ShaderProgramReflection.cpp 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766
  1. // Copyright (C) 2009-2020, Panagiotis Christopoulos Charitos and contributors.
  2. // All rights reserved.
  3. // Code licensed under the BSD License.
  4. // http://www.anki3d.org/LICENSE
  5. #include <anki/shader_compiler/ShaderProgramReflection.h>
  6. #include <anki/gr/utils/Functions.h>
  7. #include <SPIRV-Cross/spirv_glsl.hpp>
  8. namespace anki
  9. {
  10. /// Populates the reflection info.
  11. class SpirvReflector : public spirv_cross::Compiler
  12. {
  13. public:
  14. SpirvReflector(const U32* ir, PtrSize wordCount, const GenericMemoryPoolAllocator<U8>& tmpAlloc)
  15. : spirv_cross::Compiler(ir, wordCount)
  16. , m_alloc(tmpAlloc)
  17. {
  18. }
  19. ANKI_USE_RESULT static Error performSpirvReflection(Array<ConstWeakArray<U8>, U32(ShaderType::COUNT)> spirv,
  20. GenericMemoryPoolAllocator<U8> tmpAlloc,
  21. ShaderReflectionVisitorInterface& interface);
  22. private:
  23. class Var
  24. {
  25. public:
  26. StringAuto m_name;
  27. ShaderVariableBlockInfo m_blockInfo;
  28. ShaderVariableDataType m_type = ShaderVariableDataType::NONE;
  29. Var(const GenericMemoryPoolAllocator<U8>& alloc)
  30. : m_name(alloc)
  31. {
  32. }
  33. };
  34. class Block
  35. {
  36. public:
  37. StringAuto m_name;
  38. DynamicArrayAuto<Var> m_vars;
  39. U32 m_binding = MAX_U32;
  40. U32 m_set = MAX_U32;
  41. U32 m_size = MAX_U32;
  42. Block(const GenericMemoryPoolAllocator<U8>& alloc)
  43. : m_name(alloc)
  44. , m_vars(alloc)
  45. {
  46. }
  47. };
  48. class Opaque
  49. {
  50. public:
  51. StringAuto m_name;
  52. ShaderVariableDataType m_type = ShaderVariableDataType::NONE;
  53. U32 m_binding = MAX_U32;
  54. U32 m_set = MAX_U32;
  55. U32 m_arraySize = MAX_U32;
  56. Opaque(const GenericMemoryPoolAllocator<U8>& alloc)
  57. : m_name(alloc)
  58. {
  59. }
  60. };
  61. class Const
  62. {
  63. public:
  64. StringAuto m_name;
  65. ShaderVariableDataType m_type = ShaderVariableDataType::NONE;
  66. U32 m_constantId = MAX_U32;
  67. Const(const GenericMemoryPoolAllocator<U8>& alloc)
  68. : m_name(alloc)
  69. {
  70. }
  71. };
  72. GenericMemoryPoolAllocator<U8> m_alloc;
  73. ANKI_USE_RESULT Error spirvTypeToAnki(const spirv_cross::SPIRType& type, ShaderVariableDataType& out) const;
  74. ANKI_USE_RESULT Error blockReflection(
  75. const spirv_cross::Resource& res, Bool isStorage, DynamicArrayAuto<Block>& blocks) const;
  76. ANKI_USE_RESULT Error opaqueReflection(const spirv_cross::Resource& res, DynamicArrayAuto<Opaque>& opaques) const;
  77. ANKI_USE_RESULT Error constsReflection(DynamicArrayAuto<Const>& consts, ShaderType stage) const;
  78. ANKI_USE_RESULT Error blockVariablesReflection(spirv_cross::TypeID resourceId, DynamicArrayAuto<Var>& vars) const;
  79. ANKI_USE_RESULT Error blockVariableReflection(
  80. const spirv_cross::SPIRType& type, CString parentVariable, U32 baseOffset, DynamicArrayAuto<Var>& vars) const;
  81. ANKI_USE_RESULT Error workgroupSizes(U32& sizex, U32& sizey, U32& sizez, U32& specConstMask);
  82. };
  83. Error SpirvReflector::blockVariablesReflection(spirv_cross::TypeID resourceId, DynamicArrayAuto<Var>& vars) const
  84. {
  85. Bool found = false;
  86. Error err = Error::NONE;
  87. ir.for_each_typed_id<spirv_cross::SPIRType>([&](uint32_t, const spirv_cross::SPIRType& type) {
  88. if(err)
  89. {
  90. return;
  91. }
  92. if(type.basetype == spirv_cross::SPIRType::Struct && !type.pointer && type.array.empty())
  93. {
  94. if(type.self == resourceId)
  95. {
  96. found = true;
  97. err = blockVariableReflection(type, CString(), 0, vars);
  98. }
  99. }
  100. });
  101. ANKI_CHECK(err);
  102. if(!found)
  103. {
  104. ANKI_SHADER_COMPILER_LOGE("Can't determine the type of a block");
  105. return Error::USER_DATA;
  106. }
  107. return Error::NONE;
  108. }
  109. Error SpirvReflector::blockVariableReflection(
  110. const spirv_cross::SPIRType& type, CString parentVariable, U32 baseOffset, DynamicArrayAuto<Var>& vars) const
  111. {
  112. ANKI_ASSERT(type.basetype == spirv_cross::SPIRType::Struct);
  113. for(U32 i = 0; i < type.member_types.size(); ++i)
  114. {
  115. Var var(m_alloc);
  116. const spirv_cross::SPIRType& memberType = get<spirv_cross::SPIRType>(type.member_types[i]);
  117. // Name
  118. {
  119. const spirv_cross::Meta* meta = ir.find_meta(type.self);
  120. ANKI_ASSERT(meta);
  121. ANKI_ASSERT(i < meta->members.size());
  122. ANKI_ASSERT(!meta->members[i].alias.empty());
  123. const std::string& name = meta->members[i].alias;
  124. if(parentVariable.isEmpty())
  125. {
  126. var.m_name.create(name.c_str());
  127. }
  128. else
  129. {
  130. var.m_name.sprintf("%s.%s", parentVariable.cstr(), name.c_str());
  131. }
  132. }
  133. // Offset
  134. {
  135. auto it = ir.meta.find(type.self);
  136. ANKI_ASSERT(it != ir.meta.end());
  137. const spirv_cross::Vector<spirv_cross::Meta::Decoration>& memb = it->second.members;
  138. ANKI_ASSERT(i < memb.size());
  139. const spirv_cross::Meta::Decoration& dec = memb[i];
  140. ANKI_ASSERT(dec.decoration_flags.get(spv::DecorationOffset));
  141. var.m_blockInfo.m_offset = I16(dec.offset + baseOffset);
  142. }
  143. // Array size
  144. {
  145. if(!memberType.array.empty())
  146. {
  147. if(memberType.array.size() > 1)
  148. {
  149. ANKI_SHADER_COMPILER_LOGE("Can't support multi-dimentional arrays at the moment");
  150. return Error::USER_DATA;
  151. }
  152. const Bool notSpecConstantArraySize = memberType.array_size_literal[0];
  153. if(notSpecConstantArraySize)
  154. {
  155. // Have a min to acount for unsized arrays of SSBOs
  156. var.m_blockInfo.m_arraySize = max<I16>(I16(memberType.array[0]), 1);
  157. }
  158. else
  159. {
  160. var.m_blockInfo.m_arraySize = 1;
  161. }
  162. }
  163. else
  164. {
  165. var.m_blockInfo.m_arraySize = 1;
  166. }
  167. }
  168. // Array stride
  169. if(has_decoration(type.member_types[i], spv::DecorationArrayStride))
  170. {
  171. var.m_blockInfo.m_arrayStride = I16(get_decoration(type.member_types[i], spv::DecorationArrayStride));
  172. }
  173. // Type
  174. auto func = [&](const Array<ShaderVariableDataType, 3>& arr) {
  175. switch(memberType.basetype)
  176. {
  177. case spirv_cross::SPIRType::UInt:
  178. var.m_type = arr[0];
  179. break;
  180. case spirv_cross::SPIRType::Int:
  181. var.m_type = arr[1];
  182. break;
  183. case spirv_cross::SPIRType::Float:
  184. var.m_type = arr[2];
  185. break;
  186. default:
  187. ANKI_ASSERT(0);
  188. }
  189. };
  190. const Bool isNumeric = memberType.basetype == spirv_cross::SPIRType::UInt
  191. || memberType.basetype == spirv_cross::SPIRType::Int
  192. || memberType.basetype == spirv_cross::SPIRType::Float;
  193. if(memberType.basetype == spirv_cross::SPIRType::Struct)
  194. {
  195. if(var.m_blockInfo.m_arraySize == 1)
  196. {
  197. ANKI_CHECK(blockVariableReflection(memberType, var.m_name, var.m_blockInfo.m_offset, vars));
  198. }
  199. else
  200. {
  201. for(U32 i = 0; i < U32(var.m_blockInfo.m_arraySize); ++i)
  202. {
  203. StringAuto newName(m_alloc);
  204. newName.sprintf("%s[%u]", var.m_name.getBegin(), i);
  205. ANKI_CHECK(blockVariableReflection(
  206. memberType, newName, var.m_blockInfo.m_offset + var.m_blockInfo.m_arrayStride * i, vars));
  207. }
  208. }
  209. }
  210. else if(memberType.vecsize == 1 && memberType.columns == 1 && isNumeric)
  211. {
  212. static const Array<ShaderVariableDataType, 3> arr = {
  213. {ShaderVariableDataType::UINT, ShaderVariableDataType::INT, ShaderVariableDataType::FLOAT}};
  214. func(arr);
  215. }
  216. else if(memberType.vecsize == 2 && memberType.columns == 1 && isNumeric)
  217. {
  218. static const Array<ShaderVariableDataType, 3> arr = {
  219. {ShaderVariableDataType::UVEC2, ShaderVariableDataType::IVEC2, ShaderVariableDataType::VEC2}};
  220. func(arr);
  221. }
  222. else if(memberType.vecsize == 3 && memberType.columns == 1 && isNumeric)
  223. {
  224. static const Array<ShaderVariableDataType, 3> arr = {
  225. {ShaderVariableDataType::UVEC3, ShaderVariableDataType::IVEC3, ShaderVariableDataType::VEC3}};
  226. func(arr);
  227. }
  228. else if(memberType.vecsize == 4 && memberType.columns == 1 && isNumeric)
  229. {
  230. static const Array<ShaderVariableDataType, 3> arr = {
  231. {ShaderVariableDataType::UVEC4, ShaderVariableDataType::IVEC4, ShaderVariableDataType::VEC4}};
  232. func(arr);
  233. }
  234. else if(memberType.vecsize == 3 && memberType.columns == 3
  235. && memberType.basetype == spirv_cross::SPIRType::Float)
  236. {
  237. var.m_type = ShaderVariableDataType::MAT3;
  238. var.m_blockInfo.m_matrixStride = 16;
  239. }
  240. else if(memberType.vecsize == 4 && memberType.columns == 3
  241. && memberType.basetype == spirv_cross::SPIRType::Float)
  242. {
  243. var.m_type = ShaderVariableDataType::MAT3X4;
  244. var.m_blockInfo.m_matrixStride = 16;
  245. }
  246. else if(memberType.vecsize == 4 && memberType.columns == 4
  247. && memberType.basetype == spirv_cross::SPIRType::Float)
  248. {
  249. var.m_type = ShaderVariableDataType::MAT4;
  250. var.m_blockInfo.m_matrixStride = 16;
  251. }
  252. else
  253. {
  254. ANKI_SHADER_COMPILER_LOGE("Unhandled base type for member: %s", var.m_name.cstr());
  255. return Error::FUNCTION_FAILED;
  256. }
  257. // Store the member if it's no struct
  258. if(var.m_type != ShaderVariableDataType::NONE)
  259. {
  260. vars.emplaceBack(std::move(var));
  261. }
  262. }
  263. return Error::NONE;
  264. }
  265. Error SpirvReflector::blockReflection(
  266. const spirv_cross::Resource& res, Bool isStorage, DynamicArrayAuto<Block>& blocks) const
  267. {
  268. Block newBlock(m_alloc);
  269. const spirv_cross::SPIRType type = get_type(res.type_id);
  270. const spirv_cross::Bitset decorationMask = get_decoration_bitset(res.id);
  271. const Bool isPushConstant = get_storage_class(res.id) == spv::StorageClassPushConstant;
  272. // Name
  273. {
  274. const std::string name = (!res.name.empty()) ? res.name : to_name(res.base_type_id);
  275. if(name.length() == 0)
  276. {
  277. ANKI_SHADER_COMPILER_LOGE("Can't accept zero name length");
  278. return Error::USER_DATA;
  279. }
  280. newBlock.m_name.create(name.c_str());
  281. }
  282. // Set
  283. if(!isPushConstant)
  284. {
  285. newBlock.m_set = get_decoration(res.id, spv::DecorationDescriptorSet);
  286. if(newBlock.m_set >= MAX_DESCRIPTOR_SETS)
  287. {
  288. ANKI_SHADER_COMPILER_LOGE("Too high descriptor set: %u", newBlock.m_set);
  289. return Error::USER_DATA;
  290. }
  291. }
  292. // Binding
  293. if(!isPushConstant)
  294. {
  295. newBlock.m_binding = get_decoration(res.id, spv::DecorationBinding);
  296. }
  297. // Size
  298. newBlock.m_size = U32(get_declared_struct_size(get_type(res.base_type_id)));
  299. ANKI_ASSERT(isStorage || newBlock.m_size > 0);
  300. // Add it
  301. const Block* otherFound = nullptr;
  302. for(const Block& other : blocks)
  303. {
  304. const Bool bindingSame = other.m_set == newBlock.m_set && other.m_binding == newBlock.m_binding;
  305. const Bool nameSame = strcmp(other.m_name.getBegin(), newBlock.m_name.getBegin()) == 0;
  306. const Bool sizeSame = other.m_size == newBlock.m_size;
  307. const Bool err0 = bindingSame && (!nameSame || !sizeSame);
  308. const Bool err1 = nameSame && (!bindingSame || !sizeSame);
  309. if(err0 || err1)
  310. {
  311. ANKI_SHADER_COMPILER_LOGE("Linking error. Blocks %s and %s", other.m_name.cstr(), newBlock.m_name.cstr());
  312. return Error::USER_DATA;
  313. }
  314. if(bindingSame)
  315. {
  316. otherFound = &other;
  317. break;
  318. }
  319. }
  320. if(!otherFound)
  321. {
  322. // Get the variables
  323. ANKI_CHECK(blockVariablesReflection(res.base_type_id, newBlock.m_vars));
  324. // Store the block
  325. blocks.emplaceBack(std::move(newBlock));
  326. }
  327. #if ANKI_ASSERTS_ENABLED
  328. else
  329. {
  330. DynamicArrayAuto<Var> vars(m_alloc);
  331. ANKI_CHECK(blockVariablesReflection(res.base_type_id, vars));
  332. ANKI_ASSERT(vars.getSize() == otherFound->m_vars.getSize() && "Expecting same vars");
  333. }
  334. #endif
  335. return Error::NONE;
  336. }
  337. Error SpirvReflector::spirvTypeToAnki(const spirv_cross::SPIRType& type, ShaderVariableDataType& out) const
  338. {
  339. switch(type.basetype)
  340. {
  341. case spirv_cross::SPIRType::Image:
  342. case spirv_cross::SPIRType::SampledImage:
  343. {
  344. switch(type.image.dim)
  345. {
  346. case spv::Dim1D:
  347. out = (type.image.arrayed) ? ShaderVariableDataType::TEXTURE_1D_ARRAY : ShaderVariableDataType::TEXTURE_1D;
  348. break;
  349. case spv::Dim2D:
  350. out = (type.image.arrayed) ? ShaderVariableDataType::TEXTURE_2D_ARRAY : ShaderVariableDataType::TEXTURE_2D;
  351. break;
  352. case spv::Dim3D:
  353. out = ShaderVariableDataType::TEXTURE_3D;
  354. break;
  355. case spv::DimCube:
  356. out = (type.image.arrayed) ? ShaderVariableDataType::TEXTURE_CUBE_ARRAY
  357. : ShaderVariableDataType::TEXTURE_CUBE;
  358. break;
  359. default:
  360. ANKI_ASSERT(0);
  361. }
  362. break;
  363. }
  364. case spirv_cross::SPIRType::Sampler:
  365. out = ShaderVariableDataType::SAMPLER;
  366. break;
  367. default:
  368. ANKI_SHADER_COMPILER_LOGE("Can't determine the type");
  369. return Error::USER_DATA;
  370. }
  371. return Error::NONE;
  372. }
  373. Error SpirvReflector::opaqueReflection(const spirv_cross::Resource& res, DynamicArrayAuto<Opaque>& opaques) const
  374. {
  375. Opaque newOpaque(m_alloc);
  376. const spirv_cross::SPIRType type = get_type(res.type_id);
  377. const spirv_cross::Bitset decorationMask = get_decoration_bitset(res.id);
  378. const spirv_cross::ID fallbackId = spirv_cross::ID(res.id);
  379. // Name
  380. const std::string name = (!res.name.empty()) ? res.name : get_fallback_name(fallbackId);
  381. if(name.length() == 0)
  382. {
  383. ANKI_SHADER_COMPILER_LOGE("Can't accept zero length name");
  384. return Error::USER_DATA;
  385. }
  386. newOpaque.m_name.create(name.c_str());
  387. // Type
  388. ANKI_CHECK(spirvTypeToAnki(type, newOpaque.m_type));
  389. // Set
  390. newOpaque.m_set = get_decoration(res.id, spv::DecorationDescriptorSet);
  391. if(newOpaque.m_set >= MAX_DESCRIPTOR_SETS)
  392. {
  393. ANKI_SHADER_COMPILER_LOGE("Too high descriptor set: %u", newOpaque.m_set);
  394. return Error::USER_DATA;
  395. }
  396. // Binding
  397. newOpaque.m_binding = get_decoration(res.id, spv::DecorationBinding);
  398. // Size
  399. if(type.array.size() == 0)
  400. {
  401. newOpaque.m_arraySize = 1;
  402. }
  403. else if(type.array.size() == 1)
  404. {
  405. newOpaque.m_arraySize = type.array[0];
  406. }
  407. else
  408. {
  409. ANKI_SHADER_COMPILER_LOGE("Can't support multi-dimensional arrays: %s", newOpaque.m_name.cstr());
  410. return Error::USER_DATA;
  411. }
  412. // Add it
  413. Bool found = false;
  414. for(const Opaque& other : opaques)
  415. {
  416. const Bool bindingSame = other.m_set == newOpaque.m_set && other.m_binding == newOpaque.m_binding;
  417. const Bool nameSame = other.m_name == newOpaque.m_name;
  418. const Bool sizeSame = other.m_arraySize == newOpaque.m_arraySize;
  419. const Bool typeSame = other.m_type == newOpaque.m_type;
  420. const Bool err = nameSame && (!bindingSame || !sizeSame || !typeSame);
  421. if(err)
  422. {
  423. ANKI_SHADER_COMPILER_LOGE("Linking error");
  424. return Error::USER_DATA;
  425. }
  426. if(nameSame)
  427. {
  428. found = true;
  429. break;
  430. }
  431. }
  432. if(!found)
  433. {
  434. opaques.emplaceBack(std::move(newOpaque));
  435. }
  436. return Error::NONE;
  437. }
  438. Error SpirvReflector::constsReflection(DynamicArrayAuto<Const>& consts, ShaderType stage) const
  439. {
  440. spirv_cross::SmallVector<spirv_cross::SpecializationConstant> specConsts = get_specialization_constants();
  441. for(const spirv_cross::SpecializationConstant& c : specConsts)
  442. {
  443. Const newConst(m_alloc);
  444. const spirv_cross::SPIRConstant cc = get<spirv_cross::SPIRConstant>(c.id);
  445. const spirv_cross::SPIRType type = get<spirv_cross::SPIRType>(cc.constant_type);
  446. const std::string name = get_name(c.id);
  447. if(name.length() == 0)
  448. {
  449. ANKI_SHADER_COMPILER_LOGE("Can't accept zero legth name");
  450. return Error::USER_DATA;
  451. }
  452. newConst.m_name.create(name.c_str());
  453. newConst.m_constantId = c.constant_id;
  454. switch(type.basetype)
  455. {
  456. case spirv_cross::SPIRType::UInt:
  457. newConst.m_type = ShaderVariableDataType::UINT;
  458. break;
  459. case spirv_cross::SPIRType::Int:
  460. newConst.m_type = ShaderVariableDataType::INT;
  461. break;
  462. case spirv_cross::SPIRType::Float:
  463. newConst.m_type = ShaderVariableDataType::FLOAT;
  464. break;
  465. default:
  466. ANKI_SHADER_COMPILER_LOGE("Can't determine the type of the spec constant: %s", name.c_str());
  467. return Error::USER_DATA;
  468. }
  469. // Search for it
  470. Const* foundConst = nullptr;
  471. for(Const& other : consts)
  472. {
  473. const Bool nameSame = other.m_name == newConst.m_name;
  474. const Bool typeSame = other.m_type == newConst.m_type;
  475. const Bool idSame = other.m_constantId == newConst.m_constantId;
  476. const Bool err0 = nameSame && (!typeSame || !idSame);
  477. const Bool err1 = idSame && (!nameSame || !typeSame);
  478. if(err0 || err1)
  479. {
  480. ANKI_SHADER_COMPILER_LOGE("Linking error");
  481. return Error::USER_DATA;
  482. }
  483. if(idSame)
  484. {
  485. foundConst = &other;
  486. break;
  487. }
  488. }
  489. // Add it or update it
  490. if(foundConst == nullptr)
  491. {
  492. consts.emplaceBack(std::move(newConst));
  493. }
  494. }
  495. return Error::NONE;
  496. }
  497. Error SpirvReflector::workgroupSizes(U32& sizex, U32& sizey, U32& sizez, U32& specConstMask)
  498. {
  499. sizex = sizey = sizez = specConstMask = 0;
  500. auto entries = get_entry_points_and_stages();
  501. for(const auto& e : entries)
  502. {
  503. if(e.execution_model == spv::ExecutionModelGLCompute)
  504. {
  505. const auto& spvEntry = get_entry_point(e.name, e.execution_model);
  506. spirv_cross::SpecializationConstant specx, specy, specz;
  507. get_work_group_size_specialization_constants(specx, specy, specz);
  508. if(specx.id != spirv_cross::ID(0))
  509. {
  510. specConstMask |= 1;
  511. sizex = specx.constant_id;
  512. }
  513. else
  514. {
  515. sizex = spvEntry.workgroup_size.x;
  516. }
  517. if(specy.id != spirv_cross::ID(0))
  518. {
  519. specConstMask |= 2;
  520. sizey = specy.constant_id;
  521. }
  522. else
  523. {
  524. sizey = spvEntry.workgroup_size.y;
  525. }
  526. if(specz.id != spirv_cross::ID(0))
  527. {
  528. specConstMask |= 4;
  529. sizez = specz.constant_id;
  530. }
  531. else
  532. {
  533. sizez = spvEntry.workgroup_size.z;
  534. }
  535. }
  536. }
  537. return Error::NONE;
  538. }
  539. Error SpirvReflector::performSpirvReflection(Array<ConstWeakArray<U8>, U32(ShaderType::COUNT)> spirv,
  540. GenericMemoryPoolAllocator<U8> tmpAlloc,
  541. ShaderReflectionVisitorInterface& interface)
  542. {
  543. DynamicArrayAuto<Block> uniformBlocks(tmpAlloc);
  544. DynamicArrayAuto<Block> storageBlocks(tmpAlloc);
  545. DynamicArrayAuto<Block> pushConstantBlock(tmpAlloc);
  546. DynamicArrayAuto<Opaque> opaques(tmpAlloc);
  547. DynamicArrayAuto<Const> specializationConstants(tmpAlloc);
  548. Array<U32, 3> workgroupSizes = {};
  549. U32 workgroupSizeSpecConstMask = 0;
  550. // Perform reflection for each stage
  551. for(const ShaderType type : EnumIterable<ShaderType>())
  552. {
  553. if(spirv[type].getSize() == 0)
  554. {
  555. continue;
  556. }
  557. // Parse SPIR-V
  558. const unsigned int* spvb = reinterpret_cast<const unsigned int*>(spirv[type].getBegin());
  559. SpirvReflector compiler(spvb, spirv[type].getSizeInBytes() / sizeof(unsigned int), tmpAlloc);
  560. // Uniform blocks
  561. for(const spirv_cross::Resource& res : compiler.get_shader_resources().uniform_buffers)
  562. {
  563. ANKI_CHECK(compiler.blockReflection(res, false, uniformBlocks));
  564. }
  565. // Sorage blocks
  566. for(const spirv_cross::Resource& res : compiler.get_shader_resources().storage_buffers)
  567. {
  568. ANKI_CHECK(compiler.blockReflection(res, true, storageBlocks));
  569. }
  570. // Push constants
  571. if(compiler.get_shader_resources().push_constant_buffers.size() == 1)
  572. {
  573. ANKI_CHECK(compiler.blockReflection(
  574. compiler.get_shader_resources().push_constant_buffers[0], false, pushConstantBlock));
  575. }
  576. else if(compiler.get_shader_resources().push_constant_buffers.size() > 1)
  577. {
  578. ANKI_SHADER_COMPILER_LOGE("Expecting only a single push constants block");
  579. return Error::USER_DATA;
  580. }
  581. // Opaque
  582. for(const spirv_cross::Resource& res : compiler.get_shader_resources().separate_images)
  583. {
  584. ANKI_CHECK(compiler.opaqueReflection(res, opaques));
  585. }
  586. for(const spirv_cross::Resource& res : compiler.get_shader_resources().storage_images)
  587. {
  588. ANKI_CHECK(compiler.opaqueReflection(res, opaques));
  589. }
  590. for(const spirv_cross::Resource& res : compiler.get_shader_resources().separate_samplers)
  591. {
  592. ANKI_CHECK(compiler.opaqueReflection(res, opaques));
  593. }
  594. // Spec consts
  595. ANKI_CHECK(compiler.constsReflection(specializationConstants, type));
  596. if(type == ShaderType::COMPUTE)
  597. {
  598. ANKI_CHECK(compiler.workgroupSizes(
  599. workgroupSizes[0], workgroupSizes[1], workgroupSizes[2], workgroupSizeSpecConstMask));
  600. }
  601. }
  602. // Inform through the interface
  603. ANKI_CHECK(interface.setCounts(uniformBlocks.getSize(),
  604. storageBlocks.getSize(),
  605. opaques.getSize(),
  606. pushConstantBlock.getSize() == 1,
  607. specializationConstants.getSize()));
  608. for(U32 i = 0; i < uniformBlocks.getSize(); ++i)
  609. {
  610. const Block& block = uniformBlocks[i];
  611. ANKI_CHECK(interface.visitUniformBlock(
  612. i, block.m_name, block.m_set, block.m_binding, block.m_size, block.m_vars.getSize()));
  613. for(U32 j = 0; j < block.m_vars.getSize(); ++j)
  614. {
  615. const Var& var = block.m_vars[j];
  616. ANKI_CHECK(interface.visitUniformVariable(i, j, var.m_name, var.m_type, var.m_blockInfo));
  617. }
  618. }
  619. for(U32 i = 0; i < storageBlocks.getSize(); ++i)
  620. {
  621. const Block& block = storageBlocks[i];
  622. ANKI_CHECK(interface.visitStorageBlock(
  623. i, block.m_name, block.m_set, block.m_binding, block.m_size, block.m_vars.getSize()));
  624. for(U32 j = 0; j < block.m_vars.getSize(); ++j)
  625. {
  626. const Var& var = block.m_vars[j];
  627. ANKI_CHECK(interface.visitStorageVariable(i, j, var.m_name, var.m_type, var.m_blockInfo));
  628. }
  629. }
  630. if(pushConstantBlock.getSize() == 1)
  631. {
  632. ANKI_CHECK(interface.visitPushConstantsBlock(
  633. pushConstantBlock[0].m_name, pushConstantBlock[0].m_size, pushConstantBlock[0].m_vars.getSize()));
  634. for(U32 j = 0; j < pushConstantBlock[0].m_vars.getSize(); ++j)
  635. {
  636. const Var& var = pushConstantBlock[0].m_vars[j];
  637. ANKI_CHECK(interface.visitPushConstant(j, var.m_name, var.m_type, var.m_blockInfo));
  638. }
  639. }
  640. for(U32 i = 0; i < opaques.getSize(); ++i)
  641. {
  642. const Opaque& o = opaques[i];
  643. ANKI_CHECK(interface.visitOpaque(i, o.m_name, o.m_type, o.m_set, o.m_binding, o.m_arraySize));
  644. }
  645. for(U32 i = 0; i < specializationConstants.getSize(); ++i)
  646. {
  647. const Const& c = specializationConstants[i];
  648. ANKI_CHECK(interface.visitConstant(i, c.m_name, c.m_type, c.m_constantId));
  649. }
  650. if(spirv[ShaderType::COMPUTE].getSize())
  651. {
  652. ANKI_CHECK(interface.setWorkgroupSizes(
  653. workgroupSizes[0], workgroupSizes[1], workgroupSizes[2], workgroupSizeSpecConstMask));
  654. }
  655. return Error::NONE;
  656. }
  657. Error performSpirvReflection(Array<ConstWeakArray<U8>, U32(ShaderType::COUNT)> spirv,
  658. GenericMemoryPoolAllocator<U8> tmpAlloc,
  659. ShaderReflectionVisitorInterface& interface)
  660. {
  661. return SpirvReflector::performSpirvReflection(spirv, tmpAlloc, interface);
  662. }
  663. } // end namespace anki