shaderc_spirv.cpp 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864
  1. /*
  2. * Copyright 2011-2021 Branimir Karadzic. All rights reserved.
  3. * License: https://github.com/bkaradzic/bgfx#license-bsd-2-clause
  4. */
  5. #include "shaderc.h"
  6. BX_PRAGMA_DIAGNOSTIC_PUSH()
  7. BX_PRAGMA_DIAGNOSTIC_IGNORED_MSVC(4100) // error C4100: 'inclusionDepth' : unreferenced formal parameter
  8. BX_PRAGMA_DIAGNOSTIC_IGNORED_MSVC(4265) // error C4265: 'spv::spirvbin_t': class has virtual functions, but destructor is not virtual
  9. BX_PRAGMA_DIAGNOSTIC_IGNORED_CLANG_GCC("-Wattributes") // warning: attribute ignored
  10. BX_PRAGMA_DIAGNOSTIC_IGNORED_CLANG_GCC("-Wdeprecated-declarations") // warning: ‘MSLVertexAttr’ is deprecated
  11. BX_PRAGMA_DIAGNOSTIC_IGNORED_CLANG_GCC("-Wtype-limits") // warning: comparison of unsigned expression in ‘< 0’ is always false
  12. BX_PRAGMA_DIAGNOSTIC_IGNORED_CLANG_GCC("-Wshadow") // warning: declaration of 'userData' shadows a member of 'glslang::TShader::Includer::IncludeResult'
  13. #define ENABLE_OPT 1
  14. #include <ShaderLang.h>
  15. #include <ResourceLimits.h>
  16. #include <SPIRV/SPVRemapper.h>
  17. #include <SPIRV/GlslangToSpv.h>
  18. #include <webgpu/webgpu_cpp.h>
  19. #define SPIRV_CROSS_EXCEPTIONS_TO_ASSERTIONS
  20. #include <spirv_msl.hpp>
  21. #include <spirv_reflect.hpp>
  22. #include <spirv-tools/optimizer.hpp>
  23. BX_PRAGMA_DIAGNOSTIC_POP()
  24. namespace bgfx
  25. {
  26. static bx::DefaultAllocator s_allocator;
  27. bx::AllocatorI* g_allocator = &s_allocator;
  28. struct TinyStlAllocator
  29. {
  30. static void* static_allocate(size_t _bytes);
  31. static void static_deallocate(void* _ptr, size_t /*_bytes*/);
  32. };
  33. void* TinyStlAllocator::static_allocate(size_t _bytes)
  34. {
  35. return BX_ALLOC(g_allocator, _bytes);
  36. }
  37. void TinyStlAllocator::static_deallocate(void* _ptr, size_t /*_bytes*/)
  38. {
  39. if (NULL != _ptr)
  40. {
  41. BX_FREE(g_allocator, _ptr);
  42. }
  43. }
  44. } // namespace bgfx
  45. #define TINYSTL_ALLOCATOR bgfx::TinyStlAllocator
  46. #include <tinystl/allocator.h>
  47. #include <tinystl/string.h>
  48. #include <tinystl/unordered_map.h>
  49. #include <tinystl/vector.h>
  50. namespace stl = tinystl;
  51. #include "../../src/shader.h"
  52. #include "../../src/shader_spirv.h"
  53. #include "../../3rdparty/khronos/vulkan-local/vulkan.h"
  54. namespace bgfx { namespace spirv
  55. {
  56. const TBuiltInResource resourceLimits =
  57. {
  58. 32, // MaxLights
  59. 6, // MaxClipPlanes
  60. 32, // MaxTextureUnits
  61. 32, // MaxTextureCoords
  62. 64, // MaxVertexAttribs
  63. 4096, // MaxVertexUniformComponents
  64. 64, // MaxVaryingFloats
  65. 32, // MaxVertexTextureImageUnits
  66. 80, // MaxCombinedTextureImageUnits
  67. 32, // MaxTextureImageUnits
  68. 4096, // MaxFragmentUniformComponents
  69. 32, // MaxDrawBuffers
  70. 128, // MaxVertexUniformVectors
  71. 8, // MaxVaryingVectors
  72. 16, // MaxFragmentUniformVectors
  73. 16, // MaxVertexOutputVectors
  74. 15, // MaxFragmentInputVectors
  75. -8, // MinProgramTexelOffset
  76. 7, // MaxProgramTexelOffset
  77. 8, // MaxClipDistances
  78. 65535, // MaxComputeWorkGroupCountX
  79. 65535, // MaxComputeWorkGroupCountY
  80. 65535, // MaxComputeWorkGroupCountZ
  81. 1024, // MaxComputeWorkGroupSizeX
  82. 1024, // MaxComputeWorkGroupSizeY
  83. 64, // MaxComputeWorkGroupSizeZ
  84. 1024, // MaxComputeUniformComponents
  85. 16, // MaxComputeTextureImageUnits
  86. 8, // MaxComputeImageUniforms
  87. 8, // MaxComputeAtomicCounters
  88. 1, // MaxComputeAtomicCounterBuffers
  89. 60, // MaxVaryingComponents
  90. 64, // MaxVertexOutputComponents
  91. 64, // MaxGeometryInputComponents
  92. 128, // MaxGeometryOutputComponents
  93. 128, // MaxFragmentInputComponents
  94. 8, // MaxImageUnits
  95. 8, // MaxCombinedImageUnitsAndFragmentOutputs
  96. 8, // MaxCombinedShaderOutputResources
  97. 0, // MaxImageSamples
  98. 0, // MaxVertexImageUniforms
  99. 0, // MaxTessControlImageUniforms
  100. 0, // MaxTessEvaluationImageUniforms
  101. 0, // MaxGeometryImageUniforms
  102. 8, // MaxFragmentImageUniforms
  103. 8, // MaxCombinedImageUniforms
  104. 16, // MaxGeometryTextureImageUnits
  105. 256, // MaxGeometryOutputVertices
  106. 1024, // MaxGeometryTotalOutputComponents
  107. 1024, // MaxGeometryUniformComponents
  108. 64, // MaxGeometryVaryingComponents
  109. 128, // MaxTessControlInputComponents
  110. 128, // MaxTessControlOutputComponents
  111. 16, // MaxTessControlTextureImageUnits
  112. 1024, // MaxTessControlUniformComponents
  113. 4096, // MaxTessControlTotalOutputComponents
  114. 128, // MaxTessEvaluationInputComponents
  115. 128, // MaxTessEvaluationOutputComponents
  116. 16, // MaxTessEvaluationTextureImageUnits
  117. 1024, // MaxTessEvaluationUniformComponents
  118. 120, // MaxTessPatchComponents
  119. 32, // MaxPatchVertices
  120. 64, // MaxTessGenLevel
  121. 16, // MaxViewports
  122. 0, // MaxVertexAtomicCounters
  123. 0, // MaxTessControlAtomicCounters
  124. 0, // MaxTessEvaluationAtomicCounters
  125. 0, // MaxGeometryAtomicCounters
  126. 8, // MaxFragmentAtomicCounters
  127. 8, // MaxCombinedAtomicCounters
  128. 1, // MaxAtomicCounterBindings
  129. 0, // MaxVertexAtomicCounterBuffers
  130. 0, // MaxTessControlAtomicCounterBuffers
  131. 0, // MaxTessEvaluationAtomicCounterBuffers
  132. 0, // MaxGeometryAtomicCounterBuffers
  133. 1, // MaxFragmentAtomicCounterBuffers
  134. 1, // MaxCombinedAtomicCounterBuffers
  135. 16384, // MaxAtomicCounterBufferSize
  136. 4, // MaxTransformFeedbackBuffers
  137. 64, // MaxTransformFeedbackInterleavedComponents
  138. 8, // MaxCullDistances
  139. 8, // MaxCombinedClipAndCullDistances
  140. 4, // MaxSamples
  141. 0, // maxMeshOutputVerticesNV
  142. 0, // maxMeshOutputPrimitivesNV
  143. 0, // maxMeshWorkGroupSizeX_NV
  144. 0, // maxMeshWorkGroupSizeY_NV
  145. 0, // maxMeshWorkGroupSizeZ_NV
  146. 0, // maxTaskWorkGroupSizeX_NV
  147. 0, // maxTaskWorkGroupSizeY_NV
  148. 0, // maxTaskWorkGroupSizeZ_NV
  149. 0, // maxMeshViewCountNV
  150. 0, // maxDualSourceDrawBuffersEXT
  151. { // limits
  152. true, // nonInductiveForLoops
  153. true, // whileLoops
  154. true, // doWhileLoops
  155. true, // generalUniformIndexing
  156. true, // generalAttributeMatrixVectorIndexing
  157. true, // generalVaryingIndexing
  158. true, // generalSamplerIndexing
  159. true, // generalVariableIndexing
  160. true, // generalConstantMatrixVectorIndexing
  161. },
  162. };
  163. bgfx::TextureComponentType::Enum SpirvCrossBaseTypeToFormatType(spirv_cross::SPIRType::BaseType spirvBaseType, bool depth)
  164. {
  165. if (depth)
  166. return bgfx::TextureComponentType::Depth;
  167. switch (spirvBaseType)
  168. {
  169. case spirv_cross::SPIRType::Float:
  170. return bgfx::TextureComponentType::Float;
  171. case spirv_cross::SPIRType::Int:
  172. return bgfx::TextureComponentType::Int;
  173. case spirv_cross::SPIRType::UInt:
  174. return bgfx::TextureComponentType::Uint;
  175. default:
  176. return bgfx::TextureComponentType::Float;
  177. }
  178. }
  179. bgfx::TextureDimension::Enum SpirvDimToTextureViewDimension(spv::Dim _dim, bool _arrayed)
  180. {
  181. switch (_dim)
  182. {
  183. case spv::Dim::Dim1D:
  184. return bgfx::TextureDimension::Dimension1D;
  185. case spv::Dim::Dim2D:
  186. return _arrayed
  187. ? bgfx::TextureDimension::Dimension2DArray
  188. : bgfx::TextureDimension::Dimension2D
  189. ;
  190. case spv::Dim::Dim3D:
  191. return bgfx::TextureDimension::Dimension3D;
  192. case spv::Dim::DimCube:
  193. return _arrayed
  194. ? bgfx::TextureDimension::DimensionCubeArray
  195. : bgfx::TextureDimension::DimensionCube
  196. ;
  197. default:
  198. BX_ASSERT(false, "Unknown texture dimension %d", _dim);
  199. return bgfx::TextureDimension::Dimension2D;
  200. }
  201. }
  202. static bgfx::TextureFormat::Enum s_textureFormats[] =
  203. {
  204. bgfx::TextureFormat::Unknown, // spv::ImageFormatUnknown = 0
  205. bgfx::TextureFormat::RGBA32F, // spv::ImageFormatRgba32f = 1
  206. bgfx::TextureFormat::RGBA16F, // spv::ImageFormatRgba16f = 2
  207. bgfx::TextureFormat::R32F, // spv::ImageFormatR32f = 3
  208. bgfx::TextureFormat::RGBA8, // spv::ImageFormatRgba8 = 4
  209. bgfx::TextureFormat::RGBA8S, // spv::ImageFormatRgba8Snorm = 5
  210. bgfx::TextureFormat::RG32F, // spv::ImageFormatRg32f = 6
  211. bgfx::TextureFormat::RG16F, // spv::ImageFormatRg16f = 7
  212. bgfx::TextureFormat::RG11B10F, // spv::ImageFormatR11fG11fB10f = 8
  213. bgfx::TextureFormat::R16F, // spv::ImageFormatR16f = 9
  214. bgfx::TextureFormat::RGBA16, // spv::ImageFormatRgba16 = 10
  215. bgfx::TextureFormat::RGB10A2, // spv::ImageFormatRgb10A2 = 11
  216. bgfx::TextureFormat::RG16, // spv::ImageFormatRg16 = 12
  217. bgfx::TextureFormat::RG8, // spv::ImageFormatRg8 = 13
  218. bgfx::TextureFormat::R16, // spv::ImageFormatR16 = 14
  219. bgfx::TextureFormat::R8, // spv::ImageFormatR8 = 15
  220. bgfx::TextureFormat::RGBA16S, // spv::ImageFormatRgba16Snorm = 16
  221. bgfx::TextureFormat::RG16S, // spv::ImageFormatRg16Snorm = 17
  222. bgfx::TextureFormat::RG8S, // spv::ImageFormatRg8Snorm = 18
  223. bgfx::TextureFormat::R16S, // spv::ImageFormatR16Snorm = 19
  224. bgfx::TextureFormat::R8S, // spv::ImageFormatR8Snorm = 20
  225. bgfx::TextureFormat::RGBA32I, // spv::ImageFormatRgba32i = 21
  226. bgfx::TextureFormat::RGBA16I, // spv::ImageFormatRgba16i = 22
  227. bgfx::TextureFormat::RGBA8I, // spv::ImageFormatRgba8i = 23
  228. bgfx::TextureFormat::R32I, // spv::ImageFormatR32i = 24
  229. bgfx::TextureFormat::RG32I, // spv::ImageFormatRg32i = 25
  230. bgfx::TextureFormat::RG16I, // spv::ImageFormatRg16i = 26
  231. bgfx::TextureFormat::RG8I, // spv::ImageFormatRg8i = 27
  232. bgfx::TextureFormat::R16I, // spv::ImageFormatR16i = 28
  233. bgfx::TextureFormat::R8I, // spv::ImageFormatR8i = 29
  234. bgfx::TextureFormat::RGBA32U, // spv::ImageFormatRgba32ui = 30
  235. bgfx::TextureFormat::RGBA16U, // spv::ImageFormatRgba16ui = 31
  236. bgfx::TextureFormat::RGBA8U, // spv::ImageFormatRgba8ui = 32
  237. bgfx::TextureFormat::R32U, // spv::ImageFormatR32ui = 33
  238. bgfx::TextureFormat::Unknown, // spv::ImageFormatRgb10a2ui = 34
  239. bgfx::TextureFormat::RG32U, // spv::ImageFormatRg32ui = 35
  240. bgfx::TextureFormat::RG16U, // spv::ImageFormatRg16ui = 36
  241. bgfx::TextureFormat::RG8U, // spv::ImageFormatRg8ui = 37
  242. bgfx::TextureFormat::R16U, // spv::ImageFormatR16ui = 38
  243. bgfx::TextureFormat::R8U, // spv::ImageFormatR8ui = 39
  244. bgfx::TextureFormat::Unknown, // spv::ImageFormatR64ui = 40
  245. bgfx::TextureFormat::Unknown, // spv::ImageFormatR64i = 41
  246. };
  247. static EShLanguage getLang(char _p)
  248. {
  249. switch (_p)
  250. {
  251. case 'c': return EShLangCompute;
  252. case 'f': return EShLangFragment;
  253. case 'v': return EShLangVertex;
  254. default: return EShLangCount;
  255. }
  256. }
  257. static const char* s_attribName[] =
  258. {
  259. "a_position",
  260. "a_normal",
  261. "a_tangent",
  262. "a_bitangent",
  263. "a_color0",
  264. "a_color1",
  265. "a_color2",
  266. "a_color3",
  267. "a_indices",
  268. "a_weight",
  269. "a_texcoord0",
  270. "a_texcoord1",
  271. "a_texcoord2",
  272. "a_texcoord3",
  273. "a_texcoord4",
  274. "a_texcoord5",
  275. "a_texcoord6",
  276. "a_texcoord7",
  277. };
  278. BX_STATIC_ASSERT(bgfx::Attrib::Count == BX_COUNTOF(s_attribName) );
  279. bgfx::Attrib::Enum toAttribEnum(const bx::StringView& _name)
  280. {
  281. for (uint8_t ii = 0; ii < Attrib::Count; ++ii)
  282. {
  283. if (0 == bx::strCmp(s_attribName[ii], _name) )
  284. {
  285. return bgfx::Attrib::Enum(ii);
  286. }
  287. }
  288. return bgfx::Attrib::Count;
  289. }
  290. static const char* s_samplerTypes[] =
  291. {
  292. "BgfxSampler2D",
  293. "BgfxISampler2D",
  294. "BgfxUSampler2D",
  295. "BgfxSampler2DArray",
  296. "BgfxSampler2DShadow",
  297. "BgfxSampler2DArrayShadow",
  298. "BgfxSampler3D",
  299. "BgfxISampler3D",
  300. "BgfxUSampler3D",
  301. "BgfxSamplerCube",
  302. "BgfxSamplerCubeShadow",
  303. "BgfxSampler2DMS",
  304. };
  305. static uint16_t writeUniformArray(bx::WriterI* _writer, const UniformArray& uniforms, bool isFragmentShader)
  306. {
  307. uint16_t size = 0;
  308. uint16_t count = static_cast<uint16_t>(uniforms.size() );
  309. bx::write(_writer, count);
  310. uint32_t fragmentBit = isFragmentShader ? kUniformFragmentBit : 0;
  311. for (uint16_t ii = 0; ii < count; ++ii)
  312. {
  313. const Uniform& un = uniforms[ii];
  314. if ( (un.type & ~kUniformMask) > UniformType::End)
  315. {
  316. size = bx::max(size, (uint16_t)(un.regIndex + un.regCount*16) );
  317. }
  318. uint8_t nameSize = (uint8_t)un.name.size();
  319. bx::write(_writer, nameSize);
  320. bx::write(_writer, un.name.c_str(), nameSize);
  321. bx::write(_writer, uint8_t(un.type | fragmentBit) );
  322. bx::write(_writer, un.num);
  323. bx::write(_writer, un.regIndex);
  324. bx::write(_writer, un.regCount);
  325. bx::write(_writer, un.texComponent);
  326. bx::write(_writer, un.texDimension);
  327. bx::write(_writer, un.texFormat);
  328. BX_TRACE("%s, %s, %d, %d, %d"
  329. , un.name.c_str()
  330. , getUniformTypeName(un.type)
  331. , un.num
  332. , un.regIndex
  333. , un.regCount
  334. );
  335. }
  336. return size;
  337. }
  338. static spv_target_env getSpirvTargetVersion(uint32_t version)
  339. {
  340. switch (version)
  341. {
  342. case 1010:
  343. return SPV_ENV_VULKAN_1_0;
  344. case 1311:
  345. return SPV_ENV_VULKAN_1_1;
  346. case 1411:
  347. return SPV_ENV_VULKAN_1_1_SPIRV_1_4;
  348. case 1512:
  349. return SPV_ENV_VULKAN_1_2;
  350. default:
  351. BX_ASSERT(0, "Unknown SPIR-V version requested. Returning SPV_ENV_VULKAN_1_0 as default.");
  352. return SPV_ENV_VULKAN_1_0;
  353. }
  354. }
  355. static glslang::EShTargetClientVersion getGlslangTargetVulkanVersion(uint32_t version)
  356. {
  357. switch (version)
  358. {
  359. case 1010:
  360. return glslang::EShTargetVulkan_1_0;
  361. case 1311:
  362. case 1411:
  363. return glslang::EShTargetVulkan_1_1;
  364. case 1512:
  365. return glslang::EShTargetVulkan_1_2;
  366. default:
  367. BX_ASSERT(0, "Unknown SPIR-V version requested. Returning EShTargetVulkan_1_0 as default.");
  368. return glslang::EShTargetVulkan_1_0;
  369. }
  370. }
  371. static glslang::EShTargetLanguageVersion getGlslangTargetSpirvVersion(uint32_t version)
  372. {
  373. switch (version)
  374. {
  375. case 1010:
  376. return glslang::EShTargetSpv_1_0;
  377. case 1311:
  378. return glslang::EShTargetSpv_1_3;
  379. case 1411:
  380. return glslang::EShTargetSpv_1_4;
  381. case 1512:
  382. return glslang::EShTargetSpv_1_5;
  383. default:
  384. BX_ASSERT(0, "Unknown SPIR-V version requested. Returning EShTargetSpv_1_0 as default.");
  385. return glslang::EShTargetSpv_1_0;
  386. }
  387. }
  388. /// This is the value used to fill out GLSLANG's SpvVersion object.
  389. /// The required value is that which is defined by GL_KHR_vulkan_glsl, which is defined here:
  390. /// https://github.com/KhronosGroup/GLSL/blob/master/extensions/khr/GL_KHR_vulkan_glsl.txt
  391. /// The value is 100.
  392. constexpr int s_GLSL_VULKAN_CLIENT_VERSION = 100;
  393. static bool compile(const Options& _options, uint32_t _version, const std::string& _code, bx::WriterI* _writer, bool _firstPass)
  394. {
  395. BX_UNUSED(_version);
  396. glslang::InitializeProcess();
  397. EShLanguage stage = getLang(_options.shaderType);
  398. if (EShLangCount == stage)
  399. {
  400. bx::printf("Error: Unknown shader type '%c'.\n", _options.shaderType);
  401. return false;
  402. }
  403. glslang::TProgram* program = new glslang::TProgram;
  404. glslang::TShader* shader = new glslang::TShader(stage);
  405. EShMessages messages = EShMessages(0
  406. | EShMsgDefault
  407. | EShMsgReadHlsl
  408. | EShMsgVulkanRules
  409. | EShMsgSpvRules
  410. );
  411. shader->setEntryPoint("main");
  412. shader->setAutoMapBindings(true);
  413. shader->setEnvInput(glslang::EShSourceHlsl, stage, glslang::EShClientVulkan, s_GLSL_VULKAN_CLIENT_VERSION);
  414. shader->setEnvClient(glslang::EShClientVulkan, getGlslangTargetVulkanVersion(_version));
  415. shader->setEnvTarget(glslang::EShTargetSpv, getGlslangTargetSpirvVersion(_version));
  416. // Reserve two spots for the stage UBOs
  417. shader->setShiftBinding(glslang::EResUbo, (stage == EShLanguage::EShLangFragment ? kSpirvFragmentBinding : kSpirvVertexBinding));
  418. shader->setShiftBinding(glslang::EResTexture, kSpirvBindShift);
  419. shader->setShiftBinding(glslang::EResSampler, kSpirvBindShift + kSpirvSamplerShift);
  420. shader->setShiftBinding(glslang::EResSsbo, kSpirvBindShift);
  421. shader->setShiftBinding(glslang::EResImage, kSpirvBindShift);
  422. const char* shaderStrings[] = { _code.c_str() };
  423. shader->setStrings(
  424. shaderStrings
  425. , BX_COUNTOF(shaderStrings)
  426. );
  427. bool compiled = shader->parse(&resourceLimits
  428. , 110
  429. , false
  430. , messages
  431. );
  432. bool linked = false;
  433. bool validated = true;
  434. if (!compiled)
  435. {
  436. const char* log = shader->getInfoLog();
  437. if (NULL != log)
  438. {
  439. int32_t source = 0;
  440. int32_t line = 0;
  441. int32_t column = 0;
  442. int32_t start = 0;
  443. int32_t end = INT32_MAX;
  444. bx::StringView err = bx::strFind(log, "ERROR:");
  445. bool found = false;
  446. if (!err.isEmpty() )
  447. {
  448. found = 2 == sscanf(err.getPtr(), "ERROR: %u:%u: '", &source, &line);
  449. if (found)
  450. {
  451. ++line;
  452. }
  453. }
  454. if (found)
  455. {
  456. start = bx::uint32_imax(1, line-10);
  457. end = start + 20;
  458. }
  459. printCode(_code.c_str(), line, start, end, column);
  460. bx::printf("%s\n", log);
  461. }
  462. }
  463. else
  464. {
  465. program->addShader(shader);
  466. linked = true
  467. && program->link(messages)
  468. && program->mapIO()
  469. ;
  470. if (!linked)
  471. {
  472. const char* log = program->getInfoLog();
  473. if (NULL != log)
  474. {
  475. bx::printf("%s\n", log);
  476. }
  477. }
  478. else
  479. {
  480. program->buildReflection();
  481. if (_firstPass)
  482. {
  483. // first time through, we just find unused uniforms and get rid of them
  484. std::string output;
  485. struct Uniform
  486. {
  487. std::string name;
  488. std::string decl;
  489. };
  490. std::vector<Uniform> uniforms;
  491. bx::LineReader reader(_code.c_str() );
  492. while (!reader.isDone() )
  493. {
  494. bx::StringView strLine = reader.next();
  495. bool moved = false;
  496. bx::StringView str = strFind(strLine, "uniform ");
  497. if (!str.isEmpty() )
  498. {
  499. bool found = false;
  500. bool sampler = false;
  501. std::string name = "";
  502. // add to samplers
  503. for (uint32_t ii = 0; ii < BX_COUNTOF(s_samplerTypes); ++ii)
  504. {
  505. if (!bx::findIdentifierMatch(strLine, s_samplerTypes[ii]).isEmpty() )
  506. {
  507. found = true;
  508. sampler = true;
  509. break;
  510. }
  511. }
  512. if (!found)
  513. {
  514. for (int32_t ii = 0, num = program->getNumLiveUniformVariables(); ii < num; ++ii)
  515. {
  516. // matching lines like: uniform u_name;
  517. // we want to replace "uniform" with "static" so that it's no longer
  518. // included in the uniform blob that the application must upload
  519. // we can't just remove them, because unused functions might still reference
  520. // them and cause a compile error when they're gone
  521. if (!bx::findIdentifierMatch(strLine, program->getUniformName(ii) ).isEmpty() )
  522. {
  523. found = true;
  524. name = program->getUniformName(ii);
  525. break;
  526. }
  527. }
  528. }
  529. if (!found)
  530. {
  531. output.append(strLine.getPtr(), str.getPtr() );
  532. output += "static ";
  533. output.append(str.getTerm(), strLine.getTerm() );
  534. output += "\n";
  535. moved = true;
  536. }
  537. else if (!sampler)
  538. {
  539. Uniform uniform;
  540. uniform.name = name;
  541. uniform.decl = std::string(strLine.getPtr(), strLine.getTerm() );
  542. uniforms.push_back(uniform);
  543. moved = true;
  544. }
  545. }
  546. if (!moved)
  547. {
  548. output.append(strLine.getPtr(), strLine.getTerm() );
  549. output += "\n";
  550. }
  551. }
  552. std::string uniformBlock;
  553. uniformBlock += "cbuffer UniformBlock\n";
  554. uniformBlock += "{\n";
  555. for (const Uniform& uniform : uniforms)
  556. {
  557. uniformBlock += uniform.decl.substr(7 /* uniform */);
  558. uniformBlock += "\n";
  559. }
  560. uniformBlock += "};\n";
  561. output = uniformBlock + output;
  562. // recompile with the unused uniforms converted to statics
  563. delete program;
  564. delete shader;
  565. return compile(_options, _version, output.c_str(), _writer, false);
  566. }
  567. UniformArray uniforms;
  568. {
  569. uint16_t count = (uint16_t)program->getNumLiveUniformVariables();
  570. for (uint16_t ii = 0; ii < count; ++ii)
  571. {
  572. Uniform un;
  573. un.name = program->getUniformName(ii);
  574. un.num = 0;
  575. const uint32_t offset = program->getUniformBufferOffset(ii);
  576. un.regIndex = uint16_t(offset);
  577. un.regCount = uint16_t(program->getUniformArraySize(ii));
  578. switch (program->getUniformType(ii) )
  579. {
  580. case 0x1404: // GL_INT:
  581. un.type = UniformType::Sampler;
  582. break;
  583. case 0x8B52: // GL_FLOAT_VEC4:
  584. un.type = UniformType::Vec4;
  585. break;
  586. case 0x8B5B: // GL_FLOAT_MAT3:
  587. un.type = UniformType::Mat3;
  588. un.regCount *= 3;
  589. break;
  590. case 0x8B5C: // GL_FLOAT_MAT4:
  591. un.type = UniformType::Mat4;
  592. un.regCount *= 4;
  593. break;
  594. default:
  595. continue;
  596. }
  597. uniforms.push_back(un);
  598. }
  599. }
  600. if (g_verbose)
  601. {
  602. program->dumpReflection();
  603. }
  604. BX_UNUSED(spv::MemorySemanticsAllMemory);
  605. glslang::TIntermediate* intermediate = program->getIntermediate(stage);
  606. std::vector<uint32_t> spirv;
  607. glslang::SpvOptions options;
  608. options.disableOptimizer = false;
  609. glslang::GlslangToSpv(*intermediate, spirv, &options);
  610. spvtools::Optimizer opt(getSpirvTargetVersion(_version));
  611. auto print_msg_to_stderr = [](
  612. spv_message_level_t
  613. , const char*
  614. , const spv_position_t&
  615. , const char* m
  616. )
  617. {
  618. bx::printf("Error: %s\n", m);
  619. };
  620. opt.SetMessageConsumer(print_msg_to_stderr);
  621. opt.RegisterLegalizationPasses();
  622. spvtools::ValidatorOptions validatorOptions;
  623. validatorOptions.SetBeforeHlslLegalization(true);
  624. if (!opt.Run(
  625. spirv.data()
  626. , spirv.size()
  627. , &spirv
  628. , validatorOptions
  629. , false
  630. ) )
  631. {
  632. compiled = false;
  633. }
  634. else
  635. {
  636. if (g_verbose)
  637. {
  638. glslang::SpirvToolsDisassemble(std::cout, spirv, getSpirvTargetVersion(_version));
  639. }
  640. spirv_cross::CompilerReflection refl(spirv);
  641. spirv_cross::ShaderResources resourcesrefl = refl.get_shader_resources();
  642. // Loop through the separate_images, and extract the uniform names:
  643. for (auto &resource : resourcesrefl.separate_images)
  644. {
  645. std::string name = refl.get_name(resource.id);
  646. if (name.size() > 7
  647. && 0 == bx::strCmp(name.c_str() + name.length() - 7, "Texture") )
  648. {
  649. name = name.substr(0, name.length() - 7);
  650. }
  651. uint32_t binding_index = refl.get_decoration(resource.id, spv::Decoration::DecorationBinding);
  652. auto imageType = refl.get_type(resource.base_type_id).image;
  653. auto componentType = refl.get_type(imageType.type).basetype;
  654. bool isCompareSampler = false;
  655. for (auto& sampler : resourcesrefl.separate_samplers)
  656. {
  657. if (binding_index + 16 == refl.get_decoration(sampler.id, spv::Decoration::DecorationBinding) )
  658. {
  659. std::string samplerName = refl.get_name(sampler.id);
  660. isCompareSampler = refl.variable_is_depth_or_compare(sampler.id) || samplerName.find("Comparison") != std::string::npos;
  661. break;
  662. }
  663. }
  664. Uniform un;
  665. un.name = name;
  666. un.type = UniformType::Enum(UniformType::Sampler
  667. | kUniformSamplerBit
  668. | (isCompareSampler ? kUniformCompareBit : 0)
  669. );
  670. un.texComponent = textureComponentTypeToId(SpirvCrossBaseTypeToFormatType(componentType, imageType.depth) );
  671. un.texDimension = textureDimensionToId(SpirvDimToTextureViewDimension(imageType.dim, imageType.arrayed) );
  672. un.texFormat = uint16_t(s_textureFormats[imageType.format]);
  673. un.regIndex = binding_index;
  674. un.regCount = 0; // unused
  675. uniforms.push_back(un);
  676. }
  677. // Loop through the storage_images, and extract the uniform names:
  678. for (auto &resource : resourcesrefl.storage_images)
  679. {
  680. std::string name = refl.get_name(resource.id);
  681. uint32_t binding_index = refl.get_decoration(resource.id, spv::Decoration::DecorationBinding);
  682. auto imageType = refl.get_type(resource.base_type_id).image;
  683. auto componentType = refl.get_type(imageType.type).basetype;
  684. spirv_cross::Bitset flags = refl.get_decoration_bitset(resource.id);
  685. UniformType::Enum type = flags.get(spv::DecorationNonWritable)
  686. ? UniformType::Enum(kUniformReadOnlyBit | UniformType::End)
  687. : UniformType::End;
  688. Uniform un;
  689. un.name = name;
  690. un.type = type;
  691. un.texComponent = textureComponentTypeToId(SpirvCrossBaseTypeToFormatType(componentType, imageType.depth) );
  692. un.texDimension = textureDimensionToId(SpirvDimToTextureViewDimension(imageType.dim, imageType.arrayed) );
  693. un.texFormat = uint16_t(s_textureFormats[imageType.format]);
  694. un.regIndex = binding_index;
  695. un.regCount = descriptorTypeToId(DescriptorType::StorageImage);
  696. uniforms.push_back(un);
  697. }
  698. // Loop through the storage buffer, and extract the uniform names:
  699. for (auto& resource : resourcesrefl.storage_buffers)
  700. {
  701. std::string name = refl.get_name(resource.id);
  702. uint32_t binding_index = refl.get_decoration(resource.id, spv::Decoration::DecorationBinding);
  703. spirv_cross::Bitset flags = refl.get_buffer_block_flags(resource.id);
  704. UniformType::Enum type = flags.get(spv::DecorationNonWritable)
  705. ? UniformType::Enum(kUniformReadOnlyBit | UniformType::End)
  706. : UniformType::End;
  707. Uniform un;
  708. un.name = name;
  709. un.type = type;
  710. un.num = 0;
  711. un.regIndex = binding_index;
  712. un.regCount = descriptorTypeToId(DescriptorType::StorageBuffer);
  713. uniforms.push_back(un);
  714. }
  715. uint16_t size = writeUniformArray( _writer, uniforms, _options.shaderType == 'f');
  716. uint32_t shaderSize = (uint32_t)spirv.size() * sizeof(uint32_t);
  717. bx::write(_writer, shaderSize);
  718. bx::write(_writer, spirv.data(), shaderSize);
  719. uint8_t nul = 0;
  720. bx::write(_writer, nul);
  721. const uint8_t numAttr = (uint8_t)program->getNumLiveAttributes();
  722. bx::write(_writer, numAttr);
  723. for (uint8_t ii = 0; ii < numAttr; ++ii)
  724. {
  725. bgfx::Attrib::Enum attr = toAttribEnum(program->getAttributeName(ii) );
  726. if (bgfx::Attrib::Count != attr)
  727. {
  728. bx::write(_writer, bgfx::attribToId(attr) );
  729. }
  730. else
  731. {
  732. bx::write(_writer, uint16_t(UINT16_MAX) );
  733. }
  734. }
  735. bx::write(_writer, size);
  736. }
  737. }
  738. }
  739. delete program;
  740. delete shader;
  741. glslang::FinalizeProcess();
  742. return compiled && linked && validated;
  743. }
  744. } // namespace spirv
  745. bool compileSPIRVShader(const Options& _options, uint32_t _version, const std::string& _code, bx::WriterI* _writer)
  746. {
  747. return spirv::compile(_options, _version, _code, _writer, true);
  748. }
  749. } // namespace bgfx