merge glitch-free branch back into trunk
[profile/ivi/pulseaudio.git] / src / pulsecore / flist.h
1 #ifndef foopulseflisthfoo
2 #define foopulseflisthfoo
3
4 /* $Id$ */
5
6 /***
7   This file is part of PulseAudio.
8
9   Copyright 2006 Lennart Poettering
10
11   PulseAudio is free software; you can redistribute it and/or modify
12   it under the terms of the GNU Lesser General Public License as
13   published by the Free Software Foundation; either version 2 of the
14   License, or (at your option) any later version.
15
16   PulseAudio is distributed in the hope that it will be useful, but
17   WITHOUT ANY WARRANTY; without even the implied warranty of
18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   General Public License for more details.
20
21   You should have received a copy of the GNU Lesser General Public
22   License along with PulseAudio; if not, write to the Free Software
23   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
24   USA.
25 ***/
26
27 #include <pulse/def.h>
28 #include <pulse/gccmacro.h>
29
30 #include <pulsecore/once.h>
31
32 /* A multiple-reader multipler-write lock-free free list implementation */
33
34 typedef struct pa_flist pa_flist;
35
36 /* Size is required to be a power of two, or 0 for the default size */
37 pa_flist * pa_flist_new(unsigned size);
38 void pa_flist_free(pa_flist *l, pa_free_cb_t free_cb);
39
40 /* Please note that this routine might fail! */
41 int pa_flist_push(pa_flist*l, void *p);
42 void* pa_flist_pop(pa_flist*l);
43
44 /* Please not that the destructor stuff is not really necesary, we do
45  * this just to make valgrind output more useful. */
46
47 #define PA_STATIC_FLIST_DECLARE(name, size, free_cb)                    \
48     static struct {                                                     \
49         pa_flist *flist;                                                \
50         pa_once once;                                                   \
51     } name##_flist = { NULL, PA_ONCE_INIT };                            \
52     static void name##_flist_init(void) {                               \
53         name##_flist.flist = pa_flist_new(size);                        \
54     }                                                                   \
55     static inline pa_flist* name##_flist_get(void) {                    \
56         pa_run_once(&name##_flist.once, name##_flist_init);             \
57         return name##_flist.flist;                                      \
58     }                                                                   \
59     static void name##_flist_destructor(void) PA_GCC_DESTRUCTOR;        \
60     static void name##_flist_destructor(void) {                         \
61         if (name##_flist.flist)                                         \
62             pa_flist_free(name##_flist.flist, (free_cb));               \
63     }                                                                   \
64     struct __stupid_useless_struct_to_allow_trailing_semicolon
65
66 #define PA_STATIC_FLIST_GET(name) (name##_flist_get())
67
68 #endif