Merge branch 'blender2.7'
[blender.git] / source / blender / gpu / intern / gpu_context.cpp
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) 2016 by Mike Erwin.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation, ClĂ©ment Foucault
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file blender/gpu/intern/gpu_context.cpp
27  *  \ingroup gpu
28  *
29  * Manage GL vertex array IDs in a thread-safe way
30  * Use these instead of glGenBuffers & its friends
31  * - alloc must be called from a thread that is bound
32  *   to the context that will be used for drawing with
33  *   this vao.
34  * - free can be called from any thread
35  */
36
37 #include "BLI_assert.h"
38 #include "BLI_utildefines.h"
39
40 #include "GPU_context.h"
41 #include "GPU_framebuffer.h"
42
43 #include "gpu_batch_private.h"
44 #include "gpu_context_private.h"
45
46 #include <vector>
47 #include <string.h>
48 #include <pthread.h>
49 #include <mutex>
50 #include <unordered_set>
51
52 #if TRUST_NO_ONE
53 #if 0
54 extern "C" {
55 extern int BLI_thread_is_main(void); /* Blender-specific function */
56 }
57
58 static bool thread_is_main() {
59         /* "main" here means the GL context's thread */
60         return BLI_thread_is_main();
61 }
62 #endif
63 #endif
64
65 static std::vector<GLuint> orphaned_buffer_ids;
66 static std::vector<GLuint> orphaned_texture_ids;
67
68 static std::mutex orphans_mutex;
69
70 struct GPUContext {
71         GLuint default_vao;
72         GPUFrameBuffer *current_fbo;
73         std::unordered_set<GPUBatch *> batches; /* Batches that have VAOs from this context */
74 #ifdef DEBUG
75         std::unordered_set<GPUFrameBuffer *> framebuffers; /* Framebuffers that have FBO from this context */
76 #endif
77         std::vector<GLuint> orphaned_vertarray_ids;
78         std::vector<GLuint> orphaned_framebuffer_ids;
79         std::mutex orphans_mutex; /* todo: try spinlock instead */
80 #if TRUST_NO_ONE
81         pthread_t thread; /* Thread on which this context is active. */
82         bool thread_is_used;
83
84         GPUContext() {
85                 thread_is_used = false;
86                 current_fbo = 0;
87         }
88 #endif
89 };
90
91 #if defined(_MSC_VER) && (_MSC_VER == 1800)
92 #define thread_local __declspec(thread)
93 thread_local GPUContext *active_ctx = NULL;
94 #else
95 static thread_local GPUContext *active_ctx = NULL;
96 #endif
97
98 static void orphans_add(GPUContext *ctx, std::vector<GLuint> *orphan_list, GLuint id)
99 {
100         std::mutex *mutex = (ctx) ? &ctx->orphans_mutex : &orphans_mutex;
101
102         mutex->lock();
103         orphan_list->emplace_back(id);
104         mutex->unlock();
105 }
106
107 static void orphans_clear(GPUContext *ctx)
108 {
109         BLI_assert(ctx); /* need at least an active context */
110         BLI_assert(pthread_equal(pthread_self(), ctx->thread)); /* context has been activated by another thread! */
111
112         ctx->orphans_mutex.lock();
113         if (!ctx->orphaned_vertarray_ids.empty()) {
114                 uint orphan_len = (uint)ctx->orphaned_vertarray_ids.size();
115                 glDeleteVertexArrays(orphan_len, ctx->orphaned_vertarray_ids.data());
116                 ctx->orphaned_vertarray_ids.clear();
117         }
118         if (!ctx->orphaned_framebuffer_ids.empty()) {
119                 uint orphan_len = (uint)ctx->orphaned_framebuffer_ids.size();
120                 glDeleteFramebuffers(orphan_len, ctx->orphaned_framebuffer_ids.data());
121                 ctx->orphaned_framebuffer_ids.clear();
122         }
123
124         ctx->orphans_mutex.unlock();
125
126         orphans_mutex.lock();
127         if (!orphaned_buffer_ids.empty()) {
128                 uint orphan_len = (uint)orphaned_buffer_ids.size();
129                 glDeleteBuffers(orphan_len, orphaned_buffer_ids.data());
130                 orphaned_buffer_ids.clear();
131         }
132         if (!orphaned_texture_ids.empty()) {
133                 uint orphan_len = (uint)orphaned_texture_ids.size();
134                 glDeleteTextures(orphan_len, orphaned_texture_ids.data());
135                 orphaned_texture_ids.clear();
136         }
137         orphans_mutex.unlock();
138 }
139
140 GPUContext *GPU_context_create(void)
141 {
142         /* BLI_assert(thread_is_main()); */
143         GPUContext *ctx = new GPUContext;
144         glGenVertexArrays(1, &ctx->default_vao);
145         GPU_context_active_set(ctx);
146         return ctx;
147 }
148
149 /* to be called after GPU_context_active_set(ctx_to_destroy) */
150 void GPU_context_discard(GPUContext *ctx)
151 {
152         /* Make sure no other thread has locked it. */
153         BLI_assert(ctx == active_ctx);
154         BLI_assert(pthread_equal(pthread_self(), ctx->thread));
155         BLI_assert(ctx->orphaned_vertarray_ids.empty());
156 #ifdef DEBUG
157         /* For now don't allow GPUFrameBuffers to be reuse in another ctx. */
158         BLI_assert(ctx->framebuffers.empty());
159 #endif
160         /* delete remaining vaos */
161         while (!ctx->batches.empty()) {
162                 /* this removes the array entry */
163                 GPU_batch_vao_cache_clear(*ctx->batches.begin());
164         }
165         glDeleteVertexArrays(1, &ctx->default_vao);
166         delete ctx;
167         active_ctx = NULL;
168 }
169
170 /* ctx can be NULL */
171 void GPU_context_active_set(GPUContext *ctx)
172 {
173 #if TRUST_NO_ONE
174         if (active_ctx) {
175                 active_ctx->thread_is_used = false;
176         }
177         /* Make sure no other context is already bound to this thread. */
178         if (ctx) {
179                 /* Make sure no other thread has locked it. */
180                 assert(ctx->thread_is_used == false);
181                 ctx->thread = pthread_self();
182                 ctx->thread_is_used = true;
183         }
184 #endif
185         if (ctx) {
186                 orphans_clear(ctx);
187         }
188         active_ctx = ctx;
189 }
190
191 GPUContext *GPU_context_active_get(void)
192 {
193         return active_ctx;
194 }
195
196 GLuint GPU_vao_default(void)
197 {
198         BLI_assert(active_ctx); /* need at least an active context */
199         BLI_assert(pthread_equal(pthread_self(), active_ctx->thread)); /* context has been activated by another thread! */
200         return active_ctx->default_vao;
201 }
202
203 GLuint GPU_vao_alloc(void)
204 {
205         GLuint new_vao_id = 0;
206         orphans_clear(active_ctx);
207         glGenVertexArrays(1, &new_vao_id);
208         return new_vao_id;
209 }
210
211 GLuint GPU_fbo_alloc(void)
212 {
213         GLuint new_fbo_id = 0;
214         orphans_clear(active_ctx);
215         glGenFramebuffers(1, &new_fbo_id);
216         return new_fbo_id;
217 }
218
219 GLuint GPU_buf_alloc(void)
220 {
221         GLuint new_buffer_id = 0;
222         orphans_clear(active_ctx);
223         glGenBuffers(1, &new_buffer_id);
224         return new_buffer_id;
225 }
226
227 GLuint GPU_tex_alloc(void)
228 {
229         GLuint new_texture_id = 0;
230         orphans_clear(active_ctx);
231         glGenTextures(1, &new_texture_id);
232         return new_texture_id;
233 }
234
235 void GPU_vao_free(GLuint vao_id, GPUContext *ctx)
236 {
237         BLI_assert(ctx);
238         if (ctx == active_ctx) {
239                 glDeleteVertexArrays(1, &vao_id);
240         }
241         else {
242                 orphans_add(ctx, &ctx->orphaned_vertarray_ids, vao_id);
243         }
244 }
245
246 void GPU_fbo_free(GLuint fbo_id, GPUContext *ctx)
247 {
248         BLI_assert(ctx);
249         if (ctx == active_ctx) {
250                 glDeleteFramebuffers(1, &fbo_id);
251         }
252         else {
253                 orphans_add(ctx, &ctx->orphaned_framebuffer_ids, fbo_id);
254         }
255 }
256
257 void GPU_buf_free(GLuint buf_id)
258 {
259         if (active_ctx) {
260                 glDeleteBuffers(1, &buf_id);
261         }
262         else {
263                 orphans_add(NULL, &orphaned_buffer_ids, buf_id);
264         }
265 }
266
267 void GPU_tex_free(GLuint tex_id)
268 {
269         if (active_ctx) {
270                 glDeleteTextures(1, &tex_id);
271         }
272         else {
273                 orphans_add(NULL, &orphaned_texture_ids, tex_id);
274         }
275 }
276
277 /* GPUBatch & GPUFrameBuffer contains respectively VAO & FBO indices
278  * which are not shared across contexts. So we need to keep track of
279  * ownership. */
280
281 void gpu_context_add_batch(GPUContext *ctx, GPUBatch *batch)
282 {
283         BLI_assert(ctx);
284         ctx->orphans_mutex.lock();
285         ctx->batches.emplace(batch);
286         ctx->orphans_mutex.unlock();
287 }
288
289 void gpu_context_remove_batch(GPUContext *ctx, GPUBatch *batch)
290 {
291         BLI_assert(ctx);
292         ctx->orphans_mutex.lock();
293         ctx->batches.erase(batch);
294         ctx->orphans_mutex.unlock();
295 }
296
297 void gpu_context_add_framebuffer(GPUContext *ctx, GPUFrameBuffer *fb)
298 {
299 #ifdef DEBUG
300         BLI_assert(ctx);
301         ctx->orphans_mutex.lock();
302         ctx->framebuffers.emplace(fb);
303         ctx->orphans_mutex.unlock();
304 #else
305         UNUSED_VARS(ctx, fb);
306 #endif
307 }
308
309 void gpu_context_remove_framebuffer(GPUContext *ctx, GPUFrameBuffer *fb)
310 {
311 #ifdef DEBUG
312         BLI_assert(ctx);
313         ctx->orphans_mutex.lock();
314         ctx->framebuffers.erase(fb);
315         ctx->orphans_mutex.unlock();
316 #else
317         UNUSED_VARS(ctx, fb);
318 #endif
319 }
320
321 void gpu_context_active_framebuffer_set(GPUContext *ctx, GPUFrameBuffer *fb)
322 {
323         ctx->current_fbo = fb;
324 }
325
326 GPUFrameBuffer *gpu_context_active_framebuffer_get(GPUContext *ctx)
327 {
328         return ctx->current_fbo;
329 }