Zephyr API Documentation 4.4.99
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>
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31/*
32 * Zephyr currently assumes the size of a couple standard types to simplify
33 * print string formats. Let's make sure this doesn't change without notice.
34 */
35BUILD_ASSERT(sizeof(int32_t) == sizeof(int));
36BUILD_ASSERT(sizeof(int64_t) == sizeof(long long));
37BUILD_ASSERT(sizeof(intptr_t) == sizeof(long));
38
47
56#define K_ANY NULL
57
58#if (CONFIG_NUM_COOP_PRIORITIES + CONFIG_NUM_PREEMPT_PRIORITIES) == 0
59#error Zero available thread priorities defined!
60#endif
61
66
77#define K_PRIO_COOP(x) (-(CONFIG_NUM_COOP_PRIORITIES - (x)))
78
89#define K_PRIO_PREEMPT(x) (x)
90
92#define K_HIGHEST_THREAD_PRIO (-CONFIG_NUM_COOP_PRIORITIES)
94#define K_LOWEST_THREAD_PRIO CONFIG_NUM_PREEMPT_PRIORITIES
96#define K_IDLE_PRIO K_LOWEST_THREAD_PRIO
98#define K_HIGHEST_APPLICATION_THREAD_PRIO (K_HIGHEST_THREAD_PRIO)
100#define K_LOWEST_APPLICATION_THREAD_PRIO (K_LOWEST_THREAD_PRIO - 1)
101
103
104#ifdef CONFIG_POLL
105#define Z_POLL_EVENT_OBJ_INIT(obj) \
106 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events),
107#define Z_DECL_POLL_EVENT sys_dlist_t poll_events;
108#else
109#define Z_POLL_EVENT_OBJ_INIT(obj)
110#define Z_DECL_POLL_EVENT
111#endif
112
113struct k_thread;
114struct k_mutex;
115struct k_sem;
116struct k_msgq;
117struct k_mbox;
118struct k_pipe;
119struct k_queue;
120struct k_fifo;
121struct k_lifo;
122struct k_stack;
123struct k_mem_slab;
124struct k_timer;
125struct k_poll_event;
126struct k_poll_signal;
127struct k_mem_domain;
128struct k_mem_partition;
129struct k_futex;
130struct k_event;
131
142
143/* private, used by k_poll and k_work_poll */
144struct k_work_poll;
145typedef int (*_poller_cb_t)(struct k_poll_event *event, uint32_t state);
146
151
165static inline void
167{
168#ifdef CONFIG_SCHED_THREAD_USAGE_ANALYSIS
169 thread->base.usage.longest = 0ULL;
170#endif
171}
172
179typedef void (*k_thread_user_cb_t)(const struct k_thread *thread,
180 void *user_data);
181
197void k_thread_foreach(k_thread_user_cb_t user_cb, void *user_data);
198
217#ifdef CONFIG_SMP
218void k_thread_foreach_filter_by_cpu(unsigned int cpu,
219 k_thread_user_cb_t user_cb, void *user_data);
220#else
221static inline
222void k_thread_foreach_filter_by_cpu(unsigned int cpu,
223 k_thread_user_cb_t user_cb, void *user_data)
224{
225 __ASSERT(cpu == 0, "cpu filter out of bounds");
226 ARG_UNUSED(cpu);
227 k_thread_foreach(user_cb, user_data);
228}
229#endif
230
259 k_thread_user_cb_t user_cb, void *user_data);
260
292#ifdef CONFIG_SMP
294 k_thread_user_cb_t user_cb, void *user_data);
295#else
296static inline
297void k_thread_foreach_unlocked_filter_by_cpu(unsigned int cpu,
298 k_thread_user_cb_t user_cb, void *user_data)
299{
300 __ASSERT(cpu == 0, "cpu filter out of bounds");
301 ARG_UNUSED(cpu);
302 k_thread_foreach_unlocked(user_cb, user_data);
303}
304#endif
305
307
313
314#endif /* !_ASMLANGUAGE */
315
316
317/*
318 * Thread user options. May be needed by assembly code. Common part uses low
319 * bits, arch-specific use high bits.
320 */
321
325#define K_ESSENTIAL (BIT(0))
326
330#define K_FP_IDX 1
343#define K_FP_REGS (BIT(K_FP_IDX))
344
351#define K_USER (BIT(2))
352
361#define K_INHERIT_PERMS (BIT(3))
362
372#define K_CALLBACK_STATE (BIT(4))
373
377#define K_DSP_IDX 13
390#define K_DSP_REGS (BIT(K_DSP_IDX))
391
395#define K_AGU_IDX 14
407#define K_AGU_REGS (BIT(K_AGU_IDX))
408
418#define K_SSE_REGS (BIT(15))
419
420/* end - thread options */
421
422#if !defined(_ASMLANGUAGE)
447__syscall k_thread_stack_t *k_thread_stack_alloc(size_t size, int flags);
448
462
514__syscall k_tid_t k_thread_create(struct k_thread *new_thread,
515 k_thread_stack_t *stack,
516 size_t stack_size,
518 void *p1, void *p2, void *p3,
519 int prio, uint32_t options, k_timeout_t delay);
520
543 void *p1, void *p2,
544 void *p3);
545
559#define k_thread_access_grant(thread, ...) \
560 FOR_EACH_FIXED_ARG(k_object_access_grant, (;), (thread), __VA_ARGS__)
561
576static inline void k_thread_heap_assign(struct k_thread *thread,
577 struct k_heap *heap)
578{
579 thread->resource_pool = heap;
580}
581
582#if defined(CONFIG_INIT_STACKS) && defined(CONFIG_THREAD_STACK_INFO)
604__syscall int k_thread_stack_space_get(const struct k_thread *thread,
605 size_t *unused_ptr);
606
622__syscall int k_thread_runtime_stack_unused_threshold_pct_set(struct k_thread *thread,
623 uint32_t pct);
624
640__syscall int k_thread_runtime_stack_unused_threshold_set(struct k_thread *thread,
641 size_t threshold);
642
655__syscall size_t k_thread_runtime_stack_unused_threshold_get(struct k_thread *thread);
656
668typedef void (*k_thread_stack_safety_handler_t)(const struct k_thread *thread,
669 size_t unused_space, void *arg);
670
685int k_thread_runtime_stack_safety_full_check(const struct k_thread *thread,
686 size_t *unused_ptr,
687 k_thread_stack_safety_handler_t handler,
688 void *arg);
689
704int k_thread_runtime_stack_safety_threshold_check(const struct k_thread *thread,
705 size_t *unused_ptr,
706 k_thread_stack_safety_handler_t handler,
707 void *arg);
708#endif
709
710#if (K_HEAP_MEM_POOL_SIZE > 0)
723void k_thread_system_pool_assign(struct k_thread *thread);
724#endif /* (K_HEAP_MEM_POOL_SIZE > 0) */
725
745__syscall int k_thread_join(struct k_thread *thread, k_timeout_t timeout);
746
762__syscall int32_t k_sleep(k_timeout_t timeout);
763
775static inline int32_t k_msleep(int32_t ms)
776{
777 return k_sleep(Z_TIMEOUT_MS(ms));
778}
779
797
814__syscall void k_busy_wait(uint32_t usec_to_wait);
815
827bool k_can_yield(void);
828
836__syscall void k_yield(void);
837
847__syscall void k_wakeup(k_tid_t thread);
848
862__attribute_const__
864
876static inline bool k_is_pre_kernel(void)
877{
878 extern bool z_sys_post_kernel; /* in init.c */
879
880 /*
881 * If called from userspace, it must be post kernel.
882 * This guard is necessary because z_sys_post_kernel memory
883 * is not accessible to user threads.
884 */
885 if (k_is_user_context()) {
886 return false;
887 }
888
889 /*
890 * Some compilers might optimize by pre-reading
891 * z_sys_post_kernel. This is absolutely not desirable.
892 * We are trying to avoid reading it if we are in user
893 * context as reading z_sys_post_kernel in user context
894 * will result in access fault. So add a compiler barrier
895 * here to stop that kind of optimizations.
896 */
897 compiler_barrier();
898
899 return !z_sys_post_kernel;
900}
901
908__attribute_const__
909static inline k_tid_t k_current_get(void)
910{
911 __ASSERT(!k_is_pre_kernel(), "k_current_get called pre-kernel");
912
913#ifdef CONFIG_CURRENT_THREAD_USE_TLS
914
915 /* Thread-local cache of current thread ID, set in z_thread_entry() */
916 extern Z_THREAD_LOCAL k_tid_t z_tls_current;
917
918 return z_tls_current;
919#else
921#endif
922}
923
944__syscall void k_thread_abort(k_tid_t thread);
945
946k_ticks_t z_timeout_expires(const struct _timeout *timeout);
947k_ticks_t z_timeout_remaining(const struct _timeout *timeout);
948
949#ifdef CONFIG_SYS_CLOCK_EXISTS
950
958__syscall k_ticks_t k_thread_timeout_expires_ticks(const struct k_thread *thread);
959
960static inline k_ticks_t z_impl_k_thread_timeout_expires_ticks(
961 const struct k_thread *thread)
962{
963 return z_timeout_expires(&thread->base.timeout);
964}
965
974
975static inline k_ticks_t z_impl_k_thread_timeout_remaining_ticks(
976 const struct k_thread *thread)
977{
978 return z_timeout_remaining(&thread->base.timeout);
979}
980
981#endif /* CONFIG_SYS_CLOCK_EXISTS */
982
986struct _static_thread_data {
987 struct k_thread *init_thread;
988 k_thread_stack_t *init_stack;
989 unsigned int init_stack_size;
990 k_thread_entry_t init_entry;
991 void *init_p1;
992 void *init_p2;
993 void *init_p3;
994 int init_prio;
995 uint32_t init_options;
996 const char *init_name;
997#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
998 int32_t init_delay_ms;
999#else
1000 k_timeout_t init_delay;
1001#endif
1002};
1003
1004#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
1005#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay_ms = (ms)
1006#define Z_THREAD_INIT_DELAY(thread) SYS_TIMEOUT_MS((thread)->init_delay_ms)
1007#else
1008#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay = SYS_TIMEOUT_MS_INIT(ms)
1009#define Z_THREAD_INIT_DELAY(thread) (thread)->init_delay
1010#endif
1011
1012#define Z_THREAD_INITIALIZER(thread, stack, stack_size, \
1013 entry, p1, p2, p3, \
1014 prio, options, delay, tname) \
1015 { \
1016 .init_thread = (thread), \
1017 .init_stack = (stack), \
1018 .init_stack_size = (stack_size), \
1019 .init_entry = (k_thread_entry_t)entry, \
1020 .init_p1 = (void *)p1, \
1021 .init_p2 = (void *)p2, \
1022 .init_p3 = (void *)p3, \
1023 .init_prio = (prio), \
1024 .init_options = (options), \
1025 .init_name = STRINGIFY(tname), \
1026 Z_THREAD_INIT_DELAY_INITIALIZER(delay) \
1027 }
1028
1029/*
1030 * Refer to K_THREAD_DEFINE() and K_KERNEL_THREAD_DEFINE() for
1031 * information on arguments.
1032 */
1033#define Z_THREAD_COMMON_DEFINE(name, stack_size, \
1034 entry, p1, p2, p3, \
1035 prio, options, delay) \
1036 struct k_thread _k_thread_obj_##name; \
1037 const STRUCT_SECTION_ITERABLE(_static_thread_data, \
1038 _k_thread_data_##name) = \
1039 Z_THREAD_INITIALIZER(&_k_thread_obj_##name, \
1040 _k_thread_stack_##name, stack_size,\
1041 entry, p1, p2, p3, prio, options, \
1042 delay, name); \
1043 __maybe_unused const k_tid_t name = (k_tid_t)&_k_thread_obj_##name
1047
1079#define K_THREAD_DEFINE(name, stack_size, \
1080 entry, p1, p2, p3, \
1081 prio, options, delay) \
1082 K_THREAD_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
1083 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
1084 prio, options, delay)
1085
1116#define K_KERNEL_THREAD_DEFINE(name, stack_size, \
1117 entry, p1, p2, p3, \
1118 prio, options, delay) \
1119 K_KERNEL_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
1120 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
1121 prio, options, delay)
1122
1132__syscall int k_thread_priority_get(k_tid_t thread);
1133
1159__syscall void k_thread_priority_set(k_tid_t thread, int prio);
1160
1161
1162#ifdef CONFIG_SCHED_DEADLINE
1198__syscall void k_thread_deadline_set(k_tid_t thread, int deadline);
1199
1240__syscall void k_thread_absolute_deadline_set(k_tid_t thread, int deadline);
1241#endif
1242
1261__syscall void k_reschedule(void);
1262
1263#ifdef CONFIG_SCHED_CPU_MASK
1281
1300
1316
1335
1346int k_thread_cpu_pin(k_tid_t thread, int cpu);
1347#endif
1348
1370__syscall void k_thread_suspend(k_tid_t thread);
1371
1383__syscall void k_thread_resume(k_tid_t thread);
1384
1398static inline void k_thread_start(k_tid_t thread)
1399{
1400 k_wakeup(thread);
1401}
1402
1429void k_sched_time_slice_set(int32_t slice, int prio);
1430
1469void k_thread_time_slice_set(struct k_thread *th, int32_t slice_ticks,
1470 k_thread_timeslice_fn_t expired, void *data);
1471
1473
1478
1490bool k_is_in_isr(void);
1491
1508__syscall int k_is_preempt_thread(void);
1509
1513
1518
1544void k_sched_lock(void);
1545
1554
1567__syscall void k_thread_custom_data_set(void *value);
1568
1576__syscall void *k_thread_custom_data_get(void);
1577
1594__syscall int k_thread_name_set(k_tid_t thread, const char *str);
1595
1604const char *k_thread_name_get(k_tid_t thread);
1605
1618__syscall int k_thread_name_copy(k_tid_t thread, char *buf,
1619 size_t size);
1620
1633const char *k_thread_state_str(k_tid_t thread_id, char *buf, size_t buf_size);
1634
1638
1643
1652#define K_NO_WAIT Z_TIMEOUT_NO_WAIT
1653
1666#define K_NSEC(t) Z_TIMEOUT_NS(t)
1667
1680#define K_USEC(t) Z_TIMEOUT_US(t)
1681
1692#define K_CYC(t) Z_TIMEOUT_CYC(t)
1693
1704#define K_TICKS(t) Z_TIMEOUT_TICKS(t)
1705
1716#define K_MSEC(ms) Z_TIMEOUT_MS(ms)
1717
1728#define K_SECONDS(s) K_MSEC((s) * MSEC_PER_SEC)
1729
1740#define K_MINUTES(m) K_SECONDS((m) * 60)
1741
1752#define K_HOURS(h) K_MINUTES((h) * 60)
1753
1762#define K_FOREVER Z_FOREVER
1763
1778#define K_TIMEOUT_SUM(timeout1, timeout2) K_TICKS(z_timeout_sum(timeout1, timeout2))
1779
1780#ifdef CONFIG_TIMEOUT_64BIT
1781
1793#define K_TIMEOUT_ABS_TICKS(t) \
1794 Z_TIMEOUT_TICKS(Z_TICK_ABS((k_ticks_t)CLAMP(t, 0, (INT64_MAX - 1))))
1795
1807#define K_TIMEOUT_ABS_SEC(t) K_TIMEOUT_ABS_TICKS(k_sec_to_ticks_ceil64(t))
1808
1820#define K_TIMEOUT_ABS_MS(t) K_TIMEOUT_ABS_TICKS(k_ms_to_ticks_ceil64(t))
1821
1834#define K_TIMEOUT_ABS_US(t) K_TIMEOUT_ABS_TICKS(k_us_to_ticks_ceil64(t))
1835
1848#define K_TIMEOUT_ABS_NS(t) K_TIMEOUT_ABS_TICKS(k_ns_to_ticks_ceil64(t))
1849
1862#define K_TIMEOUT_ABS_CYC(t) K_TIMEOUT_ABS_TICKS(k_cyc_to_ticks_ceil64(t))
1863#endif
1864
1868
1875struct k_timer {
1879 /*
1880 * _timeout structure must be first here if we want to use
1881 * dynamic timer allocation. timeout.node is used in the double-linked
1882 * list of free timers
1883 */
1884 struct _timeout timeout;
1885
1886 /* wait queue for the (single) thread waiting on this timer */
1887 _wait_q_t wait_q;
1888
1889 /* runs in ISR context */
1890 void (*expiry_fn)(struct k_timer *timer);
1891
1892 /* runs in the context of the thread that calls k_timer_stop() */
1893 void (*stop_fn)(struct k_timer *timer);
1894
1895 /* timer period */
1896 k_timeout_t period;
1897
1898 /* timer status */
1899 uint32_t status;
1900
1901 /* user-specific data, also used to support legacy features */
1902 void *user_data;
1903
1905
1906#ifdef CONFIG_OBJ_CORE_TIMER
1907 struct k_obj_core obj_core;
1908#endif
1912};
1913
1914#ifdef CONFIG_TIMER_OBSERVER
1915struct k_timer_observer {
1916 /* Invoked upon completion of k_timer initialization */
1917 void (*on_init)(struct k_timer *timer);
1918
1919 /* Invoked after the timer transitions to the running state */
1920 void (*on_start)(struct k_timer *timer, k_timeout_t duration,
1921 k_timeout_t period);
1922
1923 /* Invoked when the active timer is explicitly stopped */
1924 void (*on_stop)(struct k_timer *timer);
1925
1926 /* Executes in ISR context, keep minimal and non-blocking */
1927 void (*on_expiry)(struct k_timer *timer);
1928};
1929#endif /* CONFIG_TIMER_OBSERVER */
1930
1934#define Z_TIMER_INITIALIZER(obj, expiry, stop) \
1935 { \
1936 .timeout = { \
1937 .fn = z_timer_expiration_handler, \
1938 }, \
1939 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
1940 .expiry_fn = expiry, \
1941 .stop_fn = stop, \
1942 .period = {}, \
1943 .status = 0, \
1944 .user_data = 0, \
1945 }
1949
1955
1966typedef void (*k_timer_expiry_t)(struct k_timer *timer);
1967
1982typedef void (*k_timer_stop_t)(struct k_timer *timer);
1983
1995#define K_TIMER_DEFINE(name, expiry_fn, stop_fn) \
1996 STRUCT_SECTION_ITERABLE(k_timer, name) = \
1997 Z_TIMER_INITIALIZER(name, expiry_fn, stop_fn)
1998
1999
2000#ifdef CONFIG_TIMER_OBSERVER
2001
2005#define Z_TIMER_OBSERVER_INITIALIZER(name, init, start, stop, expiry) \
2006 { \
2007 .on_init = init, \
2008 .on_start = start, \
2009 .on_stop = stop, \
2010 .on_expiry = expiry \
2011 }
2015
2029#define K_TIMER_OBSERVER_DEFINE(name, init, start, stop, expiry) \
2030 static const STRUCT_SECTION_ITERABLE(k_timer_observer, name) = \
2031 Z_TIMER_OBSERVER_INITIALIZER(name, init, start, stop, expiry)
2032
2033#endif /* CONFIG_TIMER_OBSERVER */
2034
2044void k_timer_init(struct k_timer *timer,
2045 k_timer_expiry_t expiry_fn,
2046 k_timer_stop_t stop_fn);
2047
2065__syscall void k_timer_start(struct k_timer *timer,
2066 k_timeout_t duration, k_timeout_t period);
2067
2084__syscall void k_timer_stop(struct k_timer *timer);
2085
2098__syscall uint32_t k_timer_status_get(struct k_timer *timer);
2099
2117__syscall uint32_t k_timer_status_sync(struct k_timer *timer);
2118
2119#ifdef CONFIG_SYS_CLOCK_EXISTS
2120
2132__syscall k_ticks_t k_timer_expires_ticks(const struct k_timer *timer);
2133
2134static inline k_ticks_t z_impl_k_timer_expires_ticks(
2135 const struct k_timer *timer)
2136{
2137 return z_timeout_expires(&timer->timeout);
2138}
2139
2150__syscall k_ticks_t k_timer_remaining_ticks(const struct k_timer *timer);
2151
2152static inline k_ticks_t z_impl_k_timer_remaining_ticks(
2153 const struct k_timer *timer)
2154{
2155 return z_timeout_remaining(&timer->timeout);
2156}
2157
2168static inline uint32_t k_timer_remaining_get(struct k_timer *timer)
2169{
2171}
2172
2173#endif /* CONFIG_SYS_CLOCK_EXISTS */
2174
2187__syscall void k_timer_user_data_set(struct k_timer *timer, void *user_data);
2188
2192static inline void z_impl_k_timer_user_data_set(struct k_timer *timer,
2193 void *user_data)
2194{
2195 timer->user_data = user_data;
2196}
2197
2205__syscall void *k_timer_user_data_get(const struct k_timer *timer);
2206
2207static inline void *z_impl_k_timer_user_data_get(const struct k_timer *timer)
2208{
2209 return timer->user_data;
2210}
2211
2232int k_timer_cleanup(struct k_timer *timer);
2233
2235
2241
2251__syscall int64_t k_uptime_ticks(void);
2252
2266static inline int64_t k_uptime_get(void)
2267{
2269}
2270
2290static inline uint32_t k_uptime_get_32(void)
2291{
2292 return (uint32_t)k_uptime_get();
2293}
2294
2303static inline uint32_t k_uptime_seconds(void)
2304{
2306}
2307
2319static inline int64_t k_uptime_delta(int64_t *reftime)
2320{
2321 int64_t uptime, delta;
2322
2323 uptime = k_uptime_get();
2324 delta = uptime - *reftime;
2325 *reftime = uptime;
2326
2327 return delta;
2328}
2329
2338static inline uint32_t k_cycle_get_32(void)
2339{
2340 return arch_k_cycle_get_32();
2341}
2342
2356static inline uint64_t k_cycle_get_64(void)
2357{
2358 if (!IS_ENABLED(CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER)) {
2359 __ASSERT(0, "64-bit cycle counter not enabled on this platform. "
2360 "See CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER");
2361 return 0;
2362 }
2363
2364 return arch_k_cycle_get_64();
2365}
2366
2370
2377struct k_queue {
2381 sys_sflist_t data_q;
2382 struct k_spinlock lock;
2383 _wait_q_t wait_q;
2384
2385 Z_DECL_POLL_EVENT
2386
2391};
2392
2396#define Z_QUEUE_INITIALIZER(obj) \
2397 { \
2398 .data_q = SYS_SFLIST_STATIC_INIT(&obj.data_q), \
2399 .lock = { }, \
2400 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
2401 Z_POLL_EVENT_OBJ_INIT(obj) \
2402 }
2406
2412
2420__syscall void k_queue_init(struct k_queue *queue);
2421
2435__syscall void k_queue_cancel_wait(struct k_queue *queue);
2436
2449void k_queue_append(struct k_queue *queue, void *data);
2450
2467__syscall int32_t k_queue_alloc_append(struct k_queue *queue, void *data);
2468
2481void k_queue_prepend(struct k_queue *queue, void *data);
2482
2499__syscall int32_t k_queue_alloc_prepend(struct k_queue *queue, void *data);
2500
2514void k_queue_insert(struct k_queue *queue, void *prev, void *data);
2515
2534int k_queue_append_list(struct k_queue *queue, void *head, void *tail);
2535
2553int k_queue_merge_slist(struct k_queue *queue, sys_slist_t *list);
2554
2572__syscall void *k_queue_get(struct k_queue *queue, k_timeout_t timeout);
2573
2588bool k_queue_remove(struct k_queue *queue, void *data);
2589
2604bool k_queue_unique_append(struct k_queue *queue, void *data);
2605
2619__syscall int k_queue_is_empty(struct k_queue *queue);
2620
2621static inline int z_impl_k_queue_is_empty(struct k_queue *queue)
2622{
2623 return sys_sflist_is_empty(&queue->data_q) ? 1 : 0;
2624}
2625
2635__syscall void *k_queue_peek_head(struct k_queue *queue);
2636
2646__syscall void *k_queue_peek_tail(struct k_queue *queue);
2647
2657#define K_QUEUE_DEFINE(name) \
2658 STRUCT_SECTION_ITERABLE(k_queue, name) = \
2659 Z_QUEUE_INITIALIZER(name)
2660
2662
2663#ifdef CONFIG_USERSPACE
2673struct k_futex {
2680};
2681
2691struct z_futex_data {
2695 _wait_q_t wait_q;
2696 struct k_spinlock lock;
2700};
2701
2705#define Z_FUTEX_DATA_INITIALIZER(obj) \
2706 { \
2707 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q) \
2708 }
2712
2718
2738__syscall int k_futex_wait(struct k_futex *futex, int expected,
2739 k_timeout_t timeout);
2740
2755__syscall int k_futex_wake(struct k_futex *futex, bool wake_all);
2756
2758#endif
2759
2765
2770
2777
2778struct k_event {
2782 _wait_q_t wait_q;
2783 uint32_t events;
2784 struct k_spinlock lock;
2785
2787
2788#ifdef CONFIG_OBJ_CORE_EVENT
2789 struct k_obj_core obj_core;
2790#endif
2794};
2795
2799#define Z_EVENT_INITIALIZER(obj) \
2800 { \
2801 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
2802 .events = 0, \
2803 .lock = {}, \
2804 }
2808
2816__syscall void k_event_init(struct k_event *event);
2817
2836__syscall uint32_t k_event_post(struct k_event *event, uint32_t events);
2837
2855__syscall uint32_t k_event_set(struct k_event *event, uint32_t events);
2856
2873__syscall uint32_t k_event_set_masked(struct k_event *event, uint32_t events,
2874 uint32_t events_mask);
2875
2889__syscall uint32_t k_event_clear(struct k_event *event, uint32_t events);
2890
2915__syscall uint32_t k_event_wait(struct k_event *event, uint32_t events,
2916 bool reset, k_timeout_t timeout);
2917
2942__syscall uint32_t k_event_wait_all(struct k_event *event, uint32_t events,
2943 bool reset, k_timeout_t timeout);
2944
2964__syscall uint32_t k_event_wait_safe(struct k_event *event, uint32_t events,
2965 bool reset, k_timeout_t timeout);
2966
2986__syscall uint32_t k_event_wait_all_safe(struct k_event *event, uint32_t events,
2987 bool reset, k_timeout_t timeout);
2988
2999static inline uint32_t k_event_test(struct k_event *event, uint32_t events_mask)
3000{
3001 return k_event_wait(event, events_mask, false, K_NO_WAIT);
3002}
3003
3013#define K_EVENT_DEFINE(name) \
3014 STRUCT_SECTION_ITERABLE(k_event, name) = \
3015 Z_EVENT_INITIALIZER(name);
3016
3018
3024struct k_fifo {
3028 struct k_queue _queue;
3029#ifdef CONFIG_OBJ_CORE_FIFO
3030 struct k_obj_core obj_core;
3031#endif
3035};
3036
3040#define Z_FIFO_INITIALIZER(obj) \
3041 { \
3042 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
3043 }
3047
3053
3061#define k_fifo_init(fifo) \
3062 ({ \
3063 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, init, fifo); \
3064 k_queue_init(&(fifo)->_queue); \
3065 K_OBJ_CORE_INIT(K_OBJ_CORE(fifo), _obj_type_fifo); \
3066 K_OBJ_CORE_LINK(K_OBJ_CORE(fifo)); \
3067 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, init, fifo); \
3068 })
3069
3081#define k_fifo_cancel_wait(fifo) \
3082 ({ \
3083 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, cancel_wait, fifo); \
3084 k_queue_cancel_wait(&(fifo)->_queue); \
3085 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, cancel_wait, fifo); \
3086 })
3087
3100#define k_fifo_put(fifo, data) \
3101 ({ \
3102 void *_data = data; \
3103 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put, fifo, _data); \
3104 k_queue_append(&(fifo)->_queue, _data); \
3105 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put, fifo, _data); \
3106 })
3107
3124#define k_fifo_alloc_put(fifo, data) \
3125 ({ \
3126 void *_data = data; \
3127 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, alloc_put, fifo, _data); \
3128 int fap_ret = k_queue_alloc_append(&(fifo)->_queue, _data); \
3129 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, alloc_put, fifo, _data, fap_ret); \
3130 fap_ret; \
3131 })
3132
3150#define k_fifo_put_list(fifo, head, tail) \
3151 ({ \
3152 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_list, fifo, head, tail); \
3153 k_queue_append_list(&(fifo)->_queue, head, tail); \
3154 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_list, fifo, head, tail); \
3155 })
3156
3173#define k_fifo_put_slist(fifo, list) \
3174 ({ \
3175 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_slist, fifo, list); \
3176 k_queue_merge_slist(&(fifo)->_queue, list); \
3177 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_slist, fifo, list); \
3178 })
3179
3197#define k_fifo_get(fifo, timeout) \
3198 ({ \
3199 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, get, fifo, timeout); \
3200 void *fg_ret = k_queue_get(&(fifo)->_queue, timeout); \
3201 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, get, fifo, timeout, fg_ret); \
3202 fg_ret; \
3203 })
3204
3218#define k_fifo_is_empty(fifo) \
3219 k_queue_is_empty(&(fifo)->_queue)
3220
3234#define k_fifo_peek_head(fifo) \
3235 ({ \
3236 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_head, fifo); \
3237 void *fph_ret = k_queue_peek_head(&(fifo)->_queue); \
3238 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_head, fifo, fph_ret); \
3239 fph_ret; \
3240 })
3241
3253#define k_fifo_peek_tail(fifo) \
3254 ({ \
3255 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_tail, fifo); \
3256 void *fpt_ret = k_queue_peek_tail(&(fifo)->_queue); \
3257 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_tail, fifo, fpt_ret); \
3258 fpt_ret; \
3259 })
3260
3270#define K_FIFO_DEFINE(name) \
3271 STRUCT_SECTION_ITERABLE(k_fifo, name) = \
3272 Z_FIFO_INITIALIZER(name)
3273
3275
3281struct k_lifo {
3285 struct k_queue _queue;
3286#ifdef CONFIG_OBJ_CORE_LIFO
3287 struct k_obj_core obj_core;
3288#endif
3292};
3293
3297#define Z_LIFO_INITIALIZER(obj) \
3298 { \
3299 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
3300 }
3304
3310
3318#define k_lifo_init(lifo) \
3319 ({ \
3320 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, init, lifo); \
3321 k_queue_init(&(lifo)->_queue); \
3322 K_OBJ_CORE_INIT(K_OBJ_CORE(lifo), _obj_type_lifo); \
3323 K_OBJ_CORE_LINK(K_OBJ_CORE(lifo)); \
3324 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, init, lifo); \
3325 })
3326
3339#define k_lifo_put(lifo, data) \
3340 ({ \
3341 void *_data = data; \
3342 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, put, lifo, _data); \
3343 k_queue_prepend(&(lifo)->_queue, _data); \
3344 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, put, lifo, _data); \
3345 })
3346
3363#define k_lifo_alloc_put(lifo, data) \
3364 ({ \
3365 void *_data = data; \
3366 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, alloc_put, lifo, _data); \
3367 int lap_ret = k_queue_alloc_prepend(&(lifo)->_queue, _data); \
3368 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, alloc_put, lifo, _data, lap_ret); \
3369 lap_ret; \
3370 })
3371
3389#define k_lifo_get(lifo, timeout) \
3390 ({ \
3391 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, get, lifo, timeout); \
3392 void *lg_ret = k_queue_get(&(lifo)->_queue, timeout); \
3393 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, get, lifo, timeout, lg_ret); \
3394 lg_ret; \
3395 })
3396
3406#define K_LIFO_DEFINE(name) \
3407 STRUCT_SECTION_ITERABLE(k_lifo, name) = \
3408 Z_LIFO_INITIALIZER(name)
3409
3411
3415#define K_STACK_FLAG_ALLOC ((uint8_t)1) /* Buffer was allocated */
3416
3417typedef uintptr_t stack_data_t;
3418
3419struct k_stack {
3420 _wait_q_t wait_q;
3421 struct k_spinlock lock;
3422 stack_data_t *base, *next, *top;
3423
3424 uint8_t flags;
3425
3427
3428#ifdef CONFIG_OBJ_CORE_STACK
3429 struct k_obj_core obj_core;
3430#endif
3431};
3432
3433#define Z_STACK_INITIALIZER(obj, stack_buffer, stack_num_entries) \
3434 { \
3435 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3436 .base = (stack_buffer), \
3437 .next = (stack_buffer), \
3438 .top = (stack_buffer) + (stack_num_entries), \
3439 }
3443
3449
3459void k_stack_init(struct k_stack *stack,
3460 stack_data_t *buffer, uint32_t num_entries);
3461
3462
3477
3478__syscall int32_t k_stack_alloc_init(struct k_stack *stack,
3479 uint32_t num_entries);
3480
3492int k_stack_cleanup(struct k_stack *stack);
3493
3507__syscall int k_stack_push(struct k_stack *stack, stack_data_t data);
3508
3529__syscall int k_stack_pop(struct k_stack *stack, stack_data_t *data,
3530 k_timeout_t timeout);
3531
3542#define K_STACK_DEFINE(name, stack_num_entries) \
3543 stack_data_t __noinit \
3544 _k_stack_buf_##name[stack_num_entries]; \
3545 STRUCT_SECTION_ITERABLE(k_stack, name) = \
3546 Z_STACK_INITIALIZER(name, _k_stack_buf_##name, \
3547 stack_num_entries)
3548
3550
3554struct k_work;
3555struct k_work_q;
3556struct k_work_queue_config;
3557extern struct k_work_q k_sys_work_q;
3561
3567
3573struct k_mutex {
3578 _wait_q_t wait_q;
3580 struct k_thread *owner;
3581
3583 uint32_t lock_count;
3584
3585#if Z_MUTEX_PI_ENABLED
3587 sys_snode_t held_node;
3588#endif /* Z_MUTEX_PI_ENABLED */
3589
3591
3592#ifdef CONFIG_OBJ_CORE_MUTEX
3593 struct k_obj_core obj_core;
3594#endif
3598};
3599
3603#if Z_MUTEX_PI_ENABLED
3604#define Z_MUTEX_HELD_NODE_INIT .held_node = {NULL},
3605#else
3606#define Z_MUTEX_HELD_NODE_INIT
3607#endif
3608
3609#define Z_MUTEX_INITIALIZER(obj) \
3610 { \
3611 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3612 .owner = NULL, \
3613 .lock_count = 0, \
3614 Z_MUTEX_HELD_NODE_INIT \
3615 }
3619
3629#define K_MUTEX_DEFINE(name) \
3630 STRUCT_SECTION_ITERABLE(k_mutex, name) = \
3631 Z_MUTEX_INITIALIZER(name)
3632
3645__syscall int k_mutex_init(struct k_mutex *mutex);
3646
3647
3669__syscall int k_mutex_lock(struct k_mutex *mutex, k_timeout_t timeout);
3670
3691__syscall int k_mutex_unlock(struct k_mutex *mutex);
3692
3696
3706 _wait_q_t wait_q;
3707
3708#ifdef CONFIG_OBJ_CORE_CONDVAR
3709 struct k_obj_core obj_core;
3710#endif
3714};
3715
3719#define Z_CONDVAR_INITIALIZER(obj) \
3720 { \
3721 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
3722 }
3726
3732
3739__syscall int k_condvar_init(struct k_condvar *condvar);
3740
3747__syscall int k_condvar_signal(struct k_condvar *condvar);
3748
3756__syscall int k_condvar_broadcast(struct k_condvar *condvar);
3757
3775__syscall int k_condvar_wait(struct k_condvar *condvar, struct k_mutex *mutex,
3776 k_timeout_t timeout);
3777
3788#define K_CONDVAR_DEFINE(name) \
3789 STRUCT_SECTION_ITERABLE(k_condvar, name) = \
3790 Z_CONDVAR_INITIALIZER(name)
3791
3794
3800
3807struct k_sem {
3811 _wait_q_t wait_q;
3812 unsigned int count;
3813 unsigned int limit;
3814
3815 Z_DECL_POLL_EVENT
3816
3818
3819#ifdef CONFIG_OBJ_CORE_SEM
3820 struct k_obj_core obj_core;
3821#endif
3825};
3826
3830#define Z_SEM_INITIALIZER(obj, initial_count, count_limit) \
3831 { \
3832 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3833 .count = (initial_count), \
3834 .limit = (count_limit), \
3835 Z_POLL_EVENT_OBJ_INIT(obj) \
3836 }
3840
3849#define K_SEM_MAX_LIMIT UINT_MAX
3850
3866__syscall int k_sem_init(struct k_sem *sem, unsigned int initial_count,
3867 unsigned int limit);
3868
3887__syscall int k_sem_take(struct k_sem *sem, k_timeout_t timeout);
3888
3899__syscall void k_sem_give(struct k_sem *sem);
3900
3910__syscall void k_sem_reset(struct k_sem *sem);
3911
3921__syscall unsigned int k_sem_count_get(struct k_sem *sem);
3922
3926static inline unsigned int z_impl_k_sem_count_get(struct k_sem *sem)
3927{
3928 return sem->count;
3929}
3930
3942#define K_SEM_DEFINE(name, initial_count, count_limit) \
3943 STRUCT_SECTION_ITERABLE(k_sem, name) = \
3944 Z_SEM_INITIALIZER(name, initial_count, count_limit); \
3945 BUILD_ASSERT(((count_limit) != 0) && \
3946 (((initial_count) < (count_limit)) || ((initial_count) == (count_limit))) && \
3947 ((count_limit) <= K_SEM_MAX_LIMIT));
3948
3950
3951#if defined(CONFIG_SCHED_IPI_SUPPORTED) || defined(__DOXYGEN__)
3952struct k_ipi_work;
3953
3954
3962typedef void (*k_ipi_func_t)(struct k_ipi_work *work);
3963
3974 sys_dnode_t node[CONFIG_MP_MAX_NUM_CPUS]; /* Node in IPI work queue */
3975 k_ipi_func_t func; /* Function to execute on target CPU */
3976 struct k_event event; /* Event to signal when processed */
3977 uint32_t bitmask; /* Bitmask of targeted CPUs */
3981};
3982
3983
3991static inline void k_ipi_work_init(struct k_ipi_work *work)
3992{
3993 k_event_init(&work->event);
3994 for (unsigned int i = 0; i < CONFIG_MP_MAX_NUM_CPUS; i++) {
3995 sys_dnode_init(&work->node[i]);
3996 }
3997 work->bitmask = 0;
3998}
3999
4018int k_ipi_work_add(struct k_ipi_work *work, uint32_t cpu_bitmask,
4019 k_ipi_func_t func);
4020
4043int k_ipi_work_wait(struct k_ipi_work *work, k_timeout_t timeout);
4044
4054
4055#endif /* CONFIG_SCHED_IPI_SUPPORTED */
4056
4060struct k_work_delayable;
4061struct k_work_sync;
4065
4071
4078typedef void (*k_work_handler_t)(struct k_work *work);
4079
4093void k_work_init(struct k_work *work,
4094 k_work_handler_t handler);
4095
4110int k_work_busy_get(const struct k_work *work);
4111
4125static inline bool k_work_is_pending(const struct k_work *work);
4126
4148 struct k_work *work);
4149
4158int k_work_submit(struct k_work *work);
4159
4184bool k_work_flush(struct k_work *work,
4185 struct k_work_sync *sync);
4186
4206int k_work_cancel(struct k_work *work);
4207
4238bool k_work_cancel_sync(struct k_work *work, struct k_work_sync *sync);
4239
4249void k_work_queue_init(struct k_work_q *queue);
4250
4270void k_work_queue_start(struct k_work_q *queue,
4271 k_thread_stack_t *stack, size_t stack_size,
4272 int prio, const struct k_work_queue_config *cfg);
4273
4284void k_work_queue_run(struct k_work_q *queue, const struct k_work_queue_config *cfg);
4285
4295static inline k_tid_t k_work_queue_thread_get(struct k_work_q *queue);
4296
4320int k_work_queue_drain(struct k_work_q *queue, bool plug);
4321
4336
4356int k_work_queue_stop(struct k_work_q *queue, k_timeout_t timeout);
4357
4372 k_work_handler_t handler);
4373
4385static inline struct k_work_delayable *
4387
4402
4417static inline bool k_work_delayable_is_pending(
4418 const struct k_work_delayable *dwork);
4419
4434 const struct k_work_delayable *dwork);
4435
4450 const struct k_work_delayable *dwork);
4451
4480 struct k_work_delayable *dwork,
4481 k_timeout_t delay);
4482
4497 k_timeout_t delay);
4498
4535 struct k_work_delayable *dwork,
4536 k_timeout_t delay);
4537
4551 k_timeout_t delay);
4552
4578 struct k_work_sync *sync);
4579
4601
4631 struct k_work_sync *sync);
4632
4634enum {
4638 /* The atomic API is used for all work and queue flags fields to
4639 * enforce sequential consistency in SMP environments.
4640 */
4641
4642 /* Bits that represent the work item states. At least nine of the
4643 * combinations are distinct valid stable states.
4644 */
4645 K_WORK_RUNNING_BIT = 0,
4646 K_WORK_CANCELING_BIT = 1,
4647 K_WORK_QUEUED_BIT = 2,
4648 K_WORK_DELAYED_BIT = 3,
4649 K_WORK_FLUSHING_BIT = 4,
4650
4651 K_WORK_MASK = BIT(K_WORK_DELAYED_BIT) | BIT(K_WORK_QUEUED_BIT)
4652 | BIT(K_WORK_RUNNING_BIT) | BIT(K_WORK_CANCELING_BIT) | BIT(K_WORK_FLUSHING_BIT),
4653
4654 /* Static work flags */
4655 K_WORK_DELAYABLE_BIT = 8,
4656 K_WORK_DELAYABLE = BIT(K_WORK_DELAYABLE_BIT),
4657
4658 /* Dynamic work queue flags */
4659 K_WORK_QUEUE_STARTED_BIT = 0,
4660 K_WORK_QUEUE_STARTED = BIT(K_WORK_QUEUE_STARTED_BIT),
4661 K_WORK_QUEUE_BUSY_BIT = 1,
4662 K_WORK_QUEUE_BUSY = BIT(K_WORK_QUEUE_BUSY_BIT),
4663 K_WORK_QUEUE_DRAIN_BIT = 2,
4664 K_WORK_QUEUE_DRAIN = BIT(K_WORK_QUEUE_DRAIN_BIT),
4665 K_WORK_QUEUE_PLUGGED_BIT = 3,
4666 K_WORK_QUEUE_PLUGGED = BIT(K_WORK_QUEUE_PLUGGED_BIT),
4667 K_WORK_QUEUE_STOP_BIT = 4,
4668 K_WORK_QUEUE_STOP = BIT(K_WORK_QUEUE_STOP_BIT),
4669
4670 /* Static work queue flags */
4671 K_WORK_QUEUE_NO_YIELD_BIT = 8,
4672 K_WORK_QUEUE_NO_YIELD = BIT(K_WORK_QUEUE_NO_YIELD_BIT),
4676 /* Transient work flags */
4677
4683 K_WORK_RUNNING = BIT(K_WORK_RUNNING_BIT),
4684
4689 K_WORK_CANCELING = BIT(K_WORK_CANCELING_BIT),
4690
4696 K_WORK_QUEUED = BIT(K_WORK_QUEUED_BIT),
4697
4703 K_WORK_DELAYED = BIT(K_WORK_DELAYED_BIT),
4704
4709 K_WORK_FLUSHING = BIT(K_WORK_FLUSHING_BIT),
4710};
4711
4717struct k_work {
4721 /* All fields are protected by the work module spinlock. */
4722
4723 /* Node to link into k_work_q pending list. */
4724 sys_snode_t node;
4725
4726 /* The function to be invoked by the work queue thread. */
4727 k_work_handler_t handler;
4728
4729 /* The queue on which the work item was last submitted. */
4730 struct k_work_q *queue;
4731
4732 /* State of the work item.
4733 *
4734 * The item can be DELAYED, QUEUED, and RUNNING simultaneously.
4735 *
4736 * It can be RUNNING and CANCELING simultaneously.
4737 */
4742};
4743
4747#define Z_WORK_INITIALIZER(work_handler) { \
4748 .handler = (work_handler), \
4749}
4753
4763 /* The work item. */
4764 struct k_work work;
4765
4766 /* Timeout used to submit work after a delay. */
4767 struct _timeout timeout;
4768
4769 /* The queue to which the work should be submitted. */
4770 struct k_work_q *queue;
4774};
4775
4779#define Z_WORK_DELAYABLE_INITIALIZER(work_handler) { \
4780 .work = { \
4781 .handler = (work_handler), \
4782 .flags = K_WORK_DELAYABLE, \
4783 }, \
4784}
4788
4805#define K_WORK_DELAYABLE_DEFINE(work, work_handler) \
4806 struct k_work_delayable work \
4807 = Z_WORK_DELAYABLE_INITIALIZER(work_handler)
4808
4812/* Record used to wait for work to flush.
4813 *
4814 * The work item is inserted into the queue that will process (or is
4815 * processing) the item, and will be processed as soon as the item
4816 * completes. When the flusher is processed the semaphore will be
4817 * signaled, releasing the thread waiting for the flush.
4818 */
4819struct z_work_flusher {
4820 struct k_work work;
4821 struct k_sem sem;
4822};
4823
4824/* Record used to wait for work to complete a cancellation.
4825 *
4826 * The work item is inserted into a global queue of pending cancels.
4827 * When a cancelling work item goes idle any matching waiters are
4828 * removed from pending_cancels and are woken.
4829 */
4830struct z_work_canceller {
4831 sys_snode_t node;
4832 struct k_work *work;
4833 struct k_sem sem;
4834};
4838
4858 union {
4859 struct z_work_flusher flusher;
4860 struct z_work_canceller canceller;
4861 };
4865};
4866
4878 const char *name;
4879
4893
4898
4908};
4909
4915struct k_work_q {
4919 /* The thread that animates the work. */
4920 __deprecated struct k_thread thread;
4921
4922 /* The thread ID that animates the work. This may be an external thread
4923 * if k_work_queue_run() is used.
4924 */
4925 k_tid_t thread_id;
4926
4927 /* All the following fields must be accessed only while the
4928 * work module spinlock is held.
4929 */
4930
4931 /* List of k_work items to be worked. */
4932 sys_slist_t pending;
4933
4934 /* Wait queue for idle work thread. */
4935 _wait_q_t notifyq;
4936
4937 /* Wait queue for threads waiting for the queue to drain. */
4938 _wait_q_t drainq;
4939
4940 /* Flags describing queue state. */
4942
4943#if defined(CONFIG_WORKQUEUE_WORK_TIMEOUT)
4944 struct _timeout work_timeout_record;
4945 struct k_work *work;
4946 k_timeout_t work_timeout;
4947 bool finished;
4948#endif /* defined(CONFIG_WORKQUEUE_WORK_TIMEOUT) */
4952};
4953
4954/* Provide the implementation for inline functions declared above */
4955
4956static inline bool k_work_is_pending(const struct k_work *work)
4957{
4958 return k_work_busy_get(work) != 0;
4959}
4960
4961static inline struct k_work_delayable *
4963{
4964 return CONTAINER_OF(work, struct k_work_delayable, work);
4965}
4966
4968 const struct k_work_delayable *dwork)
4969{
4970 return k_work_delayable_busy_get(dwork) != 0;
4971}
4972
4974 const struct k_work_delayable *dwork)
4975{
4976 return z_timeout_expires(&dwork->timeout);
4977}
4978
4980 const struct k_work_delayable *dwork)
4981{
4982 return z_timeout_remaining(&dwork->timeout);
4983}
4984
4985static inline k_tid_t k_work_queue_thread_get(struct k_work_q *queue)
4986{
4987 return queue->thread_id;
4988}
4989
4991
4992struct k_work_user;
4993
4998
5008typedef void (*k_work_user_handler_t)(struct k_work_user *work);
5009
5013struct k_work_user_q {
5014 struct k_queue queue;
5015 struct k_thread thread;
5016};
5017
5018enum {
5019 K_WORK_USER_STATE_PENDING, /* Work item pending state */
5020};
5021
5022struct k_work_user {
5023 void *_reserved; /* Used by k_queue implementation. */
5024 k_work_user_handler_t handler;
5026};
5027
5028#if defined(__cplusplus) && ((__cplusplus - 0) < 202002L)
5029#define Z_WORK_USER_INITIALIZER(work_handler) { NULL, work_handler, 0 }
5030#else
5031#define Z_WORK_USER_INITIALIZER(work_handler) \
5032 { \
5033 ._reserved = NULL, \
5034 .handler = (work_handler), \
5035 .flags = 0 \
5036 }
5037#endif
5041
5053#define K_WORK_USER_DEFINE(work, work_handler) \
5054 struct k_work_user work = Z_WORK_USER_INITIALIZER(work_handler)
5055
5065static inline void k_work_user_init(struct k_work_user *work,
5066 k_work_user_handler_t handler)
5067{
5068 *work = (struct k_work_user)Z_WORK_USER_INITIALIZER(handler);
5069}
5070
5087static inline bool k_work_user_is_pending(struct k_work_user *work)
5088{
5089 return atomic_test_bit(&work->flags, K_WORK_USER_STATE_PENDING);
5090}
5091
5110static inline int k_work_user_submit_to_queue(struct k_work_user_q *work_q,
5111 struct k_work_user *work)
5112{
5113 int ret = -EBUSY;
5114
5115 if (!atomic_test_and_set_bit(&work->flags,
5116 K_WORK_USER_STATE_PENDING)) {
5117 ret = k_queue_alloc_append(&work_q->queue, work);
5118
5119 /* Couldn't insert into the queue. Clear the pending bit
5120 * so the work item can be submitted again
5121 */
5122 if (ret != 0) {
5123 atomic_clear_bit(&work->flags,
5124 K_WORK_USER_STATE_PENDING);
5125 }
5126 }
5127
5128 return ret;
5129}
5130
5150void k_work_user_queue_start(struct k_work_user_q *work_q,
5151 k_thread_stack_t *stack,
5152 size_t stack_size, int prio,
5153 const char *name);
5154
5165static inline k_tid_t k_work_user_queue_thread_get(struct k_work_user_q *work_q)
5166{
5167 return &work_q->thread;
5168}
5169
5171
5175struct k_work_poll {
5176 struct k_work work;
5177 struct k_work_q *workq;
5178 struct z_poller poller;
5179 struct k_poll_event *events;
5180 int num_events;
5181 k_work_handler_t real_handler;
5182 struct _timeout timeout;
5183 int poll_result;
5184};
5188
5193
5205#define K_WORK_DEFINE(work, work_handler) \
5206 struct k_work work = Z_WORK_INITIALIZER(work_handler)
5207
5217void k_work_poll_init(struct k_work_poll *work,
5218 k_work_handler_t handler);
5219
5255 struct k_work_poll *work,
5256 struct k_poll_event *events,
5257 int num_events,
5258 k_timeout_t timeout);
5259
5291int k_work_poll_submit(struct k_work_poll *work,
5292 struct k_poll_event *events,
5293 int num_events,
5294 k_timeout_t timeout);
5295
5310int k_work_poll_cancel(struct k_work_poll *work);
5311
5313
5319
5325struct k_msgq {
5330 _wait_q_t wait_q;
5332 struct k_spinlock lock;
5334 size_t msg_size;
5336 uint32_t max_msgs;
5338 char *buffer_start;
5340 char *buffer_end;
5342 char *read_ptr;
5344 char *write_ptr;
5346 uint32_t used_msgs;
5347
5348 Z_DECL_POLL_EVENT
5349
5351 uint8_t flags;
5352
5354
5355#ifdef CONFIG_OBJ_CORE_MSGQ
5356 struct k_obj_core obj_core;
5357#endif
5361};
5362
5366#define Z_MSGQ_INITIALIZER(obj, q_buffer, q_msg_size, q_max_msgs) \
5367 { \
5368 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
5369 .lock = {}, \
5370 .msg_size = q_msg_size, \
5371 .max_msgs = q_max_msgs, \
5372 .buffer_start = q_buffer, \
5373 .buffer_end = q_buffer + (q_max_msgs * q_msg_size), \
5374 .read_ptr = q_buffer, \
5375 .write_ptr = q_buffer, \
5376 .used_msgs = 0, \
5377 Z_POLL_EVENT_OBJ_INIT(obj) \
5378 .flags = 0, \
5379 }
5380
5381#define K_MSGQ_FLAG_ALLOC BIT(0)
5385
5397
5398
5421#define K_MSGQ_DEFINE(q_name, q_msg_size, q_max_msgs, q_align) \
5422 static char __noinit __aligned(q_align) \
5423 _k_fifo_buf_##q_name[(q_max_msgs) * (q_msg_size)]; \
5424 STRUCT_SECTION_ITERABLE(k_msgq, q_name) = \
5425 Z_MSGQ_INITIALIZER(q_name, _k_fifo_buf_##q_name, \
5426 (q_msg_size), (q_max_msgs))
5427
5441#define K_MSGQ_DEFINE_STATIC(q_name, q_msg_size, q_max_msgs, q_align) \
5442 static char __noinit __aligned(q_align) \
5443 _k_fifo_buf_##q_name[(q_max_msgs) * (q_msg_size)]; \
5444 static STRUCT_SECTION_ITERABLE(k_msgq, q_name) = \
5445 Z_MSGQ_INITIALIZER(q_name, _k_fifo_buf_##q_name, \
5446 (q_msg_size), (q_max_msgs))
5447
5467#define K_MSGQ_DEFINE_TYPE(q_name, q_msg_type, q_max_msgs) \
5468 K_MSGQ_DEFINE(q_name, sizeof(q_msg_type), q_max_msgs, __alignof(q_msg_type))
5469
5481#define K_MSGQ_DEFINE_STATIC_TYPE(q_name, q_msg_type, q_max_msgs) \
5482 K_MSGQ_DEFINE_STATIC(q_name, sizeof(q_msg_type), q_max_msgs, __alignof(q_msg_type))
5483
5498void k_msgq_init(struct k_msgq *msgq, char *buffer, size_t msg_size,
5499 uint32_t max_msgs);
5500
5520__syscall int k_msgq_alloc_init(struct k_msgq *msgq, size_t msg_size,
5521 uint32_t max_msgs);
5522
5536int k_msgq_cleanup(struct k_msgq *msgq);
5537
5558__syscall int k_msgq_put(struct k_msgq *msgq, const void *data, k_timeout_t timeout);
5559
5584__syscall int k_msgq_put_front(struct k_msgq *msgq, const void *data);
5585
5606__syscall int k_msgq_get(struct k_msgq *msgq, void *data, k_timeout_t timeout);
5607
5622__syscall int k_msgq_peek(struct k_msgq *msgq, void *data);
5623
5640__syscall int k_msgq_peek_at(struct k_msgq *msgq, void *data, uint32_t idx);
5641
5651__syscall void k_msgq_purge(struct k_msgq *msgq);
5652
5663__syscall uint32_t k_msgq_num_free_get(struct k_msgq *msgq);
5664
5673__syscall void k_msgq_get_attrs(struct k_msgq *msgq,
5674 struct k_msgq_attrs *attrs);
5675
5676
5677static inline uint32_t z_impl_k_msgq_num_free_get(struct k_msgq *msgq)
5678{
5679 return msgq->max_msgs - msgq->used_msgs;
5680}
5681
5691__syscall uint32_t k_msgq_num_used_get(struct k_msgq *msgq);
5692
5693static inline uint32_t z_impl_k_msgq_num_used_get(struct k_msgq *msgq)
5694{
5695 return msgq->used_msgs;
5696}
5697
5699
5705
5712 size_t size;
5716 void *tx_data;
5725 k_tid_t _syncing_thread;
5726#if (CONFIG_NUM_MBOX_ASYNC_MSGS > 0)
5728 struct k_sem *_async_sem;
5729#endif
5733};
5734
5739struct k_mbox {
5744 _wait_q_t tx_msg_queue;
5746 _wait_q_t rx_msg_queue;
5747 struct k_spinlock lock;
5748
5750
5751#ifdef CONFIG_OBJ_CORE_MAILBOX
5752 struct k_obj_core obj_core;
5753#endif
5757};
5758
5762#define Z_MBOX_INITIALIZER(obj) \
5763 { \
5764 .tx_msg_queue = Z_WAIT_Q_INIT(&obj.tx_msg_queue), \
5765 .rx_msg_queue = Z_WAIT_Q_INIT(&obj.rx_msg_queue), \
5766 }
5770
5780#define K_MBOX_DEFINE(name) \
5781 STRUCT_SECTION_ITERABLE(k_mbox, name) = \
5782 Z_MBOX_INITIALIZER(name) \
5783
5784
5791void k_mbox_init(struct k_mbox *mbox);
5792
5812int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
5813 k_timeout_t timeout);
5814
5828void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
5829 struct k_sem *sem);
5830
5848int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *rx_msg,
5849 void *buffer, k_timeout_t timeout);
5850
5864void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer);
5865
5867
5873
5883__syscall void k_pipe_init(struct k_pipe *pipe, uint8_t *buffer, size_t buffer_size);
5884
5888enum pipe_flags {
5889 PIPE_FLAG_OPEN = BIT(0),
5890 PIPE_FLAG_RESET = BIT(1),
5891};
5895
5901struct k_pipe {
5905 size_t waiting;
5906 struct ring_buf buf;
5907 struct k_spinlock lock;
5908 _wait_q_t data;
5909 _wait_q_t space;
5910 uint8_t flags;
5911
5912 Z_DECL_POLL_EVENT
5913#ifdef CONFIG_OBJ_CORE_PIPE
5914 struct k_obj_core obj_core;
5915#endif
5920};
5921
5925#define Z_PIPE_INITIALIZER(obj, pipe_buffer, pipe_buffer_size) \
5926{ \
5927 .waiting = 0, \
5928 .buf = RING_BUF_INIT(pipe_buffer, pipe_buffer_size), \
5929 .data = Z_WAIT_Q_INIT(&obj.data), \
5930 .space = Z_WAIT_Q_INIT(&obj.space), \
5931 .flags = PIPE_FLAG_OPEN, \
5932 Z_POLL_EVENT_OBJ_INIT(obj) \
5933}
5937
5951#define K_PIPE_DEFINE(name, pipe_buffer_size, pipe_align) \
5952 static unsigned char __noinit __aligned(pipe_align) \
5953 _k_pipe_buf_##name[pipe_buffer_size]; \
5954 STRUCT_SECTION_ITERABLE(k_pipe, name) = \
5955 Z_PIPE_INITIALIZER(name, _k_pipe_buf_##name, pipe_buffer_size)
5956
5957
5974__syscall int k_pipe_write(struct k_pipe *pipe, const uint8_t *data, size_t len,
5975 k_timeout_t timeout);
5976
5992__syscall int k_pipe_read(struct k_pipe *pipe, uint8_t *data, size_t len,
5993 k_timeout_t timeout);
5994
6004__syscall void k_pipe_reset(struct k_pipe *pipe);
6005
6014__syscall void k_pipe_close(struct k_pipe *pipe);
6016
6020struct k_mem_slab_info {
6021 uint32_t num_blocks;
6022 size_t block_size;
6023 uint32_t num_used;
6024#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
6025 uint32_t max_used;
6026#endif
6027};
6028
6029struct k_mem_slab {
6030 _wait_q_t wait_q;
6031 struct k_spinlock lock;
6032 char *buffer;
6033 char *free_list;
6034 struct k_mem_slab_info info;
6035
6037
6038#ifdef CONFIG_OBJ_CORE_MEM_SLAB
6039 struct k_obj_core obj_core;
6040#endif
6041};
6042
6043#define Z_MEM_SLAB_INITIALIZER(_slab, _slab_buffer, _slab_block_size, \
6044 _slab_num_blocks) \
6045 { \
6046 .wait_q = Z_WAIT_Q_INIT(&(_slab).wait_q), \
6047 .lock = {}, \
6048 .buffer = _slab_buffer, \
6049 .free_list = NULL, \
6050 .info = {_slab_num_blocks, _slab_block_size, 0} \
6051 }
6055
6061
6087#define K_MEM_SLAB_DEFINE_IN_SECT(name, in_section, slab_block_size, slab_num_blocks, slab_align) \
6088 BUILD_ASSERT(((slab_block_size) % (slab_align)) == 0, \
6089 "slab_block_size must be a multiple of slab_align"); \
6090 BUILD_ASSERT((((slab_align) & ((slab_align) - 1)) == 0), \
6091 "slab_align must be a power of 2"); \
6092 char in_section __aligned(WB_UP( \
6093 slab_align)) _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
6094 STRUCT_SECTION_ITERABLE(k_mem_slab, name) = Z_MEM_SLAB_INITIALIZER( \
6095 name, _k_mem_slab_buf_##name, WB_UP(slab_block_size), slab_num_blocks)
6096
6120#define K_MEM_SLAB_DEFINE(name, slab_block_size, slab_num_blocks, slab_align) \
6121 K_MEM_SLAB_DEFINE_IN_SECT(name, __noinit_named(k_mem_slab_buf_##name), slab_block_size, \
6122 slab_num_blocks, slab_align)
6123
6145#define K_MEM_SLAB_DEFINE_TYPE(name, type, slab_num_blocks) \
6146 K_MEM_SLAB_DEFINE(name, sizeof(type), slab_num_blocks, __alignof(type))
6147
6164#define K_MEM_SLAB_DEFINE_IN_SECT_STATIC(name, in_section, slab_block_size, slab_num_blocks, \
6165 slab_align) \
6166 BUILD_ASSERT(((slab_block_size) % (slab_align)) == 0, \
6167 "slab_block_size must be a multiple of slab_align"); \
6168 BUILD_ASSERT((((slab_align) & ((slab_align) - 1)) == 0), \
6169 "slab_align must be a power of 2"); \
6170 static char in_section __aligned(WB_UP( \
6171 slab_align)) _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
6172 static STRUCT_SECTION_ITERABLE(k_mem_slab, name) = Z_MEM_SLAB_INITIALIZER( \
6173 name, _k_mem_slab_buf_##name, WB_UP(slab_block_size), slab_num_blocks)
6174
6189#define K_MEM_SLAB_DEFINE_STATIC(name, slab_block_size, slab_num_blocks, slab_align) \
6190 K_MEM_SLAB_DEFINE_IN_SECT_STATIC(name, __noinit_named(k_mem_slab_buf_##name), \
6191 slab_block_size, slab_num_blocks, slab_align)
6192
6205#define K_MEM_SLAB_DEFINE_STATIC_TYPE(name, type, slab_num_blocks) \
6206 K_MEM_SLAB_DEFINE_STATIC(name, sizeof(type), slab_num_blocks, __alignof(type))
6207
6229int k_mem_slab_init(struct k_mem_slab *slab, void *buffer,
6230 size_t block_size, uint32_t num_blocks);
6231
6253int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem,
6254 k_timeout_t timeout);
6255
6267void k_mem_slab_free(struct k_mem_slab *slab, void *mem);
6268
6281static inline uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
6282{
6283 return slab->info.num_used;
6284}
6285
6298static inline uint32_t k_mem_slab_max_used_get(struct k_mem_slab *slab)
6299{
6300#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
6301 return slab->info.max_used;
6302#else
6303 ARG_UNUSED(slab);
6304 return 0;
6305#endif
6306}
6307
6320static inline uint32_t k_mem_slab_num_free_get(struct k_mem_slab *slab)
6321{
6322 return slab->info.num_blocks - slab->info.num_used;
6323}
6324
6338
6339int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stats *stats);
6340
6354int k_mem_slab_runtime_stats_reset_max(struct k_mem_slab *slab);
6355
6357
6362
6368struct k_heap {
6372 struct sys_heap heap;
6373 _wait_q_t wait_q;
6374 struct k_spinlock lock;
6378};
6379
6393void k_heap_init(struct k_heap *h, void *mem,
6394 size_t bytes) __attribute_nonnull(1);
6395
6417void *k_heap_aligned_alloc(struct k_heap *h, size_t align, size_t bytes,
6418 k_timeout_t timeout) __attribute_nonnull(1);
6419
6441void *k_heap_alloc(struct k_heap *h, size_t bytes,
6442 k_timeout_t timeout) __attribute_nonnull(1);
6443
6466void *k_heap_calloc(struct k_heap *h, size_t num, size_t size, k_timeout_t timeout)
6467 __attribute_nonnull(1);
6468
6492void *k_heap_realloc(struct k_heap *h, void *ptr, size_t bytes, k_timeout_t timeout)
6493 __attribute_nonnull(1);
6494
6505void k_heap_free(struct k_heap *h, void *mem) __attribute_nonnull(1);
6506
6507/*
6508 * Heap sizing constants computed at build time from actual struct layouts
6509 * in lib/heap/heap_constants.c via the gen_offset mechanism.
6510 */
6511#include <zephyr/heap_constants.h>
6512
6513/* chunk0 size in bytes for nb buckets (includes trailer metadata) */
6514#define _Z_HEAP_C0(nb) \
6515 (ROUND_UP(___z_heap_struct_SIZEOF + \
6516 (nb) * ___z_heap_bucket_SIZEOF, ___z_heap_chunk_unit_SIZEOF) + \
6517 ___z_heap_trailer_SIZEOF)
6518
6519/* Allocation chunk size in bytes (header + data rounded up, plus trailer) */
6520#define _Z_HEAP_AC(ab) \
6521 (ROUND_UP(___z_heap_hdr_SIZEOF + (ab), ___z_heap_chunk_unit_SIZEOF) + \
6522 ___z_heap_trailer_SIZEOF)
6523
6524/* Total heap size in chunk units */
6525#define _Z_HEAP_SZ(nb, ab) \
6526 ((_Z_HEAP_C0(nb) + _Z_HEAP_AC(ab)) / ___z_heap_chunk_unit_SIZEOF)
6527
6528/* Bucket count from heap size in chunk units (mirrors bucket_idx() + 1) */
6529#define _Z_HEAP_NB(sz) \
6530 (32 - __builtin_clz((unsigned int)((sz) - \
6531 ___z_heap_min_chunk_SIZEOF + 1)))
6532
6533/* 3-round convergent iteration starting from 1 bucket */
6534#define _Z_HEAP_NB1(ab) _Z_HEAP_NB(_Z_HEAP_SZ(1, ab))
6535#define _Z_HEAP_NB2(ab) _Z_HEAP_NB(_Z_HEAP_SZ(_Z_HEAP_NB1(ab), ab))
6536#define _Z_HEAP_NB3(ab) _Z_HEAP_NB(_Z_HEAP_SZ(_Z_HEAP_NB2(ab), ab))
6537
6551#define Z_HEAP_MIN_SIZE_FOR(alloc_bytes) \
6552 (_Z_HEAP_C0(_Z_HEAP_NB3(alloc_bytes)) + \
6553 _Z_HEAP_AC(alloc_bytes) + ___z_heap_ftr_SIZEOF)
6554
6555#define Z_HEAP_MIN_SIZE Z_HEAP_MIN_SIZE_FOR(1)
6556
6573#define Z_HEAP_DEFINE_IN_SECT(name, bytes, in_section) \
6574 char in_section \
6575 __aligned(8) /* CHUNK_UNIT */ \
6576 kheap_##name[MAX(bytes, Z_HEAP_MIN_SIZE)]; \
6577 STRUCT_SECTION_ITERABLE(k_heap, name) = { \
6578 .heap = { \
6579 .init_mem = kheap_##name, \
6580 .init_bytes = MAX(bytes, Z_HEAP_MIN_SIZE), \
6581 }, \
6582 }
6583
6598#define K_HEAP_DEFINE(name, bytes) \
6599 Z_HEAP_DEFINE_IN_SECT(name, bytes, \
6600 __noinit_named(kheap_buf_##name))
6601
6616#define K_HEAP_DEFINE_NOCACHE(name, bytes) \
6617 Z_HEAP_DEFINE_IN_SECT(name, bytes, __nocache)
6618
6628int k_heap_array_get(struct k_heap **heap);
6629
6633
6640
6659void *k_aligned_alloc(size_t align, size_t size);
6660
6672void *k_malloc(size_t size);
6673
6684void k_free(void *ptr);
6685
6697void *k_calloc(size_t nmemb, size_t size);
6698
6716void *k_realloc(void *ptr, size_t size);
6717
6719
6720/* polling API - PRIVATE */
6721
6722#ifdef CONFIG_POLL
6723#define _INIT_OBJ_POLL_EVENT(obj) do { (obj)->poll_event = NULL; } while (false)
6724#else
6725#define _INIT_OBJ_POLL_EVENT(obj) do { } while (false)
6726#endif
6727
6728/* private - types bit positions */
6729enum _poll_types_bits {
6730 /* can be used to ignore an event */
6731 _POLL_TYPE_IGNORE,
6732
6733 /* to be signaled by k_poll_signal_raise() */
6734 _POLL_TYPE_SIGNAL,
6735
6736 /* semaphore availability */
6737 _POLL_TYPE_SEM_AVAILABLE,
6738
6739 /* queue/FIFO/LIFO data availability */
6740 _POLL_TYPE_DATA_AVAILABLE,
6741
6742 /* msgq data availability */
6743 _POLL_TYPE_MSGQ_DATA_AVAILABLE,
6744
6745 /* pipe data availability */
6746 _POLL_TYPE_PIPE_DATA_AVAILABLE,
6747
6748 _POLL_NUM_TYPES
6749};
6750
6751#define Z_POLL_TYPE_BIT(type) (1U << ((type) - 1U))
6752
6753/* private - states bit positions */
6754enum _poll_states_bits {
6755 /* default state when creating event */
6756 _POLL_STATE_NOT_READY,
6757
6758 /* signaled by k_poll_signal_raise() */
6759 _POLL_STATE_SIGNALED,
6760
6761 /* semaphore is available */
6762 _POLL_STATE_SEM_AVAILABLE,
6763
6764 /* data is available to read on queue/FIFO/LIFO */
6765 _POLL_STATE_DATA_AVAILABLE,
6766
6767 /* queue/FIFO/LIFO wait was cancelled */
6768 _POLL_STATE_CANCELLED,
6769
6770 /* data is available to read on a message queue */
6771 _POLL_STATE_MSGQ_DATA_AVAILABLE,
6772
6773 /* data is available to read from a pipe */
6774 _POLL_STATE_PIPE_DATA_AVAILABLE,
6775
6776 _POLL_NUM_STATES
6777};
6778
6779#define Z_POLL_STATE_BIT(state) (1U << ((state) - 1U))
6780
6781#define _POLL_EVENT_NUM_UNUSED_BITS \
6782 (32 - (0 \
6783 + 8 /* tag */ \
6784 + _POLL_NUM_TYPES \
6785 + _POLL_NUM_STATES \
6786 + 1 /* modes */ \
6787 ))
6788
6789/* end of polling API - PRIVATE */
6790
6791
6799
6800/* Public polling API */
6801
6807
6809#define K_POLL_TYPE_IGNORE 0
6811#define K_POLL_TYPE_SIGNAL Z_POLL_TYPE_BIT(_POLL_TYPE_SIGNAL)
6813#define K_POLL_TYPE_SEM_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_SEM_AVAILABLE)
6815#define K_POLL_TYPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_DATA_AVAILABLE)
6817#define K_POLL_TYPE_FIFO_DATA_AVAILABLE K_POLL_TYPE_DATA_AVAILABLE
6819#define K_POLL_TYPE_LIFO_DATA_AVAILABLE K_POLL_TYPE_DATA_AVAILABLE
6821#define K_POLL_TYPE_MSGQ_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_MSGQ_DATA_AVAILABLE)
6823#define K_POLL_TYPE_PIPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_PIPE_DATA_AVAILABLE)
6824
6826
6836
6842
6844#define K_POLL_STATE_NOT_READY 0
6846#define K_POLL_STATE_SIGNALED Z_POLL_STATE_BIT(_POLL_STATE_SIGNALED)
6848#define K_POLL_STATE_SEM_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_SEM_AVAILABLE)
6850#define K_POLL_STATE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_DATA_AVAILABLE)
6852#define K_POLL_STATE_FIFO_DATA_AVAILABLE K_POLL_STATE_DATA_AVAILABLE
6854#define K_POLL_STATE_LIFO_DATA_AVAILABLE K_POLL_STATE_DATA_AVAILABLE
6856#define K_POLL_STATE_MSGQ_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_MSGQ_DATA_AVAILABLE)
6858#define K_POLL_STATE_PIPE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_PIPE_DATA_AVAILABLE)
6860#define K_POLL_STATE_CANCELLED Z_POLL_STATE_BIT(_POLL_STATE_CANCELLED)
6861
6863
6876 sys_dlist_t poll_events;
6880
6885 unsigned int signaled;
6886
6889};
6890
6896#define K_POLL_SIGNAL_INITIALIZER(obj) \
6897 { \
6898 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events), \
6899 .signaled = 0, \
6900 .result = 0, \
6901 }
6902
6911 sys_dnode_t _node;
6912
6914 struct z_poller *poller;
6918
6921
6923 uint32_t type:_POLL_NUM_TYPES;
6924
6926 uint32_t state:_POLL_NUM_STATES;
6927
6930
6932 uint32_t unused:_POLL_EVENT_NUM_UNUSED_BITS;
6933
6935 union {
6936 /* The _typed_* aliases below are used by the K_POLL_EVENT_*INITIALIZER() macros to
6937 * ensure type safety of polled objects.
6938 */
6940 void *obj, *_typed_K_POLL_TYPE_IGNORE;
6942 struct k_poll_signal *signal, *_typed_K_POLL_TYPE_SIGNAL;
6944 struct k_sem *sem, *_typed_K_POLL_TYPE_SEM_AVAILABLE;
6946 struct k_fifo *fifo, *_typed_K_POLL_TYPE_FIFO_DATA_AVAILABLE;
6948 struct k_lifo *lifo, *_typed_K_POLL_TYPE_LIFO_DATA_AVAILABLE;
6950 struct k_queue *queue, *_typed_K_POLL_TYPE_DATA_AVAILABLE;
6952 struct k_msgq *msgq, *_typed_K_POLL_TYPE_MSGQ_DATA_AVAILABLE;
6954 struct k_pipe *pipe, *_typed_K_POLL_TYPE_PIPE_DATA_AVAILABLE;
6955 };
6956};
6957
6966#define K_POLL_EVENT_INITIALIZER(_event_type, _event_mode, _event_obj) \
6967 { \
6968 .poller = NULL, \
6969 .type = _event_type, \
6970 .state = K_POLL_STATE_NOT_READY, \
6971 .mode = _event_mode, \
6972 .unused = 0, \
6973 { \
6974 ._typed_##_event_type = _event_obj, \
6975 }, \
6976 }
6977
6987#define K_POLL_EVENT_STATIC_INITIALIZER(_event_type, _event_mode, _event_obj, \
6988 event_tag) \
6989 { \
6990 .tag = event_tag, \
6991 .type = _event_type, \
6992 .state = K_POLL_STATE_NOT_READY, \
6993 .mode = _event_mode, \
6994 .unused = 0, \
6995 { \
6996 ._typed_##_event_type = _event_obj, \
6997 }, \
6998 }
6999
7014
7015void k_poll_event_init(struct k_poll_event *event, uint32_t type,
7016 int mode, void *obj);
7017
7060
7061__syscall int k_poll(struct k_poll_event *events, int num_events,
7062 k_timeout_t timeout);
7063
7071
7072__syscall void k_poll_signal_init(struct k_poll_signal *sig);
7073
7079__syscall void k_poll_signal_reset(struct k_poll_signal *sig);
7080
7091__syscall void k_poll_signal_check(struct k_poll_signal *sig,
7092 unsigned int *signaled, int *result);
7093
7116
7117__syscall int k_poll_signal_raise(struct k_poll_signal *sig, int result);
7118
7120
7139static inline void k_cpu_idle(void)
7140{
7141 arch_cpu_idle();
7142}
7143
7158static inline void k_cpu_atomic_idle(unsigned int key)
7159{
7161}
7162
7166
7171#ifdef ARCH_EXCEPT
7172/* This architecture has direct support for triggering a CPU exception */
7173#define z_except_reason(reason) ARCH_EXCEPT(reason)
7174#else
7175
7176#if defined(CONFIG_PRINTK) && !defined(CONFIG_ASSERT_NO_FILE_INFO)
7177#define __EXCEPT_LOC() printk("@ %s:%d\n", __FILE__, __LINE__)
7178#else
7179#define __EXCEPT_LOC()
7180#endif /* CONFIG_PRINTK */
7181
7182/* NOTE: This is the implementation for arches that do not implement
7183 * ARCH_EXCEPT() to generate a real CPU exception.
7184 *
7185 * We won't have a real exception frame to determine the PC value when
7186 * the oops occurred, so print file and line number before we jump into
7187 * the fatal error handler.
7188 */
7189#define z_except_reason(reason) do { \
7190 __EXCEPT_LOC(); \
7191 z_fatal_error(reason, NULL); \
7192 } while (false)
7193
7194#endif /* _ARCH__EXCEPT */
7198
7210#define k_oops() z_except_reason(K_ERR_KERNEL_OOPS)
7211
7220#define k_panic() z_except_reason(K_ERR_KERNEL_PANIC)
7221
7225/*
7226 * private APIs that are utilized by one or more public APIs
7227 */
7228
7232void z_timer_expiration_handler(struct _timeout *timeout);
7236
7237#ifdef CONFIG_PRINTK
7245__syscall void k_str_out(char *c, size_t n);
7246#endif
7247
7253
7274__syscall int k_float_disable(struct k_thread *thread);
7275
7314__syscall int k_float_enable(struct k_thread *thread, unsigned int options);
7315
7319
7329
7337
7346
7357
7368
7378
7387
7396
7397#ifdef __cplusplus
7398}
7399#endif
7400
7401#include <zephyr/tracing/tracing.h>
7402#include <zephyr/syscalls/kernel.h>
7403
7404#endif /* !_ASMLANGUAGE */
7405
7406#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:31
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:2338
#define K_NO_WAIT
Generate null timeout delay.
Definition kernel.h:1652
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:2290
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:2319
static uint32_t k_uptime_seconds(void)
Get system uptime in seconds.
Definition kernel.h:2303
static uint64_t k_cycle_get_64(void)
Read the 64-bit hardware clock.
Definition kernel.h:2356
static int64_t k_uptime_get(void)
Get system uptime.
Definition kernel.h:2266
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:7139
static void k_cpu_atomic_idle(unsigned int key)
Make the CPU idle in an atomic fashion.
Definition kernel.h:7158
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:2999
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:344
struct _sflist sys_sflist_t
Flagged single-linked list structure.
Definition sflist.h:62
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:137
@ K_ISR
Executing in an interrupt service routine.
Definition kernel.h:138
@ K_COOP_THREAD
Executing in a cooperative thread.
Definition kernel.h:139
@ K_PREEMPT_THREAD
Executing in a preemptible thread.
Definition kernel.h:140
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:6281
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:6298
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:6320
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:6828
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:6832
@ K_POLL_NUM_MODES
Number of poll modes.
Definition kernel.h:6834
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 SYS_PORT_TRACING_TRACKING_FIELD(type)
Field added to kernel objects so they are tracked.
Definition tracing_macros.h:375
#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:576
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.
int32_t k_sleep(k_timeout_t timeout)
Put the current thread to sleep.
void k_sched_lock(void)
Lock the scheduler.
static int32_t k_msleep(int32_t ms)
Put the current thread to sleep.
Definition kernel.h:775
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:166
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:909
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:1398
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:876
int k_thread_cpu_pin(k_tid_t thread, int cpu)
Pin a thread to a CPU.
int32_t k_usleep(int32_t us)
Put the current thread to sleep with microsecond resolution.
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:179
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:1982
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:1966
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:2168
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:1782
#define k_ticks_to_sec_floor32(t)
Convert ticks to seconds.
Definition time_units.h:1622
#define k_ticks_to_ms_floor64(t)
Convert ticks to milliseconds.
Definition time_units.h:1734
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:4985
static bool k_work_is_pending(const struct k_work *work)
Test whether a work item is currently pending.
Definition kernel.h:4956
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:4973
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:5110
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:5087
void(* k_work_handler_t)(struct k_work *work)
The signature for a work item handler function.
Definition kernel.h:4078
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:4967
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:5065
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:5008
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:5165
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:4962
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:4979
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:4689
@ K_WORK_QUEUED
Flag indicating a work item that has been submitted to a queue but has not started running.
Definition kernel.h:4696
@ K_WORK_DELAYED
Flag indicating a delayed work item that is scheduled for submission to a queue.
Definition kernel.h:4703
@ K_WORK_RUNNING
Flag indicating a work item that is running under a work queue thread.
Definition kernel.h:4683
@ K_WORK_FLUSHING
Flag indicating a synced work item that is being flushed.
Definition kernel.h:4709
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:3962
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:3991
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:338
Memory Statistics.
flags
Definition parser.h:97
state
Definition parser_state.h:29
Header file for the ring buffer API.
__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:3702
Event Structure.
Definition kernel.h:2778
Kernel FIFO structure.
Definition kernel.h:3024
futex structure
Definition kernel.h:2673
atomic_t val
Futex value.
Definition kernel.h:2679
Kernel synchronized heap structure.
Definition kernel.h:6368
IPI work item structure.
Definition kernel.h:3970
Kernel LIFO structure.
Definition kernel.h:3281
Mailbox Message Structure.
Definition kernel.h:5710
k_tid_t tx_target_thread
target thread id
Definition kernel.h:5720
void * tx_data
sender's message data buffer
Definition kernel.h:5716
k_tid_t rx_source_thread
source thread id
Definition kernel.h:5718
uint32_t info
application-defined information value
Definition kernel.h:5714
size_t size
size of message (in bytes)
Definition kernel.h:5712
Mailbox Structure.
Definition kernel.h:5739
Memory Domain.
Definition mem_domain.h:80
Memory Partition.
Definition mem_domain.h:55
Message Queue Attributes.
Definition kernel.h:5389
uint32_t used_msgs
Used messages.
Definition kernel.h:5395
size_t msg_size
Message Size.
Definition kernel.h:5391
uint32_t max_msgs
Maximal number of messages.
Definition kernel.h:5393
Message Queue Structure.
Definition kernel.h:5325
Kernel mutex structure.
Definition kernel.h:3573
Object core structure.
Definition obj_core.h:123
Kernel pipe structure.
Definition kernel.h:5901
Poll Event.
Definition kernel.h:6906
struct k_poll_signal * signal
Poll signal being polled.
Definition kernel.h:6942
struct k_pipe * pipe
Pipe being polled.
Definition kernel.h:6954
uint32_t tag
optional user-specified tag, opaque, untouched by the API
Definition kernel.h:6920
struct k_fifo * fifo
FIFO being polled.
Definition kernel.h:6946
struct k_msgq * msgq
Message queue being polled.
Definition kernel.h:6952
struct k_queue * queue
Queue being polled.
Definition kernel.h:6950
uint32_t unused
unused bits in 32-bit word
Definition kernel.h:6932
uint32_t type
bitfield of event types (bitwise-ORed K_POLL_TYPE_xxx values)
Definition kernel.h:6923
struct k_sem * sem
Semaphore being polled.
Definition kernel.h:6944
uint32_t state
bitfield of event states (bitwise-ORed K_POLL_STATE_xxx values)
Definition kernel.h:6926
uint32_t mode
mode of operation, from enum k_poll_modes
Definition kernel.h:6929
void * obj
Generic object pointer.
Definition kernel.h:6940
struct k_lifo * lifo
LIFO being polled.
Definition kernel.h:6948
Poll signal object.
Definition kernel.h:6871
int result
custom result value passed to k_poll_signal_raise() if needed
Definition kernel.h:6888
unsigned int signaled
1 if the event has been signaled, 0 otherwise.
Definition kernel.h:6885
Kernel queue structure.
Definition kernel.h:2377
Semaphore structure.
Definition kernel.h:3807
Kernel Spin Lock.
Definition spinlock.h:45
Thread Structure.
Definition thread.h:259
struct _thread_base base
Definition thread.h:261
struct k_heap * resource_pool
resource pool
Definition thread.h:357
struct __thread_entry entry
thread entry and parameters description
Definition thread.h:296
Kernel timeout type.
Definition clock.h:65
Kernel timer structure.
Definition kernel.h:1875
A structure used to submit work after a delay.
Definition kernel.h:4759
Kernel workqueue structure.
Definition kernel.h:4915
A structure holding optional configuration items for a work queue.
Definition kernel.h:4873
const char * name
The name to be given to the work queue thread.
Definition kernel.h:4878
uint32_t work_timeout_ms
Controls whether work queue monitors work timeouts.
Definition kernel.h:4907
bool essential
Control whether the work queue thread should be marked as essential thread.
Definition kernel.h:4897
bool no_yield
Control whether the work queue thread should yield between items.
Definition kernel.h:4892
A structure holding internal state for a pending synchronous operation on a work item or queue.
Definition kernel.h:4854
A structure used to submit work.
Definition kernel.h:4717
A structure to represent a ring buffer.
Definition ring_buffer.h:67
Definition sys_heap.h:60
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
struct k_thread * k_tid_t
Definition thread.h:408
struct k_thread_runtime_stats k_thread_runtime_stats_t
Macros to abstract toolchain specific capabilities.
Main header file for tracing subsystem API.
Header file for tracing macros.