code cleanup:
[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
60 void BLI_begin_threaded_malloc(void);
61 void BLI_end_threaded_malloc(void);
62
63 /* System Information */
64
65 int             BLI_system_thread_count(void); /* gets the number of threads the system can make use of */
66
67 /* Global Mutex Locks
68  * 
69  * One custom lock available now. can be extended. */
70
71 #define LOCK_IMAGE              0
72 #define LOCK_PREVIEW    1
73 #define LOCK_VIEWER             2
74 #define LOCK_CUSTOM1    3
75 #define LOCK_RCACHE             4
76 #define LOCK_OPENGL             5
77 #define LOCK_NODES              6
78 #define LOCK_MOVIECLIP  7
79
80 void    BLI_lock_thread(int type);
81 void    BLI_unlock_thread(int type);
82
83 /* Mutex Lock */
84
85 typedef pthread_mutex_t ThreadMutex;
86 #define BLI_MUTEX_INITIALIZER   PTHREAD_MUTEX_INITIALIZER
87
88 void BLI_mutex_init(ThreadMutex *mutex);
89 void BLI_mutex_lock(ThreadMutex *mutex);
90 void BLI_mutex_unlock(ThreadMutex *mutex);
91 void BLI_mutex_end(ThreadMutex *mutex);
92
93 /* Read/Write Mutex Lock */
94
95 #define THREAD_LOCK_READ        1
96 #define THREAD_LOCK_WRITE       2
97
98 typedef pthread_rwlock_t ThreadRWMutex;
99
100 void BLI_rw_mutex_init(ThreadRWMutex *mutex);
101 void BLI_rw_mutex_lock(ThreadRWMutex *mutex, int mode);
102 void BLI_rw_mutex_unlock(ThreadRWMutex *mutex);
103 void BLI_rw_mutex_end(ThreadRWMutex *mutex);
104
105 /* ThreadedWorker
106  *
107  * A simple tool for dispatching work to a limited number of threads
108  * in a transparent fashion from the caller's perspective. */
109
110 struct ThreadedWorker;
111
112 /* Create a new worker supporting tot parallel threads.
113  * When new work in inserted and all threads are busy, sleep(sleep_time) before checking again
114  */
115 struct ThreadedWorker *BLI_create_worker(void *(*do_thread)(void *), int tot, int sleep_time);
116
117 /* join all working threads */
118 void BLI_end_worker(struct ThreadedWorker *worker);
119
120 /* also ends all working threads */
121 void BLI_destroy_worker(struct ThreadedWorker *worker);
122
123 /* Spawns a new work thread if possible, sleeps until one is available otherwise
124  * NOTE: inserting work is NOT thread safe, so make sure it is only done from one thread */
125 void BLI_insert_work(struct ThreadedWorker *worker, void *param);
126
127 /* ThreadWorkQueue
128  *
129  * Thread-safe work queue to push work/pointers between threads. */
130
131 typedef struct ThreadQueue ThreadQueue;
132
133 ThreadQueue *BLI_thread_queue_init(void);
134 void BLI_thread_queue_free(ThreadQueue *queue);
135
136 void BLI_thread_queue_push(ThreadQueue *queue, void *work);
137 void *BLI_thread_queue_pop(ThreadQueue *queue);
138 void *BLI_thread_queue_pop_timeout(ThreadQueue *queue, int ms);
139 int BLI_thread_queue_size(ThreadQueue *queue);
140
141 void BLI_thread_queue_nowait(ThreadQueue *queue);
142
143 #endif
144