mlir/lib/Dialect/IRDL/IR/IRDLOps.cpp

//===- IRDLOps.cpp - IRDL dialect -------------------------------*- C++ -*-===//
//
// This file is licensed 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
//
//===----------------------------------------------------------------------===//

#include "mlir/Dialect/IRDL/IR/IRDL.h"
#include "mlir/Dialect/IRDL/IRDLSymbols.h"
#include "mlir/IR/ValueRange.h"
#include <optional>

using namespace mlir;
using namespace mlir::irdl;

/// Maps given `args` to the index in the `valueToConstr`
static SmallVector<unsigned>
getConstraintIndicesForArgs(mlir::OperandRange args,
                            ArrayRef<Value> valueToConstr) {
  SmallVector<unsigned> constraints;
  for (Value arg : args) {
    for (auto [i, value] : enumerate(valueToConstr)) {
      if (value == arg) {
        constraints.push_back(i);
        break;
      }
    }
  }
  return constraints;
}

std::unique_ptr<Constraint> IsOp::getVerifier(
    ArrayRef<Value> valueToConstr,
    DenseMap<TypeOp, std::unique_ptr<DynamicTypeDefinition>> const &types,
    DenseMap<AttributeOp, std::unique_ptr<DynamicAttrDefinition>> const
        &attrs) {
  return std::make_unique<IsConstraint>(getExpectedAttr());
}

std::unique_ptr<Constraint> BaseOp::getVerifier(
    ArrayRef<Value> valueToConstr,
    DenseMap<TypeOp, std::unique_ptr<DynamicTypeDefinition>> const &types,
    DenseMap<AttributeOp, std::unique_ptr<DynamicAttrDefinition>> const
        &attrs) {
  MLIRContext *ctx = getContext();

  // Case where the input is a symbol reference.
  // This corresponds to the case where the base is an IRDL type or attribute.
  if (auto baseRef = getBaseRef()) {
    // The verifier for BaseOp guarantees it is within a dialect.
    Operation *defOp =
        irdl::lookupSymbolNearDialect(getOperation(), baseRef.value());

    // Type case.
    if (auto typeOp = dyn_cast<TypeOp>(defOp)) {
      DynamicTypeDefinition *typeDef = types.at(typeOp).get();
      auto name = StringAttr::get(ctx, typeDef->getDialect()->getNamespace() +
                                           "." + typeDef->getName().str());
      return std::make_unique<BaseTypeConstraint>(typeDef->getTypeID(), name);
    }

    // Attribute case.
    auto attrOp = cast<AttributeOp>(defOp);
    DynamicAttrDefinition *attrDef = attrs.at(attrOp).get();
    auto name = StringAttr::get(ctx, attrDef->getDialect()->getNamespace() +
                                         "." + attrDef->getName().str());
    return std::make_unique<BaseAttrConstraint>(attrDef->getTypeID(), name);
  }

  // Case where the input is string literal.
  // This corresponds to the case where the base is a registered type or
  // attribute.
  StringRef baseName = getBaseName().value();

  // Type case.
  if (baseName[0] == '!') {
    auto abstractType = AbstractType::lookup(baseName.drop_front(1), ctx);
    if (!abstractType) {
      emitError() << "no registered type with name " << baseName;
      return nullptr;
    }
    return std::make_unique<BaseTypeConstraint>(abstractType->get().getTypeID(),
                                                abstractType->get().getName());
  }

  auto abstractAttr = AbstractAttribute::lookup(baseName.drop_front(1), ctx);
  if (!abstractAttr) {
    emitError() << "no registered attribute with name " << baseName;
    return nullptr;
  }
  return std::make_unique<BaseAttrConstraint>(abstractAttr->get().getTypeID(),
                                              abstractAttr->get().getName());
}

std::unique_ptr<Constraint> ParametricOp::getVerifier(
    ArrayRef<Value> valueToConstr,
    DenseMap<TypeOp, std::unique_ptr<DynamicTypeDefinition>> const &types,
    DenseMap<AttributeOp, std::unique_ptr<DynamicAttrDefinition>> const
        &attrs) {
  SmallVector<unsigned> constraints =
      getConstraintIndicesForArgs(getArgs(), valueToConstr);

  // Symbol reference case for the base.
  // The verifier for ParametricOp guarantees it is within a dialect.
  SymbolRefAttr symRef = getBaseType();
  Operation *defOp = irdl::lookupSymbolNearDialect(getOperation(), symRef);
  if (!defOp) {
    emitError() << symRef << " does not refer to any existing symbol";
    return nullptr;
  }

  if (auto typeOp = dyn_cast<TypeOp>(defOp))
    return std::make_unique<DynParametricTypeConstraint>(types.at(typeOp).get(),
                                                         constraints);

  if (auto attrOp = dyn_cast<AttributeOp>(defOp))
    return std::make_unique<DynParametricAttrConstraint>(attrs.at(attrOp).get(),
                                                         constraints);

  llvm_unreachable("verifier should ensure that the referenced operation is "
                   "either a type or an attribute definition");
}

std::unique_ptr<Constraint> AnyOfOp::getVerifier(
    ArrayRef<Value> valueToConstr,
    DenseMap<TypeOp, std::unique_ptr<DynamicTypeDefinition>> const &types,
    DenseMap<AttributeOp, std::unique_ptr<DynamicAttrDefinition>> const
        &attrs) {
  return std::make_unique<AnyOfConstraint>(
      getConstraintIndicesForArgs(getArgs(), valueToConstr));
}

std::unique_ptr<Constraint> AllOfOp::getVerifier(
    ArrayRef<Value> valueToConstr,
    DenseMap<TypeOp, std::unique_ptr<DynamicTypeDefinition>> const &types,
    DenseMap<AttributeOp, std::unique_ptr<DynamicAttrDefinition>> const
        &attrs) {
  return std::make_unique<AllOfConstraint>(
      getConstraintIndicesForArgs(getArgs(), valueToConstr));
}

std::unique_ptr<Constraint> AnyOp::getVerifier(
    ArrayRef<Value> valueToConstr,
    DenseMap<TypeOp, std::unique_ptr<DynamicTypeDefinition>> const &types,
    DenseMap<AttributeOp, std::unique_ptr<DynamicAttrDefinition>> const
        &attrs) {
  return std::make_unique<AnyAttributeConstraint>();
}

std::unique_ptr<RegionConstraint> RegionOp::getVerifier(
    ArrayRef<Value> valueToConstr,
    DenseMap<TypeOp, std::unique_ptr<DynamicTypeDefinition>> const &types,
    DenseMap<AttributeOp, std::unique_ptr<DynamicAttrDefinition>> const
        &attrs) {
  return std::make_unique<RegionConstraint>(
      getConstrainedArguments() ? std::optional{getConstraintIndicesForArgs(
                                      getEntryBlockArgs(), valueToConstr)}
                                : std::nullopt,
      getNumberOfBlocks());
}