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