-
Notifications
You must be signed in to change notification settings - Fork 292
/
FIRParser.cpp
5664 lines (4846 loc) · 197 KB
/
FIRParser.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//===- FIRParser.cpp - .fir to FIRRTL dialect parser ----------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This implements a .fir file parser.
//
//===----------------------------------------------------------------------===//
#include "circt/Dialect/FIRRTL/FIRParser.h"
#include "FIRAnnotations.h"
#include "FIRLexer.h"
#include "circt/Dialect/FIRRTL/AnnotationDetails.h"
#include "circt/Dialect/FIRRTL/CHIRRTLDialect.h"
#include "circt/Dialect/FIRRTL/FIRRTLAttributes.h"
#include "circt/Dialect/FIRRTL/FIRRTLOps.h"
#include "circt/Dialect/FIRRTL/FIRRTLUtils.h"
#include "circt/Dialect/FIRRTL/Import/FIRAnnotations.h"
#include "circt/Dialect/HW/HWAttributes.h"
#include "circt/Dialect/HW/InnerSymbolNamespace.h"
#include "circt/Support/LLVM.h"
#include "mlir/IR/BuiltinOps.h"
#include "mlir/IR/BuiltinTypes.h"
#include "mlir/IR/Diagnostics.h"
#include "mlir/IR/ImplicitLocOpBuilder.h"
#include "mlir/IR/PatternMatch.h"
#include "mlir/IR/Threading.h"
#include "mlir/IR/Verifier.h"
#include "mlir/Support/Timing.h"
#include "mlir/Tools/mlir-translate/Translation.h"
#include "llvm/ADT/PointerEmbeddedInt.h"
#include "llvm/ADT/STLExtras.h"
#include "llvm/ADT/SmallPtrSet.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/ADT/StringSwitch.h"
#include "llvm/ADT/TypeSwitch.h"
#include "llvm/Support/JSON.h"
#include "llvm/Support/SourceMgr.h"
#include "llvm/Support/raw_ostream.h"
#include <memory>
using namespace circt;
using namespace firrtl;
using namespace chirrtl;
using llvm::SMLoc;
using llvm::SourceMgr;
using mlir::LocationAttr;
namespace json = llvm::json;
//===----------------------------------------------------------------------===//
// SharedParserConstants
//===----------------------------------------------------------------------===//
namespace {
/// This class refers to immutable values and annotations maintained globally by
/// the parser which can be referred to by any active parser, even those running
/// in parallel. This is shared by all active parsers.
struct SharedParserConstants {
SharedParserConstants(MLIRContext *context, FIRParserOptions options)
: context(context), options(options),
emptyArrayAttr(ArrayAttr::get(context, {})),
loIdentifier(StringAttr::get(context, "lo")),
hiIdentifier(StringAttr::get(context, "hi")),
amountIdentifier(StringAttr::get(context, "amount")),
fieldIndexIdentifier(StringAttr::get(context, "fieldIndex")),
indexIdentifier(StringAttr::get(context, "index")) {}
/// The context we're parsing into.
MLIRContext *const context;
// Options that control the behavior of the parser.
const FIRParserOptions options;
/// A map from identifiers to type aliases.
llvm::StringMap<FIRRTLType> aliasMap;
/// A map from identifiers to class ops.
llvm::DenseMap<StringRef, ClassLike> classMap;
/// An empty array attribute.
const ArrayAttr emptyArrayAttr;
/// Cached identifiers used in primitives.
const StringAttr loIdentifier, hiIdentifier, amountIdentifier;
const StringAttr fieldIndexIdentifier, indexIdentifier;
private:
SharedParserConstants(const SharedParserConstants &) = delete;
void operator=(const SharedParserConstants &) = delete;
};
} // end anonymous namespace
//===----------------------------------------------------------------------===//
// FIRParser
//===----------------------------------------------------------------------===//
namespace {
/// This class implements logic common to all levels of the parser, including
/// things like types and helper logic.
struct FIRParser {
FIRParser(SharedParserConstants &constants, FIRLexer &lexer,
FIRVersion version)
: version(version), constants(constants), lexer(lexer),
locatorFilenameCache(constants.loIdentifier /*arbitrary non-null id*/) {
}
// Helper methods to get stuff from the shared parser constants.
SharedParserConstants &getConstants() const { return constants; }
MLIRContext *getContext() const { return constants.context; }
FIRLexer &getLexer() { return lexer; }
/// Return the indentation level of the specified token.
std::optional<unsigned> getIndentation() const {
return lexer.getIndentation(getToken());
}
/// Return the current token the parser is inspecting.
const FIRToken &getToken() const { return lexer.getToken(); }
StringRef getTokenSpelling() const { return getToken().getSpelling(); }
//===--------------------------------------------------------------------===//
// Error Handling
//===--------------------------------------------------------------------===//
/// Emit an error and return failure.
InFlightDiagnostic emitError(const Twine &message = {}) {
return emitError(getToken().getLoc(), message);
}
InFlightDiagnostic emitError(SMLoc loc, const Twine &message = {});
/// Emit a warning.
InFlightDiagnostic emitWarning(const Twine &message = {}) {
return emitWarning(getToken().getLoc(), message);
}
InFlightDiagnostic emitWarning(SMLoc loc, const Twine &message = {});
//===--------------------------------------------------------------------===//
// Location Handling
//===--------------------------------------------------------------------===//
class LocWithInfo;
/// Encode the specified source location information into an attribute for
/// attachment to the IR.
Location translateLocation(llvm::SMLoc loc) {
return lexer.translateLocation(loc);
}
/// Parse an @info marker if present. If so, fill in the specified Location,
/// if not, ignore it.
ParseResult parseOptionalInfoLocator(LocationAttr &result);
/// Parse an optional name that may appear in Stop, Printf, or Verification
/// statements.
ParseResult parseOptionalName(StringAttr &name);
//===--------------------------------------------------------------------===//
// Version and Feature Checking
//===--------------------------------------------------------------------===//
ParseResult requireFeature(FIRVersion minimum, StringRef feature) {
return requireFeature(minimum, feature, getToken().getLoc());
}
ParseResult requireFeature(FIRVersion minimum, StringRef feature, SMLoc loc) {
if (version < minimum)
return emitError(loc)
<< feature << " are a FIRRTL " << minimum
<< "+ feature, but the specified FIRRTL version was " << version;
return success();
}
ParseResult removedFeature(FIRVersion removedVersion, StringRef feature) {
return removedFeature(removedVersion, feature, getToken().getLoc());
}
ParseResult removedFeature(FIRVersion removedVersion, StringRef feature,
SMLoc loc) {
if (version >= removedVersion)
return emitError(loc)
<< feature << " were removed in FIRRTL " << removedVersion
<< ", but the specified FIRRTL version was " << version;
return success();
}
//===--------------------------------------------------------------------===//
// Annotation Parsing
//===--------------------------------------------------------------------===//
/// Parse a non-standard inline Annotation JSON blob if present. This uses
/// the info-like encoding of %[<JSON Blob>].
ParseResult parseOptionalAnnotations(SMLoc &loc, StringRef &result);
//===--------------------------------------------------------------------===//
// Token Parsing
//===--------------------------------------------------------------------===//
/// If the current token has the specified kind, consume it and return true.
/// If not, return false.
bool consumeIf(FIRToken::Kind kind) {
if (getToken().isNot(kind))
return false;
consumeToken(kind);
return true;
}
/// Advance the current lexer onto the next token.
///
/// This returns the consumed token.
FIRToken consumeToken() {
FIRToken consumedToken = getToken();
assert(consumedToken.isNot(FIRToken::eof, FIRToken::error) &&
"shouldn't advance past EOF or errors");
lexer.lexToken();
return consumedToken;
}
/// Advance the current lexer onto the next token, asserting what the expected
/// current token is. This is preferred to the above method because it leads
/// to more self-documenting code with better checking.
///
/// This returns the consumed token.
FIRToken consumeToken(FIRToken::Kind kind) {
FIRToken consumedToken = getToken();
assert(consumedToken.is(kind) && "consumed an unexpected token");
consumeToken();
return consumedToken;
}
/// Capture the current token's spelling into the specified value. This
/// always succeeds.
ParseResult parseGetSpelling(StringRef &spelling) {
spelling = getTokenSpelling();
return success();
}
/// Consume the specified token if present and return success. On failure,
/// output a diagnostic and return failure.
ParseResult parseToken(FIRToken::Kind expectedToken, const Twine &message);
/// Parse a comma-separated list of elements, terminated with an arbitrary
/// token.
ParseResult parseListUntil(FIRToken::Kind rightToken,
const std::function<ParseResult()> &parseElement);
//===--------------------------------------------------------------------===//
// Common Parser Rules
//===--------------------------------------------------------------------===//
/// Parse 'intLit' into the specified value.
ParseResult parseIntLit(APInt &result, const Twine &message);
ParseResult parseIntLit(int64_t &result, const Twine &message);
ParseResult parseIntLit(int32_t &result, const Twine &message);
// Parse 'verLit' into specified value
ParseResult parseVersionLit(const Twine &message);
// Parse ('<' intLit '>')? setting result to -1 if not present.
template <typename T>
ParseResult parseOptionalWidth(T &result);
// Parse the 'id' grammar, which is an identifier or an allowed keyword.
ParseResult parseId(StringRef &result, const Twine &message);
ParseResult parseId(StringAttr &result, const Twine &message);
ParseResult parseFieldId(StringRef &result, const Twine &message);
ParseResult parseFieldIdSeq(SmallVectorImpl<StringRef> &result,
const Twine &message);
ParseResult parseEnumType(FIRRTLType &result);
ParseResult parseListType(FIRRTLType &result);
ParseResult parseType(FIRRTLType &result, const Twine &message);
// Parse a property type specifically.
ParseResult parsePropertyType(PropertyType &result, const Twine &message);
ParseResult parseRUW(RUWAttr &result);
ParseResult parseOptionalRUW(RUWAttr &result);
ParseResult parseParameter(StringAttr &resultName, TypedAttr &resultValue,
SMLoc &resultLoc);
/// The version of FIRRTL to use for this parser.
FIRVersion version;
private:
FIRParser(const FIRParser &) = delete;
void operator=(const FIRParser &) = delete;
/// FIRParser is subclassed and reinstantiated. Do not add additional
/// non-trivial state here, add it to SharedParserConstants.
SharedParserConstants &constants;
FIRLexer &lexer;
/// This is a single-entry cache for filenames in locators.
StringAttr locatorFilenameCache;
/// This is a single-entry cache for FileLineCol locations.
FileLineColLoc fileLineColLocCache;
};
} // end anonymous namespace
//===----------------------------------------------------------------------===//
// Error Handling
//===----------------------------------------------------------------------===//
InFlightDiagnostic FIRParser::emitError(SMLoc loc, const Twine &message) {
auto diag = mlir::emitError(translateLocation(loc), message);
// If we hit a parse error in response to a lexer error, then the lexer
// already reported the error.
if (getToken().is(FIRToken::error))
diag.abandon();
return diag;
}
InFlightDiagnostic FIRParser::emitWarning(SMLoc loc, const Twine &message) {
return mlir::emitWarning(translateLocation(loc), message);
}
//===----------------------------------------------------------------------===//
// Token Parsing
//===----------------------------------------------------------------------===//
/// Consume the specified token if present and return success. On failure,
/// output a diagnostic and return failure.
ParseResult FIRParser::parseToken(FIRToken::Kind expectedToken,
const Twine &message) {
if (consumeIf(expectedToken))
return success();
return emitError(message);
}
/// Parse a comma-separated list of zero or more elements, terminated with an
/// arbitrary token.
ParseResult
FIRParser::parseListUntil(FIRToken::Kind rightToken,
const std::function<ParseResult()> &parseElement) {
if (consumeIf(rightToken))
return success();
if (parseElement())
return failure();
while (consumeIf(FIRToken::comma)) {
if (parseElement())
return failure();
}
if (parseToken(rightToken, "expected ','"))
return failure();
return success();
}
//===--------------------------------------------------------------------===//
// Location Processing
//===--------------------------------------------------------------------===//
/// This helper class is used to handle Info records, which specify higher level
/// symbolic source location, that may be missing from the file. If the higher
/// level source information is missing, we fall back to the location in the
/// .fir file.
class FIRParser::LocWithInfo {
public:
explicit LocWithInfo(SMLoc firLoc, FIRParser *parser)
: parser(parser), firLoc(firLoc) {}
SMLoc getFIRLoc() const { return firLoc; }
Location getLoc() {
if (infoLoc)
return *infoLoc;
auto result = parser->translateLocation(firLoc);
infoLoc = result;
return result;
}
/// Parse an @info marker if present and update our location.
ParseResult parseOptionalInfo() {
LocationAttr loc;
if (failed(parser->parseOptionalInfoLocator(loc)))
return failure();
if (loc) {
using ILH = FIRParserOptions::InfoLocHandling;
switch (parser->constants.options.infoLocatorHandling) {
case ILH::IgnoreInfo:
assert(0 && "Should not return info locations if ignoring");
break;
case ILH::PreferInfo:
infoLoc = loc;
break;
case ILH::FusedInfo:
infoLoc = FusedLoc::get(loc.getContext(),
{loc, parser->translateLocation(firLoc)});
break;
}
}
return success();
}
/// If we didn't parse an info locator for the specified value, this sets a
/// default, overriding a fall back to a location in the .fir file.
void setDefaultLoc(Location loc) {
if (!infoLoc)
infoLoc = loc;
}
private:
FIRParser *const parser;
/// This is the designated location in the .fir file for use when there is no
/// @ info marker.
SMLoc firLoc;
/// This is the location specified by the @ marker if present.
std::optional<Location> infoLoc;
};
/// Parse an @info marker if present. If so, fill in the specified Location,
/// if not, ignore it.
ParseResult FIRParser::parseOptionalInfoLocator(LocationAttr &result) {
if (getToken().isNot(FIRToken::fileinfo))
return success();
auto loc = getToken().getLoc();
auto spelling = getTokenSpelling();
consumeToken(FIRToken::fileinfo);
auto locationPair = maybeStringToLocation(
spelling,
constants.options.infoLocatorHandling ==
FIRParserOptions::InfoLocHandling::IgnoreInfo,
locatorFilenameCache, fileLineColLocCache, getContext());
// If parsing failed, then indicate that a weird info was found.
if (!locationPair.first) {
mlir::emitWarning(translateLocation(loc),
"ignoring unknown @ info record format");
return success();
}
// If the parsing succeeded, but we are supposed to drop locators, then just
// return.
if (locationPair.first && constants.options.infoLocatorHandling ==
FIRParserOptions::InfoLocHandling::IgnoreInfo)
return success();
// Otherwise, set the location attribute and return.
result = *locationPair.second;
return success();
}
/// Parse an optional trailing name that may show up on assert, assume, cover,
/// stop, or printf.
///
/// optional_name ::= ( ':' id )?
ParseResult FIRParser::parseOptionalName(StringAttr &name) {
if (getToken().isNot(FIRToken::colon)) {
name = StringAttr::get(getContext(), "");
return success();
}
consumeToken(FIRToken::colon);
StringRef nameRef;
if (parseId(nameRef, "expected result name"))
return failure();
name = StringAttr::get(getContext(), nameRef);
return success();
}
//===--------------------------------------------------------------------===//
// Annotation Handling
//===--------------------------------------------------------------------===//
/// Parse a non-standard inline Annotation JSON blob if present. This uses
/// the info-like encoding of %[<JSON Blob>].
ParseResult FIRParser::parseOptionalAnnotations(SMLoc &loc, StringRef &result) {
if (getToken().isNot(FIRToken::inlineannotation))
return success();
loc = getToken().getLoc();
result = getTokenSpelling().drop_front(2).drop_back(1);
consumeToken(FIRToken::inlineannotation);
return success();
}
//===--------------------------------------------------------------------===//
// Common Parser Rules
//===--------------------------------------------------------------------===//
/// intLit ::= UnsignedInt
/// ::= SignedInt
/// ::= HexLit
/// ::= OctalLit
/// ::= BinaryLit
/// HexLit ::= '"' 'h' ( '+' | '-' )? ( HexDigit )+ '"'
/// OctalLit ::= '"' 'o' ( '+' | '-' )? ( OctalDigit )+ '"'
/// BinaryLit ::= '"' 'b' ( '+' | '-' )? ( BinaryDigit )+ '"'
///
ParseResult FIRParser::parseIntLit(APInt &result, const Twine &message) {
auto spelling = getTokenSpelling();
bool isNegative = false;
switch (getToken().getKind()) {
case FIRToken::signed_integer:
isNegative = spelling[0] == '-';
assert(spelling[0] == '+' || spelling[0] == '-');
spelling = spelling.drop_front();
[[fallthrough]];
case FIRToken::integer:
if (spelling.getAsInteger(10, result))
return emitError(message), failure();
// Make sure that the returned APInt has a zero at the top so clients don't
// confuse it with a negative number.
if (result.isNegative())
result = result.zext(result.getBitWidth() + 1);
if (isNegative)
result = -result;
// If this was parsed as >32 bits, but can be represented in 32 bits,
// truncate off the extra width. This is important for extmodules which
// like parameters to be 32-bits, and insulates us from some arbitraryness
// in StringRef::getAsInteger.
if (result.getBitWidth() > 32 && result.getSignificantBits() <= 32)
result = result.trunc(32);
consumeToken();
return success();
case FIRToken::radix_specified_integer: {
if (requireFeature({2, 4, 0}, "radix-specified integer literals"))
return failure();
if (spelling[0] == '-') {
isNegative = true;
spelling = spelling.drop_front();
}
unsigned base = llvm::StringSwitch<unsigned>(spelling.take_front(2))
.Case("0b", 2)
.Case("0o", 8)
.Case("0d", 10)
.Case("0h", 16);
spelling = spelling.drop_front(2);
if (spelling.getAsInteger(base, result))
return emitError("invalid character in integer literal"), failure();
if (result.isNegative())
result = result.zext(result.getBitWidth() + 1);
if (isNegative)
result = -result;
consumeToken();
return success();
}
case FIRToken::string: {
if (FIRVersion(3, 0, 0) <= version)
return emitError(
"String-encoded integer literals are unsupported after FIRRTL 3.0.0");
// Drop the quotes.
assert(spelling.front() == '"' && spelling.back() == '"');
spelling = spelling.drop_back().drop_front();
// Decode the base.
unsigned base;
switch (spelling.empty() ? ' ' : spelling.front()) {
case 'h':
base = 16;
break;
case 'o':
base = 8;
break;
case 'b':
base = 2;
break;
default:
return emitError("expected base specifier (h/o/b) in integer literal"),
failure();
}
spelling = spelling.drop_front();
// Handle the optional sign.
bool isNegative = false;
if (!spelling.empty() && spelling.front() == '+')
spelling = spelling.drop_front();
else if (!spelling.empty() && spelling.front() == '-') {
isNegative = true;
spelling = spelling.drop_front();
}
// Parse the digits.
if (spelling.empty())
return emitError("expected digits in integer literal"), failure();
if (spelling.getAsInteger(base, result))
return emitError("invalid character in integer literal"), failure();
// We just parsed the positive version of this number. Make sure it has
// a zero at the top so clients don't confuse it with a negative number and
// so the negation (in the case of a negative sign) doesn't overflow.
if (result.isNegative())
result = result.zext(result.getBitWidth() + 1);
if (isNegative)
result = -result;
consumeToken(FIRToken::string);
return success();
}
default:
return emitError("expected integer literal"), failure();
}
}
ParseResult FIRParser::parseIntLit(int64_t &result, const Twine &message) {
APInt value;
auto loc = getToken().getLoc();
if (parseIntLit(value, message))
return failure();
result = (int64_t)value.getLimitedValue(INT64_MAX);
if (result != value)
return emitError(loc, "value is too big to handle"), failure();
return success();
}
ParseResult FIRParser::parseIntLit(int32_t &result, const Twine &message) {
APInt value;
auto loc = getToken().getLoc();
if (parseIntLit(value, message))
return failure();
result = (int32_t)value.getLimitedValue(INT32_MAX);
if (result != value)
return emitError(loc, "value is too big to handle"), failure();
return success();
}
/// versionLit ::= version
/// deconstruct a version literal into parts and returns those.
ParseResult FIRParser::parseVersionLit(const Twine &message) {
auto spelling = getTokenSpelling();
if (getToken().getKind() != FIRToken::version)
return emitError(message), failure();
// form a.b.c
auto [a, d] = spelling.split(".");
auto [b, c] = d.split(".");
APInt aInt, bInt, cInt;
if (a.getAsInteger(10, aInt) || b.getAsInteger(10, bInt) ||
c.getAsInteger(10, cInt))
return emitError("failed to parse version string"), failure();
version.major = aInt.getLimitedValue(UINT32_MAX);
version.minor = bInt.getLimitedValue(UINT32_MAX);
version.patch = cInt.getLimitedValue(UINT32_MAX);
if (version.major != aInt || version.minor != bInt || version.patch != cInt)
return emitError("integers out of range"), failure();
if (version < minimumFIRVersion)
return emitError() << "FIRRTL version must be >=" << minimumFIRVersion,
failure();
consumeToken(FIRToken::version);
return success();
}
// optional-width ::= ('<' intLit '>')?
//
// This returns with result equal to -1 if not present.
template <typename T>
ParseResult FIRParser::parseOptionalWidth(T &result) {
if (!consumeIf(FIRToken::less))
return result = -1, success();
// Parse a width specifier if present.
auto widthLoc = getToken().getLoc();
if (parseIntLit(result, "expected width") ||
parseToken(FIRToken::greater, "expected >"))
return failure();
if (result < 0)
return emitError(widthLoc, "invalid width specifier"), failure();
return success();
}
/// id ::= Id | keywordAsId
///
/// Parse the 'id' grammar, which is an identifier or an allowed keyword. On
/// success, this returns the identifier in the result attribute.
ParseResult FIRParser::parseId(StringRef &result, const Twine &message) {
switch (getToken().getKind()) {
// The most common case is an identifier.
case FIRToken::identifier:
case FIRToken::literal_identifier:
// Otherwise it may be a keyword that we're allowing in an id position.
#define TOK_KEYWORD(spelling) case FIRToken::kw_##spelling:
#include "FIRTokenKinds.def"
// Yep, this is a valid identifier or literal identifier. Turn it into an
// attribute. If it is a literal identifier, then drop the leading and
// trailing '`' (backticks).
if (getToken().getKind() == FIRToken::literal_identifier)
result = getTokenSpelling().drop_front().drop_back();
else
result = getTokenSpelling();
consumeToken();
return success();
default:
emitError(message);
return failure();
}
}
ParseResult FIRParser::parseId(StringAttr &result, const Twine &message) {
StringRef name;
if (parseId(name, message))
return failure();
result = StringAttr::get(getContext(), name);
return success();
}
/// fieldId ::= Id
/// ::= RelaxedId
/// ::= UnsignedInt
/// ::= keywordAsId
///
ParseResult FIRParser::parseFieldId(StringRef &result, const Twine &message) {
// Handle the UnsignedInt case.
result = getTokenSpelling();
if (consumeIf(FIRToken::integer))
return success();
// FIXME: Handle RelaxedId
// Otherwise, it must be Id or keywordAsId.
if (parseId(result, message))
return failure();
return success();
}
/// fieldId ::= Id
/// ::= Float
/// ::= version
/// ::= UnsignedInt
/// ::= keywordAsId
///
ParseResult FIRParser::parseFieldIdSeq(SmallVectorImpl<StringRef> &result,
const Twine &message) {
// Handle the UnsignedInt case.
StringRef tmp = getTokenSpelling();
if (consumeIf(FIRToken::integer)) {
result.push_back(tmp);
return success();
}
if (consumeIf(FIRToken::floatingpoint)) {
// form a.b
// Both a and b could have more floating point stuff, but just ignore that
// for now.
auto [a, b] = tmp.split(".");
result.push_back(a);
result.push_back(b);
return success();
}
if (consumeIf(FIRToken::version)) {
// form a.b.c
auto [a, d] = tmp.split(".");
auto [b, c] = d.split(".");
result.push_back(a);
result.push_back(b);
result.push_back(c);
return success();
}
// Otherwise, it must be Id or keywordAsId.
if (parseId(tmp, message))
return failure();
result.push_back(tmp);
return success();
}
/// enum-field ::= Id ( ':' type )? ;
/// enum-type ::= '{|' enum-field* '|}'
ParseResult FIRParser::parseEnumType(FIRRTLType &result) {
if (parseToken(FIRToken::l_brace_bar,
"expected leading '{|' in enumeration type"))
return failure();
SmallVector<FEnumType::EnumElement> elements;
if (parseListUntil(FIRToken::r_brace_bar, [&]() -> ParseResult {
auto fieldLoc = getToken().getLoc();
// Parse the name of the tag.
StringRef name;
if (parseId(name, "expected valid identifier for enumeration tag"))
return failure();
// Parse an optional type ascription.
FIRRTLBaseType type;
if (consumeIf(FIRToken::colon)) {
FIRRTLType parsedType;
if (parseType(parsedType, "expected enumeration type"))
return failure();
type = type_dyn_cast<FIRRTLBaseType>(parsedType);
if (!type)
return emitError(fieldLoc, "field must be a base type");
} else {
// If there is no type specified, default to UInt<0>.
type = UIntType::get(getContext(), 0);
}
elements.emplace_back(StringAttr::get(getContext(), name), type);
return success();
}))
return failure();
result = FEnumType::get(getContext(), elements);
return success();
}
ParseResult FIRParser::parsePropertyType(PropertyType &result,
const Twine &message) {
FIRRTLType type;
if (parseType(type, message))
return failure();
auto prop = type_dyn_cast<PropertyType>(type);
if (!prop)
return emitError("expected property type");
result = prop;
return success();
}
/// list-type ::= 'List' '<' type '>'
ParseResult FIRParser::parseListType(FIRRTLType &result) {
consumeToken(FIRToken::kw_List);
PropertyType elementType;
if (parseToken(FIRToken::less, "expected '<' in List type") ||
parsePropertyType(elementType, "expected List element type") ||
parseToken(FIRToken::greater, "expected '>' in List type"))
return failure();
result = ListType::get(getContext(), elementType);
return success();
}
/// type ::= 'Clock'
/// ::= 'Reset'
/// ::= 'AsyncReset'
/// ::= 'UInt' optional-width
/// ::= 'SInt' optional-width
/// ::= 'Analog' optional-width
/// ::= {' field* '}'
/// ::= type '[' intLit ']'
/// ::= 'Probe' '<' type '>'
/// ::= 'RWProbe' '<' type '>'
/// ::= 'const' type
/// ::= 'String'
/// ::= list-type
/// ::= id
///
/// field: 'flip'? fieldId ':' type
///
// NOLINTNEXTLINE(misc-no-recursion)
ParseResult FIRParser::parseType(FIRRTLType &result, const Twine &message) {
switch (getToken().getKind()) {
default:
return emitError(message), failure();
case FIRToken::kw_Clock:
consumeToken(FIRToken::kw_Clock);
result = ClockType::get(getContext());
break;
case FIRToken::kw_Inst: {
if (requireFeature(nextFIRVersion, "Inst types"))
return failure();
consumeToken(FIRToken::kw_Inst);
if (parseToken(FIRToken::less, "expected < in Inst type"))
return failure();
auto loc = getToken().getLoc();
StringRef id;
if (parseId(id, "expected class name in Inst type"))
return failure();
// Look up the class that is being referenced.
const auto &classMap = getConstants().classMap;
auto lookup = classMap.find(id);
if (lookup == classMap.end())
return emitError(loc) << "unknown class '" << id << "'";
auto classOp = lookup->second;
if (parseToken(FIRToken::greater, "expected > in Inst type"))
return failure();
result = classOp.getInstanceType();
break;
}
case FIRToken::kw_AnyRef: {
if (requireFeature(nextFIRVersion, "AnyRef types"))
return failure();
consumeToken(FIRToken::kw_AnyRef);
result = AnyRefType::get(getContext());
break;
}
case FIRToken::kw_Reset:
consumeToken(FIRToken::kw_Reset);
result = ResetType::get(getContext());
break;
case FIRToken::kw_AsyncReset:
consumeToken(FIRToken::kw_AsyncReset);
result = AsyncResetType::get(getContext());
break;
case FIRToken::kw_UInt:
case FIRToken::kw_SInt:
case FIRToken::kw_Analog: {
auto kind = getToken().getKind();
consumeToken();
// Parse a width specifier if present.
int32_t width;
if (parseOptionalWidth(width))
return failure();
if (kind == FIRToken::kw_SInt)
result = SIntType::get(getContext(), width);
else if (kind == FIRToken::kw_UInt)
result = UIntType::get(getContext(), width);
else {
assert(kind == FIRToken::kw_Analog);
result = AnalogType::get(getContext(), width);
}
break;
}
case FIRToken::kw_Probe:
case FIRToken::kw_RWProbe: {
auto kind = getToken().getKind();
auto loc = getToken().getLoc();
consumeToken();
// Inner Type
FIRRTLType type;
if (parseToken(FIRToken::less, "expected '<' in reference type") ||
parseType(type, "expected probe data type"))
return failure();
SmallVector<StringRef> layers;
if (consumeIf(FIRToken::comma)) {
if (requireFeature({3, 2, 0}, "colored probes"))
return failure();
// Probe Color
do {
StringRef layer;
loc = getToken().getLoc();
if (parseId(layer, "expected layer name"))
return failure();
layers.push_back(layer);
} while (consumeIf(FIRToken::period));
}
if (!consumeIf(FIRToken::greater))
return emitError(loc, "expected '>' to end reference type");
bool forceable = kind == FIRToken::kw_RWProbe;
auto innerType = type_dyn_cast<FIRRTLBaseType>(type);
if (!innerType)
return emitError(loc, "invalid probe inner type, must be base-type");
if (!innerType.isPassive())
return emitError(loc, "probe inner type must be passive");
if (forceable && innerType.containsConst())
return emitError(loc, "rwprobe cannot contain const");
SymbolRefAttr layer;
if (!layers.empty()) {
auto nestedLayers =