]> git.sesse.net Git - movit/blob - resource_pool.h
35b3b3b5b025d4e8c00fbcbdbe814c7548d101bb
[movit] / resource_pool.h
1 #ifndef _MOVIT_RESOURCE_POOL_H
2 #define _MOVIT_RESOURCE_POOL_H 1
3
4 // A ResourcePool governs resources that are shared between multiple EffectChains;
5 // in particular, resources that might be expensive to acquire or hold. Thus,
6 // if you have many EffectChains, hooking them up to the same ResourcePool is
7 // probably a good idea.
8 //
9 // However, hooking an EffectChain to a ResourcePool extends the OpenGL context
10 // demands (see effect_chain.h) to that of the ResourcePool; all chains must then
11 // only be used in OpenGL contexts sharing resources with each other. This is
12 // the reason why there isn't just one global ResourcePool singleton (although
13 // most practical users will just want one).
14 //
15 // Thread-safety: All functions except the constructor and destructor can be
16 // safely called from multiple threads at the same time, provided they have
17 // separate (but sharing) OpenGL contexts.
18 //
19 // Memory management (only relevant if you use multiple contexts): Some objects,
20 // like FBOs, are not shareable across contexts, and can only be deleted from
21 // the context they were created in. Thus, you will need to tell the
22 // ResourcePool explicitly if you delete a context, or they will leak (and the
23 // ResourcePool destructor will assert-fail). See clean_context().
24
25 #include <epoxy/gl.h>
26 #include <pthread.h>
27 #include <stddef.h>
28 #include <list>
29 #include <map>
30 #include <set>
31 #include <stack>
32 #include <string>
33 #include <utility>
34 #include <vector>
35
36 namespace movit {
37
38 class ResourcePool {
39 public:
40         // program_freelist_max_length is how many compiled programs that are unused to keep
41         // around after they are no longer in use (in case another EffectChain
42         // wants that exact program later). Shaders are expensive to compile and do not
43         // need a lot of resources to keep around, so this should be a reasonable number.
44         //
45         // texture_freelist_max_bytes is how many bytes of unused textures to keep around
46         // after they are no longer in use (in case a new texture of the same dimensions
47         // and format is needed). Note that the size estimate is very coarse; it does not
48         // take into account padding, metadata, and most importantly mipmapping.
49         // This means you should be prepared for actual memory usage of the freelist being
50         // twice this estimate or more.
51         ResourcePool(size_t program_freelist_max_length = 100,
52                      size_t texture_freelist_max_bytes = 100 << 20,  // 100 MB.
53                      size_t fbo_freelist_max_length = 100,  // Per context.
54                      size_t vao_freelist_max_length = 100);  // Per context.
55         ~ResourcePool();
56
57         // All remaining functions are intended for calls from EffectChain only.
58
59         // Compile the given vertex+fragment shader pair, or fetch an already
60         // compiled program from the cache if possible. Keeps ownership of the
61         // program; you must call release_glsl_program() instead of deleting it
62         // when you no longer want it.
63         //
64         // If <fragment_shader_outputs> contains more than one value, the given
65         // outputs will be bound to fragment shader output colors in the order
66         // they appear in the vector. Otherwise, output order is undefined and
67         // determined by the OpenGL driver.
68         GLuint compile_glsl_program(const std::string& vertex_shader,
69                                     const std::string& fragment_shader,
70                                     const std::vector<std::string>& frag_shader_outputs);
71         void release_glsl_program(GLuint glsl_program_num);
72
73         // Since uniforms belong to the program and not to the context,
74         // a given GLSL program number can't be used by more than one thread
75         // at a time. Thus, if two threads want to use the same program
76         // (usually because two EffectChains share them via caching),
77         // we will need to make a clone. use_glsl_program() makes such
78         // a clone if needed, calls glUseProgram(), and returns the real
79         // program number that was used; this must be given to
80         // unuse_glsl_program() to release it. unuse_glsl_program() does not
81         // actually change any OpenGL state, though.
82         GLuint use_glsl_program(GLuint glsl_program_num);
83         void unuse_glsl_program(GLuint instance_program_num);
84
85         // Allocate a 2D texture of the given internal format and dimensions,
86         // or fetch a previous used if possible. Unbinds GL_TEXTURE_2D afterwards.
87         // Keeps ownership of the texture; you must call release_2d_texture() instead
88         // of deleting it when you no longer want it.
89         GLuint create_2d_texture(GLint internal_format, GLsizei width, GLsizei height);
90         void release_2d_texture(GLuint texture_num);
91
92         // Allocate an FBO with the the given texture(s) bound as framebuffer attachment(s),
93         // or fetch a previous used if possible. Unbinds GL_FRAMEBUFFER afterwards.
94         // Keeps ownership of the FBO; you must call release_fbo() of deleting
95         // it when you no longer want it.
96         //
97         // NOTE: In principle, the FBO doesn't have a resolution or pixel format;
98         // you can bind almost whatever texture you want to it. However, changing
99         // textures can have an adverse effect on performance due to validation,
100         // in particular on NVidia cards. Also, keep in mind that FBOs are not
101         // shareable across contexts, so you must have the context that's supposed
102         // to own the FBO current when you create or release it.
103         GLuint create_fbo(GLuint texture0_num,
104                           GLuint texture1_num = 0,
105                           GLuint texture2_num = 0,
106                           GLuint texture3_num = 0);
107         void release_fbo(GLuint fbo_num);
108
109         // Create a VAO of a very specific form: All the given attribute indices
110         // are bound to start of the  given VBO and contain two-component floats.
111         // Keeps ownership of the VAO; you must call release_vec2_vao() of deleting
112         // it when you no longer want it. VAOs are not sharable across contexts.
113         //
114         // These are not cached primarily for performance, but rather to work
115         // around an NVIDIA driver bug where glVertexAttribPointer() is thread-hostile
116         // (ie., simultaneous GL work in unrelated contexts can cause the driver
117         // to free() memory that was never malloc()-ed).
118         GLuint create_vec2_vao(const std::set<GLint> &attribute_indices,
119                                GLuint vbo_num);
120         void release_vec2_vao(const GLuint vao_num);
121
122         // Informs the ResourcePool that the current context is going away soon,
123         // and that any resources held for it in the freelist should be deleted.
124         //
125         // You do not need to do this for the last context; the regular destructor
126         // will take care of that. This means that if you only ever use one
127         // thread/context, you never need to call this function.
128         void clean_context();
129
130 private:
131         // Delete the given program and both its shaders.
132         void delete_program(GLuint program_num);
133
134         // Deletes all FBOs for the given context that belong to deleted textures.
135         void cleanup_unlinked_fbos(void *context);
136
137         // Remove FBOs off the end of the freelist for <context>, until it
138         // is no more than <max_length> elements long.
139         void shrink_fbo_freelist(void *context, size_t max_length);
140
141         // Same, for VAOs.
142         void shrink_vao_freelist(void *context, size_t max_length);
143
144         // Increment the refcount, or take it off the freelist if it's zero.
145         void increment_program_refcount(GLuint program_num);
146
147         // If debugging is on, output shader to a temporary file, for easier debugging.
148         void output_debug_shader(const std::string &shader_src, const std::string &suffix);
149
150         // For a new program that's not a clone of anything, insert it into the right
151         // structures: Give it a refcount, and set up the program_masters / program_instances lists.
152         void add_master_program(GLuint program_num);
153
154         // Link the given vertex and fragment shaders into a full GLSL program.
155         // See compile_glsl_program() for explanation of <fragment_shader_outputs>.
156         static GLuint link_program(GLuint vs_obj,
157                                    GLuint fs_obj,
158                                    const std::vector<std::string>& fragment_shader_outputs);
159
160         // Protects all the other elements in the class.
161         pthread_mutex_t lock;
162
163         size_t program_freelist_max_length, texture_freelist_max_bytes, fbo_freelist_max_length, vao_freelist_max_length;
164                 
165         // A mapping from vertex/fragment shader source strings to compiled program number.
166         std::map<std::pair<std::string, std::string>, GLuint> programs;
167
168         // A mapping from compiled program number to number of current users.
169         // Once this reaches zero, the program is taken out of this map and instead
170         // put on the freelist (after which it may be deleted).
171         std::map<GLuint, int> program_refcount;
172
173         // A mapping from program number to vertex and fragment shaders.
174         // Contains everything needed to re-link the program.
175         struct ShaderSpec {
176                 GLuint vs_obj, fs_obj;
177                 std::vector<std::string> fragment_shader_outputs;
178         };
179         std::map<GLuint, ShaderSpec> program_shaders;
180
181         // For each program, a list of other programs that are exactly like it.
182         // By default, will only contain the program itself, but due to cloning
183         // (see use_glsl_program()), may grow. Programs are taken off this list
184         // while they are in use (by use_glsl_program()).
185         std::map<GLuint, std::stack<GLuint> > program_instances;
186
187         // For each program, the master program that created it
188         // (inverse of program_instances).
189         std::map<GLuint, GLuint> program_masters;
190
191         // A list of programs that are no longer in use, most recently freed first.
192         // Once this reaches <program_freelist_max_length>, the last element
193         // will be deleted.
194         std::list<GLuint> program_freelist;
195
196         struct Texture2D {
197                 GLint internal_format;
198                 GLsizei width, height;
199         };
200
201         // A mapping from texture number to format details. This is filled if the
202         // texture is given out to a client or on the freelist, but not if it is
203         // deleted from the freelist.
204         std::map<GLuint, Texture2D> texture_formats;
205
206         // A list of all textures that are release but not freed (most recently freed
207         // first), and an estimate of their current memory usage. Once
208         // <texture_freelist_bytes> goes above <texture_freelist_max_bytes>,
209         // elements are deleted off the end of the list until we are under the limit
210         // again.
211         std::list<GLuint> texture_freelist;
212         size_t texture_freelist_bytes;
213
214         static const unsigned num_fbo_attachments = 4;
215         struct FBO {
216                 GLuint fbo_num;
217                 // GL_INVALID_INDEX means associated to a texture that has since been deleted.
218                 // 0 means the output isn't bound.
219                 GLuint texture_num[num_fbo_attachments];
220         };
221
222         // For each context, a mapping from FBO number to format details. This is
223         // filled if the FBO is given out to a client or on the freelist, but
224         // not if it is deleted from the freelist.
225         std::map<std::pair<void *, GLuint>, FBO> fbo_formats;
226         typedef std::map<std::pair<void *, GLuint>, FBO>::iterator FBOFormatIterator;
227
228         // For each context, a list of all FBOs that are released but not freed
229         // (most recently freed first). Once this reaches <fbo_freelist_max_length>,
230         // the last element will be deleted.
231         //
232         // We store iterators directly into <fbo_format> for efficiency.
233         std::map<void *, std::list<FBOFormatIterator> > fbo_freelist;
234
235         // Very similar, for VAOs.
236         struct VAO {
237                 GLuint vao_num;
238                 std::set<GLint> attribute_indices;
239                 GLuint vbo_num;
240         };
241         std::map<std::pair<void *, GLuint>, VAO> vao_formats;
242         typedef std::map<std::pair<void *, GLuint>, VAO>::iterator VAOFormatIterator;
243         std::map<void *, std::list<VAOFormatIterator> > vao_freelist;
244
245         // See the caveats at the constructor.
246         static size_t estimate_texture_size(const Texture2D &texture_format);
247 };
248
249 }  // namespace movit
250
251 #endif  // !defined(_MOVIT_RESOURCE_POOL_H)