This repository was archived by the owner on Apr 21, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 38
/
Copy pathSpirvCompiler.cpp
2128 lines (1778 loc) · 61.7 KB
/
SpirvCompiler.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2018-2020, Zhirnov Andrey. For more information see 'LICENSE'
#include "SpirvCompiler.h"
#include "PrivateDefines.h"
#include "stl/Algorithms/StringUtils.h"
#include "stl/Algorithms/StringParser.h"
#include "stl/Stream/FileStream.h"
#include "framegraph/Shared/EnumUtils.h"
#include "VCachedDebuggableShaderData.h"
// glslang includes
#ifdef COMPILER_MSVC
# pragma warning (push)
# pragma warning (disable: 4005)
#endif
#ifdef COMPILER_CLANG
# pragma clang diagnostic push
# pragma clang diagnostic ignored "-Wdouble-promotion"
#endif
#include "glslang/Include/revision.h"
#include "glslang/Public/ShaderLang.h"
#include "glslang/MachineIndependent/localintermediate.h"
#include "glslang/Include/intermediate.h"
#include "SPIRV/doc.h"
#include "SPIRV/disassemble.h"
#include "SPIRV/GlslangToSpv.h"
#include "SPIRV/GLSL.std.450.h"
#ifdef COMPILER_MSVC
# pragma warning (pop)
#endif
#ifdef COMPILER_CLANG
# pragma clang diagnostic pop
#endif
// SPIRV-Tools includes
#ifdef FG_GLSLANG_ENABLE_OPT
# include "spirv-tools/optimizer.hpp"
# include "spirv-tools/libspirv.h"
#else
# pragma message("SPIRV-Tolls library is missing, SPIRV optimization will be disabled")
#endif
#ifndef FG_ENABLE_GLSL_TRACE
# pragma message("GLSL-Trace library is missing, shader debugging and profiling will be disabled")
#endif
#if GLSLANG_PATCH_LEVEL < 3743
# error update glslang!
#endif
namespace FG
{
//
// Shader Includer
//
class SpirvCompiler::ShaderIncluder final : public glslang::TShader::Includer
{
// types
private:
struct IncludeResultImpl final : IncludeResult
{
const String _data;
IncludeResultImpl (String &&data, const String& headerName, void* userData = null) :
IncludeResult{headerName, null, 0, userData}, _data{std::move(data)}
{
const_cast<const char*&>(headerData) = _data.c_str();
const_cast<size_t&>(headerLength) = _data.length();
}
ND_ StringView GetSource () const { return _data; }
};
using IncludeResultPtr_t = UniquePtr< IncludeResultImpl >;
using IncludeResults_t = Array< IncludeResultPtr_t >;
using IncludedFiles_t = HashMap< String, Ptr<IncludeResultImpl> >;
// variables
private:
IncludeResults_t _results;
IncludedFiles_t _includedFiles;
Array<String> const& _directories;
// methods
public:
explicit ShaderIncluder (const Array<String> &dirs) : _directories{dirs} {}
~ShaderIncluder () override {}
//bool GetHeaderSource (StringView header, OUT StringView &source) const;
ND_ IncludedFiles_t const& GetIncludedFiles () const { return _includedFiles; }
// TShader::Includer //
IncludeResult* includeSystem (const char* headerName, const char* includerName, size_t inclusionDepth) override;
IncludeResult* includeLocal (const char* headerName, const char* includerName, size_t inclusionDepth) override;
void releaseInclude (IncludeResult *) override {}
};
/*
=================================================
GetHeaderSource
=================================================
*
bool SpirvCompiler::ShaderIncluder::GetHeaderSource (StringView header, OUT StringView &source) const
{
auto iter = _includedFiles.find( String{header} );
if ( iter != _includedFiles.end() )
{
source = iter->second->GetSource();
return true;
}
return false;
}
/*
=================================================
includeSystem
=================================================
*/
SpirvCompiler::ShaderIncluder::IncludeResult*
SpirvCompiler::ShaderIncluder::includeSystem (const char*, const char *, size_t)
{
return null;
}
/*
=================================================
includeLocal
=================================================
*/
SpirvCompiler::ShaderIncluder::IncludeResult*
SpirvCompiler::ShaderIncluder::includeLocal (const char* headerName, const char *, size_t)
{
ASSERT( _directories.size() );
# ifdef FS_HAS_FILESYSTEM
for (auto& folder : _directories)
{
FS::path fpath = FS::path( folder ) / headerName;
if ( not FS::exists( fpath ))
continue;
const String filename = fpath.make_preferred().string();
// prevent recursive include
if ( _includedFiles.count( filename ))
return _results.emplace_back(new IncludeResultImpl{ "// skip header\n", headerName }).get();
FileRStream file{ filename };
CHECK_ERR( file.IsOpen() );
String data;
CHECK_ERR( file.Read( size_t(file.Size()), OUT data ));
auto* result = _results.emplace_back(new IncludeResultImpl{ std::move(data), headerName }).get();
_includedFiles.insert_or_assign( filename, result );
return result;
}
# else
for (auto& folder : _directories)
{
String fpath = folder;
if ( fpath.size() and not (fpath.back() == '/' or fpath.back() == '\\') )
fpath += '/';
fpath += headerName;
FileRStream file{ fpath };
if ( not file.IsOpen() )
continue;
if ( _includedFiles.count( fpath ))
return _results.emplace_back(new IncludeResultImpl{ " ", headerName }).get();
String data;
CHECK_ERR( file.Read( size_t(file.Size()), OUT data ));
auto* result = _results.emplace_back(new IncludeResultImpl{ std::move(data), headerName }).get();
_includedFiles.insert_or_assign( fpath, result );
return result;
}
# endif
return null;
}
//-----------------------------------------------------------------------------
//
// GLSLang Result
//
struct SpirvCompiler::GLSLangResult
{
glslang::TProgram prog;
UniquePtr< glslang::TShader > shader;
};
/*
=================================================
constructor
=================================================
*/
SpirvCompiler::SpirvCompiler (const Array<String> &dirs) : _directories{dirs}
{
glslang::InitializeProcess();
_GenerateResources( OUT _builtinResource );
}
/*
=================================================
destructor
=================================================
*/
SpirvCompiler::~SpirvCompiler ()
{
glslang::FinalizeProcess();
}
/*
=================================================
SetCompilationFlags
=================================================
*/
void SpirvCompiler::SetCompilationFlags (EShaderCompilationFlags flags)
{
_compilerFlags = flags;
}
/*
=================================================
SetDebugFlags
=================================================
*/
void SpirvCompiler::SetDebugFlags (EShaderLangFormat flags)
{
_debugFlags = flags;
}
/*
=================================================
SetShaderClockFeatures
=================================================
*/
void SpirvCompiler::SetShaderClockFeatures (bool shaderSubgroupClock, bool shaderDeviceClock)
{
_features.shaderSubgroupClock = shaderSubgroupClock;
_features.shaderDeviceClock = shaderDeviceClock;
}
/*
=================================================
SetShaderFeatures
=================================================
*/
void SpirvCompiler::SetShaderFeatures (bool vertexPipelineStoresAndAtomics, bool fragmentStoresAndAtomics)
{
_features.vertexPipelineStoresAndAtomics = vertexPipelineStoresAndAtomics;
_features.fragmentStoresAndAtomics = fragmentStoresAndAtomics;
}
/*
=================================================
_CheckShaderFeatures
=================================================
*/
bool SpirvCompiler::_CheckShaderFeatures (EShader shaderType) const
{
BEGIN_ENUM_CHECKS();
switch ( shaderType )
{
case EShader::Vertex :
case EShader::TessControl :
case EShader::TessEvaluation :
case EShader::Geometry :
return _features.vertexPipelineStoresAndAtomics;
case EShader::Fragment :
return _features.fragmentStoresAndAtomics;
case EShader::Compute :
return true;
case EShader::MeshTask :
case EShader::Mesh :
return true;
case EShader::RayGen :
case EShader::RayAnyHit :
case EShader::RayClosestHit :
case EShader::RayMiss :
case EShader::RayIntersection :
case EShader::RayCallable :
return true;
case EShader::_Count :
case EShader::Unknown :
break;
}
END_ENUM_CHECKS();
return false;
}
/*
=================================================
Compile
=================================================
*/
bool SpirvCompiler::Compile (EShader shaderType, EShaderLangFormat srcShaderFmt, EShaderLangFormat dstShaderFmt,
NtStringView entry, NtStringView source, StringView debugName,
OUT PipelineDescription::Shader &outShader, OUT ShaderReflection &outReflection, OUT String &log)
{
log.clear();
COMP_CHECK_ERR( (dstShaderFmt & EShaderLangFormat::_StorageFormatMask) == EShaderLangFormat::SPIRV );
dstShaderFmt &= ~EShaderLangFormat::_DebugModeMask;
_currentStage = EShaderStages_FromShader( shaderType );
// compile shader without debug info
{
ShaderIncluder includer {_directories};
GLSLangResult glslang_data;
COMP_CHECK_ERR( _ParseGLSL( shaderType, srcShaderFmt, dstShaderFmt, entry, {source.c_str()}, INOUT includer, OUT glslang_data, INOUT log ));
Array<uint> spirv;
COMP_CHECK_ERR( _CompileSPIRV( glslang_data, OUT spirv, INOUT log ));
COMP_CHECK_ERR( _BuildReflection( glslang_data, OUT outReflection ));
if ( AllBits( _compilerFlags, EShaderCompilationFlags::ParseAnnotations ))
{
_ParseAnnotations( StringView{source}, INOUT outReflection );
for (auto& file : includer.GetIncludedFiles()) {
_ParseAnnotations( file.second->GetSource(), INOUT outReflection );
}
}
outShader.specConstants = outReflection.specConstants;
outShader.AddShaderData( dstShaderFmt, StringView{entry}, std::move(spirv), debugName );
}
// compile shader with debug info
#ifdef FG_ENABLE_GLSL_TRACE
using DebugUtils = VCachedDebuggableSpirv::ShaderDebugUtils_t;
using DebugUtilsPtr = VCachedDebuggableSpirv::ShaderDebugUtilsPtr;
EShaderLangFormat dbg_mode = (srcShaderFmt & EShaderLangFormat::_DebugModeMask) | _debugFlags;
if ( dbg_mode != EShaderLangFormat::Unknown )
{
CHECK_ERR( _CheckShaderFeatures( shaderType ));
for (uint j = BitScanForward(dbg_mode); (1u << j) <= uint(EShaderLangFormat::_DebugModeMask); ++j)
{
EShaderLangFormat mode = EShaderLangFormat(1u << j);
if ( not AllBits( dbg_mode, mode ))
continue;
ShaderIncluder includer {_directories};
GLSLangResult glslang_data;
COMP_CHECK_ERR( _ParseGLSL( shaderType, srcShaderFmt, dstShaderFmt, entry, {source.c_str()}, INOUT includer, OUT glslang_data, INOUT log ));
DebugUtilsPtr debug_utils {new DebugUtils{ InPlaceIndex<ShaderTrace> }};
ShaderTrace& trace = UnionGet<ShaderTrace>( *debug_utils.get() );
EShLanguage stage = glslang_data.shader->getStage();
glslang::TIntermediate& interm = *glslang_data.prog.getIntermediate( stage );
trace.SetSource( source.c_str(), source.length() );
for (auto& file : includer.GetIncludedFiles()) {
trace.IncludeSource( file.second->headerName.data(), file.second->GetSource().data(), file.second->GetSource().length() );
}
switch ( mode )
{
case EShaderLangFormat::EnableDebugTrace :
COMP_CHECK_ERR( trace.InsertTraceRecording( interm, FG_DebugDescriptorSet ));
break;
case EShaderLangFormat::EnableProfiling :
COMP_CHECK_ERR( trace.InsertFunctionProfiler( interm, FG_DebugDescriptorSet, _features.shaderSubgroupClock, _features.shaderDeviceClock ));
break;
case EShaderLangFormat::EnableTimeMap :
COMP_CHECK_ERR( trace.InsertShaderClockMap( interm, FG_DebugDescriptorSet ));
break;
default :
FG_LOGI( "unsupported shader debug mode: 0x" + ToString<16>( mode ));
break;
}
Array<uint> spirv;
COMP_CHECK_ERR( _CompileSPIRV( glslang_data, OUT spirv, INOUT log ));
outShader.data.insert({ dstShaderFmt | mode, MakeShared<VCachedDebuggableSpirv>( StringView{entry}, std::move(spirv), debugName, std::move(debug_utils) ) });
}
}
#endif // FG_ENABLE_GLSL_TRACE
return true;
}
/*
=================================================
ConvertShaderType
=================================================
*/
ND_ static EShLanguage ConvertShaderType (EShader shaderType)
{
BEGIN_ENUM_CHECKS();
switch ( shaderType )
{
case EShader::Vertex : return EShLangVertex;
case EShader::TessControl : return EShLangTessControl;
case EShader::TessEvaluation : return EShLangTessEvaluation;
case EShader::Geometry : return EShLangGeometry;
case EShader::Fragment : return EShLangFragment;
case EShader::Compute : return EShLangCompute;
case EShader::MeshTask : return EShLangTaskNV;
case EShader::Mesh : return EShLangMeshNV;
case EShader::RayGen : return EShLangRayGenNV;
case EShader::RayAnyHit : return EShLangAnyHitNV;
case EShader::RayClosestHit : return EShLangClosestHitNV;
case EShader::RayMiss : return EShLangMissNV;
case EShader::RayIntersection: return EShLangIntersectNV;
case EShader::RayCallable : return EShLangCallableNV;
case EShader::Unknown :
case EShader::_Count : break; // to shutup warnings
}
END_ENUM_CHECKS();
RETURN_ERR( "unknown shader type", EShLangCount );
}
/*
=================================================
EShaderLangFormat_GetVersion
=================================================
*/
ND_ static int EShaderLangFormat_GetVersion (EShaderLangFormat fmt)
{
return int(fmt & EShaderLangFormat::_VersionMask) >> uint(EShaderLangFormat::_VersionOffset);
}
/*
=================================================
_ParseGLSL
=================================================
*/
bool SpirvCompiler::_ParseGLSL (EShader shaderType, EShaderLangFormat srcShaderFmt, EShaderLangFormat dstShaderFmt,
NtStringView entry, ArrayView<const char *> source, INOUT ShaderIncluder &includer,
OUT GLSLangResult &glslangData, OUT String &log)
{
using namespace glslang;
EShClient client = EShClientOpenGL;
EshTargetClientVersion client_version = EShTargetOpenGL_450;
EShTargetLanguage target = EShTargetNone;
EShTargetLanguageVersion target_version = EShTargetLanguageVersion(0);
int version = 0;
int sh_version = 460; // TODO
EProfile sh_profile = ENoProfile;
EShSource sh_source;
#ifdef FG_GLSLANG_ENABLE_OPT
_spirvTraget = SPV_ENV_UNIVERSAL_1_0;
#endif
_targetVulkan = false;
switch ( srcShaderFmt & EShaderLangFormat::_ApiMask )
{
case EShaderLangFormat::OpenGL :
sh_source = EShSourceGlsl;
version = EShaderLangFormat_GetVersion( srcShaderFmt );
sh_profile = version >= 330 ? ECoreProfile : ENoProfile;
break;
case EShaderLangFormat::OpenGLES :
sh_source = EShSourceGlsl;
version = EShaderLangFormat_GetVersion( srcShaderFmt );
sh_profile = EEsProfile;
break;
case EShaderLangFormat::DirectX :
sh_source = EShSourceHlsl;
version = EShaderLangFormat_GetVersion( srcShaderFmt );
sh_profile = ENoProfile; // TODO: check
break;
case EShaderLangFormat::Vulkan :
sh_source = EShSourceGlsl;
version = EShaderLangFormat_GetVersion( srcShaderFmt );
sh_profile = ECoreProfile;
break;
default :
COMP_RETURN_ERR( "unsupported shader format" );
}
switch ( dstShaderFmt & EShaderLangFormat::_ApiMask )
{
case EShaderLangFormat::Vulkan :
{
uint dst_ver = EShaderLangFormat_GetVersion( dstShaderFmt );
client = EShClientVulkan;
target = EShTargetSpv;
_targetVulkan = true;
switch ( dst_ver )
{
case 100 :
client_version = EShTargetVulkan_1_0;
target_version = EShTargetSpv_1_0;
#ifdef FG_GLSLANG_ENABLE_OPT
_spirvTraget = SPV_ENV_VULKAN_1_0;
#endif
break;
case 110 :
client_version = EShTargetVulkan_1_1;
target_version = EShTargetSpv_1_3;
#ifdef FG_GLSLANG_ENABLE_OPT
_spirvTraget = SPV_ENV_VULKAN_1_1;
#endif
break;
case 120 :
client_version = EShTargetVulkan_1_1; // TODO
target_version = EShTargetSpv_1_4;
#ifdef FG_GLSLANG_ENABLE_OPT
_spirvTraget = SPV_ENV_VULKAN_1_1_SPIRV_1_4;
#endif
break;
default :
RETURN_ERR( "Unsupported vulkan version: " + ToString(dst_ver) );
}
break;
}
case EShaderLangFormat::OpenGL :
if ( (dstShaderFmt & EShaderLangFormat::_FormatMask) == EShaderLangFormat::SPIRV )
{
target = EShTargetSpv;
target_version = EShTargetSpv_1_0;
#ifdef FG_GLSLANG_ENABLE_OPT
_spirvTraget = SPV_ENV_OPENGL_4_5;
#endif
}
break;
}
EShMessages messages = EShMsgDefault;
EShLanguage stage = ConvertShaderType( shaderType );
auto& shader = glslangData.shader;
shader.reset( new TShader( stage ));
shader->setStrings( source.data(), int(source.size()) );
shader->setEntryPoint( entry.c_str() );
shader->setEnvInput( sh_source, stage, client, version );
shader->setEnvClient( client, client_version );
shader->setEnvTarget( target, target_version );
if ( not shader->parse( &_builtinResource, sh_version, sh_profile, false, true, messages, includer ))
{
log += shader->getInfoLog();
_OnCompilationFailed( source, INOUT log );
return false;
}
glslangData.prog.addShader( shader.get() );
if ( not glslangData.prog.link( messages ))
{
log += glslangData.prog.getInfoLog();
_OnCompilationFailed( source, INOUT log );
return false;
}
return true;
}
/*
=================================================
_CompileSPIRV
=================================================
*/
bool SpirvCompiler::_CompileSPIRV (const GLSLangResult &glslangData, OUT Array<uint> &spirv, OUT String &log) const
{
using namespace glslang;
const TIntermediate* intermediate = glslangData.prog.getIntermediate( glslangData.shader->getStage() );
COMP_CHECK_ERR( intermediate );
SpvOptions spv_options;
spv::SpvBuildLogger logger;
spv_options.generateDebugInfo = false;
spv_options.disableOptimizer = not AllBits( _compilerFlags, EShaderCompilationFlags::Optimize );
spv_options.optimizeSize = AllBits( _compilerFlags, EShaderCompilationFlags::OptimizeSize );
GlslangToSpv( *intermediate, OUT spirv, &logger, &spv_options );
log += logger.getAllMessages();
#ifdef FG_GLSLANG_ENABLE_OPT
if ( AllBits( _compilerFlags, EShaderCompilationFlags::StrongOptimization ))
CHECK_ERR( _OptimizeSPIRV( INOUT spirv, OUT log ));
#endif
return true;
}
#ifdef FG_GLSLANG_ENABLE_OPT
/*
=================================================
DisassembleSPIRV
=================================================
*/
inline bool DisassembleSPIRV (spv_target_env targetEnv, const Array<uint> &spirv, OUT String &result)
{
result.clear();
spv_context ctx = spvContextCreate( targetEnv );
CHECK_ERR( ctx != null );
spv_text text = null;
spv_diagnostic diagnostic = null;
if ( spvBinaryToText( ctx, spirv.data(), spirv.size(), 0, &text, &diagnostic ) == SPV_SUCCESS )
{
result = String{ text->str, text->length };
}
spvTextDestroy( text );
spvDiagnosticDestroy( diagnostic );
spvContextDestroy( ctx );
return true;
}
/*
=================================================
_OptimizeSPIRV
=================================================
*/
bool SpirvCompiler::_OptimizeSPIRV (INOUT Array<uint> &spirv, INOUT String &log) const
{
spv_target_env target_env = BitCast<spv_target_env>( _spirvTraget );
spvtools::Optimizer optimizer{ target_env };
optimizer.SetMessageConsumer(
[&log] (spv_message_level_t level, const char *source, const spv_position_t &position, const char *message) {
switch ( level )
{
case SPV_MSG_FATAL:
case SPV_MSG_INTERNAL_ERROR:
case SPV_MSG_ERROR:
log << "error: ";
break;
case SPV_MSG_WARNING:
log << "warning: ";
break;
case SPV_MSG_INFO:
case SPV_MSG_DEBUG:
log << "info: ";
break;
}
if ( source )
log << source << ":";
log << ToString(position.line) << ":" << ToString(position.column) << ":" << ToString(position.index) << ":";
if ( message )
log << " " << message;
});
optimizer.RegisterLegalizationPasses();
optimizer.RegisterSizePasses();
optimizer.RegisterPerformancePasses();
optimizer.RegisterPass(spvtools::CreateCompactIdsPass());
optimizer.RegisterPass(spvtools::CreateAggressiveDCEPass());;
optimizer.RegisterPass(spvtools::CreateRemoveDuplicatesPass());
optimizer.RegisterPass(spvtools::CreateCFGCleanupPass());
spvtools::OptimizerOptions spvOptOptions;
spvOptOptions.set_run_validator(false);
optimizer.Run(spirv.data(), spirv.size(), &spirv, spvOptOptions);
return true;
}
#endif // FG_GLSLANG_ENABLE_OPT
/*
=================================================
ReadLine
=================================================
*/
inline bool ReadLine (StringView log, INOUT size_t &pos, OUT StringView &line)
{
size_t begin = pos;
line = Default;
// find new line
for (; pos < log.size(); ++pos)
{
const char c = log[pos];
if ( c == '\r' or c == '\n' )
break;
}
if ( pos == begin )
return false;
line = log.substr( begin, pos - begin );
// skip empty lines
for (; pos < log.size(); ++pos)
{
const char c = log[pos];
if ( c != '\r' and c != '\n' )
break;
}
return true;
}
/*
=================================================
ParseGLSLError
=================================================
*/
struct GLSLErrorInfo
{
StringView description;
StringView fileName;
uint sourceIndex;
size_t line;
bool isError;
GLSLErrorInfo () : sourceIndex{0}, line{UMax}, isError{false} {}
};
static bool ParseGLSLError (StringView line, OUT GLSLErrorInfo &info)
{
const StringView c_error = "error";
const StringView c_warning = "warning";
size_t pos = 0;
const auto ReadToken = [&line, &pos] (OUT bool &isNumber)
{{
isNumber= true;
const size_t start = pos;
for (; pos < line.length() and line[pos] != ':'; ++pos) {
isNumber &= (line[pos] >= '0' and line[pos] <= '9');
}
return line.substr( start, pos - start );
}};
const auto SkipSeparator = [&line, &pos] ()
{{
if ( pos+1 < line.length() and line[pos] == ':' and line[pos+1] == ' ' )
pos += 2;
else
if ( pos < line.length() and line[pos] == ':' )
pos += 1;
else
return false;
return true;
}};
//---------------------------------------------------------------------------
// parse error/warning/...
if ( StartsWithIC( line, c_error ))
{
pos += c_error.length();
info.isError = true;
}
else
if ( StartsWithIC( line, c_warning ))
{
pos += c_warning.length();
info.isError = false;
}
else
return false;
if ( not SkipSeparator() )
return false;
// parse source index or header name
{
bool is_number;
const StringView src = ReadToken( OUT is_number );
if ( not SkipSeparator() )
return false;
if ( not is_number )
info.fileName = src;
else
info.sourceIndex = uint(std::stoi( String(src) ));
}
// parse line number
{
bool is_number;
const StringView src = ReadToken( OUT is_number );
if ( not SkipSeparator() or not is_number )
return false;
info.line = uint(std::stoi( String(src) ));
}
info.description = line.substr( pos );
return true;
}
/*
=================================================
_OnCompilationFailed
=================================================
*/
bool SpirvCompiler::_OnCompilationFailed (ArrayView<const char *> source, INOUT String &log) const
{
// glslang errors format:
// pattern: <error/warning>: <number>:<line>: <description>
// pattern: <error/warning>: <file>:<line>: <description>
StringView line;
uint line_number = 0;
size_t prev_line = UMax;
size_t pos = 0;
String str; str.reserve( log.length() );
Array<size_t> num_lines; num_lines.resize( source.size() );
for (; ReadLine( log, INOUT pos, OUT line ); ++line_number)
{
GLSLErrorInfo error_info;
bool added = false;
if ( ParseGLSLError( line, OUT error_info ))
{
// unite error in same source lines
if ( prev_line == error_info.line )
{
str << line << "\n";
continue;
}
prev_line = error_info.line;
if ( error_info.fileName.empty() )
{
// search in sources
StringView cur_source = error_info.sourceIndex < source.size() ? source[ error_info.sourceIndex ] : "";
size_t lines_count = error_info.sourceIndex < num_lines.size() ? num_lines[ error_info.sourceIndex ] : 0;
if ( lines_count == 0 and error_info.sourceIndex < num_lines.size() )
{
lines_count = StringParser::CalculateNumberOfLines( cur_source ) + 1;
num_lines[ error_info.sourceIndex ] = lines_count;
}
CHECK( error_info.line <= lines_count );
size_t line_pos = 0;
CHECK( StringParser::MoveToLine( cur_source, INOUT line_pos, error_info.line-1 ));
StringView line_str;
StringParser::ReadLineToEnd( cur_source, INOUT line_pos, OUT line_str );
str << "in source (" << ToString(error_info.sourceIndex) << ": " << ToString(error_info.line) << "):\n\"" << line_str << "\"\n" << line << "\n";
added = true;
}
else
{
// search in header
/*StringView src;
if ( includer.GetHeaderSource( error_info.fileName, OUT src ))
{
const size_t lines_count = StringParser::CalculateNumberOfLines( src ) + 1;
const size_t local_line = error_info.line;
size_t line_pos = 0;
StringView line_str;
CHECK( local_line < lines_count );
CHECK( StringParser::MoveToLine( src, INOUT line_pos, local_line-1 ));
StringParser::ReadLineToEnd( src, INOUT line_pos, OUT line_str );
str << "in source (" << error_info.fileName << ": " << ToString(local_line) << "):\n\"" << line_str << "\"\n" << line << "\n";
added = true;
}*/
}
}
if ( not added )
{
str << DEBUG_ONLY( "<unknown> " << ) line << "\n";
}
}
std::swap( log, str );
return true;
}
/*
=================================================
_BuildReflection
=================================================
*/
bool SpirvCompiler::_BuildReflection (const GLSLangResult &glslangData, OUT ShaderReflection &result)
{
_intermediate = glslangData.prog.getIntermediate( glslangData.shader->getStage() );
COMP_CHECK_ERR( _intermediate );
// deserialize shader
TIntermNode* root = _intermediate->getTreeRoot();
COMP_CHECK_ERR( _ProcessExternalObjects( null, root, OUT result ));
COMP_CHECK_ERR( _ProcessShaderInfo( INOUT result ));
_intermediate = null;
return true;
}
/*
=================================================
_ParseAnnotations
----
supported annotations:
set <int> <string> -- descriptor set name
discard -- changes writeonly access to writediscard
dynamic-offset -- uniform or storage buffer uses dynamic offset
multiple annotations:
@<annotation-1>, @<annotation-2>, ...
=================================================
*/
bool SpirvCompiler::_ParseAnnotations (StringView source, INOUT ShaderReflection &reflection) const
{
struct Annotation
{
bool writeDiscard : 1;
bool dynamicOffset : 1;
Annotation () : writeDiscard{false}, dynamicOffset{false} {}
};
const auto ReadWord = [] (StringView src, INOUT size_t &pos)
{
const size_t start = pos;
for (bool is_word = true; is_word & (pos < src.length()); pos += is_word)
{
const char c = src[pos];
is_word = ((c >= 'a') & (c <= 'z')) | (c == '-');
}
return src.substr( start, pos - start );
};
const auto ParseDescSet = [this, &reflection] (StringView src, INOUT size_t &pos) -> bool
{
size_t start = UMax;