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(!spec_values.empty())
  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                         if(v.storage==SpirVModule::PUSH_CONSTANT)
  86                                 info.bind_point = ReflectData::PUSH_CONSTANT;
  87                         else
  88                         {
  89                                 if(v.binding>=0)
  90                                         info.bind_point = v.binding | (v.descriptor_set<<20);
  91                                 else
  92                                         info.bind_point = ReflectData::DEFAULT_BLOCK;
  93                                 n_descriptor_sets = max(n_descriptor_sets, v.descriptor_set+1);
  94                         }
  95                         info.data_size = v.struct_type->size;
  96
  97                         string prefix;
  98                         if(!v.name.empty())
  99                                 prefix = v.struct_type->name+".";
 100                         block_uniform_names.emplace_back();
 101                         collect_block_uniforms(*v.struct_type, prefix, 0, block_uniform_names.back());
 102                 }
 103                 else if(v.storage==SpirVModule::UNIFORM_CONSTANT && (v.location>=0 || v.binding>=0))
 104                 {
 105                         block_uniform_names[0].push_back(v.name);
 106                         reflect_data.uniforms.emplace_back();
 107                         ReflectData::UniformInfo &info = reflect_data.uniforms.back();
 108                         info.name = v.name;
 109                         info.tag = v.name;
 110                         info.location = v.location;
 111                         if(v.binding>=0)
 112                                 info.binding = v.binding | (v.descriptor_set<<20);
 113                         n_descriptor_sets = max(n_descriptor_sets, v.descriptor_set+1);
 114                         info.array_size = max(v.array_size, 1U);
 115                         info.type = v.type;
 116                 }
 117         }
 118
 119         sort_member(reflect_data.uniforms, &ReflectData::UniformInfo::tag);
 120
 121         if(block_uniform_names.front().empty())
 122         {
 123                 reflect_data.uniform_blocks.erase(reflect_data.uniform_blocks.begin());
 124                 block_uniform_names.erase(block_uniform_names.begin());
 125         }
 126
 127         for(unsigned i=0; i<reflect_data.uniform_blocks.size(); ++i)
 128         {
 129                 ReflectData::UniformBlockInfo &block = reflect_data.uniform_blocks[i];
 130                 for(const string &n: block_uniform_names[i])
 131                 {
 132                         // The element is already known to be present
 133                         ReflectData::UniformInfo &uni = *lower_bound_member(reflect_data.uniforms, Tag(n), &ReflectData::UniformInfo::tag);
 134                         block.uniforms.push_back(&uni);
 135                         uni.block = &block;
 136                 }
 137                 block.sort_uniforms();
 138                 block.update_layout_hash();
 139         }
 140
 141         reflect_data.n_descriptor_sets = n_descriptor_sets;
 142         reflect_data.update_layout_hash();
 143 }
 144
 145 void Program::collect_block_uniforms(const SpirVModule::Structure &strct, const string &prefix, unsigned base_offset, vector<string> &uniform_names)
 146 {
 147         for(const SpirVModule::StructMember &m: strct.members)
 148         {
 149                 unsigned offset = base_offset+m.offset;
 150                 if(m.struct_type)
 151                 {
 152                         if(m.array_size)
 153                         {
 154                                 for(unsigned j=0; j<m.array_size; ++j, offset+=m.array_stride)
 155                                         collect_block_uniforms(*m.struct_type, format("%s%s[%d].", prefix, m.name, j), offset, uniform_names);
 156                         }
 157                         else
 158                                 collect_block_uniforms(*m.struct_type, prefix+m.name+".", offset, uniform_names);
 159                 }
 160                 else
 161                 {
 162                         string name = prefix+m.name;
 163                         uniform_names.push_back(name);
 164                         reflect_data.uniforms.emplace_back();
 165                         ReflectData::UniformInfo &info = reflect_data.uniforms.back();
 166                         info.name = name;
 167                         info.tag = name;
 168                         info.offset = offset;
 169                         info.array_size = max(m.array_size, 1U);
 170                         info.array_stride = m.array_stride;
 171                         info.matrix_stride = m.matrix_stride;
 172                         info.type = m.type;
 173                 }
 174         }
 175 }
 176
 177 void Program::collect_attributes(const SpirVModule &mod)
 178 {
 179         for(const SpirVModule::EntryPoint &e: mod.get_entry_points())
 180                 if(e.stage==SpirVModule::VERTEX && e.name=="main")
 181                 {
 182                         for(const SpirVModule::Variable *v: e.globals)
 183                                 if(v->storage==SpirVModule::INPUT)
 184                                 {
 185                                         reflect_data.attributes.emplace_back();
 186                                         ReflectData::AttributeInfo &info = reflect_data.attributes.back();
 187                                         info.name = v->name;
 188                                         info.location = v->location;
 189                                         info.array_size = v->array_size;
 190                                         info.type = v->type;
 191                                 }
 192                 }
 193 }
 194
 195 void Program::collect_builtins(const SpirVModule &mod)
 196 {
 197         for(const SpirVModule::Variable &v: mod.get_variables())
 198                 if(v.storage==SpirVModule::OUTPUT && v.struct_type)
 199                         collect_builtins(*v.struct_type);
 200 }
 201
 202 void Program::collect_builtins(const SpirVModule::Structure &strct)
 203 {
 204         for(const SpirVModule::StructMember &m: strct.members)
 205                 if(m.builtin==SpirVModule::CLIP_DISTANCE)
 206                         reflect_data.n_clip_distances = m.array_size;
 207 }
 208
 209 const ReflectData::UniformBlockInfo &Program::get_uniform_block_info(const string &name) const
 210 {
 211         auto i = find_member(reflect_data.uniform_blocks, name, &ReflectData::UniformBlockInfo::name);
 212         if(i==reflect_data.uniform_blocks.end())
 213                 throw key_error(name);
 214         return *i;
 215 }
 216
 217 const ReflectData::UniformInfo &Program::get_uniform_info(const string &name) const
 218 {
 219         auto i = lower_bound_member(reflect_data.uniforms, Tag(name), &ReflectData::UniformInfo::tag);
 220         if(i==reflect_data.uniforms.end() || i->name!=name)
 221                 throw key_error(name);
 222         return *i;
 223 }
 224
 225 const ReflectData::UniformInfo &Program::get_uniform_info(Tag tag) const
 226 {
 227         auto i = lower_bound_member(reflect_data.uniforms, tag, &ReflectData::UniformInfo::tag);
 228         if(i==reflect_data.uniforms.end() || i->tag!=tag)
 229                 throw key_error(tag);
 230         return *i;
 231 }
 232
 233 int Program::get_uniform_location(const string &name) const
 234 {
 235         if(name[name.size()-1]==']')
 236                 throw invalid_argument("Program::get_uniform_location");
 237
 238         auto i = lower_bound_member(reflect_data.uniforms, Tag(name), &ReflectData::UniformInfo::tag);
 239         return i!=reflect_data.uniforms.end() && i->name==name && i->block->bind_point<0 ? i->location : -1;
 240 }
 241
 242 int Program::get_uniform_location(Tag tag) const
 243 {
 244         auto i = lower_bound_member(reflect_data.uniforms, tag, &ReflectData::UniformInfo::tag);
 245         return i!=reflect_data.uniforms.end() && i->tag==tag && i->block->bind_point<0 ? i->location : -1;
 246 }
 247
 248 int Program::get_uniform_binding(Tag tag) const
 249 {
 250         auto i = lower_bound_member(reflect_data.uniforms, tag, &ReflectData::UniformInfo::tag);
 251         return i!=reflect_data.uniforms.end() && i->tag==tag ? i->binding : -1;
 252 }
 253
 254 bool Program::uses_binding(int binding) const
 255 {
 256         auto i = lower_bound(reflect_data.used_bindings, binding);
 257         return i!=reflect_data.used_bindings.end() && *i==binding;
 258 }
 259
 260 const ReflectData::AttributeInfo &Program::get_attribute_info(const string &name) const
 261 {
 262         auto i = lower_bound_member(reflect_data.attributes, name, &ReflectData::AttributeInfo::name);
 263         if(i==reflect_data.attributes.end() || i->name!=name)
 264                 throw key_error(name);
 265         return *i;
 266 }
 267
 268 int Program::get_attribute_location(const string &name) const
 269 {
 270         if(name[name.size()-1]==']')
 271                 throw invalid_argument("Program::get_attribute_location");
 272
 273         auto i = lower_bound_member(reflect_data.attributes, name, &ReflectData::AttributeInfo::name);
 274         return i!=reflect_data.attributes.end() && i->name==name ? i->location : -1;
 275 }
 276
 277
 278 Program::Loader::Loader(Program &p, Collection &c):
 279         DataFile::CollectionObjectLoader<Program>(p, &c)
 280 {
 281         add("module", &Loader::module);
 282 }
 283
 284 void Program::Loader::module(const string &n)
 285 {
 286         map<string, int> spec_values;
 287         SpecializationLoader ldr(spec_values);
 288         load_sub_with(ldr);
 289         obj.add_stages(get_collection().get<Module>(n), spec_values);
 290 }
 291
 292
 293 DataFile::Loader::ActionMap Program::SpecializationLoader::shared_actions;
 294
 295 Program::SpecializationLoader::SpecializationLoader(map<string, int> &sv):
 296         spec_values(sv)
 297 {
 298         set_actions(shared_actions);
 299 }
 300
 301 void Program::SpecializationLoader::init_actions()
 302 {
 303         add("specialize", &SpecializationLoader::specialize_bool);
 304         add("specialize", &SpecializationLoader::specialize_int);
 305 }
 306
 307 void Program::SpecializationLoader::specialize_bool(const string &name, bool value)
 308 {
 309         spec_values[name] = value;
 310 }
 311
 312 void Program::SpecializationLoader::specialize_int(const string &name, int value)
 313 {
 314         spec_values[name] = value;
 315 }
 316
 317 } // namespace GL
 318 } // namespace Msp