Struct.h

Go to the documentation of this file.

//===-- Struct.h - C API for Struct 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
// Struct 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_STRUCT_H
#define LLZK_C_DIALECT_STRUCT_H
 
#include "llzk-c/Support.h"
 
#include <mlir-c/AffineMap.h>
#include <mlir-c/IR.h>
#include <mlir-c/Support.h>
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
MLIR_DECLARE_CAPI_DIALECT_REGISTRATION(Struct, llzk__component);
 
//===----------------------------------------------------------------------===//
// StructType
//===----------------------------------------------------------------------===//

MLIR_CAPI_EXPORTED MlirType llzkStructTypeGet(MlirAttribute name);

MLIR_CAPI_EXPORTED
MlirType llzkStructTypeGetWithArrayAttr(MlirAttribute name, MlirAttribute params);

MLIR_CAPI_EXPORTED MlirType
llzkStructTypeGetWithAttrs(MlirAttribute name, intptr_t numParams, MlirAttribute const *params);

LLZK_DECLARE_TYPE_ISA(StructType);

MLIR_CAPI_EXPORTED MlirAttribute llzkStructTypeGetName(MlirType type);

MLIR_CAPI_EXPORTED MlirAttribute llzkStructTypeGetParams(MlirType type);
 
//===----------------------------------------------------------------------===//
// StructDefOp
//===----------------------------------------------------------------------===//

LLZK_DECLARE_OP_ISA(StructDefOp);

MLIR_CAPI_EXPORTED MlirType llzkStructDefOpGetType(MlirOperation op);

MLIR_CAPI_EXPORTED MlirType
llzkStructDefOpGetTypeWithParams(MlirOperation op, MlirAttribute params);

MLIR_CAPI_EXPORTED MlirOperation llzkStructDefOpGetFieldDef(MlirOperation op, MlirStringRef name);

MLIR_CAPI_EXPORTED void llzkStructDefOpGetFieldDefs(MlirOperation op, MlirOperation *dst);

MLIR_CAPI_EXPORTED intptr_t llzkStructDefOpGetNumFieldDefs(MlirOperation op);

MlirLogicalResult llzkStructDefOpGetHasColumns(MlirOperation op);

MLIR_CAPI_EXPORTED MlirOperation llzkStructDefOpGetComputeFuncOp(MlirOperation op);

MLIR_CAPI_EXPORTED MlirOperation llzkStructDefOpGetConstrainFuncOp(MlirOperation op);

MLIR_CAPI_EXPORTED const char *
llzkStructDefOpGetHeaderString(MlirOperation op, intptr_t *dstSize, char *(*alloc_string)(size_t));

LLZK_DECLARE_NARY_OP_PREDICATE(StructDefOp, HasParamName, MlirStringRef name);

MLIR_CAPI_EXPORTED MlirAttribute llzkStructDefOpGetFullyQualifiedName(MlirOperation op);

LLZK_DECLARE_OP_PREDICATE(StructDefOp, IsMainComponent);
 
//===----------------------------------------------------------------------===//
// FieldDefOp
//===----------------------------------------------------------------------===//

LLZK_DECLARE_OP_ISA(FieldDefOp);

LLZK_DECLARE_OP_PREDICATE(FieldDefOp, HasPublicAttr);

MLIR_CAPI_EXPORTED void llzkFieldDefOpSetPublicAttr(MlirOperation op, bool value);
 
//===----------------------------------------------------------------------===//
// FieldReadOp
//===----------------------------------------------------------------------===//

LLZK_DECLARE_OP_BUILD_METHOD(
    FieldReadOp, MlirType type, MlirValue component, MlirStringRef fieldName
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    FieldReadOp, WithAffineMapDistance, MlirType type, MlirValue component, MlirStringRef fieldName,
    MlirAffineMap affineMap, MlirValueRange mapOperands, int32_t nDimensions
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    FieldReadOp, WithConstParamDistance, MlirType type, MlirValue component,
    MlirStringRef fieldName, MlirStringRef paramName
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    FieldReadOp, WithLiteralDistance, MlirType type, MlirValue component, MlirStringRef fieldName,
    int64_t distance
);
 
#ifdef __cplusplus
}
#endif
 
#endif