08e24d677f565d3ad64fc1ea081b5f91985745fb
[blender-staging.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 #include <pthread.h>
35
36 /* for tables, button in UI, etc */
37 #define BLENDER_MAX_THREADS             64
38
39 struct ListBase;
40
41 /* Threading API */
42
43 void    BLI_init_threads        (struct ListBase *threadbase, void *(*do_thread)(void *), int tot);
44 int             BLI_available_threads(struct ListBase *threadbase);
45 int             BLI_available_thread_index(struct ListBase *threadbase);
46 void    BLI_insert_thread       (struct ListBase *threadbase, void *callerdata);
47 void    BLI_remove_thread       (struct ListBase *threadbase, void *callerdata);
48 void    BLI_remove_thread_index(struct ListBase *threadbase, int index);
49 void    BLI_remove_threads(struct ListBase *threadbase);
50 void    BLI_end_threads         (struct ListBase *threadbase);
51
52 /* System Information */
53
54 int             BLI_system_thread_count(void); /* gets the number of threads the system can make use of */
55
56 /* Global Mutex Locks
57  * 
58  * One custom lock available now. can be extended. */
59
60 #define LOCK_IMAGE              0
61 #define LOCK_PREVIEW    1
62 #define LOCK_VIEWER             2
63 #define LOCK_CUSTOM1    3
64
65 void    BLI_lock_thread(int type);
66 void    BLI_unlock_thread(int type);
67
68 /* Mutex Lock */
69
70 typedef pthread_mutex_t ThreadMutex;
71
72 void BLI_mutex_init(ThreadMutex *mutex);
73 void BLI_mutex_lock(ThreadMutex *mutex);
74 void BLI_mutex_unlock(ThreadMutex *mutex);
75 void BLI_mutex_end(ThreadMutex *mutex);
76
77 /* Read/Write Mutex Lock */
78
79 #define THREAD_LOCK_READ        1
80 #define THREAD_LOCK_WRITE       2
81
82 typedef pthread_rwlock_t ThreadRWMutex;
83
84 void BLI_rw_mutex_init(ThreadRWMutex *mutex);
85 void BLI_rw_mutex_lock(ThreadRWMutex *mutex, int mode);
86 void BLI_rw_mutex_unlock(ThreadRWMutex *mutex);
87 void BLI_rw_mutex_end(ThreadRWMutex *mutex);
88
89 /* ThreadedWorker
90  *
91  * A simple tool for dispatching work to a limited number of threads
92  * in a transparent fashion from the caller's perspective. */
93
94 struct ThreadedWorker;
95
96 /* Create a new worker supporting tot parallel threads.
97  * When new work in inserted and all threads are busy, sleep(sleep_time) before checking again
98  */
99 struct ThreadedWorker *BLI_create_worker(void *(*do_thread)(void *), int tot, int sleep_time);
100
101 /* join all working threads */
102 void BLI_end_worker(struct ThreadedWorker *worker);
103
104 /* also ends all working threads */
105 void BLI_destroy_worker(struct ThreadedWorker *worker);
106
107 /* Spawns a new work thread if possible, sleeps until one is available otherwise
108  * NOTE: inserting work is NOT thread safe, so make sure it is only done from one thread */
109 void BLI_insert_work(struct ThreadedWorker *worker, void *param);
110
111 /* ThreadWorkQueue
112  *
113  * Thread-safe work queue to push work/pointers between threads. */
114
115 typedef struct ThreadQueue ThreadQueue;
116
117 ThreadQueue *BLI_thread_queue_init();
118 void BLI_thread_queue_free(ThreadQueue *queue);
119
120 void BLI_thread_queue_push(ThreadQueue *queue, void *work);
121 void *BLI_thread_queue_pop(ThreadQueue *queue);
122 void *BLI_thread_queue_pop_timeout(ThreadQueue *queue, int ms);
123 int BLI_thread_queue_size(ThreadQueue *queue);
124
125 void BLI_thread_queue_nowait(ThreadQueue *queue);
126
127 #endif
128