ShaderProgramReflection.cpp 21 KB

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