Skip to content

Commit 448f25c

Browse files
zhanghb97zhanghb97
committed
[mlir] Expose affine expression to C API
This patch provides C API for MLIR affine expression. - Implement C API for methods of AffineExpr class. - Implement C API for methods of derived classes (AffineBinaryOpExpr, AffineDimExpr, AffineSymbolExpr, and AffineConstantExpr). Differential Revision: https://reviews.llvm.org/D89856
1 parent 1cab3bf commit 448f25c

File tree

6 files changed

+483
-0
lines changed

6 files changed

+483
-0
lines changed

‎mlir/include/mlir-c/AffineExpr.h

+150
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
/*===-- mlir-c/AffineExpr.h - C API for MLIR Affine Expressions ---*- C -*-===*\
2+
|* *|
3+
|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
4+
|* Exceptions. *|
5+
|* See https://llvm.org/LICENSE.txt for license information. *|
6+
|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
7+
|* *|
8+
\*===----------------------------------------------------------------------===*/
9+
10+
#ifndef MLIR_C_AFFINEEXPR_H
11+
#define MLIR_C_AFFINEEXPR_H
12+
13+
#include "mlir-c/AffineMap.h"
14+
#include "mlir-c/IR.h"
15+
16+
#ifdef __cplusplus
17+
extern "C" {
18+
#endif
19+
20+
DEFINE_C_API_STRUCT(MlirAffineExpr, const void);
21+
22+
/** Gets the context that owns the affine expression. */
23+
MlirContext mlirAffineExprGetContext(MlirAffineExpr affineExpr);
24+
25+
/** Prints an affine expression by sending chunks of the string representation
26+
* and forwarding `userData to `callback`. Note that the callback may be called
27+
* several times with consecutive chunks of the string. */
28+
void mlirAffineExprPrint(MlirAffineExpr affineExpr, MlirStringCallback callback,
29+
void *userData);
30+
31+
/** Prints the affine expression to the standard error stream. */
32+
void mlirAffineExprDump(MlirAffineExpr affineExpr);
33+
34+
/** Checks whether the given affine expression is made out of only symbols and
35+
* constants. */
36+
int mlirAffineExprIsSymbolicOrConstant(MlirAffineExpr affineExpr);
37+
38+
/** Checks whether the given affine expression is a pure affine expression, i.e.
39+
* mul, floordiv, ceildic, and mod is only allowed w.r.t constants. */
40+
int mlirAffineExprIsPureAffine(MlirAffineExpr affineExpr);
41+
42+
/** Returns the greatest known integral divisor of this affine expression. The
43+
* result is always positive. */
44+
int64_t mlirAffineExprGetLargestKnownDivisor(MlirAffineExpr affineExpr);
45+
46+
/** Checks whether the given affine expression is a multiple of 'factor'. */
47+
int mlirAffineExprIsMultipleOf(MlirAffineExpr affineExpr, int64_t factor);
48+
49+
/** Checks whether the given affine expression involves AffineDimExpr
50+
* 'position'. */
51+
int mlirAffineExprIsFunctionOfDim(MlirAffineExpr affineExpr, intptr_t position);
52+
53+
/*============================================================================*/
54+
/* Affine Dimension Expression. */
55+
/*============================================================================*/
56+
57+
/** Creates an affine dimension expression with 'position' in the context. */
58+
MlirAffineExpr mlirAffineDimExprGet(MlirContext ctx, intptr_t position);
59+
60+
/** Returns the position of the given affine dimension expression. */
61+
intptr_t mlirAffineDimExprGetPosition(MlirAffineExpr affineExpr);
62+
63+
/*============================================================================*/
64+
/* Affine Symbol Expression. */
65+
/*============================================================================*/
66+
67+
/** Creates an affine symbol expression with 'position' in the context. */
68+
MlirAffineExpr mlirAffineSymbolExprGet(MlirContext ctx, intptr_t position);
69+
70+
/** Returns the position of the given affine symbol expression. */
71+
intptr_t mlirAffineSymbolExprGetPosition(MlirAffineExpr affineExpr);
72+
73+
/*============================================================================*/
74+
/* Affine Constant Expression. */
75+
/*============================================================================*/
76+
77+
/** Creates an affine constant expression with 'constant' in the context. */
78+
MlirAffineExpr mlirAffineConstantExprGet(MlirContext ctx, int64_t constant);
79+
80+
/** Returns the value of the given affine constant expression. */
81+
int64_t mlirAffineConstantExprGetValue(MlirAffineExpr affineExpr);
82+
83+
/*============================================================================*/
84+
/* Affine Add Expression. */
85+
/*============================================================================*/
86+
87+
/** Checks whether the given affine expression is an add expression. */
88+
int mlirAffineExprIsAAdd(MlirAffineExpr affineExpr);
89+
90+
/** Creates an affine add expression with 'lhs' and 'rhs'. */
91+
MlirAffineExpr mlirAffineAddExprGet(MlirAffineExpr lhs, MlirAffineExpr rhs);
92+
93+
/*============================================================================*/
94+
/* Affine Mul Expression. */
95+
/*============================================================================*/
96+
97+
/** Checks whether the given affine expression is an mul expression. */
98+
int mlirAffineExprIsAMul(MlirAffineExpr affineExpr);
99+
100+
/** Creates an affine mul expression with 'lhs' and 'rhs'. */
101+
MlirAffineExpr mlirAffineMulExprGet(MlirAffineExpr lhs, MlirAffineExpr rhs);
102+
103+
/*============================================================================*/
104+
/* Affine Mod Expression. */
105+
/*============================================================================*/
106+
107+
/** Checks whether the given affine expression is an mod expression. */
108+
int mlirAffineExprIsAMod(MlirAffineExpr affineExpr);
109+
110+
/** Creates an affine mod expression with 'lhs' and 'rhs'. */
111+
MlirAffineExpr mlirAffineModExprGet(MlirAffineExpr lhs, MlirAffineExpr rhs);
112+
113+
/*============================================================================*/
114+
/* Affine FloorDiv Expression. */
115+
/*============================================================================*/
116+
117+
/** Checks whether the given affine expression is an floordiv expression. */
118+
int mlirAffineExprIsAFloorDiv(MlirAffineExpr affineExpr);
119+
120+
/** Creates an affine floordiv expression with 'lhs' and 'rhs'. */
121+
MlirAffineExpr mlirAffineFloorDivExprGet(MlirAffineExpr lhs,
122+
MlirAffineExpr rhs);
123+
124+
/*============================================================================*/
125+
/* Affine CeilDiv Expression. */
126+
/*============================================================================*/
127+
128+
/** Checks whether the given affine expression is an ceildiv expression. */
129+
int mlirAffineExprIsACeilDiv(MlirAffineExpr affineExpr);
130+
131+
/** Creates an affine ceildiv expression with 'lhs' and 'rhs'. */
132+
MlirAffineExpr mlirAffineCeilDivExprGet(MlirAffineExpr lhs, MlirAffineExpr rhs);
133+
134+
/*============================================================================*/
135+
/* Affine Binary Operation Expression. */
136+
/*============================================================================*/
137+
138+
/** Returns the left hand side affine expression of the given affine binary
139+
* operation expression. */
140+
MlirAffineExpr mlirAffineBinaryOpExprGetLHS(MlirAffineExpr affineExpr);
141+
142+
/** Returns the right hand side affine expression of the given affine binary
143+
* operation expression. */
144+
MlirAffineExpr mlirAffineBinaryOpExprGetRHS(MlirAffineExpr affineExpr);
145+
146+
#ifdef __cplusplus
147+
}
148+
#endif
149+
150+
#endif // MLIR_C_AFFINEEXPR_H

