3ccfcc023daf2c83d01866159d821e859dd645cf
[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 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_init_threads(struct ListBase *threadbase, void *(*do_thread)(void *), int tot);
59 int     BLI_available_threads(struct ListBase *threadbase);
60 int     BLI_available_thread_index(struct ListBase *threadbase);
61 void    BLI_insert_thread(struct ListBase *threadbase, void *callerdata);
62 void    BLI_remove_thread(struct ListBase *threadbase, void *callerdata);
63 void    BLI_remove_thread_index(struct ListBase *threadbase, int index);
64 void    BLI_remove_threads(struct ListBase *threadbase);
65 void    BLI_end_threads(struct ListBase *threadbase);
66 int     BLI_thread_is_main(void);
67
68
69 void BLI_begin_threaded_malloc(void);
70 void BLI_end_threaded_malloc(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
92 void    BLI_lock_thread(int type);
93 void    BLI_unlock_thread(int type);
94
95 /* Mutex Lock */
96
97 typedef pthread_mutex_t ThreadMutex;
98 #define BLI_MUTEX_INITIALIZER   PTHREAD_MUTEX_INITIALIZER
99
100 void BLI_mutex_init(ThreadMutex *mutex);
101 void BLI_mutex_end(ThreadMutex *mutex);
102
103 ThreadMutex *BLI_mutex_alloc(void);
104 void BLI_mutex_free(ThreadMutex *mutex);
105
106 void BLI_mutex_lock(ThreadMutex *mutex);
107 bool BLI_mutex_trylock(ThreadMutex *mutex);
108 void BLI_mutex_unlock(ThreadMutex *mutex);
109
110 /* Spin Lock */
111
112 #ifdef __APPLE__
113 typedef OSSpinLock SpinLock;
114 #else
115 typedef pthread_spinlock_t SpinLock;
116 #endif
117
118 void BLI_spin_init(SpinLock *spin);
119 void BLI_spin_lock(SpinLock *spin);
120 void BLI_spin_unlock(SpinLock *spin);
121 void BLI_spin_end(SpinLock *spin);
122
123 /* Read/Write Mutex Lock */
124
125 #define THREAD_LOCK_READ    1
126 #define THREAD_LOCK_WRITE   2
127
128 #define BLI_RWLOCK_INITIALIZER PTHREAD_RWLOCK_INITIALIZER
129
130 typedef pthread_rwlock_t ThreadRWMutex;
131
132 void BLI_rw_mutex_init(ThreadRWMutex *mutex);
133 void BLI_rw_mutex_end(ThreadRWMutex *mutex);
134
135 ThreadRWMutex *BLI_rw_mutex_alloc(void);
136 void BLI_rw_mutex_free(ThreadRWMutex *mutex);
137
138 void BLI_rw_mutex_lock(ThreadRWMutex *mutex, int mode);
139 void BLI_rw_mutex_unlock(ThreadRWMutex *mutex);
140
141 /* Ticket Mutex Lock
142  *
143  * This is a 'fair' mutex in that it will grant the lock to the first thread
144  * that requests it. */
145
146 typedef struct TicketMutex TicketMutex;
147
148 TicketMutex *BLI_ticket_mutex_alloc(void);
149 void BLI_ticket_mutex_free(TicketMutex *ticket);
150 void BLI_ticket_mutex_lock(TicketMutex *ticket);
151 void BLI_ticket_mutex_unlock(TicketMutex *ticket);
152
153 /* Condition */
154  
155 typedef pthread_cond_t ThreadCondition;
156
157 void BLI_condition_init(ThreadCondition *cond);
158 void BLI_condition_wait(ThreadCondition *cond, ThreadMutex *mutex);
159 void BLI_condition_notify_one(ThreadCondition *cond);
160 void BLI_condition_notify_all(ThreadCondition *cond);
161 void BLI_condition_end(ThreadCondition *cond);
162
163 /* ThreadWorkQueue
164  *
165  * Thread-safe work queue to push work/pointers between threads. */
166
167 typedef struct ThreadQueue ThreadQueue;
168
169 ThreadQueue *BLI_thread_queue_init(void);
170 void BLI_thread_queue_free(ThreadQueue *queue);
171
172 void BLI_thread_queue_push(ThreadQueue *queue, void *work);
173 void *BLI_thread_queue_pop(ThreadQueue *queue);
174 void *BLI_thread_queue_pop_timeout(ThreadQueue *queue, int ms);
175 int BLI_thread_queue_size(ThreadQueue *queue);
176
177 void BLI_thread_queue_wait_finish(ThreadQueue *queue);
178 void BLI_thread_queue_nowait(ThreadQueue *queue);
179
180 #ifdef __cplusplus
181 }
182 #endif
183
184 #endif
185