[FIRRTL] FIRParser: parse tagExtract operations

Author: youngar

lib/Dialect/FIRRTL/Import/FIRParser.cpp

@@ -1967,6 +1967,7 @@ struct FIRStmtParser : public FIRParser {
   ParseResult parseRefRelease();
   ParseResult parseRefReleaseInitial();
   ParseResult parseRefRead(Value &result);
+  ParseResult parseTagExtract(Value &result);
   ParseResult parseProbe(Value &result);
   ParseResult parsePropAssign();
   ParseResult parseRWProbe(Value &result);
@@ -2122,6 +2123,14 @@ ParseResult FIRStmtParser::parseExpImpl(Value &result, const Twine &message,
     if (parseRefRead(result))
       return failure();
     break;
+  case FIRToken::lp_tagExtract:
+    if (requireFeature(missingSpecFIRVersion, "Bools"))
+      return failure();
+    if (isLeadingStmt)
+      return emitError("unexpected tagExtract() as start of statement");
+    if (parseTagExtract(result))
+      return failure();
+    break;
   case FIRToken::lp_probe:
     if (isLeadingStmt)
       return emitError("unexpected probe() as start of statement");
@@ -3956,6 +3965,28 @@ ParseResult FIRStmtParser::parseRefRead(Value &result) {
   return success();
 }
 
+/// tagExtract ::= 'tagExtract' '(' exp ')'
+ParseResult FIRStmtParser::parseTagExtract(Value &result) {
+  auto startTok = consumeToken(FIRToken::lp_tagExtract);
+
+  Value input;
+  if (parseExp(input, "expected expression in 'tagExtract'") ||
+      parseToken(FIRToken::r_paren, "expected ')' in 'tagExtract'"))
+    return failure();
+
+  locationProcessor.setLoc(startTok.getLoc());
+
+  // Check argument is an enum-type value.
+  if (!type_isa<FEnumType>(input.getType()))
+    return emitError(startTok.getLoc(),
+                     "expected enum-type expression in 'tagExtract', got ")
+           << input.getType();
+
+  result = builder.create<TagExtractOp>(input);
+
+  return success();
+}
+
 /// probe ::= 'probe' '(' static_ref ')'
 ParseResult FIRStmtParser::parseProbe(Value &result) {
   auto startTok = consumeToken(FIRToken::lp_probe);

lib/Dialect/FIRRTL/Import/FIRTokenKinds.def

@@ -187,6 +187,7 @@ TOK_LPKEYWORD(release_initial)
 TOK_LPKEYWORD(read)
 TOK_LPKEYWORD(probe)
 TOK_LPKEYWORD(rwprobe)
+TOK_LPKEYWORD(tagExtract)
 
 TOK_LPKEYWORD(intrinsic)
 TOK_LPKEYWORD(cat)

test/Dialect/FIRRTL/parse-basic.fir

@@ -945,7 +945,7 @@ circuit MyModule :     ; CHECK: firrtl.circuit "MyModule"
       ; CHECK: }
       None:
         invalidate o
-
+ 
   ; CHECK-LABEL: firrtl.module private @EnumInfer(
   module EnumInfer:
     input i : {| A: UInt<8>, None |}
@@ -954,6 +954,14 @@ circuit MyModule :     ; CHECK: firrtl.circuit "MyModule"
     ; CHECK: connect %o, %i
     connect o, i
 
+  ; CHECK-LABEL: firrtl.module private @TagExtract
+  module TagExtract:
+    input i : {|A, B, C|}
+    output o : UInt<2>
+    ; CHECK: %0 = firrtl.tagextract %i : !firrtl.enum<A, B, C>
+    ; CHECK: firrtl.matchingconnect %o, %0 : !firrtl.uint<2>
+    connect o, tagExtract(i)
+
   ; CHECK-LABEL: module private @RefsChild(
   ; CHECK-SAME: out %r: !firrtl.probe<uint<1>>
   ; CHECK-SAME: out %rw: !firrtl.rwprobe<uint<1>>