‎mlir/include/mlir/CAPI/AffineExpr.h

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
//===- AffineExpr.h - C API Utils for Affine Expressions --------*- C++ -*-===//
2+
//
3+
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4+
// See https://llvm.org/LICENSE.txt for license information.
5+
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6+
//
7+
//===----------------------------------------------------------------------===//
8+
//
9+
// This file contains declarations of implementation details of the C API for
10+
// MLIR Affine Expression. This file should not be included from C++ code other
11+
// than C API implementation nor from C code.
12+
//
13+
//===----------------------------------------------------------------------===//
14+
15+
#ifndef MLIR_CAPI_AFFINEEXPR_H
16+
#define MLIR_CAPI_AFFINEEXPR_H
17+
18+
#include "mlir-c/AffineExpr.h"
19+
#include "mlir/CAPI/Wrap.h"
20+
#include "mlir/IR/AffineExpr.h"
21+
22+
DEFINE_C_API_METHODS(MlirAffineExpr, mlir::AffineExpr)
23+
24+
#endif // MLIR_CAPI_AFFINEEXPR_H

‎mlir/include/mlir/IR/AffineExpr.h

+9
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,15 @@ class AffineExpr {
164164

165165
friend ::llvm::hash_code hash_value(AffineExpr arg);
166166

167+
/// Methods supporting C API.
168+
const void *getAsOpaquePointer() const {
169+
return static_cast<const void *>(expr);
170+
}
171+
static AffineExpr getFromOpaquePointer(const void *pointer) {
172+
return AffineExpr(
173+
reinterpret_cast<ImplType *>(const_cast<void *>(pointer)));
174+
}
175+
167176
protected:
168177
ImplType *expr;
169178
};

