9cabb89956e0a19912cbdbec95464cf62af31a4d
[platform/upstream/pulseaudio.git] / src / pulsecore / thread.h
1 #ifndef foopulsethreadhfoo
2 #define foopulsethreadhfoo
3
4 /***
5   This file is part of PulseAudio.
6
7   Copyright 2006 Lennart Poettering
8   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9
10   PulseAudio is free software; you can redistribute it and/or modify
11   it under the terms of the GNU Lesser General Public License as
12   published by the Free Software Foundation; either version 2.1 of the
13   License, or (at your option) any later version.
14
15   PulseAudio is distributed in the hope that it will be useful, but
16   WITHOUT ANY WARRANTY; without even the implied warranty of
17   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18   General Public License for more details.
19
20   You should have received a copy of the GNU Lesser General Public
21   License along with PulseAudio; if not, write to the Free Software
22   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
23   USA.
24 ***/
25
26 #include <pulse/def.h>
27 #include <pulse/gccmacro.h>
28
29 #include <pulsecore/once.h>
30 #include <pulsecore/core-util.h>
31
32 #ifndef PACKAGE
33 #error "Please include config.h before including this file!"
34 #endif
35
36 typedef struct pa_thread pa_thread;
37
38 typedef void (*pa_thread_func_t) (void *userdata);
39
40 pa_thread* pa_thread_new(const char *name, pa_thread_func_t thread_func, void *userdata);
41 void pa_thread_free(pa_thread *t);
42 int pa_thread_join(pa_thread *t);
43 int pa_thread_is_running(pa_thread *t);
44 pa_thread *pa_thread_self(void);
45 void pa_thread_yield(void);
46
47 void* pa_thread_get_data(pa_thread *t);
48 void pa_thread_set_data(pa_thread *t, void *userdata);
49
50 const char *pa_thread_get_name(pa_thread *t);
51 void pa_thread_set_name(pa_thread *t, const char *name);
52
53 typedef struct pa_tls pa_tls;
54
55 pa_tls* pa_tls_new(pa_free_cb_t free_cb);
56 void pa_tls_free(pa_tls *t);
57 void * pa_tls_get(pa_tls *t);
58 void *pa_tls_set(pa_tls *t, void *userdata);
59
60 #define PA_STATIC_TLS_DECLARE(name, free_cb)                            \
61     static struct {                                                     \
62         pa_once once;                                                   \
63         pa_tls *volatile tls;                                           \
64     } name##_tls = {                                                    \
65         .once = PA_ONCE_INIT,                                           \
66         .tls = NULL                                                     \
67     };                                                                  \
68     static void name##_tls_init(void) {                                 \
69         name##_tls.tls = pa_tls_new(free_cb);                           \
70     }                                                                   \
71     static inline pa_tls* name##_tls_obj(void) {                        \
72         pa_run_once(&name##_tls.once, name##_tls_init);                 \
73         return name##_tls.tls;                                          \
74     }                                                                   \
75     static void name##_tls_destructor(void) PA_GCC_DESTRUCTOR;          \
76     static void name##_tls_destructor(void) {                           \
77         static void (*_free_cb)(void*) = free_cb;                       \
78         if (!pa_in_valgrind())                                          \
79             return;                                                     \
80         if (!name##_tls.tls)                                            \
81             return;                                                     \
82         if (_free_cb) {                                                 \
83             void *p;                                                    \
84             if ((p = pa_tls_get(name##_tls.tls)))                       \
85                 _free_cb(p);                                            \
86         }                                                               \
87         pa_tls_free(name##_tls.tls);                                    \
88     }                                                                   \
89     static inline void* name##_tls_get(void) {                          \
90         return pa_tls_get(name##_tls_obj());                            \
91     }                                                                   \
92     static inline void* name##_tls_set(void *p) {                       \
93         return pa_tls_set(name##_tls_obj(), p);                         \
94     }                                                                   \
95     struct __stupid_useless_struct_to_allow_trailing_semicolon
96
97 #if defined(SUPPORT_TLS___THREAD) && !defined(OS_IS_WIN32)
98 /* An optimized version of the above that requires no dynamic
99  * allocation if the compiler supports __thread */
100 #define PA_STATIC_TLS_DECLARE_NO_FREE(name)                             \
101     static __thread void *name##_tls = NULL;                            \
102     static inline void* name##_tls_get(void) {                          \
103         return name##_tls;                                              \
104     }                                                                   \
105     static inline void* name##_tls_set(void *p) {                       \
106         void *r = name##_tls;                                           \
107         name##_tls = p;                                                 \
108         return r;                                                       \
109     }                                                                   \
110     struct __stupid_useless_struct_to_allow_trailing_semicolon
111 #else
112 #define PA_STATIC_TLS_DECLARE_NO_FREE(name) PA_STATIC_TLS_DECLARE(name, NULL)
113 #endif
114
115 #define PA_STATIC_TLS_GET(name) (name##_tls_get())
116 #define PA_STATIC_TLS_SET(name, p) (name##_tls_set(p))
117
118 #endif