ShaderProgramParser.cpp 22 KB

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