Fix use of uninitialized GPU context memory in release builds.
[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 #endif
84
85         GPUContext() {
86 #if TRUST_NO_ONE
87                 thread_is_used = false;
88 #endif
89                 current_fbo = 0;
90         }
91 };
92
93 #if defined(_MSC_VER) && (_MSC_VER == 1800)
94 #define thread_local __declspec(thread)
95 thread_local GPUContext *active_ctx = NULL;
96 #else
97 static thread_local GPUContext *active_ctx = NULL;
98 #endif
99
100 static void orphans_add(GPUContext *ctx, std::vector<GLuint> *orphan_list, GLuint id)
101 {
102         std::mutex *mutex = (ctx) ? &ctx->orphans_mutex : &orphans_mutex;
103
104         mutex->lock();
105         orphan_list->emplace_back(id);
106         mutex->unlock();
107 }
108
109 static void orphans_clear(GPUContext *ctx)
110 {
111         BLI_assert(ctx); /* need at least an active context */
112         BLI_assert(pthread_equal(pthread_self(), ctx->thread)); /* context has been activated by another thread! */
113
114         ctx->orphans_mutex.lock();
115         if (!ctx->orphaned_vertarray_ids.empty()) {
116                 uint orphan_len = (uint)ctx->orphaned_vertarray_ids.size();
117                 glDeleteVertexArrays(orphan_len, ctx->orphaned_vertarray_ids.data());
118                 ctx->orphaned_vertarray_ids.clear();
119         }
120         if (!ctx->orphaned_framebuffer_ids.empty()) {
121                 uint orphan_len = (uint)ctx->orphaned_framebuffer_ids.size();
122                 glDeleteFramebuffers(orphan_len, ctx->orphaned_framebuffer_ids.data());
123                 ctx->orphaned_framebuffer_ids.clear();
124         }
125
126         ctx->orphans_mutex.unlock();
127
128         orphans_mutex.lock();
129         if (!orphaned_buffer_ids.empty()) {
130                 uint orphan_len = (uint)orphaned_buffer_ids.size();
131                 glDeleteBuffers(orphan_len, orphaned_buffer_ids.data());
132                 orphaned_buffer_ids.clear();
133         }
134         if (!orphaned_texture_ids.empty()) {
135                 uint orphan_len = (uint)orphaned_texture_ids.size();
136                 glDeleteTextures(orphan_len, orphaned_texture_ids.data());
137                 orphaned_texture_ids.clear();
138         }
139         orphans_mutex.unlock();
140 }
141
142 GPUContext *GPU_context_create(void)
143 {
144         /* BLI_assert(thread_is_main()); */
145         GPUContext *ctx = new GPUContext;
146         glGenVertexArrays(1, &ctx->default_vao);
147         GPU_context_active_set(ctx);
148         return ctx;
149 }
150
151 /* to be called after GPU_context_active_set(ctx_to_destroy) */
152 void GPU_context_discard(GPUContext *ctx)
153 {
154         /* Make sure no other thread has locked it. */
155         BLI_assert(ctx == active_ctx);
156         BLI_assert(pthread_equal(pthread_self(), ctx->thread));
157         BLI_assert(ctx->orphaned_vertarray_ids.empty());
158 #ifdef DEBUG
159         /* For now don't allow GPUFrameBuffers to be reuse in another ctx. */
160         BLI_assert(ctx->framebuffers.empty());
161 #endif
162         /* delete remaining vaos */
163         while (!ctx->batches.empty()) {
164                 /* this removes the array entry */
165                 GPU_batch_vao_cache_clear(*ctx->batches.begin());
166         }
167         glDeleteVertexArrays(1, &ctx->default_vao);
168         delete ctx;
169         active_ctx = NULL;
170 }
171
172 /* ctx can be NULL */
173 void GPU_context_active_set(GPUContext *ctx)
174 {
175 #if TRUST_NO_ONE
176         if (active_ctx) {
177                 active_ctx->thread_is_used = false;
178         }
179         /* Make sure no other context is already bound to this thread. */
180         if (ctx) {
181                 /* Make sure no other thread has locked it. */
182                 assert(ctx->thread_is_used == false);
183                 ctx->thread = pthread_self();
184                 ctx->thread_is_used = true;
185         }
186 #endif
187         if (ctx) {
188                 orphans_clear(ctx);
189         }
190         active_ctx = ctx;
191 }
192
193 GPUContext *GPU_context_active_get(void)
194 {
195         return active_ctx;
196 }
197
198 GLuint GPU_vao_default(void)
199 {
200         BLI_assert(active_ctx); /* need at least an active context */
201         BLI_assert(pthread_equal(pthread_self(), active_ctx->thread)); /* context has been activated by another thread! */
202         return active_ctx->default_vao;
203 }
204
205 GLuint GPU_vao_alloc(void)
206 {
207         GLuint new_vao_id = 0;
208         orphans_clear(active_ctx);
209         glGenVertexArrays(1, &new_vao_id);
210         return new_vao_id;
211 }
212
213 GLuint GPU_fbo_alloc(void)
214 {
215         GLuint new_fbo_id = 0;
216         orphans_clear(active_ctx);
217         glGenFramebuffers(1, &new_fbo_id);
218         return new_fbo_id;
219 }
220
221 GLuint GPU_buf_alloc(void)
222 {
223         GLuint new_buffer_id = 0;
224         orphans_clear(active_ctx);
225         glGenBuffers(1, &new_buffer_id);
226         return new_buffer_id;
227 }
228
229 GLuint GPU_tex_alloc(void)
230 {
231         GLuint new_texture_id = 0;
232         orphans_clear(active_ctx);
233         glGenTextures(1, &new_texture_id);
234         return new_texture_id;
235 }
236
237 void GPU_vao_free(GLuint vao_id, GPUContext *ctx)
238 {
239         BLI_assert(ctx);
240         if (ctx == active_ctx) {
241                 glDeleteVertexArrays(1, &vao_id);
242         }
243         else {
244                 orphans_add(ctx, &ctx->orphaned_vertarray_ids, vao_id);
245         }
246 }
247
248 void GPU_fbo_free(GLuint fbo_id, GPUContext *ctx)
249 {
250         BLI_assert(ctx);
251         if (ctx == active_ctx) {
252                 glDeleteFramebuffers(1, &fbo_id);
253         }
254         else {
255                 orphans_add(ctx, &ctx->orphaned_framebuffer_ids, fbo_id);
256         }
257 }
258
259 void GPU_buf_free(GLuint buf_id)
260 {
261         if (active_ctx) {
262                 glDeleteBuffers(1, &buf_id);
263         }
264         else {
265                 orphans_add(NULL, &orphaned_buffer_ids, buf_id);
266         }
267 }
268
269 void GPU_tex_free(GLuint tex_id)
270 {
271         if (active_ctx) {
272                 glDeleteTextures(1, &tex_id);
273         }
274         else {
275                 orphans_add(NULL, &orphaned_texture_ids, tex_id);
276         }
277 }
278
279 /* GPUBatch & GPUFrameBuffer contains respectively VAO & FBO indices
280  * which are not shared across contexts. So we need to keep track of
281  * ownership. */
282
283 void gpu_context_add_batch(GPUContext *ctx, GPUBatch *batch)
284 {
285         BLI_assert(ctx);
286         ctx->orphans_mutex.lock();
287         ctx->batches.emplace(batch);
288         ctx->orphans_mutex.unlock();
289 }
290
291 void gpu_context_remove_batch(GPUContext *ctx, GPUBatch *batch)
292 {
293         BLI_assert(ctx);
294         ctx->orphans_mutex.lock();
295         ctx->batches.erase(batch);
296         ctx->orphans_mutex.unlock();
297 }
298
299 void gpu_context_add_framebuffer(GPUContext *ctx, GPUFrameBuffer *fb)
300 {
301 #ifdef DEBUG
302         BLI_assert(ctx);
303         ctx->orphans_mutex.lock();
304         ctx->framebuffers.emplace(fb);
305         ctx->orphans_mutex.unlock();
306 #else
307         UNUSED_VARS(ctx, fb);
308 #endif
309 }
310
311 void gpu_context_remove_framebuffer(GPUContext *ctx, GPUFrameBuffer *fb)
312 {
313 #ifdef DEBUG
314         BLI_assert(ctx);
315         ctx->orphans_mutex.lock();
316         ctx->framebuffers.erase(fb);
317         ctx->orphans_mutex.unlock();
318 #else
319         UNUSED_VARS(ctx, fb);
320 #endif
321 }
322
323 void gpu_context_active_framebuffer_set(GPUContext *ctx, GPUFrameBuffer *fb)
324 {
325         ctx->current_fbo = fb;
326 }
327
328 GPUFrameBuffer *gpu_context_active_framebuffer_get(GPUContext *ctx)
329 {
330         return ctx->current_fbo;
331 }