4 * Copyright(c) 2015 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 * Some portions of this software is derived from the
36 * https://github.com/halayli/lthread which carrys the following license.
38 * Copyright (C) 2012, Hasan Alayli <halayli@gmail.com>
40 * Redistribution and use in source and binary forms, with or without
41 * modification, are permitted provided that the following conditions
43 * 1. Redistributions of source code must retain the above copyright
44 * notice, this list of conditions and the following disclaimer.
45 * 2. Redistributions in binary form must reproduce the above copyright
46 * notice, this list of conditions and the following disclaimer in the
47 * documentation and/or other materials provided with the distribution.
49 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
81 #include "lthread_api.h"
83 #include "lthread_timer.h"
84 #include "lthread_tls.h"
85 #include "lthread_objcache.h"
86 #include "lthread_diag.h"
90 * This function gets called after an lthread function has returned.
92 void _lthread_exit_handler(struct lthread *lt)
95 lt->state |= BIT(ST_LT_EXITED);
97 if (!(lt->state & BIT(ST_LT_DETACH))) {
98 /* thread is this not explicitly detached
99 * it must be joinable, so we call lthread_exit().
104 /* if we get here the thread is detached so we can reschedule it,
105 * allowing the scheduler to free it
112 * Free resources allocated to an lthread
114 void _lthread_free(struct lthread *lt)
117 DIAG_EVENT(lt, LT_DIAG_LTHREAD_FREE, lt, 0);
119 /* invoke any user TLS destructor functions */
120 _lthread_tls_destroy(lt);
122 /* free memory allocated for TLS defined using RTE_PER_LTHREAD macros */
123 if (sizeof(void *) < (uint64_t)RTE_PER_LTHREAD_SECTION_SIZE)
124 _lthread_objcache_free(lt->tls->root_sched->per_lthread_cache,
125 lt->per_lthread_data);
127 /* free pthread style TLS memory */
128 _lthread_objcache_free(lt->tls->root_sched->tls_cache, lt->tls);
131 _lthread_objcache_free(lt->stack_container->root_sched->stack_cache,
132 lt->stack_container);
134 /* now free the thread */
135 _lthread_objcache_free(lt->root_sched->lthread_cache, lt);
140 * Allocate a stack and maintain a cache of stacks
142 struct lthread_stack *_stack_alloc(void)
144 struct lthread_stack *s;
146 s = _lthread_objcache_alloc((THIS_SCHED)->stack_cache);
147 RTE_ASSERT(s != NULL);
149 s->root_sched = THIS_SCHED;
150 s->stack_size = LTHREAD_MAX_STACK_SIZE;
155 * Execute a ctx by invoking the start function
156 * On return call an exit handler if the user has provided one
158 static void _lthread_exec(void *arg)
160 struct lthread *lt = (struct lthread *)arg;
162 /* invoke the contexts function */
164 /* do exit handling */
165 if (lt->exit_handler != NULL)
166 lt->exit_handler(lt);
170 * Initialize an lthread
171 * Set its function, args, and exit handler
174 _lthread_init(struct lthread *lt,
175 lthread_func_t fun, void *arg, lthread_exit_func exit_handler)
178 /* set ctx func and args */
181 lt->exit_handler = exit_handler;
183 /* set initial state */
184 lt->birth = _sched_now();
185 lt->state = BIT(ST_LT_INIT);
186 lt->join = LT_JOIN_INITIAL;
190 * set the lthread stack
192 void _lthread_set_stack(struct lthread *lt, void *stack, size_t stack_size)
196 lt->stack_size = stack_size;
198 arch_set_stack(lt, _lthread_exec);
202 * Create an lthread on the current scheduler
203 * If there is no current scheduler on this pthread then first create one
206 lthread_create(struct lthread **new_lt, int lcore_id,
207 lthread_func_t fun, void *arg)
209 if ((new_lt == NULL) || (fun == NULL))
210 return POSIX_ERRNO(EINVAL);
213 lcore_id = rte_lcore_id();
214 else if (lcore_id > LTHREAD_MAX_LCORES)
215 return POSIX_ERRNO(EINVAL);
217 struct lthread *lt = NULL;
219 if (THIS_SCHED == NULL) {
220 THIS_SCHED = _lthread_sched_create(0);
221 if (THIS_SCHED == NULL) {
222 perror("Failed to create scheduler");
223 return POSIX_ERRNO(EAGAIN);
227 /* allocate a thread structure */
228 lt = _lthread_objcache_alloc((THIS_SCHED)->lthread_cache);
230 return POSIX_ERRNO(EAGAIN);
232 bzero(lt, sizeof(struct lthread));
233 lt->root_sched = THIS_SCHED;
235 /* set the function args and exit handlder */
236 _lthread_init(lt, fun, arg, _lthread_exit_handler);
238 /* put it in the ready queue */
242 lcore_id = rte_lcore_id();
244 DIAG_CREATE_EVENT(lt, LT_DIAG_LTHREAD_CREATE);
247 _ready_queue_insert(_lthread_sched_get(lcore_id), lt);
252 * Schedules lthread to sleep for `nsecs`
253 * setting the lthread state to LT_ST_SLEEPING.
254 * lthread state is cleared upon resumption or expiry.
256 static inline void _lthread_sched_sleep(struct lthread *lt, uint64_t nsecs)
258 uint64_t state = lt->state;
259 uint64_t clks = _ns_to_clks(nsecs);
262 _timer_start(lt, clks);
263 lt->state = state | BIT(ST_LT_SLEEPING);
265 DIAG_EVENT(lt, LT_DIAG_LTHREAD_SLEEP, clks, 0);
272 * Cancels any running timer.
273 * This can be called multiple times on the same lthread regardless if it was
276 int _lthread_desched_sleep(struct lthread *lt)
278 uint64_t state = lt->state;
280 if (state & BIT(ST_LT_SLEEPING)) {
282 state &= (CLEARBIT(ST_LT_SLEEPING) & CLEARBIT(ST_LT_EXPIRED));
283 lt->state = state | BIT(ST_LT_READY);
290 * set user data pointer in an lthread
292 void lthread_set_data(void *data)
294 if (sizeof(void *) == RTE_PER_LTHREAD_SECTION_SIZE)
295 THIS_LTHREAD->per_lthread_data = data;
299 * Retrieve user data pointer from an lthread
301 void *lthread_get_data(void)
303 return THIS_LTHREAD->per_lthread_data;
307 * Return the current lthread handle
309 struct lthread *lthread_current(void)
311 struct lthread_sched *sched = THIS_SCHED;
314 return sched->current_lthread;
321 * Tasklet to cancel a thread
326 struct lthread *lt = (struct lthread *) arg;
328 lt->state |= BIT(ST_LT_CANCELLED);
335 * Mark the specified as canceled
337 int lthread_cancel(struct lthread *cancel_lt)
341 if ((cancel_lt == NULL) || (cancel_lt == THIS_LTHREAD))
342 return POSIX_ERRNO(EINVAL);
344 DIAG_EVENT(cancel_lt, LT_DIAG_LTHREAD_CANCEL, cancel_lt, 0);
346 if (cancel_lt->sched != THIS_SCHED) {
348 /* spawn task-let to cancel the thread */
350 cancel_lt->sched->lcore_id,
355 cancel_lt->state |= BIT(ST_LT_CANCELLED);
360 * Suspend the current lthread for specified time
362 void lthread_sleep(uint64_t nsecs)
364 struct lthread *lt = THIS_LTHREAD;
366 _lthread_sched_sleep(lt, nsecs);
371 * Suspend the current lthread for specified time
373 void lthread_sleep_clks(uint64_t clks)
375 struct lthread *lt = THIS_LTHREAD;
376 uint64_t state = lt->state;
379 _timer_start(lt, clks);
380 lt->state = state | BIT(ST_LT_SLEEPING);
382 DIAG_EVENT(lt, LT_DIAG_LTHREAD_SLEEP, clks, 0);
387 * Requeue the current thread to the back of the ready queue
389 void lthread_yield(void)
391 struct lthread *lt = THIS_LTHREAD;
393 DIAG_EVENT(lt, LT_DIAG_LTHREAD_YIELD, 0, 0);
395 _ready_queue_insert(THIS_SCHED, lt);
396 ctx_switch(&(THIS_SCHED)->ctx, <->ctx);
400 * Exit the current lthread
401 * If a thread is joining pass the user pointer to it
403 void lthread_exit(void *ptr)
405 struct lthread *lt = THIS_LTHREAD;
407 /* if thread is detached (this is not valid) just exit */
408 if (lt->state & BIT(ST_LT_DETACH))
411 /* There is a race between lthread_join() and lthread_exit()
412 * - if exit before join then we suspend and resume on join
413 * - if join before exit then we resume the joining thread
415 if ((lt->join == LT_JOIN_INITIAL)
416 && rte_atomic64_cmpset(<->join, LT_JOIN_INITIAL,
419 DIAG_EVENT(lt, LT_DIAG_LTHREAD_EXIT, 1, 0);
421 /* set the exit value */
422 if ((ptr != NULL) && (lt->lt_join->lt_exit_ptr != NULL))
423 *(lt->lt_join->lt_exit_ptr) = ptr;
425 /* let the joining thread know we have set the exit value */
426 lt->join = LT_JOIN_EXIT_VAL_SET;
429 DIAG_EVENT(lt, LT_DIAG_LTHREAD_EXIT, 0, 0);
430 /* set the exit value */
431 if ((ptr != NULL) && (lt->lt_join->lt_exit_ptr != NULL))
432 *(lt->lt_join->lt_exit_ptr) = ptr;
433 /* let the joining thread know we have set the exit value */
434 lt->join = LT_JOIN_EXIT_VAL_SET;
435 _ready_queue_insert(lt->lt_join->sched,
436 (struct lthread *)lt->lt_join);
440 /* wait until the joinging thread has collected the exit value */
441 while (lt->join != LT_JOIN_EXIT_VAL_READ)
444 /* reset join state */
445 lt->join = LT_JOIN_INITIAL;
447 /* detach it so its resources can be released */
448 lt->state |= (BIT(ST_LT_DETACH) | BIT(ST_LT_EXITED));
453 * Suspend until the joined thread returns
455 int lthread_join(struct lthread *lt, void **ptr)
458 return POSIX_ERRNO(EINVAL);
460 struct lthread *current = THIS_LTHREAD;
461 uint64_t lt_state = lt->state;
463 /* invalid to join a detached thread, or a thread that is joined */
464 if ((lt_state & BIT(ST_LT_DETACH)) || (lt->join == LT_JOIN_THREAD_SET))
465 return POSIX_ERRNO(EINVAL);
466 /* pointer to the joining thread and a poingter to return a value */
467 lt->lt_join = current;
468 current->lt_exit_ptr = ptr;
469 /* There is a race between lthread_join() and lthread_exit()
470 * - if join before exit we suspend and will resume when exit is called
471 * - if exit before join we resume the exiting thread
473 if ((lt->join == LT_JOIN_INITIAL)
474 && rte_atomic64_cmpset(<->join, LT_JOIN_INITIAL,
475 LT_JOIN_THREAD_SET)) {
477 DIAG_EVENT(current, LT_DIAG_LTHREAD_JOIN, lt, 1);
480 DIAG_EVENT(current, LT_DIAG_LTHREAD_JOIN, lt, 0);
481 _ready_queue_insert(lt->sched, lt);
484 /* wait for exiting thread to set return value */
485 while (lt->join != LT_JOIN_EXIT_VAL_SET)
488 /* collect the return value */
490 *ptr = *current->lt_exit_ptr;
492 /* let the exiting thread proceed to exit */
493 lt->join = LT_JOIN_EXIT_VAL_READ;
499 * Detach current lthread
500 * A detached thread cannot be joined
502 void lthread_detach(void)
504 struct lthread *lt = THIS_LTHREAD;
506 DIAG_EVENT(lt, LT_DIAG_LTHREAD_DETACH, 0, 0);
508 uint64_t state = lt->state;
510 lt->state = state | BIT(ST_LT_DETACH);
514 * Set function name of an lthread
515 * this is a debug aid
517 void lthread_set_funcname(const char *f)
519 struct lthread *lt = THIS_LTHREAD;
521 strncpy(lt->funcname, f, sizeof(lt->funcname));
522 lt->funcname[sizeof(lt->funcname)-1] = 0;