‎mlir/lib/CAPI/IR/AffineExpr.cpp

+169
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
//===- AffineExpr.cpp - C API for MLIR Affine Expressions -----------------===//
2+
//
3+
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4+
// See https://llvm.org/LICENSE.txt for license information.
5+
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6+
//
7+
//===----------------------------------------------------------------------===//
8+
9+
#include "mlir-c/AffineExpr.h"
10+
#include "mlir-c/AffineMap.h"
11+
#include "mlir-c/IR.h"
12+
#include "mlir/CAPI/AffineExpr.h"
13+
#include "mlir/CAPI/AffineMap.h"
14+
#include "mlir/CAPI/IR.h"
15+
#include "mlir/CAPI/Utils.h"
16+
#include "mlir/IR/AffineExpr.h"
17+
18+
using namespace mlir;
19+
20+
MlirContext mlirAffineExprGetContext(MlirAffineExpr affineExpr) {
21+
return wrap(unwrap(affineExpr).getContext());
22+
}
23+
24+
void mlirAffineExprPrint(MlirAffineExpr affineExpr, MlirStringCallback callback,
25+
void *userData) {
26+
mlir::detail::CallbackOstream stream(callback, userData);
27+
unwrap(affineExpr).print(stream);
28+
stream.flush();
29+
}
30+
31+
void mlirAffineExprDump(MlirAffineExpr affineExpr) {
32+
unwrap(affineExpr).dump();
33+
}
34+
35+
int mlirAffineExprIsSymbolicOrConstant(MlirAffineExpr affineExpr) {
36+
return unwrap(affineExpr).isSymbolicOrConstant();
37+
}
38+
39+
int mlirAffineExprIsPureAffine(MlirAffineExpr affineExpr) {
40+
return unwrap(affineExpr).isPureAffine();
41+
}
42+
43+
int64_t mlirAffineExprGetLargestKnownDivisor(MlirAffineExpr affineExpr) {
44+
return unwrap(affineExpr).getLargestKnownDivisor();
45+
}
46+
47+
int mlirAffineExprIsMultipleOf(MlirAffineExpr affineExpr, int64_t factor) {
48+
return unwrap(affineExpr).isMultipleOf(factor);
49+
}
50+
51+
int mlirAffineExprIsFunctionOfDim(MlirAffineExpr affineExpr,
52+
intptr_t position) {
53+
return unwrap(affineExpr).isFunctionOfDim(position);
54+
}
55+
56+
/*============================================================================*/
57+
/* Affine Dimension Expression. */
58+
/*============================================================================*/
59+
60+
MlirAffineExpr mlirAffineDimExprGet(MlirContext ctx, intptr_t position) {
61+
return wrap(getAffineDimExpr(position, unwrap(ctx)));
62+
}
63+
64+
intptr_t mlirAffineDimExprGetPosition(MlirAffineExpr affineExpr) {
65+
return unwrap(affineExpr).cast<AffineDimExpr>().getPosition();
66+
}
67+
68+
/*============================================================================*/
69+
/* Affine Symbol Expression. */
70+
/*============================================================================*/
71+
72+
MlirAffineExpr mlirAffineSymbolExprGet(MlirContext ctx, intptr_t position) {
73+
return wrap(getAffineSymbolExpr(position, unwrap(ctx)));
74+
}
75+
76+
intptr_t mlirAffineSymbolExprGetPosition(MlirAffineExpr affineExpr) {
77+
return unwrap(affineExpr).cast<AffineSymbolExpr>().getPosition();
78+
}
79+
80+
/*============================================================================*/
81+
/* Affine Constant Expression. */
82+
/*============================================================================*/
83+
84+
MlirAffineExpr mlirAffineConstantExprGet(MlirContext ctx, int64_t constant) {
85+
return wrap(getAffineConstantExpr(constant, unwrap(ctx)));
86+
}
87+
88+
int64_t mlirAffineConstantExprGetValue(MlirAffineExpr affineExpr) {
89+
return unwrap(affineExpr).cast<AffineConstantExpr>().getValue();
90+
}
91+
92+
/*============================================================================*/
93+
/* Affine Add Expression. */
94+
/*============================================================================*/
95+
96+
int mlirAffineExprIsAAdd(MlirAffineExpr affineExpr) {
97+
return unwrap(affineExpr).getKind() == mlir::AffineExprKind::Add;
98+
}
99+
100+
MlirAffineExpr mlirAffineAddExprGet(MlirAffineExpr lhs, MlirAffineExpr rhs) {
101+
return wrap(getAffineBinaryOpExpr(mlir::AffineExprKind::Add, unwrap(lhs),
102+
unwrap(rhs)));
103+
}
104+
105+
/*============================================================================*/
106+
/* Affine Mul Expression. */
107+
/*============================================================================*/
108+
109+
int mlirAffineExprIsAMul(MlirAffineExpr affineExpr) {
110+
return unwrap(affineExpr).getKind() == mlir::AffineExprKind::Mul;
111+
}
112+
113+
MlirAffineExpr mlirAffineMulExprGet(MlirAffineExpr lhs, MlirAffineExpr rhs) {
114+
return wrap(getAffineBinaryOpExpr(mlir::AffineExprKind::Mul, unwrap(lhs),
115+
unwrap(rhs)));
116+
}
117+
118+
/*============================================================================*/
119+
/* Affine Mod Expression. */
120+
/*============================================================================*/
121+
122+
int mlirAffineExprIsAMod(MlirAffineExpr affineExpr) {
123+
return unwrap(affineExpr).getKind() == mlir::AffineExprKind::Mod;
124+
}
125+
126+
MlirAffineExpr mlirAffineModExprGet(MlirAffineExpr lhs, MlirAffineExpr rhs) {
127+
return wrap(getAffineBinaryOpExpr(mlir::AffineExprKind::Mod, unwrap(lhs),
128+
unwrap(rhs)));
129+
}
130+
131+
/*============================================================================*/
132+
/* Affine FloorDiv Expression. */
133+
/*============================================================================*/
134+
135+
int mlirAffineExprIsAFloorDiv(MlirAffineExpr affineExpr) {
136+
return unwrap(affineExpr).getKind() == mlir::AffineExprKind::FloorDiv;
137+
}
138+
139+
MlirAffineExpr mlirAffineFloorDivExprGet(MlirAffineExpr lhs,
140+
MlirAffineExpr rhs) {
141+
return wrap(getAffineBinaryOpExpr(mlir::AffineExprKind::FloorDiv, unwrap(lhs),
142+
unwrap(rhs)));
143+
}
144+
145+
/*============================================================================*/
146+
/* Affine CeilDiv Expression. */
147+
/*============================================================================*/
148+
149+
int mlirAffineExprIsACeilDiv(MlirAffineExpr affineExpr) {
150+
return unwrap(affineExpr).getKind() == mlir::AffineExprKind::CeilDiv;
151+
}
152+
153+
MlirAffineExpr mlirAffineCeilDivExprGet(MlirAffineExpr lhs,
154+
MlirAffineExpr rhs) {
155+
return wrap(getAffineBinaryOpExpr(mlir::AffineExprKind::CeilDiv, unwrap(lhs),
156+
unwrap(rhs)));
157+
}
158+
159+
/*============================================================================*/
160+
/* Affine Binary Operation Expression. */
161+
/*============================================================================*/
162+
163+
MlirAffineExpr mlirAffineBinaryOpExprGetLHS(MlirAffineExpr affineExpr) {
164+
return wrap(unwrap(affineExpr).cast<AffineBinaryOpExpr>().getLHS());
165+
}
166+
167+
MlirAffineExpr mlirAffineBinaryOpExprGetRHS(MlirAffineExpr affineExpr) {
168+
return wrap(unwrap(affineExpr).cast<AffineBinaryOpExpr>().getRHS());
169+
}

‎mlir/lib/CAPI/IR/CMakeLists.txt

+1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Main API.
22
add_mlir_library(MLIRCAPIIR
3+
AffineExpr.cpp
34
AffineMap.cpp
45
Diagnostics.cpp
56
IR.cpp

0 commit comments

Comments
 (0)