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