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