1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2015 Intel Corporation
15 #include "lthread_api.h"
16 #include "pthread_shim.h"
18 #define RTE_LOGTYPE_PTHREAD_SHIM RTE_LOGTYPE_USER3
20 #define POSIX_ERRNO(x) (x)
22 /* some releases of FreeBSD 10, e.g. 10.0, don't have CPU_COUNT macro */
24 #define CPU_COUNT(x) __cpu_count(x)
26 static inline unsigned int
27 __cpu_count(const rte_cpuset_t *cpuset)
29 unsigned int i, count = 0;
30 for (i = 0; i < RTE_MAX_LCORE; i++)
31 if (CPU_ISSET(i, cpuset))
38 * this flag determines at run time if we override pthread
39 * calls and map then to equivalent lthread calls
40 * or of we call the standard pthread function
42 static __thread int override;
46 * this structures contains function pointers that will be
47 * initialised to the loaded address of the real
48 * pthread library API functions
50 struct pthread_lib_funcs {
51 int (*f_pthread_barrier_destroy)
52 (pthread_barrier_t *);
53 int (*f_pthread_barrier_init)
54 (pthread_barrier_t *, const pthread_barrierattr_t *, unsigned);
55 int (*f_pthread_barrier_wait)
56 (pthread_barrier_t *);
57 int (*f_pthread_cond_broadcast)
59 int (*f_pthread_cond_destroy)
61 int (*f_pthread_cond_init)
62 (pthread_cond_t *, const pthread_condattr_t *);
63 int (*f_pthread_cond_signal)
65 int (*f_pthread_cond_timedwait)
66 (pthread_cond_t *, pthread_mutex_t *, const struct timespec *);
67 int (*f_pthread_cond_wait)
68 (pthread_cond_t *, pthread_mutex_t *);
69 int (*f_pthread_create)
70 (pthread_t *, const pthread_attr_t *, void *(*)(void *), void *);
71 int (*f_pthread_detach)
73 int (*f_pthread_equal)
74 (pthread_t, pthread_t);
75 void (*f_pthread_exit)
77 void * (*f_pthread_getspecific)
79 int (*f_pthread_getcpuclockid)
80 (pthread_t, clockid_t *);
83 int (*f_pthread_key_create)
84 (pthread_key_t *, void (*) (void *));
85 int (*f_pthread_key_delete)
87 int (*f_pthread_mutex_destroy)
88 (pthread_mutex_t *__mutex);
89 int (*f_pthread_mutex_init)
90 (pthread_mutex_t *__mutex, const pthread_mutexattr_t *);
91 int (*f_pthread_mutex_lock)
92 (pthread_mutex_t *__mutex);
93 int (*f_pthread_mutex_trylock)
94 (pthread_mutex_t *__mutex);
95 int (*f_pthread_mutex_timedlock)
96 (pthread_mutex_t *__mutex, const struct timespec *);
97 int (*f_pthread_mutex_unlock)
98 (pthread_mutex_t *__mutex);
100 (pthread_once_t *, void (*) (void));
101 int (*f_pthread_rwlock_destroy)
102 (pthread_rwlock_t *__rwlock);
103 int (*f_pthread_rwlock_init)
104 (pthread_rwlock_t *__rwlock, const pthread_rwlockattr_t *);
105 int (*f_pthread_rwlock_rdlock)
106 (pthread_rwlock_t *__rwlock);
107 int (*f_pthread_rwlock_timedrdlock)
108 (pthread_rwlock_t *__rwlock, const struct timespec *);
109 int (*f_pthread_rwlock_timedwrlock)
110 (pthread_rwlock_t *__rwlock, const struct timespec *);
111 int (*f_pthread_rwlock_tryrdlock)
112 (pthread_rwlock_t *__rwlock);
113 int (*f_pthread_rwlock_trywrlock)
114 (pthread_rwlock_t *__rwlock);
115 int (*f_pthread_rwlock_unlock)
116 (pthread_rwlock_t *__rwlock);
117 int (*f_pthread_rwlock_wrlock)
118 (pthread_rwlock_t *__rwlock);
119 pthread_t (*f_pthread_self)
121 int (*f_pthread_setspecific)
122 (pthread_key_t, const void *);
123 int (*f_pthread_spin_init)
124 (pthread_spinlock_t *__spin, int);
125 int (*f_pthread_spin_destroy)
126 (pthread_spinlock_t *__spin);
127 int (*f_pthread_spin_lock)
128 (pthread_spinlock_t *__spin);
129 int (*f_pthread_spin_trylock)
130 (pthread_spinlock_t *__spin);
131 int (*f_pthread_spin_unlock)
132 (pthread_spinlock_t *__spin);
133 int (*f_pthread_cancel)
135 int (*f_pthread_setcancelstate)
137 int (*f_pthread_setcanceltype)
139 void (*f_pthread_testcancel)
141 int (*f_pthread_getschedparam)
142 (pthread_t pthread, int *, struct sched_param *);
143 int (*f_pthread_setschedparam)
144 (pthread_t, int, const struct sched_param *);
145 int (*f_pthread_yield)
147 int (*f_pthread_setaffinity_np)
148 (pthread_t thread, size_t cpusetsize, const rte_cpuset_t *cpuset);
150 (const struct timespec *req, struct timespec *rem);
151 } _sys_pthread_funcs = {
152 .f_pthread_barrier_destroy = NULL,
157 * this macro obtains the loaded address of a library function
160 static void *__libc_dl_handle = RTLD_NEXT;
162 #define get_addr_of_loaded_symbol(name) do { \
164 _sys_pthread_funcs.f_##name = dlsym(__libc_dl_handle, (#name)); \
165 error_str = dlerror(); \
166 if (error_str != NULL) { \
167 fprintf(stderr, "%s\n", error_str); \
173 * The constructor function initialises the
174 * function pointers for pthread library functions
176 RTE_INIT(pthread_intercept_ctor)
180 * Get the original functions
182 get_addr_of_loaded_symbol(pthread_barrier_destroy);
183 get_addr_of_loaded_symbol(pthread_barrier_init);
184 get_addr_of_loaded_symbol(pthread_barrier_wait);
185 get_addr_of_loaded_symbol(pthread_cond_broadcast);
186 get_addr_of_loaded_symbol(pthread_cond_destroy);
187 get_addr_of_loaded_symbol(pthread_cond_init);
188 get_addr_of_loaded_symbol(pthread_cond_signal);
189 get_addr_of_loaded_symbol(pthread_cond_timedwait);
190 get_addr_of_loaded_symbol(pthread_cond_wait);
191 get_addr_of_loaded_symbol(pthread_create);
192 get_addr_of_loaded_symbol(pthread_detach);
193 get_addr_of_loaded_symbol(pthread_equal);
194 get_addr_of_loaded_symbol(pthread_exit);
195 get_addr_of_loaded_symbol(pthread_getspecific);
196 get_addr_of_loaded_symbol(pthread_getcpuclockid);
197 get_addr_of_loaded_symbol(pthread_join);
198 get_addr_of_loaded_symbol(pthread_key_create);
199 get_addr_of_loaded_symbol(pthread_key_delete);
200 get_addr_of_loaded_symbol(pthread_mutex_destroy);
201 get_addr_of_loaded_symbol(pthread_mutex_init);
202 get_addr_of_loaded_symbol(pthread_mutex_lock);
203 get_addr_of_loaded_symbol(pthread_mutex_trylock);
204 get_addr_of_loaded_symbol(pthread_mutex_timedlock);
205 get_addr_of_loaded_symbol(pthread_mutex_unlock);
206 get_addr_of_loaded_symbol(pthread_once);
207 get_addr_of_loaded_symbol(pthread_rwlock_destroy);
208 get_addr_of_loaded_symbol(pthread_rwlock_init);
209 get_addr_of_loaded_symbol(pthread_rwlock_rdlock);
210 get_addr_of_loaded_symbol(pthread_rwlock_timedrdlock);
211 get_addr_of_loaded_symbol(pthread_rwlock_timedwrlock);
212 get_addr_of_loaded_symbol(pthread_rwlock_tryrdlock);
213 get_addr_of_loaded_symbol(pthread_rwlock_trywrlock);
214 get_addr_of_loaded_symbol(pthread_rwlock_unlock);
215 get_addr_of_loaded_symbol(pthread_rwlock_wrlock);
216 get_addr_of_loaded_symbol(pthread_self);
217 get_addr_of_loaded_symbol(pthread_setspecific);
218 get_addr_of_loaded_symbol(pthread_spin_init);
219 get_addr_of_loaded_symbol(pthread_spin_destroy);
220 get_addr_of_loaded_symbol(pthread_spin_lock);
221 get_addr_of_loaded_symbol(pthread_spin_trylock);
222 get_addr_of_loaded_symbol(pthread_spin_unlock);
223 get_addr_of_loaded_symbol(pthread_cancel);
224 get_addr_of_loaded_symbol(pthread_setcancelstate);
225 get_addr_of_loaded_symbol(pthread_setcanceltype);
226 get_addr_of_loaded_symbol(pthread_testcancel);
227 get_addr_of_loaded_symbol(pthread_getschedparam);
228 get_addr_of_loaded_symbol(pthread_setschedparam);
229 get_addr_of_loaded_symbol(pthread_yield);
230 get_addr_of_loaded_symbol(pthread_setaffinity_np);
231 get_addr_of_loaded_symbol(nanosleep);
236 * Enable/Disable pthread override
241 void pthread_override_set(int state)
248 * Return pthread override state
253 int pthread_override_get(void)
259 * This macro is used to catch and log
260 * invocation of stubs for unimplemented pthread
263 #define NOT_IMPLEMENTED do { \
267 "WARNING %s NOT IMPLEMENTED\n", \
273 * pthread API override functions follow
274 * Note in this example code only a subset of functions are
277 * The stub functions provided will issue a warning log
278 * message if an unimplemented function is invoked
282 int pthread_barrier_destroy(pthread_barrier_t *a)
285 return _sys_pthread_funcs.f_pthread_barrier_destroy(a);
289 pthread_barrier_init(pthread_barrier_t *a,
290 const pthread_barrierattr_t *b, unsigned c)
293 return _sys_pthread_funcs.f_pthread_barrier_init(a, b, c);
296 int pthread_barrier_wait(pthread_barrier_t *a)
299 return _sys_pthread_funcs.f_pthread_barrier_wait(a);
302 int pthread_cond_broadcast(pthread_cond_t *cond)
306 lthread_cond_broadcast(*(struct lthread_cond **)cond);
309 return _sys_pthread_funcs.f_pthread_cond_broadcast(cond);
312 int pthread_mutex_destroy(pthread_mutex_t *mutex)
315 return lthread_mutex_destroy(*(struct lthread_mutex **)mutex);
316 return _sys_pthread_funcs.f_pthread_mutex_destroy(mutex);
319 int pthread_cond_destroy(pthread_cond_t *cond)
322 return lthread_cond_destroy(*(struct lthread_cond **)cond);
323 return _sys_pthread_funcs.f_pthread_cond_destroy(cond);
326 int pthread_cond_init(pthread_cond_t *cond, const pthread_condattr_t *attr)
329 return lthread_cond_init(NULL,
330 (struct lthread_cond **)cond,
331 (const struct lthread_condattr *) attr);
332 return _sys_pthread_funcs.f_pthread_cond_init(cond, attr);
335 int pthread_cond_signal(pthread_cond_t *cond)
338 lthread_cond_signal(*(struct lthread_cond **)cond);
341 return _sys_pthread_funcs.f_pthread_cond_signal(cond);
345 pthread_cond_timedwait(pthread_cond_t *__restrict cond,
346 pthread_mutex_t *__restrict mutex,
347 const struct timespec *__restrict time)
350 return _sys_pthread_funcs.f_pthread_cond_timedwait(cond, mutex, time);
353 int pthread_cond_wait(pthread_cond_t *cond, pthread_mutex_t *mutex)
356 pthread_mutex_unlock(mutex);
357 int rv = lthread_cond_wait(*(struct lthread_cond **)cond, 0);
359 pthread_mutex_lock(mutex);
362 return _sys_pthread_funcs.f_pthread_cond_wait(cond, mutex);
366 pthread_create(pthread_t *__restrict tid,
367 const pthread_attr_t *__restrict attr,
368 void *(func) (void *),
369 void *__restrict arg)
375 /* determine CPU being requested */
379 pthread_attr_getaffinity_np(attr,
380 sizeof(rte_cpuset_t),
383 if (CPU_COUNT(&cpuset) != 1)
384 return POSIX_ERRNO(EINVAL);
386 for (lcore = 0; lcore < LTHREAD_MAX_LCORES; lcore++) {
387 if (!CPU_ISSET(lcore, &cpuset))
392 return lthread_create((struct lthread **)tid, lcore,
393 (void (*)(void *))func, arg);
395 return _sys_pthread_funcs.f_pthread_create(tid, attr, func, arg);
398 int pthread_detach(pthread_t tid)
401 struct lthread *lt = (struct lthread *)tid;
403 if (lt == lthread_current()) {
409 return _sys_pthread_funcs.f_pthread_detach(tid);
412 int pthread_equal(pthread_t a, pthread_t b)
415 return _sys_pthread_funcs.f_pthread_equal(a, b);
418 void pthread_exit_override(void *v)
424 _sys_pthread_funcs.f_pthread_exit(v);
428 *pthread_getspecific(pthread_key_t key)
431 return lthread_getspecific((unsigned int) key);
432 return _sys_pthread_funcs.f_pthread_getspecific(key);
435 int pthread_getcpuclockid(pthread_t a, clockid_t *b)
438 return _sys_pthread_funcs.f_pthread_getcpuclockid(a, b);
441 int pthread_join(pthread_t tid, void **val)
444 return lthread_join((struct lthread *)tid, val);
445 return _sys_pthread_funcs.f_pthread_join(tid, val);
448 int pthread_key_create(pthread_key_t *keyptr, void (*dtor) (void *))
451 return lthread_key_create((unsigned int *)keyptr, dtor);
452 return _sys_pthread_funcs.f_pthread_key_create(keyptr, dtor);
455 int pthread_key_delete(pthread_key_t key)
458 lthread_key_delete((unsigned int) key);
461 return _sys_pthread_funcs.f_pthread_key_delete(key);
466 pthread_mutex_init(pthread_mutex_t *mutex, const pthread_mutexattr_t *attr)
469 return lthread_mutex_init(NULL,
470 (struct lthread_mutex **)mutex,
471 (const struct lthread_mutexattr *)attr);
472 return _sys_pthread_funcs.f_pthread_mutex_init(mutex, attr);
475 int pthread_mutex_lock(pthread_mutex_t *mutex)
478 return lthread_mutex_lock(*(struct lthread_mutex **)mutex);
479 return _sys_pthread_funcs.f_pthread_mutex_lock(mutex);
482 int pthread_mutex_trylock(pthread_mutex_t *mutex)
485 return lthread_mutex_trylock(*(struct lthread_mutex **)mutex);
486 return _sys_pthread_funcs.f_pthread_mutex_trylock(mutex);
489 int pthread_mutex_timedlock(pthread_mutex_t *mutex, const struct timespec *b)
492 return _sys_pthread_funcs.f_pthread_mutex_timedlock(mutex, b);
495 int pthread_mutex_unlock(pthread_mutex_t *mutex)
498 return lthread_mutex_unlock(*(struct lthread_mutex **)mutex);
499 return _sys_pthread_funcs.f_pthread_mutex_unlock(mutex);
502 int pthread_once(pthread_once_t *a, void (b) (void))
505 return _sys_pthread_funcs.f_pthread_once(a, b);
508 int pthread_rwlock_destroy(pthread_rwlock_t *a)
511 return _sys_pthread_funcs.f_pthread_rwlock_destroy(a);
514 int pthread_rwlock_init(pthread_rwlock_t *a, const pthread_rwlockattr_t *b)
517 return _sys_pthread_funcs.f_pthread_rwlock_init(a, b);
520 int pthread_rwlock_rdlock(pthread_rwlock_t *a)
523 return _sys_pthread_funcs.f_pthread_rwlock_rdlock(a);
526 int pthread_rwlock_timedrdlock(pthread_rwlock_t *a, const struct timespec *b)
529 return _sys_pthread_funcs.f_pthread_rwlock_timedrdlock(a, b);
532 int pthread_rwlock_timedwrlock(pthread_rwlock_t *a, const struct timespec *b)
535 return _sys_pthread_funcs.f_pthread_rwlock_timedwrlock(a, b);
538 int pthread_rwlock_tryrdlock(pthread_rwlock_t *a)
541 return _sys_pthread_funcs.f_pthread_rwlock_tryrdlock(a);
544 int pthread_rwlock_trywrlock(pthread_rwlock_t *a)
547 return _sys_pthread_funcs.f_pthread_rwlock_trywrlock(a);
550 int pthread_rwlock_unlock(pthread_rwlock_t *a)
553 return _sys_pthread_funcs.f_pthread_rwlock_unlock(a);
556 int pthread_rwlock_wrlock(pthread_rwlock_t *a)
559 return _sys_pthread_funcs.f_pthread_rwlock_wrlock(a);
562 #ifdef RTE_EXEC_ENV_LINUXAPP
570 return _sys_pthread_funcs.f_pthread_yield();
579 _sys_pthread_funcs.f_pthread_yield();
583 pthread_t pthread_self(void)
586 return (pthread_t) lthread_current();
587 return _sys_pthread_funcs.f_pthread_self();
590 int pthread_setspecific(pthread_key_t key, const void *data)
593 int rv = lthread_setspecific((unsigned int)key, data);
596 return _sys_pthread_funcs.f_pthread_setspecific(key, data);
599 int pthread_spin_init(pthread_spinlock_t *a, int b)
602 return _sys_pthread_funcs.f_pthread_spin_init(a, b);
605 int pthread_spin_destroy(pthread_spinlock_t *a)
608 return _sys_pthread_funcs.f_pthread_spin_destroy(a);
611 int pthread_spin_lock(pthread_spinlock_t *a)
614 return _sys_pthread_funcs.f_pthread_spin_lock(a);
617 int pthread_spin_trylock(pthread_spinlock_t *a)
620 return _sys_pthread_funcs.f_pthread_spin_trylock(a);
623 int pthread_spin_unlock(pthread_spinlock_t *a)
626 return _sys_pthread_funcs.f_pthread_spin_unlock(a);
629 int pthread_cancel(pthread_t tid)
632 lthread_cancel(*(struct lthread **)tid);
635 return _sys_pthread_funcs.f_pthread_cancel(tid);
638 int pthread_setcancelstate(int a, int *b)
641 return _sys_pthread_funcs.f_pthread_setcancelstate(a, b);
644 int pthread_setcanceltype(int a, int *b)
647 return _sys_pthread_funcs.f_pthread_setcanceltype(a, b);
650 void pthread_testcancel(void)
653 return _sys_pthread_funcs.f_pthread_testcancel();
657 int pthread_getschedparam(pthread_t tid, int *a, struct sched_param *b)
660 return _sys_pthread_funcs.f_pthread_getschedparam(tid, a, b);
663 int pthread_setschedparam(pthread_t a, int b, const struct sched_param *c)
666 return _sys_pthread_funcs.f_pthread_setschedparam(a, b, c);
670 int nanosleep(const struct timespec *req, struct timespec *rem)
673 uint64_t ns = req->tv_sec * 1000000000 + req->tv_nsec;
678 return _sys_pthread_funcs.f_nanosleep(req, rem);
682 pthread_setaffinity_np(pthread_t thread, size_t cpusetsize,
683 const rte_cpuset_t *cpuset)
686 /* we only allow affinity with a single CPU */
687 if (CPU_COUNT(cpuset) != 1)
688 return POSIX_ERRNO(EINVAL);
690 /* we only allow the current thread to sets its own affinity */
691 struct lthread *lt = (struct lthread *)thread;
693 if (lthread_current() != lt)
694 return POSIX_ERRNO(EINVAL);
696 /* determine the CPU being requested */
699 for (i = 0; i < LTHREAD_MAX_LCORES; i++) {
700 if (!CPU_ISSET(i, cpuset))
704 /* check requested core is allowed */
705 if (i == LTHREAD_MAX_LCORES)
706 return POSIX_ERRNO(EINVAL);
708 /* finally we can set affinity to the requested lcore */
709 lthread_set_affinity(i);
712 return _sys_pthread_funcs.f_pthread_setaffinity_np(thread, cpusetsize,