Zephyr Project API 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
kernel.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016, Wind River Systems, Inc.
3 *
4 * SPDX-License-Identifier: Apache-2.0
5 */
6
12
13#ifndef ZEPHYR_INCLUDE_KERNEL_H_
14#define ZEPHYR_INCLUDE_KERNEL_H_
15
16#if !defined(_ASMLANGUAGE)
18#include <errno.h>
19#include <limits.h>
20#include <stdbool.h>
21#include <zephyr/toolchain.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31/*
32 * Zephyr currently assumes the size of a couple standard types to simplify
33 * print string formats. Let's make sure this doesn't change without notice.
34 */
35BUILD_ASSERT(sizeof(int32_t) == sizeof(int));
36BUILD_ASSERT(sizeof(int64_t) == sizeof(long long));
37BUILD_ASSERT(sizeof(intptr_t) == sizeof(long));
38
47
56#define K_ANY NULL
57
58#if (CONFIG_NUM_COOP_PRIORITIES + CONFIG_NUM_PREEMPT_PRIORITIES) == 0
59#error Zero available thread priorities defined!
60#endif
61
66
77#define K_PRIO_COOP(x) (-(CONFIG_NUM_COOP_PRIORITIES - (x)))
78
89#define K_PRIO_PREEMPT(x) (x)
90
92#define K_HIGHEST_THREAD_PRIO (-CONFIG_NUM_COOP_PRIORITIES)
94#define K_LOWEST_THREAD_PRIO CONFIG_NUM_PREEMPT_PRIORITIES
96#define K_IDLE_PRIO K_LOWEST_THREAD_PRIO
98#define K_HIGHEST_APPLICATION_THREAD_PRIO (K_HIGHEST_THREAD_PRIO)
100#define K_LOWEST_APPLICATION_THREAD_PRIO (K_LOWEST_THREAD_PRIO - 1)
101
103
104#ifdef CONFIG_POLL
105#define Z_POLL_EVENT_OBJ_INIT(obj) \
106 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events),
107#define Z_DECL_POLL_EVENT sys_dlist_t poll_events;
108#else
109#define Z_POLL_EVENT_OBJ_INIT(obj)
110#define Z_DECL_POLL_EVENT
111#endif
112
113struct k_thread;
114struct k_mutex;
115struct k_sem;
116struct k_msgq;
117struct k_mbox;
118struct k_pipe;
119struct k_queue;
120struct k_fifo;
121struct k_lifo;
122struct k_stack;
123struct k_mem_slab;
124struct k_timer;
125struct k_poll_event;
126struct k_poll_signal;
127struct k_mem_domain;
128struct k_mem_partition;
129struct k_futex;
130struct k_event;
131
142
143/* private, used by k_poll and k_work_poll */
144struct k_work_poll;
145typedef int (*_poller_cb_t)(struct k_poll_event *event, uint32_t state);
146
151
165static inline void
167{
168#ifdef CONFIG_SCHED_THREAD_USAGE_ANALYSIS
169 thread->base.usage.longest = 0ULL;
170#endif
171}
172
179typedef void (*k_thread_user_cb_t)(const struct k_thread *thread,
180 void *user_data);
181
197void k_thread_foreach(k_thread_user_cb_t user_cb, void *user_data);
198
217#ifdef CONFIG_SMP
218void k_thread_foreach_filter_by_cpu(unsigned int cpu,
219 k_thread_user_cb_t user_cb, void *user_data);
220#else
221static inline
222void k_thread_foreach_filter_by_cpu(unsigned int cpu,
223 k_thread_user_cb_t user_cb, void *user_data)
224{
225 __ASSERT(cpu == 0, "cpu filter out of bounds");
226 ARG_UNUSED(cpu);
227 k_thread_foreach(user_cb, user_data);
228}
229#endif
230
259 k_thread_user_cb_t user_cb, void *user_data);
260
292#ifdef CONFIG_SMP
294 k_thread_user_cb_t user_cb, void *user_data);
295#else
296static inline
297void k_thread_foreach_unlocked_filter_by_cpu(unsigned int cpu,
298 k_thread_user_cb_t user_cb, void *user_data)
299{
300 __ASSERT(cpu == 0, "cpu filter out of bounds");
301 ARG_UNUSED(cpu);
302 k_thread_foreach_unlocked(user_cb, user_data);
303}
304#endif
305
307
313
314#endif /* !_ASMLANGUAGE */
315
316
317/*
318 * Thread user options. May be needed by assembly code. Common part uses low
319 * bits, arch-specific use high bits.
320 */
321
325#define K_ESSENTIAL (BIT(0))
326
330#define K_FP_IDX 1
343#define K_FP_REGS (BIT(K_FP_IDX))
344
351#define K_USER (BIT(2))
352
361#define K_INHERIT_PERMS (BIT(3))
362
372#define K_CALLBACK_STATE (BIT(4))
373
377#define K_DSP_IDX 13
390#define K_DSP_REGS (BIT(K_DSP_IDX))
391
395#define K_AGU_IDX 14
407#define K_AGU_REGS (BIT(K_AGU_IDX))
408
418#define K_SSE_REGS (BIT(15))
419
420/* end - thread options */
421
422#if !defined(_ASMLANGUAGE)
447__syscall k_thread_stack_t *k_thread_stack_alloc(size_t size, int flags);
448
462
514__syscall k_tid_t k_thread_create(struct k_thread *new_thread,
515 k_thread_stack_t *stack,
516 size_t stack_size,
518 void *p1, void *p2, void *p3,
519 int prio, uint32_t options, k_timeout_t delay);
520
543 void *p1, void *p2,
544 void *p3);
545
559#define k_thread_access_grant(thread, ...) \
560 FOR_EACH_FIXED_ARG(k_object_access_grant, (;), (thread), __VA_ARGS__)
561
576static inline void k_thread_heap_assign(struct k_thread *thread,
577 struct k_heap *heap)
578{
579 thread->resource_pool = heap;
580}
581
582#if defined(CONFIG_INIT_STACKS) && defined(CONFIG_THREAD_STACK_INFO)
604__syscall int k_thread_stack_space_get(const struct k_thread *thread,
605 size_t *unused_ptr);
606
622__syscall int k_thread_runtime_stack_unused_threshold_pct_set(struct k_thread *thread,
623 uint32_t pct);
624
640__syscall int k_thread_runtime_stack_unused_threshold_set(struct k_thread *thread,
641 size_t threshold);
642
655__syscall size_t k_thread_runtime_stack_unused_threshold_get(struct k_thread *thread);
656
668typedef void (*k_thread_stack_safety_handler_t)(const struct k_thread *thread,
669 size_t unused_space, void *arg);
670
685int k_thread_runtime_stack_safety_full_check(const struct k_thread *thread,
686 size_t *unused_ptr,
687 k_thread_stack_safety_handler_t handler,
688 void *arg);
689
704int k_thread_runtime_stack_safety_threshold_check(const struct k_thread *thread,
705 size_t *unused_ptr,
706 k_thread_stack_safety_handler_t handler,
707 void *arg);
708#endif
709
710#if (K_HEAP_MEM_POOL_SIZE > 0)
723void k_thread_system_pool_assign(struct k_thread *thread);
724#endif /* (K_HEAP_MEM_POOL_SIZE > 0) */
725
745__syscall int k_thread_join(struct k_thread *thread, k_timeout_t timeout);
746
762__syscall int32_t k_sleep(k_timeout_t timeout);
763
775static inline int32_t k_msleep(int32_t ms)
776{
777 return k_sleep(Z_TIMEOUT_MS(ms));
778}
779
797
814__syscall void k_busy_wait(uint32_t usec_to_wait);
815
827bool k_can_yield(void);
828
836__syscall void k_yield(void);
837
847__syscall void k_wakeup(k_tid_t thread);
848
862__attribute_const__
864
876static inline bool k_is_pre_kernel(void)
877{
878 extern bool z_sys_post_kernel; /* in init.c */
879
880 /*
881 * If called from userspace, it must be post kernel.
882 * This guard is necessary because z_sys_post_kernel memory
883 * is not accessible to user threads.
884 */
885 if (k_is_user_context()) {
886 return false;
887 }
888
889 /*
890 * Some compilers might optimize by pre-reading
891 * z_sys_post_kernel. This is absolutely not desirable.
892 * We are trying to avoid reading it if we are in user
893 * context as reading z_sys_post_kernel in user context
894 * will result in access fault. So add a compiler barrier
895 * here to stop that kind of optimizations.
896 */
897 compiler_barrier();
898
899 return !z_sys_post_kernel;
900}
901
908__attribute_const__
909static inline k_tid_t k_current_get(void)
910{
911 __ASSERT(!k_is_pre_kernel(), "k_current_get called pre-kernel");
912
913#ifdef CONFIG_CURRENT_THREAD_USE_TLS
914
915 /* Thread-local cache of current thread ID, set in z_thread_entry() */
916 extern Z_THREAD_LOCAL k_tid_t z_tls_current;
917
918 return z_tls_current;
919#else
921#endif
922}
923
943__syscall void k_thread_abort(k_tid_t thread);
944
945k_ticks_t z_timeout_expires(const struct _timeout *timeout);
946k_ticks_t z_timeout_remaining(const struct _timeout *timeout);
947
948#ifdef CONFIG_SYS_CLOCK_EXISTS
949
957__syscall k_ticks_t k_thread_timeout_expires_ticks(const struct k_thread *thread);
958
959static inline k_ticks_t z_impl_k_thread_timeout_expires_ticks(
960 const struct k_thread *thread)
961{
962 return z_timeout_expires(&thread->base.timeout);
963}
964
973
974static inline k_ticks_t z_impl_k_thread_timeout_remaining_ticks(
975 const struct k_thread *thread)
976{
977 return z_timeout_remaining(&thread->base.timeout);
978}
979
980#endif /* CONFIG_SYS_CLOCK_EXISTS */
981
985struct _static_thread_data {
986 struct k_thread *init_thread;
987 k_thread_stack_t *init_stack;
988 unsigned int init_stack_size;
989 k_thread_entry_t init_entry;
990 void *init_p1;
991 void *init_p2;
992 void *init_p3;
993 int init_prio;
994 uint32_t init_options;
995 const char *init_name;
996#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
997 int32_t init_delay_ms;
998#else
999 k_timeout_t init_delay;
1000#endif
1001};
1002
1003#ifdef CONFIG_TIMER_READS_ITS_FREQUENCY_AT_RUNTIME
1004#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay_ms = (ms)
1005#define Z_THREAD_INIT_DELAY(thread) SYS_TIMEOUT_MS((thread)->init_delay_ms)
1006#else
1007#define Z_THREAD_INIT_DELAY_INITIALIZER(ms) .init_delay = SYS_TIMEOUT_MS_INIT(ms)
1008#define Z_THREAD_INIT_DELAY(thread) (thread)->init_delay
1009#endif
1010
1011#define Z_THREAD_INITIALIZER(thread, stack, stack_size, \
1012 entry, p1, p2, p3, \
1013 prio, options, delay, tname) \
1014 { \
1015 .init_thread = (thread), \
1016 .init_stack = (stack), \
1017 .init_stack_size = (stack_size), \
1018 .init_entry = (k_thread_entry_t)entry, \
1019 .init_p1 = (void *)p1, \
1020 .init_p2 = (void *)p2, \
1021 .init_p3 = (void *)p3, \
1022 .init_prio = (prio), \
1023 .init_options = (options), \
1024 .init_name = STRINGIFY(tname), \
1025 Z_THREAD_INIT_DELAY_INITIALIZER(delay) \
1026 }
1027
1028/*
1029 * Refer to K_THREAD_DEFINE() and K_KERNEL_THREAD_DEFINE() for
1030 * information on arguments.
1031 */
1032#define Z_THREAD_COMMON_DEFINE(name, stack_size, \
1033 entry, p1, p2, p3, \
1034 prio, options, delay) \
1035 struct k_thread _k_thread_obj_##name; \
1036 const STRUCT_SECTION_ITERABLE(_static_thread_data, \
1037 _k_thread_data_##name) = \
1038 Z_THREAD_INITIALIZER(&_k_thread_obj_##name, \
1039 _k_thread_stack_##name, stack_size,\
1040 entry, p1, p2, p3, prio, options, \
1041 delay, name); \
1042 __maybe_unused const k_tid_t name = (k_tid_t)&_k_thread_obj_##name
1046
1078#define K_THREAD_DEFINE(name, stack_size, \
1079 entry, p1, p2, p3, \
1080 prio, options, delay) \
1081 K_THREAD_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
1082 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
1083 prio, options, delay)
1084
1115#define K_KERNEL_THREAD_DEFINE(name, stack_size, \
1116 entry, p1, p2, p3, \
1117 prio, options, delay) \
1118 K_KERNEL_STACK_DEFINE(_k_thread_stack_##name, stack_size); \
1119 Z_THREAD_COMMON_DEFINE(name, stack_size, entry, p1, p2, p3, \
1120 prio, options, delay)
1121
1131__syscall int k_thread_priority_get(k_tid_t thread);
1132
1158__syscall void k_thread_priority_set(k_tid_t thread, int prio);
1159
1160
1161#ifdef CONFIG_SCHED_DEADLINE
1197__syscall void k_thread_deadline_set(k_tid_t thread, int deadline);
1198
1239__syscall void k_thread_absolute_deadline_set(k_tid_t thread, int deadline);
1240#endif
1241
1260__syscall void k_reschedule(void);
1261
1262#ifdef CONFIG_SCHED_CPU_MASK
1280
1299
1315
1334
1345int k_thread_cpu_pin(k_tid_t thread, int cpu);
1346#endif
1347
1369__syscall void k_thread_suspend(k_tid_t thread);
1370
1382__syscall void k_thread_resume(k_tid_t thread);
1383
1397static inline void k_thread_start(k_tid_t thread)
1398{
1399 k_wakeup(thread);
1400}
1401
1428void k_sched_time_slice_set(int32_t slice, int prio);
1429
1468void k_thread_time_slice_set(struct k_thread *th, int32_t slice_ticks,
1469 k_thread_timeslice_fn_t expired, void *data);
1470
1472
1477
1489bool k_is_in_isr(void);
1490
1507__syscall int k_is_preempt_thread(void);
1508
1512
1517
1543void k_sched_lock(void);
1544
1553
1566__syscall void k_thread_custom_data_set(void *value);
1567
1575__syscall void *k_thread_custom_data_get(void);
1576
1593__syscall int k_thread_name_set(k_tid_t thread, const char *str);
1594
1603const char *k_thread_name_get(k_tid_t thread);
1604
1617__syscall int k_thread_name_copy(k_tid_t thread, char *buf,
1618 size_t size);
1619
1632const char *k_thread_state_str(k_tid_t thread_id, char *buf, size_t buf_size);
1633
1637
1642
1651#define K_NO_WAIT Z_TIMEOUT_NO_WAIT
1652
1665#define K_NSEC(t) Z_TIMEOUT_NS(t)
1666
1679#define K_USEC(t) Z_TIMEOUT_US(t)
1680
1691#define K_CYC(t) Z_TIMEOUT_CYC(t)
1692
1703#define K_TICKS(t) Z_TIMEOUT_TICKS(t)
1704
1715#define K_MSEC(ms) Z_TIMEOUT_MS(ms)
1716
1727#define K_SECONDS(s) K_MSEC((s) * MSEC_PER_SEC)
1728
1739#define K_MINUTES(m) K_SECONDS((m) * 60)
1740
1751#define K_HOURS(h) K_MINUTES((h) * 60)
1752
1761#define K_FOREVER Z_FOREVER
1762
1777#define K_TIMEOUT_SUM(timeout1, timeout2) K_TICKS(z_timeout_sum(timeout1, timeout2))
1778
1779#ifdef CONFIG_TIMEOUT_64BIT
1780
1792#define K_TIMEOUT_ABS_TICKS(t) \
1793 Z_TIMEOUT_TICKS(Z_TICK_ABS((k_ticks_t)CLAMP(t, 0, (INT64_MAX - 1))))
1794
1806#define K_TIMEOUT_ABS_SEC(t) K_TIMEOUT_ABS_TICKS(k_sec_to_ticks_ceil64(t))
1807
1819#define K_TIMEOUT_ABS_MS(t) K_TIMEOUT_ABS_TICKS(k_ms_to_ticks_ceil64(t))
1820
1833#define K_TIMEOUT_ABS_US(t) K_TIMEOUT_ABS_TICKS(k_us_to_ticks_ceil64(t))
1834
1847#define K_TIMEOUT_ABS_NS(t) K_TIMEOUT_ABS_TICKS(k_ns_to_ticks_ceil64(t))
1848
1861#define K_TIMEOUT_ABS_CYC(t) K_TIMEOUT_ABS_TICKS(k_cyc_to_ticks_ceil64(t))
1862#endif
1863
1867
1874struct k_timer {
1878 /*
1879 * _timeout structure must be first here if we want to use
1880 * dynamic timer allocation. timeout.node is used in the double-linked
1881 * list of free timers
1882 */
1883 struct _timeout timeout;
1884
1885 /* wait queue for the (single) thread waiting on this timer */
1886 _wait_q_t wait_q;
1887
1888 /* runs in ISR context */
1889 void (*expiry_fn)(struct k_timer *timer);
1890
1891 /* runs in the context of the thread that calls k_timer_stop() */
1892 void (*stop_fn)(struct k_timer *timer);
1893
1894 /* timer period */
1895 k_timeout_t period;
1896
1897 /* timer status */
1898 uint32_t status;
1899
1900 /* user-specific data, also used to support legacy features */
1901 void *user_data;
1902
1904
1905#ifdef CONFIG_OBJ_CORE_TIMER
1906 struct k_obj_core obj_core;
1907#endif
1911};
1912
1913#ifdef CONFIG_TIMER_OBSERVER
1914struct k_timer_observer {
1915 /* Invoked upon completion of k_timer initialization */
1916 void (*on_init)(struct k_timer *timer);
1917
1918 /* Invoked after the timer transitions to the running state */
1919 void (*on_start)(struct k_timer *timer, k_timeout_t duration,
1920 k_timeout_t period);
1921
1922 /* Invoked when the active timer is explicitly stopped */
1923 void (*on_stop)(struct k_timer *timer);
1924
1925 /* Executes in ISR context, keep minimal and non-blocking */
1926 void (*on_expiry)(struct k_timer *timer);
1927};
1928#endif /* CONFIG_TIMER_OBSERVER */
1929
1933#define Z_TIMER_INITIALIZER(obj, expiry, stop) \
1934 { \
1935 .timeout = { \
1936 .fn = z_timer_expiration_handler, \
1937 }, \
1938 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
1939 .expiry_fn = expiry, \
1940 .stop_fn = stop, \
1941 .period = {}, \
1942 .status = 0, \
1943 .user_data = 0, \
1944 }
1948
1954
1965typedef void (*k_timer_expiry_t)(struct k_timer *timer);
1966
1981typedef void (*k_timer_stop_t)(struct k_timer *timer);
1982
1994#define K_TIMER_DEFINE(name, expiry_fn, stop_fn) \
1995 STRUCT_SECTION_ITERABLE(k_timer, name) = \
1996 Z_TIMER_INITIALIZER(name, expiry_fn, stop_fn)
1997
1998
1999#ifdef CONFIG_TIMER_OBSERVER
2000
2004#define Z_TIMER_OBSERVER_INITIALIZER(name, init, start, stop, expiry) \
2005 { \
2006 .on_init = init, \
2007 .on_start = start, \
2008 .on_stop = stop, \
2009 .on_expiry = expiry \
2010 }
2014
2028#define K_TIMER_OBSERVER_DEFINE(name, init, start, stop, expiry) \
2029 static const STRUCT_SECTION_ITERABLE(k_timer_observer, name) = \
2030 Z_TIMER_OBSERVER_INITIALIZER(name, init, start, stop, expiry)
2031
2032#endif /* CONFIG_TIMER_OBSERVER */
2033
2043void k_timer_init(struct k_timer *timer,
2044 k_timer_expiry_t expiry_fn,
2045 k_timer_stop_t stop_fn);
2046
2064__syscall void k_timer_start(struct k_timer *timer,
2065 k_timeout_t duration, k_timeout_t period);
2066
2083__syscall void k_timer_stop(struct k_timer *timer);
2084
2097__syscall uint32_t k_timer_status_get(struct k_timer *timer);
2098
2116__syscall uint32_t k_timer_status_sync(struct k_timer *timer);
2117
2118#ifdef CONFIG_SYS_CLOCK_EXISTS
2119
2131__syscall k_ticks_t k_timer_expires_ticks(const struct k_timer *timer);
2132
2133static inline k_ticks_t z_impl_k_timer_expires_ticks(
2134 const struct k_timer *timer)
2135{
2136 return z_timeout_expires(&timer->timeout);
2137}
2138
2149__syscall k_ticks_t k_timer_remaining_ticks(const struct k_timer *timer);
2150
2151static inline k_ticks_t z_impl_k_timer_remaining_ticks(
2152 const struct k_timer *timer)
2153{
2154 return z_timeout_remaining(&timer->timeout);
2155}
2156
2167static inline uint32_t k_timer_remaining_get(struct k_timer *timer)
2168{
2170}
2171
2172#endif /* CONFIG_SYS_CLOCK_EXISTS */
2173
2186__syscall void k_timer_user_data_set(struct k_timer *timer, void *user_data);
2187
2191static inline void z_impl_k_timer_user_data_set(struct k_timer *timer,
2192 void *user_data)
2193{
2194 timer->user_data = user_data;
2195}
2196
2204__syscall void *k_timer_user_data_get(const struct k_timer *timer);
2205
2206static inline void *z_impl_k_timer_user_data_get(const struct k_timer *timer)
2207{
2208 return timer->user_data;
2209}
2210
2231int k_timer_cleanup(struct k_timer *timer);
2232
2234
2240
2250__syscall int64_t k_uptime_ticks(void);
2251
2265static inline int64_t k_uptime_get(void)
2266{
2268}
2269
2289static inline uint32_t k_uptime_get_32(void)
2290{
2291 return (uint32_t)k_uptime_get();
2292}
2293
2302static inline uint32_t k_uptime_seconds(void)
2303{
2305}
2306
2318static inline int64_t k_uptime_delta(int64_t *reftime)
2319{
2320 int64_t uptime, delta;
2321
2322 uptime = k_uptime_get();
2323 delta = uptime - *reftime;
2324 *reftime = uptime;
2325
2326 return delta;
2327}
2328
2337static inline uint32_t k_cycle_get_32(void)
2338{
2339 return arch_k_cycle_get_32();
2340}
2341
2355static inline uint64_t k_cycle_get_64(void)
2356{
2357 if (!IS_ENABLED(CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER)) {
2358 __ASSERT(0, "64-bit cycle counter not enabled on this platform. "
2359 "See CONFIG_TIMER_HAS_64BIT_CYCLE_COUNTER");
2360 return 0;
2361 }
2362
2363 return arch_k_cycle_get_64();
2364}
2365
2369
2376struct k_queue {
2380 sys_sflist_t data_q;
2381 struct k_spinlock lock;
2382 _wait_q_t wait_q;
2383
2384 Z_DECL_POLL_EVENT
2385
2390};
2391
2395#define Z_QUEUE_INITIALIZER(obj) \
2396 { \
2397 .data_q = SYS_SFLIST_STATIC_INIT(&obj.data_q), \
2398 .lock = { }, \
2399 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
2400 Z_POLL_EVENT_OBJ_INIT(obj) \
2401 }
2405
2411
2419__syscall void k_queue_init(struct k_queue *queue);
2420
2434__syscall void k_queue_cancel_wait(struct k_queue *queue);
2435
2448void k_queue_append(struct k_queue *queue, void *data);
2449
2466__syscall int32_t k_queue_alloc_append(struct k_queue *queue, void *data);
2467
2480void k_queue_prepend(struct k_queue *queue, void *data);
2481
2498__syscall int32_t k_queue_alloc_prepend(struct k_queue *queue, void *data);
2499
2513void k_queue_insert(struct k_queue *queue, void *prev, void *data);
2514
2533int k_queue_append_list(struct k_queue *queue, void *head, void *tail);
2534
2552int k_queue_merge_slist(struct k_queue *queue, sys_slist_t *list);
2553
2571__syscall void *k_queue_get(struct k_queue *queue, k_timeout_t timeout);
2572
2587bool k_queue_remove(struct k_queue *queue, void *data);
2588
2603bool k_queue_unique_append(struct k_queue *queue, void *data);
2604
2618__syscall int k_queue_is_empty(struct k_queue *queue);
2619
2620static inline int z_impl_k_queue_is_empty(struct k_queue *queue)
2621{
2622 return sys_sflist_is_empty(&queue->data_q) ? 1 : 0;
2623}
2624
2634__syscall void *k_queue_peek_head(struct k_queue *queue);
2635
2645__syscall void *k_queue_peek_tail(struct k_queue *queue);
2646
2656#define K_QUEUE_DEFINE(name) \
2657 STRUCT_SECTION_ITERABLE(k_queue, name) = \
2658 Z_QUEUE_INITIALIZER(name)
2659
2661
2662#ifdef CONFIG_USERSPACE
2672struct k_futex {
2679};
2680
2690struct z_futex_data {
2694 _wait_q_t wait_q;
2695 struct k_spinlock lock;
2699};
2700
2704#define Z_FUTEX_DATA_INITIALIZER(obj) \
2705 { \
2706 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q) \
2707 }
2711
2717
2737__syscall int k_futex_wait(struct k_futex *futex, int expected,
2738 k_timeout_t timeout);
2739
2754__syscall int k_futex_wake(struct k_futex *futex, bool wake_all);
2755
2757#endif
2758
2764
2769
2776
2777struct k_event {
2781 _wait_q_t wait_q;
2782 uint32_t events;
2783 struct k_spinlock lock;
2784
2786
2787#ifdef CONFIG_OBJ_CORE_EVENT
2788 struct k_obj_core obj_core;
2789#endif
2793};
2794
2798#define Z_EVENT_INITIALIZER(obj) \
2799 { \
2800 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
2801 .events = 0, \
2802 .lock = {}, \
2803 }
2807
2815__syscall void k_event_init(struct k_event *event);
2816
2835__syscall uint32_t k_event_post(struct k_event *event, uint32_t events);
2836
2854__syscall uint32_t k_event_set(struct k_event *event, uint32_t events);
2855
2872__syscall uint32_t k_event_set_masked(struct k_event *event, uint32_t events,
2873 uint32_t events_mask);
2874
2888__syscall uint32_t k_event_clear(struct k_event *event, uint32_t events);
2889
2914__syscall uint32_t k_event_wait(struct k_event *event, uint32_t events,
2915 bool reset, k_timeout_t timeout);
2916
2941__syscall uint32_t k_event_wait_all(struct k_event *event, uint32_t events,
2942 bool reset, k_timeout_t timeout);
2943
2963__syscall uint32_t k_event_wait_safe(struct k_event *event, uint32_t events,
2964 bool reset, k_timeout_t timeout);
2965
2985__syscall uint32_t k_event_wait_all_safe(struct k_event *event, uint32_t events,
2986 bool reset, k_timeout_t timeout);
2987
2998static inline uint32_t k_event_test(struct k_event *event, uint32_t events_mask)
2999{
3000 return k_event_wait(event, events_mask, false, K_NO_WAIT);
3001}
3002
3012#define K_EVENT_DEFINE(name) \
3013 STRUCT_SECTION_ITERABLE(k_event, name) = \
3014 Z_EVENT_INITIALIZER(name);
3015
3017
3023struct k_fifo {
3027 struct k_queue _queue;
3028#ifdef CONFIG_OBJ_CORE_FIFO
3029 struct k_obj_core obj_core;
3030#endif
3034};
3035
3039#define Z_FIFO_INITIALIZER(obj) \
3040 { \
3041 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
3042 }
3046
3052
3060#define k_fifo_init(fifo) \
3061 ({ \
3062 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, init, fifo); \
3063 k_queue_init(&(fifo)->_queue); \
3064 K_OBJ_CORE_INIT(K_OBJ_CORE(fifo), _obj_type_fifo); \
3065 K_OBJ_CORE_LINK(K_OBJ_CORE(fifo)); \
3066 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, init, fifo); \
3067 })
3068
3080#define k_fifo_cancel_wait(fifo) \
3081 ({ \
3082 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, cancel_wait, fifo); \
3083 k_queue_cancel_wait(&(fifo)->_queue); \
3084 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, cancel_wait, fifo); \
3085 })
3086
3099#define k_fifo_put(fifo, data) \
3100 ({ \
3101 void *_data = data; \
3102 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put, fifo, _data); \
3103 k_queue_append(&(fifo)->_queue, _data); \
3104 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put, fifo, _data); \
3105 })
3106
3123#define k_fifo_alloc_put(fifo, data) \
3124 ({ \
3125 void *_data = data; \
3126 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, alloc_put, fifo, _data); \
3127 int fap_ret = k_queue_alloc_append(&(fifo)->_queue, _data); \
3128 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, alloc_put, fifo, _data, fap_ret); \
3129 fap_ret; \
3130 })
3131
3149#define k_fifo_put_list(fifo, head, tail) \
3150 ({ \
3151 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_list, fifo, head, tail); \
3152 k_queue_append_list(&(fifo)->_queue, head, tail); \
3153 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_list, fifo, head, tail); \
3154 })
3155
3172#define k_fifo_put_slist(fifo, list) \
3173 ({ \
3174 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, put_slist, fifo, list); \
3175 k_queue_merge_slist(&(fifo)->_queue, list); \
3176 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, put_slist, fifo, list); \
3177 })
3178
3196#define k_fifo_get(fifo, timeout) \
3197 ({ \
3198 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, get, fifo, timeout); \
3199 void *fg_ret = k_queue_get(&(fifo)->_queue, timeout); \
3200 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, get, fifo, timeout, fg_ret); \
3201 fg_ret; \
3202 })
3203
3217#define k_fifo_is_empty(fifo) \
3218 k_queue_is_empty(&(fifo)->_queue)
3219
3233#define k_fifo_peek_head(fifo) \
3234 ({ \
3235 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_head, fifo); \
3236 void *fph_ret = k_queue_peek_head(&(fifo)->_queue); \
3237 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_head, fifo, fph_ret); \
3238 fph_ret; \
3239 })
3240
3252#define k_fifo_peek_tail(fifo) \
3253 ({ \
3254 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_fifo, peek_tail, fifo); \
3255 void *fpt_ret = k_queue_peek_tail(&(fifo)->_queue); \
3256 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_fifo, peek_tail, fifo, fpt_ret); \
3257 fpt_ret; \
3258 })
3259
3269#define K_FIFO_DEFINE(name) \
3270 STRUCT_SECTION_ITERABLE(k_fifo, name) = \
3271 Z_FIFO_INITIALIZER(name)
3272
3274
3280struct k_lifo {
3284 struct k_queue _queue;
3285#ifdef CONFIG_OBJ_CORE_LIFO
3286 struct k_obj_core obj_core;
3287#endif
3291};
3292
3296#define Z_LIFO_INITIALIZER(obj) \
3297 { \
3298 ._queue = Z_QUEUE_INITIALIZER(obj._queue) \
3299 }
3303
3309
3317#define k_lifo_init(lifo) \
3318 ({ \
3319 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, init, lifo); \
3320 k_queue_init(&(lifo)->_queue); \
3321 K_OBJ_CORE_INIT(K_OBJ_CORE(lifo), _obj_type_lifo); \
3322 K_OBJ_CORE_LINK(K_OBJ_CORE(lifo)); \
3323 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, init, lifo); \
3324 })
3325
3338#define k_lifo_put(lifo, data) \
3339 ({ \
3340 void *_data = data; \
3341 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, put, lifo, _data); \
3342 k_queue_prepend(&(lifo)->_queue, _data); \
3343 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, put, lifo, _data); \
3344 })
3345
3362#define k_lifo_alloc_put(lifo, data) \
3363 ({ \
3364 void *_data = data; \
3365 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, alloc_put, lifo, _data); \
3366 int lap_ret = k_queue_alloc_prepend(&(lifo)->_queue, _data); \
3367 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, alloc_put, lifo, _data, lap_ret); \
3368 lap_ret; \
3369 })
3370
3388#define k_lifo_get(lifo, timeout) \
3389 ({ \
3390 SYS_PORT_TRACING_OBJ_FUNC_ENTER(k_lifo, get, lifo, timeout); \
3391 void *lg_ret = k_queue_get(&(lifo)->_queue, timeout); \
3392 SYS_PORT_TRACING_OBJ_FUNC_EXIT(k_lifo, get, lifo, timeout, lg_ret); \
3393 lg_ret; \
3394 })
3395
3405#define K_LIFO_DEFINE(name) \
3406 STRUCT_SECTION_ITERABLE(k_lifo, name) = \
3407 Z_LIFO_INITIALIZER(name)
3408
3410
3414#define K_STACK_FLAG_ALLOC ((uint8_t)1) /* Buffer was allocated */
3415
3416typedef uintptr_t stack_data_t;
3417
3418struct k_stack {
3419 _wait_q_t wait_q;
3420 struct k_spinlock lock;
3421 stack_data_t *base, *next, *top;
3422
3423 uint8_t flags;
3424
3426
3427#ifdef CONFIG_OBJ_CORE_STACK
3428 struct k_obj_core obj_core;
3429#endif
3430};
3431
3432#define Z_STACK_INITIALIZER(obj, stack_buffer, stack_num_entries) \
3433 { \
3434 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3435 .base = (stack_buffer), \
3436 .next = (stack_buffer), \
3437 .top = (stack_buffer) + (stack_num_entries), \
3438 }
3442
3448
3458void k_stack_init(struct k_stack *stack,
3459 stack_data_t *buffer, uint32_t num_entries);
3460
3461
3476
3477__syscall int32_t k_stack_alloc_init(struct k_stack *stack,
3478 uint32_t num_entries);
3479
3491int k_stack_cleanup(struct k_stack *stack);
3492
3506__syscall int k_stack_push(struct k_stack *stack, stack_data_t data);
3507
3528__syscall int k_stack_pop(struct k_stack *stack, stack_data_t *data,
3529 k_timeout_t timeout);
3530
3541#define K_STACK_DEFINE(name, stack_num_entries) \
3542 stack_data_t __noinit \
3543 _k_stack_buf_##name[stack_num_entries]; \
3544 STRUCT_SECTION_ITERABLE(k_stack, name) = \
3545 Z_STACK_INITIALIZER(name, _k_stack_buf_##name, \
3546 stack_num_entries)
3547
3549
3553struct k_work;
3554struct k_work_q;
3555struct k_work_queue_config;
3556extern struct k_work_q k_sys_work_q;
3560
3566
3572struct k_mutex {
3577 _wait_q_t wait_q;
3579 struct k_thread *owner;
3580
3582 uint32_t lock_count;
3583
3585 int owner_orig_prio;
3586
3588
3589#ifdef CONFIG_OBJ_CORE_MUTEX
3590 struct k_obj_core obj_core;
3591#endif
3595};
3596
3600#define Z_MUTEX_INITIALIZER(obj) \
3601 { \
3602 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3603 .owner = NULL, \
3604 .lock_count = 0, \
3605 .owner_orig_prio = K_LOWEST_APPLICATION_THREAD_PRIO, \
3606 }
3610
3620#define K_MUTEX_DEFINE(name) \
3621 STRUCT_SECTION_ITERABLE(k_mutex, name) = \
3622 Z_MUTEX_INITIALIZER(name)
3623
3636__syscall int k_mutex_init(struct k_mutex *mutex);
3637
3638
3660__syscall int k_mutex_lock(struct k_mutex *mutex, k_timeout_t timeout);
3661
3682__syscall int k_mutex_unlock(struct k_mutex *mutex);
3683
3687
3697 _wait_q_t wait_q;
3698
3699#ifdef CONFIG_OBJ_CORE_CONDVAR
3700 struct k_obj_core obj_core;
3701#endif
3705};
3706
3710#define Z_CONDVAR_INITIALIZER(obj) \
3711 { \
3712 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
3713 }
3717
3723
3730__syscall int k_condvar_init(struct k_condvar *condvar);
3731
3738__syscall int k_condvar_signal(struct k_condvar *condvar);
3739
3747__syscall int k_condvar_broadcast(struct k_condvar *condvar);
3748
3766__syscall int k_condvar_wait(struct k_condvar *condvar, struct k_mutex *mutex,
3767 k_timeout_t timeout);
3768
3779#define K_CONDVAR_DEFINE(name) \
3780 STRUCT_SECTION_ITERABLE(k_condvar, name) = \
3781 Z_CONDVAR_INITIALIZER(name)
3782
3785
3791
3798struct k_sem {
3802 _wait_q_t wait_q;
3803 unsigned int count;
3804 unsigned int limit;
3805
3806 Z_DECL_POLL_EVENT
3807
3809
3810#ifdef CONFIG_OBJ_CORE_SEM
3811 struct k_obj_core obj_core;
3812#endif
3816};
3817
3821#define Z_SEM_INITIALIZER(obj, initial_count, count_limit) \
3822 { \
3823 .wait_q = Z_WAIT_Q_INIT(&(obj).wait_q), \
3824 .count = (initial_count), \
3825 .limit = (count_limit), \
3826 Z_POLL_EVENT_OBJ_INIT(obj) \
3827 }
3831
3840#define K_SEM_MAX_LIMIT UINT_MAX
3841
3857__syscall int k_sem_init(struct k_sem *sem, unsigned int initial_count,
3858 unsigned int limit);
3859
3878__syscall int k_sem_take(struct k_sem *sem, k_timeout_t timeout);
3879
3890__syscall void k_sem_give(struct k_sem *sem);
3891
3901__syscall void k_sem_reset(struct k_sem *sem);
3902
3912__syscall unsigned int k_sem_count_get(struct k_sem *sem);
3913
3917static inline unsigned int z_impl_k_sem_count_get(struct k_sem *sem)
3918{
3919 return sem->count;
3920}
3921
3933#define K_SEM_DEFINE(name, initial_count, count_limit) \
3934 STRUCT_SECTION_ITERABLE(k_sem, name) = \
3935 Z_SEM_INITIALIZER(name, initial_count, count_limit); \
3936 BUILD_ASSERT(((count_limit) != 0) && \
3937 (((initial_count) < (count_limit)) || ((initial_count) == (count_limit))) && \
3938 ((count_limit) <= K_SEM_MAX_LIMIT));
3939
3941
3942#if defined(CONFIG_SCHED_IPI_SUPPORTED) || defined(__DOXYGEN__)
3943struct k_ipi_work;
3944
3945
3953typedef void (*k_ipi_func_t)(struct k_ipi_work *work);
3954
3965 sys_dnode_t node[CONFIG_MP_MAX_NUM_CPUS]; /* Node in IPI work queue */
3966 k_ipi_func_t func; /* Function to execute on target CPU */
3967 struct k_event event; /* Event to signal when processed */
3968 uint32_t bitmask; /* Bitmask of targeted CPUs */
3972};
3973
3974
3982static inline void k_ipi_work_init(struct k_ipi_work *work)
3983{
3984 k_event_init(&work->event);
3985 for (unsigned int i = 0; i < CONFIG_MP_MAX_NUM_CPUS; i++) {
3986 sys_dnode_init(&work->node[i]);
3987 }
3988 work->bitmask = 0;
3989}
3990
4009int k_ipi_work_add(struct k_ipi_work *work, uint32_t cpu_bitmask,
4010 k_ipi_func_t func);
4011
4034int k_ipi_work_wait(struct k_ipi_work *work, k_timeout_t timeout);
4035
4045
4046#endif /* CONFIG_SCHED_IPI_SUPPORTED */
4047
4051struct k_work_delayable;
4052struct k_work_sync;
4056
4062
4069typedef void (*k_work_handler_t)(struct k_work *work);
4070
4084void k_work_init(struct k_work *work,
4085 k_work_handler_t handler);
4086
4101int k_work_busy_get(const struct k_work *work);
4102
4116static inline bool k_work_is_pending(const struct k_work *work);
4117
4139 struct k_work *work);
4140
4149int k_work_submit(struct k_work *work);
4150
4175bool k_work_flush(struct k_work *work,
4176 struct k_work_sync *sync);
4177
4197int k_work_cancel(struct k_work *work);
4198
4229bool k_work_cancel_sync(struct k_work *work, struct k_work_sync *sync);
4230
4240void k_work_queue_init(struct k_work_q *queue);
4241
4261void k_work_queue_start(struct k_work_q *queue,
4262 k_thread_stack_t *stack, size_t stack_size,
4263 int prio, const struct k_work_queue_config *cfg);
4264
4275void k_work_queue_run(struct k_work_q *queue, const struct k_work_queue_config *cfg);
4276
4286static inline k_tid_t k_work_queue_thread_get(struct k_work_q *queue);
4287
4311int k_work_queue_drain(struct k_work_q *queue, bool plug);
4312
4327
4347int k_work_queue_stop(struct k_work_q *queue, k_timeout_t timeout);
4348
4363 k_work_handler_t handler);
4364
4376static inline struct k_work_delayable *
4378
4393
4408static inline bool k_work_delayable_is_pending(
4409 const struct k_work_delayable *dwork);
4410
4425 const struct k_work_delayable *dwork);
4426
4441 const struct k_work_delayable *dwork);
4442
4471 struct k_work_delayable *dwork,
4472 k_timeout_t delay);
4473
4488 k_timeout_t delay);
4489
4526 struct k_work_delayable *dwork,
4527 k_timeout_t delay);
4528
4542 k_timeout_t delay);
4543
4569 struct k_work_sync *sync);
4570
4592
4622 struct k_work_sync *sync);
4623
4625enum {
4629 /* The atomic API is used for all work and queue flags fields to
4630 * enforce sequential consistency in SMP environments.
4631 */
4632
4633 /* Bits that represent the work item states. At least nine of the
4634 * combinations are distinct valid stable states.
4635 */
4636 K_WORK_RUNNING_BIT = 0,
4637 K_WORK_CANCELING_BIT = 1,
4638 K_WORK_QUEUED_BIT = 2,
4639 K_WORK_DELAYED_BIT = 3,
4640 K_WORK_FLUSHING_BIT = 4,
4641
4642 K_WORK_MASK = BIT(K_WORK_DELAYED_BIT) | BIT(K_WORK_QUEUED_BIT)
4643 | BIT(K_WORK_RUNNING_BIT) | BIT(K_WORK_CANCELING_BIT) | BIT(K_WORK_FLUSHING_BIT),
4644
4645 /* Static work flags */
4646 K_WORK_DELAYABLE_BIT = 8,
4647 K_WORK_DELAYABLE = BIT(K_WORK_DELAYABLE_BIT),
4648
4649 /* Dynamic work queue flags */
4650 K_WORK_QUEUE_STARTED_BIT = 0,
4651 K_WORK_QUEUE_STARTED = BIT(K_WORK_QUEUE_STARTED_BIT),
4652 K_WORK_QUEUE_BUSY_BIT = 1,
4653 K_WORK_QUEUE_BUSY = BIT(K_WORK_QUEUE_BUSY_BIT),
4654 K_WORK_QUEUE_DRAIN_BIT = 2,
4655 K_WORK_QUEUE_DRAIN = BIT(K_WORK_QUEUE_DRAIN_BIT),
4656 K_WORK_QUEUE_PLUGGED_BIT = 3,
4657 K_WORK_QUEUE_PLUGGED = BIT(K_WORK_QUEUE_PLUGGED_BIT),
4658 K_WORK_QUEUE_STOP_BIT = 4,
4659 K_WORK_QUEUE_STOP = BIT(K_WORK_QUEUE_STOP_BIT),
4660
4661 /* Static work queue flags */
4662 K_WORK_QUEUE_NO_YIELD_BIT = 8,
4663 K_WORK_QUEUE_NO_YIELD = BIT(K_WORK_QUEUE_NO_YIELD_BIT),
4667 /* Transient work flags */
4668
4674 K_WORK_RUNNING = BIT(K_WORK_RUNNING_BIT),
4675
4680 K_WORK_CANCELING = BIT(K_WORK_CANCELING_BIT),
4681
4687 K_WORK_QUEUED = BIT(K_WORK_QUEUED_BIT),
4688
4694 K_WORK_DELAYED = BIT(K_WORK_DELAYED_BIT),
4695
4700 K_WORK_FLUSHING = BIT(K_WORK_FLUSHING_BIT),
4701};
4702
4708struct k_work {
4712 /* All fields are protected by the work module spinlock. */
4713
4714 /* Node to link into k_work_q pending list. */
4715 sys_snode_t node;
4716
4717 /* The function to be invoked by the work queue thread. */
4718 k_work_handler_t handler;
4719
4720 /* The queue on which the work item was last submitted. */
4721 struct k_work_q *queue;
4722
4723 /* State of the work item.
4724 *
4725 * The item can be DELAYED, QUEUED, and RUNNING simultaneously.
4726 *
4727 * It can be RUNNING and CANCELING simultaneously.
4728 */
4733};
4734
4738#define Z_WORK_INITIALIZER(work_handler) { \
4739 .handler = (work_handler), \
4740}
4744
4754 /* The work item. */
4755 struct k_work work;
4756
4757 /* Timeout used to submit work after a delay. */
4758 struct _timeout timeout;
4759
4760 /* The queue to which the work should be submitted. */
4761 struct k_work_q *queue;
4765};
4766
4770#define Z_WORK_DELAYABLE_INITIALIZER(work_handler) { \
4771 .work = { \
4772 .handler = (work_handler), \
4773 .flags = K_WORK_DELAYABLE, \
4774 }, \
4775}
4779
4796#define K_WORK_DELAYABLE_DEFINE(work, work_handler) \
4797 struct k_work_delayable work \
4798 = Z_WORK_DELAYABLE_INITIALIZER(work_handler)
4799
4803/* Record used to wait for work to flush.
4804 *
4805 * The work item is inserted into the queue that will process (or is
4806 * processing) the item, and will be processed as soon as the item
4807 * completes. When the flusher is processed the semaphore will be
4808 * signaled, releasing the thread waiting for the flush.
4809 */
4810struct z_work_flusher {
4811 struct k_work work;
4812 struct k_sem sem;
4813};
4814
4815/* Record used to wait for work to complete a cancellation.
4816 *
4817 * The work item is inserted into a global queue of pending cancels.
4818 * When a cancelling work item goes idle any matching waiters are
4819 * removed from pending_cancels and are woken.
4820 */
4821struct z_work_canceller {
4822 sys_snode_t node;
4823 struct k_work *work;
4824 struct k_sem sem;
4825};
4829
4849 union {
4850 struct z_work_flusher flusher;
4851 struct z_work_canceller canceller;
4852 };
4856};
4857
4869 const char *name;
4870
4884
4889
4899};
4900
4906struct k_work_q {
4910 /* The thread that animates the work. */
4911 __deprecated struct k_thread thread;
4912
4913 /* The thread ID that animates the work. This may be an external thread
4914 * if k_work_queue_run() is used.
4915 */
4916 k_tid_t thread_id;
4917
4918 /* All the following fields must be accessed only while the
4919 * work module spinlock is held.
4920 */
4921
4922 /* List of k_work items to be worked. */
4923 sys_slist_t pending;
4924
4925 /* Wait queue for idle work thread. */
4926 _wait_q_t notifyq;
4927
4928 /* Wait queue for threads waiting for the queue to drain. */
4929 _wait_q_t drainq;
4930
4931 /* Flags describing queue state. */
4933
4934#if defined(CONFIG_WORKQUEUE_WORK_TIMEOUT)
4935 struct _timeout work_timeout_record;
4936 struct k_work *work;
4937 k_timeout_t work_timeout;
4938 bool finished;
4939#endif /* defined(CONFIG_WORKQUEUE_WORK_TIMEOUT) */
4943};
4944
4945/* Provide the implementation for inline functions declared above */
4946
4947static inline bool k_work_is_pending(const struct k_work *work)
4948{
4949 return k_work_busy_get(work) != 0;
4950}
4951
4952static inline struct k_work_delayable *
4954{
4955 return CONTAINER_OF(work, struct k_work_delayable, work);
4956}
4957
4959 const struct k_work_delayable *dwork)
4960{
4961 return k_work_delayable_busy_get(dwork) != 0;
4962}
4963
4965 const struct k_work_delayable *dwork)
4966{
4967 return z_timeout_expires(&dwork->timeout);
4968}
4969
4971 const struct k_work_delayable *dwork)
4972{
4973 return z_timeout_remaining(&dwork->timeout);
4974}
4975
4976static inline k_tid_t k_work_queue_thread_get(struct k_work_q *queue)
4977{
4978 return queue->thread_id;
4979}
4980
4982
4983struct k_work_user;
4984
4989
4999typedef void (*k_work_user_handler_t)(struct k_work_user *work);
5000
5004struct k_work_user_q {
5005 struct k_queue queue;
5006 struct k_thread thread;
5007};
5008
5009enum {
5010 K_WORK_USER_STATE_PENDING, /* Work item pending state */
5011};
5012
5013struct k_work_user {
5014 void *_reserved; /* Used by k_queue implementation. */
5015 k_work_user_handler_t handler;
5017};
5018
5019#if defined(__cplusplus) && ((__cplusplus - 0) < 202002L)
5020#define Z_WORK_USER_INITIALIZER(work_handler) { NULL, work_handler, 0 }
5021#else
5022#define Z_WORK_USER_INITIALIZER(work_handler) \
5023 { \
5024 ._reserved = NULL, \
5025 .handler = (work_handler), \
5026 .flags = 0 \
5027 }
5028#endif
5032
5044#define K_WORK_USER_DEFINE(work, work_handler) \
5045 struct k_work_user work = Z_WORK_USER_INITIALIZER(work_handler)
5046
5056static inline void k_work_user_init(struct k_work_user *work,
5057 k_work_user_handler_t handler)
5058{
5059 *work = (struct k_work_user)Z_WORK_USER_INITIALIZER(handler);
5060}
5061
5078static inline bool k_work_user_is_pending(struct k_work_user *work)
5079{
5080 return atomic_test_bit(&work->flags, K_WORK_USER_STATE_PENDING);
5081}
5082
5101static inline int k_work_user_submit_to_queue(struct k_work_user_q *work_q,
5102 struct k_work_user *work)
5103{
5104 int ret = -EBUSY;
5105
5106 if (!atomic_test_and_set_bit(&work->flags,
5107 K_WORK_USER_STATE_PENDING)) {
5108 ret = k_queue_alloc_append(&work_q->queue, work);
5109
5110 /* Couldn't insert into the queue. Clear the pending bit
5111 * so the work item can be submitted again
5112 */
5113 if (ret != 0) {
5114 atomic_clear_bit(&work->flags,
5115 K_WORK_USER_STATE_PENDING);
5116 }
5117 }
5118
5119 return ret;
5120}
5121
5141void k_work_user_queue_start(struct k_work_user_q *work_q,
5142 k_thread_stack_t *stack,
5143 size_t stack_size, int prio,
5144 const char *name);
5145
5156static inline k_tid_t k_work_user_queue_thread_get(struct k_work_user_q *work_q)
5157{
5158 return &work_q->thread;
5159}
5160
5162
5166struct k_work_poll {
5167 struct k_work work;
5168 struct k_work_q *workq;
5169 struct z_poller poller;
5170 struct k_poll_event *events;
5171 int num_events;
5172 k_work_handler_t real_handler;
5173 struct _timeout timeout;
5174 int poll_result;
5175};
5179
5184
5196#define K_WORK_DEFINE(work, work_handler) \
5197 struct k_work work = Z_WORK_INITIALIZER(work_handler)
5198
5208void k_work_poll_init(struct k_work_poll *work,
5209 k_work_handler_t handler);
5210
5246 struct k_work_poll *work,
5247 struct k_poll_event *events,
5248 int num_events,
5249 k_timeout_t timeout);
5250
5282int k_work_poll_submit(struct k_work_poll *work,
5283 struct k_poll_event *events,
5284 int num_events,
5285 k_timeout_t timeout);
5286
5301int k_work_poll_cancel(struct k_work_poll *work);
5302
5304
5310
5316struct k_msgq {
5321 _wait_q_t wait_q;
5323 struct k_spinlock lock;
5325 size_t msg_size;
5327 uint32_t max_msgs;
5329 char *buffer_start;
5331 char *buffer_end;
5333 char *read_ptr;
5335 char *write_ptr;
5337 uint32_t used_msgs;
5338
5339 Z_DECL_POLL_EVENT
5340
5342 uint8_t flags;
5343
5345
5346#ifdef CONFIG_OBJ_CORE_MSGQ
5347 struct k_obj_core obj_core;
5348#endif
5352};
5353
5357#define Z_MSGQ_INITIALIZER(obj, q_buffer, q_msg_size, q_max_msgs) \
5358 { \
5359 .wait_q = Z_WAIT_Q_INIT(&obj.wait_q), \
5360 .lock = {}, \
5361 .msg_size = q_msg_size, \
5362 .max_msgs = q_max_msgs, \
5363 .buffer_start = q_buffer, \
5364 .buffer_end = q_buffer + (q_max_msgs * q_msg_size), \
5365 .read_ptr = q_buffer, \
5366 .write_ptr = q_buffer, \
5367 .used_msgs = 0, \
5368 Z_POLL_EVENT_OBJ_INIT(obj) \
5369 .flags = 0, \
5370 }
5371
5372#define K_MSGQ_FLAG_ALLOC BIT(0)
5376
5388
5389
5408#define K_MSGQ_DEFINE(q_name, q_msg_size, q_max_msgs, q_align) \
5409 static char __noinit __aligned(q_align) \
5410 _k_fifo_buf_##q_name[(q_max_msgs) * (q_msg_size)]; \
5411 STRUCT_SECTION_ITERABLE(k_msgq, q_name) = \
5412 Z_MSGQ_INITIALIZER(q_name, _k_fifo_buf_##q_name, \
5413 (q_msg_size), (q_max_msgs))
5414
5429void k_msgq_init(struct k_msgq *msgq, char *buffer, size_t msg_size,
5430 uint32_t max_msgs);
5431
5451__syscall int k_msgq_alloc_init(struct k_msgq *msgq, size_t msg_size,
5452 uint32_t max_msgs);
5453
5467int k_msgq_cleanup(struct k_msgq *msgq);
5468
5489__syscall int k_msgq_put(struct k_msgq *msgq, const void *data, k_timeout_t timeout);
5490
5515__syscall int k_msgq_put_front(struct k_msgq *msgq, const void *data);
5516
5537__syscall int k_msgq_get(struct k_msgq *msgq, void *data, k_timeout_t timeout);
5538
5553__syscall int k_msgq_peek(struct k_msgq *msgq, void *data);
5554
5571__syscall int k_msgq_peek_at(struct k_msgq *msgq, void *data, uint32_t idx);
5572
5582__syscall void k_msgq_purge(struct k_msgq *msgq);
5583
5594__syscall uint32_t k_msgq_num_free_get(struct k_msgq *msgq);
5595
5604__syscall void k_msgq_get_attrs(struct k_msgq *msgq,
5605 struct k_msgq_attrs *attrs);
5606
5607
5608static inline uint32_t z_impl_k_msgq_num_free_get(struct k_msgq *msgq)
5609{
5610 return msgq->max_msgs - msgq->used_msgs;
5611}
5612
5622__syscall uint32_t k_msgq_num_used_get(struct k_msgq *msgq);
5623
5624static inline uint32_t z_impl_k_msgq_num_used_get(struct k_msgq *msgq)
5625{
5626 return msgq->used_msgs;
5627}
5628
5630
5636
5643 size_t size;
5647 void *tx_data;
5656 k_tid_t _syncing_thread;
5657#if (CONFIG_NUM_MBOX_ASYNC_MSGS > 0)
5659 struct k_sem *_async_sem;
5660#endif
5664};
5665
5670struct k_mbox {
5675 _wait_q_t tx_msg_queue;
5677 _wait_q_t rx_msg_queue;
5678 struct k_spinlock lock;
5679
5681
5682#ifdef CONFIG_OBJ_CORE_MAILBOX
5683 struct k_obj_core obj_core;
5684#endif
5688};
5689
5693#define Z_MBOX_INITIALIZER(obj) \
5694 { \
5695 .tx_msg_queue = Z_WAIT_Q_INIT(&obj.tx_msg_queue), \
5696 .rx_msg_queue = Z_WAIT_Q_INIT(&obj.rx_msg_queue), \
5697 }
5701
5711#define K_MBOX_DEFINE(name) \
5712 STRUCT_SECTION_ITERABLE(k_mbox, name) = \
5713 Z_MBOX_INITIALIZER(name) \
5714
5715
5722void k_mbox_init(struct k_mbox *mbox);
5723
5743int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
5744 k_timeout_t timeout);
5745
5759void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg,
5760 struct k_sem *sem);
5761
5779int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *rx_msg,
5780 void *buffer, k_timeout_t timeout);
5781
5795void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer);
5796
5798
5804
5814__syscall void k_pipe_init(struct k_pipe *pipe, uint8_t *buffer, size_t buffer_size);
5815
5819enum pipe_flags {
5820 PIPE_FLAG_OPEN = BIT(0),
5821 PIPE_FLAG_RESET = BIT(1),
5822};
5826
5832struct k_pipe {
5836 size_t waiting;
5837 struct ring_buf buf;
5838 struct k_spinlock lock;
5839 _wait_q_t data;
5840 _wait_q_t space;
5841 uint8_t flags;
5842
5843 Z_DECL_POLL_EVENT
5844#ifdef CONFIG_OBJ_CORE_PIPE
5845 struct k_obj_core obj_core;
5846#endif
5851};
5852
5856#define Z_PIPE_INITIALIZER(obj, pipe_buffer, pipe_buffer_size) \
5857{ \
5858 .waiting = 0, \
5859 .buf = RING_BUF_INIT(pipe_buffer, pipe_buffer_size), \
5860 .data = Z_WAIT_Q_INIT(&obj.data), \
5861 .space = Z_WAIT_Q_INIT(&obj.space), \
5862 .flags = PIPE_FLAG_OPEN, \
5863 Z_POLL_EVENT_OBJ_INIT(obj) \
5864}
5868
5882#define K_PIPE_DEFINE(name, pipe_buffer_size, pipe_align) \
5883 static unsigned char __noinit __aligned(pipe_align) \
5884 _k_pipe_buf_##name[pipe_buffer_size]; \
5885 STRUCT_SECTION_ITERABLE(k_pipe, name) = \
5886 Z_PIPE_INITIALIZER(name, _k_pipe_buf_##name, pipe_buffer_size)
5887
5888
5905__syscall int k_pipe_write(struct k_pipe *pipe, const uint8_t *data, size_t len,
5906 k_timeout_t timeout);
5907
5923__syscall int k_pipe_read(struct k_pipe *pipe, uint8_t *data, size_t len,
5924 k_timeout_t timeout);
5925
5935__syscall void k_pipe_reset(struct k_pipe *pipe);
5936
5945__syscall void k_pipe_close(struct k_pipe *pipe);
5947
5951struct k_mem_slab_info {
5952 uint32_t num_blocks;
5953 size_t block_size;
5954 uint32_t num_used;
5955#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
5956 uint32_t max_used;
5957#endif
5958};
5959
5960struct k_mem_slab {
5961 _wait_q_t wait_q;
5962 struct k_spinlock lock;
5963 char *buffer;
5964 char *free_list;
5965 struct k_mem_slab_info info;
5966
5968
5969#ifdef CONFIG_OBJ_CORE_MEM_SLAB
5970 struct k_obj_core obj_core;
5971#endif
5972};
5973
5974#define Z_MEM_SLAB_INITIALIZER(_slab, _slab_buffer, _slab_block_size, \
5975 _slab_num_blocks) \
5976 { \
5977 .wait_q = Z_WAIT_Q_INIT(&(_slab).wait_q), \
5978 .lock = {}, \
5979 .buffer = _slab_buffer, \
5980 .free_list = NULL, \
5981 .info = {_slab_num_blocks, _slab_block_size, 0} \
5982 }
5986
5992
6018#define K_MEM_SLAB_DEFINE_IN_SECT(name, in_section, slab_block_size, slab_num_blocks, slab_align) \
6019 BUILD_ASSERT(((slab_block_size) % (slab_align)) == 0, \
6020 "slab_block_size must be a multiple of slab_align"); \
6021 BUILD_ASSERT((((slab_align) & ((slab_align) - 1)) == 0), \
6022 "slab_align must be a power of 2"); \
6023 char in_section __aligned(WB_UP( \
6024 slab_align)) _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
6025 STRUCT_SECTION_ITERABLE(k_mem_slab, name) = Z_MEM_SLAB_INITIALIZER( \
6026 name, _k_mem_slab_buf_##name, WB_UP(slab_block_size), slab_num_blocks)
6027
6051#define K_MEM_SLAB_DEFINE(name, slab_block_size, slab_num_blocks, slab_align) \
6052 K_MEM_SLAB_DEFINE_IN_SECT(name, __noinit_named(k_mem_slab_buf_##name), slab_block_size, \
6053 slab_num_blocks, slab_align)
6054
6076#define K_MEM_SLAB_DEFINE_TYPE(name, type, slab_num_blocks) \
6077 K_MEM_SLAB_DEFINE(name, sizeof(type), slab_num_blocks, __alignof(type))
6078
6095#define K_MEM_SLAB_DEFINE_IN_SECT_STATIC(name, in_section, slab_block_size, slab_num_blocks, \
6096 slab_align) \
6097 BUILD_ASSERT(((slab_block_size) % (slab_align)) == 0, \
6098 "slab_block_size must be a multiple of slab_align"); \
6099 BUILD_ASSERT((((slab_align) & ((slab_align) - 1)) == 0), \
6100 "slab_align must be a power of 2"); \
6101 static char in_section __aligned(WB_UP( \
6102 slab_align)) _k_mem_slab_buf_##name[(slab_num_blocks) * WB_UP(slab_block_size)]; \
6103 static STRUCT_SECTION_ITERABLE(k_mem_slab, name) = Z_MEM_SLAB_INITIALIZER( \
6104 name, _k_mem_slab_buf_##name, WB_UP(slab_block_size), slab_num_blocks)
6105
6120#define K_MEM_SLAB_DEFINE_STATIC(name, slab_block_size, slab_num_blocks, slab_align) \
6121 K_MEM_SLAB_DEFINE_IN_SECT_STATIC(name, __noinit_named(k_mem_slab_buf_##name), \
6122 slab_block_size, slab_num_blocks, slab_align)
6123
6136#define K_MEM_SLAB_DEFINE_STATIC_TYPE(name, type, slab_num_blocks) \
6137 K_MEM_SLAB_DEFINE_STATIC(name, sizeof(type), slab_num_blocks, __alignof(type))
6138
6160int k_mem_slab_init(struct k_mem_slab *slab, void *buffer,
6161 size_t block_size, uint32_t num_blocks);
6162
6184int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem,
6185 k_timeout_t timeout);
6186
6198void k_mem_slab_free(struct k_mem_slab *slab, void *mem);
6199
6212static inline uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
6213{
6214 return slab->info.num_used;
6215}
6216
6229static inline uint32_t k_mem_slab_max_used_get(struct k_mem_slab *slab)
6230{
6231#ifdef CONFIG_MEM_SLAB_TRACE_MAX_UTILIZATION
6232 return slab->info.max_used;
6233#else
6234 ARG_UNUSED(slab);
6235 return 0;
6236#endif
6237}
6238
6251static inline uint32_t k_mem_slab_num_free_get(struct k_mem_slab *slab)
6252{
6253 return slab->info.num_blocks - slab->info.num_used;
6254}
6255
6269
6270int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stats *stats);
6271
6285int k_mem_slab_runtime_stats_reset_max(struct k_mem_slab *slab);
6286
6288
6293
6299struct k_heap {
6303 struct sys_heap heap;
6304 _wait_q_t wait_q;
6305 struct k_spinlock lock;
6309};
6310
6324void k_heap_init(struct k_heap *h, void *mem,
6325 size_t bytes) __attribute_nonnull(1);
6326
6348void *k_heap_aligned_alloc(struct k_heap *h, size_t align, size_t bytes,
6349 k_timeout_t timeout) __attribute_nonnull(1);
6350
6372void *k_heap_alloc(struct k_heap *h, size_t bytes,
6373 k_timeout_t timeout) __attribute_nonnull(1);
6374
6397void *k_heap_calloc(struct k_heap *h, size_t num, size_t size, k_timeout_t timeout)
6398 __attribute_nonnull(1);
6399
6423void *k_heap_realloc(struct k_heap *h, void *ptr, size_t bytes, k_timeout_t timeout)
6424 __attribute_nonnull(1);
6425
6436void k_heap_free(struct k_heap *h, void *mem) __attribute_nonnull(1);
6437
6438/*
6439 * Heap sizing constants computed at build time from actual struct layouts
6440 * in lib/heap/heap_constants.c via the gen_offset mechanism.
6441 */
6442#include <zephyr/heap_constants.h>
6443
6444/* chunk0 size in bytes for nb buckets (includes trailer metadata) */
6445#define _Z_HEAP_C0(nb) \
6446 (ROUND_UP(___z_heap_struct_SIZEOF + \
6447 (nb) * ___z_heap_bucket_SIZEOF, ___z_heap_chunk_unit_SIZEOF) + \
6448 ___z_heap_trailer_SIZEOF)
6449
6450/* Allocation chunk size in bytes (header + data rounded up, plus trailer) */
6451#define _Z_HEAP_AC(ab) \
6452 (ROUND_UP(___z_heap_hdr_SIZEOF + (ab), ___z_heap_chunk_unit_SIZEOF) + \
6453 ___z_heap_trailer_SIZEOF)
6454
6455/* Total heap size in chunk units */
6456#define _Z_HEAP_SZ(nb, ab) \
6457 ((_Z_HEAP_C0(nb) + _Z_HEAP_AC(ab)) / ___z_heap_chunk_unit_SIZEOF)
6458
6459/* Bucket count from heap size in chunk units (mirrors bucket_idx() + 1) */
6460#define _Z_HEAP_NB(sz) \
6461 (32 - __builtin_clz((unsigned int)((sz) - \
6462 ___z_heap_min_chunk_SIZEOF + 1)))
6463
6464/* 3-round convergent iteration starting from 1 bucket */
6465#define _Z_HEAP_NB1(ab) _Z_HEAP_NB(_Z_HEAP_SZ(1, ab))
6466#define _Z_HEAP_NB2(ab) _Z_HEAP_NB(_Z_HEAP_SZ(_Z_HEAP_NB1(ab), ab))
6467#define _Z_HEAP_NB3(ab) _Z_HEAP_NB(_Z_HEAP_SZ(_Z_HEAP_NB2(ab), ab))
6468
6482#define Z_HEAP_MIN_SIZE_FOR(alloc_bytes) \
6483 (_Z_HEAP_C0(_Z_HEAP_NB3(alloc_bytes)) + \
6484 _Z_HEAP_AC(alloc_bytes) + ___z_heap_ftr_SIZEOF)
6485
6486#define Z_HEAP_MIN_SIZE Z_HEAP_MIN_SIZE_FOR(1)
6487
6504#define Z_HEAP_DEFINE_IN_SECT(name, bytes, in_section) \
6505 char in_section \
6506 __aligned(8) /* CHUNK_UNIT */ \
6507 kheap_##name[MAX(bytes, Z_HEAP_MIN_SIZE)]; \
6508 STRUCT_SECTION_ITERABLE(k_heap, name) = { \
6509 .heap = { \
6510 .init_mem = kheap_##name, \
6511 .init_bytes = MAX(bytes, Z_HEAP_MIN_SIZE), \
6512 }, \
6513 }
6514
6529#define K_HEAP_DEFINE(name, bytes) \
6530 Z_HEAP_DEFINE_IN_SECT(name, bytes, \
6531 __noinit_named(kheap_buf_##name))
6532
6547#define K_HEAP_DEFINE_NOCACHE(name, bytes) \
6548 Z_HEAP_DEFINE_IN_SECT(name, bytes, __nocache)
6549
6559int k_heap_array_get(struct k_heap **heap);
6560
6564
6571
6590void *k_aligned_alloc(size_t align, size_t size);
6591
6603void *k_malloc(size_t size);
6604
6615void k_free(void *ptr);
6616
6628void *k_calloc(size_t nmemb, size_t size);
6629
6647void *k_realloc(void *ptr, size_t size);
6648
6650
6651/* polling API - PRIVATE */
6652
6653#ifdef CONFIG_POLL
6654#define _INIT_OBJ_POLL_EVENT(obj) do { (obj)->poll_event = NULL; } while (false)
6655#else
6656#define _INIT_OBJ_POLL_EVENT(obj) do { } while (false)
6657#endif
6658
6659/* private - types bit positions */
6660enum _poll_types_bits {
6661 /* can be used to ignore an event */
6662 _POLL_TYPE_IGNORE,
6663
6664 /* to be signaled by k_poll_signal_raise() */
6665 _POLL_TYPE_SIGNAL,
6666
6667 /* semaphore availability */
6668 _POLL_TYPE_SEM_AVAILABLE,
6669
6670 /* queue/FIFO/LIFO data availability */
6671 _POLL_TYPE_DATA_AVAILABLE,
6672
6673 /* msgq data availability */
6674 _POLL_TYPE_MSGQ_DATA_AVAILABLE,
6675
6676 /* pipe data availability */
6677 _POLL_TYPE_PIPE_DATA_AVAILABLE,
6678
6679 _POLL_NUM_TYPES
6680};
6681
6682#define Z_POLL_TYPE_BIT(type) (1U << ((type) - 1U))
6683
6684/* private - states bit positions */
6685enum _poll_states_bits {
6686 /* default state when creating event */
6687 _POLL_STATE_NOT_READY,
6688
6689 /* signaled by k_poll_signal_raise() */
6690 _POLL_STATE_SIGNALED,
6691
6692 /* semaphore is available */
6693 _POLL_STATE_SEM_AVAILABLE,
6694
6695 /* data is available to read on queue/FIFO/LIFO */
6696 _POLL_STATE_DATA_AVAILABLE,
6697
6698 /* queue/FIFO/LIFO wait was cancelled */
6699 _POLL_STATE_CANCELLED,
6700
6701 /* data is available to read on a message queue */
6702 _POLL_STATE_MSGQ_DATA_AVAILABLE,
6703
6704 /* data is available to read from a pipe */
6705 _POLL_STATE_PIPE_DATA_AVAILABLE,
6706
6707 _POLL_NUM_STATES
6708};
6709
6710#define Z_POLL_STATE_BIT(state) (1U << ((state) - 1U))
6711
6712#define _POLL_EVENT_NUM_UNUSED_BITS \
6713 (32 - (0 \
6714 + 8 /* tag */ \
6715 + _POLL_NUM_TYPES \
6716 + _POLL_NUM_STATES \
6717 + 1 /* modes */ \
6718 ))
6719
6720/* end of polling API - PRIVATE */
6721
6722
6730
6731/* Public polling API */
6732
6738
6740#define K_POLL_TYPE_IGNORE 0
6742#define K_POLL_TYPE_SIGNAL Z_POLL_TYPE_BIT(_POLL_TYPE_SIGNAL)
6744#define K_POLL_TYPE_SEM_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_SEM_AVAILABLE)
6746#define K_POLL_TYPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_DATA_AVAILABLE)
6748#define K_POLL_TYPE_FIFO_DATA_AVAILABLE K_POLL_TYPE_DATA_AVAILABLE
6750#define K_POLL_TYPE_MSGQ_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_MSGQ_DATA_AVAILABLE)
6752#define K_POLL_TYPE_PIPE_DATA_AVAILABLE Z_POLL_TYPE_BIT(_POLL_TYPE_PIPE_DATA_AVAILABLE)
6753
6755
6765
6771
6773#define K_POLL_STATE_NOT_READY 0
6775#define K_POLL_STATE_SIGNALED Z_POLL_STATE_BIT(_POLL_STATE_SIGNALED)
6777#define K_POLL_STATE_SEM_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_SEM_AVAILABLE)
6779#define K_POLL_STATE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_DATA_AVAILABLE)
6781#define K_POLL_STATE_FIFO_DATA_AVAILABLE K_POLL_STATE_DATA_AVAILABLE
6783#define K_POLL_STATE_MSGQ_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_MSGQ_DATA_AVAILABLE)
6785#define K_POLL_STATE_PIPE_DATA_AVAILABLE Z_POLL_STATE_BIT(_POLL_STATE_PIPE_DATA_AVAILABLE)
6787#define K_POLL_STATE_CANCELLED Z_POLL_STATE_BIT(_POLL_STATE_CANCELLED)
6788
6790
6803 sys_dlist_t poll_events;
6807
6812 unsigned int signaled;
6813
6816};
6817
6823#define K_POLL_SIGNAL_INITIALIZER(obj) \
6824 { \
6825 .poll_events = SYS_DLIST_STATIC_INIT(&obj.poll_events), \
6826 .signaled = 0, \
6827 .result = 0, \
6828 }
6829
6838 sys_dnode_t _node;
6839
6841 struct z_poller *poller;
6845
6848
6850 uint32_t type:_POLL_NUM_TYPES;
6851
6853 uint32_t state:_POLL_NUM_STATES;
6854
6857
6859 uint32_t unused:_POLL_EVENT_NUM_UNUSED_BITS;
6860
6862 union {
6863 /* The _typed_* aliases below are used by the K_POLL_EVENT_*INITIALIZER() macros to
6864 * ensure type safety of polled objects.
6865 */
6867 void *obj, *_typed_K_POLL_TYPE_IGNORE;
6869 struct k_poll_signal *signal, *_typed_K_POLL_TYPE_SIGNAL;
6871 struct k_sem *sem, *_typed_K_POLL_TYPE_SEM_AVAILABLE;
6873 struct k_fifo *fifo, *_typed_K_POLL_TYPE_FIFO_DATA_AVAILABLE;
6875 struct k_queue *queue, *_typed_K_POLL_TYPE_DATA_AVAILABLE;
6877 struct k_msgq *msgq, *_typed_K_POLL_TYPE_MSGQ_DATA_AVAILABLE;
6879 struct k_pipe *pipe, *_typed_K_POLL_TYPE_PIPE_DATA_AVAILABLE;
6880 };
6881};
6882
6891#define K_POLL_EVENT_INITIALIZER(_event_type, _event_mode, _event_obj) \
6892 { \
6893 .poller = NULL, \
6894 .type = _event_type, \
6895 .state = K_POLL_STATE_NOT_READY, \
6896 .mode = _event_mode, \
6897 .unused = 0, \
6898 { \
6899 ._typed_##_event_type = _event_obj, \
6900 }, \
6901 }
6902
6912#define K_POLL_EVENT_STATIC_INITIALIZER(_event_type, _event_mode, _event_obj, \
6913 event_tag) \
6914 { \
6915 .tag = event_tag, \
6916 .type = _event_type, \
6917 .state = K_POLL_STATE_NOT_READY, \
6918 .mode = _event_mode, \
6919 .unused = 0, \
6920 { \
6921 ._typed_##_event_type = _event_obj, \
6922 }, \
6923 }
6924
6939
6940void k_poll_event_init(struct k_poll_event *event, uint32_t type,
6941 int mode, void *obj);
6942
6985
6986__syscall int k_poll(struct k_poll_event *events, int num_events,
6987 k_timeout_t timeout);
6988
6996
6997__syscall void k_poll_signal_init(struct k_poll_signal *sig);
6998
7004__syscall void k_poll_signal_reset(struct k_poll_signal *sig);
7005
7016__syscall void k_poll_signal_check(struct k_poll_signal *sig,
7017 unsigned int *signaled, int *result);
7018
7041
7042__syscall int k_poll_signal_raise(struct k_poll_signal *sig, int result);
7043
7045
7064static inline void k_cpu_idle(void)
7065{
7066 arch_cpu_idle();
7067}
7068
7083static inline void k_cpu_atomic_idle(unsigned int key)
7084{
7086}
7087
7091
7096#ifdef ARCH_EXCEPT
7097/* This architecture has direct support for triggering a CPU exception */
7098#define z_except_reason(reason) ARCH_EXCEPT(reason)
7099#else
7100
7101#if !defined(CONFIG_ASSERT_NO_FILE_INFO)
7102#define __EXCEPT_LOC() __ASSERT_PRINT("@ %s:%d\n", __FILE__, __LINE__)
7103#else
7104#define __EXCEPT_LOC()
7105#endif
7106
7107/* NOTE: This is the implementation for arches that do not implement
7108 * ARCH_EXCEPT() to generate a real CPU exception.
7109 *
7110 * We won't have a real exception frame to determine the PC value when
7111 * the oops occurred, so print file and line number before we jump into
7112 * the fatal error handler.
7113 */
7114#define z_except_reason(reason) do { \
7115 __EXCEPT_LOC(); \
7116 z_fatal_error(reason, NULL); \
7117 } while (false)
7118
7119#endif /* _ARCH__EXCEPT */
7123
7135#define k_oops() z_except_reason(K_ERR_KERNEL_OOPS)
7136
7145#define k_panic() z_except_reason(K_ERR_KERNEL_PANIC)
7146
7150/*
7151 * private APIs that are utilized by one or more public APIs
7152 */
7153
7157void z_timer_expiration_handler(struct _timeout *timeout);
7161
7162#ifdef CONFIG_PRINTK
7170__syscall void k_str_out(char *c, size_t n);
7171#endif
7172
7178
7199__syscall int k_float_disable(struct k_thread *thread);
7200
7239__syscall int k_float_enable(struct k_thread *thread, unsigned int options);
7240
7244
7254
7262
7271
7282
7293
7303
7312
7321
7322#ifdef __cplusplus
7323}
7324#endif
7325
7326#include <zephyr/tracing/tracing.h>
7327#include <zephyr/syscalls/kernel.h>
7328
7329#endif /* !_ASMLANGUAGE */
7330
7331#endif /* ZEPHYR_INCLUDE_KERNEL_H_ */
static uint32_t arch_k_cycle_get_32(void)
Definition misc.h:26
static uint64_t arch_k_cycle_get_64(void)
Definition misc.h:33
void(* k_thread_entry_t)(void *p1, void *p2, void *p3)
Thread entry point function type.
Definition arch_interface.h:48
struct z_thread_stack_element k_thread_stack_t
Typedef of struct z_thread_stack_element.
Definition arch_interface.h:46
System error numbers.
void arch_cpu_atomic_idle(unsigned int key)
Atomically re-enable interrupts and enter low power mode.
void arch_cpu_idle(void)
Power save idle routine.
long atomic_t
Atomic integer variable.
Definition atomic_types.h:31
static bool atomic_test_bit(const atomic_t *target, int bit)
Atomically get and test a bit.
Definition atomic.h:135
static void atomic_clear_bit(atomic_t *target, int bit)
Atomically clear a bit.
Definition atomic.h:224
static bool atomic_test_and_set_bit(atomic_t *target, int bit)
Atomically set a bit and test it.
Definition atomic.h:178
static uint32_t k_cycle_get_32(void)
Read the hardware clock.
Definition kernel.h:2337
#define K_NO_WAIT
Generate null timeout delay.
Definition kernel.h:1651
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:2289
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:2318
static uint32_t k_uptime_seconds(void)
Get system uptime in seconds.
Definition kernel.h:2302
static uint64_t k_cycle_get_64(void)
Read the 64-bit hardware clock.
Definition kernel.h:2355
static int64_t k_uptime_get(void)
Get system uptime.
Definition kernel.h:2265
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:7064
static void k_cpu_atomic_idle(unsigned int key)
Make the CPU idle in an atomic fashion.
Definition kernel.h:7083
struct _dnode sys_dnode_t
Doubly-linked list node structure.
Definition dlist.h:57
struct _dnode sys_dlist_t
Doubly-linked list structure.
Definition dlist.h:53
static void sys_dnode_init(sys_dnode_t *node)
initialize node to its state when not in a list
Definition dlist.h:222
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:2998
uint32_t k_event_wait_safe(struct k_event *event, uint32_t events, bool reset, k_timeout_t timeout)
Wait for any of the specified events (safe version).
uint32_t k_event_set(struct k_event *event, uint32_t events)
Set the events in an event object.
uint32_t k_event_post(struct k_event *event, uint32_t events)
Post one or more events to an event object.
void k_event_init(struct k_event *event)
Initialize an event object.
uint32_t k_event_clear(struct k_event *event, uint32_t events)
Clear the events in an event object.
uint32_t k_event_wait_all(struct k_event *event, uint32_t events, bool reset, k_timeout_t timeout)
Wait for all of the specified events.
static bool sys_sflist_is_empty(const sys_sflist_t *list)
Test if the given list is empty.
Definition sflist.h:339
struct _sflist sys_sflist_t
Flagged single-linked list structure.
Definition sflist.h:57
int k_float_disable(struct k_thread *thread)
Disable preservation of floating point context information.
int k_float_enable(struct k_thread *thread, unsigned int options)
Enable preservation of floating point context information.
int k_futex_wait(struct k_futex *futex, int expected, k_timeout_t timeout)
Pend the current thread on a futex.
int k_futex_wake(struct k_futex *futex, bool wake_all)
Wake one/all threads pending on a futex.
void * k_heap_alloc(struct k_heap *h, size_t bytes, k_timeout_t timeout)
Allocate memory from a k_heap.
int k_heap_array_get(struct k_heap **heap)
Get the array of statically defined heaps.
void * k_heap_calloc(struct k_heap *h, size_t num, size_t size, k_timeout_t timeout)
Allocate and initialize memory for an array of objects from a k_heap.
void k_heap_free(struct k_heap *h, void *mem)
Free memory allocated by k_heap_alloc().
void k_free(void *ptr)
Free memory allocated from heap.
void * k_realloc(void *ptr, size_t size)
Expand the size of an existing allocation.
void k_heap_init(struct k_heap *h, void *mem, size_t bytes)
Initialize a k_heap.
void * k_malloc(size_t size)
Allocate memory from the heap.
void * k_heap_realloc(struct k_heap *h, void *ptr, size_t bytes, k_timeout_t timeout)
Reallocate memory from a k_heap.
void * k_calloc(size_t nmemb, size_t size)
Allocate memory from heap, array style.
void * k_aligned_alloc(size_t align, size_t size)
Allocate memory from the heap with a specified alignment.
void * k_heap_aligned_alloc(struct k_heap *h, size_t align, size_t bytes, k_timeout_t timeout)
Allocate aligned memory from a k_heap.
bool k_is_in_isr(void)
Determine if code is running at interrupt level.
int k_is_preempt_thread(void)
Determine if code is running in a preemptible thread.
execution_context_types
Types of execution contexts.
Definition kernel.h:137
@ K_ISR
Executing in an interrupt service routine.
Definition kernel.h:138
@ K_COOP_THREAD
Executing in a cooperative thread.
Definition kernel.h:139
@ K_PREEMPT_THREAD
Executing in a preemptible thread.
Definition kernel.h:140
int k_mbox_get(struct k_mbox *mbox, struct k_mbox_msg *rx_msg, void *buffer, k_timeout_t timeout)
Receive a mailbox message.
void k_mbox_data_get(struct k_mbox_msg *rx_msg, void *buffer)
Retrieve mailbox message data into a buffer.
void k_mbox_init(struct k_mbox *mbox)
Initialize a mailbox.
int k_mbox_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg, k_timeout_t timeout)
Send a mailbox message in a synchronous manner.
void k_mbox_async_put(struct k_mbox *mbox, struct k_mbox_msg *tx_msg, struct k_sem *sem)
Send a mailbox message in an asynchronous manner.
int k_mem_slab_init(struct k_mem_slab *slab, void *buffer, size_t block_size, uint32_t num_blocks)
Initialize a memory slab.
void k_mem_slab_free(struct k_mem_slab *slab, void *mem)
Free memory allocated from a memory slab.
int k_mem_slab_runtime_stats_get(struct k_mem_slab *slab, struct sys_memory_stats *stats)
Get the memory stats for a memory slab.
int k_mem_slab_runtime_stats_reset_max(struct k_mem_slab *slab)
Reset the maximum memory usage for a slab.
int k_mem_slab_alloc(struct k_mem_slab *slab, void **mem, k_timeout_t timeout)
Allocate memory from a memory slab.
static uint32_t k_mem_slab_num_used_get(struct k_mem_slab *slab)
Get the number of used blocks in a memory slab.
Definition kernel.h:6212
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:6229
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:6251
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:6757
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:6761
@ K_POLL_NUM_MODES
Number of poll modes.
Definition kernel.h:6763
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:52
struct _snode sys_snode_t
Single-linked list node structure.
Definition slist.h:42
int k_stack_pop(struct k_stack *stack, stack_data_t *data, k_timeout_t timeout)
Pop an element from a stack.
void k_stack_init(struct k_stack *stack, stack_data_t *buffer, uint32_t num_entries)
Initialize a stack.
int k_stack_cleanup(struct k_stack *stack)
Release a stack's allocated buffer.
int k_stack_push(struct k_stack *stack, stack_data_t data)
Push an element onto a stack.
int32_t k_stack_alloc_init(struct k_stack *stack, uint32_t num_entries)
Initialize a stack.
#define SYS_PORT_TRACING_TRACKING_FIELD(type)
Field added to kernel objects so they are tracked.
Definition tracing_macros.h:375
#define IS_ENABLED(config_macro)
Check for macro definition in compiler-visible expressions.
Definition util_macro.h:154
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
#define CONTAINER_OF(ptr, type, field)
Get a pointer to a structure containing the element.
Definition util.h:281
#define EBUSY
Mount device busy.
Definition errno.h:55
int k_thread_name_copy(k_tid_t thread, char *buf, size_t size)
Copy the thread name into a supplied buffer.
void k_yield(void)
Yield the current thread.
const char * k_thread_state_str(k_tid_t thread_id, char *buf, size_t buf_size)
Get thread state string.
void k_thread_resume(k_tid_t thread)
Resume a suspended thread.
void * k_thread_custom_data_get(void)
Get current thread's custom data.
void k_thread_abort(k_tid_t thread)
Abort a thread.
int k_thread_name_set(k_tid_t thread, const char *str)
Set current thread name.
void k_thread_priority_set(k_tid_t thread, int prio)
Set a thread's priority.
void k_thread_absolute_deadline_set(k_tid_t thread, int deadline)
Set absolute deadline expiration time for scheduler.
int k_thread_cpu_mask_enable(k_tid_t thread, int cpu)
Enable thread to run on specified CPU.
void k_thread_foreach_unlocked(k_thread_user_cb_t user_cb, void *user_data)
Iterate over all the threads in the system without locking.
bool k_can_yield(void)
Check whether it is possible to yield in the current context.
int k_thread_priority_get(k_tid_t thread)
Get a thread's priority.
static void k_thread_heap_assign(struct k_thread *thread, struct k_heap *heap)
Assign a resource memory pool to a thread.
Definition kernel.h:576
FUNC_NORETURN void k_thread_user_mode_enter(k_thread_entry_t entry, void *p1, void *p2, void *p3)
Drop a thread's privileges permanently to user mode.
int k_thread_join(struct k_thread *thread, k_timeout_t timeout)
Sleep until a thread exits.
k_ticks_t k_thread_timeout_remaining_ticks(const struct k_thread *thread)
Get time remaining before a thread wakes up, in system ticks.
void k_thread_custom_data_set(void *value)
Set current thread's custom data.
int32_t k_sleep(k_timeout_t timeout)
Put the current thread to sleep.
void k_sched_lock(void)
Lock the scheduler.
static int32_t k_msleep(int32_t ms)
Put the current thread to sleep.
Definition kernel.h:775
void k_busy_wait(uint32_t usec_to_wait)
Cause the current thread to busy wait.
void k_thread_time_slice_set(struct k_thread *th, int32_t slice_ticks, k_thread_timeslice_fn_t expired, void *data)
Set thread time slice.
static void k_thread_runtime_stats_longest_frame_reset(__maybe_unused struct k_thread *thread)
Resets thread longest frame usage data for specified thread.
Definition kernel.h:166
void k_thread_suspend(k_tid_t thread)
Suspend a thread.
void k_sched_unlock(void)
Unlock the scheduler.
static __attribute_const__ k_tid_t k_current_get(void)
Get thread ID of the current thread.
Definition kernel.h:909
int k_thread_cpu_mask_clear(k_tid_t thread)
Sets all CPU enable masks to zero.
void k_thread_foreach_filter_by_cpu(unsigned int cpu, k_thread_user_cb_t user_cb, void *user_data)
Iterate over all the threads in running on specified cpu.
void k_sched_time_slice_set(int32_t slice, int prio)
Set time-slicing period and scope.
int k_thread_cpu_mask_disable(k_tid_t thread, int cpu)
Prevent thread to run on specified CPU.
void k_wakeup(k_tid_t thread)
Wake up a sleeping thread.
int k_thread_stack_free(k_thread_stack_t *stack)
Free a dynamically allocated thread stack.
k_ticks_t k_thread_timeout_expires_ticks(const struct k_thread *thread)
Get time when a thread wakes up, in system ticks.
__attribute_const__ k_tid_t k_sched_current_thread_query(void)
Query thread ID of the current thread.
static void k_thread_start(k_tid_t thread)
Start an inactive thread.
Definition kernel.h:1397
k_tid_t k_thread_create(struct k_thread *new_thread, k_thread_stack_t *stack, size_t stack_size, k_thread_entry_t entry, void *p1, void *p2, void *p3, int prio, uint32_t options, k_timeout_t delay)
Create a thread.
void k_reschedule(void)
Invoke the scheduler.
void k_thread_deadline_set(k_tid_t thread, int deadline)
Set relative deadline expiration time for scheduler.
void k_thread_foreach_unlocked_filter_by_cpu(unsigned int cpu, k_thread_user_cb_t user_cb, void *user_data)
Iterate over the threads in running on current cpu without locking.
const char * k_thread_name_get(k_tid_t thread)
Get thread name.
void k_thread_foreach(k_thread_user_cb_t user_cb, void *user_data)
Iterate over all the threads in the system.
static bool k_is_pre_kernel(void)
Test whether startup is in the before-main-task phase.
Definition kernel.h:876
int k_thread_cpu_pin(k_tid_t thread, int cpu)
Pin a thread to a CPU.
int32_t k_usleep(int32_t us)
Put the current thread to sleep with microsecond resolution.
int k_thread_cpu_mask_enable_all(k_tid_t thread)
Sets all CPU enable masks to one.
void(* k_thread_user_cb_t)(const struct k_thread *thread, void *user_data)
Callback type used by thread iteration functions.
Definition kernel.h:179
k_thread_stack_t * k_thread_stack_alloc(size_t size, int flags)
Dynamically allocate a thread stack.
k_ticks_t k_timer_expires_ticks(const struct k_timer *timer)
Get next expiration time of a timer, in system ticks.
void(* k_timer_stop_t)(struct k_timer *timer)
Timer stop function type.
Definition kernel.h:1981
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:1965
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:2167
uint32_t k_timer_status_sync(struct k_timer *timer)
Synchronize thread to timer expiration.
void k_timer_stop(struct k_timer *timer)
Stop a timer.
uint32_t k_timer_status_get(struct k_timer *timer)
Read timer status.
void k_timer_user_data_set(struct k_timer *timer, void *user_data)
Associate user-specific data with a timer.
#define k_ticks_to_ms_ceil32(t)
Convert ticks to milliseconds.
Definition time_units.h:1782
#define k_ticks_to_sec_floor32(t)
Convert ticks to seconds.
Definition time_units.h:1622
#define k_ticks_to_ms_floor64(t)
Convert ticks to milliseconds.
Definition time_units.h:1734
int k_work_poll_submit_to_queue(struct k_work_q *work_q, struct k_work_poll *work, struct k_poll_event *events, int num_events, k_timeout_t timeout)
Submit a triggered work item.
static k_tid_t k_work_queue_thread_get(struct k_work_q *queue)
Access the thread that animates a work queue.
Definition kernel.h:4976
static bool k_work_is_pending(const struct k_work *work)
Test whether a work item is currently pending.
Definition kernel.h:4947
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:4964
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:5101
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:5078
void(* k_work_handler_t)(struct k_work *work)
The signature for a work item handler function.
Definition kernel.h:4069
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:4958
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:5056
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:4999
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:5156
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:4953
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:4970
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:4680
@ K_WORK_QUEUED
Flag indicating a work item that has been submitted to a queue but has not started running.
Definition kernel.h:4687
@ K_WORK_DELAYED
Flag indicating a delayed work item that is scheduled for submission to a queue.
Definition kernel.h:4694
@ K_WORK_RUNNING
Flag indicating a work item that is running under a work queue thread.
Definition kernel.h:4674
@ K_WORK_FLUSHING
Flag indicating a synced work item that is being flushed.
Definition kernel.h:4700
#define BUILD_ASSERT(EXPR, MSG...)
Definition llvm.h:51
struct k_thread * k_tid_t
Definition thread.h:383
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:3953
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:3982
int k_thread_runtime_stats_disable(k_tid_t thread)
Disable gathering of runtime statistics for specified thread.
int k_thread_runtime_stats_cpu_get(int cpu, k_thread_runtime_stats_t *stats)
Get the runtime statistics of all threads on specified cpu.
Header files included by kernel.h.
void(* k_thread_timeslice_fn_t)(struct k_thread *thread, void *data)
Definition kernel_structs.h:338
Memory Statistics.
flags
Definition parser.h:97
state
Definition parser_state.h:29
Header file for the ring buffer API.
__UINT32_TYPE__ uint32_t
Definition stdint.h:90
__INTPTR_TYPE__ intptr_t
Definition stdint.h:104
__INT32_TYPE__ int32_t
Definition stdint.h:74
__UINT64_TYPE__ uint64_t
Definition stdint.h:91
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
__UINTPTR_TYPE__ uintptr_t
Definition stdint.h:105
__INT64_TYPE__ int64_t
Definition stdint.h:75
Kernel condition variable structure.
Definition kernel.h:3693
Event Structure.
Definition kernel.h:2777
Kernel FIFO structure.
Definition kernel.h:3023
futex structure
Definition kernel.h:2672
atomic_t val
Futex value.
Definition kernel.h:2678
Kernel synchronized heap structure.
Definition kernel.h:6299
IPI work item structure.
Definition kernel.h:3961
Kernel LIFO structure.
Definition kernel.h:3280
Mailbox Message Structure.
Definition kernel.h:5641
k_tid_t tx_target_thread
target thread id
Definition kernel.h:5651
void * tx_data
sender's message data buffer
Definition kernel.h:5647
k_tid_t rx_source_thread
source thread id
Definition kernel.h:5649
uint32_t info
application-defined information value
Definition kernel.h:5645
size_t size
size of message (in bytes)
Definition kernel.h:5643
Mailbox Structure.
Definition kernel.h:5670
Memory Domain.
Definition mem_domain.h:80
Memory Partition.
Definition mem_domain.h:55
Message Queue Attributes.
Definition kernel.h:5380
uint32_t used_msgs
Used messages.
Definition kernel.h:5386
size_t msg_size
Message Size.
Definition kernel.h:5382
uint32_t max_msgs
Maximal number of messages.
Definition kernel.h:5384
Message Queue Structure.
Definition kernel.h:5316
Kernel mutex structure.
Definition kernel.h:3572
Object core structure.
Definition obj_core.h:123
Kernel pipe structure.
Definition kernel.h:5832
Poll Event.
Definition kernel.h:6833
struct k_poll_signal * signal
Poll signal being polled.
Definition kernel.h:6869
struct k_pipe * pipe
Pipe being polled.
Definition kernel.h:6879
uint32_t tag
optional user-specified tag, opaque, untouched by the API
Definition kernel.h:6847
struct k_fifo * fifo
FIFO being polled.
Definition kernel.h:6873
struct k_msgq * msgq
Message queue being polled.
Definition kernel.h:6877
struct k_queue * queue
Queue being polled.
Definition kernel.h:6875
uint32_t unused
unused bits in 32-bit word
Definition kernel.h:6859
uint32_t type
bitfield of event types (bitwise-ORed K_POLL_TYPE_xxx values)
Definition kernel.h:6850
struct k_sem * sem
Semaphore being polled.
Definition kernel.h:6871
uint32_t state
bitfield of event states (bitwise-ORed K_POLL_STATE_xxx values)
Definition kernel.h:6853
uint32_t mode
mode of operation, from enum k_poll_modes
Definition kernel.h:6856
void * obj
Generic object pointer.
Definition kernel.h:6867
Poll signal object.
Definition kernel.h:6798
int result
custom result value passed to k_poll_signal_raise() if needed
Definition kernel.h:6815
unsigned int signaled
1 if the event has been signaled, 0 otherwise.
Definition kernel.h:6812
Kernel queue structure.
Definition kernel.h:2376
Semaphore structure.
Definition kernel.h:3798
Kernel Spin Lock.
Definition spinlock.h:45
Thread Structure.
Definition thread.h:259
struct _thread_base base
Definition thread.h:261
struct k_heap * resource_pool
resource pool
Definition thread.h:357
struct __thread_entry entry
thread entry and parameters description
Definition thread.h:296
Kernel timeout type.
Definition clock.h:65
Kernel timer structure.
Definition kernel.h:1874
A structure used to submit work after a delay.
Definition kernel.h:4750
Kernel workqueue structure.
Definition kernel.h:4906
A structure holding optional configuration items for a work queue.
Definition kernel.h:4864
const char * name
The name to be given to the work queue thread.
Definition kernel.h:4869
uint32_t work_timeout_ms
Controls whether work queue monitors work timeouts.
Definition kernel.h:4898
bool essential
Control whether the work queue thread should be marked as essential thread.
Definition kernel.h:4888
bool no_yield
Control whether the work queue thread should yield between items.
Definition kernel.h:4883
A structure holding internal state for a pending synchronous operation on a work item or queue.
Definition kernel.h:4845
A structure used to submit work.
Definition kernel.h:4708
A structure to represent a ring buffer.
Definition ring_buffer.h:65
Definition sys_heap.h:60
Definition mem_stats.h:24
Iterable sections helpers.
static bool k_is_user_context(void)
Indicate whether the CPU is currently in user mode.
Definition syscall.h:120
Macros to abstract toolchain specific capabilities.
Main header file for tracing subsystem API.
Header file for tracing macros.