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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
|
// slang-check-shader.cpp
#include "slang-check-impl.h"
// This file encapsulates semantic checking logic primarily
// related to shaders, including validating entry points,
// enumerating specialization parameters, and validating
// attempts to specialize shader code.
#include "slang-lookup.h"
namespace Slang
{
static bool isValidThreadDispatchIDType(Type* type)
{
// Can accept a single int/unit
{
auto basicType = as<BasicExpressionType>(type);
if (basicType)
{
return (basicType->baseType == BaseType::Int || basicType->baseType == BaseType::UInt);
}
}
// Can be an int/uint vector from size 1 to 3
{
auto vectorType = as<VectorExpressionType>(type);
if (!vectorType)
{
return false;
}
auto elemCount = as<ConstantIntVal>(vectorType->elementCount);
if (elemCount->value < 1 || elemCount->value > 3)
{
return false;
}
// Must be a basic type
auto basicType = as<BasicExpressionType>(vectorType->elementType);
if (!basicType)
{
return false;
}
// Must be integral
return (basicType->baseType == BaseType::Int || basicType->baseType == BaseType::UInt);
}
}
/// Recursively walk `paramDeclRef` and add any existential/interface specialization parameters to `ioSpecializationParams`.
static void _collectExistentialSpecializationParamsRec(
ASTBuilder* astBuilder,
SpecializationParams& ioSpecializationParams,
DeclRef<VarDeclBase> paramDeclRef);
/// Recursively walk `type` and add any existential/interface specialization parameters to `ioSpecializationParams`.
static void _collectExistentialSpecializationParamsRec(
ASTBuilder* astBuilder,
SpecializationParams& ioSpecializationParams,
Type* type,
SourceLoc loc)
{
// Whether or not something is an array does not affect
// the number of existential slots it introduces.
//
while( auto arrayType = as<ArrayExpressionType>(type) )
{
type = arrayType->getElementType();
}
if( auto parameterGroupType = as<ParameterGroupType>(type) )
{
_collectExistentialSpecializationParamsRec(
astBuilder,
ioSpecializationParams,
parameterGroupType->getElementType(),
loc);
return;
}
else if (auto structuredBufferType = as<HLSLStructuredBufferTypeBase>(type))
{
_collectExistentialSpecializationParamsRec(
astBuilder, ioSpecializationParams, structuredBufferType->getElementType(), loc);
return;
}
if( auto declRefType = as<DeclRefType>(type) )
{
auto typeDeclRef = declRefType->declRef;
if( auto interfaceDeclRef = typeDeclRef.as<InterfaceDecl>() )
{
// Each leaf parameter of interface type adds a specialization
// parameter, which determines the concrete type(s) that may
// be provided as arguments for that parameter.
//
SpecializationParam specializationParam;
specializationParam.flavor = SpecializationParam::Flavor::ExistentialType;
specializationParam.loc = loc;
specializationParam.object = type;
ioSpecializationParams.add(specializationParam);
}
else if( auto structDeclRef = typeDeclRef.as<StructDecl>() )
{
// A structure type should recursively introduce
// existential slots for its fields.
//
for( auto fieldDeclRef : getFields(structDeclRef, MemberFilterStyle::Instance) )
{
_collectExistentialSpecializationParamsRec(
astBuilder,
ioSpecializationParams,
fieldDeclRef);
}
}
}
// TODO: We eventually need to handle cases like constant
// buffers and parameter blocks that may have existential
// element types.
}
static void _collectExistentialSpecializationParamsRec(
ASTBuilder* astBuilder,
SpecializationParams& ioSpecializationParams,
DeclRef<VarDeclBase> paramDeclRef)
{
_collectExistentialSpecializationParamsRec(
astBuilder,
ioSpecializationParams,
getType(astBuilder, paramDeclRef),
paramDeclRef.getLoc());
}
/// Collect any interface/existential specialization parameters for `paramDeclRef` into `ioParamInfo` and `ioSpecializationParams`
static void _collectExistentialSpecializationParamsForShaderParam(
ASTBuilder* astBuilder,
ShaderParamInfo& ioParamInfo,
SpecializationParams& ioSpecializationParams,
DeclRef<VarDeclBase> paramDeclRef)
{
Index beginParamIndex = ioSpecializationParams.getCount();
_collectExistentialSpecializationParamsRec(astBuilder, ioSpecializationParams, paramDeclRef);
Index endParamIndex = ioSpecializationParams.getCount();
ioParamInfo.firstSpecializationParamIndex = beginParamIndex;
ioParamInfo.specializationParamCount = endParamIndex - beginParamIndex;
}
void EntryPoint::_collectGenericSpecializationParamsRec(Decl* decl)
{
if(!decl)
return;
_collectGenericSpecializationParamsRec(decl->parentDecl);
auto genericDecl = as<GenericDecl>(decl);
if(!genericDecl)
return;
for(auto m : genericDecl->members)
{
if(auto genericTypeParam = as<GenericTypeParamDecl>(m))
{
SpecializationParam param;
param.flavor = SpecializationParam::Flavor::GenericType;
param.loc = genericTypeParam->loc;
param.object = genericTypeParam;
m_genericSpecializationParams.add(param);
}
else if(auto genericValParam = as<GenericValueParamDecl>(m))
{
SpecializationParam param;
param.flavor = SpecializationParam::Flavor::GenericValue;
param.loc = genericValParam->loc;
param.object = genericValParam;
m_genericSpecializationParams.add(param);
}
}
}
/// Enumerate the existential-type parameters of an `EntryPoint`.
///
/// Any parameters found will be added to the list of existential slots on `this`.
///
void EntryPoint::_collectShaderParams()
{
// We don't currently treat an entry point as having any
// *global* shader parameters.
//
// TODO: We could probably clean up the code a bit by treating
// an entry point as introducing a global shader parameter
// that is based on the implicit "parameters struct" type
// of the entry point itself.
// We collect the generic parameters of the entry point,
// along with those of any outer generics first.
//
_collectGenericSpecializationParamsRec(getFuncDecl());
// After geneic specialization parameters have been collected,
// we look through the value parameters of the entry point
// function and see if any of them introduce existential/interface
// specialization parameters.
//
// Note: we defensively test whether there is a function decl-ref
// because this routine gets called from the constructor, and
// a "dummy" entry point will have a null pointer for the function.
//
if( auto funcDeclRef = getFuncDeclRef() )
{
for( auto paramDeclRef : getParameters(funcDeclRef) )
{
ShaderParamInfo shaderParamInfo;
shaderParamInfo.paramDeclRef = paramDeclRef;
_collectExistentialSpecializationParamsForShaderParam(
getLinkage()->getASTBuilder(),
shaderParamInfo,
m_existentialSpecializationParams,
paramDeclRef);
m_shaderParams.add(shaderParamInfo);
}
}
}
bool isPrimaryDecl(
CallableDecl* decl)
{
SLANG_ASSERT(decl);
return (!decl->primaryDecl) || (decl == decl->primaryDecl);
}
FuncDecl* findFunctionDeclByName(
Module* translationUnit,
Name* name,
DiagnosticSink* sink)
{
auto translationUnitSyntax = translationUnit->getModuleDecl();
// We will look up any global-scope declarations in the translation
// unit that match the name of our entry point.
Decl* firstDeclWithName = nullptr;
if (!translationUnitSyntax->getMemberDictionary().TryGetValue(name, firstDeclWithName))
{
// If there doesn't appear to be any such declaration, then we are done.
sink->diagnose(translationUnitSyntax, Diagnostics::entryPointFunctionNotFound, name);
return nullptr;
}
// We found at least one global-scope declaration with the right name,
// but (1) it might not be a function, and (2) there might be
// more than one function.
//
// We'll walk the linked list of declarations with the same name,
// to see what we find. Along the way we'll keep track of the
// first function declaration we find, if any:
FuncDecl* entryPointFuncDecl = nullptr;
for (auto ee = firstDeclWithName; ee; ee = ee->nextInContainerWithSameName)
{
// Is this declaration a function?
if (auto funcDecl = as<FuncDecl>(ee))
{
// Skip non-primary declarations, so that
// we don't give an error when an entry
// point is forward-declared.
if (!isPrimaryDecl(funcDecl))
continue;
// is this the first one we've seen?
if (!entryPointFuncDecl)
{
// If so, this is a candidate to be
// the entry point function.
entryPointFuncDecl = funcDecl;
}
else
{
// Uh-oh! We've already seen a function declaration with this
// name before, so the whole thing is ambiguous. We need
// to diagnose and bail out.
sink->diagnose(translationUnitSyntax, Diagnostics::ambiguousEntryPoint, name);
// List all of the declarations that the user *might* mean
for (auto ff = firstDeclWithName; ff; ff = ff->nextInContainerWithSameName)
{
if (auto candidate = as<FuncDecl>(ff))
{
sink->diagnose(candidate, Diagnostics::entryPointCandidate, candidate->getName());
}
}
// Bail out.
return nullptr;
}
}
}
return entryPointFuncDecl;
}
// Validate that an entry point function conforms to any additional
// constraints based on the stage (and profile?) it specifies.
void validateEntryPoint(
EntryPoint* entryPoint,
DiagnosticSink* sink)
{
auto entryPointFuncDecl = entryPoint->getFuncDecl();
auto stage = entryPoint->getStage();
// TODO: We currently do minimal checking here, but this is the
// right place to perform the following validation checks:
//
// * Are the function input/output parameters and result type
// all valid for the chosen stage? (e.g., there shouldn't be
// an `OutputStream<X>` type in a vertex shader signature)
//
// * For any varying input/output, are there semantics specified
// (Note: this potentially overlaps with layout logic...), and
// are the system-value semantics valid for the given stage?
//
// There's actually a lot of detail to semantic checking, in
// that the AST-level code should probably be validating the
// use of system-value semantics by linking them to explicit
// declarations in the standard library. We should also be
// using profile information on those declarations to infer
// appropriate profile restrictions on the entry point.
//
// * Is the entry point actually usable on the given stage/profile?
// E.g., if we have a vertex shader that (transitively) calls
// `Texture2D.Sample`, then that should produce an error because
// that function is specific to the fragment profile/stage.
//
auto entryPointName = entryPointFuncDecl->getName();
auto module = getModule(entryPointFuncDecl);
auto linkage = module->getLinkage();
// Every entry point needs to have a stage specified either via
// command-line/API options, or via an explicit `[shader("...")]` attribute.
//
if( stage == Stage::Unknown )
{
sink->diagnose(entryPointFuncDecl, Diagnostics::entryPointHasNoStage, entryPointName);
}
if( stage == Stage::Hull )
{
// TODO: We could consider *always* checking any `[patchconsantfunc("...")]`
// attributes, so that they need to resolve to a function.
auto attr = entryPointFuncDecl->findModifier<PatchConstantFuncAttribute>();
if (attr)
{
if (attr->args.getCount() != 1)
{
sink->diagnose(attr, Diagnostics::badlyDefinedPatchConstantFunc, entryPointName);
return;
}
Expr* expr = attr->args[0];
StringLiteralExpr* stringLit = as<StringLiteralExpr>(expr);
if (!stringLit)
{
sink->diagnose(expr, Diagnostics::badlyDefinedPatchConstantFunc, entryPointName);
return;
}
// We look up the patch-constant function by its name in the module
// scope of the translation unit that declared the HS entry point.
//
// TODO: Eventually we probably want to do the lookup in the scope
// of the parent declarations of the entry point. E.g., if the entry
// point is a member function of a `struct`, then its patch-constant
// function should be allowed to be another member function of
// the same `struct`.
//
// In the extremely long run we may want to support an alternative to
// this attribute-based linkage between the two functions that
// make up the entry point.
//
Name* name = linkage->getNamePool()->getName(stringLit->value);
FuncDecl* patchConstantFuncDecl = findFunctionDeclByName(
module,
name,
sink);
if (!patchConstantFuncDecl)
{
sink->diagnose(expr, Diagnostics::attributeFunctionNotFound, name, "patchconstantfunc");
return;
}
attr->patchConstantFuncDecl = patchConstantFuncDecl;
}
}
else if(stage == Stage::Compute)
{
for(const auto& param : entryPointFuncDecl->getParameters())
{
if(auto semantic = param->findModifier<HLSLSimpleSemantic>())
{
const auto& semanticToken = semantic->name;
String lowerName = String(semanticToken.getContent()).toLower();
if(lowerName == "sv_dispatchthreadid")
{
Type* paramType = param->getType();
if(!isValidThreadDispatchIDType(paramType))
{
String typeString = paramType->toString();
sink->diagnose(param->loc, Diagnostics::invalidDispatchThreadIDType, typeString);
return;
}
}
}
}
}
}
// Given an entry point specified via API or command line options,
// attempt to find a matching AST declaration that implements the specified
// entry point. If such a function is found, then validate that it actually
// meets the requirements for the selected stage/profile.
//
// Returns an `EntryPoint` object representing the (unspecialized)
// entry point if it is found and validated, and null otherwise.
//
RefPtr<EntryPoint> findAndValidateEntryPoint(
FrontEndEntryPointRequest* entryPointReq)
{
// The first step in validating the entry point is to find
// the (unique) function declaration that matches its name.
//
// TODO: We may eventually want/need to extend this to
// account for nested names like `SomeStruct.vsMain`, or
// indeed even to handle generics.
//
auto compileRequest = entryPointReq->getCompileRequest();
auto translationUnit = entryPointReq->getTranslationUnit();
auto linkage = compileRequest->getLinkage();
auto sink = compileRequest->getSink();
auto translationUnitSyntax = translationUnit->getModuleDecl();
auto entryPointName = entryPointReq->getName();
// We will look up any global-scope declarations in the translation
// unit that match the name of our entry point.
Decl* firstDeclWithName = nullptr;
if( !translationUnitSyntax->getMemberDictionary().TryGetValue(entryPointName, firstDeclWithName))
{
// If there doesn't appear to be any such declaration, then
// we need to diagnose it as an error, and then bail out.
sink->diagnose(translationUnitSyntax, Diagnostics::entryPointFunctionNotFound, entryPointName);
return nullptr;
}
// We found at least one global-scope declaration with the right name,
// but (1) it might not be a function, and (2) there might be
// more than one function.
//
// We'll walk the linked list of declarations with the same name,
// to see what we find. Along the way we'll keep track of the
// first function declaration we find, if any:
//
FuncDecl* entryPointFuncDecl = nullptr;
for(auto ee = firstDeclWithName; ee; ee = ee->nextInContainerWithSameName)
{
// We want to support the case where the declaration is
// a generic function, so we will automatically
// unwrap any outer `GenericDecl` we find here.
//
auto decl = ee;
if(auto genericDecl = as<GenericDecl>(decl))
decl = genericDecl->inner;
// Is this declaration a function?
if (auto funcDecl = as<FuncDecl>(decl))
{
// Skip non-primary declarations, so that
// we don't give an error when an entry
// point is forward-declared.
if (!isPrimaryDecl(funcDecl))
continue;
// is this the first one we've seen?
if (!entryPointFuncDecl)
{
// If so, this is a candidate to be
// the entry point function.
entryPointFuncDecl = funcDecl;
}
else
{
// Uh-oh! We've already seen a function declaration with this
// name before, so the whole thing is ambiguous. We need
// to diagnose and bail out.
sink->diagnose(translationUnitSyntax, Diagnostics::ambiguousEntryPoint, entryPointName);
// List all of the declarations that the user *might* mean
for (auto ff = firstDeclWithName; ff; ff = ff->nextInContainerWithSameName)
{
if (auto candidate = as<FuncDecl>(ff))
{
sink->diagnose(candidate, Diagnostics::entryPointCandidate, candidate->getName());
}
}
// Bail out.
return nullptr;
}
}
}
// Did we find a function declaration in our search?
if(!entryPointFuncDecl)
{
// If not, then we need to diagnose the error.
// For convenience, we will point to the first
// declaration with the right name, that wasn't a function.
sink->diagnose(firstDeclWithName, Diagnostics::entryPointSymbolNotAFunction, entryPointName);
return nullptr;
}
// TODO: it is possible that the entry point was declared with
// profile or target overloading. Is there anything that we need
// to do at this point to filter out declarations that aren't
// relevant to the selected profile for the entry point?
// We found something, and can start doing some basic checking.
//
// If the entry point specifies a stage via a `[shader("...")]` attribute,
// then we might be able to infer a stage for the entry point request if
// it didn't have one, *or* issue a diagnostic if there is a mismatch.
//
auto entryPointProfile = entryPointReq->getProfile();
if( auto entryPointAttribute = entryPointFuncDecl->findModifier<EntryPointAttribute>() )
{
auto entryPointStage = entryPointProfile.getStage();
if( entryPointStage == Stage::Unknown )
{
entryPointProfile.setStage(entryPointAttribute->stage);
}
else if( entryPointAttribute->stage != entryPointStage )
{
sink->diagnose(entryPointFuncDecl, Diagnostics::specifiedStageDoesntMatchAttribute, entryPointName, entryPointStage, entryPointAttribute->stage);
}
}
else
{
// TODO: Should we attach a `[shader(...)]` attribute to an
// entry point that didn't have one, so that we can have
// a more uniform representation in the AST?
}
RefPtr<EntryPoint> entryPoint = EntryPoint::create(
linkage,
makeDeclRef(entryPointFuncDecl),
entryPointProfile);
// Now that we've *found* the entry point, it is time to validate
// that it actually meets the constraints for the chosen stage/profile.
//
validateEntryPoint(entryPoint, sink);
return entryPoint;
}
/// Get the name a variable will use for reflection purposes
Name* getReflectionName(VarDeclBase* varDecl)
{
if (auto reflectionNameModifier = varDecl->findModifier<ParameterGroupReflectionName>())
return reflectionNameModifier->nameAndLoc.name;
return varDecl->getName();
}
Type* getParamType(ASTBuilder* astBuilder, DeclRef<VarDeclBase> const& paramDeclRef)
{
auto paramType = getType(astBuilder, paramDeclRef);
if (paramDeclRef.getDecl()->findModifier<NoDiffModifier>())
{
auto modifierVal = static_cast<Val*>(astBuilder->getOrCreate<NoDiffModifierVal>());
paramType = astBuilder->getModifiedType(paramType, 1, &modifierVal);
}
return paramType;
}
void Module::_collectShaderParams()
{
auto moduleDecl = m_moduleDecl;
// We are going to walk the global declarations in the body of the
// module, and use those to build up our lists of:
//
// * Global shader parameters
// * Specialization parameters (both generic and interface/existential)
// * Requirements (`import`ed modules)
//
// For requirements, we want to be careful to only
// add each required module once (in case the same
// module got `import`ed multiple times), so we
// will keep a set of the modules we've already
// seen and processed.
//
HashSet<Module*> requiredModuleSet;
for( auto globalDecl : moduleDecl->members )
{
if(auto globalVar = as<VarDecl>(globalDecl))
{
// We do not want to consider global variable declarations
// that don't represents shader parameters. This includes
// things like `static` globals and `groupshared` variables.
//
if(!isGlobalShaderParameter(globalVar))
continue;
// At this point we know we have a global shader parameter.
ShaderParamInfo shaderParamInfo;
shaderParamInfo.paramDeclRef = makeDeclRef(globalVar);
// We need to consider what specialization parameters
// are introduced by this shader parameter. This step
// fills in fields on `shaderParamInfo` so that we
// can assocaite specialization arguments supplied later
// with the correct parameter.
//
_collectExistentialSpecializationParamsForShaderParam(
getLinkage()->getASTBuilder(),
shaderParamInfo,
m_specializationParams,
makeDeclRef(globalVar));
m_shaderParams.add(shaderParamInfo);
}
else if( auto globalGenericParam = as<GlobalGenericParamDecl>(globalDecl) )
{
// A global generic type parameter declaration introduces
// a suitable specialization parameter.
//
SpecializationParam specializationParam;
specializationParam.flavor = SpecializationParam::Flavor::GenericType;
specializationParam.loc = globalGenericParam->loc;
specializationParam.object = globalGenericParam;
m_specializationParams.add(specializationParam);
}
else if( auto globalGenericValueParam = as<GlobalGenericValueParamDecl>(globalDecl) )
{
// A global generic type parameter declaration introduces
// a suitable specialization parameter.
//
SpecializationParam specializationParam;
specializationParam.flavor = SpecializationParam::Flavor::GenericValue;
specializationParam.loc = globalGenericValueParam->loc;
specializationParam.object = globalGenericValueParam;
m_specializationParams.add(specializationParam);
}
else if( auto importDecl = as<ImportDecl>(globalDecl) )
{
// An `import` declaration creates a requirement dependency
// from this module to another module.
//
auto importedModule = getModule(importDecl->importedModuleDecl);
if(!requiredModuleSet.Contains(importedModule))
{
requiredModuleSet.Add(importedModule);
m_requirements.add(importedModule);
}
}
}
}
Index Module::getRequirementCount()
{
return m_requirements.getCount();
}
RefPtr<ComponentType> Module::getRequirement(Index index)
{
return m_requirements[index];
}
void Module::acceptVisitor(ComponentTypeVisitor* visitor, SpecializationInfo* specializationInfo)
{
visitor->visitModule(this, as<ModuleSpecializationInfo>(specializationInfo));
}
/// Create a new component type based on `inComponentType`, but with all its requiremetns filled.
RefPtr<ComponentType> fillRequirements(
ComponentType* inComponentType)
{
auto linkage = inComponentType->getLinkage();
// We are going to simplify things by solving the problem iteratively.
// If the current `componentType` has requirements for `A`, `B`, ... etc.
// then we will create a composite of `componentType`, `A`, `B`, ...
// and then see if the resulting composite has any requirements.
//
// This avoids the problem of trying to compute teh transitive closure
// of the requirements relationship (while dealing with deduplication,
// etc.)
RefPtr<ComponentType> componentType = inComponentType;
for(;;)
{
auto requirementCount = componentType->getRequirementCount();
if(requirementCount == 0)
break;
List<RefPtr<ComponentType>> allComponents;
allComponents.add(componentType);
for(Index rr = 0; rr < requirementCount; ++rr)
{
auto requirement = componentType->getRequirement(rr);
allComponents.add(requirement);
}
componentType = CompositeComponentType::create(
linkage,
allComponents);
}
return componentType;
}
/// Create a component type to represent the "global scope" of a compile request.
///
/// This component type will include all the modules and their global
/// parameters from the compile request, but not anything specific
/// to any entry point functions.
///
/// The layout for this component type will thus represent the things that
/// a user is likely to want to have stay the same across all compiled
/// entry points.
///
/// The component type that this function creates is unspecialized, in
/// that it doesn't take into account any specialization arguments
/// that might have been supplied as part of the compile request.
///
RefPtr<ComponentType> createUnspecializedGlobalComponentType(
FrontEndCompileRequest* compileRequest)
{
// We want our resulting program to depend on
// all the translation units the user specified,
// even if some of them don't contain entry points
// (this is important for parameter layout/binding).
//
// We also want to ensure that the modules for the
// translation units comes first in the enumerated
// order for dependencies, to match the pre-existing
// compiler behavior (at least for now).
//
auto linkage = compileRequest->getLinkage();
RefPtr<ComponentType> globalComponentType;
if(compileRequest->translationUnits.getCount() == 1)
{
// The common case is that a compilation only uses
// a single translation unit, and thus results in
// a single `Module`. We can then use that module
// as the component type that represents the global scope.
//
globalComponentType = compileRequest->translationUnits[0]->getModule();
}
else
{
List<RefPtr<ComponentType>> translationUnitComponentTypes;
for( auto tu : compileRequest->translationUnits )
{
translationUnitComponentTypes.add(tu->getModule());
}
globalComponentType = CompositeComponentType::create(
linkage,
translationUnitComponentTypes);
}
return fillRequirements(globalComponentType);
}
void FrontEndCompileRequest::checkEntryPoints()
{
auto linkage = getLinkage();
auto sink = getSink();
// The validation of entry points here will be modal, and controlled
// by whether the user specified any entry points directly via
// API or command-line options.
//
// TODO: We may want to make this choice explicit rather than implicit.
//
// First, check if the user requested any entry points explicitly via
// the API or command line.
//
bool anyExplicitEntryPoints = getEntryPointReqCount() != 0;
if( anyExplicitEntryPoints )
{
// If there were any explicit requests for entry points to be
// checked, then we will *only* check those.
//
for(auto entryPointReq : getEntryPointReqs())
{
auto entryPoint = findAndValidateEntryPoint(
entryPointReq);
if( entryPoint )
{
// TODO: We need to implement an explicit policy
// for what should happen if the user specified
// entry points via the command-line (or API),
// but didn't specify any groups (since the current
// compilation API doesn't allow for grouping).
//
entryPointReq->getTranslationUnit()->module->_addEntryPoint(entryPoint);
}
}
// TODO: We should consider always processing both categories,
// and just making sure to only check each entry point function
// declaration once...
}
else
{
// Otherwise, scan for any `[shader(...)]` attributes in
// the user's code, and construct `EntryPoint`s to
// represent them.
//
// This ensures that downstream code only has to consider
// the central list of entry point requests, and doesn't
// have to know where they came from.
// TODO: A comprehensive approach here would need to search
// recursively for entry points, because they might appear
// as, e.g., member function of a `struct` type.
//
// For now we'll start with an extremely basic approach that
// should work for typical HLSL code.
//
Index translationUnitCount = translationUnits.getCount();
for(Index tt = 0; tt < translationUnitCount; ++tt)
{
auto translationUnit = translationUnits[tt];
for( auto globalDecl : translationUnit->getModuleDecl()->members )
{
auto maybeFuncDecl = globalDecl;
if( auto genericDecl = as<GenericDecl>(maybeFuncDecl) )
{
maybeFuncDecl = genericDecl->inner;
}
auto funcDecl = as<FuncDecl>(maybeFuncDecl);
if(!funcDecl)
continue;
auto entryPointAttr = funcDecl->findModifier<EntryPointAttribute>();
if(!entryPointAttr)
continue;
// We've discovered a valid entry point. It is a function (possibly
// generic) that has a `[shader(...)]` attribute to mark it as an
// entry point.
//
// We will now register that entry point as an `EntryPoint`
// with an appropriately chosen profile.
//
// The profile will only include a stage, so that the profile "family"
// and "version" are left unspecified. Downstream code will need
// to be able to handle this case.
//
Profile profile;
profile.setStage(entryPointAttr->stage);
RefPtr<EntryPoint> entryPoint = EntryPoint::create(
linkage,
makeDeclRef(funcDecl),
profile);
validateEntryPoint(entryPoint, sink);
// Note: in the case that the user didn't explicitly
// specify entry points and we are instead compiling
// a shader "library," then we do not want to automatically
// combine the entry points into groups in the generated
// `Program`, since that would be slightly too magical.
//
// Instead, each entry point will end up in a singleton
// group, so that its entry-point parameters lay out
// independent of the others.
//
translationUnit->module->_addEntryPoint(entryPoint);
}
}
}
}
/// Create a component type that represents the global scope for a compile request,
/// along with any entry point functions.
///
/// The resulting component type will include the global-scope information
/// first, so its layout will be compatible with the result of
/// `createUnspecializedGlobalComponentType`.
///
/// The new component type will also add on any entry-point functions
/// that were requested and will thus include space for their `uniform` parameters.
/// If multiple entry points were requested then they will be given non-overlapping
/// parameter bindings, consistent with them being used together in
/// a single pipeline state, hit group, etc.
///
/// The result of this function is unspecialized and doesn't take into
/// account any specialization arguments the user might have supplied.
///
RefPtr<ComponentType> createUnspecializedGlobalAndEntryPointsComponentType(
FrontEndCompileRequest* compileRequest,
List<RefPtr<ComponentType>>& outUnspecializedEntryPoints)
{
auto linkage = compileRequest->getLinkage();
auto globalComponentType = compileRequest->getGlobalComponentType();
List<RefPtr<ComponentType>> allComponentTypes;
allComponentTypes.add(globalComponentType);
Index translationUnitCount = compileRequest->translationUnits.getCount();
for(Index tt = 0; tt < translationUnitCount; ++tt)
{
auto translationUnit = compileRequest->translationUnits[tt];
auto module = translationUnit->getModule();
for(auto entryPoint : module->getEntryPoints() )
{
outUnspecializedEntryPoints.add(entryPoint);
allComponentTypes.add(entryPoint);
}
}
// Also consider entry points that were introduced via adding
// a library reference...
//
for( auto extraEntryPoint : compileRequest->m_extraEntryPoints )
{
auto entryPoint = EntryPoint::createDummyForDeserialize(
linkage,
extraEntryPoint.name,
extraEntryPoint.profile,
extraEntryPoint.mangledName);
allComponentTypes.add(entryPoint);
}
if(allComponentTypes.getCount() > 1)
{
auto composite = CompositeComponentType::create(
linkage,
allComponentTypes);
return composite;
}
else
{
return globalComponentType;
}
}
RefPtr<ComponentType::SpecializationInfo> Module::_validateSpecializationArgsImpl(
SpecializationArg const* args,
Index argCount,
DiagnosticSink* sink)
{
SLANG_ASSERT(argCount == getSpecializationParamCount());
SharedSemanticsContext semanticsContext(getLinkage(), this, sink);
SemanticsVisitor visitor(&semanticsContext);
RefPtr<Module::ModuleSpecializationInfo> specializationInfo = new Module::ModuleSpecializationInfo();
for( Index ii = 0; ii < argCount; ++ii )
{
auto& arg = args[ii];
auto& param = m_specializationParams[ii];
switch( param.flavor )
{
case SpecializationParam::Flavor::GenericType:
{
auto genericTypeParamDecl = as<GlobalGenericParamDecl>(param.object);
SLANG_ASSERT(genericTypeParamDecl);
Type* argType = as<Type>(arg.val);
if(!argType)
{
sink->diagnose(param.loc, Diagnostics::expectedTypeForSpecializationArg, genericTypeParamDecl);
argType = getLinkage()->getASTBuilder()->getErrorType();
}
// TODO: There is a serious flaw to this checking logic if we ever have cases where
// the constraints on one `type_param` can depend on another `type_param`, e.g.:
//
// type_param A;
// type_param B : ISidekick<A>;
//
// In that case, if a user tries to set `B` to `Robin` and `Robin` conforms to
// `ISidekick<Batman>`, then the compiler needs to know whether `A` is being
// set to `Batman` to know whether the setting for `B` is valid. In this limit
// the constraints can be mutually recursive (so `A : IMentor<B>`).
//
// The only way to check things correctly is to validate each conformance under
// a set of assumptions (substitutions) that includes all the type substitutions,
// and possibly also all the other constraints *except* the one to be validated.
//
// We will punt on this for now, and just check each constraint in isolation.
// As a quick sanity check, see if the argument that is being supplied for a
// global generic type parameter is a reference to *another* global generic
// type parameter, since that should always be an error.
//
if( auto argDeclRefType = as<DeclRefType>(argType) )
{
auto argDeclRef = argDeclRefType->declRef;
if(auto argGenericParamDeclRef = argDeclRef.as<GlobalGenericParamDecl>())
{
if(argGenericParamDeclRef.getDecl() == genericTypeParamDecl)
{
// We are trying to specialize a generic parameter using itself.
sink->diagnose(genericTypeParamDecl,
Diagnostics::cannotSpecializeGlobalGenericToItself,
genericTypeParamDecl->getName());
continue;
}
else
{
// We are trying to specialize a generic parameter using a *different*
// global generic type parameter.
sink->diagnose(genericTypeParamDecl,
Diagnostics::cannotSpecializeGlobalGenericToAnotherGenericParam,
genericTypeParamDecl->getName(),
argGenericParamDeclRef.getName());
continue;
}
}
}
ModuleSpecializationInfo::GenericArgInfo genericArgInfo;
genericArgInfo.paramDecl = genericTypeParamDecl;
genericArgInfo.argVal = argType;
specializationInfo->genericArgs.add(genericArgInfo);
// Walk through the declared constraints for the parameter,
// and check that the argument actually satisfies them.
for(auto constraintDecl : genericTypeParamDecl->getMembersOfType<GenericTypeConstraintDecl>())
{
// Get the type that the constraint is enforcing conformance to
auto interfaceType = getSup(getLinkage()->getASTBuilder(), DeclRef<GenericTypeConstraintDecl>(constraintDecl, nullptr));
// Use our semantic-checking logic to search for a witness to the required conformance
auto witness = visitor.tryGetSubtypeWitness(argType, interfaceType);
if (!witness)
{
// If no witness was found, then we will be unable to satisfy
// the conformances required.
sink->diagnose(genericTypeParamDecl,
Diagnostics::typeArgumentForGenericParameterDoesNotConformToInterface,
argType,
genericTypeParamDecl->nameAndLoc.name,
interfaceType);
}
ModuleSpecializationInfo::GenericArgInfo constraintArgInfo;
constraintArgInfo.paramDecl = constraintDecl;
constraintArgInfo.argVal = witness;
specializationInfo->genericArgs.add(constraintArgInfo);
}
}
break;
case SpecializationParam::Flavor::ExistentialType:
{
auto interfaceType = as<Type>(param.object);
SLANG_ASSERT(interfaceType);
Type* argType = as<Type>(arg.val);
if(!argType)
{
sink->diagnose(param.loc, Diagnostics::expectedTypeForSpecializationArg, interfaceType);
argType = getLinkage()->getASTBuilder()->getErrorType();
}
auto witness = visitor.tryGetSubtypeWitness(argType, interfaceType);
if (!witness)
{
// If no witness was found, then we will be unable to satisfy
// the conformances required.
sink->diagnose(SourceLoc(),
Diagnostics::typeArgumentDoesNotConformToInterface,
argType,
interfaceType);
}
ExpandedSpecializationArg expandedArg;
expandedArg.val = argType;
expandedArg.witness = witness;
specializationInfo->existentialArgs.add(expandedArg);
}
break;
case SpecializationParam::Flavor::GenericValue:
{
auto paramDecl = as<GlobalGenericValueParamDecl>(param.object);
SLANG_ASSERT(paramDecl);
// Now we need to check that the argument `Val` has the
// appropriate type expected by the parameter.
IntVal* intVal = as<IntVal>(arg.val);
if(!intVal)
{
sink->diagnose(param.loc, Diagnostics::expectedValueOfTypeForSpecializationArg, paramDecl->getType(), paramDecl);
intVal = getLinkage()->getASTBuilder()->getIntVal(m_astBuilder->getIntType(), 0);
}
ModuleSpecializationInfo::GenericArgInfo expandedArg;
expandedArg.paramDecl = paramDecl;
expandedArg.argVal = intVal;
specializationInfo->genericArgs.add(expandedArg);
}
break;
default:
SLANG_UNEXPECTED("unhandled specialization parameter flavor");
}
}
return specializationInfo;
}
static void _extractSpecializationArgs(
ComponentType* componentType,
List<Expr*> const& argExprs,
List<SpecializationArg>& outArgs,
DiagnosticSink* sink)
{
auto linkage = componentType->getLinkage();
SharedSemanticsContext semanticsContext(linkage, nullptr, sink);
SemanticsVisitor semanticsVisitor(&semanticsContext);
auto argCount = argExprs.getCount();
for(Index ii = 0; ii < argCount; ++ii )
{
auto argExpr = argExprs[ii];
auto paramInfo = componentType->getSpecializationParam(ii);
SpecializationArg arg;
arg.val = semanticsVisitor.ExtractGenericArgVal(argExpr);
outArgs.add(arg);
}
}
RefPtr<ComponentType::SpecializationInfo> EntryPoint::_validateSpecializationArgsImpl(
SpecializationArg const* inArgs,
Index inArgCount,
DiagnosticSink* sink)
{
auto args = inArgs;
auto argCount = inArgCount;
SharedSemanticsContext sharedSemanticsContext(getLinkage(), nullptr, sink);
SemanticsVisitor visitor(&sharedSemanticsContext);
// The first N arguments will be for the explicit generic parameters
// of the entry point (if it has any).
//
auto genericSpecializationParamCount = getGenericSpecializationParamCount();
SLANG_ASSERT(argCount >= genericSpecializationParamCount);
RefPtr<EntryPointSpecializationInfo> info = new EntryPointSpecializationInfo();
DeclRef<FuncDecl> specializedFuncDeclRef = m_funcDeclRef;
if(genericSpecializationParamCount)
{
// We need to construct a generic application and use
// the semantic checking machinery to expand out
// the rest of the arguments via inference...
auto genericDeclRef = m_funcDeclRef.getParent().as<GenericDecl>();
SLANG_ASSERT(genericDeclRef); // otherwise we wouldn't have generic parameters
List<Val*> genericArgs;
for(Index ii = 0; ii < genericSpecializationParamCount; ++ii)
{
auto specializationArg = args[ii];
genericArgs.add(specializationArg.val);
}
GenericSubstitution* genericSubst =
getLinkage()->getASTBuilder()->getOrCreateGenericSubstitution(
genericDeclRef.getDecl(),
genericArgs,
genericDeclRef.substitutions.substitutions);
for( auto constraintDecl : genericDeclRef.getDecl()->getMembersOfType<GenericTypeConstraintDecl>() )
{
auto constraintSubst = genericDeclRef.substitutions;
constraintSubst.substitutions = genericSubst;
DeclRef<GenericTypeConstraintDecl> constraintDeclRef(
constraintDecl, constraintSubst);
ASTBuilder* astBuilder = getLinkage()->getASTBuilder();
auto sub = getSub(astBuilder, constraintDeclRef);
auto sup = getSup(astBuilder, constraintDeclRef);
auto subTypeWitness = visitor.tryGetSubtypeWitness(sub, sup);
if(subTypeWitness)
{
genericArgs.add(subTypeWitness);
}
else
{
// TODO: diagnose a problem here
sink->diagnose(constraintDecl, Diagnostics::typeArgumentDoesNotConformToInterface, sub, sup);
continue;
}
}
genericSubst =
getLinkage()->getASTBuilder()->getOrCreateGenericSubstitution(
genericDeclRef.getDecl(),
genericArgs,
genericDeclRef.substitutions.substitutions);
specializedFuncDeclRef.substitutions.substitutions = genericSubst;
}
info->specializedFuncDeclRef = specializedFuncDeclRef;
// Once the generic parameters (if any) have been dealt with,
// any remaining specialization arguments are for existential/interface
// specialization parameters, attached to the value parameters
// of the entry point.
//
args += genericSpecializationParamCount;
argCount -= genericSpecializationParamCount;
auto existentialSpecializationParamCount = getExistentialSpecializationParamCount();
SLANG_ASSERT(argCount == existentialSpecializationParamCount);
for( Index ii = 0; ii < existentialSpecializationParamCount; ++ii )
{
auto& param = m_existentialSpecializationParams[ii];
auto& specializationArg = args[ii];
// TODO: We need to handle all the cases of "flavor" for the `param`s (not just types)
auto paramType = as<Type>(param.object);
auto argType = as<Type>(specializationArg.val);
auto witness = visitor.tryGetSubtypeWitness(argType, paramType);
if (!witness)
{
// If no witness was found, then we will be unable to satisfy
// the conformances required.
sink->diagnose(SourceLoc(), Diagnostics::typeArgumentDoesNotConformToInterface, argType, paramType);
continue;
}
ExpandedSpecializationArg expandedArg;
expandedArg.val = specializationArg.val;
expandedArg.witness = witness;
info->existentialSpecializationArgs.add(expandedArg);
}
return info;
}
/// Create a specialization an existing entry point based on specialization argument expressions.
RefPtr<ComponentType> createSpecializedEntryPoint(
EntryPoint* unspecializedEntryPoint,
List<Expr*> const& argExprs,
DiagnosticSink* sink)
{
// We need to convert all of the `Expr` arguments
// into `SpecializationArg`s, so that we can bottleneck
// through the shared logic.
//
List<SpecializationArg> args;
_extractSpecializationArgs(unspecializedEntryPoint, argExprs, args, sink);
if(sink->getErrorCount())
return nullptr;
return ((ComponentType*) unspecializedEntryPoint)->specialize(
args.getBuffer(),
args.getCount(),
sink);
}
Scope* ComponentType::_createScopeForLegacyLookup(ASTBuilder* astBuilder)
{
// The shape of this logic is dictated by the legacy
// behavior for name-based lookup/parsing of types
// specified via the API or command line.
//
// We begin with a dummy scope that has as its parent
// the scope that provides the "base" langauge
// definitions (that scope is necessary because
// it defines keywords like `true` and `false`).
//
Scope* scope = astBuilder->create<Scope>();
scope->parent = getLinkage()->getSessionImpl()->slangLanguageScope;
//
// Next, the scope needs to include all of the
// modules in the program as peers, as if they
// were `import`ed into the scope.
//
for( auto module : getModuleDependencies() )
{
Scope* moduleScope = astBuilder->create<Scope>();
moduleScope->containerDecl = module->getModuleDecl();
moduleScope->nextSibling = scope->nextSibling;
scope->nextSibling = moduleScope;
}
return scope;
}
/// Parse an array of strings as specialization arguments.
///
/// Names in the strings will be parsed in the context of
/// the code loaded into the given compile request.
///
void parseSpecializationArgStrings(
EndToEndCompileRequest* endToEndReq,
List<String> const& genericArgStrings,
List<Expr*>& outGenericArgs)
{
auto unspecialiedProgram = endToEndReq->getUnspecializedGlobalComponentType();
// TODO(JS):
//
// We create the scopes on the linkages ASTBuilder. We might want to create a temporary ASTBuilder,
// and let that memory get freed, but is like this because it's not clear if the scopes in ASTNode members
// will dangle if we do.
Scope* scope = unspecialiedProgram->_createScopeForLegacyLookup(endToEndReq->getLinkage()->getASTBuilder());
// We are going to do some semantic checking, so we need to
// set up a `SemanticsVistitor` that we can use.
//
auto linkage = endToEndReq->getLinkage();
auto sink = endToEndReq->getSink();
SharedSemanticsContext sharedSemanticsContext(
linkage,
nullptr,
sink);
SemanticsVisitor semantics(&sharedSemanticsContext);
// We will be looping over the generic argument strings
// that the user provided via the API (or command line),
// and parsing+checking each into an `Expr`.
//
// This loop will *not* handle coercing the arguments
// to be types.
//
for(auto name : genericArgStrings)
{
Expr* argExpr = linkage->parseTermString(name, scope);
argExpr = semantics.CheckTerm(argExpr);
if(!argExpr)
{
sink->diagnose(SourceLoc(), Diagnostics::internalCompilerError, "couldn't parse specialization argument");
return;
}
outGenericArgs.add(argExpr);
}
}
Type* Linkage::specializeType(
Type* unspecializedType,
Int argCount,
Type* const* args,
DiagnosticSink* sink)
{
SLANG_ASSERT(unspecializedType);
// TODO: We should cache and re-use specialized types
// when the exact same arguments are provided again later.
SharedSemanticsContext sharedSemanticsContext(this, nullptr, sink);
SemanticsVisitor visitor(&sharedSemanticsContext);
SpecializationParams specializationParams;
_collectExistentialSpecializationParamsRec(getASTBuilder(), specializationParams, unspecializedType, SourceLoc());
assert(specializationParams.getCount() == argCount);
ExpandedSpecializationArgs specializationArgs;
for( Int aa = 0; aa < argCount; ++aa )
{
auto paramType = as<Type>(specializationParams[aa].object);
auto argType = args[aa];
ExpandedSpecializationArg arg;
arg.val = argType;
arg.witness = visitor.tryGetSubtypeWitness(argType, paramType);
specializationArgs.add(arg);
}
ExistentialSpecializedType* specializedType = m_astBuilder->create<ExistentialSpecializedType>();
specializedType->baseType = unspecializedType;
specializedType->args = specializationArgs;
m_specializedTypes.add(specializedType);
return specializedType;
}
/// Shared implementation logic for the `_createSpecializedProgram*` entry points.
static RefPtr<ComponentType> _createSpecializedProgramImpl(
Linkage* linkage,
ComponentType* unspecializedProgram,
List<Expr*> const& specializationArgExprs,
DiagnosticSink* sink)
{
// If there are no specialization arguments,
// then the the result of specialization should
// be the same as the input.
//
auto specializationArgCount = specializationArgExprs.getCount();
if( specializationArgCount == 0 )
{
return unspecializedProgram;
}
auto specializationParamCount = unspecializedProgram->getSpecializationParamCount();
if(specializationArgCount != specializationParamCount )
{
sink->diagnose(SourceLoc(), Diagnostics::mismatchSpecializationArguments,
specializationParamCount,
specializationArgCount);
return nullptr;
}
// We have an appropriate number of arguments for the global specialization parameters,
// and now we need to check that the arguments conform to the declared constraints.
//
SharedSemanticsContext visitor(linkage, nullptr, sink);
List<SpecializationArg> specializationArgs;
_extractSpecializationArgs(unspecializedProgram, specializationArgExprs, specializationArgs, sink);
if(sink->getErrorCount())
return nullptr;
auto specializedProgram = unspecializedProgram->specialize(
specializationArgs.getBuffer(),
specializationArgs.getCount(),
sink);
return specializedProgram;
}
/// Specialize an entry point that was checked by the front-end, based on specialization arguments.
///
/// If the end-to-end compile request included specialization argument strings
/// for this entry point, then they will be parsed, checked, and used
/// as arguments to the generic entry point.
///
/// Returns a specialized entry point if everything worked as expected.
/// Returns null and diagnoses errors if anything goes wrong.
///
RefPtr<ComponentType> createSpecializedEntryPoint(
EndToEndCompileRequest* endToEndReq,
EntryPoint* unspecializedEntryPoint,
EndToEndCompileRequest::EntryPointInfo const& entryPointInfo)
{
auto sink = endToEndReq->getSink();
// If the user specified generic arguments for the entry point,
// then we will need to parse the arguments first.
//
List<Expr*> specializationArgExprs;
parseSpecializationArgStrings(
endToEndReq,
entryPointInfo.specializationArgStrings,
specializationArgExprs);
// Next we specialize the entry point function given the parsed
// generic argument expressions.
//
auto entryPoint = createSpecializedEntryPoint(
unspecializedEntryPoint,
specializationArgExprs,
sink);
return entryPoint;
}
/// Create a specialized component type for the global scope of the given compile request.
///
/// The specialized program will be consistent with that created by
/// `createUnspecializedGlobalComponentType`, and will simply fill in
/// its specialization parameters with the arguments (if any) supllied
/// as part fo the end-to-end compile request.
///
/// The layout of the new component type will be consistent with that
/// of the original *if* there are no global generic type parameters
/// (only interface/existential parameters).
///
RefPtr<ComponentType> createSpecializedGlobalComponentType(
EndToEndCompileRequest* endToEndReq)
{
// The compile request must have already completed front-end processing,
// so that we have an unspecialized program available, and now only need
// to parse and check any generic arguments that are being supplied for
// global or entry-point generic parameters.
//
auto unspecializedProgram = endToEndReq->getUnspecializedGlobalComponentType();
auto linkage = endToEndReq->getLinkage();
auto sink = endToEndReq->getSink();
// First, let's parse the specialization argument strings that were
// provided via the API, so that we can match them
// against what was declared in the program.
//
List<Expr*> globalSpecializationArgs;
parseSpecializationArgStrings(
endToEndReq,
endToEndReq->m_globalSpecializationArgStrings,
globalSpecializationArgs);
// Don't proceed further if anything failed to parse.
if(sink->getErrorCount())
return nullptr;
// Now we create the initial specialized program by
// applying the global generic arguments (if any) to the
// unspecialized program.
//
auto specializedProgram = _createSpecializedProgramImpl(
linkage,
unspecializedProgram,
globalSpecializationArgs,
sink);
// If anything went wrong with the global generic
// arguments, then bail out now.
//
if(!specializedProgram)
return nullptr;
// Next we will deal with the entry points for the
// new specialized program.
//
// If the user specified explicit entry points as part of the
// end-to-end request, then we only want to process those (and
// ignore any other `[shader(...)]`-attributed entry points).
//
// However, if the user specified *no* entry points as part
// of the end-to-end request, then we would like to go
// ahead and consider all the entry points that were found
// by the front-end.
//
Index entryPointCount = endToEndReq->m_entryPoints.getCount();
if( entryPointCount == 0 )
{
entryPointCount = unspecializedProgram->getEntryPointCount();
endToEndReq->m_entryPoints.setCount(entryPointCount);
}
return specializedProgram;
}
/// Create a specialized program based on the given compile request.
///
/// The specialized program created here includes both the global
/// scope for all the translation units involved and all the entry
/// points, and it also includes any specialization arguments
/// that were supplied.
///
/// It is important to note that this function specializes
/// the global scope and the entry points in isolation and then
/// composes them, and that this can lead to different layout
/// from the result of `createUnspecializedGlobalAndEntryPointsComponentType`.
///
/// If we have a module `M` with entry point `E`, and each has one
/// specialization parameter, then `createUnspecialized...` will yield:
///
/// compose(M,E)
///
/// That composed type will have two specialization parameters (the one
/// from `M` plus the one from `E`) and so we might specialize it to get:
///
/// specialize(compose(M,E), X, Y)
///
/// while if we use `createSpecialized...` we will get:
///
/// compose(specialize(M,X), specialize(E,Y))
///
/// While these options are semantically equivalent, they would not lay
/// out the same way in memory.
///
/// There are many reasons why an application might prefer one over the
/// other, and an application that cares should use the more explicit
/// APIs to construct what they want. The behavior of this function
/// is just to provide a reasonable default for use by end-to-end
/// compilation (e.g., from the command line).
///
RefPtr<ComponentType> createSpecializedGlobalAndEntryPointsComponentType(
EndToEndCompileRequest* endToEndReq,
List<RefPtr<ComponentType>>& outSpecializedEntryPoints)
{
auto specializedGlobalComponentType = endToEndReq->getSpecializedGlobalComponentType();
List<RefPtr<ComponentType>> allComponentTypes;
allComponentTypes.add(specializedGlobalComponentType);
auto unspecializedGlobalAndEntryPointsComponentType = endToEndReq->getUnspecializedGlobalAndEntryPointsComponentType();
// It is possible that there were entry points other than those specified
// vai the original end-to-end compile request. In particular:
//
// * It is possible to compile with *no* entry points specified, in which
// case the current compiler behavior is to use any entry points marked
// via `[shader(...)]` attributes in the AST.
//
// * It is possible for entry points to come into play via serialized libraries
// loaded with `-r` on the command line (or the equivalent API).
//
// We will thus draw a distinction between the "specified" entry points,
// and the "found" entry points.
//
auto specifiedEntryPointCount = endToEndReq->m_entryPoints.getCount();
auto foundEntryPointCount = unspecializedGlobalAndEntryPointsComponentType->getEntryPointCount();
SLANG_ASSERT(foundEntryPointCount >= specifiedEntryPointCount);
// For any entry points that were specified, we can use the specialization
// argument information provided via API or command line.
//
for(Index ii = 0; ii < specifiedEntryPointCount; ++ii)
{
auto& entryPointInfo = endToEndReq->m_entryPoints[ii];
auto unspecializedEntryPoint = unspecializedGlobalAndEntryPointsComponentType->getEntryPoint(ii);
auto specializedEntryPoint = createSpecializedEntryPoint(endToEndReq, unspecializedEntryPoint, entryPointInfo);
allComponentTypes.add(specializedEntryPoint);
outSpecializedEntryPoints.add(specializedEntryPoint);
}
// There might have been errors during the specialization above,
// so we will bail out early if anything went wrong, rather
// then try to create a composite where some of the constituent
// component types might be null.
//
if(endToEndReq->getSink()->getErrorCount() != 0)
return nullptr;
// Any entry points beyond those that were specified up front will be
// assumed to not need/want specialization.
//
for( Index ii = specifiedEntryPointCount; ii < foundEntryPointCount; ++ii )
{
auto unspecializedEntryPoint = unspecializedGlobalAndEntryPointsComponentType->getEntryPoint(ii);
allComponentTypes.add(unspecializedEntryPoint);
outSpecializedEntryPoints.add(unspecializedEntryPoint);
}
RefPtr<ComponentType> composed = CompositeComponentType::create(endToEndReq->getLinkage(), allComponentTypes);
return composed;
}
}
|