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
|
#include "slang-ir-lower-buffer-element-type.h"
#include "slang-ir-clone.h"
#include "slang-ir-insts.h"
#include "slang-ir-layout.h"
#include "slang-ir-util.h"
#include "slang-ir.h"
namespace Slang
{
struct TypeLoweringConfig
{
AddressSpace addressSpace;
IRTypeLayoutRules* layoutRule;
bool operator==(const TypeLoweringConfig& other) const
{
return addressSpace == other.addressSpace && layoutRule == other.layoutRule;
}
HashCode getHashCode() const
{
return combineHash(Slang::getHashCode(addressSpace), Slang::getHashCode(layoutRule));
}
};
TypeLoweringConfig getTypeLoweringConfigForBuffer(TargetProgram* target, IRType* bufferType);
struct LoweredElementTypeContext
{
static const IRIntegerValue kMaxArraySizeToUnroll = 32;
enum ConversionMethodKind
{
Func,
Opcode
};
struct ConversionMethod
{
ConversionMethodKind kind = ConversionMethodKind::Func;
union
{
IRFunc* func;
IROp op;
};
ConversionMethod() { func = nullptr; }
operator bool()
{
return kind == ConversionMethodKind::Func ? func != nullptr : op != kIROp_Nop;
}
ConversionMethod& operator=(IRFunc* f)
{
kind = ConversionMethodKind::Func;
this->func = f;
return *this;
}
ConversionMethod& operator=(IROp irop)
{
kind = ConversionMethodKind::Opcode;
this->op = irop;
return *this;
}
IRInst* apply(IRBuilder& builder, IRType* resultType, IRInst* operandAddr)
{
if (!*this)
return builder.emitLoad(operandAddr);
if (kind == ConversionMethodKind::Func)
return builder.emitCallInst(resultType, func, 1, &operandAddr);
else
{
auto val = builder.emitLoad(operandAddr);
return builder.emitIntrinsicInst(resultType, op, 1, &val);
}
}
void applyDestinationDriven(IRBuilder& builder, IRInst* dest, IRInst* operand)
{
if (!*this)
{
builder.emitStore(dest, operand);
return;
}
if (kind == ConversionMethodKind::Func)
{
IRInst* operands[] = {dest, operand};
builder.emitCallInst(builder.getVoidType(), func, 2, operands);
}
else
{
auto val = builder.emitIntrinsicInst(
tryGetPointedToType(&builder, dest->getDataType()),
op,
1,
&operand);
builder.emitStore(dest, val);
}
}
};
struct LoweredElementTypeInfo
{
IRType* originalType;
IRType* loweredType;
IRType* loweredInnerArrayType =
nullptr; // For matrix/array types that are lowered into a struct type, this is the
// inner array type of the data field.
IRStructKey* loweredInnerStructKey =
nullptr; // For matrix/array types that are lowered into a struct type, this is the
// struct key of the data field.
ConversionMethod convertOriginalToLowered;
ConversionMethod convertLoweredToOriginal;
};
struct LoweredTypeMap : RefObject
{
Dictionary<IRType*, LoweredElementTypeInfo> loweredTypeInfo;
Dictionary<IRType*, LoweredElementTypeInfo> mapLoweredTypeToInfo;
};
Dictionary<TypeLoweringConfig, RefPtr<LoweredTypeMap>> loweredTypeInfoMaps;
struct ConversionMethodKey
{
IRType* toType;
IRType* fromType;
bool operator==(const ConversionMethodKey& other) const
{
return toType == other.toType && fromType == other.fromType;
}
HashCode64 getHashCode() const
{
return combineHash(Slang::getHashCode(toType), Slang::getHashCode(fromType));
}
};
Dictionary<ConversionMethodKey, ConversionMethod> conversionMethodMap;
ConversionMethod getConversionMethod(IRType* toType, IRType* fromType)
{
ConversionMethodKey key;
key.toType = toType;
key.fromType = fromType;
ConversionMethod method;
conversionMethodMap.tryGetValue(key, method);
return method;
}
SlangMatrixLayoutMode defaultMatrixLayout = SLANG_MATRIX_LAYOUT_ROW_MAJOR;
TargetProgram* target;
BufferElementTypeLoweringOptions options;
LoweredElementTypeContext(
TargetProgram* target,
BufferElementTypeLoweringOptions inOptions,
SlangMatrixLayoutMode inDefaultMatrixLayout)
: target(target), defaultMatrixLayout(inDefaultMatrixLayout), options(inOptions)
{
}
IRFunc* createMatrixUnpackFunc(
IRMatrixType* matrixType,
IRStructType* structType,
IRStructKey* dataKey)
{
IRBuilder builder(structType);
builder.setInsertAfter(structType);
auto func = builder.createFunc();
auto refStructType = builder.getRefType(structType, AddressSpace::Generic);
auto funcType = builder.getFuncType(1, (IRType**)&refStructType, matrixType);
func->setFullType(funcType);
builder.addNameHintDecoration(func, UnownedStringSlice("unpackStorage"));
builder.addForceInlineDecoration(func);
builder.setInsertInto(func);
builder.emitBlock();
auto rowCount = (Index)getIntVal(matrixType->getRowCount());
auto colCount = (Index)getIntVal(matrixType->getColumnCount());
auto packedParamRef = builder.emitParam(refStructType);
auto packedParam = builder.emitLoad(packedParamRef);
auto vectorArray = builder.emitFieldExtract(packedParam, dataKey);
List<IRInst*> args;
args.setCount(rowCount * colCount);
if (getIntVal(matrixType->getLayout()) == SLANG_MATRIX_LAYOUT_COLUMN_MAJOR)
{
for (IRIntegerValue c = 0; c < colCount; c++)
{
auto vector = builder.emitElementExtract(vectorArray, c);
for (IRIntegerValue r = 0; r < rowCount; r++)
{
auto element = builder.emitElementExtract(vector, r);
args[(Index)(r * colCount + c)] = element;
}
}
}
else
{
for (IRIntegerValue r = 0; r < rowCount; r++)
{
auto vector = builder.emitElementExtract(vectorArray, r);
for (IRIntegerValue c = 0; c < colCount; c++)
{
auto element = builder.emitElementExtract(vector, c);
args[(Index)(r * colCount + c)] = element;
}
}
}
IRInst* result =
builder.emitMakeMatrix(matrixType, (UInt)args.getCount(), args.getBuffer());
builder.emitReturn(result);
return func;
}
IRFunc* createMatrixPackFunc(
IRMatrixType* matrixType,
IRStructType* structType,
IRVectorType* vectorType,
IRArrayType* arrayType)
{
IRBuilder builder(structType);
builder.setInsertAfter(structType);
auto func = builder.createFunc();
auto outStructType = builder.getRefType(structType, AddressSpace::Generic);
IRType* paramTypes[] = {outStructType, matrixType};
auto funcType = builder.getFuncType(2, paramTypes, builder.getVoidType());
func->setFullType(funcType);
builder.addNameHintDecoration(func, UnownedStringSlice("packMatrix"));
builder.addForceInlineDecoration(func);
builder.setInsertInto(func);
builder.emitBlock();
auto rowCount = getIntVal(matrixType->getRowCount());
auto colCount = getIntVal(matrixType->getColumnCount());
auto outParam = builder.emitParam(outStructType);
auto originalParam = builder.emitParam(matrixType);
List<IRInst*> elements;
elements.setCount((Index)(rowCount * colCount));
for (IRIntegerValue r = 0; r < rowCount; r++)
{
auto vector = builder.emitElementExtract(originalParam, r);
for (IRIntegerValue c = 0; c < colCount; c++)
{
auto element = builder.emitElementExtract(vector, c);
elements[(Index)(r * colCount + c)] = element;
}
}
List<IRInst*> vectors;
if (getIntVal(matrixType->getLayout()) == SLANG_MATRIX_LAYOUT_COLUMN_MAJOR)
{
for (IRIntegerValue c = 0; c < colCount; c++)
{
List<IRInst*> vecArgs;
for (IRIntegerValue r = 0; r < rowCount; r++)
{
auto element = elements[(Index)(r * colCount + c)];
vecArgs.add(element);
}
// Fill in default values for remaining elements in the vector.
for (IRIntegerValue r = rowCount; r < getIntVal(vectorType->getElementCount()); r++)
{
vecArgs.add(builder.emitDefaultConstruct(vectorType->getElementType()));
}
auto colVector = builder.emitMakeVector(
vectorType,
(UInt)vecArgs.getCount(),
vecArgs.getBuffer());
vectors.add(colVector);
}
}
else
{
for (IRIntegerValue r = 0; r < rowCount; r++)
{
List<IRInst*> vecArgs;
for (IRIntegerValue c = 0; c < colCount; c++)
{
auto element = elements[(Index)(r * colCount + c)];
vecArgs.add(element);
}
// Fill in default values for remaining elements in the vector.
for (IRIntegerValue c = colCount; c < getIntVal(vectorType->getElementCount()); c++)
{
vecArgs.add(builder.emitDefaultConstruct(vectorType->getElementType()));
}
auto rowVector = builder.emitMakeVector(
vectorType,
(UInt)vecArgs.getCount(),
vecArgs.getBuffer());
vectors.add(rowVector);
}
}
auto vectorArray =
builder.emitMakeArray(arrayType, (UInt)vectors.getCount(), vectors.getBuffer());
auto result = builder.emitMakeStruct(structType, 1, &vectorArray);
builder.emitStore(outParam, result);
builder.emitReturn();
return func;
}
IRFunc* createArrayUnpackFunc(
IRArrayType* arrayType,
IRStructType* structType,
IRStructKey* dataKey,
LoweredElementTypeInfo innerTypeInfo)
{
IRBuilder builder(structType);
builder.setInsertAfter(structType);
auto func = builder.createFunc();
auto refStructType = builder.getRefType(structType, AddressSpace::Generic);
auto funcType = builder.getFuncType(1, (IRType**)&refStructType, arrayType);
func->setFullType(funcType);
builder.addNameHintDecoration(func, UnownedStringSlice("unpackStorage"));
builder.addForceInlineDecoration(func);
builder.setInsertInto(func);
builder.emitBlock();
auto packedParam = builder.emitParam(refStructType);
auto packedArray = builder.emitFieldAddress(packedParam, dataKey);
auto count = getArraySizeVal(arrayType->getElementCount());
IRInst* result = nullptr;
if (count <= kMaxArraySizeToUnroll)
{
// If the array is small enough, just process each element directly.
List<IRInst*> args;
args.setCount((Index)count);
for (IRIntegerValue ii = 0; ii < count; ++ii)
{
auto packedElementAddr = builder.emitElementAddress(packedArray, ii);
auto originalElement = innerTypeInfo.convertLoweredToOriginal.apply(
builder,
innerTypeInfo.originalType,
packedElementAddr);
args[(Index)ii] = originalElement;
}
result = builder.emitMakeArray(arrayType, (UInt)args.getCount(), args.getBuffer());
}
else
{
// The general case for large arrays is to emit a loop through the elements.
IRVar* resultVar = builder.emitVar(arrayType);
IRBlock* loopBodyBlock;
IRBlock* loopBreakBlock;
auto loopParam = emitLoopBlocks(
&builder,
builder.getIntValue(builder.getIntType(), 0),
builder.getIntValue(builder.getIntType(), count),
loopBodyBlock,
loopBreakBlock);
builder.setInsertBefore(loopBodyBlock->getFirstOrdinaryInst());
auto packedElementAddr = builder.emitElementAddress(packedArray, loopParam);
auto originalElement = innerTypeInfo.convertLoweredToOriginal.apply(
builder,
innerTypeInfo.originalType,
packedElementAddr);
auto varPtr = builder.emitElementAddress(resultVar, loopParam);
builder.emitStore(varPtr, originalElement);
builder.setInsertInto(loopBreakBlock);
result = builder.emitLoad(resultVar);
}
builder.emitReturn(result);
return func;
}
IRFunc* createArrayPackFunc(
IRArrayType* arrayType,
IRStructType* structType,
IRStructKey* arrayStructKey,
LoweredElementTypeInfo innerTypeInfo)
{
IRBuilder builder(structType);
builder.setInsertAfter(structType);
auto func = builder.createFunc();
auto outLoweredType = builder.getRefType(structType, AddressSpace::Generic);
IRType* paramTypes[] = {outLoweredType, structType};
auto funcType = builder.getFuncType(2, paramTypes, builder.getVoidType());
func->setFullType(funcType);
builder.addNameHintDecoration(func, UnownedStringSlice("packStorage"));
builder.addForceInlineDecoration(func);
builder.setInsertInto(func);
builder.emitBlock();
auto outParam = builder.emitParam(outLoweredType);
auto originalParam = builder.emitParam(arrayType);
auto count = getArraySizeVal(arrayType->getElementCount());
auto destArray = builder.emitFieldAddress(outParam, arrayStructKey);
if (count <= kMaxArraySizeToUnroll)
{
// If the array is small enough, just process each element directly.
List<IRInst*> args;
args.setCount((Index)count);
for (IRIntegerValue ii = 0; ii < count; ++ii)
{
auto originalElement = builder.emitElementExtract(originalParam, ii);
auto destArrayElement = builder.emitElementAddress(destArray, ii);
innerTypeInfo.convertOriginalToLowered.applyDestinationDriven(
builder,
destArrayElement,
originalElement);
}
}
else
{
// The general case for large arrays is to emit a loop through the elements.
IRBlock* loopBodyBlock;
IRBlock* loopBreakBlock;
auto loopParam = emitLoopBlocks(
&builder,
builder.getIntValue(builder.getIntType(), 0),
builder.getIntValue(builder.getIntType(), count),
loopBodyBlock,
loopBreakBlock);
builder.setInsertBefore(loopBodyBlock->getFirstOrdinaryInst());
auto originalElement = builder.emitElementExtract(originalParam, loopParam);
auto varPtr = builder.emitElementAddress(destArray, loopParam);
innerTypeInfo.convertOriginalToLowered.applyDestinationDriven(
builder,
varPtr,
originalElement);
builder.setInsertInto(loopBreakBlock);
}
builder.emitReturn();
return func;
}
const char* getLayoutName(IRTypeLayoutRuleName name)
{
switch (name)
{
case IRTypeLayoutRuleName::Std140:
return "std140";
case IRTypeLayoutRuleName::Std430:
return "std430";
case IRTypeLayoutRuleName::Natural:
return "natural";
case IRTypeLayoutRuleName::C:
return "c";
default:
return "default";
}
}
// Returns the number of elements N that ensures the IRVectorType(elementType,N)
// has 16-byte aligned size and N is no less than `minCount`.
IRIntegerValue get16ByteAlignedVectorElementCount(IRType* elementType, IRIntegerValue minCount)
{
IRSizeAndAlignment sizeAlignment;
getNaturalSizeAndAlignment(target->getOptionSet(), elementType, &sizeAlignment);
if (sizeAlignment.size)
return align(sizeAlignment.size * minCount, 16) / sizeAlignment.size;
return 4;
}
bool shouldLowerMatrixType(IRMatrixType* matrixType, TypeLoweringConfig config)
{
// For spirv, we always want to lower all matrix types, because SPIRV does not support
// specifying matrix layout/stride if the matrix type is used in places other than
// defining a struct field. This means that if a matrix is used to define a varying
// parameter, we always want to wrap it in a struct.
//
if (target->shouldEmitSPIRVDirectly())
{
return true;
}
if (getIntVal(matrixType->getLayout()) == defaultMatrixLayout &&
config.layoutRule->ruleName == IRTypeLayoutRuleName::Natural)
{
// For other targets, we only lower the matrix types if they differ from the default
// matrix layout.
return false;
}
return true;
}
LoweredElementTypeInfo getLoweredTypeInfoImpl(IRType* type, TypeLoweringConfig config)
{
IRBuilder builder(type);
builder.setInsertAfter(type);
LoweredElementTypeInfo info;
info.originalType = type;
if (auto matrixType = as<IRMatrixType>(type))
{
if (!shouldLowerMatrixType(matrixType, config))
{
info.loweredType = type;
return info;
}
auto loweredType = builder.createStructType();
builder.addPhysicalTypeDecoration(loweredType);
StringBuilder nameSB;
bool isColMajor =
getIntVal(matrixType->getLayout()) == SLANG_MATRIX_LAYOUT_COLUMN_MAJOR;
nameSB << "_MatrixStorage_";
getTypeNameHint(nameSB, matrixType->getElementType());
nameSB << getIntVal(matrixType->getRowCount()) << "x"
<< getIntVal(matrixType->getColumnCount());
if (isColMajor)
nameSB << "_ColMajor";
nameSB << getLayoutName(config.layoutRule->ruleName);
builder.addNameHintDecoration(loweredType, nameSB.produceString().getUnownedSlice());
auto structKey = builder.createStructKey();
builder.addNameHintDecoration(structKey, UnownedStringSlice("data"));
auto vectorSize = isColMajor ? matrixType->getRowCount() : matrixType->getColumnCount();
if (config.layoutRule->ruleName == IRTypeLayoutRuleName::Std140 &&
options.use16ByteArrayElementForConstantBuffer)
{
// For constant buffer layout, we need to use 16-byte aligned vector if
// we are required to ensure array element types has 16-byte stride.
vectorSize = builder.getIntValue(get16ByteAlignedVectorElementCount(
matrixType->getElementType(),
getIntVal(vectorSize)));
}
auto vectorType = builder.getVectorType(matrixType->getElementType(), vectorSize);
IRSizeAndAlignment elementSizeAlignment;
getSizeAndAlignment(
target->getOptionSet(),
config.layoutRule,
vectorType,
&elementSizeAlignment);
elementSizeAlignment = config.layoutRule->alignCompositeElement(elementSizeAlignment);
auto arrayType = builder.getArrayType(
vectorType,
isColMajor ? matrixType->getColumnCount() : matrixType->getRowCount(),
builder.getIntValue(builder.getIntType(), elementSizeAlignment.getStride()));
builder.createStructField(loweredType, structKey, arrayType);
info.loweredType = loweredType;
info.loweredInnerArrayType = arrayType;
info.loweredInnerStructKey = structKey;
info.convertLoweredToOriginal =
createMatrixUnpackFunc(matrixType, loweredType, structKey);
info.convertOriginalToLowered =
createMatrixPackFunc(matrixType, loweredType, vectorType, arrayType);
return info;
}
else if (auto arrayTypeBase = as<IRArrayTypeBase>(type))
{
auto loweredInnerTypeInfo = getLoweredTypeInfo(arrayTypeBase->getElementType(), config);
if (config.layoutRule->ruleName == IRTypeLayoutRuleName::Std140 &&
options.use16ByteArrayElementForConstantBuffer)
{
// For constant buffer layout, we need to use 16-byte-aligned vector if
// we are required to ensure array element types has 16-byte stride.
// We only need to handle the case where the element type is a scalar or vector
// type here, because if the element type is a matrix type or struct type,
// the size promotion will be handled during lowering of the element type.
IRType* packedVectorType = nullptr;
if (auto vectorType = as<IRVectorType>(loweredInnerTypeInfo.loweredType))
{
packedVectorType = builder.getVectorType(
vectorType->getElementType(),
builder.getIntValue(get16ByteAlignedVectorElementCount(
vectorType->getElementType(),
getIntVal(vectorType->getElementCount()))));
if (packedVectorType != loweredInnerTypeInfo.originalType)
{
loweredInnerTypeInfo.convertLoweredToOriginal = kIROp_VectorReshape;
loweredInnerTypeInfo.convertOriginalToLowered = kIROp_VectorReshape;
}
}
else if (auto scalarType = as<IRBasicType>(loweredInnerTypeInfo.loweredType))
{
packedVectorType = builder.getVectorType(
loweredInnerTypeInfo.loweredType,
get16ByteAlignedVectorElementCount(scalarType, 1));
loweredInnerTypeInfo.convertLoweredToOriginal = kIROp_VectorReshape;
loweredInnerTypeInfo.convertOriginalToLowered = kIROp_MakeVectorFromScalar;
}
if (packedVectorType)
{
loweredInnerTypeInfo.loweredType = packedVectorType;
if (loweredInnerTypeInfo.convertLoweredToOriginal)
conversionMethodMap[ConversionMethodKey{
packedVectorType,
loweredInnerTypeInfo.originalType}] =
loweredInnerTypeInfo.convertOriginalToLowered;
if (loweredInnerTypeInfo.convertOriginalToLowered)
conversionMethodMap[ConversionMethodKey{
loweredInnerTypeInfo.originalType,
packedVectorType}] = loweredInnerTypeInfo.convertLoweredToOriginal;
}
}
// For spirv backend, we always want to lower all array types for non-varying
// parameters, even if the element type comes out the same. This is because different
// layout rules may have different array stride requirements.
if (!target->shouldEmitSPIRVDirectly() || config.addressSpace == AddressSpace::Input)
{
if (!loweredInnerTypeInfo.convertLoweredToOriginal)
{
info.loweredType = type;
return info;
}
}
auto arrayType = as<IRArrayType>(arrayTypeBase);
if (arrayType)
{
auto loweredType = builder.createStructType();
builder.addPhysicalTypeDecoration(loweredType);
info.loweredType = loweredType;
StringBuilder nameSB;
nameSB << "_Array_" << getLayoutName(config.layoutRule->ruleName) << "_";
getTypeNameHint(nameSB, arrayType->getElementType());
nameSB << getArraySizeVal(arrayType->getElementCount());
builder.addNameHintDecoration(
loweredType,
nameSB.produceString().getUnownedSlice());
auto structKey = builder.createStructKey();
builder.addNameHintDecoration(structKey, UnownedStringSlice("data"));
IRSizeAndAlignment elementSizeAlignment;
getSizeAndAlignment(
target->getOptionSet(),
config.layoutRule,
loweredInnerTypeInfo.loweredType,
&elementSizeAlignment);
elementSizeAlignment =
config.layoutRule->alignCompositeElement(elementSizeAlignment);
auto innerArrayType = builder.getArrayType(
loweredInnerTypeInfo.loweredType,
arrayType->getElementCount(),
builder.getIntValue(builder.getIntType(), elementSizeAlignment.getStride()));
builder.createStructField(loweredType, structKey, innerArrayType);
info.loweredInnerArrayType = innerArrayType;
info.loweredInnerStructKey = structKey;
info.convertLoweredToOriginal =
createArrayUnpackFunc(arrayType, loweredType, structKey, loweredInnerTypeInfo);
info.convertOriginalToLowered =
createArrayPackFunc(arrayType, loweredType, structKey, loweredInnerTypeInfo);
}
else
{
IRSizeAndAlignment elementSizeAlignment;
getSizeAndAlignment(
target->getOptionSet(),
config.layoutRule,
loweredInnerTypeInfo.loweredType,
&elementSizeAlignment);
elementSizeAlignment =
config.layoutRule->alignCompositeElement(elementSizeAlignment);
auto innerArrayType = builder.getArrayTypeBase(
arrayTypeBase->getOp(),
loweredInnerTypeInfo.loweredType,
nullptr,
builder.getIntValue(builder.getIntType(), elementSizeAlignment.getStride()));
info.loweredType = innerArrayType;
}
return info;
}
else if (auto structType = as<IRStructType>(type))
{
List<LoweredElementTypeInfo> fieldLoweredTypeInfo;
bool isTrivial = true;
for (auto field : structType->getFields())
{
auto loweredFieldTypeInfo = getLoweredTypeInfo(field->getFieldType(), config);
fieldLoweredTypeInfo.add(loweredFieldTypeInfo);
if (loweredFieldTypeInfo.convertLoweredToOriginal ||
config.layoutRule->ruleName != IRTypeLayoutRuleName::Natural)
isTrivial = false;
}
// For spirv backend, we always want to lower all array types, even if the element type
// comes out the same. This is because different layout rules may have different array
// stride requirements.
//
// Additionally, `buffer` blocks do not work correctly unless lowered when targeting
// GLSL.
if (!isKhronosTarget(target->getTargetReq()))
{
// For non-spirv target, we skip lowering this type if all field types are
// unchanged.
if (isTrivial)
{
info.loweredType = type;
return info;
}
}
auto loweredType = builder.createStructType();
builder.addPhysicalTypeDecoration(loweredType);
StringBuilder nameSB;
getTypeNameHint(nameSB, type);
nameSB << "_" << getLayoutName(config.layoutRule->ruleName);
builder.addNameHintDecoration(loweredType, nameSB.produceString().getUnownedSlice());
info.loweredType = loweredType;
// Create fields.
{
Index fieldId = 0;
for (auto field : structType->getFields())
{
auto& loweredFieldTypeInfo = fieldLoweredTypeInfo[fieldId];
// When lowering type for user pointer, skip fields that are unsized array.
if (config.addressSpace == AddressSpace::UserPointer &&
as<IRUnsizedArrayType>(loweredFieldTypeInfo.loweredType))
{
fieldId++;
loweredFieldTypeInfo.loweredType = builder.getVoidType();
continue;
}
builder.createStructField(
loweredType,
field->getKey(),
loweredFieldTypeInfo.loweredType);
fieldId++;
}
}
// Create unpack func.
{
builder.setInsertAfter(loweredType);
info.convertLoweredToOriginal = builder.createFunc();
builder.setInsertInto(info.convertLoweredToOriginal.func);
builder.addNameHintDecoration(
info.convertLoweredToOriginal.func,
UnownedStringSlice("unpackStorage"));
builder.addForceInlineDecoration(info.convertLoweredToOriginal.func);
auto refLoweredType = builder.getRefType(loweredType, AddressSpace::Generic);
info.convertLoweredToOriginal.func->setFullType(
builder.getFuncType(1, (IRType**)&refLoweredType, type));
builder.emitBlock();
auto loweredParam = builder.emitParam(refLoweredType);
List<IRInst*> args;
Index fieldId = 0;
for (auto field : structType->getFields())
{
if (as<IRVoidType>(fieldLoweredTypeInfo[fieldId].loweredType))
{
fieldId++;
continue;
}
auto storageField = builder.emitFieldAddress(loweredParam, field->getKey());
auto unpackedField =
fieldLoweredTypeInfo[fieldId].convertLoweredToOriginal.apply(
builder,
field->getFieldType(),
storageField);
args.add(unpackedField);
fieldId++;
}
auto result = builder.emitMakeStruct(type, args);
builder.emitReturn(result);
}
// Create pack func.
{
builder.setInsertAfter(info.convertLoweredToOriginal.func);
info.convertOriginalToLowered = builder.createFunc();
builder.setInsertInto(info.convertOriginalToLowered.func);
builder.addNameHintDecoration(
info.convertOriginalToLowered.func,
UnownedStringSlice("packStorage"));
builder.addForceInlineDecoration(info.convertOriginalToLowered.func);
auto outLoweredType = builder.getRefType(loweredType, AddressSpace::Generic);
IRType* paramTypes[] = {outLoweredType, type};
info.convertOriginalToLowered.func->setFullType(
builder.getFuncType(2, paramTypes, builder.getVoidType()));
builder.emitBlock();
auto outParam = builder.emitParam(outLoweredType);
auto param = builder.emitParam(type);
List<IRInst*> args;
Index fieldId = 0;
for (auto field : structType->getFields())
{
if (as<IRVoidType>(fieldLoweredTypeInfo[fieldId].loweredType))
{
fieldId++;
continue;
}
auto fieldVal =
builder.emitFieldExtract(field->getFieldType(), param, field->getKey());
auto destAddr = builder.emitFieldAddress(outParam, field->getKey());
fieldLoweredTypeInfo[fieldId].convertOriginalToLowered.applyDestinationDriven(
builder,
destAddr,
fieldVal);
fieldId++;
}
builder.emitReturn();
}
return info;
}
if (target->shouldEmitSPIRVDirectly())
{
switch (target->getTargetReq()->getTarget())
{
case CodeGenTarget::SPIRV:
case CodeGenTarget::SPIRVAssembly:
{
auto scalarType = type;
auto vectorType = as<IRVectorType>(scalarType);
if (vectorType)
scalarType = vectorType->getElementType();
if (as<IRBoolType>(scalarType))
{
// Bool is an abstract type in SPIRV, so we need to lower them into an int.
// Find an integer type of the correct size for the current layout rule.
IRSizeAndAlignment boolSizeAndAlignment;
if (getSizeAndAlignment(
target->getOptionSet(),
config.layoutRule,
scalarType,
&boolSizeAndAlignment) == SLANG_OK)
{
IntInfo ii;
ii.width = boolSizeAndAlignment.size * 8;
ii.isSigned = true;
info.loweredType = builder.getType(getIntTypeOpFromInfo(ii));
}
else
{
// Just in case that fails for some reason, just use an int.
info.loweredType = builder.getIntType();
}
if (vectorType)
info.loweredType = builder.getVectorType(
info.loweredType,
vectorType->getElementCount());
info.convertLoweredToOriginal = kIROp_BuiltinCast;
info.convertOriginalToLowered = kIROp_BuiltinCast;
return info;
}
}
default:
break;
}
}
info.loweredType = type;
return info;
}
LoweredTypeMap& getTypeLoweringMap(TypeLoweringConfig config)
{
RefPtr<LoweredTypeMap> map;
if (loweredTypeInfoMaps.tryGetValue(config, map))
return *map;
map = new LoweredTypeMap();
loweredTypeInfoMaps.add(config, map);
return *map;
}
LoweredElementTypeInfo getLoweredTypeInfo(IRType* type, TypeLoweringConfig config)
{
// If `type` is already a lowered type, no more lowering is required.
LoweredElementTypeInfo info;
auto& map = getTypeLoweringMap(config);
auto& mapLoweredTypeToInfo = map.mapLoweredTypeToInfo;
auto& loweredTypeInfo = map.loweredTypeInfo;
if (mapLoweredTypeToInfo.tryGetValue(type))
{
info.originalType = type;
info.loweredType = type;
return info;
}
if (loweredTypeInfo.tryGetValue(type, info))
return info;
info = getLoweredTypeInfoImpl(type, config);
IRSizeAndAlignment sizeAlignment;
getSizeAndAlignment(
target->getOptionSet(),
config.layoutRule,
info.loweredType,
&sizeAlignment);
loweredTypeInfo.set(type, info);
mapLoweredTypeToInfo.set(info.loweredType, info);
conversionMethodMap[{info.originalType, info.loweredType}] = info.convertLoweredToOriginal;
conversionMethodMap[{info.loweredType, info.originalType}] = info.convertOriginalToLowered;
return info;
}
IRType* getLoweredPtrLikeType(IRType* originalPtrLikeType, IRType* newElementType)
{
if (as<IRPointerLikeType>(originalPtrLikeType) || as<IRPtrTypeBase>(originalPtrLikeType) ||
as<IRHLSLStructuredBufferTypeBase>(originalPtrLikeType) ||
as<IRGLSLShaderStorageBufferType>(originalPtrLikeType))
{
IRBuilder builder(newElementType);
builder.setInsertAfter(newElementType);
ShortList<IRInst*> operands;
for (UInt i = 0; i < originalPtrLikeType->getOperandCount(); i++)
operands.add(originalPtrLikeType->getOperand(i));
operands[0] = newElementType;
return builder.getType(
originalPtrLikeType->getOp(),
(UInt)operands.getCount(),
operands.getArrayView().getBuffer());
}
SLANG_UNREACHABLE("unhandled ptr like or buffer type");
}
IRInst* getStoreVal(IRInst* storeInst)
{
if (auto store = as<IRStore>(storeInst))
return store->getVal();
else if (auto sbStore = as<IRRWStructuredBufferStore>(storeInst))
return sbStore->getVal();
return nullptr;
}
struct MatrixAddrWorkItem
{
IRInst* matrixAddrInst;
TypeLoweringConfig config;
};
IRInst* getBufferAddr(IRBuilder& builder, IRInst* loadStoreInst)
{
switch (loadStoreInst->getOp())
{
case kIROp_Load:
case kIROp_Store:
return loadStoreInst->getOperand(0);
case kIROp_StructuredBufferLoad:
case kIROp_StructuredBufferLoadStatus:
case kIROp_RWStructuredBufferLoad:
case kIROp_RWStructuredBufferLoadStatus:
case kIROp_RWStructuredBufferStore:
return builder.emitRWStructuredBufferGetElementPtr(
loadStoreInst->getOperand(0),
loadStoreInst->getOperand(1));
default:
return nullptr;
}
}
void processModule(IRModule* module)
{
IRBuilder builder(module);
struct BufferTypeInfo
{
IRType* bufferType;
IRType* elementType;
bool shouldWrapArrayInStruct = false;
};
List<BufferTypeInfo> bufferTypeInsts;
for (auto globalInst : module->getGlobalInsts())
{
IRType* elementType = nullptr;
if (auto ptrType = as<IRPtrTypeBase>(globalInst))
{
switch (ptrType->getAddressSpace())
{
case AddressSpace::UserPointer:
if (!options.lowerBufferPointer)
continue;
[[fallthrough]];
case AddressSpace::Input:
case AddressSpace::Output:
elementType = ptrType->getValueType();
break;
}
}
if (auto structBuffer = as<IRHLSLStructuredBufferTypeBase>(globalInst))
{
elementType = structBuffer->getElementType();
auto config = getTypeLoweringConfigForBuffer(target, structBuffer);
// Create size and alignment decoration for potential use
// in`StructuredBufferGetDimensions`.
IRSizeAndAlignment sizeAlignment;
getSizeAndAlignment(
target->getOptionSet(),
config.layoutRule,
elementType,
&sizeAlignment);
SLANG_UNUSED(sizeAlignment);
}
else if (auto constBuffer = as<IRUniformParameterGroupType>(globalInst))
elementType = constBuffer->getElementType();
else if (auto storageBuffer = as<IRGLSLShaderStorageBufferType>(globalInst))
elementType = storageBuffer->getElementType();
if (as<IRTextureBufferType>(globalInst))
continue;
if (!as<IRStructType>(elementType) && !as<IRMatrixType>(elementType) &&
!as<IRArrayType>(elementType) && !as<IRBoolType>(elementType))
continue;
bufferTypeInsts.add(BufferTypeInfo{(IRType*)globalInst, elementType});
}
// Maintain a pending work list of all matrix addresses, and try to lower them out of
// existance after everything else has been lowered.
List<MatrixAddrWorkItem> matrixAddrInsts;
for (auto bufferTypeInfo : bufferTypeInsts)
{
auto bufferType = bufferTypeInfo.bufferType;
auto elementType = bufferTypeInfo.elementType;
if (elementType->findDecoration<IRPhysicalTypeDecoration>())
continue;
auto config = getTypeLoweringConfigForBuffer(target, bufferType);
auto loweredBufferElementTypeInfo = getLoweredTypeInfo(elementType, config);
// If the lowered type is the same as original type, no change is required.
if (loweredBufferElementTypeInfo.loweredType ==
loweredBufferElementTypeInfo.originalType)
continue;
builder.setInsertBefore(bufferType);
ShortList<IRInst*> typeOperands;
for (UInt i = 0; i < bufferType->getOperandCount(); i++)
typeOperands.add(bufferType->getOperand(i));
typeOperands[0] = loweredBufferElementTypeInfo.loweredType;
auto loweredBufferType = builder.getType(
bufferType->getOp(),
(UInt)typeOperands.getCount(),
typeOperands.getArrayView().getBuffer());
// We treat a value of a buffer type as a pointer, and use a work list to translate
// all loads and stores through the pointer values that needs lowering.
List<IRInst*> ptrValsWorkList;
traverseUses(
bufferType,
[&](IRUse* use)
{
auto user = use->getUser();
if (use != &user->typeUse)
return;
ptrValsWorkList.add(use->getUser());
});
// Translate the values to use new lowered buffer type instead.
for (Index i = 0; i < ptrValsWorkList.getCount(); i++)
{
auto ptrVal = ptrValsWorkList[i];
auto oldPtrType = ptrVal->getFullType();
auto originalElementType = oldPtrType->getOperand(0);
// If we are accessing an unsized array element from a pointer, we need to compute
// the trailing ptr that points to the first element of the array.
// And then replace all getElementPtr(arrayPtr, index) with
// getOffsetPtr(trailingPtr, index).
if (auto fieldAddr = as<IRFieldAddress>(ptrVal))
{
auto handleUnsizedArrayAccess = [&]() -> bool
{
auto ptrType = as<IRPtrType>(ptrVal->getDataType());
if (!ptrType)
return false;
if (ptrType->getAddressSpace() != AddressSpace::UserPointer)
return false;
if (auto unsizedArrayType = as<IRUnsizedArrayType>(ptrType->getValueType()))
{
builder.setInsertBefore(ptrVal);
auto newArrayPtrVal = fieldAddr->getBase();
auto loweredInnerType =
getLoweredTypeInfo(unsizedArrayType->getElementType(), config);
IRSizeAndAlignment arrayElementSizeAlignment;
getSizeAndAlignment(
target->getOptionSet(),
config.layoutRule,
loweredInnerType.loweredType,
&arrayElementSizeAlignment);
IRSizeAndAlignment baseSizeAlignment;
getSizeAndAlignment(
target->getOptionSet(),
config.layoutRule,
tryGetPointedToType(&builder, fieldAddr->getBase()->getDataType()),
&baseSizeAlignment);
// Convert pointer to uint64 and adjust offset.
IRIntegerValue offset = baseSizeAlignment.size;
offset = align(offset, arrayElementSizeAlignment.alignment);
if (offset != 0)
{
auto rawPtr =
builder.emitBitCast(builder.getUInt64Type(), newArrayPtrVal);
newArrayPtrVal = builder.emitAdd(
rawPtr->getFullType(),
rawPtr,
builder.getIntValue(builder.getUInt64Type(), offset));
}
newArrayPtrVal = builder.emitBitCast(
builder.getPtrType(
loweredInnerType.loweredType,
ptrType->getAddressSpace()),
newArrayPtrVal);
traverseUses(
ptrVal,
[&](IRUse* use)
{
auto user = use->getUser();
if (user->getOp() == kIROp_GetElementPtr)
{
builder.setInsertBefore(user);
auto newElementPtr = builder.emitGetOffsetPtr(
newArrayPtrVal,
user->getOperand(1));
user->replaceUsesWith(newElementPtr);
user->removeAndDeallocate();
ptrValsWorkList.add(newElementPtr);
}
else if (user->getOp() == kIROp_GetOffsetPtr)
{
}
else
{
SLANG_UNEXPECTED(
"unknown use of pointer to unsized array.");
}
});
SLANG_ASSERT(!ptrVal->hasUses());
ptrVal->removeAndDeallocate();
return true;
}
return false;
};
if (handleUnsizedArrayAccess())
continue;
}
LoweredElementTypeInfo loweredElementTypeInfo = {};
if (auto getElementPtr = as<IRGetElementPtr>(ptrVal))
{
if (auto arrayType = as<IRArrayTypeBase>(
tryGetPointedToType(&builder, getElementPtr->getBase()->getDataType())))
{
// For WGSL, an array of scalar or vector type will always be converted to
// an array of 16-byte aligned vector type. In this case, we will run into a
// GetElementPtr where the result type is different from the element type of
// the base array.
// We should setup loweredElementTypeInfo so the remaining logic can handle
// this case and insert proper packing/unpacking logic around it.
if (arrayType->getElementType() != originalElementType &&
isScalarOrVectorType(originalElementType))
{
loweredElementTypeInfo.loweredType = arrayType->getElementType();
loweredElementTypeInfo.originalType = (IRType*)originalElementType;
loweredElementTypeInfo.convertLoweredToOriginal = getConversionMethod(
loweredElementTypeInfo.originalType,
loweredElementTypeInfo.loweredType);
loweredElementTypeInfo.convertOriginalToLowered = getConversionMethod(
loweredElementTypeInfo.loweredType,
loweredElementTypeInfo.originalType);
}
}
}
// For general cases we simply check if the element type needs lowering.
// If so we will insert packing/unpacking logic if necessary.
//
if (!loweredElementTypeInfo.loweredType)
{
loweredElementTypeInfo =
getLoweredTypeInfo((IRType*)originalElementType, config);
}
if (loweredElementTypeInfo.loweredType == loweredElementTypeInfo.originalType)
continue;
ptrVal->setFullType(getLoweredPtrLikeType(
ptrVal->getFullType(),
loweredElementTypeInfo.loweredType));
traverseUses(
ptrVal,
[&](IRUse* use)
{
auto user = use->getUser();
if (as<IRDecoration>(user))
return;
switch (user->getOp())
{
case kIROp_Load:
case kIROp_StructuredBufferLoad:
case kIROp_StructuredBufferLoadStatus:
case kIROp_RWStructuredBufferLoad:
case kIROp_RWStructuredBufferLoadStatus:
case kIROp_StructuredBufferConsume:
{
builder.setInsertBefore(user);
auto addr = getBufferAddr(builder, user);
if (!addr)
{
IRCloneEnv cloneEnv = {};
builder.setInsertBefore(user);
auto newLoad = cloneInst(&cloneEnv, &builder, user);
newLoad->setFullType(loweredElementTypeInfo.loweredType);
addr = builder.emitVar(loweredElementTypeInfo.loweredType);
builder.emitStore(addr, newLoad);
}
if (auto alignedAttr = user->findAttr<IRAlignedAttr>())
{
builder.addAlignedAddressDecoration(
addr,
alignedAttr->getAlignment());
}
auto unpackedVal =
loweredElementTypeInfo.convertLoweredToOriginal.apply(
builder,
loweredElementTypeInfo.originalType,
addr);
user->replaceUsesWith(unpackedVal);
user->removeAndDeallocate();
break;
}
case kIROp_Store:
case kIROp_RWStructuredBufferStore:
case kIROp_StructuredBufferAppend:
{
// Use must be the dest operand of the store inst.
if (use != user->getOperands() + 0)
break;
IRCloneEnv cloneEnv = {};
builder.setInsertBefore(user);
auto originalVal = getStoreVal(user);
IRInst* addr = getBufferAddr(builder, user);
if (addr)
{
if (auto alignedAttr = user->findAttr<IRAlignedAttr>())
{
builder.addAlignedAddressDecoration(
addr,
alignedAttr->getAlignment());
}
loweredElementTypeInfo.convertOriginalToLowered
.applyDestinationDriven(builder, addr, originalVal);
user->removeAndDeallocate();
}
else if (auto sbAppend = as<IRStructuredBufferAppend>(user))
{
builder.setInsertBefore(sbAppend);
addr = builder.emitVar(loweredElementTypeInfo.loweredType);
loweredElementTypeInfo.convertOriginalToLowered
.applyDestinationDriven(builder, addr, originalVal);
auto packedVal = builder.emitLoad(addr);
sbAppend->setOperand(1, packedVal);
}
else
{
SLANG_UNREACHABLE("unhandled store type");
}
break;
}
case kIROp_GetElementPtr:
case kIROp_FieldAddress:
{
// If original type is an array, the lowered type will be a struct.
// In that case, all existing address insts should be appended with
// a field extract.
if (as<IRArrayType>(originalElementType))
{
builder.setInsertBefore(user);
List<IRInst*> args;
for (UInt i = 0; i < user->getOperandCount(); i++)
args.add(user->getOperand(i));
auto newArrayPtrVal = builder.emitFieldAddress(
builder.getPtrType(
loweredElementTypeInfo.loweredInnerArrayType),
ptrVal,
loweredElementTypeInfo.loweredInnerStructKey);
builder.replaceOperand(use, newArrayPtrVal);
ptrValsWorkList.add(user);
}
else if (as<IRMatrixType>(originalElementType))
{
// We are tring to get a pointer to a lowered matrix element.
// We process this insts at a later phase.
SLANG_ASSERT(user->getOp() == kIROp_GetElementPtr);
matrixAddrInsts.add(MatrixAddrWorkItem{user, config});
}
else
{
// If we getting a derived address from the pointer, we need
// to recursively lower the new address. We do so by pushing
// the address inst into the work list.
ptrValsWorkList.add(user);
}
}
break;
case kIROp_RWStructuredBufferGetElementPtr:
case kIROp_GetOffsetPtr:
ptrValsWorkList.add(user);
break;
case kIROp_StructuredBufferGetDimensions:
break;
case kIROp_Call:
{
// If a structured buffer or pointer typed value is used directly as
// an argument, we don't need to do any marshalling here.
if (as<IRHLSLStructuredBufferTypeBase>(ptrVal->getDataType()))
break;
if (options.lowerBufferPointer &&
as<IRPtrType>(ptrVal->getDataType()))
break;
// If we are calling a function with an l-value pointer from buffer
// access, we need to materialize the object as a local variable,
// and pass the address of the local variable to the function.
builder.setInsertBefore(user);
auto unpackedVal =
loweredElementTypeInfo.convertLoweredToOriginal.apply(
builder,
(IRType*)originalElementType,
ptrVal);
auto var = builder.emitVar((IRType*)originalElementType);
builder.emitStore(var, unpackedVal);
use->set(var);
builder.setInsertAfter(user);
auto newVal = builder.emitLoad(var);
loweredElementTypeInfo.convertOriginalToLowered
.applyDestinationDriven(builder, ptrVal, newVal);
}
break;
default:
break;
}
});
}
// Replace all remaining uses of bufferType to loweredBufferType, these uses are
// non-operational and should be directly replaceable, such as uses in `IRFuncType`.
bufferType->replaceUsesWith(loweredBufferType);
bufferType->removeAndDeallocate();
}
// Process all matrix address uses.
lowerMatrixAddresses(module, matrixAddrInsts);
}
// Lower all getElementPtr insts of a lowered matrix out of existance.
void lowerMatrixAddresses(IRModule* module, List<MatrixAddrWorkItem>& matrixAddrInsts)
{
IRBuilder builder(module);
for (auto workItem : matrixAddrInsts)
{
auto majorAddr = workItem.matrixAddrInst;
auto majorGEP = as<IRGetElementPtr>(majorAddr);
SLANG_ASSERT(majorGEP);
auto loweredMatrixType =
cast<IRPtrTypeBase>(majorGEP->getBase()->getFullType())->getValueType();
auto matrixTypeInfo = getTypeLoweringMap(workItem.config)
.mapLoweredTypeToInfo.tryGetValue(loweredMatrixType);
SLANG_ASSERT(matrixTypeInfo);
auto matrixType = as<IRMatrixType>(matrixTypeInfo->originalType);
auto rowCount = getIntVal(matrixType->getRowCount());
traverseUses(
majorAddr,
[&](IRUse* use)
{
auto user = use->getUser();
builder.setInsertBefore(user);
switch (user->getOp())
{
case kIROp_Load:
{
IRInst* resultInst = nullptr;
auto dataPtr = builder.emitFieldAddress(
getLoweredPtrLikeType(
majorAddr->getDataType(),
matrixTypeInfo->loweredInnerArrayType),
majorGEP->getBase(),
matrixTypeInfo->loweredInnerStructKey);
if (getIntVal(matrixType->getLayout()) ==
SLANG_MATRIX_LAYOUT_COLUMN_MAJOR)
{
List<IRInst*> args;
for (IRIntegerValue i = 0; i < rowCount; i++)
{
auto vector =
builder.emitLoad(builder.emitElementAddress(dataPtr, i));
auto element =
builder.emitElementExtract(vector, majorGEP->getIndex());
args.add(element);
}
resultInst = builder.emitMakeVector(
builder.getVectorType(
matrixType->getElementType(),
(IRIntegerValue)args.getCount()),
args);
}
else
{
auto element =
builder.emitElementAddress(dataPtr, majorGEP->getIndex());
resultInst = builder.emitLoad(element);
}
user->replaceUsesWith(resultInst);
user->removeAndDeallocate();
}
break;
case kIROp_Store:
{
auto storeInst = cast<IRStore>(user);
if (storeInst->getOperand(0) != majorAddr)
break;
auto dataPtr = builder.emitFieldAddress(
getLoweredPtrLikeType(
majorAddr->getDataType(),
matrixTypeInfo->loweredInnerArrayType),
majorGEP->getBase(),
matrixTypeInfo->loweredInnerStructKey);
if (getIntVal(matrixType->getLayout()) ==
SLANG_MATRIX_LAYOUT_COLUMN_MAJOR)
{
for (IRIntegerValue i = 0; i < rowCount; i++)
{
auto vectorAddr = builder.emitElementAddress(dataPtr, i);
auto elementAddr = builder.emitElementAddress(
vectorAddr,
majorGEP->getIndex());
builder.emitStore(
elementAddr,
builder.emitElementExtract(storeInst->getVal(), i));
}
}
else
{
auto rowAddr =
builder.emitElementAddress(dataPtr, majorGEP->getIndex());
builder.emitStore(rowAddr, storeInst->getVal());
user->removeAndDeallocate();
}
break;
}
case kIROp_GetElementPtr:
{
auto gep2 = cast<IRGetElementPtr>(user);
auto rowIndex = majorGEP->getIndex();
auto colIndex = gep2->getIndex();
if (getIntVal(matrixType->getLayout()) ==
SLANG_MATRIX_LAYOUT_COLUMN_MAJOR)
{
Swap(rowIndex, colIndex);
}
auto dataPtr = builder.emitFieldAddress(
getLoweredPtrLikeType(
majorAddr->getDataType(),
matrixTypeInfo->loweredInnerArrayType),
majorGEP->getBase(),
matrixTypeInfo->loweredInnerStructKey);
auto vectorAddr = builder.emitElementAddress(dataPtr, rowIndex);
auto elementAddr = builder.emitElementAddress(vectorAddr, colIndex);
gep2->replaceUsesWith(elementAddr);
gep2->removeAndDeallocate();
break;
}
default:
SLANG_UNREACHABLE("unhandled inst of a matrix address inst that needs "
"storage lowering.");
break;
}
});
}
}
};
void lowerBufferElementTypeToStorageType(
TargetProgram* target,
IRModule* module,
BufferElementTypeLoweringOptions options)
{
SlangMatrixLayoutMode defaultMatrixMode =
(SlangMatrixLayoutMode)target->getOptionSet().getMatrixLayoutMode();
if ((isCPUTarget(target->getTargetReq()) || isCUDATarget(target->getTargetReq()) ||
isMetalTarget(target->getTargetReq())))
defaultMatrixMode = SLANG_MATRIX_LAYOUT_ROW_MAJOR;
else if (defaultMatrixMode == SLANG_MATRIX_LAYOUT_MODE_UNKNOWN)
defaultMatrixMode = SLANG_MATRIX_LAYOUT_ROW_MAJOR;
LoweredElementTypeContext context(target, options, defaultMatrixMode);
context.processModule(module);
}
IRTypeLayoutRules* getTypeLayoutRulesFromOp(IROp layoutTypeOp, IRTypeLayoutRules* defaultLayout)
{
switch (layoutTypeOp)
{
case kIROp_DefaultBufferLayoutType:
return defaultLayout;
case kIROp_Std140BufferLayoutType:
return IRTypeLayoutRules::getStd140();
case kIROp_Std430BufferLayoutType:
return IRTypeLayoutRules::getStd430();
case kIROp_ScalarBufferLayoutType:
return IRTypeLayoutRules::getNatural();
case kIROp_CBufferLayoutType:
return IRTypeLayoutRules::getC();
}
return defaultLayout;
}
IRTypeLayoutRules* getTypeLayoutRuleForBuffer(TargetProgram* target, IRType* bufferType)
{
if (target->getTargetReq()->getTarget() != CodeGenTarget::WGSL)
{
if (!isKhronosTarget(target->getTargetReq()))
return IRTypeLayoutRules::getNatural();
// If we are just emitting GLSL, we can just use the general layout rule.
if (!target->shouldEmitSPIRVDirectly())
return IRTypeLayoutRules::getNatural();
// If the user specified a C-compatible buffer layout, then do that.
if (target->getOptionSet().shouldUseCLayout())
return IRTypeLayoutRules::getC();
// If the user specified a scalar buffer layout, then just use that.
if (target->getOptionSet().shouldUseScalarLayout())
return IRTypeLayoutRules::getNatural();
}
if (target->getOptionSet().shouldUseDXLayout())
{
if (as<IRUniformParameterGroupType>(bufferType))
{
return IRTypeLayoutRules::getConstantBuffer();
}
else
return IRTypeLayoutRules::getNatural();
}
// The default behavior is to use std140 for constant buffers and std430 for other buffers.
switch (bufferType->getOp())
{
case kIROp_HLSLStructuredBufferType:
case kIROp_HLSLRWStructuredBufferType:
case kIROp_HLSLAppendStructuredBufferType:
case kIROp_HLSLConsumeStructuredBufferType:
case kIROp_HLSLRasterizerOrderedStructuredBufferType:
{
auto structBufferType = as<IRHLSLStructuredBufferTypeBase>(bufferType);
auto layoutTypeOp = structBufferType->getDataLayout()
? structBufferType->getDataLayout()->getOp()
: kIROp_DefaultBufferLayoutType;
return getTypeLayoutRulesFromOp(layoutTypeOp, IRTypeLayoutRules::getStd430());
}
case kIROp_ConstantBufferType:
case kIROp_ParameterBlockType:
{
auto parameterGroupType = as<IRUniformParameterGroupType>(bufferType);
auto layoutTypeOp = parameterGroupType->getDataLayout()
? parameterGroupType->getDataLayout()->getOp()
: kIROp_DefaultBufferLayoutType;
return getTypeLayoutRulesFromOp(layoutTypeOp, IRTypeLayoutRules::getStd140());
}
case kIROp_GLSLShaderStorageBufferType:
{
auto storageBufferType = as<IRGLSLShaderStorageBufferType>(bufferType);
auto layoutTypeOp = storageBufferType->getDataLayout()
? storageBufferType->getDataLayout()->getOp()
: kIROp_Std430BufferLayoutType;
return getTypeLayoutRulesFromOp(layoutTypeOp, IRTypeLayoutRules::getStd430());
}
case kIROp_PtrType:
return IRTypeLayoutRules::getNatural();
}
return IRTypeLayoutRules::getNatural();
}
TypeLoweringConfig getTypeLoweringConfigForBuffer(TargetProgram* target, IRType* bufferType)
{
AddressSpace addrSpace = AddressSpace::Generic;
if (auto ptrType = as<IRPtrTypeBase>(bufferType))
{
switch (ptrType->getAddressSpace())
{
case AddressSpace::Input:
case AddressSpace::Output:
addrSpace = AddressSpace::Input;
break;
case AddressSpace::UserPointer:
addrSpace = AddressSpace::UserPointer;
break;
}
}
auto rules = getTypeLayoutRuleForBuffer(target, bufferType);
return TypeLoweringConfig{addrSpace, rules};
}
} // namespace Slang
|