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