]> git.tdb.fi Git - libs/gl.git/blob - source/core/program.cpp
Recognize push constant blocks when reflecting SPIR-V modules
[libs/gl.git] / source / core / program.cpp
1 #include <msp/core/algorithm.h>
2 #include "error.h"
3 #include "program.h"
4
5 using namespace std;
6
7 namespace Msp {
8 namespace GL {
9
10 Program::Program(const Module &mod, const map<string, int> &spec_values)
11 {
12         add_stages(mod, spec_values);
13 }
14
15 void Program::add_stages(const Module &mod, const map<string, int> &spec_values)
16 {
17         if(has_stages())
18                 throw invalid_operation("Program::add_stages");
19
20         reflect_data = ReflectData();
21
22         TransientData transient;
23         switch(mod.get_format())
24         {
25         case Module::GLSL:
26                 add_glsl_stages(static_cast<const GlslModule &>(mod), spec_values, transient);
27                 break;
28         case Module::SPIR_V:
29                 add_spirv_stages(static_cast<const SpirVModule &>(mod), spec_values);
30                 break;
31         default:
32                 throw invalid_argument("Program::add_stages");
33         }
34
35         finalize(mod, transient);
36
37         if(mod.get_format()==Module::SPIR_V)
38         {
39                 collect_uniforms(static_cast<const SpirVModule &>(mod));
40                 collect_attributes(static_cast<const SpirVModule &>(mod));
41                 collect_builtins(static_cast<const SpirVModule &>(mod));
42         }
43
44         finalize_uniforms();
45
46         for(const ReflectData::UniformInfo &u: reflect_data.uniforms)
47                 require_type(u.type);
48         for(const ReflectData::AttributeInfo &a: reflect_data.attributes)
49                 require_type(a.type);
50 }
51
52 void Program::collect_uniforms(const SpirVModule &mod)
53 {
54         // Prepare the default block
55         reflect_data.uniform_blocks.push_back(ReflectData::UniformBlockInfo());
56         vector<vector<string> > block_uniform_names(1);
57
58         for(const SpirVModule::Variable &v: mod.get_variables())
59         {
60                 if((v.storage==SpirVModule::UNIFORM || v.storage==SpirVModule::PUSH_CONSTANT) && v.struct_type)
61                 {
62                         reflect_data.uniform_blocks.push_back(ReflectData::UniformBlockInfo());
63                         ReflectData::UniformBlockInfo &info = reflect_data.uniform_blocks.back();
64                         info.name = v.struct_type->name;
65                         if(v.storage==SpirVModule::PUSH_CONSTANT)
66                                 info.bind_point = ReflectData::PUSH_CONSTANT;
67                         else
68                         {
69                                 info.bind_point = v.binding;
70                                 info.descriptor_set = v.descriptor_set;
71                         }
72                         info.data_size = v.struct_type->size;
73
74                         string prefix;
75                         if(!v.name.empty())
76                                 prefix = v.struct_type->name+".";
77                         block_uniform_names.push_back(vector<string>());
78                         collect_block_uniforms(*v.struct_type, prefix, 0, block_uniform_names.back());
79                 }
80                 else if(v.storage==SpirVModule::UNIFORM_CONSTANT && v.location>=0)
81                 {
82                         block_uniform_names[0].push_back(v.name);
83                         reflect_data.uniforms.push_back(ReflectData::UniformInfo());
84                         ReflectData::UniformInfo &info = reflect_data.uniforms.back();
85                         info.name = v.name;
86                         info.tag = v.name;
87                         info.location = v.location;
88                         info.binding = v.binding;
89                         info.descriptor_set = v.descriptor_set;
90                         info.array_size = max(v.array_size, 1U);
91                         info.type = v.type;
92                 }
93         }
94
95         sort_member(reflect_data.uniforms, &ReflectData::UniformInfo::tag);
96
97         for(unsigned i=0; i<reflect_data.uniform_blocks.size(); ++i)
98         {
99                 ReflectData::UniformBlockInfo &block = reflect_data.uniform_blocks[i];
100                 for(const string &n: block_uniform_names[i])
101                 {
102                         // The element is already known to be present
103                         ReflectData::UniformInfo &uni = *lower_bound_member(reflect_data.uniforms, Tag(n), &ReflectData::UniformInfo::tag);
104                         block.uniforms.push_back(&uni);
105                         uni.block = &block;
106                 }
107                 block.sort_uniforms();
108                 block.update_layout_hash();
109         }
110
111         reflect_data.update_layout_hash();
112 }
113
114 void Program::collect_block_uniforms(const SpirVModule::Structure &strct, const string &prefix, unsigned base_offset, vector<string> &uniform_names)
115 {
116         for(const SpirVModule::StructMember &m: strct.members)
117         {
118                 unsigned offset = base_offset+m.offset;
119                 if(m.struct_type)
120                 {
121                         if(m.array_size)
122                         {
123                                 for(unsigned j=0; j<m.array_size; ++j, offset+=m.array_stride)
124                                         collect_block_uniforms(*m.struct_type, format("%s%s[%d].", prefix, m.name, j), offset, uniform_names);
125                         }
126                         else
127                                 collect_block_uniforms(*m.struct_type, prefix+m.name+".", offset, uniform_names);
128                 }
129                 else
130                 {
131                         string name = prefix+m.name;
132                         uniform_names.push_back(name);
133                         reflect_data.uniforms.push_back(ReflectData::UniformInfo());
134                         ReflectData::UniformInfo &info = reflect_data.uniforms.back();
135                         info.name = name;
136                         info.tag = name;
137                         info.offset = offset;
138                         info.array_size = max(m.array_size, 1U);
139                         info.array_stride = m.array_stride;
140                         info.matrix_stride = m.matrix_stride;
141                         info.type = m.type;
142                 }
143         }
144 }
145
146 void Program::collect_attributes(const SpirVModule &mod)
147 {
148         for(const SpirVModule::EntryPoint &e: mod.get_entry_points())
149                 if(e.stage==SpirVModule::VERTEX && e.name=="main")
150                 {
151                         for(const SpirVModule::Variable *v: e.globals)
152                                 if(v->storage==SpirVModule::INPUT)
153                                 {
154                                         reflect_data.attributes.push_back(ReflectData::AttributeInfo());
155                                         ReflectData::AttributeInfo &info = reflect_data.attributes.back();
156                                         info.name = v->name;
157                                         info.location = v->location;
158                                         info.array_size = v->array_size;
159                                         info.type = v->type;
160                                 }
161                 }
162 }
163
164 void Program::collect_builtins(const SpirVModule &mod)
165 {
166         for(const SpirVModule::Variable &v: mod.get_variables())
167                 if(v.storage==SpirVModule::OUTPUT && v.struct_type)
168                         collect_builtins(*v.struct_type);
169 }
170
171 void Program::collect_builtins(const SpirVModule::Structure &strct)
172 {
173         for(const SpirVModule::StructMember &m: strct.members)
174                 if(m.builtin==SpirVModule::CLIP_DISTANCE)
175                         reflect_data.n_clip_distances = m.array_size;
176 }
177
178 const ReflectData::UniformBlockInfo &Program::get_uniform_block_info(const string &name) const
179 {
180         auto i = find_member(reflect_data.uniform_blocks, name, &ReflectData::UniformBlockInfo::name);
181         if(i==reflect_data.uniform_blocks.end())
182                 throw key_error(name);
183         return *i;
184 }
185
186 const ReflectData::UniformInfo &Program::get_uniform_info(const string &name) const
187 {
188         auto i = lower_bound_member(reflect_data.uniforms, Tag(name), &ReflectData::UniformInfo::tag);
189         if(i==reflect_data.uniforms.end() || i->name!=name)
190                 throw key_error(name);
191         return *i;
192 }
193
194 const ReflectData::UniformInfo &Program::get_uniform_info(Tag tag) const
195 {
196         auto i = lower_bound_member(reflect_data.uniforms, tag, &ReflectData::UniformInfo::tag);
197         if(i==reflect_data.uniforms.end() || i->tag!=tag)
198                 throw key_error(tag);
199         return *i;
200 }
201
202 int Program::get_uniform_location(const string &name) const
203 {
204         if(name[name.size()-1]==']')
205                 throw invalid_argument("Program::get_uniform_location");
206
207         auto i = lower_bound_member(reflect_data.uniforms, Tag(name), &ReflectData::UniformInfo::tag);
208         return i!=reflect_data.uniforms.end() && i->name==name && i->block->bind_point<0 ? i->location : -1;
209 }
210
211 int Program::get_uniform_location(Tag tag) const
212 {
213         auto i = lower_bound_member(reflect_data.uniforms, tag, &ReflectData::UniformInfo::tag);
214         return i!=reflect_data.uniforms.end() && i->tag==tag && i->block->bind_point<0 ? i->location : -1;
215 }
216
217 int Program::get_uniform_binding(Tag tag) const
218 {
219         auto i = lower_bound_member(reflect_data.uniforms, tag, &ReflectData::UniformInfo::tag);
220         return i!=reflect_data.uniforms.end() && i->tag==tag ? i->binding : -1;
221 }
222
223 const ReflectData::AttributeInfo &Program::get_attribute_info(const string &name) const
224 {
225         auto i = lower_bound_member(reflect_data.attributes, name, &ReflectData::AttributeInfo::name);
226         if(i==reflect_data.attributes.end() || i->name!=name)
227                 throw key_error(name);
228         return *i;
229 }
230
231 int Program::get_attribute_location(const string &name) const
232 {
233         if(name[name.size()-1]==']')
234                 throw invalid_argument("Program::get_attribute_location");
235
236         auto i = lower_bound_member(reflect_data.attributes, name, &ReflectData::AttributeInfo::name);
237         return i!=reflect_data.attributes.end() && i->name==name ? i->location : -1;
238 }
239
240
241 Program::Loader::Loader(Program &p, Collection &c):
242         DataFile::CollectionObjectLoader<Program>(p, &c)
243 {
244         add("module", &Loader::module);
245 }
246
247 void Program::Loader::module(const string &n)
248 {
249         map<string, int> spec_values;
250         SpecializationLoader ldr(spec_values);
251         load_sub_with(ldr);
252         obj.add_stages(get_collection().get<Module>(n), spec_values);
253 }
254
255
256 DataFile::Loader::ActionMap Program::SpecializationLoader::shared_actions;
257
258 Program::SpecializationLoader::SpecializationLoader(map<string, int> &sv):
259         spec_values(sv)
260 {
261         set_actions(shared_actions);
262 }
263
264 void Program::SpecializationLoader::init_actions()
265 {
266         add("specialize", &SpecializationLoader::specialize_bool);
267         add("specialize", &SpecializationLoader::specialize_int);
268 }
269
270 void Program::SpecializationLoader::specialize_bool(const string &name, bool value)
271 {
272         spec_values[name] = value;
273 }
274
275 void Program::SpecializationLoader::specialize_int(const string &name, int value)
276 {
277         spec_values[name] = value;
278 }
279
280 } // namespace GL
281 } // namespace Msp