Support.h

Go to the documentation of this file.

//===-- Support.h - C API general utilities -----------------------*- 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 utilities for working with the C API.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLZK_C_IR_H
#define LLZK_C_IR_H
 
#include "llzk-c/Builder.h" // IWYU pragma: keep
 
#include <mlir-c/IR.h> // IWYU pragma: keep
#include <mlir-c/Support.h>
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
//===----------------------------------------------------------------------===//
// Utility macros for function declarations.
//===----------------------------------------------------------------------===//
 
#define LLZK_BUILD_METHOD_NAME(op, suffix) llzk##op##Build##suffix
#define LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(op, suffix, ...)                                       \
  MLIR_CAPI_EXPORTED MlirOperation LLZK_BUILD_METHOD_NAME(op, suffix)(                             \
      MlirOpBuilder builder, MlirLocation location, __VA_ARGS__                                    \
  )
// Used for when the build method is "general" and does not have a suffix at the end.
#define LLZK_DECLARE_OP_BUILD_METHOD(op, ...) LLZK_DECLARE_SUFFIX_OP_BUILD_METHOD(op, , __VA_ARGS__)
 
#define LLZK_DECLARE_PREDICATE(name, ...) MLIR_CAPI_EXPORTED bool llzk##name(__VA_ARGS__)
 
#define LLZK_DECLARE_OP_PREDICATE(op, name)                                                        \
  MLIR_CAPI_EXPORTED bool llzk##op##Get##name(MlirOperation op)
#define LLZK_DECLARE_NARY_OP_PREDICATE(op, name, ...)                                              \
  MLIR_CAPI_EXPORTED bool llzk##op##Get##name(MlirOperation op, __VA_ARGS__)
 
#define LLZK_DECLARE_ISA(what, root) MLIR_CAPI_EXPORTED bool llzk##root##IsA##what(Mlir##root what)
#define LLZK_DECLARE_TYPE_ISA(what) LLZK_DECLARE_ISA(what, Type)
#define LLZK_DECLARE_OP_ISA(what) LLZK_DECLARE_ISA(what, Operation)
#define LLZK_DECLARE_ATTR_ISA(what) LLZK_DECLARE_ISA(what, Attribute)
 
//===----------------------------------------------------------------------===//
// Representation of a mlir::ValueRange.
//===----------------------------------------------------------------------===//
 
struct MlirValueRange {
  MlirValue const *values;
  intptr_t size;
};
typedef struct MlirValueRange MlirValueRange;
 
//===----------------------------------------------------------------------===//
// Symbol lookup result.
//===----------------------------------------------------------------------===//
 
typedef struct LlzkSymbolLookupResult {
  void *ptr;
} LlzkSymbolLookupResult;

MLIR_CAPI_EXPORTED void llzkSymbolLookupResultDestroy(LlzkSymbolLookupResult result);

MLIR_CAPI_EXPORTED MlirOperation LlzkSymbolLookupResultGetOperation(LlzkSymbolLookupResult result);
 
//===----------------------------------------------------------------------===//
// MLIR ports.
//===----------------------------------------------------------------------===//

MLIR_CAPI_EXPORTED void
mlirOperationReplaceUsesOfWith(MlirOperation op, MlirValue of, MlirValue with);
 
//===----------------------------------------------------------------------===//
// CAPI support of additional MLIR functionality.
//===----------------------------------------------------------------------===//

MLIR_CAPI_EXPORTED
void mlirOperationWalkReverse(
    MlirOperation from, MlirOperationWalkCallback callback, void *userData, MlirWalkOrder walkOrder
);
 
//===----------------------------------------------------------------------===//
// Helper types and functions for map operands constructor arguments.
//===----------------------------------------------------------------------===//

typedef struct LlzkAffineMapOperandsBuilder {
  intptr_t nMapOperands;
  // A list of lists of Values. The outer list is owned by this struct but the inner lists
  // are not and are considered views (similar to the C++ `ValueRange` class).
  MlirValueRange *mapOperands;
  intptr_t nDimsPerMap;
  union {
    MlirAttribute attr;
    int32_t *array;
  } dimsPerMap;
} LlzkAffineMapOperandsBuilder;

MLIR_CAPI_EXPORTED LlzkAffineMapOperandsBuilder llzkAffineMapOperandsBuilderCreate(void);

MLIR_CAPI_EXPORTED void llzkAffineMapOperandsBuilderDestroy(LlzkAffineMapOperandsBuilder *builder);

MLIR_CAPI_EXPORTED void llzkAffineMapOperandsBuilderAppendOperands(
    LlzkAffineMapOperandsBuilder *builder, intptr_t n, MlirValueRange const *mapOperands
);

MLIR_CAPI_EXPORTED void llzkAffineMapOperandsBuilderAppendOperandsWithDimCount(
    LlzkAffineMapOperandsBuilder *builder, intptr_t n, MlirValueRange const *mapOperands,
    int32_t const *dimsPerMap
);

MLIR_CAPI_EXPORTED void llzkAffineMapOperandsBuilderAppendDimCount(
    LlzkAffineMapOperandsBuilder *builder, intptr_t n, int32_t const *dimsPerMap
);

MLIR_CAPI_EXPORTED void llzkAffineMapOperandsBuilderSetDimsPerMapFromAttr(
    LlzkAffineMapOperandsBuilder *builder, MlirAttribute attribute
);

MLIR_CAPI_EXPORTED void
llzkAffineMapOperandsBuilderConvertDimsPerMapToArray(LlzkAffineMapOperandsBuilder *builder);

MLIR_CAPI_EXPORTED void llzkAffineMapOperandsBuilderConvertDimsPerMapToAttr(
    LlzkAffineMapOperandsBuilder *builder, MlirContext context
);

MLIR_CAPI_EXPORTED MlirAttribute llzkAffineMapOperandsBuilderGetDimsPerMapAttr(
    LlzkAffineMapOperandsBuilder builder, MlirContext context
);
 
#ifdef __cplusplus
}
#endif
 
#endif