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
|
#include <inttypes.h>
#include <stdint.h>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include "Lexer.h"
#include "Parse.h"
#include "WAVM/IR/Module.h"
#include "WAVM/IR/Operators.h"
#include "WAVM/IR/Types.h"
#include "WAVM/IR/Validate.h"
#include "WAVM/Inline/Assert.h"
#include "WAVM/Inline/BasicTypes.h"
#include "WAVM/Inline/Errors.h"
#include "WAVM/Inline/HashMap.h"
#include "WAVM/Inline/Serialization.h"
#include "WAVM/Platform/Intrinsic.h"
using namespace WAVM;
using namespace WAVM::IR;
using namespace WAVM::WAST;
namespace WAVM { namespace WAST {
template<typename InnerStream> struct ResumableCodeValidationProxyStream
{
const Token* validationErrorToken{nullptr};
ResumableCodeValidationProxyStream(ModuleState* moduleState,
const FunctionDef& function,
InnerStream& inInnerStream)
: codeValidationStream(*moduleState->validationState, function)
, innerStream(inInnerStream)
, parseState(moduleState->parseState)
{
}
#define VISIT_OPERATOR(name, Imm, isControlOp) \
void name(Imm imm = {}) \
{ \
try \
{ \
codeValidationStream.name(imm); \
innerStream.name(imm); \
} \
catch(ValidationException const& exception) \
{ \
try \
{ \
codeValidationStream.unreachable(); \
innerStream.unreachable(); \
} \
catch(ValidationException const&) \
{ \
/* If a second validation exception occurs trying to emit unreachable, just */ \
/* throw the original exception up to the top level. */ \
throw exception; \
} \
parseErrorf(parseState, \
validationErrorToken, \
"validation error: %s", \
exception.message.c_str()); \
/* The validator won't have the correct control state after an invalid control */ \
/* operator, so just continue parsing at the next recovery point. */ \
if(isControlOp) { throw RecoverParseException(); } \
} \
}
#define VISIT_CONTROL_OPERATOR(_1, name, _2, Imm, ...) VISIT_OPERATOR(name, Imm, true)
#define VISIT_NONCONTROL_OPERATOR(_1, name, _2, Imm, ...) VISIT_OPERATOR(name, Imm, false)
WAVM_ENUM_NONCONTROL_OPERATORS(VISIT_NONCONTROL_OPERATOR)
WAVM_ENUM_CONTROL_OPERATORS(VISIT_CONTROL_OPERATOR)
#undef VISIT_CONTROL_OPERATOR
#undef VISIT_NONCONTROL_OPERATOR
void finishValidation() { codeValidationStream.finish(); }
private:
CodeValidationStream codeValidationStream;
InnerStream& innerStream;
ParseState* parseState;
};
// State associated with parsing a function.
struct FunctionState
{
FunctionDef& functionDef;
std::shared_ptr<NameToIndexMap> localNameToIndexMap;
Uptr numLocals;
NameToIndexMap branchTargetNameToIndexMap;
Uptr branchTargetDepth;
std::vector<std::string> labelDisassemblyNames;
Serialization::ArrayOutputStream codeByteStream;
OperatorEncoderStream operationEncoder;
ResumableCodeValidationProxyStream<OperatorEncoderStream> validatingCodeStream;
FunctionState(const std::shared_ptr<NameToIndexMap>& inLocalNameToIndexMap,
FunctionDef& inFunctionDef,
ModuleState* moduleState)
: functionDef(inFunctionDef)
, localNameToIndexMap(inLocalNameToIndexMap)
, numLocals(inFunctionDef.nonParameterLocalTypes.size()
+ moduleState->module.types[inFunctionDef.type.index].params().size())
, branchTargetDepth(0)
, operationEncoder(codeByteStream)
, validatingCodeStream(moduleState, inFunctionDef, operationEncoder)
{
}
};
}}
namespace {
// While in scope, pushes a branch target onto the branch target stack.
// Also maintains the branchTargetNameToIndexMap
struct ScopedBranchTarget
{
ScopedBranchTarget(FunctionState* inFunctionState, Name inName)
: functionState(inFunctionState), name(inName), previousBranchTargetIndex(UINTPTR_MAX)
{
branchTargetIndex = ++functionState->branchTargetDepth;
if(name)
{
Uptr& mapValueRef
= functionState->branchTargetNameToIndexMap.getOrAdd(name, UINTPTR_MAX);
if(mapValueRef != UINTPTR_MAX)
{
// If the name was already bound to a branch target, remember the previously
// bound branch target.
previousBranchTargetIndex = mapValueRef;
mapValueRef = branchTargetIndex;
}
else
{
mapValueRef = branchTargetIndex;
}
}
}
~ScopedBranchTarget()
{
WAVM_ASSERT(branchTargetIndex == functionState->branchTargetDepth);
--functionState->branchTargetDepth;
if(name)
{
WAVM_ASSERT(functionState->branchTargetNameToIndexMap.contains(name));
WAVM_ASSERT(functionState->branchTargetNameToIndexMap[name] == branchTargetIndex);
if(previousBranchTargetIndex == UINTPTR_MAX)
{ WAVM_ERROR_UNLESS(functionState->branchTargetNameToIndexMap.remove(name)); }
else
{
functionState->branchTargetNameToIndexMap.set(name, previousBranchTargetIndex);
}
}
}
private:
FunctionState* functionState;
Name name;
Uptr branchTargetIndex;
Uptr previousBranchTargetIndex;
};
}
static bool tryParseAndResolveBranchTargetRef(CursorState* cursor, Uptr& outTargetDepth)
{
Reference branchTargetRef;
if(tryParseNameOrIndexRef(cursor, branchTargetRef))
{
switch(branchTargetRef.type)
{
case Reference::Type::index: outTargetDepth = branchTargetRef.index; break;
case Reference::Type::name: {
const HashMapPair<Name, Uptr>* nameIndexPair
= cursor->functionState->branchTargetNameToIndexMap.getPair(branchTargetRef.name);
if(!nameIndexPair)
{
parseErrorf(cursor->parseState, branchTargetRef.token, "unknown name");
outTargetDepth = UINTPTR_MAX;
}
else
{
outTargetDepth = cursor->functionState->branchTargetDepth - nameIndexPair->value;
}
break;
}
case Reference::Type::invalid:
default: WAVM_UNREACHABLE();
};
return true;
}
return false;
}
static void parseAndValidateRedundantBranchTargetName(CursorState* cursor,
Name branchTargetName,
const char* context,
const char* redundantContext)
{
Name redundantName;
if(tryParseName(cursor, redundantName) && branchTargetName != redundantName)
{
parseErrorf(cursor->parseState,
cursor->nextToken - 1,
"%s label doesn't match %s label",
redundantContext,
context);
}
}
static void parseImm(CursorState* cursor, NoImm&) {}
static void parseImm(CursorState* cursor, MemoryImm& outImm)
{
if(!tryParseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->memoryNameToIndexMap,
cursor->moduleState->module.memories.size(),
"memory",
outImm.memoryIndex))
{ outImm.memoryIndex = 0; }
}
static void parseImm(CursorState* cursor, MemoryCopyImm& outImm)
{
if(!tryParseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->memoryNameToIndexMap,
cursor->moduleState->module.memories.size(),
"memory",
outImm.destMemoryIndex))
{ outImm.destMemoryIndex = 0; }
if(!tryParseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->memoryNameToIndexMap,
cursor->moduleState->module.memories.size(),
"memory",
outImm.sourceMemoryIndex))
{ outImm.sourceMemoryIndex = outImm.destMemoryIndex; }
}
static void parseImm(CursorState* cursor, TableImm& outImm)
{
if(!tryParseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->tableNameToIndexMap,
cursor->moduleState->module.tables.size(),
"table",
outImm.tableIndex))
{ outImm.tableIndex = 0; }
}
static void parseImm(CursorState* cursor, TableCopyImm& outImm)
{
if(!tryParseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->tableNameToIndexMap,
cursor->moduleState->module.tables.size(),
"table",
outImm.destTableIndex))
{ outImm.destTableIndex = 0; }
if(!tryParseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->tableNameToIndexMap,
cursor->moduleState->module.tables.size(),
"table",
outImm.sourceTableIndex))
{ outImm.sourceTableIndex = outImm.destTableIndex; }
}
static void parseImm(CursorState* cursor, SelectImm& outImm)
{
outImm.type = ValueType::any;
const Token* firstResultToken = nullptr;
while(cursor->nextToken[0].type == t_leftParenthesis && cursor->nextToken[1].type == t_result)
{
parseParenthesized(cursor, [&] {
const Token* resultToken = cursor->nextToken;
require(cursor, t_result);
if(!firstResultToken) { firstResultToken = resultToken; }
const Token* valueTypeToken = cursor->nextToken;
ValueType result;
while(tryParseValueType(cursor, result))
{
if(outImm.type == ValueType::any) { outImm.type = result; }
else
{
parseErrorf(cursor->parseState,
valueTypeToken,
"validation error: typed select must have exactly one result");
}
};
});
};
if(firstResultToken && outImm.type == ValueType::any)
{
parseErrorf(cursor->parseState,
firstResultToken,
"validation error: typed select must have exactly one result");
}
}
static void parseImm(CursorState* cursor, LiteralImm<I32>& outImm)
{
outImm.value = parseI32(cursor);
}
static void parseImm(CursorState* cursor, LiteralImm<I64>& outImm)
{
outImm.value = parseI64(cursor);
}
static void parseImm(CursorState* cursor, LiteralImm<F32>& outImm)
{
outImm.value = parseF32(cursor);
}
static void parseImm(CursorState* cursor, LiteralImm<F64>& outImm)
{
outImm.value = parseF64(cursor);
}
static void parseImm(CursorState* cursor, BranchImm& outImm)
{
if(!tryParseAndResolveBranchTargetRef(cursor, outImm.targetDepth))
{
parseErrorf(cursor->parseState, cursor->nextToken, "expected branch target name or index");
throw RecoverParseException();
}
}
static void parseImm(CursorState* cursor, BranchTableImm& outImm)
{
std::vector<Uptr> targetDepths;
Uptr targetDepth = 0;
while(tryParseAndResolveBranchTargetRef(cursor, targetDepth))
{ targetDepths.push_back(targetDepth); };
if(!targetDepths.size())
{
parseErrorf(cursor->parseState, cursor->nextToken, "expected branch target name or index");
throw RecoverParseException();
}
else
{
outImm.defaultTargetDepth = targetDepths.back();
targetDepths.pop_back();
outImm.branchTableIndex = cursor->functionState->functionDef.branchTables.size();
cursor->functionState->functionDef.branchTables.push_back(std::move(targetDepths));
}
}
template<bool isGlobal>
static void parseImm(CursorState* cursor, GetOrSetVariableImm<isGlobal>& outImm)
{
outImm.variableIndex = parseAndResolveNameOrIndexRef(
cursor,
isGlobal ? cursor->moduleState->globalNameToIndexMap
: *cursor->functionState->localNameToIndexMap,
isGlobal ? cursor->moduleState->module.globals.size() : cursor->functionState->numLocals,
isGlobal ? "global" : "local");
}
static void parseImm(CursorState* cursor, FunctionImm& outImm)
{
outImm.functionIndex
= parseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->functionNameToIndexMap,
cursor->moduleState->module.functions.size(),
"function");
}
static void parseImm(CursorState* cursor, FunctionRefImm& outImm)
{
outImm.functionIndex
= parseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->functionNameToIndexMap,
cursor->moduleState->module.functions.size(),
"function");
}
static void parseImm(CursorState* cursor, CallIndirectImm& outImm)
{
if(cursor->nextToken->type == t_name || cursor->nextToken->type == t_quotedName
|| cursor->nextToken->type == t_decimalInt || cursor->nextToken->type == t_hexInt)
{
// Parse a table name or index.
outImm.tableIndex = parseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->tableNameToIndexMap,
cursor->moduleState->module.tables.size(),
"table");
}
else
{
outImm.tableIndex = 0;
}
// Parse the callee type, as a reference or explicit declaration.
const Token* firstTypeToken = cursor->nextToken;
std::vector<std::string> paramDisassemblyNames;
NameToIndexMap paramNameToIndexMap;
const UnresolvedFunctionType unresolvedFunctionType
= parseFunctionTypeRefAndOrDecl(cursor, paramNameToIndexMap, paramDisassemblyNames);
outImm.type.index = resolveFunctionType(cursor->moduleState, unresolvedFunctionType).index;
// Disallow named parameters.
if(paramNameToIndexMap.size())
{
auto paramNameIt = paramNameToIndexMap.begin();
parseErrorf(cursor->parseState,
firstTypeToken,
"call_indirect callee type declaration may not declare parameter names ($%s)",
paramNameIt->key.getString().c_str());
}
}
template<Uptr naturalAlignmentLog2>
static void parseImm(CursorState* cursor, LoadOrStoreImm<naturalAlignmentLog2>& outImm)
{
if(!tryParseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->memoryNameToIndexMap,
cursor->moduleState->module.memories.size(),
"memory",
outImm.memoryIndex))
{ outImm.memoryIndex = 0; }
outImm.offset = 0;
if(cursor->nextToken->type == t_offset)
{
++cursor->nextToken;
require(cursor, t_equals);
outImm.offset = cursor->moduleState->module.featureSpec.memory64 ? parseU64(cursor)
: parseU32(cursor);
}
const U32 naturalAlignment = 1 << naturalAlignmentLog2;
U32 alignment = naturalAlignment;
if(cursor->nextToken->type == t_align)
{
++cursor->nextToken;
require(cursor, t_equals);
const Token* alignmentToken = cursor->nextToken;
alignment = parseU32(cursor);
if(!alignment || alignment & (alignment - 1))
{ parseErrorf(cursor->parseState, cursor->nextToken, "alignment must be power of 2"); }
else if(alignment > naturalAlignment)
{
parseErrorf(cursor->parseState,
alignmentToken,
"validation error: alignment must be <= natural alignment");
alignment = naturalAlignment;
}
}
outImm.alignmentLog2 = (U8)floorLogTwo(alignment);
}
static bool isIntLiteral(TokenType tokenType)
{
return tokenType == t_hexInt || tokenType == t_decimalInt;
}
template<Uptr naturalAlignmentLog2, Uptr numLanes>
static void parseImm(CursorState* cursor,
LoadOrStoreLaneImm<naturalAlignmentLog2, numLanes>& outImm)
{
// If the first immediate is a name, or an integer followed by another integer, alignment, or
// offset, interpret it as a memory reference.
if(cursor->nextToken->type == t_name || cursor->nextToken->type == t_quotedName
|| (isIntLiteral(cursor->nextToken->type)
&& (isIntLiteral(cursor->nextToken[1].type) || cursor->nextToken[1].type == t_offset
|| cursor->nextToken[1].type == t_align)))
{
outImm.memoryIndex
= parseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->memoryNameToIndexMap,
cursor->moduleState->module.memories.size(),
"memory");
}
else
{
outImm.memoryIndex = 0;
}
outImm.offset = 0;
if(cursor->nextToken->type == t_offset)
{
++cursor->nextToken;
require(cursor, t_equals);
outImm.offset = cursor->moduleState->module.featureSpec.memory64 ? parseU64(cursor)
: parseU32(cursor);
}
const U32 naturalAlignment = 1 << naturalAlignmentLog2;
U32 alignment = naturalAlignment;
if(cursor->nextToken->type == t_align)
{
++cursor->nextToken;
require(cursor, t_equals);
const Token* alignmentToken = cursor->nextToken;
alignment = parseU32(cursor);
if(!alignment || alignment & (alignment - 1))
{ parseErrorf(cursor->parseState, cursor->nextToken, "alignment must be power of 2"); }
else if(alignment > naturalAlignment)
{
parseErrorf(cursor->parseState,
alignmentToken,
"validation error: alignment must be <= natural alignment");
alignment = naturalAlignment;
}
}
outImm.alignmentLog2 = (U8)floorLogTwo(alignment);
U8 laneIndex = parseU8(cursor, false);
if(Uptr(laneIndex) >= numLanes)
{
parseErrorf(cursor->parseState,
cursor->nextToken - 1,
"validation error: lane index must be in the range 0..%" WAVM_PRIuPTR,
numLanes - 1);
laneIndex = 0;
}
outImm.laneIndex = laneIndex;
}
static void parseImm(CursorState* cursor, LiteralImm<V128>& outImm)
{
outImm.value = parseV128(cursor);
}
template<Uptr numLanes> static void parseImm(CursorState* cursor, LaneIndexImm<numLanes>& outImm)
{
U8 laneIndex = parseU8(cursor, false);
if(Uptr(laneIndex) >= numLanes)
{
parseErrorf(cursor->parseState,
cursor->nextToken - 1,
"validation error: lane index must be in the range 0..%" WAVM_PRIuPTR,
numLanes - 1);
laneIndex = 0;
}
outImm.laneIndex = laneIndex;
}
template<Uptr numLanes> static void parseImm(CursorState* cursor, ShuffleImm<numLanes>& outImm)
{
for(Uptr destLaneIndex = 0; destLaneIndex < numLanes; ++destLaneIndex)
{
U8 sourceLaneIndex = parseU8(cursor, false);
if(Uptr(sourceLaneIndex) >= numLanes * 2)
{
parseErrorf(cursor->parseState,
cursor->nextToken - 1,
"validation error: lane index must be in the range 0..%" WAVM_PRIuPTR,
numLanes * 2 - 1);
sourceLaneIndex = 0;
}
outImm.laneIndices[destLaneIndex] = sourceLaneIndex;
}
}
template<Uptr naturalAlignmentLog2>
static void parseImm(CursorState* cursor, AtomicLoadOrStoreImm<naturalAlignmentLog2>& outImm)
{
LoadOrStoreImm<naturalAlignmentLog2> loadOrStoreImm;
parseImm(cursor, loadOrStoreImm);
outImm.memoryIndex = loadOrStoreImm.memoryIndex;
outImm.alignmentLog2 = loadOrStoreImm.alignmentLog2;
outImm.offset = loadOrStoreImm.offset;
}
static void parseImm(CursorState* cursor, AtomicFenceImm& outImm)
{
outImm.order = MemoryOrder::sequentiallyConsistent;
}
static void parseImm(CursorState* cursor, ExceptionTypeImm& outImm)
{
outImm.exceptionTypeIndex
= parseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->exceptionTypeNameToIndexMap,
cursor->moduleState->module.exceptionTypes.size(),
"exception type");
}
static void parseImm(CursorState* cursor, DelegateImm& outImm)
{
if(!tryParseAndResolveBranchTargetRef(cursor, outImm.catchDepth))
{
parseErrorf(cursor->parseState, cursor->nextToken, "expected try label or index");
throw RecoverParseException();
}
}
static void parseImm(CursorState* cursor, RethrowImm& outImm)
{
if(!tryParseAndResolveBranchTargetRef(cursor, outImm.catchDepth))
{
parseErrorf(cursor->parseState, cursor->nextToken, "expected try label or index");
throw RecoverParseException();
}
}
static void parseImm(CursorState* cursor, DataSegmentAndMemImm& outImm)
{
Reference firstRef;
if(!tryParseNameOrIndexRef(cursor, firstRef))
{
parseErrorf(cursor->parseState, cursor->nextToken, "expected data segment name or index");
throw RecoverParseException();
}
else
{
Reference secondRef;
const bool hasSecondRef = tryParseNameOrIndexRef(cursor, secondRef);
outImm.memoryIndex = hasSecondRef ? resolveRef(cursor->parseState,
cursor->moduleState->memoryNameToIndexMap,
cursor->moduleState->module.memories.size(),
firstRef)
: 0;
outImm.dataSegmentIndex = resolveRef(cursor->parseState,
cursor->moduleState->dataNameToIndexMap,
cursor->moduleState->module.dataSegments.size(),
hasSecondRef ? secondRef : firstRef);
}
}
static void parseImm(CursorState* cursor, DataSegmentImm& outImm)
{
outImm.dataSegmentIndex
= parseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->dataNameToIndexMap,
cursor->moduleState->module.dataSegments.size(),
"data");
}
static void parseImm(CursorState* cursor, ElemSegmentAndTableImm& outImm)
{
Reference firstRef;
if(!tryParseNameOrIndexRef(cursor, firstRef))
{
parseErrorf(cursor->parseState, cursor->nextToken, "expected elem segment name or index");
throw RecoverParseException();
}
else
{
Reference secondRef;
const bool hasSecondRef = tryParseNameOrIndexRef(cursor, secondRef);
outImm.tableIndex = hasSecondRef ? resolveRef(cursor->parseState,
cursor->moduleState->tableNameToIndexMap,
cursor->moduleState->module.tables.size(),
firstRef)
: 0;
outImm.elemSegmentIndex = resolveRef(cursor->parseState,
cursor->moduleState->elemNameToIndexMap,
cursor->moduleState->module.elemSegments.size(),
hasSecondRef ? secondRef : firstRef);
}
}
static void parseImm(CursorState* cursor, ElemSegmentImm& outImm)
{
outImm.elemSegmentIndex
= parseAndResolveNameOrIndexRef(cursor,
cursor->moduleState->elemNameToIndexMap,
cursor->moduleState->module.elemSegments.size(),
"elem");
}
static void parseImm(CursorState* cursor, ReferenceTypeImm& outImm)
{
outImm.referenceType = parseReferencedType(cursor);
}
static void parseInstrSequence(CursorState* cursor, Uptr depth);
static void parseExpr(CursorState* cursor, Uptr depth);
static void parseControlImm(CursorState* cursor,
Name& outBranchTargetName,
ControlStructureImm& imm)
{
tryParseName(cursor, outBranchTargetName);
cursor->functionState->labelDisassemblyNames.push_back(outBranchTargetName.getString());
FunctionType functionType;
// For backward compatibility, handle a naked result type.
ValueType singleResultType;
if(tryParseValueType(cursor, singleResultType))
{ functionType = FunctionType(TypeTuple(singleResultType)); }
else
{
// Parse the callee type, as a reference or explicit declaration.
const Token* firstTypeToken = cursor->nextToken;
std::vector<std::string> paramDisassemblyNames;
NameToIndexMap paramNameToIndexMap;
const UnresolvedFunctionType unresolvedFunctionType
= parseFunctionTypeRefAndOrDecl(cursor, paramNameToIndexMap, paramDisassemblyNames);
// Disallow named parameters.
if(paramNameToIndexMap.size())
{
auto paramNameIt = paramNameToIndexMap.begin();
parseErrorf(cursor->parseState,
firstTypeToken,
"block type declaration may not declare parameter names ($%s)",
paramNameIt->key.getString().c_str());
}
if(!unresolvedFunctionType.reference)
{
// If there wasn't a type reference, just use the inline declared params and results.
functionType = unresolvedFunctionType.explicitType;
}
else
{
// If there was a type reference, resolve it. This also verifies that if there were also
// params and/or results declared inline that they match the resolved type reference.
const Uptr referencedFunctionTypeIndex
= resolveFunctionType(cursor->moduleState, unresolvedFunctionType).index;
if(referencedFunctionTypeIndex != UINTPTR_MAX)
{
WAVM_ASSERT(referencedFunctionTypeIndex < cursor->moduleState->module.types.size());
functionType = cursor->moduleState->module.types[referencedFunctionTypeIndex];
}
}
}
// Translate the function type into an indexed block type.
if(functionType.params().size() == 0 && functionType.results().size() == 0)
{
imm.type.format = IndexedBlockType::noParametersOrResult;
imm.type.resultType = ValueType::none;
}
else if(functionType.params().size() == 0 && functionType.results().size() == 1)
{
imm.type.format = IndexedBlockType::oneResult;
imm.type.resultType = functionType.results()[0];
}
else
{
imm.type.format = IndexedBlockType::functionType;
imm.type.index = getUniqueFunctionTypeIndex(cursor->moduleState, functionType).index;
}
}
static void checkRecursionDepth(CursorState* cursor, Uptr depth)
{
if(depth > cursor->moduleState->module.featureSpec.maxSyntaxRecursion)
{
parseErrorf(cursor->parseState, cursor->nextToken, "exceeded maximum recursion depth");
throw RecoverParseException();
}
}
static WAVM_FORCENOINLINE void parseBlock(CursorState* cursor, bool isExpr, Uptr depth)
{
Name branchTargetName;
ControlStructureImm imm;
parseControlImm(cursor, branchTargetName, imm);
ScopedBranchTarget branchTarget(cursor->functionState, branchTargetName);
cursor->functionState->validatingCodeStream.block(imm);
parseInstrSequence(cursor, depth);
cursor->functionState->validatingCodeStream.end();
if(!isExpr)
{
require(cursor, t_end);
parseAndValidateRedundantBranchTargetName(cursor, branchTargetName, "block", "end");
}
}
static WAVM_FORCENOINLINE void parseLoop(CursorState* cursor, bool isExpr, Uptr depth)
{
Name branchTargetName;
ControlStructureImm imm;
parseControlImm(cursor, branchTargetName, imm);
ScopedBranchTarget branchTarget(cursor->functionState, branchTargetName);
cursor->functionState->validatingCodeStream.loop(imm);
parseInstrSequence(cursor, depth);
cursor->functionState->validatingCodeStream.end();
if(!isExpr)
{
require(cursor, t_end);
parseAndValidateRedundantBranchTargetName(cursor, branchTargetName, "loop", "end");
}
}
static WAVM_FORCENOINLINE void parseIfInstr(CursorState* cursor, Uptr depth)
{
Name branchTargetName;
ControlStructureImm imm;
parseControlImm(cursor, branchTargetName, imm);
ScopedBranchTarget branchTarget(cursor->functionState, branchTargetName);
cursor->functionState->validatingCodeStream.if_(imm);
// Parse the then clause.
parseInstrSequence(cursor, depth);
// Parse the else clause.
if(cursor->nextToken->type == t_else_)
{
++cursor->nextToken;
parseAndValidateRedundantBranchTargetName(cursor, branchTargetName, "if", "else");
cursor->functionState->validatingCodeStream.else_();
parseInstrSequence(cursor, depth);
}
cursor->functionState->validatingCodeStream.end();
require(cursor, t_end);
parseAndValidateRedundantBranchTargetName(cursor, branchTargetName, "if", "end");
}
static WAVM_FORCENOINLINE void parseIfExpr(CursorState* cursor, Uptr depth)
{
Name branchTargetName;
ControlStructureImm imm;
parseControlImm(cursor, branchTargetName, imm);
// Parse an optional condition expression.
if(cursor->nextToken[0].type != t_leftParenthesis || cursor->nextToken[1].type != t_then)
{ parseExpr(cursor, depth); }
ScopedBranchTarget branchTarget(cursor->functionState, branchTargetName);
cursor->functionState->validatingCodeStream.if_(imm);
// Parse the if clauses.
if(cursor->nextToken[0].type == t_leftParenthesis && cursor->nextToken[1].type == t_then)
{
// First syntax: (then <instr>)* (else <instr>*)?
parseParenthesized(cursor, [&] {
require(cursor, t_then);
parseInstrSequence(cursor, depth);
});
if(cursor->nextToken->type == t_leftParenthesis)
{
parseParenthesized(cursor, [&] {
require(cursor, t_else_);
cursor->functionState->validatingCodeStream.validationErrorToken
= cursor->nextToken;
cursor->functionState->validatingCodeStream.else_();
parseInstrSequence(cursor, depth);
});
}
}
else
{
// Second syntax option: <expr> <expr>?
parseExpr(cursor, depth);
if(cursor->nextToken->type != t_rightParenthesis)
{
cursor->functionState->validatingCodeStream.else_();
parseExpr(cursor, depth);
}
}
cursor->functionState->validatingCodeStream.end();
}
static WAVM_FORCENOINLINE void parseTryInstr(CursorState* cursor, Uptr depth)
{
Name branchTargetName;
ControlStructureImm imm;
parseControlImm(cursor, branchTargetName, imm);
ScopedBranchTarget branchTarget(cursor->functionState, branchTargetName);
cursor->functionState->validatingCodeStream.try_(imm);
// Parse the try clause.
parseInstrSequence(cursor, depth);
// Parse catch clauses.
while(cursor->nextToken->type != t_end)
{
if(cursor->nextToken->type == t_catch_)
{
++cursor->nextToken;
ExceptionTypeImm exceptionTypeImm;
parseImm(cursor, exceptionTypeImm);
cursor->functionState->validatingCodeStream.catch_(exceptionTypeImm);
parseInstrSequence(cursor, depth);
}
else if(cursor->nextToken->type == t_catch_all)
{
++cursor->nextToken;
cursor->functionState->validatingCodeStream.catch_all();
parseInstrSequence(cursor, depth);
}
else
{
parseErrorf(cursor->parseState,
cursor->nextToken,
"expected 'catch', 'catch_all', or 'end' following 'try'");
throw RecoverParseException();
}
};
require(cursor, t_end);
parseAndValidateRedundantBranchTargetName(cursor, branchTargetName, "try", "end");
cursor->functionState->validatingCodeStream.end();
}
static WAVM_FORCENOINLINE void parseExprSequence(CursorState* cursor, Uptr depth)
{
while(cursor->nextToken->type != t_rightParenthesis) { parseExpr(cursor, depth); };
}
#define VISIT_OP(opcode, name, nameString, Imm, ...) \
static WAVM_FORCENOINLINE void parseOp_##name( \
CursorState* cursor, bool isExpression, Uptr depth) \
{ \
const Token* opcodeToken = cursor->nextToken; \
++cursor->nextToken; \
Imm imm; \
parseImm(cursor, imm); \
if(isExpression) { parseExprSequence(cursor, depth); } \
cursor->functionState->validatingCodeStream.validationErrorToken = opcodeToken; \
cursor->functionState->validatingCodeStream.name(imm); \
}
WAVM_ENUM_NONCONTROL_OPERATORS(VISIT_OP)
#undef VISIT_OP
static void parseExpr(CursorState* cursor, Uptr depth)
{
++depth;
checkRecursionDepth(cursor, depth);
parseParenthesized(cursor, [&] {
cursor->functionState->validatingCodeStream.validationErrorToken = cursor->nextToken;
try
{
switch(cursor->nextToken->type)
{
case t_block: {
++cursor->nextToken;
parseBlock(cursor, true, depth);
break;
}
case t_loop: {
++cursor->nextToken;
parseLoop(cursor, true, depth);
break;
}
case t_if_: {
++cursor->nextToken;
parseIfExpr(cursor, depth);
break;
}
#define VISIT_OP(opcode, name, nameString, Imm, ...) \
case t_##name: \
parseOp_##name(cursor, true, depth); \
break;
WAVM_ENUM_NONCONTROL_OPERATORS(VISIT_OP)
#undef VISIT_OP
case t_legacyInstructionName:
parseErrorf(cursor->parseState,
cursor->nextToken,
"legacy instruction name: requires the legacy-instr-name feature.");
throw RecoverParseException();
default:
parseErrorf(cursor->parseState, cursor->nextToken, "expected instruction name");
throw RecoverParseException();
}
}
catch(RecoverParseException const&)
{
cursor->functionState->validatingCodeStream.unreachable();
throw RecoverParseException();
}
});
}
static void parseInstrSequence(CursorState* cursor, Uptr depth)
{
while(true)
{
cursor->functionState->validatingCodeStream.validationErrorToken = cursor->nextToken;
try
{
switch(cursor->nextToken->type)
{
case t_leftParenthesis: parseExpr(cursor, depth); break;
case t_rightParenthesis: return;
case t_else_: return;
case t_end: return;
case t_catch_: return;
case t_catch_all: return;
case t_block: {
checkRecursionDepth(cursor, depth + 1);
++cursor->nextToken;
parseBlock(cursor, false, depth + 1);
break;
}
case t_loop: {
checkRecursionDepth(cursor, depth + 1);
++cursor->nextToken;
parseLoop(cursor, false, depth + 1);
break;
}
case t_if_: {
checkRecursionDepth(cursor, depth + 1);
++cursor->nextToken;
parseIfInstr(cursor, depth + 1);
break;
}
case t_try_: {
checkRecursionDepth(cursor, depth + 1);
++cursor->nextToken;
parseTryInstr(cursor, depth + 1);
break;
}
#define VISIT_OP(opcode, name, nameString, Imm, ...) \
case t_##name: parseOp_##name(cursor, false, depth); break;
WAVM_ENUM_NONCONTROL_OPERATORS(VISIT_OP)
#undef VISIT_OP
case t_legacyInstructionName:
parseErrorf(cursor->parseState,
cursor->nextToken,
"legacy instruction name: requires the legacy-instr-name feature.");
throw RecoverParseException();
default:
parseErrorf(cursor->parseState, cursor->nextToken, "expected instruction name");
throw RecoverParseException();
}
}
catch(RecoverParseException const&)
{
cursor->functionState->validatingCodeStream.unreachable();
// This is a workaround for rethrowing from a catch handler blowing up the stack.
// On Windows, the call stack frames between the throw and the catch are not freed until
// exiting the catch scope. The throw uses substantial stack space, and the catch adds a
// stack frame on top of that. As a result, unwinding a call stack by recursively
// throwing exceptions from within catch scopes can overflow the stack.
// Jumping out of the catch before rethrowing ensures that the stack frames between the
// original throw and this function are freed before continuing to unwind the stack.
goto rethrowRecoverParseException;
}
};
WAVM_UNREACHABLE();
rethrowRecoverParseException:
throw RecoverParseException();
}
FunctionDef WAST::parseFunctionDef(CursorState* cursor, const Token* funcToken)
{
std::shared_ptr<std::vector<std::string>> localDisassemblyNames
= std::make_shared<std::vector<std::string>>();
std::shared_ptr<NameToIndexMap> localNameToIndexMap = std::make_shared<NameToIndexMap>();
// Parse the function type, as a reference or explicit declaration.
const UnresolvedFunctionType unresolvedFunctionType
= parseFunctionTypeRefAndOrDecl(cursor, *localNameToIndexMap, *localDisassemblyNames);
// Defer resolving the function type until all type declarations have been parsed.
const Uptr functionIndex = cursor->moduleState->module.functions.size();
const Uptr functionDefIndex = cursor->moduleState->module.functions.defs.size();
const Token* firstBodyToken = cursor->nextToken;
cursor->moduleState->postTypeCallbacks.push_back([functionIndex,
functionDefIndex,
firstBodyToken,
localNameToIndexMap,
localDisassemblyNames,
unresolvedFunctionType](
ModuleState* moduleState) {
// Resolve the function type and set it on the FunctionDef.
const IndexedFunctionType functionTypeIndex
= resolveFunctionType(moduleState, unresolvedFunctionType);
moduleState->module.functions.defs[functionDefIndex].type = functionTypeIndex;
// Defer parsing the body of the function until all function types have been resolved.
moduleState->functionBodyCallbacks.push_back([functionIndex,
functionDefIndex,
firstBodyToken,
localNameToIndexMap,
localDisassemblyNames,
functionTypeIndex](ModuleState* moduleState) {
FunctionDef& functionDef = moduleState->module.functions.defs[functionDefIndex];
FunctionType functionType = functionTypeIndex.index == UINTPTR_MAX
? FunctionType()
: moduleState->module.types[functionTypeIndex.index];
// Parse the function's local variables.
CursorState functionCursorState(firstBodyToken, moduleState->parseState, moduleState);
while(tryParseParenthesizedTagged(&functionCursorState, t_local, [&] {
Name localName;
if(tryParseName(&functionCursorState, localName))
{
bindName(
moduleState->parseState,
*localNameToIndexMap,
localName,
functionType.params().size() + functionDef.nonParameterLocalTypes.size());
localDisassemblyNames->push_back(localName.getString());
functionDef.nonParameterLocalTypes.push_back(
parseValueType(&functionCursorState));
}
else
{
while(functionCursorState.nextToken->type != t_rightParenthesis)
{
localDisassemblyNames->push_back(std::string());
functionDef.nonParameterLocalTypes.push_back(
parseValueType(&functionCursorState));
};
}
}))
{};
moduleState->disassemblyNames.functions[functionIndex].locals
= std::move(*localDisassemblyNames);
// Parse the function's code.
const Token* validationErrorToken = firstBodyToken;
try
{
FunctionState functionState(localNameToIndexMap, functionDef, moduleState);
functionCursorState.functionState = &functionState;
try
{
parseInstrSequence(&functionCursorState, 0);
if(!moduleState->parseState->unresolvedErrors.size())
{
validationErrorToken = functionCursorState.nextToken;
functionState.validatingCodeStream.end();
functionState.validatingCodeStream.finishValidation();
}
}
catch(RecoverParseException const&)
{
}
catch(FatalParseException const&)
{
}
functionDef.code = std::move(functionState.codeByteStream.getBytes());
moduleState->disassemblyNames.functions[functionIndex].labels
= std::move(functionState.labelDisassemblyNames);
}
catch(ValidationException const& exception)
{
parseErrorf(moduleState->parseState,
validationErrorToken,
"validation error: %s",
exception.message.c_str());
}
});
});
// Continue parsing after the closing parenthesis.
findClosingParenthesis(cursor, funcToken - 1);
--cursor->nextToken;
return {{UINTPTR_MAX}, {}, {}, {}};
}
|