Felt.h

Go to the documentation of this file.

//===-- Felt.h - C API for Felt 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
// Felt 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_FELT_H
#define LLZK_C_DIALECT_FELT_H
 
#include <mlir-c/IR.h>
 
// Include the generated CAPI
#include "llzk/Dialect/Felt/IR/Attrs.capi.h.inc"
#include "llzk/Dialect/Felt/IR/Ops.capi.h.inc"
#include "llzk/Dialect/Felt/IR/Types.capi.h.inc"
 
#ifdef __cplusplus
extern "C" {
#endif

MLIR_DECLARE_CAPI_DIALECT_REGISTRATION(Felt, llzk__felt);
 
//===----------------------------------------------------------------------===//
// FeltConstAttr
//===----------------------------------------------------------------------===//

MLIR_CAPI_EXPORTED MlirAttribute
llzkFelt_FeltConstAttrGetInField(MlirContext ctx, int64_t value, MlirStringRef fieldName);

MLIR_CAPI_EXPORTED MlirAttribute
llzkFelt_FeltConstAttrGetUnspecified(MlirContext ctx, int64_t value);

MLIR_CAPI_EXPORTED MlirAttribute
llzkFelt_FeltConstAttrGetWithBits(MlirContext ctx, unsigned numBits, int64_t value, MlirType type);

MLIR_CAPI_EXPORTED MlirAttribute llzkFelt_FeltConstAttrGetWithBitsInField(
    MlirContext ctx, unsigned numBits, int64_t value, MlirStringRef fieldName
);

MLIR_CAPI_EXPORTED MlirAttribute
llzkFelt_FeltConstAttrGetWithBitsUnspecified(MlirContext ctx, unsigned numBits, int64_t value);

MLIR_CAPI_EXPORTED MlirAttribute llzkFelt_FeltConstAttrGetFromString(
    MlirContext ctx, unsigned numBits, MlirStringRef str, MlirType type
);

MLIR_CAPI_EXPORTED MlirAttribute llzkFelt_FeltConstAttrGetFromStringInField(
    MlirContext ctx, unsigned numBits, MlirStringRef str, MlirStringRef fieldName
);

MLIR_CAPI_EXPORTED MlirAttribute llzkFelt_FeltConstAttrGetFromStringUnspecified(
    MlirContext ctx, unsigned numBits, MlirStringRef str
);

MLIR_CAPI_EXPORTED MlirAttribute llzkFelt_FeltConstAttrGetFromParts(
    MlirContext ctx, unsigned numBits, const uint64_t *parts, intptr_t nParts, MlirType type
);

MLIR_CAPI_EXPORTED MlirAttribute llzkFelt_FeltConstAttrGetFromPartsInField(
    MlirContext ctx, unsigned numBits, const uint64_t *parts, intptr_t nParts,
    MlirStringRef fieldName
);

MLIR_CAPI_EXPORTED MlirAttribute llzkFelt_FeltConstAttrGetFromPartsUnspecified(
    MlirContext ctx, unsigned numBits, const uint64_t *parts, intptr_t nParts
);
 
//===----------------------------------------------------------------------===//
// FieldSpecAttr
//===----------------------------------------------------------------------===//

MLIR_CAPI_EXPORTED MlirAttribute llzkFelt_FieldSpecAttrGetFromString(
    MlirContext ctx, MlirIdentifier fieldName, unsigned numBits, MlirStringRef primeStr
);

MLIR_CAPI_EXPORTED MlirAttribute llzkFelt_FieldSpecAttrGetFromParts(
    MlirContext ctx, MlirIdentifier fieldName, unsigned numBits, const uint64_t *parts,
    intptr_t nParts
);
 
//===----------------------------------------------------------------------===//
// FeltType
//===----------------------------------------------------------------------===//

MLIR_CAPI_EXPORTED MlirType llzkFelt_FeltTypeGetUnspecified(MlirContext ctx);

MLIR_CAPI_EXPORTED MlirType llzkFelt_FeltTypeGetFromRef(MlirContext ctx, MlirStringRef fieldName);
 
#ifdef __cplusplus
}
#endif
 
#endif // LLZK_C_DIALECT_FELT_H