POD.h

Go to the documentation of this file.

//===-- POD.h - C API for POD dialect -----------------------------*- C -*-===//
//
// Part of the LLZK Project, under the Apache License v2.0.
// See LICENSE.txt for license information.
// Copyright 2026 Project LLZK
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
//
// This header declares the C interface for registering and accessing the
// POD 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_POD_H
#define LLZK_C_DIALECT_POD_H
 
#include "llzk-c/Support.h"
 
#include <mlir-c/BuiltinAttributes.h>
#include <mlir-c/IR.h>
#include <mlir-c/Support.h>
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
MLIR_DECLARE_CAPI_DIALECT_REGISTRATION(POD, llzk__pod);
 
//===----------------------------------------------------------------------===//
// Auxiliary types
//===----------------------------------------------------------------------===//
 
typedef struct LlzkRecordValue {
  MlirStringRef name;
  MlirValue value;
} LlzkRecordValue;
 
//===----------------------------------------------------------------------===//
// RecordAttr
//===----------------------------------------------------------------------===//

MLIR_CAPI_EXPORTED MlirAttribute llzkRecordAttrGet(MlirStringRef name, MlirType type);

LLZK_DECLARE_ATTR_ISA(RecordAttr);

MLIR_CAPI_EXPORTED MlirStringRef llzkRecordAttrGetName(MlirAttribute attr);

MLIR_CAPI_EXPORTED MlirAttribute llzkRecordAttrGetNameSym(MlirAttribute attr);

MLIR_CAPI_EXPORTED MlirType llzkRecordAttrGetType(MlirAttribute attr);
 
//===----------------------------------------------------------------------===//
// PodType
//===----------------------------------------------------------------------===//

MLIR_CAPI_EXPORTED MlirType
llzkPodTypeGet(MlirContext context, intptr_t nRecords, MlirAttribute const *records);

MLIR_CAPI_EXPORTED MlirType llzkPodTypeGetFromInitialValues(
    MlirContext context, intptr_t nRecords, LlzkRecordValue const *records
);

LLZK_DECLARE_TYPE_ISA(PodType);

MLIR_CAPI_EXPORTED intptr_t llzkPodTypeGetNumRecords(MlirType type);

MLIR_CAPI_EXPORTED void llzkPodTypeGetRecords(MlirType type, MlirAttribute *dst);

MLIR_CAPI_EXPORTED MlirAttribute llzkPodTypeGetNthRecord(MlirType type, intptr_t n);

MLIR_CAPI_EXPORTED MlirType llzkPodTypeLookupRecord(MlirType type, MlirStringRef name);

MLIR_CAPI_EXPORTED MlirType
llzkPodTypeLookupRecordWithinLocation(MlirType type, MlirStringRef name, MlirLocation loc);

MLIR_CAPI_EXPORTED MlirType
llzkPodTypeLookupRecordWithinOperation(MlirType type, MlirStringRef name, MlirOperation op);
 
//===----------------------------------------------------------------------===//
// NewPodOp
//===----------------------------------------------------------------------===//

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    NewPodOp, InferredFromInitialValues, intptr_t nValues, LlzkRecordValue const *values
);

LLZK_DECLARE_OP_BUILD_METHOD(
    NewPodOp, MlirType type, intptr_t nValues, LlzkRecordValue const *values
);

LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(
    NewPodOp, WithMapOperands, MlirType type, intptr_t nValues, LlzkRecordValue const *values,
    LlzkAffineMapOperandsBuilder mapOperands
);

LLZK_DECLARE_OP_ISA(NewPodOp);
 
//===----------------------------------------------------------------------===//
// ReadPodOp
//===----------------------------------------------------------------------===//

LLZK_DECLARE_OP_ISA(ReadPodOp);
 
//===----------------------------------------------------------------------===//
// WritePodOp
//===----------------------------------------------------------------------===//

LLZK_DECLARE_OP_ISA(WritePodOp);
 
#ifdef __cplusplus
}
#endif
 
#endif