10#include "slang/ast/EvalContext.h"
11#include "slang/ast/SystemSubroutine.h"
12#include "slang/syntax/AllSyntax.h"
13#include "llvm/ADT/ScopeExit.h"
16using namespace ImportVerilog;
21 if (svint.hasUnknown()) {
22 unsigned numWords = svint.getNumWords() / 2;
23 auto value = ArrayRef<uint64_t>(svint.getRawPtr(), numWords);
24 auto unknown = ArrayRef<uint64_t>(svint.getRawPtr() + numWords, numWords);
25 return FVInt(APInt(svint.getBitWidth(), value),
26 APInt(svint.getBitWidth(), unknown));
28 auto value = ArrayRef<uint64_t>(svint.getRawPtr(), svint.getNumWords());
29 return FVInt(APInt(svint.getBitWidth(), value));
36 const slang::ConstantRange &range) {
37 auto &builder =
context.builder;
38 auto indexType = cast<moore::UnpackedType>(index.getType());
41 auto lo = range.lower();
42 auto hi = range.upper();
43 auto offset = range.isLittleEndian() ? lo : hi;
46 const bool needSigned = (lo < 0) || (hi < 0);
49 const uint64_t maxAbs = std::max<uint64_t>(std::abs(lo), std::abs(hi));
54 unsigned want = needSigned
55 ? (llvm::Log2_64_Ceil(std::max<uint64_t>(1, maxAbs)) + 1)
56 : std::max<unsigned>(1, llvm::Log2_64_Ceil(maxAbs + 1));
59 const unsigned bw = std::max<unsigned>(want, indexType.getBitSize().value());
62 moore::IntType::get(index.getContext(), bw, indexType.getDomain());
63 index =
context.materializeConversion(intType, index, needSigned, loc);
66 if (range.isLittleEndian())
69 return moore::NegOp::create(builder, loc, index);
73 moore::ConstantOp::create(builder, loc, intType, offset, needSigned);
74 if (range.isLittleEndian())
75 return moore::SubOp::create(builder, loc, index, offsetConst);
77 return moore::SubOp::create(builder, loc, offsetConst, index);
82 static_assert(int(slang::TimeUnit::Seconds) == 0);
83 static_assert(int(slang::TimeUnit::Milliseconds) == 1);
84 static_assert(int(slang::TimeUnit::Microseconds) == 2);
85 static_assert(int(slang::TimeUnit::Nanoseconds) == 3);
86 static_assert(int(slang::TimeUnit::Picoseconds) == 4);
87 static_assert(int(slang::TimeUnit::Femtoseconds) == 5);
89 static_assert(int(slang::TimeScaleMagnitude::One) == 1);
90 static_assert(int(slang::TimeScaleMagnitude::Ten) == 10);
91 static_assert(int(slang::TimeScaleMagnitude::Hundred) == 100);
93 auto exp =
static_cast<unsigned>(
context.timeScale.base.unit);
96 auto scale =
static_cast<uint64_t
>(
context.timeScale.base.magnitude);
103 const slang::ast::ClassPropertySymbol &expr) {
104 auto loc =
context.convertLocation(expr.location);
105 auto builder =
context.builder;
107 auto type =
context.convertType(expr.getType());
109 mlir::Value instRef =
context.getImplicitThisRef();
111 mlir::emitError(loc) <<
"class property '" << expr.name
112 <<
"' referenced without an implicit 'this'";
116 auto fieldSym = mlir::FlatSymbolRefAttr::get(builder.getContext(), expr.name);
117 auto fieldTy = cast<moore::UnpackedType>(type);
118 auto fieldRefTy = moore::RefType::get(fieldTy);
120 moore::ClassHandleType classTy =
121 cast<moore::ClassHandleType>(instRef.getType());
123 auto targetClassHandle =
124 context.getAncestorClassWithProperty(classTy, expr.name, loc);
125 if (!targetClassHandle)
128 auto upcastRef =
context.materializeConversion(targetClassHandle, instRef,
129 false, instRef.getLoc());
133 Value fieldRef = moore::ClassPropertyRefOp::create(builder, loc, fieldRefTy,
134 upcastRef, fieldSym);
146 ExprVisitor(
Context &context, Location loc,
bool isLvalue)
147 : context(context), loc(loc), builder(context.builder),
148 isLvalue(isLvalue) {}
154 Value convertLvalueOrRvalueExpression(
const slang::ast::Expression &expr) {
161 Value visit(
const slang::ast::ElementSelectExpression &expr) {
163 auto value = convertLvalueOrRvalueExpression(expr.value());
168 auto derefType = value.getType();
170 derefType = cast<moore::RefType>(derefType).getNestedType();
171 if (!isa<moore::IntType, moore::ArrayType, moore::UnpackedArrayType>(
173 mlir::emitError(loc) <<
"unsupported expression: element select into "
174 << expr.value().type->toString() <<
"\n";
179 isLvalue ? moore::RefType::get(cast<moore::UnpackedType>(type)) : type;
180 auto range = expr.value().type->getFixedRange();
181 if (
auto *constValue = expr.selector().getConstant();
182 constValue && constValue->isInteger()) {
183 assert(!constValue->hasUnknown());
184 assert(constValue->size() <= 32);
186 auto lowBit = constValue->integer().as<uint32_t>().value();
188 return moore::ExtractRefOp::create(builder, loc, resultType, value,
189 range.translateIndex(lowBit));
191 return moore::ExtractOp::create(builder, loc, resultType, value,
192 range.translateIndex(lowBit));
200 return moore::DynExtractRefOp::create(builder, loc, resultType, value,
203 return moore::DynExtractOp::create(builder, loc, resultType, value,
208 Value visit(
const slang::ast::RangeSelectExpression &expr) {
210 auto value = convertLvalueOrRvalueExpression(expr.value());
214 std::optional<int32_t> constLeft;
215 std::optional<int32_t> constRight;
216 if (
auto *constant = expr.left().getConstant())
217 constLeft = constant->integer().as<int32_t>();
218 if (
auto *constant = expr.right().getConstant())
219 constRight = constant->integer().as<int32_t>();
225 <<
"unsupported expression: range select with non-constant bounds";
245 int32_t offsetConst = 0;
246 auto range = expr.value().type->getFixedRange();
248 using slang::ast::RangeSelectionKind;
249 if (expr.getSelectionKind() == RangeSelectionKind::Simple) {
254 assert(constRight &&
"constness checked in slang");
255 offsetConst = *constRight;
266 offsetConst = *constLeft;
277 int32_t offsetAdd = 0;
282 if (expr.getSelectionKind() == RangeSelectionKind::IndexedDown &&
283 range.isLittleEndian()) {
284 assert(constRight &&
"constness checked in slang");
285 offsetAdd = 1 - *constRight;
291 if (expr.getSelectionKind() == RangeSelectionKind::IndexedUp &&
292 !range.isLittleEndian()) {
293 assert(constRight &&
"constness checked in slang");
294 offsetAdd = *constRight - 1;
298 if (offsetAdd != 0) {
300 offsetDyn = moore::AddOp::create(
301 builder, loc, offsetDyn,
302 moore::ConstantOp::create(
303 builder, loc, cast<moore::IntType>(offsetDyn.getType()),
307 offsetConst += offsetAdd;
318 isLvalue ? moore::RefType::get(cast<moore::UnpackedType>(type)) : type;
323 return moore::DynExtractRefOp::create(builder, loc, resultType, value,
326 return moore::DynExtractOp::create(builder, loc, resultType, value,
330 offsetConst = range.translateIndex(offsetConst);
332 return moore::ExtractRefOp::create(builder, loc, resultType, value,
335 return moore::ExtractOp::create(builder, loc, resultType, value,
342 Value visit(
const slang::ast::ConcatenationExpression &expr) {
343 SmallVector<Value> operands;
344 for (
auto *operand : expr.operands()) {
348 if (operand->type->isVoid())
350 auto value = convertLvalueOrRvalueExpression(*operand);
357 operands.push_back(value);
360 return moore::ConcatRefOp::create(builder, loc, operands);
362 return moore::ConcatOp::create(builder, loc, operands);
366 Value visit(
const slang::ast::MemberAccessExpression &expr) {
371 auto *valueType = expr.value().type.get();
372 auto memberName = builder.getStringAttr(expr.member.name);
375 if (valueType->isStruct()) {
377 isLvalue ? moore::RefType::get(cast<moore::UnpackedType>(type))
379 auto value = convertLvalueOrRvalueExpression(expr.value());
384 return moore::StructExtractRefOp::create(builder, loc, resultType,
386 return moore::StructExtractOp::create(builder, loc, resultType,
391 if (valueType->isPackedUnion() || valueType->isUnpackedUnion()) {
393 isLvalue ? moore::RefType::get(cast<moore::UnpackedType>(type))
395 auto value = convertLvalueOrRvalueExpression(expr.value());
400 return moore::UnionExtractRefOp::create(builder, loc, resultType,
402 return moore::UnionExtractOp::create(builder, loc, type, memberName,
407 if (valueType->isClass()) {
411 auto targetTy = cast<moore::ClassHandleType>(valTy);
416 auto upcastTargetTy =
430 mlir::FlatSymbolRefAttr::get(builder.getContext(), expr.member.name);
431 auto fieldRefTy = moore::RefType::get(cast<moore::UnpackedType>(type));
434 Value fieldRef = moore::ClassPropertyRefOp::create(
435 builder, loc, fieldRefTy, baseVal, fieldSym);
438 return isLvalue ? fieldRef
439 : moore::ReadOp::create(builder, loc, fieldRef);
442 mlir::emitError(loc,
"expression of type ")
443 << valueType->toString() <<
" has no member fields";
455struct RvalueExprVisitor :
public ExprVisitor {
457 : ExprVisitor(
context, loc, false) {}
458 using ExprVisitor::visit;
461 Value visit(
const slang::ast::LValueReferenceExpression &expr) {
462 assert(!
context.lvalueStack.empty() &&
"parent assignments push lvalue");
463 auto lvalue =
context.lvalueStack.back();
464 return moore::ReadOp::create(builder, loc, lvalue);
468 Value visit(
const slang::ast::NamedValueExpression &expr) {
470 if (
auto value =
context.valueSymbols.lookup(&expr.symbol)) {
471 if (isa<moore::RefType>(value.getType())) {
472 auto readOp = moore::ReadOp::create(builder, loc, value);
473 if (
context.rvalueReadCallback)
474 context.rvalueReadCallback(readOp);
475 value = readOp.getResult();
481 if (
auto globalOp =
context.globalVariables.lookup(&expr.symbol)) {
482 auto value = moore::GetGlobalVariableOp::create(builder, loc, globalOp);
483 return moore::ReadOp::create(builder, loc, value);
487 if (
auto *
const property =
488 expr.symbol.as_if<slang::ast::ClassPropertySymbol>()) {
490 return moore::ReadOp::create(builder, loc, fieldRef).getResult();
494 auto constant =
context.evaluateConstant(expr);
495 if (
auto value =
context.materializeConstant(constant, *expr.type, loc))
500 auto d = mlir::emitError(loc,
"unknown name `") << expr.symbol.name <<
"`";
501 d.attachNote(
context.convertLocation(expr.symbol.location))
502 <<
"no rvalue generated for " << slang::ast::toString(expr.symbol.kind);
507 Value visit(
const slang::ast::HierarchicalValueExpression &expr) {
508 auto hierLoc =
context.convertLocation(expr.symbol.location);
509 if (
auto value =
context.valueSymbols.lookup(&expr.symbol)) {
510 if (isa<moore::RefType>(value.getType())) {
511 auto readOp = moore::ReadOp::create(builder, hierLoc, value);
512 if (
context.rvalueReadCallback)
513 context.rvalueReadCallback(readOp);
514 value = readOp.getResult();
521 auto d = mlir::emitError(loc,
"unknown hierarchical name `")
522 << expr.symbol.name <<
"`";
523 d.attachNote(hierLoc) <<
"no rvalue generated for "
524 << slang::ast::toString(expr.symbol.kind);
529 Value visit(
const slang::ast::ConversionExpression &expr) {
530 auto type =
context.convertType(*expr.type);
533 return context.convertRvalueExpression(expr.operand(), type);
537 Value visit(
const slang::ast::AssignmentExpression &expr) {
538 auto lhs =
context.convertLvalueExpression(expr.left());
543 context.lvalueStack.push_back(lhs);
544 auto rhs =
context.convertRvalueExpression(
545 expr.right(), cast<moore::RefType>(lhs.getType()).getNestedType());
546 context.lvalueStack.pop_back();
553 if (!expr.isNonBlocking()) {
554 if (expr.timingControl)
555 if (failed(
context.convertTimingControl(*expr.timingControl)))
557 auto assignOp = moore::BlockingAssignOp::create(builder, loc, lhs, rhs);
558 if (
context.variableAssignCallback)
559 context.variableAssignCallback(assignOp);
564 if (expr.timingControl) {
566 if (
auto *ctrl = expr.timingControl->as_if<slang::ast::DelayControl>()) {
567 auto delay =
context.convertRvalueExpression(
568 ctrl->expr, moore::TimeType::get(builder.getContext()));
571 auto assignOp = moore::DelayedNonBlockingAssignOp::create(
572 builder, loc, lhs, rhs, delay);
573 if (
context.variableAssignCallback)
574 context.variableAssignCallback(assignOp);
579 auto loc =
context.convertLocation(expr.timingControl->sourceRange);
581 <<
"unsupported non-blocking assignment timing control: "
582 << slang::ast::toString(expr.timingControl->kind);
585 auto assignOp = moore::NonBlockingAssignOp::create(builder, loc, lhs, rhs);
586 if (
context.variableAssignCallback)
587 context.variableAssignCallback(assignOp);
593 template <
class ConcreteOp>
594 Value createReduction(Value arg,
bool invert) {
595 arg =
context.convertToSimpleBitVector(arg);
598 Value result = ConcreteOp::create(builder, loc, arg);
600 result = moore::NotOp::create(builder, loc, result);
605 Value createIncrement(Value arg,
bool isInc,
bool isPost) {
606 auto preValue = moore::ReadOp::create(builder, loc, arg);
612 postValue = moore::NotOp::create(builder, loc, preValue).getResult();
615 auto one = moore::ConstantOp::create(
616 builder, loc, cast<moore::IntType>(preValue.getType()), 1);
618 isInc ? moore::AddOp::create(builder, loc, preValue, one).getResult()
619 : moore::SubOp::create(builder, loc, preValue, one).getResult();
621 moore::BlockingAssignOp::create(builder, loc, arg, postValue);
622 if (
context.variableAssignCallback)
623 context.variableAssignCallback(assignOp);
632 Value createRealIncrement(Value arg,
bool isInc,
bool isPost) {
633 auto preValue = moore::ReadOp::create(builder, loc, arg);
636 auto ty = preValue.getType();
637 moore::RealType realTy = llvm::dyn_cast<moore::RealType>(ty);
642 if (realTy.getWidth() == moore::RealWidth::f32) {
643 oneAttr = builder.getFloatAttr(builder.getF32Type(), 1.0);
644 }
else if (realTy.getWidth() == moore::RealWidth::f64) {
645 oneAttr = builder.getFloatAttr(builder.getF64Type(), 1.0);
647 mlir::emitError(loc) <<
"cannot construct increment for " << realTy;
650 auto one = moore::ConstantRealOp::create(builder, loc, oneAttr);
654 ? moore::AddRealOp::create(builder, loc, preValue, one).getResult()
655 : moore::SubRealOp::create(builder, loc, preValue, one).getResult();
657 moore::BlockingAssignOp::create(builder, loc, arg, postValue);
659 if (
context.variableAssignCallback)
660 context.variableAssignCallback(assignOp);
667 Value visitRealUOp(
const slang::ast::UnaryExpression &expr) {
668 Type opFTy =
context.convertType(*expr.operand().type);
670 using slang::ast::UnaryOperator;
672 if (expr.op == UnaryOperator::Preincrement ||
673 expr.op == UnaryOperator::Predecrement ||
674 expr.op == UnaryOperator::Postincrement ||
675 expr.op == UnaryOperator::Postdecrement)
676 arg =
context.convertLvalueExpression(expr.operand());
678 arg =
context.convertRvalueExpression(expr.operand(), opFTy);
684 case UnaryOperator::Plus:
686 case UnaryOperator::Minus:
687 return moore::NegRealOp::create(builder, loc, arg);
689 case UnaryOperator::Preincrement:
690 return createRealIncrement(arg,
true,
false);
691 case UnaryOperator::Predecrement:
692 return createRealIncrement(arg,
false,
false);
693 case UnaryOperator::Postincrement:
694 return createRealIncrement(arg,
true,
true);
695 case UnaryOperator::Postdecrement:
696 return createRealIncrement(arg,
false,
true);
698 case UnaryOperator::LogicalNot:
699 arg =
context.convertToBool(arg);
702 return moore::NotOp::create(builder, loc, arg);
705 mlir::emitError(loc) <<
"Unary operator " << slang::ast::toString(expr.op)
706 <<
" not supported with real values!\n";
712 Value visit(
const slang::ast::UnaryExpression &expr) {
714 const auto *floatType =
715 expr.operand().type->as_if<slang::ast::FloatingType>();
718 return visitRealUOp(expr);
720 using slang::ast::UnaryOperator;
722 if (expr.op == UnaryOperator::Preincrement ||
723 expr.op == UnaryOperator::Predecrement ||
724 expr.op == UnaryOperator::Postincrement ||
725 expr.op == UnaryOperator::Postdecrement)
726 arg =
context.convertLvalueExpression(expr.operand());
728 arg =
context.convertRvalueExpression(expr.operand());
735 case UnaryOperator::Plus:
736 return context.convertToSimpleBitVector(arg);
738 case UnaryOperator::Minus:
739 arg =
context.convertToSimpleBitVector(arg);
742 return moore::NegOp::create(builder, loc, arg);
744 case UnaryOperator::BitwiseNot:
745 arg =
context.convertToSimpleBitVector(arg);
748 return moore::NotOp::create(builder, loc, arg);
750 case UnaryOperator::BitwiseAnd:
751 return createReduction<moore::ReduceAndOp>(arg,
false);
752 case UnaryOperator::BitwiseOr:
753 return createReduction<moore::ReduceOrOp>(arg,
false);
754 case UnaryOperator::BitwiseXor:
755 return createReduction<moore::ReduceXorOp>(arg,
false);
756 case UnaryOperator::BitwiseNand:
757 return createReduction<moore::ReduceAndOp>(arg,
true);
758 case UnaryOperator::BitwiseNor:
759 return createReduction<moore::ReduceOrOp>(arg,
true);
760 case UnaryOperator::BitwiseXnor:
761 return createReduction<moore::ReduceXorOp>(arg,
true);
763 case UnaryOperator::LogicalNot:
764 arg =
context.convertToBool(arg);
767 return moore::NotOp::create(builder, loc, arg);
769 case UnaryOperator::Preincrement:
770 return createIncrement(arg,
true,
false);
771 case UnaryOperator::Predecrement:
772 return createIncrement(arg,
false,
false);
773 case UnaryOperator::Postincrement:
774 return createIncrement(arg,
true,
true);
775 case UnaryOperator::Postdecrement:
776 return createIncrement(arg,
false,
true);
779 mlir::emitError(loc,
"unsupported unary operator");
784 Value buildLogicalBOp(slang::ast::BinaryOperator op, Value lhs, Value rhs,
785 std::optional<Domain> domain = std::nullopt) {
786 using slang::ast::BinaryOperator;
790 lhs =
context.convertToBool(lhs, domain.value());
791 rhs =
context.convertToBool(rhs, domain.value());
793 lhs =
context.convertToBool(lhs);
794 rhs =
context.convertToBool(rhs);
801 case BinaryOperator::LogicalAnd:
802 return moore::AndOp::create(builder, loc, lhs, rhs);
804 case BinaryOperator::LogicalOr:
805 return moore::OrOp::create(builder, loc, lhs, rhs);
807 case BinaryOperator::LogicalImplication: {
809 auto notLHS = moore::NotOp::create(builder, loc, lhs);
810 return moore::OrOp::create(builder, loc, notLHS, rhs);
813 case BinaryOperator::LogicalEquivalence: {
815 auto notLHS = moore::NotOp::create(builder, loc, lhs);
816 auto notRHS = moore::NotOp::create(builder, loc, rhs);
817 auto both = moore::AndOp::create(builder, loc, lhs, rhs);
818 auto notBoth = moore::AndOp::create(builder, loc, notLHS, notRHS);
819 return moore::OrOp::create(builder, loc, both, notBoth);
823 llvm_unreachable(
"not a logical BinaryOperator");
827 Value visitRealBOp(
const slang::ast::BinaryExpression &expr) {
829 auto lhs =
context.convertRvalueExpression(expr.left());
832 auto rhs =
context.convertRvalueExpression(expr.right());
836 using slang::ast::BinaryOperator;
838 case BinaryOperator::Add:
839 return moore::AddRealOp::create(builder, loc, lhs, rhs);
840 case BinaryOperator::Subtract:
841 return moore::SubRealOp::create(builder, loc, lhs, rhs);
842 case BinaryOperator::Multiply:
843 return moore::MulRealOp::create(builder, loc, lhs, rhs);
844 case BinaryOperator::Divide:
845 return moore::DivRealOp::create(builder, loc, lhs, rhs);
846 case BinaryOperator::Power:
847 return moore::PowRealOp::create(builder, loc, lhs, rhs);
849 case BinaryOperator::Equality:
850 return moore::EqRealOp::create(builder, loc, lhs, rhs);
851 case BinaryOperator::Inequality:
852 return moore::NeRealOp::create(builder, loc, lhs, rhs);
854 case BinaryOperator::GreaterThan:
855 return moore::FgtOp::create(builder, loc, lhs, rhs);
856 case BinaryOperator::LessThan:
857 return moore::FltOp::create(builder, loc, lhs, rhs);
858 case BinaryOperator::GreaterThanEqual:
859 return moore::FgeOp::create(builder, loc, lhs, rhs);
860 case BinaryOperator::LessThanEqual:
861 return moore::FleOp::create(builder, loc, lhs, rhs);
863 case BinaryOperator::LogicalAnd:
864 case BinaryOperator::LogicalOr:
865 case BinaryOperator::LogicalImplication:
866 case BinaryOperator::LogicalEquivalence:
867 return buildLogicalBOp(expr.op, lhs, rhs);
870 mlir::emitError(loc) <<
"Binary operator "
871 << slang::ast::toString(expr.op)
872 <<
" not supported with real valued operands!\n";
879 template <
class ConcreteOp>
880 Value createBinary(Value lhs, Value rhs) {
881 lhs =
context.convertToSimpleBitVector(lhs);
884 rhs =
context.convertToSimpleBitVector(rhs);
887 return ConcreteOp::create(builder, loc, lhs, rhs);
891 Value visit(
const slang::ast::BinaryExpression &expr) {
893 const auto *rhsFloatType =
894 expr.right().type->as_if<slang::ast::FloatingType>();
895 const auto *lhsFloatType =
896 expr.left().type->as_if<slang::ast::FloatingType>();
899 if (rhsFloatType || lhsFloatType)
900 return visitRealBOp(expr);
902 auto lhs =
context.convertRvalueExpression(expr.left());
905 auto rhs =
context.convertRvalueExpression(expr.right());
910 Domain domain = Domain::TwoValued;
911 if (expr.type->isFourState() || expr.left().type->isFourState() ||
912 expr.right().type->isFourState())
913 domain = Domain::FourValued;
915 using slang::ast::BinaryOperator;
917 case BinaryOperator::Add:
918 return createBinary<moore::AddOp>(lhs, rhs);
919 case BinaryOperator::Subtract:
920 return createBinary<moore::SubOp>(lhs, rhs);
921 case BinaryOperator::Multiply:
922 return createBinary<moore::MulOp>(lhs, rhs);
923 case BinaryOperator::Divide:
924 if (expr.type->isSigned())
925 return createBinary<moore::DivSOp>(lhs, rhs);
927 return createBinary<moore::DivUOp>(lhs, rhs);
928 case BinaryOperator::Mod:
929 if (expr.type->isSigned())
930 return createBinary<moore::ModSOp>(lhs, rhs);
932 return createBinary<moore::ModUOp>(lhs, rhs);
933 case BinaryOperator::Power: {
938 auto rhsCast =
context.materializeConversion(
939 lhs.getType(), rhs, expr.right().type->isSigned(), rhs.getLoc());
940 if (expr.type->isSigned())
941 return createBinary<moore::PowSOp>(lhs, rhsCast);
943 return createBinary<moore::PowUOp>(lhs, rhsCast);
946 case BinaryOperator::BinaryAnd:
947 return createBinary<moore::AndOp>(lhs, rhs);
948 case BinaryOperator::BinaryOr:
949 return createBinary<moore::OrOp>(lhs, rhs);
950 case BinaryOperator::BinaryXor:
951 return createBinary<moore::XorOp>(lhs, rhs);
952 case BinaryOperator::BinaryXnor: {
953 auto result = createBinary<moore::XorOp>(lhs, rhs);
956 return moore::NotOp::create(builder, loc, result);
959 case BinaryOperator::Equality:
960 if (isa<moore::UnpackedArrayType>(lhs.getType()))
961 return moore::UArrayCmpOp::create(
962 builder, loc, moore::UArrayCmpPredicate::eq, lhs, rhs);
963 else if (isa<moore::StringType>(lhs.getType()))
964 return moore::StringCmpOp::create(
965 builder, loc, moore::StringCmpPredicate::eq, lhs, rhs);
967 return createBinary<moore::EqOp>(lhs, rhs);
968 case BinaryOperator::Inequality:
969 if (isa<moore::UnpackedArrayType>(lhs.getType()))
970 return moore::UArrayCmpOp::create(
971 builder, loc, moore::UArrayCmpPredicate::ne, lhs, rhs);
972 else if (isa<moore::StringType>(lhs.getType()))
973 return moore::StringCmpOp::create(
974 builder, loc, moore::StringCmpPredicate::ne, lhs, rhs);
976 return createBinary<moore::NeOp>(lhs, rhs);
977 case BinaryOperator::CaseEquality:
978 return createBinary<moore::CaseEqOp>(lhs, rhs);
979 case BinaryOperator::CaseInequality:
980 return createBinary<moore::CaseNeOp>(lhs, rhs);
981 case BinaryOperator::WildcardEquality:
982 return createBinary<moore::WildcardEqOp>(lhs, rhs);
983 case BinaryOperator::WildcardInequality:
984 return createBinary<moore::WildcardNeOp>(lhs, rhs);
986 case BinaryOperator::GreaterThanEqual:
987 if (expr.left().type->isSigned())
988 return createBinary<moore::SgeOp>(lhs, rhs);
989 else if (isa<moore::StringType>(lhs.getType()))
990 return moore::StringCmpOp::create(
991 builder, loc, moore::StringCmpPredicate::ge, lhs, rhs);
993 return createBinary<moore::UgeOp>(lhs, rhs);
994 case BinaryOperator::GreaterThan:
995 if (expr.left().type->isSigned())
996 return createBinary<moore::SgtOp>(lhs, rhs);
997 else if (isa<moore::StringType>(lhs.getType()))
998 return moore::StringCmpOp::create(
999 builder, loc, moore::StringCmpPredicate::gt, lhs, rhs);
1001 return createBinary<moore::UgtOp>(lhs, rhs);
1002 case BinaryOperator::LessThanEqual:
1003 if (expr.left().type->isSigned())
1004 return createBinary<moore::SleOp>(lhs, rhs);
1005 else if (isa<moore::StringType>(lhs.getType()))
1006 return moore::StringCmpOp::create(
1007 builder, loc, moore::StringCmpPredicate::le, lhs, rhs);
1009 return createBinary<moore::UleOp>(lhs, rhs);
1010 case BinaryOperator::LessThan:
1011 if (expr.left().type->isSigned())
1012 return createBinary<moore::SltOp>(lhs, rhs);
1013 else if (isa<moore::StringType>(lhs.getType()))
1014 return moore::StringCmpOp::create(
1015 builder, loc, moore::StringCmpPredicate::lt, lhs, rhs);
1017 return createBinary<moore::UltOp>(lhs, rhs);
1019 case BinaryOperator::LogicalAnd:
1020 case BinaryOperator::LogicalOr:
1021 case BinaryOperator::LogicalImplication:
1022 case BinaryOperator::LogicalEquivalence:
1023 return buildLogicalBOp(expr.op, lhs, rhs, domain);
1025 case BinaryOperator::LogicalShiftLeft:
1026 return createBinary<moore::ShlOp>(lhs, rhs);
1027 case BinaryOperator::LogicalShiftRight:
1028 return createBinary<moore::ShrOp>(lhs, rhs);
1029 case BinaryOperator::ArithmeticShiftLeft:
1030 return createBinary<moore::ShlOp>(lhs, rhs);
1031 case BinaryOperator::ArithmeticShiftRight: {
1034 lhs =
context.convertToSimpleBitVector(lhs);
1035 rhs =
context.convertToSimpleBitVector(rhs);
1038 if (expr.type->isSigned())
1039 return moore::AShrOp::create(builder, loc, lhs, rhs);
1040 return moore::ShrOp::create(builder, loc, lhs, rhs);
1044 mlir::emitError(loc,
"unsupported binary operator");
1049 Value visit(
const slang::ast::UnbasedUnsizedIntegerLiteral &expr) {
1050 return context.materializeSVInt(expr.getValue(), *expr.type, loc);
1054 Value visit(
const slang::ast::IntegerLiteral &expr) {
1055 return context.materializeSVInt(expr.getValue(), *expr.type, loc);
1059 Value visit(
const slang::ast::TimeLiteral &expr) {
1064 double value = std::round(expr.getValue() * scale);
1074 static constexpr uint64_t limit =
1075 (std::numeric_limits<uint64_t>::max() >> 11) << 11;
1076 if (value > limit) {
1077 mlir::emitError(loc) <<
"time value is larger than " << limit <<
" fs";
1081 return moore::ConstantTimeOp::create(builder, loc,
1082 static_cast<uint64_t
>(value));
1086 Value visit(
const slang::ast::ReplicationExpression &expr) {
1087 auto type =
context.convertType(*expr.type);
1088 auto value =
context.convertRvalueExpression(expr.concat());
1091 return moore::ReplicateOp::create(builder, loc, type, value);
1095 Value visit(
const slang::ast::InsideExpression &expr) {
1096 auto lhs =
context.convertToSimpleBitVector(
1097 context.convertRvalueExpression(expr.left()));
1101 SmallVector<Value> conditions;
1104 for (
const auto *listExpr : expr.rangeList()) {
1108 if (
const auto *openRange =
1109 listExpr->as_if<slang::ast::ValueRangeExpression>()) {
1111 auto lowBound =
context.convertToSimpleBitVector(
1112 context.convertRvalueExpression(openRange->left()));
1113 auto highBound =
context.convertToSimpleBitVector(
1114 context.convertRvalueExpression(openRange->right()));
1115 if (!lowBound || !highBound)
1117 Value leftValue, rightValue;
1120 if (openRange->left().type->isSigned() ||
1121 expr.left().type->isSigned()) {
1122 leftValue = moore::SgeOp::create(builder, loc, lhs, lowBound);
1124 leftValue = moore::UgeOp::create(builder, loc, lhs, lowBound);
1126 if (openRange->right().type->isSigned() ||
1127 expr.left().type->isSigned()) {
1128 rightValue = moore::SleOp::create(builder, loc, lhs, highBound);
1130 rightValue = moore::UleOp::create(builder, loc, lhs, highBound);
1132 cond = moore::AndOp::create(builder, loc, leftValue, rightValue);
1135 if (!listExpr->type->isIntegral()) {
1136 if (listExpr->type->isUnpackedArray()) {
1138 loc,
"unpacked arrays in 'inside' expressions not supported");
1142 loc,
"only simple bit vectors supported in 'inside' expressions");
1146 auto value =
context.convertToSimpleBitVector(
1147 context.convertRvalueExpression(*listExpr));
1150 cond = moore::WildcardEqOp::create(builder, loc, lhs, value);
1152 conditions.push_back(cond);
1156 auto result = conditions.back();
1157 conditions.pop_back();
1158 while (!conditions.empty()) {
1159 result = moore::OrOp::create(builder, loc, conditions.back(), result);
1160 conditions.pop_back();
1166 Value visit(
const slang::ast::ConditionalExpression &expr) {
1167 auto type =
context.convertType(*expr.type);
1170 if (expr.conditions.size() > 1) {
1171 mlir::emitError(loc)
1172 <<
"unsupported conditional expression with more than one condition";
1175 const auto &cond = expr.conditions[0];
1177 mlir::emitError(loc) <<
"unsupported conditional expression with pattern";
1181 context.convertToBool(
context.convertRvalueExpression(*cond.expr));
1184 auto conditionalOp =
1185 moore::ConditionalOp::create(builder, loc, type, value);
1188 auto &trueBlock = conditionalOp.getTrueRegion().emplaceBlock();
1189 auto &falseBlock = conditionalOp.getFalseRegion().emplaceBlock();
1191 OpBuilder::InsertionGuard g(builder);
1194 builder.setInsertionPointToStart(&trueBlock);
1195 auto trueValue =
context.convertRvalueExpression(expr.left(), type);
1198 moore::YieldOp::create(builder, loc, trueValue);
1201 builder.setInsertionPointToStart(&falseBlock);
1202 auto falseValue =
context.convertRvalueExpression(expr.right(), type);
1205 moore::YieldOp::create(builder, loc, falseValue);
1207 return conditionalOp.getResult();
1211 Value visit(
const slang::ast::CallExpression &expr) {
1213 auto constant =
context.evaluateConstant(expr);
1214 if (
auto value =
context.materializeConstant(constant, *expr.type, loc))
1218 [&](
auto &subroutine) {
return visitCall(expr, subroutine); },
1224 std::pair<Value, moore::ClassHandleType>
1225 getMethodReceiverTypeHandle(
const slang::ast::CallExpression &expr) {
1227 moore::ClassHandleType handleTy;
1231 if (
const slang::ast::Expression *recvExpr = expr.thisClass()) {
1232 thisRef =
context.convertRvalueExpression(*recvExpr);
1237 thisRef =
context.getImplicitThisRef();
1239 mlir::emitError(loc) <<
"method '" << expr.getSubroutineName()
1240 <<
"' called without an object";
1244 handleTy = cast<moore::ClassHandleType>(thisRef.getType());
1245 return {thisRef, handleTy};
1249 mlir::CallOpInterface
1250 buildMethodCall(
const slang::ast::SubroutineSymbol *subroutine,
1252 moore::ClassHandleType actualHandleTy, Value actualThisRef,
1253 SmallVector<Value> &arguments,
1254 SmallVector<Type> &resultTypes) {
1257 auto funcTy = lowering->
op.getFunctionType();
1258 auto expected0 = funcTy.getInput(0);
1259 auto expectedHdlTy = cast<moore::ClassHandleType>(expected0);
1262 auto implicitThisRef =
context.materializeConversion(
1263 expectedHdlTy, actualThisRef,
false, actualThisRef.getLoc());
1266 SmallVector<Value> explicitArguments;
1267 explicitArguments.reserve(arguments.size() + 1);
1268 explicitArguments.push_back(implicitThisRef);
1269 explicitArguments.append(arguments.begin(), arguments.end());
1272 const bool isVirtual =
1273 (subroutine->flags & slang::ast::MethodFlags::Virtual) != 0;
1276 auto calleeSym = lowering->
op.getSymName();
1278 return mlir::func::CallOp::create(builder, loc, resultTypes, calleeSym,
1282 auto funcName = subroutine->name;
1283 auto method = moore::VTableLoadMethodOp::create(
1284 builder, loc, funcTy, actualThisRef,
1285 SymbolRefAttr::get(
context.getContext(), funcName));
1286 return mlir::func::CallIndirectOp::create(builder, loc, method,
1291 Value visitCall(
const slang::ast::CallExpression &expr,
1292 const slang::ast::SubroutineSymbol *subroutine) {
1294 const bool isMethod = (subroutine->thisVar !=
nullptr);
1296 auto *lowering =
context.declareFunction(*subroutine);
1299 auto convertedFunction =
context.convertFunction(*subroutine);
1300 if (failed(convertedFunction))
1306 SmallVector<Value> arguments;
1307 for (
auto [callArg, declArg] :
1308 llvm::zip(expr.arguments(), subroutine->getArguments())) {
1312 auto *expr = callArg;
1313 if (
const auto *assign = expr->as_if<slang::ast::AssignmentExpression>())
1314 expr = &assign->left();
1317 if (declArg->direction == slang::ast::ArgumentDirection::In)
1318 value =
context.convertRvalueExpression(*expr);
1320 value =
context.convertLvalueExpression(*expr);
1323 arguments.push_back(value);
1327 auto materializeCaptureAtCall = [&](Value cap) -> Value {
1329 auto refTy = dyn_cast<moore::RefType>(cap.getType());
1331 lowering->
op.emitError(
1332 "expected captured value to be moore::RefType");
1339 Region *capRegion = [&]() -> Region * {
1340 if (
auto ba = dyn_cast<BlockArgument>(cap))
1341 return ba.getOwner()->getParent();
1342 if (
auto *def = cap.getDefiningOp())
1343 return def->getParentRegion();
1347 Region *callRegion =
1348 builder.getBlock() ? builder.getBlock()->getParent() :
nullptr;
1350 for (Region *r = callRegion; r; r = r->getParentRegion()) {
1351 if (r == capRegion) {
1358 lowering->
op.emitError()
1359 <<
"cannot materialize captured ref at call site; non-symbol "
1361 << (cap.getDefiningOp()
1362 ? cap.getDefiningOp()->getName().getStringRef()
1367 for (Value cap : lowering->captures) {
1368 Value mat = materializeCaptureAtCall(cap);
1371 arguments.push_back(mat);
1376 SmallVector<Type> resultTypes(
1377 lowering->
op.getFunctionType().getResults().begin(),
1378 lowering->
op.getFunctionType().getResults().end());
1380 mlir::CallOpInterface callOp;
1384 auto [thisRef, tyHandle] = getMethodReceiverTypeHandle(expr);
1385 callOp = buildMethodCall(subroutine, lowering, tyHandle, thisRef,
1386 arguments, resultTypes);
1390 mlir::func::CallOp::create(builder, loc, lowering->
op, arguments);
1393 auto result = resultTypes.size() > 0 ? callOp->getOpResult(0) : Value{};
1397 if (resultTypes.size() == 0)
1398 return mlir::UnrealizedConversionCastOp::create(
1399 builder, loc, moore::VoidType::get(
context.getContext()),
1407 Value visitCall(
const slang::ast::CallExpression &expr,
1408 const slang::ast::CallExpression::SystemCallInfo &info) {
1409 const auto &subroutine = *
info.subroutine;
1414 bool isAssertionCall =
1415 llvm::StringSwitch<bool>(subroutine.name)
1416 .Cases({
"$rose",
"$fell",
"$stable",
"$past"},
true)
1419 if (isAssertionCall)
1420 return context.convertAssertionCallExpression(expr, info, loc);
1422 auto args = expr.arguments();
1424 FailureOr<Value> result;
1434 if (!subroutine.name.compare(
"$sformatf")) {
1436 auto fmtValue =
context.convertFormatString(
1437 expr.arguments(), loc, moore::IntFormat::Decimal,
false);
1438 if (failed(fmtValue))
1440 return fmtValue.value();
1449 switch (args.size()) {
1451 result =
context.convertSystemCallArity0(subroutine, loc);
1455 value =
context.convertRvalueExpression(*args[0]);
1458 result =
context.convertSystemCallArity1(subroutine, loc, value);
1462 value =
context.convertRvalueExpression(*args[0]);
1463 value2 =
context.convertRvalueExpression(*args[1]);
1464 if (!value || !value2)
1466 result =
context.convertSystemCallArity2(subroutine, loc, value, value2);
1485 mlir::emitError(loc) <<
"unsupported system call `" << subroutine.name
1491 Value visit(
const slang::ast::StringLiteral &expr) {
1492 auto type =
context.convertType(*expr.type);
1493 return moore::ConstantStringOp::create(builder, loc, type, expr.getValue());
1497 Value visit(
const slang::ast::RealLiteral &expr) {
1498 auto fTy = mlir::Float64Type::get(
context.getContext());
1499 auto attr = mlir::FloatAttr::get(fTy, expr.getValue());
1500 return moore::ConstantRealOp::create(builder, loc, attr).getResult();
1505 FailureOr<SmallVector<Value>>
1506 convertElements(
const slang::ast::AssignmentPatternExpressionBase &expr,
1507 std::variant<Type, ArrayRef<Type>> expectedTypes,
1508 unsigned replCount) {
1509 const auto &elts = expr.elements();
1510 const size_t elementCount = elts.size();
1513 const bool hasBroadcast =
1514 std::holds_alternative<Type>(expectedTypes) &&
1515 static_cast<bool>(std::get<Type>(expectedTypes));
1517 const bool hasPerElem =
1518 std::holds_alternative<ArrayRef<Type>>(expectedTypes) &&
1519 !std::get<ArrayRef<Type>>(expectedTypes).empty();
1523 auto types = std::get<ArrayRef<Type>>(expectedTypes);
1524 if (types.size() != elementCount) {
1525 mlir::emitError(loc)
1526 <<
"assignment pattern arity mismatch: expected " << types.size()
1527 <<
" elements, got " << elementCount;
1532 SmallVector<Value> converted;
1533 converted.reserve(elementCount * std::max(1u, replCount));
1536 if (!hasBroadcast && !hasPerElem) {
1538 for (
const auto *elementExpr : elts) {
1539 Value v =
context.convertRvalueExpression(*elementExpr);
1542 converted.push_back(v);
1544 }
else if (hasBroadcast) {
1546 Type want = std::get<Type>(expectedTypes);
1547 for (
const auto *elementExpr : elts) {
1548 Value v = want ?
context.convertRvalueExpression(*elementExpr, want)
1549 :
context.convertRvalueExpression(*elementExpr);
1552 converted.push_back(v);
1555 auto types = std::get<ArrayRef<Type>>(expectedTypes);
1556 for (
size_t i = 0; i < elementCount; ++i) {
1557 Type want = types[i];
1558 const auto *elementExpr = elts[i];
1559 Value v = want ?
context.convertRvalueExpression(*elementExpr, want)
1560 :
context.convertRvalueExpression(*elementExpr);
1563 converted.push_back(v);
1567 for (
unsigned i = 1; i < replCount; ++i)
1568 converted.append(converted.begin(), converted.begin() + elementCount);
1574 Value visitAssignmentPattern(
1575 const slang::ast::AssignmentPatternExpressionBase &expr,
1576 unsigned replCount = 1) {
1577 auto type =
context.convertType(*expr.type);
1578 const auto &elts = expr.elements();
1581 if (
auto intType = dyn_cast<moore::IntType>(type)) {
1582 auto elements = convertElements(expr, {}, replCount);
1584 if (failed(elements))
1587 assert(intType.getWidth() == elements->size());
1588 std::reverse(elements->begin(), elements->end());
1589 return moore::ConcatOp::create(builder, loc, intType, *elements);
1593 if (
auto structType = dyn_cast<moore::StructType>(type)) {
1594 SmallVector<Type> expectedTy;
1595 expectedTy.reserve(structType.getMembers().size());
1596 for (
auto member : structType.getMembers())
1597 expectedTy.push_back(member.type);
1599 FailureOr<SmallVector<Value>> elements;
1600 if (expectedTy.size() == elts.size())
1601 elements = convertElements(expr, expectedTy, replCount);
1603 elements = convertElements(expr, {}, replCount);
1605 if (failed(elements))
1608 assert(structType.getMembers().size() == elements->size());
1609 return moore::StructCreateOp::create(builder, loc, structType, *elements);
1613 if (
auto structType = dyn_cast<moore::UnpackedStructType>(type)) {
1614 SmallVector<Type> expectedTy;
1615 expectedTy.reserve(structType.getMembers().size());
1616 for (
auto member : structType.getMembers())
1617 expectedTy.push_back(member.type);
1619 FailureOr<SmallVector<Value>> elements;
1620 if (expectedTy.size() == elts.size())
1621 elements = convertElements(expr, expectedTy, replCount);
1623 elements = convertElements(expr, {}, replCount);
1625 if (failed(elements))
1628 assert(structType.getMembers().size() == elements->size());
1630 return moore::StructCreateOp::create(builder, loc, structType, *elements);
1634 if (
auto arrayType = dyn_cast<moore::ArrayType>(type)) {
1636 convertElements(expr, arrayType.getElementType(), replCount);
1638 if (failed(elements))
1641 assert(arrayType.getSize() == elements->size());
1642 return moore::ArrayCreateOp::create(builder, loc, arrayType, *elements);
1646 if (
auto arrayType = dyn_cast<moore::UnpackedArrayType>(type)) {
1648 convertElements(expr, arrayType.getElementType(), replCount);
1650 if (failed(elements))
1653 assert(arrayType.getSize() == elements->size());
1654 return moore::ArrayCreateOp::create(builder, loc, arrayType, *elements);
1657 mlir::emitError(loc) <<
"unsupported assignment pattern with type " << type;
1661 Value visit(
const slang::ast::SimpleAssignmentPatternExpression &expr) {
1662 return visitAssignmentPattern(expr);
1665 Value visit(
const slang::ast::StructuredAssignmentPatternExpression &expr) {
1666 return visitAssignmentPattern(expr);
1669 Value visit(
const slang::ast::ReplicatedAssignmentPatternExpression &expr) {
1671 context.evaluateConstant(expr.count()).integer().as<
unsigned>();
1672 assert(count &&
"Slang guarantees constant non-zero replication count");
1673 return visitAssignmentPattern(expr, *count);
1676 Value visit(
const slang::ast::StreamingConcatenationExpression &expr) {
1677 SmallVector<Value> operands;
1678 for (
auto stream : expr.streams()) {
1679 auto operandLoc =
context.convertLocation(stream.operand->sourceRange);
1680 if (!stream.constantWithWidth.has_value() && stream.withExpr) {
1681 mlir::emitError(operandLoc)
1682 <<
"Moore only support streaming "
1683 "concatenation with fixed size 'with expression'";
1687 if (stream.constantWithWidth.has_value()) {
1688 value =
context.convertRvalueExpression(*stream.withExpr);
1689 auto type = cast<moore::UnpackedType>(value.getType());
1690 auto intType = moore::IntType::get(
1691 context.getContext(), type.getBitSize().value(), type.getDomain());
1693 value =
context.materializeConversion(intType, value,
false, loc);
1695 value =
context.convertRvalueExpression(*stream.operand);
1698 value =
context.convertToSimpleBitVector(value);
1701 operands.push_back(value);
1705 if (operands.size() == 1) {
1708 value = operands.front();
1710 value = moore::ConcatOp::create(builder, loc, operands).getResult();
1713 if (expr.getSliceSize() == 0) {
1717 auto type = cast<moore::IntType>(value.getType());
1718 SmallVector<Value> slicedOperands;
1719 auto iterMax = type.getWidth() / expr.getSliceSize();
1720 auto remainSize = type.getWidth() % expr.getSliceSize();
1722 for (
size_t i = 0; i < iterMax; i++) {
1723 auto extractResultType = moore::IntType::get(
1724 context.getContext(), expr.getSliceSize(), type.getDomain());
1726 auto extracted = moore::ExtractOp::create(builder, loc, extractResultType,
1727 value, i * expr.getSliceSize());
1728 slicedOperands.push_back(extracted);
1732 auto extractResultType = moore::IntType::get(
1733 context.getContext(), remainSize, type.getDomain());
1736 moore::ExtractOp::create(builder, loc, extractResultType, value,
1737 iterMax * expr.getSliceSize());
1738 slicedOperands.push_back(extracted);
1741 return moore::ConcatOp::create(builder, loc, slicedOperands);
1744 Value visit(
const slang::ast::AssertionInstanceExpression &expr) {
1745 return context.convertAssertionExpression(expr.body, loc);
1760 Value visit(
const slang::ast::NewClassExpression &expr) {
1761 auto type =
context.convertType(*expr.type);
1762 auto classTy = dyn_cast<moore::ClassHandleType>(type);
1768 if (!classTy && expr.isSuperClass) {
1769 newObj =
context.getImplicitThisRef();
1770 if (!newObj || !newObj.getType() ||
1771 !isa<moore::ClassHandleType>(newObj.getType())) {
1772 mlir::emitError(loc) <<
"implicit this ref was not set while "
1773 "converting new class function";
1776 auto thisType = cast<moore::ClassHandleType>(newObj.getType());
1778 cast<moore::ClassDeclOp>(*
context.symbolTable.lookupNearestSymbolFrom(
1779 context.intoModuleOp, thisType.getClassSym()));
1780 auto baseClassSym = classDecl.getBase();
1781 classTy = circt::moore::ClassHandleType::get(
context.getContext(),
1782 baseClassSym.value());
1785 newObj = moore::ClassNewOp::create(builder, loc, classTy, {});
1788 const auto *constructor = expr.constructorCall();
1793 if (
const auto *callConstructor =
1794 constructor->as_if<slang::ast::CallExpression>())
1795 if (
const auto *subroutine =
1796 std::get_if<const slang::ast::SubroutineSymbol *>(
1797 &callConstructor->subroutine)) {
1800 if (!(*subroutine)->thisVar) {
1801 mlir::emitError(loc) <<
"Expected subroutine called by new to use an "
1802 "implicit this reference";
1805 if (failed(
context.convertFunction(**subroutine)))
1808 auto savedThis =
context.currentThisRef;
1809 context.currentThisRef = newObj;
1811 llvm::make_scope_exit([&] {
context.currentThisRef = savedThis; });
1813 if (!visitCall(*callConstructor, *subroutine))
1822 template <
typename T>
1823 Value visit(T &&node) {
1824 mlir::emitError(loc,
"unsupported expression: ")
1825 << slang::ast::toString(node.kind);
1829 Value visitInvalid(
const slang::ast::Expression &expr) {
1830 mlir::emitError(loc,
"invalid expression");
1841struct LvalueExprVisitor :
public ExprVisitor {
1843 : ExprVisitor(
context, loc, true) {}
1844 using ExprVisitor::visit;
1847 Value visit(
const slang::ast::NamedValueExpression &expr) {
1849 if (
auto value =
context.valueSymbols.lookup(&expr.symbol))
1853 if (
auto globalOp =
context.globalVariables.lookup(&expr.symbol))
1854 return moore::GetGlobalVariableOp::create(builder, loc, globalOp);
1856 if (
auto *
const property =
1857 expr.symbol.as_if<slang::ast::ClassPropertySymbol>()) {
1861 auto d = mlir::emitError(loc,
"unknown name `") << expr.symbol.name <<
"`";
1862 d.attachNote(
context.convertLocation(expr.symbol.location))
1863 <<
"no lvalue generated for " << slang::ast::toString(expr.symbol.kind);
1868 Value visit(
const slang::ast::HierarchicalValueExpression &expr) {
1870 if (
auto value =
context.valueSymbols.lookup(&expr.symbol))
1874 if (
auto globalOp =
context.globalVariables.lookup(&expr.symbol))
1875 return moore::GetGlobalVariableOp::create(builder, loc, globalOp);
1879 auto d = mlir::emitError(loc,
"unknown hierarchical name `")
1880 << expr.symbol.name <<
"`";
1881 d.attachNote(
context.convertLocation(expr.symbol.location))
1882 <<
"no lvalue generated for " << slang::ast::toString(expr.symbol.kind);
1886 Value visit(
const slang::ast::StreamingConcatenationExpression &expr) {
1887 SmallVector<Value> operands;
1888 for (
auto stream : expr.streams()) {
1889 auto operandLoc =
context.convertLocation(stream.operand->sourceRange);
1890 if (!stream.constantWithWidth.has_value() && stream.withExpr) {
1891 mlir::emitError(operandLoc)
1892 <<
"Moore only support streaming "
1893 "concatenation with fixed size 'with expression'";
1897 if (stream.constantWithWidth.has_value()) {
1898 value =
context.convertLvalueExpression(*stream.withExpr);
1899 auto type = cast<moore::UnpackedType>(
1900 cast<moore::RefType>(value.getType()).getNestedType());
1901 auto intType = moore::RefType::get(moore::IntType::get(
1902 context.getContext(), type.getBitSize().value(), type.getDomain()));
1904 value =
context.materializeConversion(intType, value,
false, loc);
1906 value =
context.convertLvalueExpression(*stream.operand);
1911 operands.push_back(value);
1914 if (operands.size() == 1) {
1917 value = operands.front();
1919 value = moore::ConcatRefOp::create(builder, loc, operands).getResult();
1922 if (expr.getSliceSize() == 0) {
1926 auto type = cast<moore::IntType>(
1927 cast<moore::RefType>(value.getType()).getNestedType());
1928 SmallVector<Value> slicedOperands;
1929 auto widthSum = type.getWidth();
1930 auto domain = type.getDomain();
1931 auto iterMax = widthSum / expr.getSliceSize();
1932 auto remainSize = widthSum % expr.getSliceSize();
1934 for (
size_t i = 0; i < iterMax; i++) {
1935 auto extractResultType = moore::RefType::get(moore::IntType::get(
1936 context.getContext(), expr.getSliceSize(), domain));
1938 auto extracted = moore::ExtractRefOp::create(
1939 builder, loc, extractResultType, value, i * expr.getSliceSize());
1940 slicedOperands.push_back(extracted);
1944 auto extractResultType = moore::RefType::get(
1945 moore::IntType::get(
context.getContext(), remainSize, domain));
1948 moore::ExtractRefOp::create(builder, loc, extractResultType, value,
1949 iterMax * expr.getSliceSize());
1950 slicedOperands.push_back(extracted);
1953 return moore::ConcatRefOp::create(builder, loc, slicedOperands);
1957 template <
typename T>
1958 Value visit(T &&node) {
1959 return context.convertRvalueExpression(node);
1962 Value visitInvalid(
const slang::ast::Expression &expr) {
1963 mlir::emitError(loc,
"invalid expression");
1973Value Context::convertRvalueExpression(
const slang::ast::Expression &expr,
1974 Type requiredType) {
1976 auto value = expr.visit(RvalueExprVisitor(*
this, loc));
1977 if (value && requiredType)
1985 return expr.visit(LvalueExprVisitor(*
this, loc));
1993 if (
auto type = dyn_cast_or_null<moore::IntType>(value.getType()))
1994 if (type.getBitSize() == 1)
1996 if (
auto type = dyn_cast_or_null<moore::UnpackedType>(value.getType()))
1997 return moore::BoolCastOp::create(
builder, value.getLoc(), value);
1998 mlir::emitError(value.getLoc(),
"expression of type ")
1999 << value.getType() <<
" cannot be cast to a boolean";
2005 const slang::ast::Type &astType,
2007 const auto *floatType = astType.as_if<slang::ast::FloatingType>();
2011 if (svreal.isShortReal() &&
2012 floatType->floatKind == slang::ast::FloatingType::ShortReal) {
2013 attr = FloatAttr::get(
builder.getF32Type(), svreal.shortReal().v);
2014 }
else if (svreal.isReal() &&
2015 floatType->floatKind == slang::ast::FloatingType::Real) {
2016 attr = FloatAttr::get(
builder.getF64Type(), svreal.real().v);
2018 mlir::emitError(loc) <<
"invalid real constant";
2022 return moore::ConstantRealOp::create(
builder, loc, attr);
2027 const slang::ast::Type &astType,
2029 slang::ConstantValue intVal = stringLiteral.convertToInt();
2030 auto effectiveWidth = intVal.getEffectiveWidth();
2031 if (!effectiveWidth)
2034 auto intTy = moore::IntType::getInt(
getContext(), effectiveWidth.value());
2036 if (astType.isString()) {
2037 auto immInt = moore::ConstantStringOp::create(
builder, loc, intTy,
2038 stringLiteral.toString())
2040 return moore::IntToStringOp::create(
builder, loc, immInt).getResult();
2047 const slang::ast::Type &astType, Location loc) {
2052 bool typeIsFourValued =
false;
2053 if (
auto unpackedType = dyn_cast<moore::UnpackedType>(type))
2057 auto intType = moore::IntType::get(
getContext(), fvint.getBitWidth(),
2058 fvint.hasUnknown() || typeIsFourValued
2061 auto result = moore::ConstantOp::create(
builder, loc, intType, fvint);
2066 const slang::ConstantValue &constant,
2067 const slang::ast::FixedSizeUnpackedArrayType &astType, Location loc) {
2075 if (astType.elementType.isIntegral())
2076 bitWidth = astType.elementType.getBitWidth();
2080 bool typeIsFourValued =
false;
2083 if (
auto unpackedType = dyn_cast<moore::UnpackedType>(type))
2094 auto intType = moore::IntType::get(
getContext(), bitWidth, domain);
2096 auto arrType = moore::UnpackedArrayType::get(
2097 getContext(), constant.elements().size(), intType);
2099 llvm::SmallVector<mlir::Value> elemVals;
2100 moore::ConstantOp constOp;
2102 mlir::OpBuilder::InsertionGuard guard(
builder);
2105 for (
auto elem : constant.elements()) {
2107 constOp = moore::ConstantOp::create(
builder, loc, intType, fvInt);
2108 elemVals.push_back(constOp.getResult());
2113 auto arrayOp = moore::ArrayCreateOp::create(
builder, loc, arrType, elemVals);
2115 return arrayOp.getResult();
2119 const slang::ast::Type &type, Location loc) {
2121 if (
auto *arr = type.as_if<slang::ast::FixedSizeUnpackedArrayType>())
2123 if (constant.isInteger())
2125 if (constant.isReal() || constant.isShortReal())
2127 if (constant.isString())
2135 using slang::ast::EvalFlags;
2136 slang::ast::EvalContext evalContext(
2138 slang::ast::LookupLocation::max),
2139 EvalFlags::CacheResults | EvalFlags::SpecparamsAllowed);
2140 return expr.eval(evalContext);
2149 auto type = moore::IntType::get(
getContext(), 1, domain);
2156 if (isa<moore::IntType>(value.getType()))
2163 if (
auto packed = dyn_cast<moore::PackedType>(value.getType()))
2164 if (
auto sbvType = packed.getSimpleBitVector())
2167 mlir::emitError(value.getLoc()) <<
"expression of type " << value.getType()
2168 <<
" cannot be cast to a simple bit vector";
2177 if (isa<moore::IntType>(value.getType()))
2180 auto &builder =
context.builder;
2181 auto packedType = cast<moore::PackedType>(value.getType());
2182 auto intType = packedType.getSimpleBitVector();
2187 if (isa<moore::TimeType>(packedType) &&
2189 value = builder.createOrFold<moore::TimeToLogicOp>(loc, value);
2190 auto scale = moore::ConstantOp::create(builder, loc, intType,
2192 return builder.createOrFold<moore::DivUOp>(loc, value, scale);
2198 if (packedType.containsTimeType()) {
2199 mlir::emitError(loc) <<
"unsupported conversion: " << packedType
2200 <<
" cannot be converted to " << intType
2201 <<
"; contains a time type";
2206 return builder.createOrFold<moore::PackedToSBVOp>(loc, value);
2214 Value value, Location loc) {
2215 if (value.getType() == packedType)
2218 auto &builder =
context.builder;
2219 auto intType = cast<moore::IntType>(value.getType());
2224 if (isa<moore::TimeType>(packedType) &&
2226 auto scale = moore::ConstantOp::create(builder, loc, intType,
2228 value = builder.createOrFold<moore::MulOp>(loc, value, scale);
2229 return builder.createOrFold<moore::LogicToTimeOp>(loc, value);
2236 mlir::emitError(loc) <<
"unsupported conversion: " << intType
2237 <<
" cannot be converted to " << packedType
2238 <<
"; contains a time type";
2243 return builder.createOrFold<moore::SBVToPackedOp>(loc, packedType, value);
2249 moore::ClassHandleType expectedHandleTy) {
2250 auto loc = actualHandle.getLoc();
2252 auto actualTy = actualHandle.getType();
2253 auto actualHandleTy = dyn_cast<moore::ClassHandleType>(actualTy);
2254 if (!actualHandleTy) {
2255 mlir::emitError(loc) <<
"expected a !moore.class<...> value, got "
2261 if (actualHandleTy == expectedHandleTy)
2262 return actualHandle;
2264 if (!
context.isClassDerivedFrom(actualHandleTy, expectedHandleTy)) {
2265 mlir::emitError(loc)
2266 <<
"receiver class " << actualHandleTy.getClassSym()
2267 <<
" is not the same as, or derived from, expected base class "
2268 << expectedHandleTy.getClassSym().getRootReference();
2273 auto casted = moore::ClassUpcastOp::create(
context.builder, loc,
2274 expectedHandleTy, actualHandle)
2282 if (type == value.getType())
2287 auto dstPacked = dyn_cast<moore::PackedType>(type);
2288 auto srcPacked = dyn_cast<moore::PackedType>(value.getType());
2289 auto dstInt = dstPacked ? dstPacked.getSimpleBitVector() : moore::IntType();
2290 auto srcInt = srcPacked ? srcPacked.getSimpleBitVector() : moore::IntType();
2292 if (dstInt && srcInt) {
2300 auto resizedType = moore::IntType::get(
2301 value.getContext(), dstInt.getWidth(), srcPacked.getDomain());
2302 if (dstInt.getWidth() < srcInt.getWidth()) {
2303 value =
builder.createOrFold<moore::TruncOp>(loc, resizedType, value);
2304 }
else if (dstInt.getWidth() > srcInt.getWidth()) {
2306 value =
builder.createOrFold<moore::SExtOp>(loc, resizedType, value);
2308 value =
builder.createOrFold<moore::ZExtOp>(loc, resizedType, value);
2312 if (dstInt.getDomain() != srcInt.getDomain()) {
2314 value =
builder.createOrFold<moore::LogicToIntOp>(loc, value);
2316 value =
builder.createOrFold<moore::IntToLogicOp>(loc, value);
2324 assert(value.getType() == type);
2329 if (isa<moore::StringType>(type) &&
2330 isa<moore::FormatStringType>(value.getType())) {
2331 return builder.createOrFold<moore::FormatStringToStringOp>(loc, value);
2335 if (isa<moore::FormatStringType>(type) &&
2336 isa<moore::StringType>(value.getType())) {
2337 return builder.createOrFold<moore::FormatStringOp>(loc, value);
2341 if (isa<moore::IntType>(type) && isa<moore::RealType>(value.getType())) {
2342 auto twoValInt =
builder.createOrFold<moore::RealToIntOp>(
2343 loc, dyn_cast<moore::IntType>(type).getTwoValued(), value);
2351 if (isa<moore::RealType>(type) && isa<moore::IntType>(value.getType())) {
2354 if (dyn_cast<moore::IntType>(value.getType()).getDomain() ==
2359 dyn_cast<moore::IntType>(value.getType()).getTwoValued(), value,
true,
2363 return builder.createOrFold<moore::SIntToRealOp>(loc, type, twoValInt);
2364 return builder.createOrFold<moore::UIntToRealOp>(loc, type, twoValInt);
2367 if (isa<moore::ClassHandleType>(type) &&
2368 isa<moore::ClassHandleType>(value.getType()))
2372 if (value.getType() != type)
2373 value = moore::ConversionOp::create(
builder, loc, type, value);
2381 auto systemCallRes =
2382 llvm::StringSwitch<std::function<FailureOr<Value>()>>(subroutine.name)
2385 return moore::UrandomBIOp::create(
builder, loc,
nullptr);
2389 return moore::RandomBIOp::create(
builder, loc,
nullptr);
2393 [&]() -> Value {
return moore::TimeBIOp::create(
builder, loc); })
2396 [&]() -> Value {
return moore::TimeBIOp::create(
builder, loc); })
2399 [&]() -> Value {
return moore::TimeBIOp::create(
builder, loc); })
2400 .Default([&]() -> Value {
return {}; });
2401 return systemCallRes();
2406 Location loc, Value value) {
2407 auto systemCallRes =
2408 llvm::StringSwitch<std::function<FailureOr<Value>()>>(subroutine.name)
2410 .Case(
"$signed", [&]() {
return value; })
2411 .Case(
"$unsigned", [&]() {
return value; })
2415 [&]() -> FailureOr<Value> {
2419 return (Value)moore::Clog2BIOp::create(
builder, loc, value);
2423 return moore::LnBIOp::create(
builder, loc, value);
2427 return moore::Log10BIOp::create(
builder, loc, value);
2431 return moore::SinBIOp::create(
builder, loc, value);
2435 return moore::CosBIOp::create(
builder, loc, value);
2439 return moore::TanBIOp::create(
builder, loc, value);
2443 return moore::ExpBIOp::create(
builder, loc, value);
2447 return moore::SqrtBIOp::create(
builder, loc, value);
2451 return moore::FloorBIOp::create(
builder, loc, value);
2455 return moore::CeilBIOp::create(
builder, loc, value);
2459 return moore::AsinBIOp::create(
builder, loc, value);
2463 return moore::AcosBIOp::create(
builder, loc, value);
2467 return moore::AtanBIOp::create(
builder, loc, value);
2471 return moore::SinhBIOp::create(
builder, loc, value);
2475 return moore::CoshBIOp::create(
builder, loc, value);
2479 return moore::TanhBIOp::create(
builder, loc, value);
2483 return moore::AsinhBIOp::create(
builder, loc, value);
2487 return moore::AcoshBIOp::create(
builder, loc, value);
2491 return moore::AtanhBIOp::create(
builder, loc, value);
2495 return moore::UrandomBIOp::create(
builder, loc, value);
2499 return moore::RandomBIOp::create(
builder, loc, value);
2501 .Case(
"$realtobits",
2503 return moore::RealtobitsBIOp::create(
builder, loc, value);
2505 .Case(
"$bitstoreal",
2507 return moore::BitstorealBIOp::create(
builder, loc, value);
2509 .Case(
"$shortrealtobits",
2511 return moore::ShortrealtobitsBIOp::create(
builder, loc,
2514 .Case(
"$bitstoshortreal",
2516 return moore::BitstoshortrealBIOp::create(
builder, loc,
2521 if (isa<moore::StringType>(value.getType()))
2522 return moore::StringLenOp::create(
builder, loc, value);
2527 return moore::StringToUpperOp::create(
builder, loc, value);
2531 return moore::StringToLowerOp::create(
builder, loc, value);
2533 .Default([&]() -> Value {
return {}; });
2534 return systemCallRes();
2539 Location loc, Value value1, Value value2) {
2540 auto systemCallRes =
2541 llvm::StringSwitch<std::function<FailureOr<Value>()>>(subroutine.name)
2544 return moore::StringGetCOp::create(
builder, loc, value1,
2547 .Default([&]() -> Value {
return {}; });
2548 return systemCallRes();
2553 return context.symbolTable.lookupNearestSymbolFrom(
context.intoModuleOp, sym);
2557 const moore::ClassHandleType &baseTy) {
2558 if (!actualTy || !baseTy)
2561 mlir::SymbolRefAttr actualSym = actualTy.getClassSym();
2562 mlir::SymbolRefAttr baseSym = baseTy.getClassSym();
2564 if (actualSym == baseSym)
2567 auto *op =
resolve(*
this, actualSym);
2568 auto decl = llvm::dyn_cast_or_null<moore::ClassDeclOp>(op);
2571 mlir::SymbolRefAttr curBase = decl.getBaseAttr();
2574 if (curBase == baseSym)
2576 decl = llvm::dyn_cast_or_null<moore::ClassDeclOp>(
resolve(*
this, curBase));
2581moore::ClassHandleType
2583 llvm::StringRef fieldName, Location loc) {
2585 mlir::SymbolRefAttr classSym = actualTy.getClassSym();
2589 auto *op =
resolve(*
this, classSym);
2590 auto decl = llvm::dyn_cast_or_null<moore::ClassDeclOp>(op);
2595 for (
auto &block : decl.getBody()) {
2596 for (
auto &opInBlock : block) {
2598 llvm::dyn_cast<moore::ClassPropertyDeclOp>(&opInBlock)) {
2599 if (prop.getSymName() == fieldName) {
2601 return moore::ClassHandleType::get(actualTy.getContext(), classSym);
2608 classSym = decl.getBaseAttr();
2612 mlir::emitError(loc) <<
"unknown property `" << fieldName <<
"`";
assert(baseType &&"element must be base type")
static std::unique_ptr< Context > context
static Value materializeSBVToPackedConversion(Context &context, moore::PackedType packedType, Value value, Location loc)
Create the necessary operations to convert from a simple bit vector IntType to an equivalent PackedTy...
static mlir::Value maybeUpcastHandle(Context &context, mlir::Value actualHandle, moore::ClassHandleType expectedHandleTy)
Check whether the actual handle is a subclass of another handle type and return a properly upcast ver...
static mlir::Operation * resolve(Context &context, mlir::SymbolRefAttr sym)
static Value visitClassProperty(Context &context, const slang::ast::ClassPropertySymbol &expr)
static uint64_t getTimeScaleInFemtoseconds(Context &context)
Get the currently active timescale as an integer number of femtoseconds.
static Value materializePackedToSBVConversion(Context &context, Value value, Location loc)
Create the necessary operations to convert from a PackedType to the corresponding simple bit vector I...
static Value getSelectIndex(Context &context, Location loc, Value index, const slang::ConstantRange &range)
Map an index into an array, with bounds range, to a bit offset of the underlying bit storage.
static FVInt convertSVIntToFVInt(const slang::SVInt &svint)
Convert a Slang SVInt to a CIRCT FVInt.
Four-valued arbitrary precision integers.
A packed SystemVerilog type.
bool containsTimeType() const
Check if this is a TimeType, or an aggregate that contains a nested TimeType.
IntType getSimpleBitVector() const
Get the simple bit vector type equivalent to this packed type.
Domain
The number of values each bit of a type can assume.
@ FourValued
Four-valued types such as logic or integer.
@ TwoValued
Two-valued types such as bit or int.
bool isIntType(Type type, unsigned width)
Check if a type is an IntType type of the given width.
The InstanceGraph op interface, see InstanceGraphInterface.td for more details.
A helper class to facilitate the conversion from a Slang AST to MLIR operations.
Value materializeConversion(Type type, Value value, bool isSigned, Location loc)
Helper function to insert the necessary operations to cast a value from one type to another.
Value convertLvalueExpression(const slang::ast::Expression &expr)
Value materializeConstant(const slang::ConstantValue &constant, const slang::ast::Type &type, Location loc)
Helper function to materialize a ConstantValue as an SSA value.
slang::ConstantValue evaluateConstant(const slang::ast::Expression &expr)
Evaluate the constant value of an expression.
slang::ast::Compilation & compilation
OpBuilder builder
The builder used to create IR operations.
Value materializeFixedSizeUnpackedArrayType(const slang::ConstantValue &constant, const slang::ast::FixedSizeUnpackedArrayType &astType, Location loc)
Helper function to materialize an unpacked array of SVInts as an SSA value.
bool isClassDerivedFrom(const moore::ClassHandleType &actualTy, const moore::ClassHandleType &baseTy)
Checks whether one class (actualTy) is derived from another class (baseTy).
Type convertType(const slang::ast::Type &type, LocationAttr loc={})
Convert a slang type into an MLIR type.
Value materializeSVInt(const slang::SVInt &svint, const slang::ast::Type &type, Location loc)
Helper function to materialize an SVInt as an SSA value.
Value materializeSVReal(const slang::ConstantValue &svreal, const slang::ast::Type &type, Location loc)
Helper function to materialize a real value as an SSA value.
Value convertToBool(Value value)
Helper function to convert a value to its "truthy" boolean value.
moore::ClassHandleType getAncestorClassWithProperty(const moore::ClassHandleType &actualTy, StringRef fieldName, Location loc)
Tries to find the closest base class of actualTy that carries a property with name fieldName.
Value convertRvalueExpression(const slang::ast::Expression &expr, Type requiredType={})
FailureOr< Value > convertSystemCallArity0(const slang::ast::SystemSubroutine &subroutine, Location loc)
Convert system function calls only have arity-0.
Value convertToSimpleBitVector(Value value)
Helper function to convert a value to its simple bit vector representation, if it has one.
Value materializeString(const slang::ConstantValue &string, const slang::ast::Type &astType, Location loc)
Helper function to materialize a string as an SSA value.
FailureOr< Value > convertSystemCallArity1(const slang::ast::SystemSubroutine &subroutine, Location loc, Value value)
Convert system function calls only have arity-1.
MLIRContext * getContext()
Return the MLIR context.
FailureOr< Value > convertSystemCallArity2(const slang::ast::SystemSubroutine &subroutine, Location loc, Value value1, Value value2)
Convert system function calls with arity-2.
Location convertLocation(slang::SourceLocation loc)
Convert a slang SourceLocation into an MLIR Location.
Function lowering information.
llvm::SmallVector< Value, 4 > captures