ShaderProgramReflection.cpp 21 KB

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