Function.h

Go to the documentation of this file.

//===-- Function.h - C API for Function dialect -------------------*- 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
//
//===----------------------------------------------------------------------===//
//
// This header declares the C interface for registering and accessing the
// Function dialect. A dialect should be registered with a context to make it
// available to users of the context. These users must load the dialect
// before using any of its attributes, operations, or types. Parser and pass
// manager can load registered dialects automatically.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLZK_C_DIALECT_FUNCTION_H
#define LLZK_C_DIALECT_FUNCTION_H
 
#include "llzk-c/Support.h"
 
#include <mlir-c/IR.h>
#include <mlir-c/Support.h>
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
MLIR_DECLARE_CAPI_DIALECT_REGISTRATION(Function, llzk__function);
 
//===----------------------------------------------------------------------===//
// FuncDefOp
//===----------------------------------------------------------------------===//

MLIR_CAPI_EXPORTED MlirOperation llzkFuncDefOpCreateWithAttrsAndArgAttrs(
    MlirLocation loc, MlirStringRef name, MlirType type, intptr_t nAttrs,
    MlirNamedAttribute const *attrs, intptr_t nArgAttrs, MlirAttribute const *argAttrs
);

static inline MlirOperation llzkFuncDefOpCreateWithAttrs(
    MlirLocation loc, MlirStringRef name, MlirType type, intptr_t nAttrs,
    MlirNamedAttribute const *attrs
) {
  return llzkFuncDefOpCreateWithAttrsAndArgAttrs(
      loc, name, type, nAttrs, attrs, /*nArgAttrs=*/0, /*argAttrs=*/NULL
  );
}

static inline MlirOperation
llzkFuncDefOpCreate(MlirLocation loc, MlirStringRef name, MlirType type) {
  return llzkFuncDefOpCreateWithAttrs(loc, name, type, /*nAttrs=*/0, /*attrs=*/NULL);
}

static inline MlirOperation llzkFuncDefOpCreateWithArgAttrs(
    MlirLocation loc, MlirStringRef name, MlirType type, intptr_t nArgAttrs,
    MlirAttribute const *argAttrs
) {
  return llzkFuncDefOpCreateWithAttrsAndArgAttrs(
      loc, name, type, /*nAttrs=*/0, /*attrs=*/NULL, nArgAttrs, argAttrs
  );
}

LLZK_DECLARE_OP_ISA(FuncDefOp);

LLZK_DECLARE_OP_PREDICATE(FuncDefOp, HasAllowConstraintAttr);

MLIR_CAPI_EXPORTED void llzkFuncDefOpSetAllowConstraintAttr(MlirOperation op, bool value);

LLZK_DECLARE_OP_PREDICATE(FuncDefOp, HasAllowWitnessAttr);

MLIR_CAPI_EXPORTED void llzkFuncDefOpSetAllowWitnessAttr(MlirOperation op, bool value);

LLZK_DECLARE_NARY_OP_PREDICATE(FuncDefOp, HasArgIsPub, unsigned arg);

MLIR_CAPI_EXPORTED MlirAttribute llzkFuncDefOpGetFullyQualifiedName(MlirOperation op);

LLZK_DECLARE_OP_PREDICATE(FuncDefOp, NameIsCompute);

LLZK_DECLARE_OP_PREDICATE(FuncDefOp, NameIsConstrain);

LLZK_DECLARE_OP_PREDICATE(FuncDefOp, IsInStruct);

LLZK_DECLARE_OP_PREDICATE(FuncDefOp, IsStructCompute);

LLZK_DECLARE_OP_PREDICATE(FuncDefOp, IsStructConstrain);

MLIR_CAPI_EXPORTED MlirValue llzkFuncDefOpGetSelfValueFromCompute(MlirOperation op);

MLIR_CAPI_EXPORTED MlirValue llzkFuncDefOpGetSelfValueFromConstrain(MlirOperation op);

MLIR_CAPI_EXPORTED MlirType llzkFuncDefOpGetSingleResultTypeOfCompute(MlirOperation op);
 
//===----------------------------------------------------------------------===//
// CallOp
//===----------------------------------------------------------------------===//

LLZK_DECLARE_OP_BUILD_METHOD(
    CallOp, intptr_t numResults, MlirType const *results, MlirAttribute name, intptr_t numOperands,
    MlirValue const *operands
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    CallOp, ToCallee, MlirOperation callee, intptr_t numOperands, MlirValue const *operands
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    CallOp, WithMapOperands, intptr_t numResults, MlirType const *results, MlirAttribute name,
    intptr_t numMapOperands, MlirValueRange const *mapOperands, MlirAttribute numDimsPerMap,
    intptr_t numArgOperands, MlirValue const *argOperands
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    CallOp, WithMapOperandsAndDims, intptr_t numResults, MlirType const *results,
    MlirAttribute name, intptr_t numMapOperands, MlirValueRange const *mapOperands,
    intptr_t numDimsPermMapLength, int32_t const *numDimsPerMap, intptr_t numArgOperands,
    MlirValue const *argOperands
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    CallOp, ToCalleeWithMapOperands, MlirOperation callee, intptr_t numMapOperands,
    MlirValueRange const *mapOperands, MlirAttribute numDimsPerMap, intptr_t numArgOperands,
    MlirValue const *argOperands
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    CallOp, ToCalleeWithMapOperandsAndDims, MlirOperation callee, intptr_t numMapOperands,
    MlirValueRange const *mapOperands, intptr_t numDimsPermMapLength, int32_t const *numDimsPerMap,
    intptr_t numArgOperands, MlirValue const *argOperands
);

LLZK_DECLARE_OP_ISA(CallOp);

MLIR_CAPI_EXPORTED MlirType llzkCallOpGetCalleeType(MlirOperation op);

LLZK_DECLARE_OP_PREDICATE(CallOp, CalleeIsCompute);

LLZK_DECLARE_OP_PREDICATE(CallOp, CalleeIsConstrain);

LLZK_DECLARE_OP_PREDICATE(CallOp, CalleeIsStructCompute);

LLZK_DECLARE_OP_PREDICATE(CallOp, CalleeIsStructConstrain);

MLIR_CAPI_EXPORTED MlirValue llzkCallOpGetSelfValueFromCompute(MlirOperation op);

MLIR_CAPI_EXPORTED MlirValue llzkCallOpGetSelfValueFromConstrain(MlirOperation op);

MLIR_CAPI_EXPORTED MlirType llzkCallOpGetSingleResultTypeOfCompute(MlirOperation op);
 
#ifdef __cplusplus
}
#endif
 
#endif