doxygen: add blenlib under core as module.
[blender.git] / source / blender / blenlib / BLI_threads.h
1 /*
2  *
3  * $Id$
4  *
5  * ***** BEGIN GPL LICENSE BLOCK *****
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The Original Code is Copyright (C) 2006 Blender Foundation.
22  * All rights reserved.
23  *
24  * The Original Code is: all of this file.
25  *
26  * Contributor(s): none yet.
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  */
30
31 #ifndef BLI_THREADS_H
32 #define BLI_THREADS_H 
33
34 /** \file BLI_threads.h
35  *  \ingroup bli
36  */
37
38 #include <pthread.h>
39
40 /* for tables, button in UI, etc */
41 #define BLENDER_MAX_THREADS             64
42
43 struct ListBase;
44
45 /* Threading API */
46
47 /*this is run once at startup*/
48 void BLI_threadapi_init(void);
49
50 void    BLI_init_threads        (struct ListBase *threadbase, void *(*do_thread)(void *), int tot);
51 int             BLI_available_threads(struct ListBase *threadbase);
52 int             BLI_available_thread_index(struct ListBase *threadbase);
53 void    BLI_insert_thread       (struct ListBase *threadbase, void *callerdata);
54 void    BLI_remove_thread       (struct ListBase *threadbase, void *callerdata);
55 void    BLI_remove_thread_index(struct ListBase *threadbase, int index);
56 void    BLI_remove_threads(struct ListBase *threadbase);
57 void    BLI_end_threads         (struct ListBase *threadbase);
58 int BLI_thread_is_main(void);
59
60 /* System Information */
61
62 int             BLI_system_thread_count(void); /* gets the number of threads the system can make use of */
63
64 /* Global Mutex Locks
65  * 
66  * One custom lock available now. can be extended. */
67
68 #define LOCK_IMAGE              0
69 #define LOCK_PREVIEW    1
70 #define LOCK_VIEWER             2
71 #define LOCK_CUSTOM1    3
72 #define LOCK_RCACHE             4
73 #define LOCK_OPENGL             5
74
75 void    BLI_lock_thread(int type);
76 void    BLI_unlock_thread(int type);
77
78 /* Mutex Lock */
79
80 typedef pthread_mutex_t ThreadMutex;
81 #define BLI_MUTEX_INITIALIZER   PTHREAD_MUTEX_INITIALIZER
82
83 void BLI_mutex_init(ThreadMutex *mutex);
84 void BLI_mutex_lock(ThreadMutex *mutex);
85 void BLI_mutex_unlock(ThreadMutex *mutex);
86 void BLI_mutex_end(ThreadMutex *mutex);
87
88 /* Read/Write Mutex Lock */
89
90 #define THREAD_LOCK_READ        1
91 #define THREAD_LOCK_WRITE       2
92
93 typedef pthread_rwlock_t ThreadRWMutex;
94
95 void BLI_rw_mutex_init(ThreadRWMutex *mutex);
96 void BLI_rw_mutex_lock(ThreadRWMutex *mutex, int mode);
97 void BLI_rw_mutex_unlock(ThreadRWMutex *mutex);
98 void BLI_rw_mutex_end(ThreadRWMutex *mutex);
99
100 /* ThreadedWorker
101  *
102  * A simple tool for dispatching work to a limited number of threads
103  * in a transparent fashion from the caller's perspective. */
104
105 struct ThreadedWorker;
106
107 /* Create a new worker supporting tot parallel threads.
108  * When new work in inserted and all threads are busy, sleep(sleep_time) before checking again
109  */
110 struct ThreadedWorker *BLI_create_worker(void *(*do_thread)(void *), int tot, int sleep_time);
111
112 /* join all working threads */
113 void BLI_end_worker(struct ThreadedWorker *worker);
114
115 /* also ends all working threads */
116 void BLI_destroy_worker(struct ThreadedWorker *worker);
117
118 /* Spawns a new work thread if possible, sleeps until one is available otherwise
119  * NOTE: inserting work is NOT thread safe, so make sure it is only done from one thread */
120 void BLI_insert_work(struct ThreadedWorker *worker, void *param);
121
122 /* ThreadWorkQueue
123  *
124  * Thread-safe work queue to push work/pointers between threads. */
125
126 typedef struct ThreadQueue ThreadQueue;
127
128 ThreadQueue *BLI_thread_queue_init(void);
129 void BLI_thread_queue_free(ThreadQueue *queue);
130
131 void BLI_thread_queue_push(ThreadQueue *queue, void *work);
132 void *BLI_thread_queue_pop(ThreadQueue *queue);
133 void *BLI_thread_queue_pop_timeout(ThreadQueue *queue, int ms);
134 int BLI_thread_queue_size(ThreadQueue *queue);
135
136 void BLI_thread_queue_nowait(ThreadQueue *queue);
137
138 #endif
139