ShaderParser.cpp 22 KB

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