OpTraits.h

Go to the documentation of this file.

//===-- OpTraits.h ----------------------------------------------*- c++ -*-===//
//
// Part of the LLZK Project, under the Apache License v2.0.
// See LICENSE.txt for license information.
// Copyright 2025 Veridise Inc.
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
 
#pragma once
 
#include <mlir/IR/OpDefinition.h>
#include <mlir/IR/Operation.h>
#include <mlir/Support/LogicalResult.h>
 
namespace llzk::function {
 
mlir::LogicalResult verifyConstraintGenTraitImpl(mlir::Operation *op);
mlir::LogicalResult verifyWitnessGenTraitImpl(mlir::Operation *op);
mlir::LogicalResult verifyNotFieldNativeTraitImpl(mlir::Operation *op);

mlir::LogicalResult
verifyVerificationTraitImpl(mlir::Operation *op, llvm::function_ref<mlir::LogicalResult()>);

template <typename TypeClass>
// NOLINTNEXTLINE(bugprone-crtp-constructor-accessibility)
class ConstraintGen : public mlir::OpTrait::TraitBase<TypeClass, ConstraintGen> {
public:
  inline static mlir::LogicalResult verifyTrait(mlir::Operation *op) {
    return verifyConstraintGenTraitImpl(op);
  }
};

template <typename TypeClass>
// NOLINTNEXTLINE(bugprone-crtp-constructor-accessibility)
class WitnessGen : public mlir::OpTrait::TraitBase<TypeClass, WitnessGen> {
public:
  inline static mlir::LogicalResult verifyTrait(mlir::Operation *op) {
    return verifyWitnessGenTraitImpl(op);
  }
};

template <typename TypeClass>
// NOLINTNEXTLINE(bugprone-crtp-constructor-accessibility)
class NotFieldNative : public mlir::OpTrait::TraitBase<TypeClass, NotFieldNative> {
public:
  inline static mlir::LogicalResult verifyTrait(mlir::Operation *op) {
    return verifyNotFieldNativeTraitImpl(op);
  }
};

template <template <typename T> class... Extra> struct Verification {
  template <typename TypeClass>
  // NOLINTNEXTLINE(bugprone-crtp-constructor-accessibility)
  class Impl : public mlir::OpTrait::TraitBase<TypeClass, Impl> {
  public:
    inline static mlir::LogicalResult verifyTrait(mlir::Operation *op) {
      return verifyVerificationTraitImpl(op, [op]() {
        return mlir::success((mlir::succeeded(Extra<TypeClass>::verifyTrait(op)) && ...));
      });
    }
  };
};
 
template <> struct Verification<> {
  template <typename TypeClass>
  // NOLINTNEXTLINE(bugprone-crtp-constructor-accessibility)
  class Impl : public mlir::OpTrait::TraitBase<TypeClass, Impl> {
  public:
    inline static mlir::LogicalResult verifyTrait(mlir::Operation *op) {
      return verifyVerificationTraitImpl(op, nullptr);
    }
  };
};
 
} // namespace llzk::function