Zephyr API Documentation 4.5.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>
23#include <zephyr/sleep.h>
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32/*
33 * Zephyr currently assumes the size of a couple standard types to simplify
34 * print string formats. Let's make sure this doesn't change without notice.
35 */
36BUILD_ASSERT(sizeof(int32_t) == sizeof(int));
37BUILD_ASSERT(sizeof(int64_t) == sizeof(long long));
38BUILD_ASSERT(sizeof(intptr_t) == sizeof(long));
39
48
57#define K_ANY NULL
58
59#if (CONFIG_NUM_COOP_PRIORITIES + CONFIG_NUM_PREEMPT_PRIORITIES) == 0
60#error Zero available thread priorities defined!
61#endif
62
67
78#define K_PRIO_COOP(x) (-(CONFIG_NUM_COOP_PRIORITIES - (x)))
79
90#define K_PRIO_PREEMPT(x) (x)
91
93#define K_HIGHEST_THREAD_PRIO (-CONFIG_NUM_COOP_PRIORITIES)
95#define K_LOWEST_THREAD_PRIO CONFIG_NUM_PREEMPT_PRIORITIES
97#define K_IDLE_PRIO K_LOWEST_THREAD_PRIO
99#define K_HIGHEST_APPLICATION_THREAD_PRIO (K_HIGHEST_THREAD_PRIO)
101#define K_LOWEST_APPLICATION_THREAD_PRIO (K_LOWEST_THREAD_PRIO - 1)
102
104
105#ifdef CONFIG_POLL
106#define Z_POLL_EVENT_OBJ_INIT(obj) \
107 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events),
108#define Z_DECL_POLL_EVENT sys_dlist_t poll_events;
109#else
110#define Z_POLL_EVENT_OBJ_INIT(obj)
111#define Z_DECL_POLL_EVENT
112#endif
113
114struct k_thread;
115struct k_mutex;
116struct k_sem;
117struct k_msgq;
118struct k_mbox;
119struct k_pipe;
120struct k_queue;
121struct k_fifo;
122struct k_lifo;
123struct k_stack;
124struct k_mem_slab;
125struct k_timer;
126struct k_poll_event;
127struct k_poll_signal;
128struct k_mem_domain;
129struct k_mem_partition;
130struct k_futex;
131struct k_event;
132
143
144/* private, used by k_poll and k_work_poll */
145struct k_work_poll;
146typedef int (*_poller_cb_t)(struct k_poll_event *event, uint32_t state);
147
152
166static inline void
168{
169#ifdef CONFIG_SCHED_THREAD_USAGE_ANALYSIS
170 thread->base.usage.longest = 0ULL;
171#endif
172}
173
180typedef void (*k_thread_user_cb_t)(const struct k_thread *thread,
181 void *user_data);
182
198void k_thread_foreach(k_thread_user_cb_t user_cb, void *user_data);
199
218#ifdef CONFIG_SMP
219void k_thread_foreach_filter_by_cpu(unsigned int cpu,
220 k_thread_user_cb_t user_cb, void *user_data);
221#else
222static inline
223void k_thread_foreach_filter_by_cpu(unsigned int cpu,
224 k_thread_user_cb_t user_cb, void *user_data)
225{
226 __ASSERT(cpu == 0, "cpu filter out of bounds");
227 ARG_UNUSED(cpu);
228 k_thread_foreach(user_cb, user_data);
229}
230#endif
231
260 k_thread_user_cb_t user_cb, void *user_data);
261
293#ifdef CONFIG_SMP
295 k_thread_user_cb_t user_cb, void *user_data);
296#else
297static inline
298void k_thread_foreach_unlocked_filter_by_cpu(unsigned int cpu,
299 k_thread_user_cb_t user_cb, void *user_data)
300{
301 __ASSERT(cpu == 0, "cpu filter out of bounds");
302 ARG_UNUSED(cpu);
303 k_thread_foreach_unlocked(user_cb, user_data);
304}
305#endif
306
308
314
315#endif /* !_ASMLANGUAGE */
316
317
318/*
319 * Thread user options. May be needed by assembly code. Common part uses low
320 * bits, arch-specific use high bits.
321 */
322
326#define K_ESSENTIAL (BIT(0))
327
331#define K_FP_IDX 1
344#define K_FP_REGS (BIT(K_FP_IDX))
345
352#define K_USER (BIT(2))
353
362#define K_INHERIT_PERMS (BIT(3))
363
373#define K_CALLBACK_STATE (BIT(4))
374
378#define K_DSP_IDX 13
391#define K_DSP_REGS (BIT(K_DSP_IDX))
392
396#define K_AGU_IDX 14
408#define K_AGU_REGS (BIT(K_AGU_IDX))
409
419#define K_SSE_REGS (BIT(15))
420
421/* end - thread options */
422
423#if !defined(_ASMLANGUAGE)
448__syscall k_thread_stack_t *k_thread_stack_alloc(size_t size, int flags);
449
463
515__syscall k_tid_t k_thread_create(struct k_thread *new_thread,
516 k_thread_stack_t *stack,
517 size_t stack_size,
519 void *p1, void *p2, void *p3,
520 int prio, uint32_t options, k_timeout_t delay);
521
544 void *p1, void *p2,
545 void *p3);
546
560#define k_thread_access_grant(thread, ...) \
561 FOR_EACH_FIXED_ARG(k_object_access_grant, (;), (thread), __VA_ARGS__)
562
577static inline void k_thread_heap_assign(struct k_thread *thread,
578 struct k_heap *heap)
579{
580 thread->resource_pool = heap;
581}
582
583#if defined(CONFIG_INIT_STACKS) && defined(CONFIG_THREAD_STACK_INFO)
605__syscall int k_thread_stack_space_get(const struct k_thread *thread,
606 size_t *unused_ptr);
607
623__syscall int k_thread_runtime_stack_unused_threshold_pct_set(struct k_thread *thread,
624 uint32_t pct);
625
641__syscall int k_thread_runtime_stack_unused_threshold_set(struct k_thread *thread,
642 size_t threshold);
643
656__syscall size_t k_thread_runtime_stack_unused_threshold_get(struct k_thread *thread);
657
669typedef void (*k_thread_stack_safety_handler_t)(const struct k_thread *thread,
670 size_t unused_space, void *arg);
671
686int k_thread_runtime_stack_safety_full_check(const struct k_thread *thread,
687 size_t *unused_ptr,
688 k_thread_stack_safety_handler_t handler,
689 void *arg);
690
705int k_thread_runtime_stack_safety_threshold_check(const struct k_thread *thread,
706 size_t *unused_ptr,
707 k_thread_stack_safety_handler_t handler,
708 void *arg);
709#endif
710
711#if (K_HEAP_MEM_POOL_SIZE > 0)
724void k_thread_system_pool_assign(struct k_thread *thread);
725#endif /* (K_HEAP_MEM_POOL_SIZE > 0) */
726
746__syscall int k_thread_join(struct k_thread *thread, k_timeout_t timeout);
747
764__syscall void k_busy_wait(uint32_t usec_to_wait);
765
777bool k_can_yield(void);
778
786__syscall void k_yield(void);
787
797__syscall void k_wakeup(k_tid_t thread);
798
812__attribute_const__
814
826static inline bool k_is_pre_kernel(void)
827{
828 extern bool z_sys_post_kernel; /* in init.c */
829
830 /*
831 * If called from userspace, it must be post kernel.
832 * This guard is necessary because z_sys_post_kernel memory
833 * is not accessible to user threads.
834 */
835 if (k_is_user_context()) {
836 return false;
837 }
838
839 /*
840 * Some compilers might optimize by pre-reading
841 * z_sys_post_kernel. This is absolutely not desirable.
842 * We are trying to avoid reading it if we are in user
843 * context as reading z_sys_post_kernel in user context
844 * will result in access fault. So add a compiler barrier
845 * here to stop that kind of optimizations.
846 */
847 compiler_barrier();
848
849 return !z_sys_post_kernel;
850}
851
858__attribute_const__
859static inline k_tid_t k_current_get(void)
860{
861 __ASSERT(!k_is_pre_kernel(), "k_current_get called pre-kernel");
862
863#ifdef CONFIG_CURRENT_THREAD_USE_TLS
864
865 /* Thread-local cache of current thread ID, set in z_thread_entry() */
866 extern Z_THREAD_LOCAL k_tid_t z_tls_current;
867
868 return z_tls_current;
869#else
871#endif
872}
873
884static inline bool k_thread_is_user_thread(const struct k_thread *thread)
885{
886 return (thread->base.user_options & K_USER) != 0U;
887}
888
909__syscall void k_thread_abort(k_tid_t thread);
910
911k_ticks_t z_timeout_expires(const struct _timeout *timeout);
912k_ticks_t z_timeout_remaining(const struct _timeout *timeout);
913
914#ifdef CONFIG_SYS_CLOCK_EXISTS
915
923__syscall k_ticks_t k_thread_timeout_expires_ticks(const struct k_thread *thread);
924
925static inline k_ticks_t z_impl_k_thread_timeout_expires_ticks(
926 const struct k_thread *thread)
927{
928 return z_timeout_expires(&thread->base.timeout);
929}
930
939
940static inline k_ticks_t z_impl_k_thread_timeout_remaining_ticks(
941 const struct k_thread *thread)
942{
943 return z_timeout_remaining(&thread->base.timeout);
944}
945
946#endif /* CONFIG_SYS_CLOCK_EXISTS */
947
951struct _static_thread_data {
952 struct k_thread *init_thread;
953 k_thread_stack_t *init_stack;
954 unsigned int init_stack_size;
955 k_thread_entry_t init_entry;
956 void *init_p1;
957 void *init_p2;
958 void *init_p3;
959 int init_prio;
960 uint32_t init_options;
961 const char *init_name;
962#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
963 int32_t init_delay_ms;
964#else
965 k_timeout_t init_delay;
966#endif
967};
968
969#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
970#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay_ms = (ms)
971#define Z_THREAD_INIT_DELAY(thread) SYS_TIMEOUT_MS((thread)->init_delay_ms)
972#else
973#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay = SYS_TIMEOUT_MS(ms)
974#define Z_THREAD_INIT_DELAY(thread) (thread)->init_delay
975#endif
976
977#define Z_THREAD_INITIALIZER(thread, stack, stack_size, \
978 entry, p1, p2, p3, \
979 prio, options, delay, tname) \
980 { \
981 .init_thread = (thread), \
982 .init_stack = (stack), \
983 .init_stack_size = (stack_size), \
984 .init_entry = (k_thread_entry_t)entry, \
985 .init_p1 = (void *)p1, \
986 .init_p2 = (void *)p2, \
987 .init_p3 = (void *)p3, \
988 .init_prio = (prio), \
989 .init_options = (options), \
990 .init_name = STRINGIFY(tname), \
991 Z_THREAD_INIT_DELAY_INITIALIZER(delay) \
992 }
993
994/*
995 * Refer to K_THREAD_DEFINE() and K_KERNEL_THREAD_DEFINE() for
996 * information on arguments.
997 */
998#define Z_THREAD_COMMON_DEFINE(name, stack_size, \
999 entry, p1, p2, p3, \
1000 prio, options, delay) \
1001 struct k_thread _k_thread_obj_##name; \
1002 const STRUCT_SECTION_ITERABLE(_static_thread_data, \
1003 _k_thread_data_##name) = \
1004 Z_THREAD_INITIALIZER(&_k_thread_obj_##name, \
1005 _k_thread_stack_##name, stack_size,\
1006 entry, p1, p2, p3, prio, options, \
1007 delay, name); \
1008 __maybe_unused const k_tid_t name = (k_tid_t)&_k_thread_obj_##name
1012
1044#define K_THREAD_DEFINE(name, stack_size, \
1045 entry, p1, p2, p3, \
1046 prio, options, delay) \
1047 K_THREAD_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
1048 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
1049 prio, options, delay)
1050
1081#define K_KERNEL_THREAD_DEFINE(name, stack_size, \
1082 entry, p1, p2, p3, \
1083 prio, options, delay) \
1084 K_KERNEL_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
1085 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
1086 prio, options, delay)
1087
1097__syscall int k_thread_priority_get(k_tid_t thread);
1098
1124__syscall void k_thread_priority_set(k_tid_t thread, int prio);
1125
1126
1127#ifdef CONFIG_SCHED_DEADLINE
1163__syscall void k_thread_deadline_set(k_tid_t thread, int deadline);
1164
1205__syscall void k_thread_absolute_deadline_set(k_tid_t thread, int deadline);
1206#endif
1207
1226__syscall void k_reschedule(void);
1227
1228#ifdef CONFIG_SCHED_CPU_MASK
1246
1265
1281
1300
1311int k_thread_cpu_pin(k_tid_t thread, int cpu);
1312#endif
1313
1335__syscall void k_thread_suspend(k_tid_t thread);
1336
1348__syscall void k_thread_resume(k_tid_t thread);
1349
1363static inline void k_thread_start(k_tid_t thread)
1364{
1365 k_wakeup(thread);
1366}
1367
1394void k_sched_time_slice_set(int32_t slice, int prio);
1395
1434void k_thread_time_slice_set(struct k_thread *th, int32_t slice_ticks,
1435 k_thread_timeslice_fn_t expired, void *data);
1436
1438
1443
1455bool k_is_in_isr(void);
1456
1473__syscall int k_is_preempt_thread(void);
1474
1478
1483
1509void k_sched_lock(void);
1510
1519
1532__syscall void k_thread_custom_data_set(void *value);
1533
1541__syscall void *k_thread_custom_data_get(void);
1542
1559__syscall int k_thread_name_set(k_tid_t thread, const char *str);
1560
1569const char *k_thread_name_get(k_tid_t thread);
1570
1583__syscall int k_thread_name_copy(k_tid_t thread, char *buf,
1584 size_t size);
1585
1598const char *k_thread_state_str(k_tid_t thread_id, char *buf, size_t buf_size);
1599
1603
1608
1617#define K_NO_WAIT Z_TIMEOUT_NO_WAIT
1618
1631#define K_NSEC(t) Z_TIMEOUT_NS(t)
1632
1645#define K_USEC(t) Z_TIMEOUT_US(t)
1646
1657#define K_CYC(t) Z_TIMEOUT_CYC(t)
1658
1669#define K_TICKS(t) Z_TIMEOUT_TICKS(t)
1670
1681#define K_MSEC(ms) Z_TIMEOUT_MS(ms)
1682
1693#define K_SECONDS(s) K_MSEC((s) * MSEC_PER_SEC)
1694
1705#define K_MINUTES(m) K_SECONDS((m) * 60)
1706
1717#define K_HOURS(h) K_MINUTES((h) * 60)
1718
1727#define K_FOREVER Z_FOREVER
1728
1743#define K_TIMEOUT_SUM(timeout1, timeout2) K_TICKS(z_timeout_sum(timeout1, timeout2))
1744
1745#ifdef CONFIG_TIMEOUT_64BIT
1746
1758#define K_TIMEOUT_ABS_TICKS(t) \
1759 Z_TIMEOUT_TICKS(Z_TICK_ABS((k_ticks_t)CLAMP(t, 0, (INT64_MAX - 1))))
1760
1772#define K_TIMEOUT_ABS_SEC(t) K_TIMEOUT_ABS_TICKS(k_sec_to_ticks_ceil64(t))
1773
1785#define K_TIMEOUT_ABS_MS(t) K_TIMEOUT_ABS_TICKS(k_ms_to_ticks_ceil64(t))
1786
1799#define K_TIMEOUT_ABS_US(t) K_TIMEOUT_ABS_TICKS(k_us_to_ticks_ceil64(t))
1800
1813#define K_TIMEOUT_ABS_NS(t) K_TIMEOUT_ABS_TICKS(k_ns_to_ticks_ceil64(t))
1814
1827#define K_TIMEOUT_ABS_CYC(t) K_TIMEOUT_ABS_TICKS(k_cyc_to_ticks_ceil64(t))
1828#endif
1829
1833
1840struct k_timer {
1844 /*
1845 * _timeout structure must be first here if we want to use
1846 * dynamic timer allocation. timeout.node is used in the double-linked
1847 * list of free timers
1848 */
1849 struct _timeout timeout;
1850
1851 /* wait queue for the (single) thread waiting on this timer */
1852 _wait_q_t wait_q;
1853
1854 /* runs in ISR context */
1855 void (*expiry_fn)(struct k_timer *timer);
1856
1857 /* runs in the context of the thread that calls k_timer_stop() */
1858 void (*stop_fn)(struct k_timer *timer);
1859
1860 /* timer period */
1861 k_timeout_t period;
1862
1863 /* timer status */
1864 uint32_t status;
1865
1866 /* user-specific data, also used to support legacy features */
1867 void *user_data;
1868
1869#ifdef CONFIG_OBJ_CORE_TIMER
1870 struct k_obj_core obj_core;
1871#endif
1875};
1876
1877#ifdef CONFIG_TIMER_OBSERVER
1878struct k_timer_observer {
1879 /* Invoked upon completion of k_timer initialization */
1880 void (*on_init)(struct k_timer *timer);
1881
1882 /* Invoked after the timer transitions to the running state */
1883 void (*on_start)(struct k_timer *timer, k_timeout_t duration,
1884 k_timeout_t period);
1885
1886 /* Invoked when the active timer is explicitly stopped */
1887 void (*on_stop)(struct k_timer *timer);
1888
1889 /* Executes in ISR context, keep minimal and non-blocking */
1890 void (*on_expiry)(struct k_timer *timer);
1891};
1892#endif /* CONFIG_TIMER_OBSERVER */
1893
1897#define Z_TIMER_INITIALIZER(obj, expiry, stop) \
1898 { \
1899 .timeout = { \
1900 .fn = z_timer_expiration_handler, \
1901 }, \
1902 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
1903 .expiry_fn = expiry, \
1904 .stop_fn = stop, \
1905 .period = {}, \
1906 .status = 0, \
1907 .user_data = 0, \
1908 }
1912
1918
1929typedef void (*k_timer_expiry_t)(struct k_timer *timer);
1930
1945typedef void (*k_timer_stop_t)(struct k_timer *timer);
1946
1958#define K_TIMER_DEFINE(name, expiry_fn, stop_fn) \
1959 STRUCT_SECTION_ITERABLE(k_timer, name) = \
1960 Z_TIMER_INITIALIZER(name, expiry_fn, stop_fn)
1961
1962
1963#ifdef CONFIG_TIMER_OBSERVER
1964
1968#define Z_TIMER_OBSERVER_INITIALIZER(name, init, start, stop, expiry) \
1969 { \
1970 .on_init = init, \
1971 .on_start = start, \
1972 .on_stop = stop, \
1973 .on_expiry = expiry \
1974 }
1978
1992#define K_TIMER_OBSERVER_DEFINE(name, init, start, stop, expiry) \
1993 static const STRUCT_SECTION_ITERABLE(k_timer_observer, name) = \
1994 Z_TIMER_OBSERVER_INITIALIZER(name, init, start, stop, expiry)
1995
1996#endif /* CONFIG_TIMER_OBSERVER */
1997
2007void k_timer_init(struct k_timer *timer,
2008 k_timer_expiry_t expiry_fn,
2009 k_timer_stop_t stop_fn);
2010
2028__syscall void k_timer_start(struct k_timer *timer,
2029 k_timeout_t duration, k_timeout_t period);
2030
2047__syscall void k_timer_stop(struct k_timer *timer);
2048
2061__syscall uint32_t k_timer_status_get(struct k_timer *timer);
2062
2080__syscall uint32_t k_timer_status_sync(struct k_timer *timer);
2081
2082#ifdef CONFIG_SYS_CLOCK_EXISTS
2083
2095__syscall k_ticks_t k_timer_expires_ticks(const struct k_timer *timer);
2096
2097static inline k_ticks_t z_impl_k_timer_expires_ticks(
2098 const struct k_timer *timer)
2099{
2100 return z_timeout_expires(&timer->timeout);
2101}
2102
2113__syscall k_ticks_t k_timer_remaining_ticks(const struct k_timer *timer);
2114
2115static inline k_ticks_t z_impl_k_timer_remaining_ticks(
2116 const struct k_timer *timer)
2117{
2118 return z_timeout_remaining(&timer->timeout);
2119}
2120
2131static inline uint32_t k_timer_remaining_get(struct k_timer *timer)
2132{
2134}
2135
2136#endif /* CONFIG_SYS_CLOCK_EXISTS */
2137
2150__syscall void k_timer_user_data_set(struct k_timer *timer, void *user_data);
2151
2155static inline void z_impl_k_timer_user_data_set(struct k_timer *timer,
2156 void *user_data)
2157{
2158 timer->user_data = user_data;
2159}
2160
2168__syscall void *k_timer_user_data_get(const struct k_timer *timer);
2169
2170static inline void *z_impl_k_timer_user_data_get(const struct k_timer *timer)
2171{
2172 return timer->user_data;
2173}
2174
2195int k_timer_cleanup(struct k_timer *timer);
2196
2198
2204
2214__syscall int64_t k_uptime_ticks(void);
2215
2229static inline int64_t k_uptime_get(void)
2230{
2232}
2233
2253static inline uint32_t k_uptime_get_32(void)
2254{
2255 return (uint32_t)k_uptime_get();
2256}
2257
2266static inline uint32_t k_uptime_seconds(void)
2267{
2269}
2270
2282static inline int64_t k_uptime_delta(int64_t *reftime)
2283{
2284 int64_t uptime, delta;
2285
2286 uptime = k_uptime_get();
2287 delta = uptime - *reftime;
2288 *reftime = uptime;
2289
2290 return delta;
2291}
2292
2301static inline uint32_t k_cycle_get_32(void)
2302{
2303 return arch_k_cycle_get_32();
2304}
2305
2319static inline uint64_t k_cycle_get_64(void)
2320{
2321 if (!IS_ENABLED(CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER)) {
2322 __ASSERT(0, "64-bit cycle counter not enabled on this platform. "
2323 "See CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER");
2324 return 0;
2325 }
2326
2327 return arch_k_cycle_get_64();
2328}
2329
2333
2340struct k_queue {
2344 sys_sflist_t data_q;
2345 struct k_spinlock lock;
2346 _wait_q_t wait_q;
2347
2348 Z_DECL_POLL_EVENT
2349
2350#ifdef CONFIG_OBJ_CORE_QUEUE
2351 struct k_obj_core obj_core;
2352#endif
2356};
2357
2361#define Z_QUEUE_INITIALIZER(obj) \
2362 { \
2363 .data_q = SYS_SFLIST_STATIC_INIT(&obj.data_q), \
2364 .lock = { }, \
2365 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
2366 Z_POLL_EVENT_OBJ_INIT(obj) \
2367 }
2371
2377
2385__syscall void k_queue_init(struct k_queue *queue);
2386
2400__syscall void k_queue_cancel_wait(struct k_queue *queue);
2401
2414void k_queue_append(struct k_queue *queue, void *data);
2415
2432__syscall int32_t k_queue_alloc_append(struct k_queue *queue, void *data);
2433
2446void k_queue_prepend(struct k_queue *queue, void *data);
2447
2464__syscall int32_t k_queue_alloc_prepend(struct k_queue *queue, void *data);
2465
2479void k_queue_insert(struct k_queue *queue, void *prev, void *data);
2480
2499int k_queue_append_list(struct k_queue *queue, void *head, void *tail);
2500
2518int k_queue_merge_slist(struct k_queue *queue, sys_slist_t *list);
2519
2537__syscall void *k_queue_get(struct k_queue *queue, k_timeout_t timeout);
2538
2553bool k_queue_remove(struct k_queue *queue, void *data);
2554
2569bool k_queue_unique_append(struct k_queue *queue, void *data);
2570
2584__syscall int k_queue_is_empty(struct k_queue *queue);
2585
2586static inline int z_impl_k_queue_is_empty(struct k_queue *queue)
2587{
2588 return sys_sflist_is_empty(&queue->data_q) ? 1 : 0;
2589}
2590
2600__syscall void *k_queue_peek_head(struct k_queue *queue);
2601
2611__syscall void *k_queue_peek_tail(struct k_queue *queue);
2612
2622#define K_QUEUE_DEFINE(name) \
2623 STRUCT_SECTION_ITERABLE(k_queue, name) = \
2624 Z_QUEUE_INITIALIZER(name)
2625
2627
2628#ifdef CONFIG_USERSPACE
2638struct k_futex {
2645};
2646
2652
2671__syscall int k_futex_wait(struct k_futex *futex, atomic_val_t expected, k_timeout_t timeout);
2672
2686__syscall int k_futex_wake(struct k_futex *futex, bool wake_all);
2687
2689#endif
2690
2696
2701
2708
2709struct k_event {
2713 _wait_q_t wait_q;
2714 uint32_t events;
2715 struct k_spinlock lock;
2716
2717#ifdef CONFIG_OBJ_CORE_EVENT
2718 struct k_obj_core obj_core;
2719#endif
2723};
2724
2728#define Z_EVENT_INITIALIZER(obj) \
2729 { \
2730 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
2731 .events = 0, \
2732 .lock = {}, \
2733 }
2737
2745__syscall void k_event_init(struct k_event *event);
2746
2765__syscall uint32_t k_event_post(struct k_event *event, uint32_t events);
2766
2784__syscall uint32_t k_event_set(struct k_event *event, uint32_t events);
2785
2802__syscall uint32_t k_event_set_masked(struct k_event *event, uint32_t events,
2803 uint32_t events_mask);
2804
2818__syscall uint32_t k_event_clear(struct k_event *event, uint32_t events);
2819
2847__syscall uint32_t k_event_wait(struct k_event *event, uint32_t events,
2848 bool reset, k_timeout_t timeout);
2849
2877__syscall uint32_t k_event_wait_all(struct k_event *event, uint32_t events,
2878 bool reset, k_timeout_t timeout);
2879
2902__syscall uint32_t k_event_wait_safe(struct k_event *event, uint32_t events,
2903 bool reset, k_timeout_t timeout);
2904
2927__syscall uint32_t k_event_wait_all_safe(struct k_event *event, uint32_t events,
2928 bool reset, k_timeout_t timeout);
2929
2940static inline uint32_t k_event_test(struct k_event *event, uint32_t events_mask)
2941{
2942 return k_event_wait(event, events_mask, false, K_NO_WAIT);
2943}
2944
2954#define K_EVENT_DEFINE(name) \
2955 STRUCT_SECTION_ITERABLE(k_event, name) = \
2956 Z_EVENT_INITIALIZER(name);
2957
2959
2965struct k_fifo {
2969 struct k_queue _queue;
2970#ifdef CONFIG_OBJ_CORE_FIFO
2971 struct k_obj_core obj_core;
2972#endif
2976};
2977
2981#define Z_FIFO_INITIALIZER(obj) \
2982 { \
2983 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
2984 }
2988
2994
3002#define k_fifo_init(fifo) \
3003 ({ \
3004 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, init, fifo); \
3005 k_queue_init(&(fifo)->_queue); \
3006 K_OBJ_CORE_INIT(K_OBJ_CORE(fifo), _obj_type_fifo); \
3007 K_OBJ_CORE_LINK(K_OBJ_CORE(fifo)); \
3008 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, init, fifo); \
3009 })
3010
3022#define k_fifo_cancel_wait(fifo) \
3023 ({ \
3024 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, cancel_wait, fifo); \
3025 k_queue_cancel_wait(&(fifo)->_queue); \
3026 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, cancel_wait, fifo); \
3027 })
3028
3041#define k_fifo_put(fifo, data) \
3042 ({ \
3043 void *_data = data; \
3044 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put, fifo, _data); \
3045 k_queue_append(&(fifo)->_queue, _data); \
3046 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put, fifo, _data); \
3047 })
3048
3065#define k_fifo_alloc_put(fifo, data) \
3066 ({ \
3067 void *_data = data; \
3068 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, alloc_put, fifo, _data); \
3069 int fap_ret = k_queue_alloc_append(&(fifo)->_queue, _data); \
3070 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, alloc_put, fifo, _data, fap_ret); \
3071 fap_ret; \
3072 })
3073
3091#define k_fifo_put_list(fifo, head, tail) \
3092 ({ \
3093 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_list, fifo, head, tail); \
3094 k_queue_append_list(&(fifo)->_queue, head, tail); \
3095 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_list, fifo, head, tail); \
3096 })
3097
3114#define k_fifo_put_slist(fifo, list) \
3115 ({ \
3116 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_slist, fifo, list); \
3117 k_queue_merge_slist(&(fifo)->_queue, list); \
3118 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_slist, fifo, list); \
3119 })
3120
3139#define k_fifo_get(fifo, timeout) \
3140 ({ \
3141 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, get, fifo, timeout); \
3142 void *fg_ret = k_queue_get(&(fifo)->_queue, timeout); \
3143 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, get, fifo, timeout, fg_ret); \
3144 fg_ret; \
3145 })
3146
3160#define k_fifo_is_empty(fifo) \
3161 k_queue_is_empty(&(fifo)->_queue)
3162
3176#define k_fifo_peek_head(fifo) \
3177 ({ \
3178 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_head, fifo); \
3179 void *fph_ret = k_queue_peek_head(&(fifo)->_queue); \
3180 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_head, fifo, fph_ret); \
3181 fph_ret; \
3182 })
3183
3195#define k_fifo_peek_tail(fifo) \
3196 ({ \
3197 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_tail, fifo); \
3198 void *fpt_ret = k_queue_peek_tail(&(fifo)->_queue); \
3199 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_tail, fifo, fpt_ret); \
3200 fpt_ret; \
3201 })
3202
3212#define K_FIFO_DEFINE(name) \
3213 STRUCT_SECTION_ITERABLE(k_fifo, name) = \
3214 Z_FIFO_INITIALIZER(name)
3215
3217
3223struct k_lifo {
3227 struct k_queue _queue;
3228#ifdef CONFIG_OBJ_CORE_LIFO
3229 struct k_obj_core obj_core;
3230#endif
3234};
3235
3239#define Z_LIFO_INITIALIZER(obj) \
3240 { \
3241 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
3242 }
3246
3252
3260#define k_lifo_init(lifo) \
3261 ({ \
3262 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, init, lifo); \
3263 k_queue_init(&(lifo)->_queue); \
3264 K_OBJ_CORE_INIT(K_OBJ_CORE(lifo), _obj_type_lifo); \
3265 K_OBJ_CORE_LINK(K_OBJ_CORE(lifo)); \
3266 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, init, lifo); \
3267 })
3268
3281#define k_lifo_put(lifo, data) \
3282 ({ \
3283 void *_data = data; \
3284 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, put, lifo, _data); \
3285 k_queue_prepend(&(lifo)->_queue, _data); \
3286 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, put, lifo, _data); \
3287 })
3288
3305#define k_lifo_alloc_put(lifo, data) \
3306 ({ \
3307 void *_data = data; \
3308 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, alloc_put, lifo, _data); \
3309 int lap_ret = k_queue_alloc_prepend(&(lifo)->_queue, _data); \
3310 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, alloc_put, lifo, _data, lap_ret); \
3311 lap_ret; \
3312 })
3313
3332#define k_lifo_get(lifo, timeout) \
3333 ({ \
3334 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, get, lifo, timeout); \
3335 void *lg_ret = k_queue_get(&(lifo)->_queue, timeout); \
3336 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, get, lifo, timeout, lg_ret); \
3337 lg_ret; \
3338 })
3339
3349#define K_LIFO_DEFINE(name) \
3350 STRUCT_SECTION_ITERABLE(k_lifo, name) = \
3351 Z_LIFO_INITIALIZER(name)
3352
3354
3358#define K_STACK_FLAG_ALLOC ((uint8_t)1) /* Buffer was allocated */
3359
3360typedef uintptr_t stack_data_t;
3361
3362struct k_stack {
3363 _wait_q_t wait_q;
3364 struct k_spinlock lock;
3365 stack_data_t *base, *next, *top;
3366
3367 uint8_t flags;
3368
3369#ifdef CONFIG_OBJ_CORE_STACK
3370 struct k_obj_core obj_core;
3371#endif
3372};
3373
3374#define Z_STACK_INITIALIZER(obj, stack_buffer, stack_num_entries) \
3375 { \
3376 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3377 .base = (stack_buffer), \
3378 .next = (stack_buffer), \
3379 .top = (stack_buffer) + (stack_num_entries), \
3380 }
3384
3390
3400void k_stack_init(struct k_stack *stack,
3401 stack_data_t *buffer, uint32_t num_entries);
3402
3403
3418
3419__syscall int32_t k_stack_alloc_init(struct k_stack *stack,
3420 uint32_t num_entries);
3421
3433int k_stack_cleanup(struct k_stack *stack);
3434
3448__syscall int k_stack_push(struct k_stack *stack, stack_data_t data);
3449
3470__syscall int k_stack_pop(struct k_stack *stack, stack_data_t *data,
3471 k_timeout_t timeout);
3472
3483#define K_STACK_DEFINE(name, stack_num_entries) \
3484 stack_data_t __noinit \
3485 _k_stack_buf_##name[stack_num_entries]; \
3486 STRUCT_SECTION_ITERABLE(k_stack, name) = \
3487 Z_STACK_INITIALIZER(name, _k_stack_buf_##name, \
3488 stack_num_entries)
3489
3491
3495struct k_work;
3496struct k_work_q;
3497struct k_work_queue_config;
3498extern struct k_work_q k_sys_work_q;
3502
3508
3514struct k_mutex {
3519 _wait_q_t wait_q;
3521 struct k_thread *owner;
3522
3524 uint32_t lock_count;
3525
3526#if Z_MUTEX_PI_ENABLED
3528 sys_snode_t held_node;
3529#endif /* Z_MUTEX_PI_ENABLED */
3530
3531#ifdef CONFIG_OBJ_CORE_MUTEX
3532 struct k_obj_core obj_core;
3533#endif
3537};
3538
3542#if Z_MUTEX_PI_ENABLED
3543#define Z_MUTEX_HELD_NODE_INIT .held_node = {NULL},
3544#else
3545#define Z_MUTEX_HELD_NODE_INIT
3546#endif
3547
3548#define Z_MUTEX_INITIALIZER(obj) \
3549 { \
3550 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3551 .owner = NULL, \
3552 .lock_count = 0, \
3553 Z_MUTEX_HELD_NODE_INIT \
3554 }
3558
3568#define K_MUTEX_DEFINE(name) \
3569 STRUCT_SECTION_ITERABLE(k_mutex, name) = \
3570 Z_MUTEX_INITIALIZER(name)
3571
3584__syscall int k_mutex_init(struct k_mutex *mutex);
3585
3586
3614__syscall int k_mutex_lock(struct k_mutex *mutex, k_timeout_t timeout);
3615
3636__syscall int k_mutex_unlock(struct k_mutex *mutex);
3637
3641
3651 _wait_q_t wait_q;
3652
3653#ifdef CONFIG_OBJ_CORE_CONDVAR
3654 struct k_obj_core obj_core;
3655#endif
3659};
3660
3664#define Z_CONDVAR_INITIALIZER(obj) \
3665 { \
3666 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
3667 }
3671
3677
3684__syscall int k_condvar_init(struct k_condvar *condvar);
3685
3692__syscall int k_condvar_signal(struct k_condvar *condvar);
3693
3701__syscall int k_condvar_broadcast(struct k_condvar *condvar);
3702
3720__syscall int k_condvar_wait(struct k_condvar *condvar, struct k_mutex *mutex,
3721 k_timeout_t timeout);
3722
3733#define K_CONDVAR_DEFINE(name) \
3734 STRUCT_SECTION_ITERABLE(k_condvar, name) = \
3735 Z_CONDVAR_INITIALIZER(name)
3736
3739
3745
3752struct k_sem {
3756 _wait_q_t wait_q;
3757 unsigned int count;
3758 unsigned int limit;
3759
3760 Z_DECL_POLL_EVENT
3761
3762#ifdef CONFIG_OBJ_CORE_SEM
3763 struct k_obj_core obj_core;
3764#endif
3768};
3769
3773#define Z_SEM_INITIALIZER(obj, initial_count, count_limit) \
3774 { \
3775 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3776 .count = (initial_count), \
3777 .limit = (count_limit), \
3778 Z_POLL_EVENT_OBJ_INIT(obj) \
3779 }
3783
3792#define K_SEM_MAX_LIMIT UINT_MAX
3793
3809__syscall int k_sem_init(struct k_sem *sem, unsigned int initial_count,
3810 unsigned int limit);
3811
3830__syscall int k_sem_take(struct k_sem *sem, k_timeout_t timeout);
3831
3842__syscall void k_sem_give(struct k_sem *sem);
3843
3856__syscall void k_sem_reset(struct k_sem *sem);
3857
3867__syscall unsigned int k_sem_count_get(struct k_sem *sem);
3868
3872static inline unsigned int z_impl_k_sem_count_get(struct k_sem *sem)
3873{
3874 return sem->count;
3875}
3876
3888#define K_SEM_DEFINE(name, initial_count, count_limit) \
3889 STRUCT_SECTION_ITERABLE(k_sem, name) = \
3890 Z_SEM_INITIALIZER(name, initial_count, count_limit); \
3891 BUILD_ASSERT(((count_limit) != 0) && \
3892 (((initial_count) < (count_limit)) || ((initial_count) == (count_limit))) && \
3893 ((count_limit) <= K_SEM_MAX_LIMIT));
3894
3896
3897#if defined(CONFIG_SCHED_IPI_SUPPORTED) || defined(__DOXYGEN__)
3898struct k_ipi_work;
3899
3900
3908typedef void (*k_ipi_func_t)(struct k_ipi_work *work);
3909
3920 sys_dnode_t node[CONFIG_MP_MAX_NUM_CPUS]; /* Node in IPI work queue */
3921 k_ipi_func_t func; /* Function to execute on target CPU */
3922 struct k_event event; /* Event to signal when processed */
3923 uint32_t bitmask; /* Bitmask of targeted CPUs */
3927};
3928
3929
3937static inline void k_ipi_work_init(struct k_ipi_work *work)
3938{
3939 k_event_init(&work->event);
3940 for (unsigned int i = 0; i < CONFIG_MP_MAX_NUM_CPUS; i++) {
3941 sys_dnode_init(&work->node[i]);
3942 }
3943 work->bitmask = 0;
3944}
3945
3964int k_ipi_work_add(struct k_ipi_work *work, uint32_t cpu_bitmask,
3965 k_ipi_func_t func);
3966
3989int k_ipi_work_wait(struct k_ipi_work *work, k_timeout_t timeout);
3990
4000
4001#endif /* CONFIG_SCHED_IPI_SUPPORTED */
4002
4006struct k_work_delayable;
4007struct k_work_sync;
4011
4017
4024typedef void (*k_work_handler_t)(struct k_work *work);
4025
4039void k_work_init(struct k_work *work,
4040 k_work_handler_t handler);
4041
4056int k_work_busy_get(const struct k_work *work);
4057
4071static inline bool k_work_is_pending(const struct k_work *work);
4072
4094 struct k_work *work);
4095
4104int k_work_submit(struct k_work *work);
4105
4130bool k_work_flush(struct k_work *work,
4131 struct k_work_sync *sync);
4132
4152int k_work_cancel(struct k_work *work);
4153
4184bool k_work_cancel_sync(struct k_work *work, struct k_work_sync *sync);
4185
4195void k_work_queue_init(struct k_work_q *queue);
4196
4216void k_work_queue_start(struct k_work_q *queue,
4217 k_thread_stack_t *stack, size_t stack_size,
4218 int prio, const struct k_work_queue_config *cfg);
4219
4230void k_work_queue_run(struct k_work_q *queue, const struct k_work_queue_config *cfg);
4231
4241static inline k_tid_t k_work_queue_thread_get(struct k_work_q *queue);
4242
4266int k_work_queue_drain(struct k_work_q *queue, bool plug);
4267
4282
4302int k_work_queue_stop(struct k_work_q *queue, k_timeout_t timeout);
4303
4318 k_work_handler_t handler);
4319
4331static inline struct k_work_delayable *
4333
4348
4363static inline bool k_work_delayable_is_pending(
4364 const struct k_work_delayable *dwork);
4365
4380 const struct k_work_delayable *dwork);
4381
4396 const struct k_work_delayable *dwork);
4397
4426 struct k_work_delayable *dwork,
4427 k_timeout_t delay);
4428
4443 k_timeout_t delay);
4444
4481 struct k_work_delayable *dwork,
4482 k_timeout_t delay);
4483
4497 k_timeout_t delay);
4498
4524 struct k_work_sync *sync);
4525
4547
4577 struct k_work_sync *sync);
4578
4580enum {
4584 /* The atomic API is used for all work and queue flags fields to
4585 * enforce sequential consistency in SMP environments.
4586 */
4587
4588 /* Bits that represent the work item states. At least nine of the
4589 * combinations are distinct valid stable states.
4590 */
4591 K_WORK_RUNNING_BIT = 0,
4592 K_WORK_CANCELING_BIT = 1,
4593 K_WORK_QUEUED_BIT = 2,
4594 K_WORK_DELAYED_BIT = 3,
4595 K_WORK_FLUSHING_BIT = 4,
4596
4597 K_WORK_MASK = BIT(K_WORK_DELAYED_BIT) | BIT(K_WORK_QUEUED_BIT)
4598 | BIT(K_WORK_RUNNING_BIT) | BIT(K_WORK_CANCELING_BIT) | BIT(K_WORK_FLUSHING_BIT),
4599
4600 /* Static work flags */
4601 K_WORK_DELAYABLE_BIT = 8,
4602 K_WORK_DELAYABLE = BIT(K_WORK_DELAYABLE_BIT),
4603
4604 /* Dynamic work queue flags */
4605 K_WORK_QUEUE_STARTED_BIT = 0,
4606 K_WORK_QUEUE_STARTED = BIT(K_WORK_QUEUE_STARTED_BIT),
4607 K_WORK_QUEUE_BUSY_BIT = 1,
4608 K_WORK_QUEUE_BUSY = BIT(K_WORK_QUEUE_BUSY_BIT),
4609 K_WORK_QUEUE_DRAIN_BIT = 2,
4610 K_WORK_QUEUE_DRAIN = BIT(K_WORK_QUEUE_DRAIN_BIT),
4611 K_WORK_QUEUE_PLUGGED_BIT = 3,
4612 K_WORK_QUEUE_PLUGGED = BIT(K_WORK_QUEUE_PLUGGED_BIT),
4613 K_WORK_QUEUE_STOP_BIT = 4,
4614 K_WORK_QUEUE_STOP = BIT(K_WORK_QUEUE_STOP_BIT),
4615
4616 /* Static work queue flags */
4617 K_WORK_QUEUE_NO_YIELD_BIT = 8,
4618 K_WORK_QUEUE_NO_YIELD = BIT(K_WORK_QUEUE_NO_YIELD_BIT),
4622 /* Transient work flags */
4623
4629 K_WORK_RUNNING = BIT(K_WORK_RUNNING_BIT),
4630
4635 K_WORK_CANCELING = BIT(K_WORK_CANCELING_BIT),
4636
4642 K_WORK_QUEUED = BIT(K_WORK_QUEUED_BIT),
4643
4649 K_WORK_DELAYED = BIT(K_WORK_DELAYED_BIT),
4650
4655 K_WORK_FLUSHING = BIT(K_WORK_FLUSHING_BIT),
4656};
4657
4663struct k_work {
4667 /* All fields are protected by the work module spinlock. */
4668
4669 /* Node to link into k_work_q pending list. */
4670 sys_snode_t node;
4671
4672 /* The function to be invoked by the work queue thread. */
4673 k_work_handler_t handler;
4674
4675 /* The queue on which the work item was last submitted. */
4676 struct k_work_q *queue;
4677
4678 /* State of the work item.
4679 *
4680 * The item can be DELAYED, QUEUED, and RUNNING simultaneously.
4681 *
4682 * It can be RUNNING and CANCELING simultaneously.
4683 */
4688};
4689
4693#define Z_WORK_INITIALIZER(work_handler) { \
4694 .handler = (work_handler), \
4695}
4699
4709 /* The work item. */
4710 struct k_work work;
4711
4712 /* Timeout used to submit work after a delay. */
4713 struct _timeout timeout;
4714
4715 /* The queue to which the work should be submitted. */
4716 struct k_work_q *queue;
4720};
4721
4725#define Z_WORK_DELAYABLE_INITIALIZER(work_handler) { \
4726 .work = { \
4727 .handler = (work_handler), \
4728 .flags = K_WORK_DELAYABLE, \
4729 }, \
4730}
4734
4751#define K_WORK_DELAYABLE_DEFINE(work, work_handler) \
4752 struct k_work_delayable work \
4753 = Z_WORK_DELAYABLE_INITIALIZER(work_handler)
4754
4758/* Record used to wait for work to flush.
4759 *
4760 * The work item is inserted into the queue that will process (or is
4761 * processing) the item, and will be processed as soon as the item
4762 * completes. When the flusher is processed the semaphore will be
4763 * signaled, releasing the thread waiting for the flush.
4764 */
4765struct z_work_flusher {
4766 struct k_work work;
4767 struct k_sem sem;
4768};
4769
4770/* Record used to wait for work to complete a cancellation.
4771 *
4772 * The work item is inserted into a global queue of pending cancels.
4773 * When a cancelling work item goes idle any matching waiters are
4774 * removed from pending_cancels and are woken.
4775 */
4776struct z_work_canceller {
4777 sys_snode_t node;
4778 struct k_work *work;
4779 struct k_sem sem;
4780};
4784
4804 union {
4805 struct z_work_flusher flusher;
4806 struct z_work_canceller canceller;
4807 };
4811};
4812
4824 const char *name;
4825
4839
4844
4854};
4855
4861struct k_work_q {
4865 /* The thread that animates the work. */
4866 __deprecated struct k_thread thread;
4867
4868 /* The thread ID that animates the work. This may be an external thread
4869 * if k_work_queue_run() is used.
4870 */
4871 k_tid_t thread_id;
4872
4873 /* All the following fields must be accessed only while the
4874 * work module spinlock is held.
4875 */
4876
4877 /* List of k_work items to be worked. */
4878 sys_slist_t pending;
4879
4880 /* Wait queue for idle work thread. */
4881 _wait_q_t notifyq;
4882
4883 /* Wait queue for threads waiting for the queue to drain. */
4884 _wait_q_t drainq;
4885
4886 /* Flags describing queue state. */
4888
4889#if defined(CONFIG_WORKQUEUE_WORK_TIMEOUT)
4890 struct _timeout work_timeout_record;
4891 struct k_work *work;
4892 k_timeout_t work_timeout;
4893 bool finished;
4894#endif /* defined(CONFIG_WORKQUEUE_WORK_TIMEOUT) */
4898};
4899
4900/* Provide the implementation for inline functions declared above */
4901
4902static inline bool k_work_is_pending(const struct k_work *work)
4903{
4904 return k_work_busy_get(work) != 0;
4905}
4906
4907static inline struct k_work_delayable *
4909{
4910 return CONTAINER_OF(work, struct k_work_delayable, work);
4911}
4912
4914 const struct k_work_delayable *dwork)
4915{
4916 return k_work_delayable_busy_get(dwork) != 0;
4917}
4918
4920 const struct k_work_delayable *dwork)
4921{
4922 return z_timeout_expires(&dwork->timeout);
4923}
4924
4926 const struct k_work_delayable *dwork)
4927{
4928 return z_timeout_remaining(&dwork->timeout);
4929}
4930
4931static inline k_tid_t k_work_queue_thread_get(struct k_work_q *queue)
4932{
4933 return queue->thread_id;
4934}
4935
4937
4938struct k_work_user;
4939
4944
4954typedef void (*k_work_user_handler_t)(struct k_work_user *work);
4955
4959struct k_work_user_q {
4960 struct k_queue queue;
4961 struct k_thread thread;
4962};
4963
4964enum {
4965 K_WORK_USER_STATE_PENDING, /* Work item pending state */
4966};
4967
4968struct k_work_user {
4969 void *_reserved; /* Used by k_queue implementation. */
4970 k_work_user_handler_t handler;
4972};
4973
4974#if defined(__cplusplus) && ((__cplusplus - 0) < 202002L)
4975#define Z_WORK_USER_INITIALIZER(work_handler) { NULL, work_handler, 0 }
4976#else
4977#define Z_WORK_USER_INITIALIZER(work_handler) \
4978 { \
4979 ._reserved = NULL, \
4980 .handler = (work_handler), \
4981 .flags = 0 \
4982 }
4983#endif
4987
4999#define K_WORK_USER_DEFINE(work, work_handler) \
5000 struct k_work_user work = Z_WORK_USER_INITIALIZER(work_handler)
5001
5011static inline void k_work_user_init(struct k_work_user *work,
5012 k_work_user_handler_t handler)
5013{
5014 *work = (struct k_work_user)Z_WORK_USER_INITIALIZER(handler);
5015}
5016
5033static inline bool k_work_user_is_pending(struct k_work_user *work)
5034{
5035 return atomic_test_bit(&work->flags, K_WORK_USER_STATE_PENDING);
5036}
5037
5056static inline int k_work_user_submit_to_queue(struct k_work_user_q *work_q,
5057 struct k_work_user *work)
5058{
5059 int ret = -EBUSY;
5060
5061 if (!atomic_test_and_set_bit(&work->flags,
5062 K_WORK_USER_STATE_PENDING)) {
5063 ret = k_queue_alloc_append(&work_q->queue, work);
5064
5065 /* Couldn't insert into the queue. Clear the pending bit
5066 * so the work item can be submitted again
5067 */
5068 if (ret != 0) {
5069 atomic_clear_bit(&work->flags,
5070 K_WORK_USER_STATE_PENDING);
5071 }
5072 }
5073
5074 return ret;
5075}
5076
5096void k_work_user_queue_start(struct k_work_user_q *work_q,
5097 k_thread_stack_t *stack,
5098 size_t stack_size, int prio,
5099 const char *name);
5100
5111static inline k_tid_t k_work_user_queue_thread_get(struct k_work_user_q *work_q)
5112{
5113 return &work_q->thread;
5114}
5115
5117
5121struct k_work_poll {
5122 struct k_work work;
5123 struct k_work_q *workq;
5124 struct z_poller poller;
5125 struct k_poll_event *events;
5126 int num_events;
5127 k_work_handler_t real_handler;
5128 struct _timeout timeout;
5129 int poll_result;
5130};
5134
5139
5151#define K_WORK_DEFINE(work, work_handler) \
5152 struct k_work work = Z_WORK_INITIALIZER(work_handler)
5153
5163void k_work_poll_init(struct k_work_poll *work,
5164 k_work_handler_t handler);
5165
5201 struct k_work_poll *work,
5202 struct k_poll_event *events,
5203 int num_events,
5204 k_timeout_t timeout);
5205
5237int k_work_poll_submit(struct k_work_poll *work,
5238 struct k_poll_event *events,
5239 int num_events,
5240 k_timeout_t timeout);
5241
5256int k_work_poll_cancel(struct k_work_poll *work);
5257
5259
5265
5271struct k_msgq {
5276 _wait_q_t wait_q;
5278 struct k_spinlock lock;
5280 size_t msg_size;
5282 uint32_t max_msgs;
5284 char *buffer_start;
5286 char *buffer_end;
5288 char *read_ptr;
5290 char *write_ptr;
5292 uint32_t used_msgs;
5293
5294 Z_DECL_POLL_EVENT
5295
5297 uint8_t flags;
5298
5299#ifdef CONFIG_OBJ_CORE_MSGQ
5300 struct k_obj_core obj_core;
5301#endif
5305};
5306
5310#define Z_MSGQ_INITIALIZER(obj, q_buffer, q_msg_size, q_max_msgs) \
5311 { \
5312 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
5313 .lock = {}, \
5314 .msg_size = q_msg_size, \
5315 .max_msgs = q_max_msgs, \
5316 .buffer_start = q_buffer, \
5317 .buffer_end = q_buffer + (q_max_msgs * q_msg_size), \
5318 .read_ptr = q_buffer, \
5319 .write_ptr = q_buffer, \
5320 .used_msgs = 0, \
5321 Z_POLL_EVENT_OBJ_INIT(obj) \
5322 .flags = 0, \
5323 }
5324
5325#define K_MSGQ_FLAG_ALLOC BIT(0)
5329
5341
5342
5365#define K_MSGQ_DEFINE(q_name, q_msg_size, q_max_msgs, q_align) \
5366 static char __noinit __aligned(q_align) \
5367 _k_fifo_buf_##q_name[(q_max_msgs) * (q_msg_size)]; \
5368 STRUCT_SECTION_ITERABLE(k_msgq, q_name) = \
5369 Z_MSGQ_INITIALIZER(q_name, _k_fifo_buf_##q_name, \
5370 (q_msg_size), (q_max_msgs))
5371
5385#define K_MSGQ_DEFINE_STATIC(q_name, q_msg_size, q_max_msgs, q_align) \
5386 static char __noinit __aligned(q_align) \
5387 _k_fifo_buf_##q_name[(q_max_msgs) * (q_msg_size)]; \
5388 static STRUCT_SECTION_ITERABLE(k_msgq, q_name) = \
5389 Z_MSGQ_INITIALIZER(q_name, _k_fifo_buf_##q_name, \
5390 (q_msg_size), (q_max_msgs))
5391
5411#define K_MSGQ_DEFINE_TYPE(q_name, q_msg_type, q_max_msgs) \
5412 K_MSGQ_DEFINE(q_name, sizeof(q_msg_type), q_max_msgs, __alignof(q_msg_type))
5413
5425#define K_MSGQ_DEFINE_STATIC_TYPE(q_name, q_msg_type, q_max_msgs) \
5426 K_MSGQ_DEFINE_STATIC(q_name, sizeof(q_msg_type), q_max_msgs, __alignof(q_msg_type))
5427
5442void k_msgq_init(struct k_msgq *msgq, char *buffer, size_t msg_size,
5443 uint32_t max_msgs);
5444
5464__syscall int k_msgq_alloc_init(struct k_msgq *msgq, size_t msg_size,
5465 uint32_t max_msgs);
5466
5480int k_msgq_cleanup(struct k_msgq *msgq);
5481
5502__syscall int k_msgq_put(struct k_msgq *msgq, const void *data, k_timeout_t timeout);
5503
5528__syscall int k_msgq_put_front(struct k_msgq *msgq, const void *data);
5529
5550__syscall int k_msgq_get(struct k_msgq *msgq, void *data, k_timeout_t timeout);
5551
5566__syscall int k_msgq_peek(struct k_msgq *msgq, void *data);
5567
5584__syscall int k_msgq_peek_at(struct k_msgq *msgq, void *data, uint32_t idx);
5585
5595__syscall void k_msgq_purge(struct k_msgq *msgq);
5596
5607__syscall uint32_t k_msgq_num_free_get(struct k_msgq *msgq);
5608
5617__syscall void k_msgq_get_attrs(struct k_msgq *msgq,
5618 struct k_msgq_attrs *attrs);
5619
5620
5621static inline uint32_t z_impl_k_msgq_num_free_get(struct k_msgq *msgq)
5622{
5623 return msgq->max_msgs - msgq->used_msgs;
5624}
5625
5635__syscall uint32_t k_msgq_num_used_get(struct k_msgq *msgq);
5636
5637static inline uint32_t z_impl_k_msgq_num_used_get(struct k_msgq *msgq)
5638{
5639 return msgq->used_msgs;
5640}
5641
5643
5649
5656 size_t size;
5660 void *tx_data;
5669 k_tid_t _syncing_thread;
5670#if (CONFIG_NUM_MBOX_ASYNC_MSGS > 0)
5672 struct k_sem *_async_sem;
5673#endif
5677};
5678
5683struct k_mbox {
5688 _wait_q_t tx_msg_queue;
5690 _wait_q_t rx_msg_queue;
5691 struct k_spinlock lock;
5692
5693#ifdef CONFIG_OBJ_CORE_MAILBOX
5694 struct k_obj_core obj_core;
5695#endif
5699};
5700
5704#define Z_MBOX_INITIALIZER(obj) \
5705 { \
5706 .tx_msg_queue = Z_WAIT_Q_INIT(&obj.tx_msg_queue), \
5707 .rx_msg_queue = Z_WAIT_Q_INIT(&obj.rx_msg_queue), \
5708 }
5712
5722#define K_MBOX_DEFINE(name) \
5723 STRUCT_SECTION_ITERABLE(k_mbox, name) = \
5724 Z_MBOX_INITIALIZER(name) \
5725
5726
5733void k_mbox_init(struct k_mbox *mbox);
5734
5754int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
5755 k_timeout_t timeout);
5756
5770void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
5771 struct k_sem *sem);
5772
5790int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *rx_msg,
5791 void *buffer, k_timeout_t timeout);
5792
5806void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer);
5807
5809
5815
5825__syscall void k_pipe_init(struct k_pipe *pipe, uint8_t *buffer, size_t buffer_size);
5826
5830enum pipe_flags {
5831 PIPE_FLAG_OPEN = BIT(0),
5832 PIPE_FLAG_RESET = BIT(1),
5833};
5837
5843struct k_pipe {
5847 size_t waiting;
5848 struct ring_buf buf;
5849 struct k_spinlock lock;
5850 _wait_q_t data;
5851 _wait_q_t space;
5852 uint8_t flags;
5853
5854 Z_DECL_POLL_EVENT
5855#ifdef CONFIG_OBJ_CORE_PIPE
5856 struct k_obj_core obj_core;
5857#endif
5861};
5862
5866#define Z_PIPE_INITIALIZER(obj, pipe_buffer, pipe_buffer_size) \
5867{ \
5868 .waiting = 0, \
5869 .buf = RING_BUF_INIT(pipe_buffer, pipe_buffer_size), \
5870 .data = Z_WAIT_Q_INIT(&obj.data), \
5871 .space = Z_WAIT_Q_INIT(&obj.space), \
5872 .flags = PIPE_FLAG_OPEN, \
5873 Z_POLL_EVENT_OBJ_INIT(obj) \
5874}
5878
5892#define K_PIPE_DEFINE(name, pipe_buffer_size, pipe_align) \
5893 static unsigned char __noinit __aligned(pipe_align) \
5894 _k_pipe_buf_##name[pipe_buffer_size]; \
5895 STRUCT_SECTION_ITERABLE(k_pipe, name) = \
5896 Z_PIPE_INITIALIZER(name, _k_pipe_buf_##name, pipe_buffer_size)
5897
5898
5916__syscall int k_pipe_write(struct k_pipe *pipe, const uint8_t *data, size_t len,
5917 k_timeout_t timeout);
5918
5935__syscall int k_pipe_read(struct k_pipe *pipe, uint8_t *data, size_t len,
5936 k_timeout_t timeout);
5937
5947__syscall void k_pipe_reset(struct k_pipe *pipe);
5948
5959__syscall void k_pipe_close(struct k_pipe *pipe);
5961
5965struct k_mem_slab_info {
5966 uint32_t num_blocks;
5967 size_t block_size;
5968 uint32_t num_used;
5969#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
5970 uint32_t max_used;
5971#endif
5972};
5973
5974struct k_mem_slab {
5975 _wait_q_t wait_q;
5976 struct k_spinlock lock;
5977 char *buffer;
5978 char *free_list;
5979 struct k_mem_slab_info info;
5980
5981#ifdef CONFIG_OBJ_CORE_MEM_SLAB
5982 struct k_obj_core obj_core;
5983#endif
5984};
5985
5986#define Z_MEM_SLAB_INITIALIZER(_slab, _slab_buffer, _slab_block_size, \
5987 _slab_num_blocks) \
5988 { \
5989 .wait_q = Z_WAIT_Q_INIT(&(_slab).wait_q), \
5990 .lock = {}, \
5991 .buffer = _slab_buffer, \
5992 .free_list = NULL, \
5993 .info = {_slab_num_blocks, _slab_block_size, 0} \
5994 }
5998
6004
6030#define K_MEM_SLAB_DEFINE_IN_SECT(name, in_section, slab_block_size, slab_num_blocks, slab_align) \
6031 BUILD_ASSERT(((slab_block_size) % (slab_align)) == 0, \
6032 "slab_block_size must be a multiple of slab_align"); \
6033 BUILD_ASSERT((((slab_align) & ((slab_align) - 1)) == 0), \
6034 "slab_align must be a power of 2"); \
6035 char in_section __aligned(WB_UP( \
6036 slab_align)) _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
6037 STRUCT_SECTION_ITERABLE(k_mem_slab, name) = Z_MEM_SLAB_INITIALIZER( \
6038 name, _k_mem_slab_buf_##name, WB_UP(slab_block_size), slab_num_blocks)
6039
6063#define K_MEM_SLAB_DEFINE(name, slab_block_size, slab_num_blocks, slab_align) \
6064 K_MEM_SLAB_DEFINE_IN_SECT(name, __noinit_named(k_mem_slab_buf_##name), slab_block_size, \
6065 slab_num_blocks, slab_align)
6066
6088#define K_MEM_SLAB_DEFINE_TYPE(name, type, slab_num_blocks) \
6089 K_MEM_SLAB_DEFINE(name, sizeof(type), slab_num_blocks, __alignof(type))
6090
6107#define K_MEM_SLAB_DEFINE_IN_SECT_STATIC(name, in_section, slab_block_size, slab_num_blocks, \
6108 slab_align) \
6109 BUILD_ASSERT(((slab_block_size) % (slab_align)) == 0, \
6110 "slab_block_size must be a multiple of slab_align"); \
6111 BUILD_ASSERT((((slab_align) & ((slab_align) - 1)) == 0), \
6112 "slab_align must be a power of 2"); \
6113 static char in_section __aligned(WB_UP( \
6114 slab_align)) _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
6115 static STRUCT_SECTION_ITERABLE(k_mem_slab, name) = Z_MEM_SLAB_INITIALIZER( \
6116 name, _k_mem_slab_buf_##name, WB_UP(slab_block_size), slab_num_blocks)
6117
6132#define K_MEM_SLAB_DEFINE_STATIC(name, slab_block_size, slab_num_blocks, slab_align) \
6133 K_MEM_SLAB_DEFINE_IN_SECT_STATIC(name, __noinit_named(k_mem_slab_buf_##name), \
6134 slab_block_size, slab_num_blocks, slab_align)
6135
6148#define K_MEM_SLAB_DEFINE_STATIC_TYPE(name, type, slab_num_blocks) \
6149 K_MEM_SLAB_DEFINE_STATIC(name, sizeof(type), slab_num_blocks, __alignof(type))
6150
6172int k_mem_slab_init(struct k_mem_slab *slab, void *buffer,
6173 size_t block_size, uint32_t num_blocks);
6174
6196int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem,
6197 k_timeout_t timeout);
6198
6210void k_mem_slab_free(struct k_mem_slab *slab, void *mem);
6211
6224static inline uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
6225{
6226 return slab->info.num_used;
6227}
6228
6241static inline uint32_t k_mem_slab_max_used_get(struct k_mem_slab *slab)
6242{
6243#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
6244 return slab->info.max_used;
6245#else
6246 ARG_UNUSED(slab);
6247 return 0;
6248#endif
6249}
6250
6263static inline uint32_t k_mem_slab_num_free_get(struct k_mem_slab *slab)
6264{
6265 return slab->info.num_blocks - slab->info.num_used;
6266}
6267
6281
6282int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stats *stats);
6283
6297int k_mem_slab_runtime_stats_reset_max(struct k_mem_slab *slab);
6298
6300
6305
6311struct k_heap {
6315 struct sys_heap heap;
6316 _wait_q_t wait_q;
6317 struct k_spinlock lock;
6321};
6322
6336void k_heap_init(struct k_heap *h, void *mem,
6337 size_t bytes) __attribute_nonnull(1);
6338
6360void *k_heap_aligned_alloc(struct k_heap *h, size_t align, size_t bytes,
6361 k_timeout_t timeout) __attribute_nonnull(1);
6362
6384void *k_heap_alloc(struct k_heap *h, size_t bytes,
6385 k_timeout_t timeout) __attribute_nonnull(1);
6386
6409void *k_heap_calloc(struct k_heap *h, size_t num, size_t size, k_timeout_t timeout)
6410 __attribute_nonnull(1);
6411
6435void *k_heap_realloc(struct k_heap *h, void *ptr, size_t bytes, k_timeout_t timeout)
6436 __attribute_nonnull(1);
6437
6448void k_heap_free(struct k_heap *h, void *mem) __attribute_nonnull(1);
6449
6450/*
6451 * Heap sizing constants computed at build time from actual struct layouts
6452 * in lib/heap/heap_constants.c via the gen_offset mechanism.
6453 */
6454#include <zephyr/heap_constants.h>
6455
6456/* chunk0 size in bytes for nb buckets (includes trailer metadata) */
6457#define _Z_HEAP_C0(nb) \
6458 (ROUND_UP(___z_heap_struct_SIZEOF + \
6459 (nb) * ___z_heap_bucket_SIZEOF, ___z_heap_chunk_unit_SIZEOF) + \
6460 ___z_heap_trailer_SIZEOF)
6461
6462/* Allocation chunk size in bytes (header + data rounded up, plus trailer) */
6463#define _Z_HEAP_AC(ab) \
6464 (ROUND_UP(___z_heap_hdr_SIZEOF + (ab), ___z_heap_chunk_unit_SIZEOF) + \
6465 ___z_heap_trailer_SIZEOF)
6466
6467/* Total heap size in chunk units */
6468#define _Z_HEAP_SZ(nb, ab) \
6469 ((_Z_HEAP_C0(nb) + _Z_HEAP_AC(ab)) / ___z_heap_chunk_unit_SIZEOF)
6470
6471/* Bucket count from heap size in chunk units (mirrors bucket_idx() + 1) */
6472#define _Z_HEAP_NB(sz) \
6473 (32 - __builtin_clz((unsigned int)((sz) - \
6474 ___z_heap_min_chunk_SIZEOF + 1)))
6475
6476/* 3-round convergent iteration starting from 1 bucket */
6477#define _Z_HEAP_NB1(ab) _Z_HEAP_NB(_Z_HEAP_SZ(1, ab))
6478#define _Z_HEAP_NB2(ab) _Z_HEAP_NB(_Z_HEAP_SZ(_Z_HEAP_NB1(ab), ab))
6479#define _Z_HEAP_NB3(ab) _Z_HEAP_NB(_Z_HEAP_SZ(_Z_HEAP_NB2(ab), ab))
6480
6494#define Z_HEAP_MIN_SIZE_FOR(alloc_bytes) \
6495 (_Z_HEAP_C0(_Z_HEAP_NB3(alloc_bytes)) + \
6496 _Z_HEAP_AC(alloc_bytes) + ___z_heap_ftr_SIZEOF)
6497
6498#define Z_HEAP_MIN_SIZE Z_HEAP_MIN_SIZE_FOR(1)
6499
6516#define Z_HEAP_DEFINE_IN_SECT(name, bytes, in_section) \
6517 char in_section \
6518 __aligned(8) /* CHUNK_UNIT */ \
6519 kheap_##name[MAX(bytes, Z_HEAP_MIN_SIZE)]; \
6520 STRUCT_SECTION_ITERABLE(k_heap, name) = { \
6521 .heap = { \
6522 .init_mem = kheap_##name, \
6523 .init_bytes = MAX(bytes, Z_HEAP_MIN_SIZE), \
6524 }, \
6525 }
6526
6541#define K_HEAP_DEFINE(name, bytes) \
6542 Z_HEAP_DEFINE_IN_SECT(name, bytes, \
6543 __noinit_named(kheap_buf_##name))
6544
6559#define K_HEAP_DEFINE_NOCACHE(name, bytes) \
6560 Z_HEAP_DEFINE_IN_SECT(name, bytes, __nocache)
6561
6571int k_heap_array_get(struct k_heap **heap);
6572
6576
6583
6602void *k_aligned_alloc(size_t align, size_t size);
6603
6615void *k_malloc(size_t size);
6616
6627void k_free(void *ptr);
6628
6640void *k_calloc(size_t nmemb, size_t size);
6641
6659void *k_realloc(void *ptr, size_t size);
6660
6662
6663/* polling API - PRIVATE */
6664
6665#ifdef CONFIG_POLL
6666#define _INIT_OBJ_POLL_EVENT(obj) do { (obj)->poll_event = NULL; } while (false)
6667#else
6668#define _INIT_OBJ_POLL_EVENT(obj) do { } while (false)
6669#endif
6670
6671/* private - types bit positions */
6672enum _poll_types_bits {
6673 /* can be used to ignore an event */
6674 _POLL_TYPE_IGNORE,
6675
6676 /* to be signaled by k_poll_signal_raise() */
6677 _POLL_TYPE_SIGNAL,
6678
6679 /* semaphore availability */
6680 _POLL_TYPE_SEM_AVAILABLE,
6681
6682 /* queue/FIFO/LIFO data availability */
6683 _POLL_TYPE_DATA_AVAILABLE,
6684
6685 /* msgq data availability */
6686 _POLL_TYPE_MSGQ_DATA_AVAILABLE,
6687
6688 /* pipe data availability */
6689 _POLL_TYPE_PIPE_DATA_AVAILABLE,
6690
6691 _POLL_NUM_TYPES
6692};
6693
6694#define Z_POLL_TYPE_BIT(type) (1U << ((type) - 1U))
6695
6696/* private - states bit positions */
6697enum _poll_states_bits {
6698 /* default state when creating event */
6699 _POLL_STATE_NOT_READY,
6700
6701 /* signaled by k_poll_signal_raise() */
6702 _POLL_STATE_SIGNALED,
6703
6704 /* semaphore is available */
6705 _POLL_STATE_SEM_AVAILABLE,
6706
6707 /* data is available to read on queue/FIFO/LIFO */
6708 _POLL_STATE_DATA_AVAILABLE,
6709
6710 /* queue/FIFO/LIFO wait was cancelled */
6711 _POLL_STATE_CANCELLED,
6712
6713 /* data is available to read on a message queue */
6714 _POLL_STATE_MSGQ_DATA_AVAILABLE,
6715
6716 /* data is available to read from a pipe */
6717 _POLL_STATE_PIPE_DATA_AVAILABLE,
6718
6719 _POLL_NUM_STATES
6720};
6721
6722#define Z_POLL_STATE_BIT(state) (1U << ((state) - 1U))
6723
6724#define _POLL_EVENT_NUM_UNUSED_BITS \
6725 (32 - (0 \
6726 + 8 /* tag */ \
6727 + _POLL_NUM_TYPES \
6728 + _POLL_NUM_STATES \
6729 + 1 /* modes */ \
6730 ))
6731
6732/* end of polling API - PRIVATE */
6733
6734
6742
6743/* Public polling API */
6744
6750
6752#define K_POLL_TYPE_IGNORE 0
6754#define K_POLL_TYPE_SIGNAL Z_POLL_TYPE_BIT(_POLL_TYPE_SIGNAL)
6756#define K_POLL_TYPE_SEM_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_SEM_AVAILABLE)
6758#define K_POLL_TYPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_DATA_AVAILABLE)
6760#define K_POLL_TYPE_FIFO_DATA_AVAILABLE K_POLL_TYPE_DATA_AVAILABLE
6762#define K_POLL_TYPE_LIFO_DATA_AVAILABLE K_POLL_TYPE_DATA_AVAILABLE
6764#define K_POLL_TYPE_MSGQ_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_MSGQ_DATA_AVAILABLE)
6766#define K_POLL_TYPE_PIPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_PIPE_DATA_AVAILABLE)
6767
6769
6779
6785
6787#define K_POLL_STATE_NOT_READY 0
6789#define K_POLL_STATE_SIGNALED Z_POLL_STATE_BIT(_POLL_STATE_SIGNALED)
6791#define K_POLL_STATE_SEM_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_SEM_AVAILABLE)
6793#define K_POLL_STATE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_DATA_AVAILABLE)
6795#define K_POLL_STATE_FIFO_DATA_AVAILABLE K_POLL_STATE_DATA_AVAILABLE
6797#define K_POLL_STATE_LIFO_DATA_AVAILABLE K_POLL_STATE_DATA_AVAILABLE
6799#define K_POLL_STATE_MSGQ_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_MSGQ_DATA_AVAILABLE)
6801#define K_POLL_STATE_PIPE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_PIPE_DATA_AVAILABLE)
6803#define K_POLL_STATE_CANCELLED Z_POLL_STATE_BIT(_POLL_STATE_CANCELLED)
6804
6806
6819 sys_dlist_t poll_events;
6823
6828 unsigned int signaled;
6829
6832};
6833
6839#define K_POLL_SIGNAL_INITIALIZER(obj) \
6840 { \
6841 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events), \
6842 .signaled = 0, \
6843 .result = 0, \
6844 }
6845
6854 sys_dnode_t _node;
6855
6857 struct z_poller *poller;
6861
6864
6866 uint32_t type:_POLL_NUM_TYPES;
6867
6869 uint32_t state:_POLL_NUM_STATES;
6870
6873
6875 uint32_t unused:_POLL_EVENT_NUM_UNUSED_BITS;
6876
6878 union {
6879 /* The _typed_* aliases below are used by the K_POLL_EVENT_*INITIALIZER() macros to
6880 * ensure type safety of polled objects.
6881 */
6883 void *obj, *_typed_K_POLL_TYPE_IGNORE;
6885 struct k_poll_signal *signal, *_typed_K_POLL_TYPE_SIGNAL;
6887 struct k_sem *sem, *_typed_K_POLL_TYPE_SEM_AVAILABLE;
6889 struct k_fifo *fifo, *_typed_K_POLL_TYPE_FIFO_DATA_AVAILABLE;
6891 struct k_lifo *lifo, *_typed_K_POLL_TYPE_LIFO_DATA_AVAILABLE;
6893 struct k_queue *queue, *_typed_K_POLL_TYPE_DATA_AVAILABLE;
6895 struct k_msgq *msgq, *_typed_K_POLL_TYPE_MSGQ_DATA_AVAILABLE;
6897 struct k_pipe *pipe, *_typed_K_POLL_TYPE_PIPE_DATA_AVAILABLE;
6898 };
6899};
6900
6909#define K_POLL_EVENT_INITIALIZER(_event_type, _event_mode, _event_obj) \
6910 { \
6911 .poller = NULL, \
6912 .type = _event_type, \
6913 .state = K_POLL_STATE_NOT_READY, \
6914 .mode = _event_mode, \
6915 .unused = 0, \
6916 { \
6917 ._typed_##_event_type = _event_obj, \
6918 }, \
6919 }
6920
6930#define K_POLL_EVENT_STATIC_INITIALIZER(_event_type, _event_mode, _event_obj, \
6931 event_tag) \
6932 { \
6933 .tag = event_tag, \
6934 .type = _event_type, \
6935 .state = K_POLL_STATE_NOT_READY, \
6936 .mode = _event_mode, \
6937 .unused = 0, \
6938 { \
6939 ._typed_##_event_type = _event_obj, \
6940 }, \
6941 }
6942
6957
6958void k_poll_event_init(struct k_poll_event *event, uint32_t type,
6959 int mode, void *obj);
6960
7003
7004__syscall int k_poll(struct k_poll_event *events, int num_events,
7005 k_timeout_t timeout);
7006
7014
7015__syscall void k_poll_signal_init(struct k_poll_signal *sig);
7016
7022__syscall void k_poll_signal_reset(struct k_poll_signal *sig);
7023
7034__syscall void k_poll_signal_check(struct k_poll_signal *sig,
7035 unsigned int *signaled, int *result);
7036
7059
7060__syscall int k_poll_signal_raise(struct k_poll_signal *sig, int result);
7061
7063
7082static inline void k_cpu_idle(void)
7083{
7084 arch_cpu_idle();
7085}
7086
7101static inline void k_cpu_atomic_idle(unsigned int key)
7102{
7104}
7105
7109
7114#ifdef ARCH_EXCEPT
7115/* This architecture has direct support for triggering a CPU exception */
7116#define z_except_reason(reason) ARCH_EXCEPT(reason)
7117#else
7118
7119#if defined(CONFIG_PRINTK) && !defined(CONFIG_ASSERT_NO_FILE_INFO)
7120#define __EXCEPT_LOC() printk("@ %s:%d\n", __FILE__, __LINE__)
7121#else
7122#define __EXCEPT_LOC()
7123#endif /* CONFIG_PRINTK */
7124
7125/* NOTE: This is the implementation for arches that do not implement
7126 * ARCH_EXCEPT() to generate a real CPU exception.
7127 *
7128 * We won't have a real exception frame to determine the PC value when
7129 * the oops occurred, so print file and line number before we jump into
7130 * the fatal error handler.
7131 */
7132#define z_except_reason(reason) do { \
7133 __EXCEPT_LOC(); \
7134 z_fatal_error(reason, NULL); \
7135 } while (false)
7136
7137#endif /* _ARCH__EXCEPT */
7141
7153#define k_oops() z_except_reason(K_ERR_KERNEL_OOPS)
7154
7163#define k_panic() z_except_reason(K_ERR_KERNEL_PANIC)
7164
7168/*
7169 * private APIs that are utilized by one or more public APIs
7170 */
7171
7175void z_timer_expiration_handler(struct _timeout *timeout);
7179
7180#ifdef CONFIG_PRINTK
7188__syscall void k_str_out(char *c, size_t n);
7189#endif
7190
7196
7217__syscall int k_float_disable(struct k_thread *thread);
7218
7257__syscall int k_float_enable(struct k_thread *thread, unsigned int options);
7258
7262
7272
7280
7289
7300
7311
7321
7330
7339
7340#ifdef __cplusplus
7341}
7342#endif
7343
7344#include <zephyr/tracing/tracing.h>
7345#include <zephyr/syscalls/kernel.h>
7346
7347#endif /* !_ASMLANGUAGE */
7348
7349#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:46
struct z_thread_stack_element k_thread_stack_t
Typedef of struct z_thread_stack_element.
Definition arch_interface.h:44
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.
static _Bool atomic_test_and_set_bit(atomic_t *target, int bit)
Atomically set a bit and test it.
Definition atomic.h:181
long atomic_t
Atomic integer variable.
Definition atomic_types.h:34
static _Bool atomic_test_bit(const atomic_t *target, int bit)
Atomically get and test a bit.
Definition atomic.h:138
static void atomic_clear_bit(atomic_t *target, int bit)
Atomically clear a bit.
Definition atomic.h:227
atomic_t atomic_val_t
Value type for atomic integer variables.
Definition atomic_types.h:41
static uint32_t k_cycle_get_32(void)
Read the hardware clock.
Definition kernel.h:2301
#define K_NO_WAIT
Generate null timeout delay.
Definition kernel.h:1617
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:2253
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:2282
static uint32_t k_uptime_seconds(void)
Get system uptime in seconds.
Definition kernel.h:2266
static uint64_t k_cycle_get_64(void)
Read the 64-bit hardware clock.
Definition kernel.h:2319
static int64_t k_uptime_get(void)
Get system uptime.
Definition kernel.h:2229
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:7082
static void k_cpu_atomic_idle(unsigned int key)
Make the CPU idle in an atomic fashion.
Definition kernel.h:7101
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:2940
uint32_t k_event_wait_safe(struct k_event *event, uint32_t events, bool reset, k_timeout_t timeout)
Wait for any of the specified events (safe version).
uint32_t k_event_set(struct k_event *event, uint32_t events)
Set the events in an event object.
uint32_t k_event_post(struct k_event *event, uint32_t events)
Post one or more events to an event object.
void k_event_init(struct k_event *event)
Initialize an event object.
uint32_t k_event_clear(struct k_event *event, uint32_t events)
Clear the events in an event object.
uint32_t k_event_wait_all(struct k_event *event, uint32_t events, bool reset, k_timeout_t timeout)
Wait for all of the specified events.
static bool sys_sflist_is_empty(const sys_sflist_t *list)
Test if the given list is empty.
Definition sflist.h:339
struct _sflist sys_sflist_t
Flagged single-linked list structure.
Definition sflist.h:57
int k_float_disable(struct k_thread *thread)
Disable preservation of floating point context information.
int k_float_enable(struct k_thread *thread, unsigned int options)
Enable preservation of floating point context information.
int k_futex_wake(struct k_futex *futex, bool wake_all)
Wake one/all threads pending on a futex.
int k_futex_wait(struct k_futex *futex, atomic_val_t expected, k_timeout_t timeout)
Pend the current thread on a futex.
void * k_heap_alloc(struct k_heap *h, size_t bytes, k_timeout_t timeout)
Allocate memory from a k_heap.
int k_heap_array_get(struct k_heap **heap)
Get the array of statically defined heaps.
void * k_heap_calloc(struct k_heap *h, size_t num, size_t size, k_timeout_t timeout)
Allocate and initialize memory for an array of objects from a k_heap.
void k_heap_free(struct k_heap *h, void *mem)
Free memory allocated by k_heap_alloc().
void k_free(void *ptr)
Free memory allocated from heap.
void * k_realloc(void *ptr, size_t size)
Expand the size of an existing allocation.
void k_heap_init(struct k_heap *h, void *mem, size_t bytes)
Initialize a k_heap.
void * k_malloc(size_t size)
Allocate memory from the heap.
void * k_heap_realloc(struct k_heap *h, void *ptr, size_t bytes, k_timeout_t timeout)
Reallocate memory from a k_heap.
void * k_calloc(size_t nmemb, size_t size)
Allocate memory from heap, array style.
void * k_aligned_alloc(size_t align, size_t size)
Allocate memory from the heap with a specified alignment.
void * k_heap_aligned_alloc(struct k_heap *h, size_t align, size_t bytes, k_timeout_t timeout)
Allocate aligned memory from a k_heap.
bool k_is_in_isr(void)
Determine if code is running at interrupt level.
int k_is_preempt_thread(void)
Determine if code is running in a preemptible thread.
execution_context_types
Types of execution contexts.
Definition kernel.h:138
@ K_ISR
Executing in an interrupt service routine.
Definition kernel.h:139
@ K_COOP_THREAD
Executing in a cooperative thread.
Definition kernel.h:140
@ K_PREEMPT_THREAD
Executing in a preemptible thread.
Definition kernel.h:141
int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *rx_msg, void *buffer, k_timeout_t timeout)
Receive a mailbox message.
void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer)
Retrieve mailbox message data into a buffer.
void k_mbox_init(struct k_mbox *mbox)
Initialize a mailbox.
int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg, k_timeout_t timeout)
Send a mailbox message in a synchronous manner.
void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg, struct k_sem *sem)
Send a mailbox message in an asynchronous manner.
int k_mem_slab_init(struct k_mem_slab *slab, void *buffer, size_t block_size, uint32_t num_blocks)
Initialize a memory slab.
void k_mem_slab_free(struct k_mem_slab *slab, void *mem)
Free memory allocated from a memory slab.
int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stats *stats)
Get the memory stats for a memory slab.
int k_mem_slab_runtime_stats_reset_max(struct k_mem_slab *slab)
Reset the maximum memory usage for a slab.
int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem, k_timeout_t timeout)
Allocate memory from a memory slab.
static uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
Get the number of used blocks in a memory slab.
Definition kernel.h:6224
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:6241
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:6263
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:6771
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:6775
@ K_POLL_NUM_MODES
Number of poll modes.
Definition kernel.h:6777
void k_queue_init(struct k_queue *queue)
Initialize a queue.
void * k_queue_get(struct k_queue *queue, k_timeout_t timeout)
Get an element from a queue.
void * k_queue_peek_tail(struct k_queue *queue)
Peek element at the tail of queue.
bool k_queue_unique_append(struct k_queue *queue, void *data)
Append an element to a queue only if it's not present already.
bool k_queue_remove(struct k_queue *queue, void *data)
Remove an element from a queue.
int k_queue_merge_slist(struct k_queue *queue, sys_slist_t *list)
Atomically add a list of elements to a queue.
int32_t k_queue_alloc_append(struct k_queue *queue, void *data)
Append an element to a queue.
void k_queue_cancel_wait(struct k_queue *queue)
Cancel waiting on a queue.
void * k_queue_peek_head(struct k_queue *queue)
Peek element at the head of queue.
void k_queue_prepend(struct k_queue *queue, void *data)
Prepend an element to a queue.
int k_queue_append_list(struct k_queue *queue, void *head, void *tail)
Atomically append a list of elements to a queue.
void k_queue_append(struct k_queue *queue, void *data)
Append an element to the end of a queue.
int32_t k_queue_alloc_prepend(struct k_queue *queue, void *data)
Prepend an element to a queue.
void k_queue_insert(struct k_queue *queue, void *prev, void *data)
Inserts an element to a queue.
int k_queue_is_empty(struct k_queue *queue)
Query a queue to see if it has data available.
void k_sem_reset(struct k_sem *sem)
Resets a semaphore's count to zero.
unsigned int k_sem_count_get(struct k_sem *sem)
Get a semaphore's count.
void k_sem_give(struct k_sem *sem)
Give a semaphore.
int k_sem_take(struct k_sem *sem, k_timeout_t timeout)
Take a semaphore.
int k_sem_init(struct k_sem *sem, unsigned int initial_count, unsigned int limit)
Initialize a semaphore.
struct _slist sys_slist_t
Single-linked list structure.
Definition slist.h:54
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:44
int k_stack_pop(struct k_stack *stack, stack_data_t *data, k_timeout_t timeout)
Pop an element from a stack.
void k_stack_init(struct k_stack *stack, stack_data_t *buffer, uint32_t num_entries)
Initialize a stack.
int k_stack_cleanup(struct k_stack *stack)
Release a stack's allocated buffer.
int k_stack_push(struct k_stack *stack, stack_data_t data)
Push an element onto a stack.
int32_t k_stack_alloc_init(struct k_stack *stack, uint32_t num_entries)
Initialize a stack.
#define IS_ENABLED(config_macro)
Check for macro definition in compiler-visible expressions.
Definition util_macro.h:154
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
#define CONTAINER_OF(ptr, type, field)
Get a pointer to a structure containing the element.
Definition util.h:281
#define EBUSY
Mount device busy.
Definition errno.h:55
int k_thread_name_copy(k_tid_t thread, char *buf, size_t size)
Copy the thread name into a supplied buffer.
void k_yield(void)
Yield the current thread.
const char * k_thread_state_str(k_tid_t thread_id, char *buf, size_t buf_size)
Get thread state string.
void k_thread_resume(k_tid_t thread)
Resume a suspended thread.
void * k_thread_custom_data_get(void)
Get current thread's custom data.
void k_thread_abort(k_tid_t thread)
Abort a thread.
int k_thread_name_set(k_tid_t thread, const char *str)
Set current thread name.
void k_thread_priority_set(k_tid_t thread, int prio)
Set a thread's priority.
void k_thread_absolute_deadline_set(k_tid_t thread, int deadline)
Set absolute deadline expiration time for scheduler.
int k_thread_cpu_mask_enable(k_tid_t thread, int cpu)
Enable thread to run on specified CPU.
void k_thread_foreach_unlocked(k_thread_user_cb_t user_cb, void *user_data)
Iterate over all the threads in the system without locking.
bool k_can_yield(void)
Check whether it is possible to yield in the current context.
int k_thread_priority_get(k_tid_t thread)
Get a thread's priority.
static void k_thread_heap_assign(struct k_thread *thread, struct k_heap *heap)
Assign a resource memory pool to a thread.
Definition kernel.h:577
FUNC_NORETURN void k_thread_user_mode_enter(k_thread_entry_t entry, void *p1, void *p2, void *p3)
Drop a thread's privileges permanently to user mode.
int k_thread_join(struct k_thread *thread, k_timeout_t timeout)
Sleep until a thread exits.
k_ticks_t k_thread_timeout_remaining_ticks(const struct k_thread *thread)
Get time remaining before a thread wakes up, in system ticks.
void k_thread_custom_data_set(void *value)
Set current thread's custom data.
static bool k_thread_is_user_thread(const struct k_thread *thread)
Test whether provided thread is user thread.
Definition kernel.h:884
void k_sched_lock(void)
Lock the scheduler.
void k_busy_wait(uint32_t usec_to_wait)
Cause the current thread to busy wait.
void k_thread_time_slice_set(struct k_thread *th, int32_t slice_ticks, k_thread_timeslice_fn_t expired, void *data)
Set thread time slice.
static void k_thread_runtime_stats_longest_frame_reset(__maybe_unused struct k_thread *thread)
Resets thread longest frame usage data for specified thread.
Definition kernel.h:167
void k_thread_suspend(k_tid_t thread)
Suspend a thread.
void k_sched_unlock(void)
Unlock the scheduler.
static __attribute_const__ k_tid_t k_current_get(void)
Get thread ID of the current thread.
Definition kernel.h:859
int k_thread_cpu_mask_clear(k_tid_t thread)
Sets all CPU enable masks to zero.
void k_thread_foreach_filter_by_cpu(unsigned int cpu, k_thread_user_cb_t user_cb, void *user_data)
Iterate over all the threads in running on specified cpu.
void k_sched_time_slice_set(int32_t slice, int prio)
Set time-slicing period and scope.
int k_thread_cpu_mask_disable(k_tid_t thread, int cpu)
Prevent thread to run on specified CPU.
void k_wakeup(k_tid_t thread)
Wake up a sleeping thread.
int k_thread_stack_free(k_thread_stack_t *stack)
Free a dynamically allocated thread stack.
k_ticks_t k_thread_timeout_expires_ticks(const struct k_thread *thread)
Get time when a thread wakes up, in system ticks.
__attribute_const__ k_tid_t k_sched_current_thread_query(void)
Query thread ID of the current thread.
static void k_thread_start(k_tid_t thread)
Start an inactive thread.
Definition kernel.h:1363
#define K_USER
user mode thread
Definition kernel.h:352
k_tid_t k_thread_create(struct k_thread *new_thread, k_thread_stack_t *stack, size_t stack_size, k_thread_entry_t entry, void *p1, void *p2, void *p3, int prio, uint32_t options, k_timeout_t delay)
Create a thread.
void k_reschedule(void)
Invoke the scheduler.
void k_thread_deadline_set(k_tid_t thread, int deadline)
Set relative deadline expiration time for scheduler.
void k_thread_foreach_unlocked_filter_by_cpu(unsigned int cpu, k_thread_user_cb_t user_cb, void *user_data)
Iterate over the threads in running on current cpu without locking.
const char * k_thread_name_get(k_tid_t thread)
Get thread name.
void k_thread_foreach(k_thread_user_cb_t user_cb, void *user_data)
Iterate over all the threads in the system.
static bool k_is_pre_kernel(void)
Test whether startup is in the before-main-task phase.
Definition kernel.h:826
int k_thread_cpu_pin(k_tid_t thread, int cpu)
Pin a thread to a CPU.
int k_thread_cpu_mask_enable_all(k_tid_t thread)
Sets all CPU enable masks to one.
void(* k_thread_user_cb_t)(const struct k_thread *thread, void *user_data)
Callback type used by thread iteration functions.
Definition kernel.h:180
k_thread_stack_t * k_thread_stack_alloc(size_t size, int flags)
Dynamically allocate a thread stack.
k_ticks_t k_timer_expires_ticks(const struct k_timer *timer)
Get next expiration time of a timer, in system ticks.
void(* k_timer_stop_t)(struct k_timer *timer)
Timer stop function type.
Definition kernel.h:1945
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:1929
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:2131
uint32_t k_timer_status_sync(struct k_timer *timer)
Synchronize thread to timer expiration.
void k_timer_stop(struct k_timer *timer)
Stop a timer.
uint32_t k_timer_status_get(struct k_timer *timer)
Read timer status.
void k_timer_user_data_set(struct k_timer *timer, void *user_data)
Associate user-specific data with a timer.
#define k_ticks_to_ms_ceil32(t)
Convert ticks to milliseconds.
Definition time_units.h:1867
#define k_ticks_to_sec_floor32(t)
Convert ticks to seconds.
Definition time_units.h:1707
#define k_ticks_to_ms_floor64(t)
Convert ticks to milliseconds.
Definition time_units.h:1819
int k_work_poll_submit_to_queue(struct k_work_q *work_q, struct k_work_poll *work, struct k_poll_event *events, int num_events, k_timeout_t timeout)
Submit a triggered work item.
static k_tid_t k_work_queue_thread_get(struct k_work_q *queue)
Access the thread that animates a work queue.
Definition kernel.h:4931
static bool k_work_is_pending(const struct k_work *work)
Test whether a work item is currently pending.
Definition kernel.h:4902
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:4919
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:5056
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:5033
void(* k_work_handler_t)(struct k_work *work)
The signature for a work item handler function.
Definition kernel.h:4024
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:4913
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:5011
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:4954
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:5111
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:4908
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:4925
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:4635
@ K_WORK_QUEUED
Flag indicating a work item that has been submitted to a queue but has not started running.
Definition kernel.h:4642
@ K_WORK_DELAYED
Flag indicating a delayed work item that is scheduled for submission to a queue.
Definition kernel.h:4649
@ K_WORK_RUNNING
Flag indicating a work item that is running under a work queue thread.
Definition kernel.h:4629
@ K_WORK_FLUSHING
Flag indicating a synced work item that is being flushed.
Definition kernel.h:4655
struct k_thread * k_tid_t
Definition thread.h:414
struct k_thread_runtime_stats k_thread_runtime_stats_t
void k_sys_runtime_stats_disable(void)
Disable gathering of system runtime statistics.
int k_thread_runtime_stats_enable(k_tid_t thread)
Enable gathering of runtime statistics for specified thread.
int k_ipi_work_add(struct k_ipi_work *work, uint32_t cpu_bitmask, k_ipi_func_t func)
Add an IPI work item to the IPI work queue.
void k_sys_runtime_stats_enable(void)
Enable gathering of system runtime statistics.
int k_thread_runtime_stats_get(k_tid_t thread, k_thread_runtime_stats_t *stats)
Get the runtime statistics of a thread.
bool k_thread_runtime_stats_is_enabled(k_tid_t thread)
Check if runtime statistics gathering is enabled for a thread.
void k_ipi_work_signal(void)
Signal that there is one or more IPI work items to process.
int k_ipi_work_wait(struct k_ipi_work *work, k_timeout_t timeout)
Wait until the IPI work item has been processed by all targeted CPUs.
void(* k_ipi_func_t)(struct k_ipi_work *work)
IPI work item handler function type.
Definition kernel.h:3908
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:3937
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:386
Memory Statistics.
flags
Definition parser.h:86
state
Definition parser_state.h:29
Simple, header-only ring buffer implementation.
Thread sleep APIs.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INTPTR_TYPE__ intptr_t
Definition stdint.h:104
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINTPTR_TYPE__ uintptr_t
Definition stdint.h:105
__INT64_TYPE__ int64_t
Definition stdint.h:75
Kernel condition variable structure.
Definition kernel.h:3647
Event Structure.
Definition kernel.h:2709
Kernel FIFO structure.
Definition kernel.h:2965
futex structure
Definition kernel.h:2638
atomic_t val
Futex value.
Definition kernel.h:2644
Kernel synchronized heap structure.
Definition kernel.h:6311
IPI work item structure.
Definition kernel.h:3916
Kernel LIFO structure.
Definition kernel.h:3223
Mailbox Message Structure.
Definition kernel.h:5654
k_tid_t tx_target_thread
target thread id
Definition kernel.h:5664
void * tx_data
sender's message data buffer
Definition kernel.h:5660
k_tid_t rx_source_thread
source thread id
Definition kernel.h:5662
uint32_t info
application-defined information value
Definition kernel.h:5658
size_t size
size of message (in bytes)
Definition kernel.h:5656
Mailbox Structure.
Definition kernel.h:5683
Memory Domain.
Definition mem_domain.h:80
Memory Partition.
Definition mem_domain.h:55
Message Queue Attributes.
Definition kernel.h:5333
uint32_t used_msgs
Used messages.
Definition kernel.h:5339
size_t msg_size
Message Size.
Definition kernel.h:5335
uint32_t max_msgs
Maximal number of messages.
Definition kernel.h:5337
Message Queue Structure.
Definition kernel.h:5271
Kernel mutex structure.
Definition kernel.h:3514
Object core structure.
Definition obj_core.h:160
Kernel pipe structure.
Definition kernel.h:5843
Poll Event.
Definition kernel.h:6849
struct k_poll_signal * signal
Poll signal being polled.
Definition kernel.h:6885
struct k_pipe * pipe
Pipe being polled.
Definition kernel.h:6897
uint32_t tag
optional user-specified tag, opaque, untouched by the API
Definition kernel.h:6863
struct k_fifo * fifo
FIFO being polled.
Definition kernel.h:6889
struct k_msgq * msgq
Message queue being polled.
Definition kernel.h:6895
struct k_queue * queue
Queue being polled.
Definition kernel.h:6893
uint32_t unused
unused bits in 32-bit word
Definition kernel.h:6875
uint32_t type
bitfield of event types (bitwise-ORed K_POLL_TYPE_xxx values)
Definition kernel.h:6866
struct k_sem * sem
Semaphore being polled.
Definition kernel.h:6887
uint32_t state
bitfield of event states (bitwise-ORed K_POLL_STATE_xxx values)
Definition kernel.h:6869
uint32_t mode
mode of operation, from enum k_poll_modes
Definition kernel.h:6872
void * obj
Generic object pointer.
Definition kernel.h:6883
struct k_lifo * lifo
LIFO being polled.
Definition kernel.h:6891
Poll signal object.
Definition kernel.h:6814
int result
custom result value passed to k_poll_signal_raise() if needed
Definition kernel.h:6831
unsigned int signaled
1 if the event has been signaled, 0 otherwise.
Definition kernel.h:6828
Kernel queue structure.
Definition kernel.h:2340
Semaphore structure.
Definition kernel.h:3752
Kernel Spin Lock.
Definition spinlock.h:45
Thread Structure.
Definition thread.h:258
struct _thread_base base
Definition thread.h:260
struct k_heap * resource_pool
resource pool
Definition thread.h:363
struct __thread_entry entry
thread entry and parameters description
Definition thread.h:302
Kernel timeout type.
Definition clock.h:65
Kernel timer structure.
Definition kernel.h:1840
A structure used to submit work after a delay.
Definition kernel.h:4705
Kernel workqueue structure.
Definition kernel.h:4861
A structure holding optional configuration items for a work queue.
Definition kernel.h:4819
const char * name
The name to be given to the work queue thread.
Definition kernel.h:4824
uint32_t work_timeout_ms
Controls whether work queue monitors work timeouts.
Definition kernel.h:4853
bool essential
Control whether the work queue thread should be marked as essential thread.
Definition kernel.h:4843
bool no_yield
Control whether the work queue thread should yield between items.
Definition kernel.h:4838
A structure holding internal state for a pending synchronous operation on a work item or queue.
Definition kernel.h:4800
A structure used to submit work.
Definition kernel.h:4663
A structure to represent a ring buffer.
Definition ring_buffer.h:62
Definition sys_heap.h:61
Definition mem_stats.h:24
Iterable sections helpers.
static bool k_is_user_context(void)
Indicate whether the CPU is currently in user mode.
Definition syscall.h:120
Macros to abstract toolchain specific capabilities.
Main header file for tracing subsystem API.
Header file for tracing macros.