Zephyr API Documentation 4.5.0-rc1
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
kernel.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016, Wind River Systems, Inc.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12
13#ifndef ZEPHYR_INCLUDE_KERNEL_H_
14#define ZEPHYR_INCLUDE_KERNEL_H_
15
16#if !defined(_ASMLANGUAGE)
18#include <errno.h>
19#include <limits.h>
20#include <stdbool.h>
21#include <zephyr/toolchain.h>
23#include <zephyr/sleep.h>
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32/*
33 * Zephyr currently assumes the size of a couple standard types to simplify
34 * print string formats. Let's make sure this doesn't change without notice.
35 */
36BUILD_ASSERT(sizeof(int32_t) == sizeof(int));
37BUILD_ASSERT(sizeof(int64_t) == sizeof(long long));
38BUILD_ASSERT(sizeof(intptr_t) == sizeof(long));
39
48
57#define K_ANY NULL
58
59#if (CONFIG_NUM_COOP_PRIORITIES + CONFIG_NUM_PREEMPT_PRIORITIES) == 0
60#error Zero available thread priorities defined!
61#endif
62
67
78#define K_PRIO_COOP(x) (-(CONFIG_NUM_COOP_PRIORITIES - (x)))
79
90#define K_PRIO_PREEMPT(x) (x)
91
93#define K_HIGHEST_THREAD_PRIO (-CONFIG_NUM_COOP_PRIORITIES)
95#define K_LOWEST_THREAD_PRIO CONFIG_NUM_PREEMPT_PRIORITIES
97#define K_IDLE_PRIO K_LOWEST_THREAD_PRIO
99#define K_HIGHEST_APPLICATION_THREAD_PRIO (K_HIGHEST_THREAD_PRIO)
101#define K_LOWEST_APPLICATION_THREAD_PRIO (K_LOWEST_THREAD_PRIO - 1)
102
104
105#ifdef CONFIG_POLL
106#define Z_POLL_EVENT_OBJ_INIT(obj) \
107 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events),
108#define Z_DECL_POLL_EVENT sys_dlist_t poll_events;
109#else
110#define Z_POLL_EVENT_OBJ_INIT(obj)
111#define Z_DECL_POLL_EVENT
112#endif
113
114struct k_thread;
115struct k_mutex;
116struct k_sem;
117struct k_msgq;
118struct k_mbox;
119struct k_pipe;
120struct k_queue;
121struct k_fifo;
122struct k_lifo;
123struct k_stack;
124struct k_mem_slab;
125struct k_timer;
126struct k_poll_event;
127struct k_poll_signal;
128struct k_mem_domain;
129struct k_mem_partition;
130struct k_futex;
131struct k_event;
132
143
144/* private, used by k_poll and k_work_poll */
145struct k_work_poll;
146typedef int (*_poller_cb_t)(struct k_poll_event *event, uint32_t state);
147
152
166static inline void
168{
169#ifdef CONFIG_SCHED_THREAD_USAGE_ANALYSIS
170 thread->base.usage.longest = 0ULL;
171#endif
172}
173
180typedef void (*k_thread_user_cb_t)(const struct k_thread *thread,
181 void *user_data);
182
198void k_thread_foreach(k_thread_user_cb_t user_cb, void *user_data);
199
218#ifdef CONFIG_SMP
219void k_thread_foreach_filter_by_cpu(unsigned int cpu,
220 k_thread_user_cb_t user_cb, void *user_data);
221#else
222static inline
223void k_thread_foreach_filter_by_cpu(unsigned int cpu,
224 k_thread_user_cb_t user_cb, void *user_data)
225{
226 __ASSERT(cpu == 0, "cpu filter out of bounds");
227 ARG_UNUSED(cpu);
228 k_thread_foreach(user_cb, user_data);
229}
230#endif
231
260 k_thread_user_cb_t user_cb, void *user_data);
261
293#ifdef CONFIG_SMP
295 k_thread_user_cb_t user_cb, void *user_data);
296#else
297static inline
298void k_thread_foreach_unlocked_filter_by_cpu(unsigned int cpu,
299 k_thread_user_cb_t user_cb, void *user_data)
300{
301 __ASSERT(cpu == 0, "cpu filter out of bounds");
302 ARG_UNUSED(cpu);
303 k_thread_foreach_unlocked(user_cb, user_data);
304}
305#endif
306
308
314
315#endif /* !_ASMLANGUAGE */
316
317
318/*
319 * Thread user options. May be needed by assembly code. Common part uses low
320 * bits, arch-specific use high bits.
321 */
322
326#define K_ESSENTIAL (BIT(0))
327
331#define K_FP_IDX 1
344#define K_FP_REGS (BIT(K_FP_IDX))
345
352#define K_USER (BIT(2))
353
362#define K_INHERIT_PERMS (BIT(3))
363
373#define K_CALLBACK_STATE (BIT(4))
374
378#define K_DSP_IDX 13
391#define K_DSP_REGS (BIT(K_DSP_IDX))
392
396#define K_AGU_IDX 14
408#define K_AGU_REGS (BIT(K_AGU_IDX))
409
419#define K_SSE_REGS (BIT(15))
420
421/* end - thread options */
422
423#if !defined(_ASMLANGUAGE)
448__syscall k_thread_stack_t *k_thread_stack_alloc(size_t size, int flags);
449
463
515__syscall k_tid_t k_thread_create(struct k_thread *new_thread,
516 k_thread_stack_t *stack,
517 size_t stack_size,
519 void *p1, void *p2, void *p3,
520 int prio, uint32_t options, k_timeout_t delay);
521
544 void *p1, void *p2,
545 void *p3);
546
560#define k_thread_access_grant(thread, ...) \
561 FOR_EACH_FIXED_ARG(k_object_access_grant, (;), (thread), __VA_ARGS__)
562
577static inline void k_thread_heap_assign(struct k_thread *thread,
578 struct k_heap *heap)
579{
580 thread->resource_pool = heap;
581}
582
583#if defined(CONFIG_INIT_STACKS) && defined(CONFIG_THREAD_STACK_INFO)
605__syscall int k_thread_stack_space_get(const struct k_thread *thread,
606 size_t *unused_ptr);
607
623__syscall int k_thread_runtime_stack_unused_threshold_pct_set(struct k_thread *thread,
624 uint32_t pct);
625
641__syscall int k_thread_runtime_stack_unused_threshold_set(struct k_thread *thread,
642 size_t threshold);
643
656__syscall size_t k_thread_runtime_stack_unused_threshold_get(struct k_thread *thread);
657
669typedef void (*k_thread_stack_safety_handler_t)(const struct k_thread *thread,
670 size_t unused_space, void *arg);
671
686int k_thread_runtime_stack_safety_full_check(const struct k_thread *thread,
687 size_t *unused_ptr,
688 k_thread_stack_safety_handler_t handler,
689 void *arg);
690
705int k_thread_runtime_stack_safety_threshold_check(const struct k_thread *thread,
706 size_t *unused_ptr,
707 k_thread_stack_safety_handler_t handler,
708 void *arg);
709#endif
710
711#if (K_HEAP_MEM_POOL_SIZE > 0)
724void k_thread_system_pool_assign(struct k_thread *thread);
725#endif /* (K_HEAP_MEM_POOL_SIZE > 0) */
726
746__syscall int k_thread_join(struct k_thread *thread, k_timeout_t timeout);
747
764__syscall void k_busy_wait(uint32_t usec_to_wait);
765
777bool k_can_yield(void);
778
786__syscall void k_yield(void);
787
797__syscall void k_wakeup(k_tid_t thread);
798
812__attribute_const__
814
826static inline bool k_is_pre_kernel(void)
827{
828 extern bool z_sys_post_kernel; /* in init.c */
829
830 /*
831 * If called from userspace, it must be post kernel.
832 * This guard is necessary because z_sys_post_kernel memory
833 * is not accessible to user threads.
834 */
835 if (k_is_user_context()) {
836 return false;
837 }
838
839 /*
840 * Some compilers might optimize by pre-reading
841 * z_sys_post_kernel. This is absolutely not desirable.
842 * We are trying to avoid reading it if we are in user
843 * context as reading z_sys_post_kernel in user context
844 * will result in access fault. So add a compiler barrier
845 * here to stop that kind of optimizations.
846 */
847 compiler_barrier();
848
849 return !z_sys_post_kernel;
850}
851
858__attribute_const__
859static inline k_tid_t k_current_get(void)
860{
861 __ASSERT(!k_is_pre_kernel(), "k_current_get called pre-kernel");
862
863#ifdef CONFIG_CURRENT_THREAD_USE_TLS
864
865 /* Thread-local cache of current thread ID, set in z_thread_entry() */
866 extern Z_THREAD_LOCAL k_tid_t z_tls_current;
867
868 return z_tls_current;
869#else
871#endif
872}
873
894__syscall void k_thread_abort(k_tid_t thread);
895
896k_ticks_t z_timeout_expires(const struct _timeout *timeout);
897k_ticks_t z_timeout_remaining(const struct _timeout *timeout);
898
899#ifdef CONFIG_SYS_CLOCK_EXISTS
900
908__syscall k_ticks_t k_thread_timeout_expires_ticks(const struct k_thread *thread);
909
910static inline k_ticks_t z_impl_k_thread_timeout_expires_ticks(
911 const struct k_thread *thread)
912{
913 return z_timeout_expires(&thread->base.timeout);
914}
915
924
925static inline k_ticks_t z_impl_k_thread_timeout_remaining_ticks(
926 const struct k_thread *thread)
927{
928 return z_timeout_remaining(&thread->base.timeout);
929}
930
931#endif /* CONFIG_SYS_CLOCK_EXISTS */
932
936struct _static_thread_data {
937 struct k_thread *init_thread;
938 k_thread_stack_t *init_stack;
939 unsigned int init_stack_size;
940 k_thread_entry_t init_entry;
941 void *init_p1;
942 void *init_p2;
943 void *init_p3;
944 int init_prio;
945 uint32_t init_options;
946 const char *init_name;
947#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
948 int32_t init_delay_ms;
949#else
950 k_timeout_t init_delay;
951#endif
952};
953
954#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
955#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay_ms = (ms)
956#define Z_THREAD_INIT_DELAY(thread) SYS_TIMEOUT_MS((thread)->init_delay_ms)
957#else
958#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay = SYS_TIMEOUT_MS(ms)
959#define Z_THREAD_INIT_DELAY(thread) (thread)->init_delay
960#endif
961
962#define Z_THREAD_INITIALIZER(thread, stack, stack_size, \
963 entry, p1, p2, p3, \
964 prio, options, delay, tname) \
965 { \
966 .init_thread = (thread), \
967 .init_stack = (stack), \
968 .init_stack_size = (stack_size), \
969 .init_entry = (k_thread_entry_t)entry, \
970 .init_p1 = (void *)p1, \
971 .init_p2 = (void *)p2, \
972 .init_p3 = (void *)p3, \
973 .init_prio = (prio), \
974 .init_options = (options), \
975 .init_name = STRINGIFY(tname), \
976 Z_THREAD_INIT_DELAY_INITIALIZER(delay) \
977 }
978
979/*
980 * Refer to K_THREAD_DEFINE() and K_KERNEL_THREAD_DEFINE() for
981 * information on arguments.
982 */
983#define Z_THREAD_COMMON_DEFINE(name, stack_size, \
984 entry, p1, p2, p3, \
985 prio, options, delay) \
986 struct k_thread _k_thread_obj_##name; \
987 const STRUCT_SECTION_ITERABLE(_static_thread_data, \
988 _k_thread_data_##name) = \
989 Z_THREAD_INITIALIZER(&_k_thread_obj_##name, \
990 _k_thread_stack_##name, stack_size,\
991 entry, p1, p2, p3, prio, options, \
992 delay, name); \
993 __maybe_unused const k_tid_t name = (k_tid_t)&_k_thread_obj_##name
997
1029#define K_THREAD_DEFINE(name, stack_size, \
1030 entry, p1, p2, p3, \
1031 prio, options, delay) \
1032 K_THREAD_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
1033 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
1034 prio, options, delay)
1035
1066#define K_KERNEL_THREAD_DEFINE(name, stack_size, \
1067 entry, p1, p2, p3, \
1068 prio, options, delay) \
1069 K_KERNEL_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
1070 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
1071 prio, options, delay)
1072
1082__syscall int k_thread_priority_get(k_tid_t thread);
1083
1109__syscall void k_thread_priority_set(k_tid_t thread, int prio);
1110
1111
1112#ifdef CONFIG_SCHED_DEADLINE
1148__syscall void k_thread_deadline_set(k_tid_t thread, int deadline);
1149
1190__syscall void k_thread_absolute_deadline_set(k_tid_t thread, int deadline);
1191#endif
1192
1211__syscall void k_reschedule(void);
1212
1213#ifdef CONFIG_SCHED_CPU_MASK
1231
1250
1266
1285
1296int k_thread_cpu_pin(k_tid_t thread, int cpu);
1297#endif
1298
1320__syscall void k_thread_suspend(k_tid_t thread);
1321
1333__syscall void k_thread_resume(k_tid_t thread);
1334
1348static inline void k_thread_start(k_tid_t thread)
1349{
1350 k_wakeup(thread);
1351}
1352
1379void k_sched_time_slice_set(int32_t slice, int prio);
1380
1419void k_thread_time_slice_set(struct k_thread *th, int32_t slice_ticks,
1420 k_thread_timeslice_fn_t expired, void *data);
1421
1423
1428
1440bool k_is_in_isr(void);
1441
1458__syscall int k_is_preempt_thread(void);
1459
1463
1468
1494void k_sched_lock(void);
1495
1504
1517__syscall void k_thread_custom_data_set(void *value);
1518
1526__syscall void *k_thread_custom_data_get(void);
1527
1544__syscall int k_thread_name_set(k_tid_t thread, const char *str);
1545
1554const char *k_thread_name_get(k_tid_t thread);
1555
1568__syscall int k_thread_name_copy(k_tid_t thread, char *buf,
1569 size_t size);
1570
1583const char *k_thread_state_str(k_tid_t thread_id, char *buf, size_t buf_size);
1584
1588
1593
1602#define K_NO_WAIT Z_TIMEOUT_NO_WAIT
1603
1616#define K_NSEC(t) Z_TIMEOUT_NS(t)
1617
1630#define K_USEC(t) Z_TIMEOUT_US(t)
1631
1642#define K_CYC(t) Z_TIMEOUT_CYC(t)
1643
1654#define K_TICKS(t) Z_TIMEOUT_TICKS(t)
1655
1666#define K_MSEC(ms) Z_TIMEOUT_MS(ms)
1667
1678#define K_SECONDS(s) K_MSEC((s) * MSEC_PER_SEC)
1679
1690#define K_MINUTES(m) K_SECONDS((m) * 60)
1691
1702#define K_HOURS(h) K_MINUTES((h) * 60)
1703
1712#define K_FOREVER Z_FOREVER
1713
1728#define K_TIMEOUT_SUM(timeout1, timeout2) K_TICKS(z_timeout_sum(timeout1, timeout2))
1729
1730#ifdef CONFIG_TIMEOUT_64BIT
1731
1743#define K_TIMEOUT_ABS_TICKS(t) \
1744 Z_TIMEOUT_TICKS(Z_TICK_ABS((k_ticks_t)CLAMP(t, 0, (INT64_MAX - 1))))
1745
1757#define K_TIMEOUT_ABS_SEC(t) K_TIMEOUT_ABS_TICKS(k_sec_to_ticks_ceil64(t))
1758
1770#define K_TIMEOUT_ABS_MS(t) K_TIMEOUT_ABS_TICKS(k_ms_to_ticks_ceil64(t))
1771
1784#define K_TIMEOUT_ABS_US(t) K_TIMEOUT_ABS_TICKS(k_us_to_ticks_ceil64(t))
1785
1798#define K_TIMEOUT_ABS_NS(t) K_TIMEOUT_ABS_TICKS(k_ns_to_ticks_ceil64(t))
1799
1812#define K_TIMEOUT_ABS_CYC(t) K_TIMEOUT_ABS_TICKS(k_cyc_to_ticks_ceil64(t))
1813#endif
1814
1818
1825struct k_timer {
1829 /*
1830 * _timeout structure must be first here if we want to use
1831 * dynamic timer allocation. timeout.node is used in the double-linked
1832 * list of free timers
1833 */
1834 struct _timeout timeout;
1835
1836 /* wait queue for the (single) thread waiting on this timer */
1837 _wait_q_t wait_q;
1838
1839 /* runs in ISR context */
1840 void (*expiry_fn)(struct k_timer *timer);
1841
1842 /* runs in the context of the thread that calls k_timer_stop() */
1843 void (*stop_fn)(struct k_timer *timer);
1844
1845 /* timer period */
1846 k_timeout_t period;
1847
1848 /* timer status */
1849 uint32_t status;
1850
1851 /* user-specific data, also used to support legacy features */
1852 void *user_data;
1853
1854#ifdef CONFIG_OBJ_CORE_TIMER
1855 struct k_obj_core obj_core;
1856#endif
1860};
1861
1862#ifdef CONFIG_TIMER_OBSERVER
1863struct k_timer_observer {
1864 /* Invoked upon completion of k_timer initialization */
1865 void (*on_init)(struct k_timer *timer);
1866
1867 /* Invoked after the timer transitions to the running state */
1868 void (*on_start)(struct k_timer *timer, k_timeout_t duration,
1869 k_timeout_t period);
1870
1871 /* Invoked when the active timer is explicitly stopped */
1872 void (*on_stop)(struct k_timer *timer);
1873
1874 /* Executes in ISR context, keep minimal and non-blocking */
1875 void (*on_expiry)(struct k_timer *timer);
1876};
1877#endif /* CONFIG_TIMER_OBSERVER */
1878
1882#define Z_TIMER_INITIALIZER(obj, expiry, stop) \
1883 { \
1884 .timeout = { \
1885 .fn = z_timer_expiration_handler, \
1886 }, \
1887 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
1888 .expiry_fn = expiry, \
1889 .stop_fn = stop, \
1890 .period = {}, \
1891 .status = 0, \
1892 .user_data = 0, \
1893 }
1897
1903
1914typedef void (*k_timer_expiry_t)(struct k_timer *timer);
1915
1930typedef void (*k_timer_stop_t)(struct k_timer *timer);
1931
1943#define K_TIMER_DEFINE(name, expiry_fn, stop_fn) \
1944 STRUCT_SECTION_ITERABLE(k_timer, name) = \
1945 Z_TIMER_INITIALIZER(name, expiry_fn, stop_fn)
1946
1947
1948#ifdef CONFIG_TIMER_OBSERVER
1949
1953#define Z_TIMER_OBSERVER_INITIALIZER(name, init, start, stop, expiry) \
1954 { \
1955 .on_init = init, \
1956 .on_start = start, \
1957 .on_stop = stop, \
1958 .on_expiry = expiry \
1959 }
1963
1977#define K_TIMER_OBSERVER_DEFINE(name, init, start, stop, expiry) \
1978 static const STRUCT_SECTION_ITERABLE(k_timer_observer, name) = \
1979 Z_TIMER_OBSERVER_INITIALIZER(name, init, start, stop, expiry)
1980
1981#endif /* CONFIG_TIMER_OBSERVER */
1982
1992void k_timer_init(struct k_timer *timer,
1993 k_timer_expiry_t expiry_fn,
1994 k_timer_stop_t stop_fn);
1995
2013__syscall void k_timer_start(struct k_timer *timer,
2014 k_timeout_t duration, k_timeout_t period);
2015
2032__syscall void k_timer_stop(struct k_timer *timer);
2033
2046__syscall uint32_t k_timer_status_get(struct k_timer *timer);
2047
2065__syscall uint32_t k_timer_status_sync(struct k_timer *timer);
2066
2067#ifdef CONFIG_SYS_CLOCK_EXISTS
2068
2080__syscall k_ticks_t k_timer_expires_ticks(const struct k_timer *timer);
2081
2082static inline k_ticks_t z_impl_k_timer_expires_ticks(
2083 const struct k_timer *timer)
2084{
2085 return z_timeout_expires(&timer->timeout);
2086}
2087
2098__syscall k_ticks_t k_timer_remaining_ticks(const struct k_timer *timer);
2099
2100static inline k_ticks_t z_impl_k_timer_remaining_ticks(
2101 const struct k_timer *timer)
2102{
2103 return z_timeout_remaining(&timer->timeout);
2104}
2105
2116static inline uint32_t k_timer_remaining_get(struct k_timer *timer)
2117{
2119}
2120
2121#endif /* CONFIG_SYS_CLOCK_EXISTS */
2122
2135__syscall void k_timer_user_data_set(struct k_timer *timer, void *user_data);
2136
2140static inline void z_impl_k_timer_user_data_set(struct k_timer *timer,
2141 void *user_data)
2142{
2143 timer->user_data = user_data;
2144}
2145
2153__syscall void *k_timer_user_data_get(const struct k_timer *timer);
2154
2155static inline void *z_impl_k_timer_user_data_get(const struct k_timer *timer)
2156{
2157 return timer->user_data;
2158}
2159
2180int k_timer_cleanup(struct k_timer *timer);
2181
2183
2189
2199__syscall int64_t k_uptime_ticks(void);
2200
2214static inline int64_t k_uptime_get(void)
2215{
2217}
2218
2238static inline uint32_t k_uptime_get_32(void)
2239{
2240 return (uint32_t)k_uptime_get();
2241}
2242
2251static inline uint32_t k_uptime_seconds(void)
2252{
2254}
2255
2267static inline int64_t k_uptime_delta(int64_t *reftime)
2268{
2269 int64_t uptime, delta;
2270
2271 uptime = k_uptime_get();
2272 delta = uptime - *reftime;
2273 *reftime = uptime;
2274
2275 return delta;
2276}
2277
2286static inline uint32_t k_cycle_get_32(void)
2287{
2288 return arch_k_cycle_get_32();
2289}
2290
2304static inline uint64_t k_cycle_get_64(void)
2305{
2306 if (!IS_ENABLED(CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER)) {
2307 __ASSERT(0, "64-bit cycle counter not enabled on this platform. "
2308 "See CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER");
2309 return 0;
2310 }
2311
2312 return arch_k_cycle_get_64();
2313}
2314
2318
2325struct k_queue {
2329 sys_sflist_t data_q;
2330 struct k_spinlock lock;
2331 _wait_q_t wait_q;
2332
2333 Z_DECL_POLL_EVENT
2334
2335#ifdef CONFIG_OBJ_CORE_QUEUE
2336 struct k_obj_core obj_core;
2337#endif
2341};
2342
2346#define Z_QUEUE_INITIALIZER(obj) \
2347 { \
2348 .data_q = SYS_SFLIST_STATIC_INIT(&obj.data_q), \
2349 .lock = { }, \
2350 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
2351 Z_POLL_EVENT_OBJ_INIT(obj) \
2352 }
2356
2362
2370__syscall void k_queue_init(struct k_queue *queue);
2371
2385__syscall void k_queue_cancel_wait(struct k_queue *queue);
2386
2399void k_queue_append(struct k_queue *queue, void *data);
2400
2417__syscall int32_t k_queue_alloc_append(struct k_queue *queue, void *data);
2418
2431void k_queue_prepend(struct k_queue *queue, void *data);
2432
2449__syscall int32_t k_queue_alloc_prepend(struct k_queue *queue, void *data);
2450
2464void k_queue_insert(struct k_queue *queue, void *prev, void *data);
2465
2484int k_queue_append_list(struct k_queue *queue, void *head, void *tail);
2485
2503int k_queue_merge_slist(struct k_queue *queue, sys_slist_t *list);
2504
2522__syscall void *k_queue_get(struct k_queue *queue, k_timeout_t timeout);
2523
2538bool k_queue_remove(struct k_queue *queue, void *data);
2539
2554bool k_queue_unique_append(struct k_queue *queue, void *data);
2555
2569__syscall int k_queue_is_empty(struct k_queue *queue);
2570
2571static inline int z_impl_k_queue_is_empty(struct k_queue *queue)
2572{
2573 return sys_sflist_is_empty(&queue->data_q) ? 1 : 0;
2574}
2575
2585__syscall void *k_queue_peek_head(struct k_queue *queue);
2586
2596__syscall void *k_queue_peek_tail(struct k_queue *queue);
2597
2607#define K_QUEUE_DEFINE(name) \
2608 STRUCT_SECTION_ITERABLE(k_queue, name) = \
2609 Z_QUEUE_INITIALIZER(name)
2610
2612
2613#ifdef CONFIG_USERSPACE
2623struct k_futex {
2630};
2631
2637
2656__syscall int k_futex_wait(struct k_futex *futex, int expected,
2657 k_timeout_t timeout);
2658
2672__syscall int k_futex_wake(struct k_futex *futex, bool wake_all);
2673
2675#endif
2676
2682
2687
2694
2695struct k_event {
2699 _wait_q_t wait_q;
2700 uint32_t events;
2701 struct k_spinlock lock;
2702
2703#ifdef CONFIG_OBJ_CORE_EVENT
2704 struct k_obj_core obj_core;
2705#endif
2709};
2710
2714#define Z_EVENT_INITIALIZER(obj) \
2715 { \
2716 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
2717 .events = 0, \
2718 .lock = {}, \
2719 }
2723
2731__syscall void k_event_init(struct k_event *event);
2732
2751__syscall uint32_t k_event_post(struct k_event *event, uint32_t events);
2752
2770__syscall uint32_t k_event_set(struct k_event *event, uint32_t events);
2771
2788__syscall uint32_t k_event_set_masked(struct k_event *event, uint32_t events,
2789 uint32_t events_mask);
2790
2804__syscall uint32_t k_event_clear(struct k_event *event, uint32_t events);
2805
2833__syscall uint32_t k_event_wait(struct k_event *event, uint32_t events,
2834 bool reset, k_timeout_t timeout);
2835
2863__syscall uint32_t k_event_wait_all(struct k_event *event, uint32_t events,
2864 bool reset, k_timeout_t timeout);
2865
2888__syscall uint32_t k_event_wait_safe(struct k_event *event, uint32_t events,
2889 bool reset, k_timeout_t timeout);
2890
2913__syscall uint32_t k_event_wait_all_safe(struct k_event *event, uint32_t events,
2914 bool reset, k_timeout_t timeout);
2915
2926static inline uint32_t k_event_test(struct k_event *event, uint32_t events_mask)
2927{
2928 return k_event_wait(event, events_mask, false, K_NO_WAIT);
2929}
2930
2940#define K_EVENT_DEFINE(name) \
2941 STRUCT_SECTION_ITERABLE(k_event, name) = \
2942 Z_EVENT_INITIALIZER(name);
2943
2945
2951struct k_fifo {
2955 struct k_queue _queue;
2956#ifdef CONFIG_OBJ_CORE_FIFO
2957 struct k_obj_core obj_core;
2958#endif
2962};
2963
2967#define Z_FIFO_INITIALIZER(obj) \
2968 { \
2969 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
2970 }
2974
2980
2988#define k_fifo_init(fifo) \
2989 ({ \
2990 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, init, fifo); \
2991 k_queue_init(&(fifo)->_queue); \
2992 K_OBJ_CORE_INIT(K_OBJ_CORE(fifo), _obj_type_fifo); \
2993 K_OBJ_CORE_LINK(K_OBJ_CORE(fifo)); \
2994 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, init, fifo); \
2995 })
2996
3008#define k_fifo_cancel_wait(fifo) \
3009 ({ \
3010 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, cancel_wait, fifo); \
3011 k_queue_cancel_wait(&(fifo)->_queue); \
3012 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, cancel_wait, fifo); \
3013 })
3014
3027#define k_fifo_put(fifo, data) \
3028 ({ \
3029 void *_data = data; \
3030 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put, fifo, _data); \
3031 k_queue_append(&(fifo)->_queue, _data); \
3032 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put, fifo, _data); \
3033 })
3034
3051#define k_fifo_alloc_put(fifo, data) \
3052 ({ \
3053 void *_data = data; \
3054 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, alloc_put, fifo, _data); \
3055 int fap_ret = k_queue_alloc_append(&(fifo)->_queue, _data); \
3056 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, alloc_put, fifo, _data, fap_ret); \
3057 fap_ret; \
3058 })
3059
3077#define k_fifo_put_list(fifo, head, tail) \
3078 ({ \
3079 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_list, fifo, head, tail); \
3080 k_queue_append_list(&(fifo)->_queue, head, tail); \
3081 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_list, fifo, head, tail); \
3082 })
3083
3100#define k_fifo_put_slist(fifo, list) \
3101 ({ \
3102 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_slist, fifo, list); \
3103 k_queue_merge_slist(&(fifo)->_queue, list); \
3104 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_slist, fifo, list); \
3105 })
3106
3125#define k_fifo_get(fifo, timeout) \
3126 ({ \
3127 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, get, fifo, timeout); \
3128 void *fg_ret = k_queue_get(&(fifo)->_queue, timeout); \
3129 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, get, fifo, timeout, fg_ret); \
3130 fg_ret; \
3131 })
3132
3146#define k_fifo_is_empty(fifo) \
3147 k_queue_is_empty(&(fifo)->_queue)
3148
3162#define k_fifo_peek_head(fifo) \
3163 ({ \
3164 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_head, fifo); \
3165 void *fph_ret = k_queue_peek_head(&(fifo)->_queue); \
3166 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_head, fifo, fph_ret); \
3167 fph_ret; \
3168 })
3169
3181#define k_fifo_peek_tail(fifo) \
3182 ({ \
3183 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_tail, fifo); \
3184 void *fpt_ret = k_queue_peek_tail(&(fifo)->_queue); \
3185 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_tail, fifo, fpt_ret); \
3186 fpt_ret; \
3187 })
3188
3198#define K_FIFO_DEFINE(name) \
3199 STRUCT_SECTION_ITERABLE(k_fifo, name) = \
3200 Z_FIFO_INITIALIZER(name)
3201
3203
3209struct k_lifo {
3213 struct k_queue _queue;
3214#ifdef CONFIG_OBJ_CORE_LIFO
3215 struct k_obj_core obj_core;
3216#endif
3220};
3221
3225#define Z_LIFO_INITIALIZER(obj) \
3226 { \
3227 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
3228 }
3232
3238
3246#define k_lifo_init(lifo) \
3247 ({ \
3248 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, init, lifo); \
3249 k_queue_init(&(lifo)->_queue); \
3250 K_OBJ_CORE_INIT(K_OBJ_CORE(lifo), _obj_type_lifo); \
3251 K_OBJ_CORE_LINK(K_OBJ_CORE(lifo)); \
3252 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, init, lifo); \
3253 })
3254
3267#define k_lifo_put(lifo, data) \
3268 ({ \
3269 void *_data = data; \
3270 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, put, lifo, _data); \
3271 k_queue_prepend(&(lifo)->_queue, _data); \
3272 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, put, lifo, _data); \
3273 })
3274
3291#define k_lifo_alloc_put(lifo, data) \
3292 ({ \
3293 void *_data = data; \
3294 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, alloc_put, lifo, _data); \
3295 int lap_ret = k_queue_alloc_prepend(&(lifo)->_queue, _data); \
3296 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, alloc_put, lifo, _data, lap_ret); \
3297 lap_ret; \
3298 })
3299
3318#define k_lifo_get(lifo, timeout) \
3319 ({ \
3320 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, get, lifo, timeout); \
3321 void *lg_ret = k_queue_get(&(lifo)->_queue, timeout); \
3322 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, get, lifo, timeout, lg_ret); \
3323 lg_ret; \
3324 })
3325
3335#define K_LIFO_DEFINE(name) \
3336 STRUCT_SECTION_ITERABLE(k_lifo, name) = \
3337 Z_LIFO_INITIALIZER(name)
3338
3340
3344#define K_STACK_FLAG_ALLOC ((uint8_t)1) /* Buffer was allocated */
3345
3346typedef uintptr_t stack_data_t;
3347
3348struct k_stack {
3349 _wait_q_t wait_q;
3350 struct k_spinlock lock;
3351 stack_data_t *base, *next, *top;
3352
3353 uint8_t flags;
3354
3355#ifdef CONFIG_OBJ_CORE_STACK
3356 struct k_obj_core obj_core;
3357#endif
3358};
3359
3360#define Z_STACK_INITIALIZER(obj, stack_buffer, stack_num_entries) \
3361 { \
3362 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3363 .base = (stack_buffer), \
3364 .next = (stack_buffer), \
3365 .top = (stack_buffer) + (stack_num_entries), \
3366 }
3370
3376
3386void k_stack_init(struct k_stack *stack,
3387 stack_data_t *buffer, uint32_t num_entries);
3388
3389
3404
3405__syscall int32_t k_stack_alloc_init(struct k_stack *stack,
3406 uint32_t num_entries);
3407
3419int k_stack_cleanup(struct k_stack *stack);
3420
3434__syscall int k_stack_push(struct k_stack *stack, stack_data_t data);
3435
3456__syscall int k_stack_pop(struct k_stack *stack, stack_data_t *data,
3457 k_timeout_t timeout);
3458
3469#define K_STACK_DEFINE(name, stack_num_entries) \
3470 stack_data_t __noinit \
3471 _k_stack_buf_##name[stack_num_entries]; \
3472 STRUCT_SECTION_ITERABLE(k_stack, name) = \
3473 Z_STACK_INITIALIZER(name, _k_stack_buf_##name, \
3474 stack_num_entries)
3475
3477
3481struct k_work;
3482struct k_work_q;
3483struct k_work_queue_config;
3484extern struct k_work_q k_sys_work_q;
3488
3494
3500struct k_mutex {
3505 _wait_q_t wait_q;
3507 struct k_thread *owner;
3508
3510 uint32_t lock_count;
3511
3512#if Z_MUTEX_PI_ENABLED
3514 sys_snode_t held_node;
3515#endif /* Z_MUTEX_PI_ENABLED */
3516
3517#ifdef CONFIG_OBJ_CORE_MUTEX
3518 struct k_obj_core obj_core;
3519#endif
3523};
3524
3528#if Z_MUTEX_PI_ENABLED
3529#define Z_MUTEX_HELD_NODE_INIT .held_node = {NULL},
3530#else
3531#define Z_MUTEX_HELD_NODE_INIT
3532#endif
3533
3534#define Z_MUTEX_INITIALIZER(obj) \
3535 { \
3536 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3537 .owner = NULL, \
3538 .lock_count = 0, \
3539 Z_MUTEX_HELD_NODE_INIT \
3540 }
3544
3554#define K_MUTEX_DEFINE(name) \
3555 STRUCT_SECTION_ITERABLE(k_mutex, name) = \
3556 Z_MUTEX_INITIALIZER(name)
3557
3570__syscall int k_mutex_init(struct k_mutex *mutex);
3571
3572
3600__syscall int k_mutex_lock(struct k_mutex *mutex, k_timeout_t timeout);
3601
3622__syscall int k_mutex_unlock(struct k_mutex *mutex);
3623
3627
3637 _wait_q_t wait_q;
3638
3639#ifdef CONFIG_OBJ_CORE_CONDVAR
3640 struct k_obj_core obj_core;
3641#endif
3645};
3646
3650#define Z_CONDVAR_INITIALIZER(obj) \
3651 { \
3652 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
3653 }
3657
3663
3670__syscall int k_condvar_init(struct k_condvar *condvar);
3671
3678__syscall int k_condvar_signal(struct k_condvar *condvar);
3679
3687__syscall int k_condvar_broadcast(struct k_condvar *condvar);
3688
3706__syscall int k_condvar_wait(struct k_condvar *condvar, struct k_mutex *mutex,
3707 k_timeout_t timeout);
3708
3719#define K_CONDVAR_DEFINE(name) \
3720 STRUCT_SECTION_ITERABLE(k_condvar, name) = \
3721 Z_CONDVAR_INITIALIZER(name)
3722
3725
3731
3738struct k_sem {
3742 _wait_q_t wait_q;
3743 unsigned int count;
3744 unsigned int limit;
3745
3746 Z_DECL_POLL_EVENT
3747
3748#ifdef CONFIG_OBJ_CORE_SEM
3749 struct k_obj_core obj_core;
3750#endif
3754};
3755
3759#define Z_SEM_INITIALIZER(obj, initial_count, count_limit) \
3760 { \
3761 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3762 .count = (initial_count), \
3763 .limit = (count_limit), \
3764 Z_POLL_EVENT_OBJ_INIT(obj) \
3765 }
3769
3778#define K_SEM_MAX_LIMIT UINT_MAX
3779
3795__syscall int k_sem_init(struct k_sem *sem, unsigned int initial_count,
3796 unsigned int limit);
3797
3816__syscall int k_sem_take(struct k_sem *sem, k_timeout_t timeout);
3817
3828__syscall void k_sem_give(struct k_sem *sem);
3829
3842__syscall void k_sem_reset(struct k_sem *sem);
3843
3853__syscall unsigned int k_sem_count_get(struct k_sem *sem);
3854
3858static inline unsigned int z_impl_k_sem_count_get(struct k_sem *sem)
3859{
3860 return sem->count;
3861}
3862
3874#define K_SEM_DEFINE(name, initial_count, count_limit) \
3875 STRUCT_SECTION_ITERABLE(k_sem, name) = \
3876 Z_SEM_INITIALIZER(name, initial_count, count_limit); \
3877 BUILD_ASSERT(((count_limit) != 0) && \
3878 (((initial_count) < (count_limit)) || ((initial_count) == (count_limit))) && \
3879 ((count_limit) <= K_SEM_MAX_LIMIT));
3880
3882
3883#if defined(CONFIG_SCHED_IPI_SUPPORTED) || defined(__DOXYGEN__)
3884struct k_ipi_work;
3885
3886
3894typedef void (*k_ipi_func_t)(struct k_ipi_work *work);
3895
3906 sys_dnode_t node[CONFIG_MP_MAX_NUM_CPUS]; /* Node in IPI work queue */
3907 k_ipi_func_t func; /* Function to execute on target CPU */
3908 struct k_event event; /* Event to signal when processed */
3909 uint32_t bitmask; /* Bitmask of targeted CPUs */
3913};
3914
3915
3923static inline void k_ipi_work_init(struct k_ipi_work *work)
3924{
3925 k_event_init(&work->event);
3926 for (unsigned int i = 0; i < CONFIG_MP_MAX_NUM_CPUS; i++) {
3927 sys_dnode_init(&work->node[i]);
3928 }
3929 work->bitmask = 0;
3930}
3931
3950int k_ipi_work_add(struct k_ipi_work *work, uint32_t cpu_bitmask,
3951 k_ipi_func_t func);
3952
3975int k_ipi_work_wait(struct k_ipi_work *work, k_timeout_t timeout);
3976
3986
3987#endif /* CONFIG_SCHED_IPI_SUPPORTED */
3988
3992struct k_work_delayable;
3993struct k_work_sync;
3997
4003
4010typedef void (*k_work_handler_t)(struct k_work *work);
4011
4025void k_work_init(struct k_work *work,
4026 k_work_handler_t handler);
4027
4042int k_work_busy_get(const struct k_work *work);
4043
4057static inline bool k_work_is_pending(const struct k_work *work);
4058
4080 struct k_work *work);
4081
4090int k_work_submit(struct k_work *work);
4091
4116bool k_work_flush(struct k_work *work,
4117 struct k_work_sync *sync);
4118
4138int k_work_cancel(struct k_work *work);
4139
4170bool k_work_cancel_sync(struct k_work *work, struct k_work_sync *sync);
4171
4181void k_work_queue_init(struct k_work_q *queue);
4182
4202void k_work_queue_start(struct k_work_q *queue,
4203 k_thread_stack_t *stack, size_t stack_size,
4204 int prio, const struct k_work_queue_config *cfg);
4205
4216void k_work_queue_run(struct k_work_q *queue, const struct k_work_queue_config *cfg);
4217
4227static inline k_tid_t k_work_queue_thread_get(struct k_work_q *queue);
4228
4252int k_work_queue_drain(struct k_work_q *queue, bool plug);
4253
4268
4288int k_work_queue_stop(struct k_work_q *queue, k_timeout_t timeout);
4289
4304 k_work_handler_t handler);
4305
4317static inline struct k_work_delayable *
4319
4334
4349static inline bool k_work_delayable_is_pending(
4350 const struct k_work_delayable *dwork);
4351
4366 const struct k_work_delayable *dwork);
4367
4382 const struct k_work_delayable *dwork);
4383
4412 struct k_work_delayable *dwork,
4413 k_timeout_t delay);
4414
4429 k_timeout_t delay);
4430
4467 struct k_work_delayable *dwork,
4468 k_timeout_t delay);
4469
4483 k_timeout_t delay);
4484
4510 struct k_work_sync *sync);
4511
4533
4563 struct k_work_sync *sync);
4564
4566enum {
4570 /* The atomic API is used for all work and queue flags fields to
4571 * enforce sequential consistency in SMP environments.
4572 */
4573
4574 /* Bits that represent the work item states. At least nine of the
4575 * combinations are distinct valid stable states.
4576 */
4577 K_WORK_RUNNING_BIT = 0,
4578 K_WORK_CANCELING_BIT = 1,
4579 K_WORK_QUEUED_BIT = 2,
4580 K_WORK_DELAYED_BIT = 3,
4581 K_WORK_FLUSHING_BIT = 4,
4582
4583 K_WORK_MASK = BIT(K_WORK_DELAYED_BIT) | BIT(K_WORK_QUEUED_BIT)
4584 | BIT(K_WORK_RUNNING_BIT) | BIT(K_WORK_CANCELING_BIT) | BIT(K_WORK_FLUSHING_BIT),
4585
4586 /* Static work flags */
4587 K_WORK_DELAYABLE_BIT = 8,
4588 K_WORK_DELAYABLE = BIT(K_WORK_DELAYABLE_BIT),
4589
4590 /* Dynamic work queue flags */
4591 K_WORK_QUEUE_STARTED_BIT = 0,
4592 K_WORK_QUEUE_STARTED = BIT(K_WORK_QUEUE_STARTED_BIT),
4593 K_WORK_QUEUE_BUSY_BIT = 1,
4594 K_WORK_QUEUE_BUSY = BIT(K_WORK_QUEUE_BUSY_BIT),
4595 K_WORK_QUEUE_DRAIN_BIT = 2,
4596 K_WORK_QUEUE_DRAIN = BIT(K_WORK_QUEUE_DRAIN_BIT),
4597 K_WORK_QUEUE_PLUGGED_BIT = 3,
4598 K_WORK_QUEUE_PLUGGED = BIT(K_WORK_QUEUE_PLUGGED_BIT),
4599 K_WORK_QUEUE_STOP_BIT = 4,
4600 K_WORK_QUEUE_STOP = BIT(K_WORK_QUEUE_STOP_BIT),
4601
4602 /* Static work queue flags */
4603 K_WORK_QUEUE_NO_YIELD_BIT = 8,
4604 K_WORK_QUEUE_NO_YIELD = BIT(K_WORK_QUEUE_NO_YIELD_BIT),
4608 /* Transient work flags */
4609
4615 K_WORK_RUNNING = BIT(K_WORK_RUNNING_BIT),
4616
4621 K_WORK_CANCELING = BIT(K_WORK_CANCELING_BIT),
4622
4628 K_WORK_QUEUED = BIT(K_WORK_QUEUED_BIT),
4629
4635 K_WORK_DELAYED = BIT(K_WORK_DELAYED_BIT),
4636
4641 K_WORK_FLUSHING = BIT(K_WORK_FLUSHING_BIT),
4642};
4643
4649struct k_work {
4653 /* All fields are protected by the work module spinlock. */
4654
4655 /* Node to link into k_work_q pending list. */
4656 sys_snode_t node;
4657
4658 /* The function to be invoked by the work queue thread. */
4659 k_work_handler_t handler;
4660
4661 /* The queue on which the work item was last submitted. */
4662 struct k_work_q *queue;
4663
4664 /* State of the work item.
4665 *
4666 * The item can be DELAYED, QUEUED, and RUNNING simultaneously.
4667 *
4668 * It can be RUNNING and CANCELING simultaneously.
4669 */
4674};
4675
4679#define Z_WORK_INITIALIZER(work_handler) { \
4680 .handler = (work_handler), \
4681}
4685
4695 /* The work item. */
4696 struct k_work work;
4697
4698 /* Timeout used to submit work after a delay. */
4699 struct _timeout timeout;
4700
4701 /* The queue to which the work should be submitted. */
4702 struct k_work_q *queue;
4706};
4707
4711#define Z_WORK_DELAYABLE_INITIALIZER(work_handler) { \
4712 .work = { \
4713 .handler = (work_handler), \
4714 .flags = K_WORK_DELAYABLE, \
4715 }, \
4716}
4720
4737#define K_WORK_DELAYABLE_DEFINE(work, work_handler) \
4738 struct k_work_delayable work \
4739 = Z_WORK_DELAYABLE_INITIALIZER(work_handler)
4740
4744/* Record used to wait for work to flush.
4745 *
4746 * The work item is inserted into the queue that will process (or is
4747 * processing) the item, and will be processed as soon as the item
4748 * completes. When the flusher is processed the semaphore will be
4749 * signaled, releasing the thread waiting for the flush.
4750 */
4751struct z_work_flusher {
4752 struct k_work work;
4753 struct k_sem sem;
4754};
4755
4756/* Record used to wait for work to complete a cancellation.
4757 *
4758 * The work item is inserted into a global queue of pending cancels.
4759 * When a cancelling work item goes idle any matching waiters are
4760 * removed from pending_cancels and are woken.
4761 */
4762struct z_work_canceller {
4763 sys_snode_t node;
4764 struct k_work *work;
4765 struct k_sem sem;
4766};
4770
4790 union {
4791 struct z_work_flusher flusher;
4792 struct z_work_canceller canceller;
4793 };
4797};
4798
4810 const char *name;
4811
4825
4830
4840};
4841
4847struct k_work_q {
4851 /* The thread that animates the work. */
4852 __deprecated struct k_thread thread;
4853
4854 /* The thread ID that animates the work. This may be an external thread
4855 * if k_work_queue_run() is used.
4856 */
4857 k_tid_t thread_id;
4858
4859 /* All the following fields must be accessed only while the
4860 * work module spinlock is held.
4861 */
4862
4863 /* List of k_work items to be worked. */
4864 sys_slist_t pending;
4865
4866 /* Wait queue for idle work thread. */
4867 _wait_q_t notifyq;
4868
4869 /* Wait queue for threads waiting for the queue to drain. */
4870 _wait_q_t drainq;
4871
4872 /* Flags describing queue state. */
4874
4875#if defined(CONFIG_WORKQUEUE_WORK_TIMEOUT)
4876 struct _timeout work_timeout_record;
4877 struct k_work *work;
4878 k_timeout_t work_timeout;
4879 bool finished;
4880#endif /* defined(CONFIG_WORKQUEUE_WORK_TIMEOUT) */
4884};
4885
4886/* Provide the implementation for inline functions declared above */
4887
4888static inline bool k_work_is_pending(const struct k_work *work)
4889{
4890 return k_work_busy_get(work) != 0;
4891}
4892
4893static inline struct k_work_delayable *
4895{
4896 return CONTAINER_OF(work, struct k_work_delayable, work);
4897}
4898
4900 const struct k_work_delayable *dwork)
4901{
4902 return k_work_delayable_busy_get(dwork) != 0;
4903}
4904
4906 const struct k_work_delayable *dwork)
4907{
4908 return z_timeout_expires(&dwork->timeout);
4909}
4910
4912 const struct k_work_delayable *dwork)
4913{
4914 return z_timeout_remaining(&dwork->timeout);
4915}
4916
4917static inline k_tid_t k_work_queue_thread_get(struct k_work_q *queue)
4918{
4919 return queue->thread_id;
4920}
4921
4923
4924struct k_work_user;
4925
4930
4940typedef void (*k_work_user_handler_t)(struct k_work_user *work);
4941
4945struct k_work_user_q {
4946 struct k_queue queue;
4947 struct k_thread thread;
4948};
4949
4950enum {
4951 K_WORK_USER_STATE_PENDING, /* Work item pending state */
4952};
4953
4954struct k_work_user {
4955 void *_reserved; /* Used by k_queue implementation. */
4956 k_work_user_handler_t handler;
4958};
4959
4960#if defined(__cplusplus) && ((__cplusplus - 0) < 202002L)
4961#define Z_WORK_USER_INITIALIZER(work_handler) { NULL, work_handler, 0 }
4962#else
4963#define Z_WORK_USER_INITIALIZER(work_handler) \
4964 { \
4965 ._reserved = NULL, \
4966 .handler = (work_handler), \
4967 .flags = 0 \
4968 }
4969#endif
4973
4985#define K_WORK_USER_DEFINE(work, work_handler) \
4986 struct k_work_user work = Z_WORK_USER_INITIALIZER(work_handler)
4987
4997static inline void k_work_user_init(struct k_work_user *work,
4998 k_work_user_handler_t handler)
4999{
5000 *work = (struct k_work_user)Z_WORK_USER_INITIALIZER(handler);
5001}
5002
5019static inline bool k_work_user_is_pending(struct k_work_user *work)
5020{
5021 return atomic_test_bit(&work->flags, K_WORK_USER_STATE_PENDING);
5022}
5023
5042static inline int k_work_user_submit_to_queue(struct k_work_user_q *work_q,
5043 struct k_work_user *work)
5044{
5045 int ret = -EBUSY;
5046
5047 if (!atomic_test_and_set_bit(&work->flags,
5048 K_WORK_USER_STATE_PENDING)) {
5049 ret = k_queue_alloc_append(&work_q->queue, work);
5050
5051 /* Couldn't insert into the queue. Clear the pending bit
5052 * so the work item can be submitted again
5053 */
5054 if (ret != 0) {
5055 atomic_clear_bit(&work->flags,
5056 K_WORK_USER_STATE_PENDING);
5057 }
5058 }
5059
5060 return ret;
5061}
5062
5082void k_work_user_queue_start(struct k_work_user_q *work_q,
5083 k_thread_stack_t *stack,
5084 size_t stack_size, int prio,
5085 const char *name);
5086
5097static inline k_tid_t k_work_user_queue_thread_get(struct k_work_user_q *work_q)
5098{
5099 return &work_q->thread;
5100}
5101
5103
5107struct k_work_poll {
5108 struct k_work work;
5109 struct k_work_q *workq;
5110 struct z_poller poller;
5111 struct k_poll_event *events;
5112 int num_events;
5113 k_work_handler_t real_handler;
5114 struct _timeout timeout;
5115 int poll_result;
5116};
5120
5125
5137#define K_WORK_DEFINE(work, work_handler) \
5138 struct k_work work = Z_WORK_INITIALIZER(work_handler)
5139
5149void k_work_poll_init(struct k_work_poll *work,
5150 k_work_handler_t handler);
5151
5187 struct k_work_poll *work,
5188 struct k_poll_event *events,
5189 int num_events,
5190 k_timeout_t timeout);
5191
5223int k_work_poll_submit(struct k_work_poll *work,
5224 struct k_poll_event *events,
5225 int num_events,
5226 k_timeout_t timeout);
5227
5242int k_work_poll_cancel(struct k_work_poll *work);
5243
5245
5251
5257struct k_msgq {
5262 _wait_q_t wait_q;
5264 struct k_spinlock lock;
5266 size_t msg_size;
5268 uint32_t max_msgs;
5270 char *buffer_start;
5272 char *buffer_end;
5274 char *read_ptr;
5276 char *write_ptr;
5278 uint32_t used_msgs;
5279
5280 Z_DECL_POLL_EVENT
5281
5283 uint8_t flags;
5284
5285#ifdef CONFIG_OBJ_CORE_MSGQ
5286 struct k_obj_core obj_core;
5287#endif
5291};
5292
5296#define Z_MSGQ_INITIALIZER(obj, q_buffer, q_msg_size, q_max_msgs) \
5297 { \
5298 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
5299 .lock = {}, \
5300 .msg_size = q_msg_size, \
5301 .max_msgs = q_max_msgs, \
5302 .buffer_start = q_buffer, \
5303 .buffer_end = q_buffer + (q_max_msgs * q_msg_size), \
5304 .read_ptr = q_buffer, \
5305 .write_ptr = q_buffer, \
5306 .used_msgs = 0, \
5307 Z_POLL_EVENT_OBJ_INIT(obj) \
5308 .flags = 0, \
5309 }
5310
5311#define K_MSGQ_FLAG_ALLOC BIT(0)
5315
5327
5328
5351#define K_MSGQ_DEFINE(q_name, q_msg_size, q_max_msgs, q_align) \
5352 static char __noinit __aligned(q_align) \
5353 _k_fifo_buf_##q_name[(q_max_msgs) * (q_msg_size)]; \
5354 STRUCT_SECTION_ITERABLE(k_msgq, q_name) = \
5355 Z_MSGQ_INITIALIZER(q_name, _k_fifo_buf_##q_name, \
5356 (q_msg_size), (q_max_msgs))
5357
5371#define K_MSGQ_DEFINE_STATIC(q_name, q_msg_size, q_max_msgs, q_align) \
5372 static char __noinit __aligned(q_align) \
5373 _k_fifo_buf_##q_name[(q_max_msgs) * (q_msg_size)]; \
5374 static STRUCT_SECTION_ITERABLE(k_msgq, q_name) = \
5375 Z_MSGQ_INITIALIZER(q_name, _k_fifo_buf_##q_name, \
5376 (q_msg_size), (q_max_msgs))
5377
5397#define K_MSGQ_DEFINE_TYPE(q_name, q_msg_type, q_max_msgs) \
5398 K_MSGQ_DEFINE(q_name, sizeof(q_msg_type), q_max_msgs, __alignof(q_msg_type))
5399
5411#define K_MSGQ_DEFINE_STATIC_TYPE(q_name, q_msg_type, q_max_msgs) \
5412 K_MSGQ_DEFINE_STATIC(q_name, sizeof(q_msg_type), q_max_msgs, __alignof(q_msg_type))
5413
5428void k_msgq_init(struct k_msgq *msgq, char *buffer, size_t msg_size,
5429 uint32_t max_msgs);
5430
5450__syscall int k_msgq_alloc_init(struct k_msgq *msgq, size_t msg_size,
5451 uint32_t max_msgs);
5452
5466int k_msgq_cleanup(struct k_msgq *msgq);
5467
5488__syscall int k_msgq_put(struct k_msgq *msgq, const void *data, k_timeout_t timeout);
5489
5514__syscall int k_msgq_put_front(struct k_msgq *msgq, const void *data);
5515
5536__syscall int k_msgq_get(struct k_msgq *msgq, void *data, k_timeout_t timeout);
5537
5552__syscall int k_msgq_peek(struct k_msgq *msgq, void *data);
5553
5570__syscall int k_msgq_peek_at(struct k_msgq *msgq, void *data, uint32_t idx);
5571
5581__syscall void k_msgq_purge(struct k_msgq *msgq);
5582
5593__syscall uint32_t k_msgq_num_free_get(struct k_msgq *msgq);
5594
5603__syscall void k_msgq_get_attrs(struct k_msgq *msgq,
5604 struct k_msgq_attrs *attrs);
5605
5606
5607static inline uint32_t z_impl_k_msgq_num_free_get(struct k_msgq *msgq)
5608{
5609 return msgq->max_msgs - msgq->used_msgs;
5610}
5611
5621__syscall uint32_t k_msgq_num_used_get(struct k_msgq *msgq);
5622
5623static inline uint32_t z_impl_k_msgq_num_used_get(struct k_msgq *msgq)
5624{
5625 return msgq->used_msgs;
5626}
5627
5629
5635
5642 size_t size;
5646 void *tx_data;
5655 k_tid_t _syncing_thread;
5656#if (CONFIG_NUM_MBOX_ASYNC_MSGS > 0)
5658 struct k_sem *_async_sem;
5659#endif
5663};
5664
5669struct k_mbox {
5674 _wait_q_t tx_msg_queue;
5676 _wait_q_t rx_msg_queue;
5677 struct k_spinlock lock;
5678
5679#ifdef CONFIG_OBJ_CORE_MAILBOX
5680 struct k_obj_core obj_core;
5681#endif
5685};
5686
5690#define Z_MBOX_INITIALIZER(obj) \
5691 { \
5692 .tx_msg_queue = Z_WAIT_Q_INIT(&obj.tx_msg_queue), \
5693 .rx_msg_queue = Z_WAIT_Q_INIT(&obj.rx_msg_queue), \
5694 }
5698
5708#define K_MBOX_DEFINE(name) \
5709 STRUCT_SECTION_ITERABLE(k_mbox, name) = \
5710 Z_MBOX_INITIALIZER(name) \
5711
5712
5719void k_mbox_init(struct k_mbox *mbox);
5720
5740int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
5741 k_timeout_t timeout);
5742
5756void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
5757 struct k_sem *sem);
5758
5776int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *rx_msg,
5777 void *buffer, k_timeout_t timeout);
5778
5792void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer);
5793
5795
5801
5811__syscall void k_pipe_init(struct k_pipe *pipe, uint8_t *buffer, size_t buffer_size);
5812
5816enum pipe_flags {
5817 PIPE_FLAG_OPEN = BIT(0),
5818 PIPE_FLAG_RESET = BIT(1),
5819};
5823
5829struct k_pipe {
5833 size_t waiting;
5834 struct ring_buf buf;
5835 struct k_spinlock lock;
5836 _wait_q_t data;
5837 _wait_q_t space;
5838 uint8_t flags;
5839
5840 Z_DECL_POLL_EVENT
5841#ifdef CONFIG_OBJ_CORE_PIPE
5842 struct k_obj_core obj_core;
5843#endif
5847};
5848
5852#define Z_PIPE_INITIALIZER(obj, pipe_buffer, pipe_buffer_size) \
5853{ \
5854 .waiting = 0, \
5855 .buf = RING_BUF_INIT(pipe_buffer, pipe_buffer_size), \
5856 .data = Z_WAIT_Q_INIT(&obj.data), \
5857 .space = Z_WAIT_Q_INIT(&obj.space), \
5858 .flags = PIPE_FLAG_OPEN, \
5859 Z_POLL_EVENT_OBJ_INIT(obj) \
5860}
5864
5878#define K_PIPE_DEFINE(name, pipe_buffer_size, pipe_align) \
5879 static unsigned char __noinit __aligned(pipe_align) \
5880 _k_pipe_buf_##name[pipe_buffer_size]; \
5881 STRUCT_SECTION_ITERABLE(k_pipe, name) = \
5882 Z_PIPE_INITIALIZER(name, _k_pipe_buf_##name, pipe_buffer_size)
5883
5884
5902__syscall int k_pipe_write(struct k_pipe *pipe, const uint8_t *data, size_t len,
5903 k_timeout_t timeout);
5904
5921__syscall int k_pipe_read(struct k_pipe *pipe, uint8_t *data, size_t len,
5922 k_timeout_t timeout);
5923
5933__syscall void k_pipe_reset(struct k_pipe *pipe);
5934
5943__syscall void k_pipe_close(struct k_pipe *pipe);
5945
5949struct k_mem_slab_info {
5950 uint32_t num_blocks;
5951 size_t block_size;
5952 uint32_t num_used;
5953#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
5954 uint32_t max_used;
5955#endif
5956};
5957
5958struct k_mem_slab {
5959 _wait_q_t wait_q;
5960 struct k_spinlock lock;
5961 char *buffer;
5962 char *free_list;
5963 struct k_mem_slab_info info;
5964
5965#ifdef CONFIG_OBJ_CORE_MEM_SLAB
5966 struct k_obj_core obj_core;
5967#endif
5968};
5969
5970#define Z_MEM_SLAB_INITIALIZER(_slab, _slab_buffer, _slab_block_size, \
5971 _slab_num_blocks) \
5972 { \
5973 .wait_q = Z_WAIT_Q_INIT(&(_slab).wait_q), \
5974 .lock = {}, \
5975 .buffer = _slab_buffer, \
5976 .free_list = NULL, \
5977 .info = {_slab_num_blocks, _slab_block_size, 0} \
5978 }
5982
5988
6014#define K_MEM_SLAB_DEFINE_IN_SECT(name, in_section, slab_block_size, slab_num_blocks, slab_align) \
6015 BUILD_ASSERT(((slab_block_size) % (slab_align)) == 0, \
6016 "slab_block_size must be a multiple of slab_align"); \
6017 BUILD_ASSERT((((slab_align) & ((slab_align) - 1)) == 0), \
6018 "slab_align must be a power of 2"); \
6019 char in_section __aligned(WB_UP( \
6020 slab_align)) _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
6021 STRUCT_SECTION_ITERABLE(k_mem_slab, name) = Z_MEM_SLAB_INITIALIZER( \
6022 name, _k_mem_slab_buf_##name, WB_UP(slab_block_size), slab_num_blocks)
6023
6047#define K_MEM_SLAB_DEFINE(name, slab_block_size, slab_num_blocks, slab_align) \
6048 K_MEM_SLAB_DEFINE_IN_SECT(name, __noinit_named(k_mem_slab_buf_##name), slab_block_size, \
6049 slab_num_blocks, slab_align)
6050
6072#define K_MEM_SLAB_DEFINE_TYPE(name, type, slab_num_blocks) \
6073 K_MEM_SLAB_DEFINE(name, sizeof(type), slab_num_blocks, __alignof(type))
6074
6091#define K_MEM_SLAB_DEFINE_IN_SECT_STATIC(name, in_section, slab_block_size, slab_num_blocks, \
6092 slab_align) \
6093 BUILD_ASSERT(((slab_block_size) % (slab_align)) == 0, \
6094 "slab_block_size must be a multiple of slab_align"); \
6095 BUILD_ASSERT((((slab_align) & ((slab_align) - 1)) == 0), \
6096 "slab_align must be a power of 2"); \
6097 static char in_section __aligned(WB_UP( \
6098 slab_align)) _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
6099 static STRUCT_SECTION_ITERABLE(k_mem_slab, name) = Z_MEM_SLAB_INITIALIZER( \
6100 name, _k_mem_slab_buf_##name, WB_UP(slab_block_size), slab_num_blocks)
6101
6116#define K_MEM_SLAB_DEFINE_STATIC(name, slab_block_size, slab_num_blocks, slab_align) \
6117 K_MEM_SLAB_DEFINE_IN_SECT_STATIC(name, __noinit_named(k_mem_slab_buf_##name), \
6118 slab_block_size, slab_num_blocks, slab_align)
6119
6132#define K_MEM_SLAB_DEFINE_STATIC_TYPE(name, type, slab_num_blocks) \
6133 K_MEM_SLAB_DEFINE_STATIC(name, sizeof(type), slab_num_blocks, __alignof(type))
6134
6156int k_mem_slab_init(struct k_mem_slab *slab, void *buffer,
6157 size_t block_size, uint32_t num_blocks);
6158
6180int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem,
6181 k_timeout_t timeout);
6182
6194void k_mem_slab_free(struct k_mem_slab *slab, void *mem);
6195
6208static inline uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
6209{
6210 return slab->info.num_used;
6211}
6212
6225static inline uint32_t k_mem_slab_max_used_get(struct k_mem_slab *slab)
6226{
6227#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
6228 return slab->info.max_used;
6229#else
6230 ARG_UNUSED(slab);
6231 return 0;
6232#endif
6233}
6234
6247static inline uint32_t k_mem_slab_num_free_get(struct k_mem_slab *slab)
6248{
6249 return slab->info.num_blocks - slab->info.num_used;
6250}
6251
6265
6266int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stats *stats);
6267
6281int k_mem_slab_runtime_stats_reset_max(struct k_mem_slab *slab);
6282
6284
6289
6295struct k_heap {
6299 struct sys_heap heap;
6300 _wait_q_t wait_q;
6301 struct k_spinlock lock;
6305};
6306
6320void k_heap_init(struct k_heap *h, void *mem,
6321 size_t bytes) __attribute_nonnull(1);
6322
6344void *k_heap_aligned_alloc(struct k_heap *h, size_t align, size_t bytes,
6345 k_timeout_t timeout) __attribute_nonnull(1);
6346
6368void *k_heap_alloc(struct k_heap *h, size_t bytes,
6369 k_timeout_t timeout) __attribute_nonnull(1);
6370
6393void *k_heap_calloc(struct k_heap *h, size_t num, size_t size, k_timeout_t timeout)
6394 __attribute_nonnull(1);
6395
6419void *k_heap_realloc(struct k_heap *h, void *ptr, size_t bytes, k_timeout_t timeout)
6420 __attribute_nonnull(1);
6421
6432void k_heap_free(struct k_heap *h, void *mem) __attribute_nonnull(1);
6433
6434/*
6435 * Heap sizing constants computed at build time from actual struct layouts
6436 * in lib/heap/heap_constants.c via the gen_offset mechanism.
6437 */
6438#include <zephyr/heap_constants.h>
6439
6440/* chunk0 size in bytes for nb buckets (includes trailer metadata) */
6441#define _Z_HEAP_C0(nb) \
6442 (ROUND_UP(___z_heap_struct_SIZEOF + \
6443 (nb) * ___z_heap_bucket_SIZEOF, ___z_heap_chunk_unit_SIZEOF) + \
6444 ___z_heap_trailer_SIZEOF)
6445
6446/* Allocation chunk size in bytes (header + data rounded up, plus trailer) */
6447#define _Z_HEAP_AC(ab) \
6448 (ROUND_UP(___z_heap_hdr_SIZEOF + (ab), ___z_heap_chunk_unit_SIZEOF) + \
6449 ___z_heap_trailer_SIZEOF)
6450
6451/* Total heap size in chunk units */
6452#define _Z_HEAP_SZ(nb, ab) \
6453 ((_Z_HEAP_C0(nb) + _Z_HEAP_AC(ab)) / ___z_heap_chunk_unit_SIZEOF)
6454
6455/* Bucket count from heap size in chunk units (mirrors bucket_idx() + 1) */
6456#define _Z_HEAP_NB(sz) \
6457 (32 - __builtin_clz((unsigned int)((sz) - \
6458 ___z_heap_min_chunk_SIZEOF + 1)))
6459
6460/* 3-round convergent iteration starting from 1 bucket */
6461#define _Z_HEAP_NB1(ab) _Z_HEAP_NB(_Z_HEAP_SZ(1, ab))
6462#define _Z_HEAP_NB2(ab) _Z_HEAP_NB(_Z_HEAP_SZ(_Z_HEAP_NB1(ab), ab))
6463#define _Z_HEAP_NB3(ab) _Z_HEAP_NB(_Z_HEAP_SZ(_Z_HEAP_NB2(ab), ab))
6464
6478#define Z_HEAP_MIN_SIZE_FOR(alloc_bytes) \
6479 (_Z_HEAP_C0(_Z_HEAP_NB3(alloc_bytes)) + \
6480 _Z_HEAP_AC(alloc_bytes) + ___z_heap_ftr_SIZEOF)
6481
6482#define Z_HEAP_MIN_SIZE Z_HEAP_MIN_SIZE_FOR(1)
6483
6500#define Z_HEAP_DEFINE_IN_SECT(name, bytes, in_section) \
6501 char in_section \
6502 __aligned(8) /* CHUNK_UNIT */ \
6503 kheap_##name[MAX(bytes, Z_HEAP_MIN_SIZE)]; \
6504 STRUCT_SECTION_ITERABLE(k_heap, name) = { \
6505 .heap = { \
6506 .init_mem = kheap_##name, \
6507 .init_bytes = MAX(bytes, Z_HEAP_MIN_SIZE), \
6508 }, \
6509 }
6510
6525#define K_HEAP_DEFINE(name, bytes) \
6526 Z_HEAP_DEFINE_IN_SECT(name, bytes, \
6527 __noinit_named(kheap_buf_##name))
6528
6543#define K_HEAP_DEFINE_NOCACHE(name, bytes) \
6544 Z_HEAP_DEFINE_IN_SECT(name, bytes, __nocache)
6545
6555int k_heap_array_get(struct k_heap **heap);
6556
6560
6567
6586void *k_aligned_alloc(size_t align, size_t size);
6587
6599void *k_malloc(size_t size);
6600
6611void k_free(void *ptr);
6612
6624void *k_calloc(size_t nmemb, size_t size);
6625
6643void *k_realloc(void *ptr, size_t size);
6644
6646
6647/* polling API - PRIVATE */
6648
6649#ifdef CONFIG_POLL
6650#define _INIT_OBJ_POLL_EVENT(obj) do { (obj)->poll_event = NULL; } while (false)
6651#else
6652#define _INIT_OBJ_POLL_EVENT(obj) do { } while (false)
6653#endif
6654
6655/* private - types bit positions */
6656enum _poll_types_bits {
6657 /* can be used to ignore an event */
6658 _POLL_TYPE_IGNORE,
6659
6660 /* to be signaled by k_poll_signal_raise() */
6661 _POLL_TYPE_SIGNAL,
6662
6663 /* semaphore availability */
6664 _POLL_TYPE_SEM_AVAILABLE,
6665
6666 /* queue/FIFO/LIFO data availability */
6667 _POLL_TYPE_DATA_AVAILABLE,
6668
6669 /* msgq data availability */
6670 _POLL_TYPE_MSGQ_DATA_AVAILABLE,
6671
6672 /* pipe data availability */
6673 _POLL_TYPE_PIPE_DATA_AVAILABLE,
6674
6675 _POLL_NUM_TYPES
6676};
6677
6678#define Z_POLL_TYPE_BIT(type) (1U << ((type) - 1U))
6679
6680/* private - states bit positions */
6681enum _poll_states_bits {
6682 /* default state when creating event */
6683 _POLL_STATE_NOT_READY,
6684
6685 /* signaled by k_poll_signal_raise() */
6686 _POLL_STATE_SIGNALED,
6687
6688 /* semaphore is available */
6689 _POLL_STATE_SEM_AVAILABLE,
6690
6691 /* data is available to read on queue/FIFO/LIFO */
6692 _POLL_STATE_DATA_AVAILABLE,
6693
6694 /* queue/FIFO/LIFO wait was cancelled */
6695 _POLL_STATE_CANCELLED,
6696
6697 /* data is available to read on a message queue */
6698 _POLL_STATE_MSGQ_DATA_AVAILABLE,
6699
6700 /* data is available to read from a pipe */
6701 _POLL_STATE_PIPE_DATA_AVAILABLE,
6702
6703 _POLL_NUM_STATES
6704};
6705
6706#define Z_POLL_STATE_BIT(state) (1U << ((state) - 1U))
6707
6708#define _POLL_EVENT_NUM_UNUSED_BITS \
6709 (32 - (0 \
6710 + 8 /* tag */ \
6711 + _POLL_NUM_TYPES \
6712 + _POLL_NUM_STATES \
6713 + 1 /* modes */ \
6714 ))
6715
6716/* end of polling API - PRIVATE */
6717
6718
6726
6727/* Public polling API */
6728
6734
6736#define K_POLL_TYPE_IGNORE 0
6738#define K_POLL_TYPE_SIGNAL Z_POLL_TYPE_BIT(_POLL_TYPE_SIGNAL)
6740#define K_POLL_TYPE_SEM_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_SEM_AVAILABLE)
6742#define K_POLL_TYPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_DATA_AVAILABLE)
6744#define K_POLL_TYPE_FIFO_DATA_AVAILABLE K_POLL_TYPE_DATA_AVAILABLE
6746#define K_POLL_TYPE_LIFO_DATA_AVAILABLE K_POLL_TYPE_DATA_AVAILABLE
6748#define K_POLL_TYPE_MSGQ_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_MSGQ_DATA_AVAILABLE)
6750#define K_POLL_TYPE_PIPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_PIPE_DATA_AVAILABLE)
6751
6753
6763
6769
6771#define K_POLL_STATE_NOT_READY 0
6773#define K_POLL_STATE_SIGNALED Z_POLL_STATE_BIT(_POLL_STATE_SIGNALED)
6775#define K_POLL_STATE_SEM_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_SEM_AVAILABLE)
6777#define K_POLL_STATE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_DATA_AVAILABLE)
6779#define K_POLL_STATE_FIFO_DATA_AVAILABLE K_POLL_STATE_DATA_AVAILABLE
6781#define K_POLL_STATE_LIFO_DATA_AVAILABLE K_POLL_STATE_DATA_AVAILABLE
6783#define K_POLL_STATE_MSGQ_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_MSGQ_DATA_AVAILABLE)
6785#define K_POLL_STATE_PIPE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_PIPE_DATA_AVAILABLE)
6787#define K_POLL_STATE_CANCELLED Z_POLL_STATE_BIT(_POLL_STATE_CANCELLED)
6788
6790
6803 sys_dlist_t poll_events;
6807
6812 unsigned int signaled;
6813
6816};
6817
6823#define K_POLL_SIGNAL_INITIALIZER(obj) \
6824 { \
6825 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events), \
6826 .signaled = 0, \
6827 .result = 0, \
6828 }
6829
6838 sys_dnode_t _node;
6839
6841 struct z_poller *poller;
6845
6848
6850 uint32_t type:_POLL_NUM_TYPES;
6851
6853 uint32_t state:_POLL_NUM_STATES;
6854
6857
6859 uint32_t unused:_POLL_EVENT_NUM_UNUSED_BITS;
6860
6862 union {
6863 /* The _typed_* aliases below are used by the K_POLL_EVENT_*INITIALIZER() macros to
6864 * ensure type safety of polled objects.
6865 */
6867 void *obj, *_typed_K_POLL_TYPE_IGNORE;
6869 struct k_poll_signal *signal, *_typed_K_POLL_TYPE_SIGNAL;
6871 struct k_sem *sem, *_typed_K_POLL_TYPE_SEM_AVAILABLE;
6873 struct k_fifo *fifo, *_typed_K_POLL_TYPE_FIFO_DATA_AVAILABLE;
6875 struct k_lifo *lifo, *_typed_K_POLL_TYPE_LIFO_DATA_AVAILABLE;
6877 struct k_queue *queue, *_typed_K_POLL_TYPE_DATA_AVAILABLE;
6879 struct k_msgq *msgq, *_typed_K_POLL_TYPE_MSGQ_DATA_AVAILABLE;
6881 struct k_pipe *pipe, *_typed_K_POLL_TYPE_PIPE_DATA_AVAILABLE;
6882 };
6883};
6884
6893#define K_POLL_EVENT_INITIALIZER(_event_type, _event_mode, _event_obj) \
6894 { \
6895 .poller = NULL, \
6896 .type = _event_type, \
6897 .state = K_POLL_STATE_NOT_READY, \
6898 .mode = _event_mode, \
6899 .unused = 0, \
6900 { \
6901 ._typed_##_event_type = _event_obj, \
6902 }, \
6903 }
6904
6914#define K_POLL_EVENT_STATIC_INITIALIZER(_event_type, _event_mode, _event_obj, \
6915 event_tag) \
6916 { \
6917 .tag = event_tag, \
6918 .type = _event_type, \
6919 .state = K_POLL_STATE_NOT_READY, \
6920 .mode = _event_mode, \
6921 .unused = 0, \
6922 { \
6923 ._typed_##_event_type = _event_obj, \
6924 }, \
6925 }
6926
6941
6942void k_poll_event_init(struct k_poll_event *event, uint32_t type,
6943 int mode, void *obj);
6944
6987
6988__syscall int k_poll(struct k_poll_event *events, int num_events,
6989 k_timeout_t timeout);
6990
6998
6999__syscall void k_poll_signal_init(struct k_poll_signal *sig);
7000
7006__syscall void k_poll_signal_reset(struct k_poll_signal *sig);
7007
7018__syscall void k_poll_signal_check(struct k_poll_signal *sig,
7019 unsigned int *signaled, int *result);
7020
7043
7044__syscall int k_poll_signal_raise(struct k_poll_signal *sig, int result);
7045
7047
7066static inline void k_cpu_idle(void)
7067{
7068 arch_cpu_idle();
7069}
7070
7085static inline void k_cpu_atomic_idle(unsigned int key)
7086{
7088}
7089
7093
7098#ifdef ARCH_EXCEPT
7099/* This architecture has direct support for triggering a CPU exception */
7100#define z_except_reason(reason) ARCH_EXCEPT(reason)
7101#else
7102
7103#if defined(CONFIG_PRINTK) && !defined(CONFIG_ASSERT_NO_FILE_INFO)
7104#define __EXCEPT_LOC() printk("@ %s:%d\n", __FILE__, __LINE__)
7105#else
7106#define __EXCEPT_LOC()
7107#endif /* CONFIG_PRINTK */
7108
7109/* NOTE: This is the implementation for arches that do not implement
7110 * ARCH_EXCEPT() to generate a real CPU exception.
7111 *
7112 * We won't have a real exception frame to determine the PC value when
7113 * the oops occurred, so print file and line number before we jump into
7114 * the fatal error handler.
7115 */
7116#define z_except_reason(reason) do { \
7117 __EXCEPT_LOC(); \
7118 z_fatal_error(reason, NULL); \
7119 } while (false)
7120
7121#endif /* _ARCH__EXCEPT */
7125
7137#define k_oops() z_except_reason(K_ERR_KERNEL_OOPS)
7138
7147#define k_panic() z_except_reason(K_ERR_KERNEL_PANIC)
7148
7152/*
7153 * private APIs that are utilized by one or more public APIs
7154 */
7155
7159void z_timer_expiration_handler(struct _timeout *timeout);
7163
7164#ifdef CONFIG_PRINTK
7172__syscall void k_str_out(char *c, size_t n);
7173#endif
7174
7180
7201__syscall int k_float_disable(struct k_thread *thread);
7202
7241__syscall int k_float_enable(struct k_thread *thread, unsigned int options);
7242
7246
7256
7264
7273
7284
7295
7305
7314
7323
7324#ifdef __cplusplus
7325}
7326#endif
7327
7328#include <zephyr/tracing/tracing.h>
7329#include <zephyr/syscalls/kernel.h>
7330
7331#endif /* !_ASMLANGUAGE */
7332
7333#endif /* ZEPHYR_INCLUDE_KERNEL_H_ */
void(* k_thread_entry_t)(void *p1, void *p2, void *p3)
Thread entry point function type.
Definition arch_interface.h:48
struct z_thread_stack_element k_thread_stack_t
Typedef of struct z_thread_stack_element.
Definition arch_interface.h:46
System error numbers.
void arch_cpu_atomic_idle(unsigned int key)
Atomically re-enable interrupts and enter low power mode.
void arch_cpu_idle(void)
Power save idle routine.
static uint32_t arch_k_cycle_get_32(void)
Obtain the current cycle count, in units specified by CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC.
static uint64_t arch_k_cycle_get_64(void)
As for arch_k_cycle_get_32(), but with a 64 bit return value.
long atomic_t
Atomic integer variable.
Definition atomic_types.h:34
static bool atomic_test_bit(const atomic_t *target, int bit)
Atomically get and test a bit.
Definition atomic.h:138
static void atomic_clear_bit(atomic_t *target, int bit)
Atomically clear a bit.
Definition atomic.h:227
static bool atomic_test_and_set_bit(atomic_t *target, int bit)
Atomically set a bit and test it.
Definition atomic.h:181
static uint32_t k_cycle_get_32(void)
Read the hardware clock.
Definition kernel.h:2286
#define K_NO_WAIT
Generate null timeout delay.
Definition kernel.h:1602
int64_t k_uptime_ticks(void)
Get system uptime, in system ticks.
static uint32_t k_uptime_get_32(void)
Get system uptime (32-bit version).
Definition kernel.h:2238
uint32_t k_ticks_t
Tick precision used in timeout APIs.
Definition clock.h:48
static int64_t k_uptime_delta(int64_t *reftime)
Get elapsed time, and update the referenced time.
Definition kernel.h:2267
static uint32_t k_uptime_seconds(void)
Get system uptime in seconds.
Definition kernel.h:2251
static uint64_t k_cycle_get_64(void)
Read the 64-bit hardware clock.
Definition kernel.h:2304
static int64_t k_uptime_get(void)
Get system uptime.
Definition kernel.h:2214
int k_condvar_signal(struct k_condvar *condvar)
Signals one thread that is pending on the condition variable.
int k_condvar_wait(struct k_condvar *condvar, struct k_mutex *mutex, k_timeout_t timeout)
Waits on the condition variable releasing the mutex lock.
int k_condvar_init(struct k_condvar *condvar)
Initialize a condition variable.
int k_condvar_broadcast(struct k_condvar *condvar)
Unblock all threads that are pending on the condition variable.
static void k_cpu_idle(void)
Make the CPU idle.
Definition kernel.h:7066
static void k_cpu_atomic_idle(unsigned int key)
Make the CPU idle in an atomic fashion.
Definition kernel.h:7085
struct _dnode sys_dnode_t
Doubly-linked list node structure.
Definition dlist.h:59
struct _dnode sys_dlist_t
Doubly-linked list structure.
Definition dlist.h:55
static void sys_dnode_init(sys_dnode_t *node)
initialize node to its state when not in a list
Definition dlist.h:224
uint32_t k_event_wait(struct k_event *event, uint32_t events, bool reset, k_timeout_t timeout)
Wait for any of the specified events.
uint32_t k_event_set_masked(struct k_event *event, uint32_t events, uint32_t events_mask)
Set or clear the events in an event object.
uint32_t k_event_wait_all_safe(struct k_event *event, uint32_t events, bool reset, k_timeout_t timeout)
Wait for all of the specified events (safe version).
static uint32_t k_event_test(struct k_event *event, uint32_t events_mask)
Test the events currently tracked in the event object.
Definition kernel.h:2926
uint32_t k_event_wait_safe(struct k_event *event, uint32_t events, bool reset, k_timeout_t timeout)
Wait for any of the specified events (safe version).
uint32_t k_event_set(struct k_event *event, uint32_t events)
Set the events in an event object.
uint32_t k_event_post(struct k_event *event, uint32_t events)
Post one or more events to an event object.
void k_event_init(struct k_event *event)
Initialize an event object.
uint32_t k_event_clear(struct k_event *event, uint32_t events)
Clear the events in an event object.
uint32_t k_event_wait_all(struct k_event *event, uint32_t events, bool reset, k_timeout_t timeout)
Wait for all of the specified events.
static bool sys_sflist_is_empty(const sys_sflist_t *list)
Test if the given list is empty.
Definition sflist.h:339
struct _sflist sys_sflist_t
Flagged single-linked list structure.
Definition sflist.h:57
int k_float_disable(struct k_thread *thread)
Disable preservation of floating point context information.
int k_float_enable(struct k_thread *thread, unsigned int options)
Enable preservation of floating point context information.
int k_futex_wait(struct k_futex *futex, int expected, k_timeout_t timeout)
Pend the current thread on a futex.
int k_futex_wake(struct k_futex *futex, bool wake_all)
Wake one/all threads pending on a futex.
void * k_heap_alloc(struct k_heap *h, size_t bytes, k_timeout_t timeout)
Allocate memory from a k_heap.
int k_heap_array_get(struct k_heap **heap)
Get the array of statically defined heaps.
void * k_heap_calloc(struct k_heap *h, size_t num, size_t size, k_timeout_t timeout)
Allocate and initialize memory for an array of objects from a k_heap.
void k_heap_free(struct k_heap *h, void *mem)
Free memory allocated by k_heap_alloc().
void k_free(void *ptr)
Free memory allocated from heap.
void * k_realloc(void *ptr, size_t size)
Expand the size of an existing allocation.
void k_heap_init(struct k_heap *h, void *mem, size_t bytes)
Initialize a k_heap.
void * k_malloc(size_t size)
Allocate memory from the heap.
void * k_heap_realloc(struct k_heap *h, void *ptr, size_t bytes, k_timeout_t timeout)
Reallocate memory from a k_heap.
void * k_calloc(size_t nmemb, size_t size)
Allocate memory from heap, array style.
void * k_aligned_alloc(size_t align, size_t size)
Allocate memory from the heap with a specified alignment.
void * k_heap_aligned_alloc(struct k_heap *h, size_t align, size_t bytes, k_timeout_t timeout)
Allocate aligned memory from a k_heap.
bool k_is_in_isr(void)
Determine if code is running at interrupt level.
int k_is_preempt_thread(void)
Determine if code is running in a preemptible thread.
execution_context_types
Types of execution contexts.
Definition kernel.h:138
@ K_ISR
Executing in an interrupt service routine.
Definition kernel.h:139
@ K_COOP_THREAD
Executing in a cooperative thread.
Definition kernel.h:140
@ K_PREEMPT_THREAD
Executing in a preemptible thread.
Definition kernel.h:141
int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *rx_msg, void *buffer, k_timeout_t timeout)
Receive a mailbox message.
void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer)
Retrieve mailbox message data into a buffer.
void k_mbox_init(struct k_mbox *mbox)
Initialize a mailbox.
int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg, k_timeout_t timeout)
Send a mailbox message in a synchronous manner.
void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg, struct k_sem *sem)
Send a mailbox message in an asynchronous manner.
int k_mem_slab_init(struct k_mem_slab *slab, void *buffer, size_t block_size, uint32_t num_blocks)
Initialize a memory slab.
void k_mem_slab_free(struct k_mem_slab *slab, void *mem)
Free memory allocated from a memory slab.
int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stats *stats)
Get the memory stats for a memory slab.
int k_mem_slab_runtime_stats_reset_max(struct k_mem_slab *slab)
Reset the maximum memory usage for a slab.
int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem, k_timeout_t timeout)
Allocate memory from a memory slab.
static uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
Get the number of used blocks in a memory slab.
Definition kernel.h:6208
static uint32_t k_mem_slab_max_used_get(struct k_mem_slab *slab)
Get the number of maximum used blocks so far in a memory slab.
Definition kernel.h:6225
static uint32_t k_mem_slab_num_free_get(struct k_mem_slab *slab)
Get the number of unused blocks in a memory slab.
Definition kernel.h:6247
int k_msgq_peek(struct k_msgq *msgq, void *data)
Peek/read a message from a message queue.
uint32_t k_msgq_num_used_get(struct k_msgq *msgq)
Get the number of messages in a message queue.
void k_msgq_init(struct k_msgq *msgq, char *buffer, size_t msg_size, uint32_t max_msgs)
Initialize a message queue.
int k_msgq_put(struct k_msgq *msgq, const void *data, k_timeout_t timeout)
Send a message to the end of a message queue.
int k_msgq_peek_at(struct k_msgq *msgq, void *data, uint32_t idx)
Peek/read a message from a message queue at the specified index.
uint32_t k_msgq_num_free_get(struct k_msgq *msgq)
Get the amount of free space in a message queue.
void k_msgq_get_attrs(struct k_msgq *msgq, struct k_msgq_attrs *attrs)
Get basic attributes of a message queue.
void k_msgq_purge(struct k_msgq *msgq)
Purge a message queue.
int k_msgq_alloc_init(struct k_msgq *msgq, size_t msg_size, uint32_t max_msgs)
Initialize a message queue.
int k_msgq_put_front(struct k_msgq *msgq, const void *data)
Send a message to the front of a message queue.
int k_msgq_get(struct k_msgq *msgq, void *data, k_timeout_t timeout)
Receive a message from a message queue.
int k_msgq_cleanup(struct k_msgq *msgq)
Release allocated buffer for a queue.
int k_mutex_unlock(struct k_mutex *mutex)
Unlock a mutex.
int k_mutex_init(struct k_mutex *mutex)
Initialize a mutex.
int k_mutex_lock(struct k_mutex *mutex, k_timeout_t timeout)
Lock a mutex.
int k_pipe_write(struct k_pipe *pipe, const uint8_t *data, size_t len, k_timeout_t timeout)
Write data to a pipe.
void k_pipe_close(struct k_pipe *pipe)
Close a pipe.
void k_pipe_reset(struct k_pipe *pipe)
Reset a pipe This routine resets the pipe, discarding any unread data and unblocking any threads wait...
void k_pipe_init(struct k_pipe *pipe, uint8_t *buffer, size_t buffer_size)
initialize a pipe
int k_pipe_read(struct k_pipe *pipe, uint8_t *data, size_t len, k_timeout_t timeout)
Read data from a pipe This routine reads up to len bytes of data from pipe.
void k_poll_signal_reset(struct k_poll_signal *sig)
Reset a poll signal object's state to unsignaled.
k_poll_modes
Modes of operation of a poll event.
Definition kernel.h:6755
void k_poll_signal_check(struct k_poll_signal *sig, unsigned int *signaled, int *result)
Fetch the signaled state and result value of a poll signal.
void k_poll_event_init(struct k_poll_event *event, uint32_t type, int mode, void *obj)
Initialize one struct k_poll_event instance.
int k_poll(struct k_poll_event *events, int num_events, k_timeout_t timeout)
Wait for one or many of multiple poll events to occur.
int k_poll_signal_raise(struct k_poll_signal *sig, int result)
Signal a poll signal object.
void k_poll_signal_init(struct k_poll_signal *sig)
Initialize a poll signal object.
@ K_POLL_MODE_NOTIFY_ONLY
Polling thread is notified of object availability, but does not take ownership of the object.
Definition kernel.h:6759
@ K_POLL_NUM_MODES
Number of poll modes.
Definition kernel.h:6761
void k_queue_init(struct k_queue *queue)
Initialize a queue.
void * k_queue_get(struct k_queue *queue, k_timeout_t timeout)
Get an element from a queue.
void * k_queue_peek_tail(struct k_queue *queue)
Peek element at the tail of queue.
bool k_queue_unique_append(struct k_queue *queue, void *data)
Append an element to a queue only if it's not present already.
bool k_queue_remove(struct k_queue *queue, void *data)
Remove an element from a queue.
int k_queue_merge_slist(struct k_queue *queue, sys_slist_t *list)
Atomically add a list of elements to a queue.
int32_t k_queue_alloc_append(struct k_queue *queue, void *data)
Append an element to a queue.
void k_queue_cancel_wait(struct k_queue *queue)
Cancel waiting on a queue.
void * k_queue_peek_head(struct k_queue *queue)
Peek element at the head of queue.
void k_queue_prepend(struct k_queue *queue, void *data)
Prepend an element to a queue.
int k_queue_append_list(struct k_queue *queue, void *head, void *tail)
Atomically append a list of elements to a queue.
void k_queue_append(struct k_queue *queue, void *data)
Append an element to the end of a queue.
int32_t k_queue_alloc_prepend(struct k_queue *queue, void *data)
Prepend an element to a queue.
void k_queue_insert(struct k_queue *queue, void *prev, void *data)
Inserts an element to a queue.
int k_queue_is_empty(struct k_queue *queue)
Query a queue to see if it has data available.
void k_sem_reset(struct k_sem *sem)
Resets a semaphore's count to zero.
unsigned int k_sem_count_get(struct k_sem *sem)
Get a semaphore's count.
void k_sem_give(struct k_sem *sem)
Give a semaphore.
int k_sem_take(struct k_sem *sem, k_timeout_t timeout)
Take a semaphore.
int k_sem_init(struct k_sem *sem, unsigned int initial_count, unsigned int limit)
Initialize a semaphore.
struct _slist sys_slist_t
Single-linked list structure.
Definition slist.h:54
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:44
int k_stack_pop(struct k_stack *stack, stack_data_t *data, k_timeout_t timeout)
Pop an element from a stack.
void k_stack_init(struct k_stack *stack, stack_data_t *buffer, uint32_t num_entries)
Initialize a stack.
int k_stack_cleanup(struct k_stack *stack)
Release a stack's allocated buffer.
int k_stack_push(struct k_stack *stack, stack_data_t data)
Push an element onto a stack.
int32_t k_stack_alloc_init(struct k_stack *stack, uint32_t num_entries)
Initialize a stack.
#define IS_ENABLED(config_macro)
Check for macro definition in compiler-visible expressions.
Definition util_macro.h:154
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
#define CONTAINER_OF(ptr, type, field)
Get a pointer to a structure containing the element.
Definition util.h:281
#define EBUSY
Mount device busy.
Definition errno.h:55
int k_thread_name_copy(k_tid_t thread, char *buf, size_t size)
Copy the thread name into a supplied buffer.
void k_yield(void)
Yield the current thread.
const char * k_thread_state_str(k_tid_t thread_id, char *buf, size_t buf_size)
Get thread state string.
void k_thread_resume(k_tid_t thread)
Resume a suspended thread.
void * k_thread_custom_data_get(void)
Get current thread's custom data.
void k_thread_abort(k_tid_t thread)
Abort a thread.
int k_thread_name_set(k_tid_t thread, const char *str)
Set current thread name.
void k_thread_priority_set(k_tid_t thread, int prio)
Set a thread's priority.
void k_thread_absolute_deadline_set(k_tid_t thread, int deadline)
Set absolute deadline expiration time for scheduler.
int k_thread_cpu_mask_enable(k_tid_t thread, int cpu)
Enable thread to run on specified CPU.
void k_thread_foreach_unlocked(k_thread_user_cb_t user_cb, void *user_data)
Iterate over all the threads in the system without locking.
bool k_can_yield(void)
Check whether it is possible to yield in the current context.
int k_thread_priority_get(k_tid_t thread)
Get a thread's priority.
static void k_thread_heap_assign(struct k_thread *thread, struct k_heap *heap)
Assign a resource memory pool to a thread.
Definition kernel.h:577
FUNC_NORETURN void k_thread_user_mode_enter(k_thread_entry_t entry, void *p1, void *p2, void *p3)
Drop a thread's privileges permanently to user mode.
int k_thread_join(struct k_thread *thread, k_timeout_t timeout)
Sleep until a thread exits.
k_ticks_t k_thread_timeout_remaining_ticks(const struct k_thread *thread)
Get time remaining before a thread wakes up, in system ticks.
void k_thread_custom_data_set(void *value)
Set current thread's custom data.
void k_sched_lock(void)
Lock the scheduler.
void k_busy_wait(uint32_t usec_to_wait)
Cause the current thread to busy wait.
void k_thread_time_slice_set(struct k_thread *th, int32_t slice_ticks, k_thread_timeslice_fn_t expired, void *data)
Set thread time slice.
static void k_thread_runtime_stats_longest_frame_reset(__maybe_unused struct k_thread *thread)
Resets thread longest frame usage data for specified thread.
Definition kernel.h:167
void k_thread_suspend(k_tid_t thread)
Suspend a thread.
void k_sched_unlock(void)
Unlock the scheduler.
static __attribute_const__ k_tid_t k_current_get(void)
Get thread ID of the current thread.
Definition kernel.h:859
int k_thread_cpu_mask_clear(k_tid_t thread)
Sets all CPU enable masks to zero.
void k_thread_foreach_filter_by_cpu(unsigned int cpu, k_thread_user_cb_t user_cb, void *user_data)
Iterate over all the threads in running on specified cpu.
void k_sched_time_slice_set(int32_t slice, int prio)
Set time-slicing period and scope.
int k_thread_cpu_mask_disable(k_tid_t thread, int cpu)
Prevent thread to run on specified CPU.
void k_wakeup(k_tid_t thread)
Wake up a sleeping thread.
int k_thread_stack_free(k_thread_stack_t *stack)
Free a dynamically allocated thread stack.
k_ticks_t k_thread_timeout_expires_ticks(const struct k_thread *thread)
Get time when a thread wakes up, in system ticks.
__attribute_const__ k_tid_t k_sched_current_thread_query(void)
Query thread ID of the current thread.
static void k_thread_start(k_tid_t thread)
Start an inactive thread.
Definition kernel.h:1348
k_tid_t k_thread_create(struct k_thread *new_thread, k_thread_stack_t *stack, size_t stack_size, k_thread_entry_t entry, void *p1, void *p2, void *p3, int prio, uint32_t options, k_timeout_t delay)
Create a thread.
void k_reschedule(void)
Invoke the scheduler.
void k_thread_deadline_set(k_tid_t thread, int deadline)
Set relative deadline expiration time for scheduler.
void k_thread_foreach_unlocked_filter_by_cpu(unsigned int cpu, k_thread_user_cb_t user_cb, void *user_data)
Iterate over the threads in running on current cpu without locking.
const char * k_thread_name_get(k_tid_t thread)
Get thread name.
void k_thread_foreach(k_thread_user_cb_t user_cb, void *user_data)
Iterate over all the threads in the system.
static bool k_is_pre_kernel(void)
Test whether startup is in the before-main-task phase.
Definition kernel.h:826
int k_thread_cpu_pin(k_tid_t thread, int cpu)
Pin a thread to a CPU.
int k_thread_cpu_mask_enable_all(k_tid_t thread)
Sets all CPU enable masks to one.
void(* k_thread_user_cb_t)(const struct k_thread *thread, void *user_data)
Callback type used by thread iteration functions.
Definition kernel.h:180
k_thread_stack_t * k_thread_stack_alloc(size_t size, int flags)
Dynamically allocate a thread stack.
k_ticks_t k_timer_expires_ticks(const struct k_timer *timer)
Get next expiration time of a timer, in system ticks.
void(* k_timer_stop_t)(struct k_timer *timer)
Timer stop function type.
Definition kernel.h:1930
k_ticks_t k_timer_remaining_ticks(const struct k_timer *timer)
Get time remaining before a timer next expires, in system ticks.
void * k_timer_user_data_get(const struct k_timer *timer)
Retrieve the user-specific data from a timer.
void(* k_timer_expiry_t)(struct k_timer *timer)
Timer expiry function type.
Definition kernel.h:1914
void k_timer_init(struct k_timer *timer, k_timer_expiry_t expiry_fn, k_timer_stop_t stop_fn)
Initialize a timer.
int k_timer_cleanup(struct k_timer *timer)
Clean up a dynamically allocated timer before freeing it.
void k_timer_start(struct k_timer *timer, k_timeout_t duration, k_timeout_t period)
Start a timer.
static uint32_t k_timer_remaining_get(struct k_timer *timer)
Get time remaining before a timer next expires.
Definition kernel.h:2116
uint32_t k_timer_status_sync(struct k_timer *timer)
Synchronize thread to timer expiration.
void k_timer_stop(struct k_timer *timer)
Stop a timer.
uint32_t k_timer_status_get(struct k_timer *timer)
Read timer status.
void k_timer_user_data_set(struct k_timer *timer, void *user_data)
Associate user-specific data with a timer.
#define k_ticks_to_ms_ceil32(t)
Convert ticks to milliseconds.
Definition time_units.h:1867
#define k_ticks_to_sec_floor32(t)
Convert ticks to seconds.
Definition time_units.h:1707
#define k_ticks_to_ms_floor64(t)
Convert ticks to milliseconds.
Definition time_units.h:1819
int k_work_poll_submit_to_queue(struct k_work_q *work_q, struct k_work_poll *work, struct k_poll_event *events, int num_events, k_timeout_t timeout)
Submit a triggered work item.
static k_tid_t k_work_queue_thread_get(struct k_work_q *queue)
Access the thread that animates a work queue.
Definition kernel.h:4917
static bool k_work_is_pending(const struct k_work *work)
Test whether a work item is currently pending.
Definition kernel.h:4888
int k_work_queue_drain(struct k_work_q *queue, bool plug)
Wait until the work queue has drained, optionally plugging it.
static k_ticks_t k_work_delayable_expires_get(const struct k_work_delayable *dwork)
Get the absolute tick count at which a scheduled delayable work will be submitted.
Definition kernel.h:4905
int k_work_schedule_for_queue(struct k_work_q *queue, struct k_work_delayable *dwork, k_timeout_t delay)
Submit an idle work item to a queue after a delay.
int k_work_delayable_busy_get(const struct k_work_delayable *dwork)
Busy state flags from the delayable work item.
int k_work_queue_stop(struct k_work_q *queue, k_timeout_t timeout)
Stop a work queue.
void k_work_init_delayable(struct k_work_delayable *dwork, k_work_handler_t handler)
Initialize a delayable work structure.
int k_work_poll_cancel(struct k_work_poll *work)
Cancel a triggered work item.
void k_work_user_queue_start(struct k_work_user_q *work_q, k_thread_stack_t *stack, size_t stack_size, int prio, const char *name)
Start a workqueue in user mode.
void k_work_poll_init(struct k_work_poll *work, k_work_handler_t handler)
Initialize a triggered work item.
int k_work_cancel(struct k_work *work)
Cancel a work item.
static int k_work_user_submit_to_queue(struct k_work_user_q *work_q, struct k_work_user *work)
Submit a work item to a user mode workqueue.
Definition kernel.h:5042
int k_work_submit_to_queue(struct k_work_q *queue, struct k_work *work)
Submit a work item to a queue.
static bool k_work_user_is_pending(struct k_work_user *work)
Check if a userspace work item is pending.
Definition kernel.h:5019
void(* k_work_handler_t)(struct k_work *work)
The signature for a work item handler function.
Definition kernel.h:4010
int k_work_schedule(struct k_work_delayable *dwork, k_timeout_t delay)
Submit an idle work item to the system work queue after a delay.
static bool k_work_delayable_is_pending(const struct k_work_delayable *dwork)
Test whether a delayed work item is currently pending.
Definition kernel.h:4899
bool k_work_cancel_delayable_sync(struct k_work_delayable *dwork, struct k_work_sync *sync)
Cancel delayable work and wait.
int k_work_cancel_delayable(struct k_work_delayable *dwork)
Cancel delayable work.
static void k_work_user_init(struct k_work_user *work, k_work_user_handler_t handler)
Initialize a userspace work item.
Definition kernel.h:4997
int k_work_queue_unplug(struct k_work_q *queue)
Release a work queue to accept new submissions.
int k_work_reschedule(struct k_work_delayable *dwork, k_timeout_t delay)
Reschedule a work item to the system work queue after a delay.
void(* k_work_user_handler_t)(struct k_work_user *work)
Work item handler function type for user work queues.
Definition kernel.h:4940
bool k_work_cancel_sync(struct k_work *work, struct k_work_sync *sync)
Cancel a work item and wait for it to complete.
static k_tid_t k_work_user_queue_thread_get(struct k_work_user_q *work_q)
Access the user mode thread that animates a work queue.
Definition kernel.h:5097
int k_work_busy_get(const struct k_work *work)
Busy state flags from the work item.
static struct k_work_delayable * k_work_delayable_from_work(struct k_work *work)
Get the parent delayable work structure from a work pointer.
Definition kernel.h:4894
static k_ticks_t k_work_delayable_remaining_get(const struct k_work_delayable *dwork)
Get the number of ticks until a scheduled delayable work will be submitted.
Definition kernel.h:4911
bool k_work_flush(struct k_work *work, struct k_work_sync *sync)
Wait for last-submitted instance to complete.
int k_work_reschedule_for_queue(struct k_work_q *queue, struct k_work_delayable *dwork, k_timeout_t delay)
Reschedule a work item to a queue after a delay.
void k_work_queue_run(struct k_work_q *queue, const struct k_work_queue_config *cfg)
Run work queue using calling thread.
int k_work_submit(struct k_work *work)
Submit a work item to the system queue.
bool k_work_flush_delayable(struct k_work_delayable *dwork, struct k_work_sync *sync)
Flush delayable work.
int k_work_poll_submit(struct k_work_poll *work, struct k_poll_event *events, int num_events, k_timeout_t timeout)
Submit a triggered work item to the system workqueue.
void k_work_queue_init(struct k_work_q *queue)
Initialize a work queue structure.
void k_work_queue_start(struct k_work_q *queue, k_thread_stack_t *stack, size_t stack_size, int prio, const struct k_work_queue_config *cfg)
Initialize a work queue.
void k_work_init(struct k_work *work, k_work_handler_t handler)
Initialize a (non-delayable) work structure.
@ K_WORK_CANCELING
Flag indicating a work item that is being canceled.
Definition kernel.h:4621
@ K_WORK_QUEUED
Flag indicating a work item that has been submitted to a queue but has not started running.
Definition kernel.h:4628
@ K_WORK_DELAYED
Flag indicating a delayed work item that is scheduled for submission to a queue.
Definition kernel.h:4635
@ K_WORK_RUNNING
Flag indicating a work item that is running under a work queue thread.
Definition kernel.h:4615
@ K_WORK_FLUSHING
Flag indicating a synced work item that is being flushed.
Definition kernel.h:4641
struct k_thread * k_tid_t
Definition thread.h:414
struct k_thread_runtime_stats k_thread_runtime_stats_t
void k_sys_runtime_stats_disable(void)
Disable gathering of system runtime statistics.
int k_thread_runtime_stats_enable(k_tid_t thread)
Enable gathering of runtime statistics for specified thread.
int k_ipi_work_add(struct k_ipi_work *work, uint32_t cpu_bitmask, k_ipi_func_t func)
Add an IPI work item to the IPI work queue.
void k_sys_runtime_stats_enable(void)
Enable gathering of system runtime statistics.
int k_thread_runtime_stats_get(k_tid_t thread, k_thread_runtime_stats_t *stats)
Get the runtime statistics of a thread.
bool k_thread_runtime_stats_is_enabled(k_tid_t thread)
Check if runtime statistics gathering is enabled for a thread.
void k_ipi_work_signal(void)
Signal that there is one or more IPI work items to process.
int k_ipi_work_wait(struct k_ipi_work *work, k_timeout_t timeout)
Wait until the IPI work item has been processed by all targeted CPUs.
void(* k_ipi_func_t)(struct k_ipi_work *work)
IPI work item handler function type.
Definition kernel.h:3894
int k_thread_runtime_stats_all_get(k_thread_runtime_stats_t *stats)
Get the runtime statistics of all threads.
static void k_ipi_work_init(struct k_ipi_work *work)
Initialize the specified IPI work item.
Definition kernel.h:3923
int k_thread_runtime_stats_disable(k_tid_t thread)
Disable gathering of runtime statistics for specified thread.
int k_thread_runtime_stats_cpu_get(int cpu, k_thread_runtime_stats_t *stats)
Get the runtime statistics of all threads on specified cpu.
Header files included by kernel.h.
void(* k_thread_timeslice_fn_t)(struct k_thread *thread, void *data)
Definition kernel_structs.h:379
Memory Statistics.
flags
Definition parser.h:86
state
Definition parser_state.h:29
Simple, header-only ring buffer implementation.
Thread sleep APIs.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INTPTR_TYPE__ intptr_t
Definition stdint.h:104
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINTPTR_TYPE__ uintptr_t
Definition stdint.h:105
__INT64_TYPE__ int64_t
Definition stdint.h:75
Kernel condition variable structure.
Definition kernel.h:3633
Event Structure.
Definition kernel.h:2695
Kernel FIFO structure.
Definition kernel.h:2951
futex structure
Definition kernel.h:2623
atomic_t val
Futex value.
Definition kernel.h:2629
Kernel synchronized heap structure.
Definition kernel.h:6295
IPI work item structure.
Definition kernel.h:3902
Kernel LIFO structure.
Definition kernel.h:3209
Mailbox Message Structure.
Definition kernel.h:5640
k_tid_t tx_target_thread
target thread id
Definition kernel.h:5650
void * tx_data
sender's message data buffer
Definition kernel.h:5646
k_tid_t rx_source_thread
source thread id
Definition kernel.h:5648
uint32_t info
application-defined information value
Definition kernel.h:5644
size_t size
size of message (in bytes)
Definition kernel.h:5642
Mailbox Structure.
Definition kernel.h:5669
Memory Domain.
Definition mem_domain.h:80
Memory Partition.
Definition mem_domain.h:55
Message Queue Attributes.
Definition kernel.h:5319
uint32_t used_msgs
Used messages.
Definition kernel.h:5325
size_t msg_size
Message Size.
Definition kernel.h:5321
uint32_t max_msgs
Maximal number of messages.
Definition kernel.h:5323
Message Queue Structure.
Definition kernel.h:5257
Kernel mutex structure.
Definition kernel.h:3500
Object core structure.
Definition obj_core.h:160
Kernel pipe structure.
Definition kernel.h:5829
Poll Event.
Definition kernel.h:6833
struct k_poll_signal * signal
Poll signal being polled.
Definition kernel.h:6869
struct k_pipe * pipe
Pipe being polled.
Definition kernel.h:6881
uint32_t tag
optional user-specified tag, opaque, untouched by the API
Definition kernel.h:6847
struct k_fifo * fifo
FIFO being polled.
Definition kernel.h:6873
struct k_msgq * msgq
Message queue being polled.
Definition kernel.h:6879
struct k_queue * queue
Queue being polled.
Definition kernel.h:6877
uint32_t unused
unused bits in 32-bit word
Definition kernel.h:6859
uint32_t type
bitfield of event types (bitwise-ORed K_POLL_TYPE_xxx values)
Definition kernel.h:6850
struct k_sem * sem
Semaphore being polled.
Definition kernel.h:6871
uint32_t state
bitfield of event states (bitwise-ORed K_POLL_STATE_xxx values)
Definition kernel.h:6853
uint32_t mode
mode of operation, from enum k_poll_modes
Definition kernel.h:6856
void * obj
Generic object pointer.
Definition kernel.h:6867
struct k_lifo * lifo
LIFO being polled.
Definition kernel.h:6875
Poll signal object.
Definition kernel.h:6798
int result
custom result value passed to k_poll_signal_raise() if needed
Definition kernel.h:6815
unsigned int signaled
1 if the event has been signaled, 0 otherwise.
Definition kernel.h:6812
Kernel queue structure.
Definition kernel.h:2325
Semaphore structure.
Definition kernel.h:3738
Kernel Spin Lock.
Definition spinlock.h:45
Thread Structure.
Definition thread.h:258
struct _thread_base base
Definition thread.h:260
struct k_heap * resource_pool
resource pool
Definition thread.h:363
struct __thread_entry entry
thread entry and parameters description
Definition thread.h:302
Kernel timeout type.
Definition clock.h:65
Kernel timer structure.
Definition kernel.h:1825
A structure used to submit work after a delay.
Definition kernel.h:4691
Kernel workqueue structure.
Definition kernel.h:4847
A structure holding optional configuration items for a work queue.
Definition kernel.h:4805
const char * name
The name to be given to the work queue thread.
Definition kernel.h:4810
uint32_t work_timeout_ms
Controls whether work queue monitors work timeouts.
Definition kernel.h:4839
bool essential
Control whether the work queue thread should be marked as essential thread.
Definition kernel.h:4829
bool no_yield
Control whether the work queue thread should yield between items.
Definition kernel.h:4824
A structure holding internal state for a pending synchronous operation on a work item or queue.
Definition kernel.h:4786
A structure used to submit work.
Definition kernel.h:4649
A structure to represent a ring buffer.
Definition ring_buffer.h:62
Definition sys_heap.h:61
Definition mem_stats.h:24
Iterable sections helpers.
static bool k_is_user_context(void)
Indicate whether the CPU is currently in user mode.
Definition syscall.h:120
Macros to abstract toolchain specific capabilities.
Main header file for tracing subsystem API.
Header file for tracing macros.