Merge branch 'blender2.7'
[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     1024
46
47 struct ListBase;
48 struct TaskScheduler;
49
50 /* Threading API */
51
52 /*this is run once at startup*/
53 void BLI_threadapi_init(void);
54 void BLI_threadapi_exit(void);
55
56 struct TaskScheduler *BLI_task_scheduler_get(void);
57
58 void    BLI_threadpool_init(struct ListBase *threadbase, void *(*do_thread)(void *), int tot);
59 int     BLI_available_threads(struct ListBase *threadbase);
60 int     BLI_threadpool_available_thread_index(struct ListBase *threadbase);
61 void    BLI_threadpool_insert(struct ListBase *threadbase, void *callerdata);
62 void    BLI_threadpool_remove(struct ListBase *threadbase, void *callerdata);
63 void    BLI_threadpool_remove_index(struct ListBase *threadbase, int index);
64 void    BLI_threadpool_clear(struct ListBase *threadbase);
65 void    BLI_threadpool_end(struct ListBase *threadbase);
66 int     BLI_thread_is_main(void);
67
68
69 void BLI_threaded_malloc_begin(void);
70 void BLI_threaded_malloc_end(void);
71
72 /* System Information */
73
74 int     BLI_system_thread_count(void); /* gets the number of threads the system can make use of */
75 void    BLI_system_num_threads_override_set(int num);
76 int     BLI_system_num_threads_override_get(void);
77
78 /* Global Mutex Locks
79  *
80  * One custom lock available now. can be extended. */
81
82 #define LOCK_IMAGE      0
83 #define LOCK_DRAW_IMAGE 1
84 #define LOCK_VIEWER     2
85 #define LOCK_CUSTOM1    3
86 #define LOCK_RCACHE     4
87 #define LOCK_OPENGL     5
88 #define LOCK_NODES      6
89 #define LOCK_MOVIECLIP  7
90 #define LOCK_COLORMANAGE 8
91 #define LOCK_FFTW       9
92 #define LOCK_VIEW3D     10
93
94 void    BLI_thread_lock(int type);
95 void    BLI_thread_unlock(int type);
96
97 /* Mutex Lock */
98
99 typedef pthread_mutex_t ThreadMutex;
100 #define BLI_MUTEX_INITIALIZER   PTHREAD_MUTEX_INITIALIZER
101
102 void BLI_mutex_init(ThreadMutex *mutex);
103 void BLI_mutex_end(ThreadMutex *mutex);
104
105 ThreadMutex *BLI_mutex_alloc(void);
106 void BLI_mutex_free(ThreadMutex *mutex);
107
108 void BLI_mutex_lock(ThreadMutex *mutex);
109 bool BLI_mutex_trylock(ThreadMutex *mutex);
110 void BLI_mutex_unlock(ThreadMutex *mutex);
111
112 /* Spin Lock */
113
114 #if defined(__APPLE__)
115 typedef OSSpinLock SpinLock;
116 #elif defined(_MSC_VER)
117 typedef volatile int SpinLock;
118 #else
119 typedef pthread_spinlock_t SpinLock;
120 #endif
121
122 void BLI_spin_init(SpinLock *spin);
123 void BLI_spin_lock(SpinLock *spin);
124 void BLI_spin_unlock(SpinLock *spin);
125 void BLI_spin_end(SpinLock *spin);
126
127 /* Read/Write Mutex Lock */
128
129 #define THREAD_LOCK_READ    1
130 #define THREAD_LOCK_WRITE   2
131
132 #define BLI_RWLOCK_INITIALIZER PTHREAD_RWLOCK_INITIALIZER
133
134 typedef pthread_rwlock_t ThreadRWMutex;
135
136 void BLI_rw_mutex_init(ThreadRWMutex *mutex);
137 void BLI_rw_mutex_end(ThreadRWMutex *mutex);
138
139 ThreadRWMutex *BLI_rw_mutex_alloc(void);
140 void BLI_rw_mutex_free(ThreadRWMutex *mutex);
141
142 void BLI_rw_mutex_lock(ThreadRWMutex *mutex, int mode);
143 void BLI_rw_mutex_unlock(ThreadRWMutex *mutex);
144
145 /* Ticket Mutex Lock
146  *
147  * This is a 'fair' mutex in that it will grant the lock to the first thread
148  * that requests it. */
149
150 typedef struct TicketMutex TicketMutex;
151
152 TicketMutex *BLI_ticket_mutex_alloc(void);
153 void BLI_ticket_mutex_free(TicketMutex *ticket);
154 void BLI_ticket_mutex_lock(TicketMutex *ticket);
155 void BLI_ticket_mutex_unlock(TicketMutex *ticket);
156
157 /* Condition */
158
159 typedef pthread_cond_t ThreadCondition;
160
161 void BLI_condition_init(ThreadCondition *cond);
162 void BLI_condition_wait(ThreadCondition *cond, ThreadMutex *mutex);
163 void BLI_condition_wait_global_mutex(ThreadCondition *cond, const int type);
164 void BLI_condition_notify_one(ThreadCondition *cond);
165 void BLI_condition_notify_all(ThreadCondition *cond);
166 void BLI_condition_end(ThreadCondition *cond);
167
168 /* ThreadWorkQueue
169  *
170  * Thread-safe work queue to push work/pointers between threads. */
171
172 typedef struct ThreadQueue ThreadQueue;
173
174 ThreadQueue *BLI_thread_queue_init(void);
175 void BLI_thread_queue_free(ThreadQueue *queue);
176
177 void BLI_thread_queue_push(ThreadQueue *queue, void *work);
178 void *BLI_thread_queue_pop(ThreadQueue *queue);
179 void *BLI_thread_queue_pop_timeout(ThreadQueue *queue, int ms);
180 int BLI_thread_queue_len(ThreadQueue *queue);
181 bool BLI_thread_queue_is_empty(ThreadQueue *queue);
182
183 void BLI_thread_queue_wait_finish(ThreadQueue *queue);
184 void BLI_thread_queue_nowait(ThreadQueue *queue);
185
186
187 /* Thread local storage */
188
189 #if defined(__APPLE__)
190 #  define ThreadLocal(type) pthread_key_t
191 #  define BLI_thread_local_create(name) pthread_key_create(&name, NULL)
192 #  define BLI_thread_local_delete(name) pthread_key_delete(name)
193 #  define BLI_thread_local_get(name) pthread_getspecific(name)
194 #  define BLI_thread_local_set(name, value) pthread_setspecific(name, value)
195 #else  /* defined(__APPLE__) */
196 #  ifdef _MSC_VER
197 #    define ThreadLocal(type) __declspec(thread) type
198 #  else
199 #    define ThreadLocal(type) __thread type
200 #  endif
201 #  define BLI_thread_local_create(name)
202 #  define BLI_thread_local_delete(name)
203 #  define BLI_thread_local_get(name) name
204 #  define BLI_thread_local_set(name, value) name = value
205 #endif  /* defined(__APPLE__) */
206
207 /* **** Special functions to help performance on crazy NUMA setups. **** */
208
209 /* Make sure process/thread is using NUMA node with fast memory access. */
210 void BLI_thread_put_process_on_fast_node(void);
211 void BLI_thread_put_thread_on_fast_node(void);
212
213 #ifdef __cplusplus
214 }
215 #endif
216
217 #endif