ShaderProgramParser.cpp 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937
  1. // Copyright (C) 2009-2023, 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/ShaderProgramParser.h>
  6. namespace anki {
  7. #define ANKI_PP_ERROR_MALFORMED() \
  8. ANKI_SHADER_COMPILER_LOGE("%s: Malformed expression: %s", fname.cstr(), line.cstr()); \
  9. return Error::kUserData
  10. #define ANKI_PP_ERROR_MALFORMED_MSG(msg_) \
  11. ANKI_SHADER_COMPILER_LOGE("%s: " msg_ ": %s", fname.cstr(), line.cstr()); \
  12. return Error::kUserData
  13. inline constexpr Array<CString, U32(ShaderType::kCount)> kShaderStageNames = {{"VERTEX", "TESSELLATION_CONTROL", "TESSELLATION_EVALUATION",
  14. "GEOMETRY", "TASK", "MESH", "FRAGMENT", "COMPUTE", "RAY_GEN",
  15. "ANY_HIT", "CLOSEST_HIT", "MISS", "INTERSECTION", "CALLABLE"}};
  16. inline constexpr char kShaderHeader[] = R"(#define ANKI_%s_SHADER 1
  17. #define kMaxBindlessTextures %uu
  18. #define kMaxBindlessReadonlyTextureBuffers %uu
  19. )";
  20. static ShaderType strToShaderType(CString str)
  21. {
  22. ShaderType shaderType = ShaderType::kCount;
  23. if(str == "vert")
  24. {
  25. shaderType = ShaderType::kVertex;
  26. }
  27. else if(str == "tessc")
  28. {
  29. shaderType = ShaderType::kTessellationControl;
  30. }
  31. else if(str == "tesse")
  32. {
  33. }
  34. else if(str == "geom")
  35. {
  36. shaderType = ShaderType::kGeometry;
  37. }
  38. else if(str == "task")
  39. {
  40. shaderType = ShaderType::kTask;
  41. }
  42. else if(str == "mesh")
  43. {
  44. shaderType = ShaderType::kMesh;
  45. }
  46. else if(str == "frag")
  47. {
  48. shaderType = ShaderType::kFragment;
  49. }
  50. else if(str == "comp")
  51. {
  52. shaderType = ShaderType::kCompute;
  53. }
  54. else if(str == "rgen")
  55. {
  56. shaderType = ShaderType::kRayGen;
  57. }
  58. else if(str == "ahit")
  59. {
  60. shaderType = ShaderType::kAnyHit;
  61. }
  62. else if(str == "chit")
  63. {
  64. shaderType = ShaderType::kClosestHit;
  65. }
  66. else if(str == "miss")
  67. {
  68. shaderType = ShaderType::kMiss;
  69. }
  70. else if(str == "int")
  71. {
  72. shaderType = ShaderType::kIntersection;
  73. }
  74. else if(str == "call")
  75. {
  76. shaderType = ShaderType::kCallable;
  77. }
  78. else
  79. {
  80. shaderType = ShaderType::kCount;
  81. }
  82. return shaderType;
  83. }
  84. ShaderProgramParser::ShaderProgramParser(CString fname, ShaderProgramFilesystemInterface* fsystem, ConstWeakArray<ShaderCompilerDefine> defines)
  85. : m_fname(fname)
  86. , m_fsystem(fsystem)
  87. {
  88. for(const ShaderCompilerDefine& def : defines)
  89. {
  90. m_defineNames.emplaceBack(def.m_name);
  91. m_defineValues.emplaceBack(def.m_value);
  92. }
  93. }
  94. ShaderProgramParser::~ShaderProgramParser()
  95. {
  96. }
  97. void ShaderProgramParser::tokenizeLine(CString line, ShaderCompilerDynamicArray<ShaderCompilerString>& tokens) const
  98. {
  99. ANKI_ASSERT(line.getLength() > 0);
  100. ShaderCompilerString l = line;
  101. // Replace all tabs with spaces
  102. for(char& c : l)
  103. {
  104. if(c == '\t')
  105. {
  106. c = ' ';
  107. }
  108. }
  109. // Split
  110. ShaderCompilerStringList spaceTokens;
  111. spaceTokens.splitString(l, ' ', false);
  112. // Create the array
  113. for(const ShaderCompilerString& s : spaceTokens)
  114. {
  115. tokens.emplaceBack(s);
  116. }
  117. }
  118. Error ShaderProgramParser::parsePragmaTechniqueStart(const ShaderCompilerString* begin, const ShaderCompilerString* end, CString line, CString fname)
  119. {
  120. ANKI_ASSERT(begin && end);
  121. const PtrSize tokenCount = end - begin;
  122. if(tokenCount == 0)
  123. {
  124. ANKI_PP_ERROR_MALFORMED();
  125. }
  126. const ShaderType shaderType = strToShaderType(*begin);
  127. if(shaderType == ShaderType::kCount)
  128. {
  129. ANKI_PP_ERROR_MALFORMED();
  130. }
  131. ShaderCompilerString techniqueName;
  132. ++begin;
  133. if(begin == end)
  134. {
  135. techniqueName = "Unnamed";
  136. }
  137. else if(*begin == "uses_mutators")
  138. {
  139. techniqueName = "Unnamed";
  140. }
  141. else if(*begin != "uses_mutators")
  142. {
  143. techniqueName = *begin;
  144. ++begin;
  145. }
  146. // Mutators
  147. U64 activeMutators = kMaxU64;
  148. if(begin != end)
  149. {
  150. if(*begin != "uses_mutators")
  151. {
  152. ANKI_PP_ERROR_MALFORMED();
  153. }
  154. ++begin;
  155. activeMutators = 0;
  156. for(; begin != end; ++begin)
  157. {
  158. // Find mutator
  159. U32 count = 0;
  160. for(const Mutator& mutator : m_mutators)
  161. {
  162. if(mutator.m_name == *begin)
  163. {
  164. activeMutators |= 1_U64 << U64(count);
  165. break;
  166. }
  167. ++count;
  168. }
  169. if(count == m_mutators.getSize())
  170. {
  171. ANKI_PP_ERROR_MALFORMED_MSG("Mutator not found");
  172. }
  173. }
  174. }
  175. // Checks
  176. if(insideTechnique())
  177. {
  178. ANKI_PP_ERROR_MALFORMED_MSG("Need to close the previous technique_start before starting a new one");
  179. }
  180. // Find the technique
  181. Technique* technique = nullptr;
  182. for(Technique& t : m_techniques)
  183. {
  184. if(t.m_name == techniqueName)
  185. {
  186. if(!!(t.m_shaderTypes & ShaderTypeBit(1 << shaderType)))
  187. {
  188. ANKI_PP_ERROR_MALFORMED_MSG("technique_start with the same name and type appeared more than once");
  189. }
  190. technique = &t;
  191. break;
  192. }
  193. }
  194. // Done
  195. TechniqueExtra* extra = nullptr;
  196. if(!technique)
  197. {
  198. technique = m_techniques.emplaceBack();
  199. technique->m_name = techniqueName;
  200. extra = m_techniqueExtras.emplaceBack();
  201. }
  202. else
  203. {
  204. const U32 idx = U32(technique - m_techniques.getBegin());
  205. extra = &m_techniqueExtras[idx];
  206. }
  207. technique->m_shaderTypes |= ShaderTypeBit(1 << shaderType);
  208. technique->m_activeMutators[shaderType] = activeMutators;
  209. ANKI_ASSERT(extra->m_sourceLines[shaderType].getSize() == 0);
  210. extra->m_sourceLines[shaderType] = m_commonSourceLines;
  211. extra->m_sourceLines[shaderType].pushBackSprintf("#define ANKI_%s_SHADER 1", kShaderStageNames[shaderType].cstr());
  212. extra->m_sourceLines[shaderType].pushBackSprintf("#define ANKI_TECHNIQUE_%s 1", techniqueName.cstr());
  213. m_insideTechniqueIdx = U32(technique - m_techniques.getBegin());
  214. m_insideTechniqueShaderType = shaderType;
  215. return Error::kNone;
  216. }
  217. Error ShaderProgramParser::parsePragmaTechniqueEnd(const ShaderCompilerString* begin, const ShaderCompilerString* end, CString line, CString fname)
  218. {
  219. ANKI_ASSERT(begin && end);
  220. // Check tokens
  221. if(begin >= end)
  222. {
  223. ANKI_PP_ERROR_MALFORMED();
  224. }
  225. const ShaderType shaderType = strToShaderType(*begin);
  226. if(shaderType == ShaderType::kCount)
  227. {
  228. ANKI_PP_ERROR_MALFORMED();
  229. }
  230. ShaderCompilerString techniqueName;
  231. ++begin;
  232. if(begin == end)
  233. {
  234. // Last token
  235. techniqueName = "Unnamed";
  236. }
  237. else
  238. {
  239. techniqueName = *begin;
  240. ++begin;
  241. if(begin != end)
  242. {
  243. ANKI_PP_ERROR_MALFORMED();
  244. }
  245. }
  246. // Checks
  247. if(!insideTechnique())
  248. {
  249. ANKI_PP_ERROR_MALFORMED_MSG("Forgot to insert a #pragma anki technique_start");
  250. }
  251. if(m_techniques.getBack().m_name != techniqueName || m_insideTechniqueShaderType != shaderType)
  252. {
  253. ANKI_PP_ERROR_MALFORMED_MSG("name or type doesn't match the one in technique_start");
  254. }
  255. // Done
  256. m_insideTechniqueIdx = kMaxU32;
  257. m_insideTechniqueShaderType = ShaderType::kCount;
  258. return Error::kNone;
  259. }
  260. Error ShaderProgramParser::parsePragmaMutator(const ShaderCompilerString* begin, const ShaderCompilerString* end, CString line, CString fname)
  261. {
  262. ANKI_ASSERT(begin && end);
  263. if(begin >= end)
  264. {
  265. ANKI_PP_ERROR_MALFORMED();
  266. }
  267. m_mutators.emplaceBack();
  268. Mutator& mutator = m_mutators.getBack();
  269. // Name
  270. {
  271. if(begin >= end)
  272. {
  273. // Need to have a name
  274. ANKI_PP_ERROR_MALFORMED();
  275. }
  276. // Check for duplicate mutators
  277. for(U32 i = 0; i < m_mutators.getSize() - 1; ++i)
  278. {
  279. if(m_mutators[i].m_name == *begin)
  280. {
  281. ANKI_PP_ERROR_MALFORMED_MSG("Duplicate mutator");
  282. }
  283. }
  284. if(begin->getLength() > kMaxShaderBinaryNameLength)
  285. {
  286. ANKI_PP_ERROR_MALFORMED_MSG("Too big name");
  287. }
  288. mutator.m_name = *begin;
  289. ++begin;
  290. }
  291. // Values
  292. {
  293. // Gather them
  294. for(; begin < end; ++begin)
  295. {
  296. MutatorValue value = 0;
  297. if(tokenIsComment(begin->toCString()))
  298. {
  299. break;
  300. }
  301. if(begin->toNumber(value))
  302. {
  303. ANKI_PP_ERROR_MALFORMED();
  304. }
  305. mutator.m_values.emplaceBack(value);
  306. }
  307. std::sort(mutator.m_values.getBegin(), mutator.m_values.getEnd());
  308. // Check for duplicates
  309. for(U32 i = 1; i < mutator.m_values.getSize(); ++i)
  310. {
  311. if(mutator.m_values[i - 1] == mutator.m_values[i])
  312. {
  313. ANKI_PP_ERROR_MALFORMED_MSG("Same value appeared more than once");
  314. }
  315. }
  316. }
  317. return Error::kNone;
  318. }
  319. Error ShaderProgramParser::parsePragmaSkipMutation(const ShaderCompilerString* begin, const ShaderCompilerString* end, CString line, CString fname)
  320. {
  321. ANKI_ASSERT(begin && end);
  322. // Some basic sanity checks
  323. const U tokenCount = U(end - begin);
  324. // One pair doesn't make sence so it's: mutator_name_0 + mutator_value_0 + mutator_name_1 + mutator_value_1
  325. constexpr U minTokenCount = 2 + 2;
  326. if(tokenCount < minTokenCount || (tokenCount % 2) != 0)
  327. {
  328. ANKI_PP_ERROR_MALFORMED();
  329. }
  330. PartialMutationSkip& skip = *m_skipMutations.emplaceBack();
  331. skip.m_partialMutation.resize(m_mutators.getSize(), std::numeric_limits<MutatorValue>::max());
  332. do
  333. {
  334. // Get mutator name
  335. const CString mutatorName = *begin;
  336. U32 mutatorIndex = kMaxU32;
  337. for(U32 i = 0; i < m_mutators.getSize(); ++i)
  338. {
  339. if(m_mutators[i].m_name == mutatorName)
  340. {
  341. mutatorIndex = i;
  342. break;
  343. }
  344. }
  345. if(mutatorIndex == kMaxU32)
  346. {
  347. ANKI_PP_ERROR_MALFORMED_MSG("Mutator not found");
  348. }
  349. // Get mutator value
  350. ++begin;
  351. const CString valueStr = *begin;
  352. MutatorValue value;
  353. if(valueStr.toNumber(value))
  354. {
  355. ANKI_PP_ERROR_MALFORMED_MSG("Malformed mutator value");
  356. }
  357. if(!mutatorHasValue(m_mutators[mutatorIndex], value))
  358. {
  359. ANKI_PP_ERROR_MALFORMED_MSG("Mutator value incorrect");
  360. }
  361. skip.m_partialMutation[mutatorIndex] = value;
  362. ++begin;
  363. } while(begin < end && !tokenIsComment(*begin));
  364. return Error::kNone;
  365. }
  366. Error ShaderProgramParser::parseInclude(const ShaderCompilerString* begin, const ShaderCompilerString* end, CString line, CString fname, U32 depth)
  367. {
  368. // Gather the path
  369. ShaderCompilerString path;
  370. for(; begin < end; ++begin)
  371. {
  372. path += *begin;
  373. }
  374. if(path.isEmpty())
  375. {
  376. ANKI_PP_ERROR_MALFORMED();
  377. }
  378. // Check
  379. const char firstChar = path[0];
  380. const char lastChar = path[path.getLength() - 1];
  381. if((firstChar == '\"' && lastChar == '\"') || (firstChar == '<' && lastChar == '>'))
  382. {
  383. ShaderCompilerString fname2(path.begin() + 1, path.begin() + path.getLength() - 1);
  384. const Bool dontIgnore =
  385. fname2.find("AnKi/Shaders/") != ShaderCompilerString::kNpos || fname2.find("ThirdParty/") != ShaderCompilerString::kNpos;
  386. if(!dontIgnore)
  387. {
  388. // The shaders can't include C++ files. Ignore the include
  389. return Error::kNone;
  390. }
  391. if(parseFile(fname2, depth + 1))
  392. {
  393. ANKI_PP_ERROR_MALFORMED_MSG("Error parsing include. See previous errors");
  394. }
  395. }
  396. else
  397. {
  398. ANKI_PP_ERROR_MALFORMED();
  399. }
  400. return Error::kNone;
  401. }
  402. Error ShaderProgramParser::parseLine(CString line, CString fname, Bool& foundPragmaOnce, U32 depth, U32 lineNo)
  403. {
  404. // Tokenize
  405. ShaderCompilerDynamicArray<ShaderCompilerString> tokens;
  406. tokenizeLine(line, tokens);
  407. ANKI_ASSERT(tokens.getSize() > 0);
  408. const ShaderCompilerString* token = tokens.getBegin();
  409. const ShaderCompilerString* end = tokens.getEnd();
  410. // Skip the hash
  411. Bool foundAloneHash = false;
  412. if(*token == "#")
  413. {
  414. ++token;
  415. foundAloneHash = true;
  416. }
  417. if((token < end) && ((foundAloneHash && *token == "include") || *token == "#include"))
  418. {
  419. // We _must_ have an #include
  420. ANKI_CHECK(parseInclude(token + 1, end, line, fname, depth));
  421. getAppendSourceList().pushBackSprintf("#line %u \"%s\"", lineNo + 1, fname.cstr());
  422. }
  423. else if((token < end) && ((foundAloneHash && *token == "pragma") || *token == "#pragma"))
  424. {
  425. // We may have a #pragma once or a #pragma anki or something else
  426. ++token;
  427. if(*token == "once")
  428. {
  429. // Pragma once
  430. if(foundPragmaOnce)
  431. {
  432. ANKI_PP_ERROR_MALFORMED_MSG("Can't have more than one #pragma once per file");
  433. }
  434. if(token + 1 != end)
  435. {
  436. ANKI_PP_ERROR_MALFORMED();
  437. }
  438. // Add the guard unique for this file
  439. foundPragmaOnce = true;
  440. const U64 hash = fname.computeHash();
  441. getAppendSourceList().pushBackSprintf("#ifndef _ANKI_INCL_GUARD_%" PRIu64 "\n"
  442. "#define _ANKI_INCL_GUARD_%" PRIu64,
  443. hash, hash);
  444. getAppendSourceList().pushBackSprintf("#line %u \"%s\"", lineNo + 1, fname.cstr());
  445. }
  446. else if(*token == "anki")
  447. {
  448. // Must be a #pragma anki
  449. ++token;
  450. if(*token == "mutator")
  451. {
  452. ANKI_CHECK(checkNoActiveStruct());
  453. ANKI_CHECK(parsePragmaMutator(token + 1, end, line, fname));
  454. }
  455. else if(*token == "technique_start")
  456. {
  457. ANKI_CHECK(checkNoActiveStruct());
  458. ANKI_CHECK(parsePragmaTechniqueStart(token + 1, end, line, fname));
  459. }
  460. else if(*token == "technique_end")
  461. {
  462. ANKI_CHECK(checkNoActiveStruct());
  463. ANKI_CHECK(parsePragmaTechniqueEnd(token + 1, end, line, fname));
  464. }
  465. else if(*token == "skip_mutation")
  466. {
  467. ANKI_CHECK(checkNoActiveStruct());
  468. ANKI_CHECK(parsePragmaSkipMutation(token + 1, end, line, fname));
  469. }
  470. else if(*token == "struct")
  471. {
  472. ANKI_CHECK(checkNoActiveStruct());
  473. ANKI_CHECK(parsePragmaStructBegin(token + 1, end, line, fname));
  474. }
  475. else if(*token == "struct_end")
  476. {
  477. ANKI_CHECK(checkActiveStruct());
  478. ANKI_CHECK(parsePragmaStructEnd(token + 1, end, line, fname));
  479. }
  480. else if(*token == "member")
  481. {
  482. ANKI_CHECK(checkActiveStruct());
  483. ANKI_CHECK(parsePragmaMember(token + 1, end, line, fname));
  484. }
  485. else if(*token == "16bit")
  486. {
  487. ANKI_CHECK(parsePragma16bit(token + 1, end, line, fname));
  488. }
  489. else
  490. {
  491. ANKI_PP_ERROR_MALFORMED();
  492. }
  493. // For good measure
  494. getAppendSourceList().pushBackSprintf("#line %u \"%s\"", lineNo + 1, fname.cstr());
  495. }
  496. else
  497. {
  498. // Some other pragma, ignore
  499. getAppendSourceList().pushBack(line);
  500. }
  501. }
  502. else
  503. {
  504. // Ignore
  505. getAppendSourceList().pushBack(line);
  506. }
  507. return Error::kNone;
  508. }
  509. Error ShaderProgramParser::parsePragmaStructBegin(const ShaderCompilerString* begin, const ShaderCompilerString* end, CString line, CString fname)
  510. {
  511. const U tokenCount = U(end - begin);
  512. if(tokenCount != 1)
  513. {
  514. ANKI_PP_ERROR_MALFORMED();
  515. }
  516. GhostStruct& gstruct = *m_ghostStructs.emplaceBack();
  517. gstruct.m_name = *begin;
  518. getAppendSourceList().pushBackSprintf("struct %s {", begin->cstr());
  519. ANKI_ASSERT(!m_insideStruct);
  520. m_insideStruct = true;
  521. return Error::kNone;
  522. }
  523. Error ShaderProgramParser::parsePragmaMember(const ShaderCompilerString* begin, const ShaderCompilerString* end, CString line, CString fname)
  524. {
  525. ANKI_ASSERT(m_insideStruct);
  526. const U tokenCount = U(end - begin);
  527. if(tokenCount != 2)
  528. {
  529. ANKI_PP_ERROR_MALFORMED();
  530. }
  531. GhostStruct& structure = m_ghostStructs.getBack();
  532. Member member;
  533. // Type
  534. const CString typeStr = *begin;
  535. member.m_type = ShaderVariableDataType::kNone;
  536. if(typeStr == "F32" || typeStr == "RF32")
  537. {
  538. member.m_type = ShaderVariableDataType::kF32;
  539. }
  540. else if(typeStr == "Vec2" || typeStr == "RVec2")
  541. {
  542. member.m_type = ShaderVariableDataType::kVec2;
  543. }
  544. else if(typeStr == "Vec3" || typeStr == "RVec3")
  545. {
  546. member.m_type = ShaderVariableDataType::kVec3;
  547. }
  548. else if(typeStr == "Vec4" || typeStr == "RVec4")
  549. {
  550. member.m_type = ShaderVariableDataType::kVec4;
  551. }
  552. else if(typeStr == "U32")
  553. {
  554. member.m_type = ShaderVariableDataType::kU32;
  555. }
  556. if(member.m_type == ShaderVariableDataType::kNone)
  557. {
  558. ANKI_PP_ERROR_MALFORMED_MSG("Unrecognized type");
  559. }
  560. // Name
  561. ++begin;
  562. member.m_name = *begin;
  563. // Rest
  564. member.m_offset = (structure.m_members.getSize())
  565. ? structure.m_members.getBack().m_offset + getShaderVariableDataTypeInfo(structure.m_members.getBack().m_type).m_size
  566. : 0;
  567. getAppendSourceList().pushBackSprintf("#define %s_%s_OFFSETOF %u", structure.m_name.cstr(), member.m_name.cstr(), member.m_offset);
  568. getAppendSourceList().pushBackSprintf("\t%s %s;", typeStr.cstr(), member.m_name.cstr());
  569. structure.m_members.emplaceBack(std::move(member));
  570. return Error::kNone;
  571. }
  572. Error ShaderProgramParser::parsePragmaStructEnd(const ShaderCompilerString* begin, const ShaderCompilerString* end, CString line, CString fname)
  573. {
  574. ANKI_ASSERT(m_insideStruct);
  575. if(begin != end)
  576. {
  577. ANKI_PP_ERROR_MALFORMED();
  578. }
  579. GhostStruct& gstruct = m_ghostStructs.getBack();
  580. const CString structName = gstruct.m_name;
  581. if(gstruct.m_members.isEmpty())
  582. {
  583. ANKI_PP_ERROR_MALFORMED_MSG("Struct doesn't have any members");
  584. }
  585. getAppendSourceList().pushBack("};");
  586. for(U32 i = 0; i < gstruct.m_members.getSize(); ++i)
  587. {
  588. const Member& m = gstruct.m_members[i];
  589. // # define XXX_LOAD()
  590. getAppendSourceList().pushBackSprintf("#\tdefine %s_%s_LOAD(buff, offset) buff.Load<%s>(%s_%s_OFFSETOF + (offset))%s", structName.cstr(),
  591. m.m_name.cstr(), getShaderVariableDataTypeInfo(m.m_type).m_name, structName.cstr(), m.m_name.cstr(),
  592. (i != gstruct.m_members.getSize() - 1) ? "," : "");
  593. }
  594. // Now define the structure LOAD in HLSL
  595. getAppendSourceList().pushBackSprintf("#define load%s(buff, offset) { \\", structName.cstr());
  596. for(U32 i = 0; i < gstruct.m_members.getSize(); ++i)
  597. {
  598. const Member& m = gstruct.m_members[i];
  599. getAppendSourceList().pushBackSprintf("\t%s_%s_LOAD(buff, offset) \\", structName.cstr(), m.m_name.cstr());
  600. }
  601. getAppendSourceList().pushBack("}");
  602. // Done
  603. m_insideStruct = false;
  604. return Error::kNone;
  605. }
  606. Error ShaderProgramParser::parsePragma16bit(const ShaderCompilerString* begin, const ShaderCompilerString* end, CString line, CString fname)
  607. {
  608. ANKI_ASSERT(begin && end);
  609. // Check tokens
  610. if(begin != end)
  611. {
  612. ANKI_PP_ERROR_MALFORMED();
  613. }
  614. m_16bitTypes = true;
  615. return Error::kNone;
  616. }
  617. Error ShaderProgramParser::parseFile(CString fname, U32 depth)
  618. {
  619. // First check the depth
  620. if(depth > kMaxIncludeDepth)
  621. {
  622. ANKI_SHADER_COMPILER_LOGE("The include depth is too high. Probably circular includance");
  623. }
  624. Bool foundPragmaOnce = false;
  625. // Load file in lines
  626. ShaderCompilerString txt;
  627. ANKI_CHECK(m_fsystem->readAllText(fname, txt));
  628. m_hash = (m_hash) ? computeHash(txt.cstr(), txt.getLength()) : appendHash(txt.cstr(), txt.getLength(), m_hash);
  629. ShaderCompilerStringList lines;
  630. lines.splitString(txt, '\n', true);
  631. if(lines.getSize() < 1)
  632. {
  633. ANKI_SHADER_COMPILER_LOGE("Source is empty");
  634. }
  635. getAppendSourceList().pushBackSprintf("#line 0 \"%s\"", fname.cstr());
  636. // Parse lines
  637. U32 lineNo = 1;
  638. for(const ShaderCompilerString& line : lines)
  639. {
  640. if(line.isEmpty())
  641. {
  642. getAppendSourceList().pushBack(" ");
  643. }
  644. else if(line.find("pragma") != ShaderCompilerString::kNpos || line.find("include") != ShaderCompilerString::kNpos)
  645. {
  646. // Possibly a preprocessor directive we care
  647. ANKI_CHECK(parseLine(line.toCString(), fname, foundPragmaOnce, depth, lineNo));
  648. }
  649. else
  650. {
  651. // Just append the line
  652. getAppendSourceList().pushBack(line.toCString());
  653. }
  654. ++lineNo;
  655. }
  656. if(foundPragmaOnce)
  657. {
  658. // Append the guard
  659. getAppendSourceList().pushBack("#endif // Include guard");
  660. }
  661. return Error::kNone;
  662. }
  663. Error ShaderProgramParser::parse()
  664. {
  665. ANKI_ASSERT(!m_fname.isEmpty());
  666. ANKI_ASSERT(m_commonSourceLines.isEmpty());
  667. const CString fname = m_fname;
  668. // Parse recursively
  669. ANKI_CHECK(parseFile(fname, 0));
  670. // Checks
  671. {
  672. if(m_techniques.getSize() == 0)
  673. {
  674. ANKI_SHADER_COMPILER_LOGE("No techniques were found");
  675. return Error::kUserData;
  676. }
  677. if(insideTechnique())
  678. {
  679. ANKI_SHADER_COMPILER_LOGE("Forgot to end a technique");
  680. return Error::kUserData;
  681. }
  682. if(m_insideStruct)
  683. {
  684. ANKI_SHADER_COMPILER_LOGE("Forgot to end a struct");
  685. return Error::kUserData;
  686. }
  687. }
  688. // Create the code lines for each technique
  689. for(U32 i = 0; i < m_techniques.getSize(); ++i)
  690. {
  691. for(ShaderType s : EnumIterable<ShaderType>())
  692. {
  693. if(m_techniqueExtras[i].m_sourceLines[s].getSize())
  694. {
  695. ANKI_ASSERT(!!(m_techniques[i].m_shaderTypes & ShaderTypeBit(1 << s)));
  696. m_techniqueExtras[i].m_sourceLines[s].join("\n", m_techniqueExtras[i].m_sources[s]);
  697. m_techniqueExtras[i].m_sourceLines[s].destroy(); // Free mem
  698. }
  699. else
  700. {
  701. ANKI_ASSERT(!(m_techniques[i].m_shaderTypes & ShaderTypeBit(1 << s)));
  702. }
  703. }
  704. }
  705. m_commonSourceLines.destroy(); // Free mem
  706. return Error::kNone;
  707. }
  708. void ShaderProgramParser::generateAnkiShaderHeader(ShaderType shaderType, ShaderCompilerString& header)
  709. {
  710. header.sprintf(kShaderHeader, kShaderStageNames[shaderType].cstr(), kMaxBindlessTextures, kMaxBindlessReadonlyTextureBuffers);
  711. }
  712. void ShaderProgramParser::generateVariant(ConstWeakArray<MutatorValue> mutation, const ShaderProgramParserTechnique& technique, ShaderType shaderType,
  713. ShaderCompilerString& source) const
  714. {
  715. // Sanity checks
  716. ANKI_ASSERT(mutation.getSize() == m_mutators.getSize());
  717. for(U32 i = 0; i < mutation.getSize(); ++i)
  718. {
  719. ANKI_ASSERT(mutatorHasValue(m_mutators[i], mutation[i]) && "Value not found");
  720. }
  721. ANKI_ASSERT(!!(technique.m_shaderTypes & ShaderTypeBit(1 << shaderType)));
  722. source.destroy();
  723. ANKI_ASSERT(&technique >= m_techniques.getBegin() && &technique < m_techniques.getEnd());
  724. const U32 tIdx = U32(&technique - m_techniques.getBegin());
  725. for(U32 i = 0; i < m_defineNames.getSize(); ++i)
  726. {
  727. source += ShaderCompilerString().sprintf("#define %s %d\n", m_defineNames[i].cstr(), m_defineValues[i]);
  728. }
  729. for(U32 i = 0; i < mutation.getSize(); ++i)
  730. {
  731. if(!!(technique.m_activeMutators[shaderType] & (1_U64 << U64(i))))
  732. {
  733. source += ShaderCompilerString().sprintf("#define %s %d\n", m_mutators[i].m_name.cstr(), mutation[i]);
  734. }
  735. }
  736. source += ShaderCompilerString().sprintf("#define ANKI_TECHNIQUE_%s 1\n", technique.m_name.cstr());
  737. ShaderCompilerString header;
  738. generateAnkiShaderHeader(shaderType, header);
  739. source += header;
  740. if(m_16bitTypes)
  741. {
  742. source += "#define ANKI_SUPPORTS_16BIT_TYPES 1\n";
  743. }
  744. else
  745. {
  746. source += "#define ANKI_SUPPORTS_16BIT_TYPES 0\n";
  747. }
  748. ANKI_ASSERT(m_techniqueExtras[tIdx].m_sources[shaderType].getLength() > 0);
  749. source += m_techniqueExtras[tIdx].m_sources[shaderType];
  750. }
  751. Bool ShaderProgramParser::mutatorHasValue(const ShaderProgramParserMutator& mutator, MutatorValue value)
  752. {
  753. for(MutatorValue v : mutator.m_values)
  754. {
  755. if(value == v)
  756. {
  757. return true;
  758. }
  759. }
  760. return false;
  761. }
  762. Bool ShaderProgramParser::skipMutation(ConstWeakArray<MutatorValue> mutation) const
  763. {
  764. ANKI_ASSERT(mutation.getSize() == m_mutators.getSize());
  765. for(const PartialMutationSkip& skip : m_skipMutations)
  766. {
  767. Bool doSkip = true;
  768. for(U32 i = 0; i < m_mutators.getSize(); ++i)
  769. {
  770. if(skip.m_partialMutation[i] == std::numeric_limits<MutatorValue>::max())
  771. {
  772. // Don't care
  773. continue;
  774. }
  775. if(skip.m_partialMutation[i] != mutation[i])
  776. {
  777. doSkip = false;
  778. break;
  779. }
  780. }
  781. if(doSkip)
  782. {
  783. return true;
  784. }
  785. }
  786. return false;
  787. }
  788. } // end namespace anki