Merging r58073 through r58111 from trunk into soc-2013-depsgraph_mt
[blender.git] / source / blender / blenlib / BLI_threads.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2006 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BLI_THREADS_H__
29 #define __BLI_THREADS_H__ 
30
31 /** \file BLI_threads.h
32  *  \ingroup bli
33  */
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 #include <pthread.h>
39
40 #ifdef __APPLE__
41 #include <libkern/OSAtomic.h>
42 #endif
43
44 /* for tables, button in UI, etc */
45 #define BLENDER_MAX_THREADS     64
46
47 struct ListBase;
48
49 /* Threading API */
50
51 /*this is run once at startup*/
52 void BLI_threadapi_init(void);
53
54 void    BLI_init_threads(struct ListBase *threadbase, void *(*do_thread)(void *), int tot);
55 int     BLI_available_threads(struct ListBase *threadbase);
56 int     BLI_available_thread_index(struct ListBase *threadbase);
57 void    BLI_insert_thread(struct ListBase *threadbase, void *callerdata);
58 void    BLI_remove_thread(struct ListBase *threadbase, void *callerdata);
59 void    BLI_remove_thread_index(struct ListBase *threadbase, int index);
60 void    BLI_remove_threads(struct ListBase *threadbase);
61 void    BLI_end_threads(struct ListBase *threadbase);
62 int     BLI_thread_is_main(void);
63
64
65 void BLI_begin_threaded_malloc(void);
66 void BLI_end_threaded_malloc(void);
67
68 /* System Information */
69
70 int     BLI_system_thread_count(void); /* gets the number of threads the system can make use of */
71 void    BLI_system_num_threads_override_set(int num);
72 int     BLI_system_num_threads_override_get(void);
73
74 /* Global Mutex Locks
75  * 
76  * One custom lock available now. can be extended. */
77
78 #define LOCK_IMAGE      0
79 #define LOCK_DRAW_IMAGE 1
80 #define LOCK_VIEWER     2
81 #define LOCK_CUSTOM1    3
82 #define LOCK_RCACHE     4
83 #define LOCK_OPENGL     5
84 #define LOCK_NODES      6
85 #define LOCK_MOVIECLIP  7
86 #define LOCK_COLORMANAGE 8
87
88 void    BLI_lock_thread(int type);
89 void    BLI_unlock_thread(int type);
90
91 /* Mutex Lock */
92
93 typedef pthread_mutex_t ThreadMutex;
94 #define BLI_MUTEX_INITIALIZER   PTHREAD_MUTEX_INITIALIZER
95
96 void BLI_mutex_init(ThreadMutex *mutex);
97 void BLI_mutex_end(ThreadMutex *mutex);
98
99 ThreadMutex *BLI_mutex_alloc(void);
100 void BLI_mutex_free(ThreadMutex *mutex);
101
102 void BLI_mutex_lock(ThreadMutex *mutex);
103 bool BLI_mutex_trylock(ThreadMutex *mutex);
104 void BLI_mutex_unlock(ThreadMutex *mutex);
105
106 /* Spin Lock */
107
108 #ifdef __APPLE__
109 typedef OSSpinLock SpinLock;
110 #else
111 typedef pthread_spinlock_t SpinLock;
112 #endif
113
114 void BLI_spin_init(SpinLock *spin);
115 void BLI_spin_lock(SpinLock *spin);
116 void BLI_spin_unlock(SpinLock *spin);
117 void BLI_spin_end(SpinLock *spin);
118
119 /* Read/Write Mutex Lock */
120
121 #define THREAD_LOCK_READ    1
122 #define THREAD_LOCK_WRITE   2
123
124 typedef pthread_rwlock_t ThreadRWMutex;
125
126 void BLI_rw_mutex_init(ThreadRWMutex *mutex);
127 void BLI_rw_mutex_end(ThreadRWMutex *mutex);
128
129 ThreadRWMutex *BLI_rw_mutex_alloc(void);
130 void BLI_rw_mutex_free(ThreadRWMutex *mutex);
131
132 void BLI_rw_mutex_lock(ThreadRWMutex *mutex, int mode);
133 void BLI_rw_mutex_unlock(ThreadRWMutex *mutex);
134
135 /* Ticket Mutex Lock
136  *
137  * This is a 'fair' mutex in that it will grant the lock to the first thread
138  * that requests it. */
139
140 typedef struct TicketMutex TicketMutex;
141
142 TicketMutex *BLI_ticket_mutex_alloc(void);
143 void BLI_ticket_mutex_free(TicketMutex *ticket);
144 void BLI_ticket_mutex_lock(TicketMutex *ticket);
145 void BLI_ticket_mutex_unlock(TicketMutex *ticket);
146
147 /* ThreadedWorker
148  *
149  * A simple tool for dispatching work to a limited number of threads
150  * in a transparent fashion from the caller's perspective. */
151
152 struct ThreadedWorker;
153
154 /* Create a new worker supporting tot parallel threads.
155  * When new work in inserted and all threads are busy, sleep(sleep_time) before checking again
156  */
157 struct ThreadedWorker *BLI_create_worker(void *(*do_thread)(void *), int tot, int sleep_time);
158
159 /* join all working threads */
160 void BLI_end_worker(struct ThreadedWorker *worker);
161
162 /* also ends all working threads */
163 void BLI_destroy_worker(struct ThreadedWorker *worker);
164
165 /* Spawns a new work thread if possible, sleeps until one is available otherwise
166  * NOTE: inserting work is NOT thread safe, so make sure it is only done from one thread */
167 void BLI_insert_work(struct ThreadedWorker *worker, void *param);
168
169 /* ThreadWorkQueue
170  *
171  * Thread-safe work queue to push work/pointers between threads. */
172
173 typedef struct ThreadQueue ThreadQueue;
174
175 ThreadQueue *BLI_thread_queue_init(void);
176 void BLI_thread_queue_free(ThreadQueue *queue);
177
178 void BLI_thread_queue_push(ThreadQueue *queue, void *work);
179 void *BLI_thread_queue_pop(ThreadQueue *queue);
180 void *BLI_thread_queue_pop_timeout(ThreadQueue *queue, int ms);
181 int BLI_thread_queue_size(ThreadQueue *queue);
182
183 void BLI_thread_queue_wait_finish(ThreadQueue *queue);
184 void BLI_thread_queue_nowait(ThreadQueue *queue);
185
186 /* Condition */
187
188 typedef pthread_cond_t ThreadCondition;
189
190 void BLI_condition_init(ThreadCondition *cond);
191 void BLI_condition_wait(ThreadCondition *cond, ThreadMutex *mutex);
192 void BLI_condition_notify_one(ThreadCondition *cond);
193 void BLI_condition_notify_all(ThreadCondition *cond);
194 void BLI_condition_end(ThreadCondition *cond);
195
196 /* Thread Local Storage */
197 #ifdef _MSC_VER
198 #  define ThreadVariable  __declspec(thread)
199 #else
200 #  define ThreadVariable  __thread
201 #endif
202
203 #ifdef __cplusplus
204 }
205 #endif
206
207 #endif
208