Skip to content

Commit 6d85777

Browse files
Jezurkobcardosolopes
Jezurko
and
bcardosolopes
authored
Backport fix for importing of global ctors/dtors and llvm.mlir.alias op linkage fix (#42)
* [MLIR][LLVMIR] Add support for the full form of global_{ctor,dtor} (llvm#133176) Currently only ctor/dtor list and their priorities are supported. This PR adds support for the missing data field. Few implementation notes: - The assembly printer has a fixed form because previous `attr_dict` will sort the dict by key name, making global_dtor and global_ctor differ in the order of printed arguments. - LLVM's `ptr null` is being converted to `#llvm.zero` otherwise we'd have to create a region to use the default operation conversion from `ptr null`, which is silly given that the field only support null or a symbol. * [MLIR][LLVM] Add weak_odr to allowed linkage for alias (llvm#132840) I missed this when originally introduced the feature (note the verifier message already contains it), this fixes a small bug. --------- Co-authored-by: Bruno Cardoso Lopes <[email protected]>
1 parent 17ae776 commit 6d85777

File tree

13 files changed

+132
-76
lines changed

13 files changed

+132
-76
lines changed

‎flang/lib/Optimizer/Transforms/CUFAddConstructor.cpp

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
#include "flang/Runtime/CUDA/registration.h"
2424
#include "flang/Runtime/entry-names.h"
2525
#include "mlir/Dialect/GPU/IR/GPUDialect.h"
26+
#include "mlir/Dialect/LLVMIR/LLVMAttrs.h"
2627
#include "mlir/Dialect/LLVMIR/LLVMDialect.h"
2728
#include "mlir/IR/Value.h"
2829
#include "mlir/Pass/Pass.h"
@@ -157,10 +158,12 @@ struct CUFAddConstructor
157158
funcs.push_back(
158159
mlir::FlatSymbolRefAttr::get(mod.getContext(), func.getSymName()));
159160
llvm::SmallVector<int> priorities;
161+
llvm::SmallVector<mlir::Attribute> data;
160162
priorities.push_back(0);
163+
data.push_back(mlir::LLVM::ZeroAttr::get(mod.getContext()));
161164
builder.create<mlir::LLVM::GlobalCtorsOp>(
162165
mod.getLoc(), builder.getArrayAttr(funcs),
163-
builder.getI32ArrayAttr(priorities));
166+
builder.getI32ArrayAttr(priorities), builder.getArrayAttr(data));
164167
}
165168
};
166169

‎flang/test/Fir/CUDA/cuda-constructor.f90

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ program main
99
! CHECK: llvm.call @_FortranACUFRegisterAllocator() : () -> ()
1010
! CHECK: llvm.return
1111
! CHECK: }
12-
! CHECK: llvm.mlir.global_ctors {ctors = [@__cudaFortranConstructor], priorities = [0 : i32]}
12+
! CHECK: llvm.mlir.global_ctors ctors = [@__cudaFortranConstructor], priorities = [0 : i32], data = [#llvm.zero]

‎mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td

Lines changed: 34 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1438,61 +1438,73 @@ def LLVM_GlobalOp : LLVM_Op<"mlir.global",
14381438

14391439
def LLVM_GlobalCtorsOp : LLVM_Op<"mlir.global_ctors", [
14401440
DeclareOpInterfaceMethods<SymbolUserOpInterface>]> {
1441-
let arguments = (ins FlatSymbolRefArrayAttr
1442-
: $ctors, I32ArrayAttr
1443-
: $priorities);
1441+
let arguments = (ins FlatSymbolRefArrayAttr:$ctors,
1442+
I32ArrayAttr:$priorities,
1443+
ArrayAttr:$data);
14441444
let summary = "LLVM dialect global_ctors.";
14451445
let description = [{
1446-
Specifies a list of constructor functions and priorities. The functions
1447-
referenced by this array will be called in ascending order of priority (i.e.
1448-
lowest first) when the module is loaded. The order of functions with the
1449-
same priority is not defined. This operation is translated to LLVM's
1450-
global_ctors global variable. The initializer functions are run at load
1451-
time. The `data` field present in LLVM's global_ctors variable is not
1452-
modeled here.
1446+
Specifies a list of constructor functions, priorities, and associated data.
1447+
The functions referenced by this array will be called in ascending order
1448+
of priority (i.e. lowest first) when the module is loaded. The order of
1449+
functions with the same priority is not defined. This operation is
1450+
translated to LLVM's global_ctors global variable. The initializer
1451+
functions are run at load time. However, if the associated data is not
1452+
`#llvm.zero`, functions only run if the data is not discarded.
14531453

14541454
Examples:
14551455

14561456
```mlir
1457-
llvm.mlir.global_ctors {@ctor}
1458-
14591457
llvm.func @ctor() {
14601458
...
14611459
llvm.return
14621460
}
1461+
llvm.mlir.global_ctors ctors = [@ctor], priorities = [0],
1462+
data = [#llvm.zero]
14631463
```
14641464

14651465
}];
1466-
let assemblyFormat = "attr-dict";
1466+
let assemblyFormat = [{
1467+
`ctors` `=` $ctors
1468+
`,` `priorities` `=` $priorities
1469+
`,` `data` `=` $data
1470+
attr-dict
1471+
}];
14671472
let hasVerifier = 1;
14681473
}
14691474

14701475
def LLVM_GlobalDtorsOp : LLVM_Op<"mlir.global_dtors", [
14711476
DeclareOpInterfaceMethods<SymbolUserOpInterface>]> {
14721477
let arguments = (ins
14731478
FlatSymbolRefArrayAttr:$dtors,
1474-
I32ArrayAttr:$priorities
1479+
I32ArrayAttr:$priorities,
1480+
ArrayAttr:$data
14751481
);
14761482
let summary = "LLVM dialect global_dtors.";
14771483
let description = [{
14781484
Specifies a list of destructor functions and priorities. The functions
1479-
referenced by this array will be called in descending order of priority (i.e.
1480-
highest first) when the module is unloaded. The order of functions with the
1481-
same priority is not defined. This operation is translated to LLVM's
1482-
global_dtors global variable. The `data` field present in LLVM's
1483-
global_dtors variable is not modeled here.
1485+
referenced by this array will be called in descending order of priority
1486+
(i.e. highest first) when the module is unloaded. The order of functions
1487+
with the same priority is not defined. This operation is translated to
1488+
LLVM's global_dtors global variable. The destruction functions are run at
1489+
load time. However, if the associated data is not `#llvm.zero`, functions
1490+
only run if the data is not discarded.
14841491

14851492
Examples:
14861493

14871494
```mlir
14881495
llvm.func @dtor() {
14891496
llvm.return
14901497
}
1491-
llvm.mlir.global_dtors {@dtor}
1498+
llvm.mlir.global_dtors dtors = [@dtor], priorities = [0],
1499+
data = [#llvm.zero]
14921500
```
1493-
14941501
}];
1495-
let assemblyFormat = "attr-dict";
1502+
let assemblyFormat = [{
1503+
`dtors` `=` $dtors
1504+
`,` `priorities` `=` $priorities
1505+
`,` `data` `=` $data
1506+
attr-dict
1507+
}];
14961508
let hasVerifier = 1;
14971509
}
14981510

‎mlir/lib/Dialect/LLVMIR/IR/LLVMDialect.cpp

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2461,6 +2461,17 @@ LogicalResult GlobalOp::verifyRegions() {
24612461
// LLVM::GlobalCtorsOp
24622462
//===----------------------------------------------------------------------===//
24632463

2464+
LogicalResult checkGlobalXtorData(Operation *op, ArrayAttr data) {
2465+
if (data.empty())
2466+
return success();
2467+
2468+
if (llvm::all_of(data.getAsRange<Attribute>(), [](Attribute v) {
2469+
return isa<FlatSymbolRefAttr, ZeroAttr>(v);
2470+
}))
2471+
return success();
2472+
return op->emitError("data element must be symbol or #llvm.zero");
2473+
}
2474+
24642475
LogicalResult
24652476
GlobalCtorsOp::verifySymbolUses(SymbolTableCollection &symbolTable) {
24662477
for (Attribute ctor : getCtors()) {
@@ -2472,10 +2483,14 @@ GlobalCtorsOp::verifySymbolUses(SymbolTableCollection &symbolTable) {
24722483
}
24732484

24742485
LogicalResult GlobalCtorsOp::verify() {
2475-
if (getCtors().size() != getPriorities().size())
2476-
return emitError(
2477-
"mismatch between the number of ctors and the number of priorities");
2478-
return success();
2486+
if (checkGlobalXtorData(*this, getData()).failed())
2487+
return failure();
2488+
2489+
if (getCtors().size() == getPriorities().size() &&
2490+
getCtors().size() == getData().size())
2491+
return success();
2492+
return emitError(
2493+
"ctors, priorities, and data must have the same number of elements");
24792494
}
24802495

24812496
//===----------------------------------------------------------------------===//
@@ -2493,10 +2508,14 @@ GlobalDtorsOp::verifySymbolUses(SymbolTableCollection &symbolTable) {
24932508
}
24942509

24952510
LogicalResult GlobalDtorsOp::verify() {
2496-
if (getDtors().size() != getPriorities().size())
2497-
return emitError(
2498-
"mismatch between the number of dtors and the number of priorities");
2499-
return success();
2511+
if (checkGlobalXtorData(*this, getData()).failed())
2512+
return failure();
2513+
2514+
if (getDtors().size() == getPriorities().size() &&
2515+
getDtors().size() == getData().size())
2516+
return success();
2517+
return emitError(
2518+
"dtors, priorities, and data must have the same number of elements");
25002519
}
25012520

25022521
//===----------------------------------------------------------------------===//
@@ -2599,6 +2618,7 @@ LogicalResult AliasOp::verify() {
25992618
case Linkage::Internal:
26002619
case Linkage::Private:
26012620
case Linkage::Weak:
2621+
case Linkage::WeakODR:
26022622
case Linkage::Linkonce:
26032623
case Linkage::LinkonceODR:
26042624
case Linkage::AvailableExternally:

‎mlir/lib/Target/LLVMIR/ModuleImport.cpp

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1115,6 +1115,7 @@ ModuleImport::convertGlobalCtorsAndDtors(llvm::GlobalVariable *globalVar) {
11151115

11161116
SmallVector<Attribute> funcs;
11171117
SmallVector<int32_t> priorities;
1118+
SmallVector<Attribute> dataList;
11181119
for (llvm::Value *operand : initializer->operands()) {
11191120
auto *aggregate = dyn_cast<llvm::ConstantAggregate>(operand);
11201121
if (!aggregate || aggregate->getNumOperands() != 3)
@@ -1126,12 +1127,18 @@ ModuleImport::convertGlobalCtorsAndDtors(llvm::GlobalVariable *globalVar) {
11261127
if (!priority || !func || !data)
11271128
return failure();
11281129

1129-
// GlobalCtorsOps and GlobalDtorsOps do not support non-null data fields.
1130-
if (!data->isNullValue())
1130+
auto *gv = dyn_cast_or_null<llvm::GlobalValue>(data);
1131+
Attribute dataAttr;
1132+
if (gv)
1133+
dataAttr = FlatSymbolRefAttr::get(context, gv->getName());
1134+
else if (data->isNullValue())
1135+
dataAttr = ZeroAttr::get(context);
1136+
else
11311137
return failure();
11321138

11331139
funcs.push_back(FlatSymbolRefAttr::get(context, func->getName()));
11341140
priorities.push_back(priority->getValue().getZExtValue());
1141+
dataList.push_back(dataAttr);
11351142
}
11361143

11371144
// Insert the global after the last one or at the start of the module.
@@ -1140,12 +1147,12 @@ ModuleImport::convertGlobalCtorsAndDtors(llvm::GlobalVariable *globalVar) {
11401147
if (globalVar->getName() == getGlobalCtorsVarName()) {
11411148
globalInsertionOp = builder.create<LLVM::GlobalCtorsOp>(
11421149
mlirModule.getLoc(), builder.getArrayAttr(funcs),
1143-
builder.getI32ArrayAttr(priorities));
1150+
builder.getI32ArrayAttr(priorities), builder.getArrayAttr(dataList));
11441151
return success();
11451152
}
11461153
globalInsertionOp = builder.create<LLVM::GlobalDtorsOp>(
11471154
mlirModule.getLoc(), builder.getArrayAttr(funcs),
1148-
builder.getI32ArrayAttr(priorities));
1155+
builder.getI32ArrayAttr(priorities), builder.getArrayAttr(dataList));
11491156
return success();
11501157
}
11511158

‎mlir/test/Dialect/LLVMIR/alias.mlir

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,23 +26,23 @@ llvm.mlir.alias external @_ZTV1D : !llvm.struct<(array<3 x ptr>)> {
2626

2727
// -----
2828

29-
llvm.mlir.global external @zed(42 : i32) : i32
29+
llvm.mlir.global weak_odr @zed(42 : i32) : i32
3030

31-
llvm.mlir.alias external @foo : i32 {
31+
llvm.mlir.alias weak_odr @foo : i32 {
3232
%0 = llvm.mlir.addressof @zed : !llvm.ptr
3333
llvm.return %0 : !llvm.ptr
3434
}
3535

36-
llvm.mlir.alias external @foo2 : i16 {
36+
llvm.mlir.alias weak_odr @foo2 : i16 {
3737
%0 = llvm.mlir.addressof @zed : !llvm.ptr
3838
llvm.return %0 : !llvm.ptr
3939
}
4040

41-
// CHECK: llvm.mlir.alias external @foo : i32 {
41+
// CHECK: llvm.mlir.alias weak_odr @foo : i32 {
4242
// CHECK: %[[ADDR:.*]] = llvm.mlir.addressof @zed : !llvm.ptr
4343
// CHECK: llvm.return %[[ADDR]] : !llvm.ptr
4444
// CHECK: }
45-
// CHECK: llvm.mlir.alias external @foo2 : i16 {
45+
// CHECK: llvm.mlir.alias weak_odr @foo2 : i16 {
4646
// CHECK: %[[ADDR:.*]] = llvm.mlir.addressof @zed : !llvm.ptr
4747
// CHECK: llvm.return %[[ADDR]] : !llvm.ptr
4848
// CHECK: }

‎mlir/test/Dialect/LLVMIR/global.mlir

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -228,25 +228,25 @@ llvm.func @ctor() {
228228
llvm.return
229229
}
230230

231-
// CHECK: llvm.mlir.global_ctors {ctors = [@ctor], priorities = [0 : i32]}
232-
llvm.mlir.global_ctors { ctors = [@ctor], priorities = [0 : i32]}
231+
// CHECK: llvm.mlir.global_ctors ctors = [@ctor], priorities = [0 : i32], data = [#llvm.zero]
232+
llvm.mlir.global_ctors ctors = [@ctor], priorities = [0 : i32], data = [#llvm.zero]
233233

234234
// -----
235235

236-
// CHECK: llvm.mlir.global_ctors {ctors = [], priorities = []}
237-
llvm.mlir.global_ctors {ctors = [], priorities = []}
236+
// CHECK: llvm.mlir.global_ctors ctors = [], priorities = [], data = []
237+
llvm.mlir.global_ctors ctors = [], priorities = [], data = []
238238

239-
// CHECK: llvm.mlir.global_dtors {dtors = [], priorities = []}
240-
llvm.mlir.global_dtors {dtors = [], priorities = []}
239+
// CHECK: llvm.mlir.global_dtors dtors = [], priorities = [], data = []
240+
llvm.mlir.global_dtors dtors = [], priorities = [], data = []
241241

242242
// -----
243243

244244
llvm.func @dtor() {
245245
llvm.return
246246
}
247247

248-
// CHECK: llvm.mlir.global_dtors {dtors = [@dtor], priorities = [0 : i32]}
249-
llvm.mlir.global_dtors { dtors = [@dtor], priorities = [0 : i32]}
248+
// CHECK: llvm.mlir.global_dtors dtors = [@dtor], priorities = [0 : i32], data = [#llvm.zero]
249+
llvm.mlir.global_dtors dtors = [@dtor], priorities = [0 : i32], data = [#llvm.zero]
250250

251251
// -----
252252

‎mlir/test/Dialect/LLVMIR/invalid.mlir

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,38 @@ llvm.func @ctor() {
99
llvm.return
1010
}
1111

12-
// expected-error@+1{{mismatch between the number of ctors and the number of priorities}}
13-
llvm.mlir.global_ctors {ctors = [@ctor], priorities = []}
12+
// expected-error@+1{{ctors, priorities, and data must have the same number of elements}}
13+
llvm.mlir.global_ctors ctors = [@ctor], priorities = [], data = [#llvm.zero]
1414

1515
// -----
1616

1717
llvm.func @dtor() {
1818
llvm.return
1919
}
2020

21-
// expected-error@+1{{mismatch between the number of dtors and the number of priorities}}
22-
llvm.mlir.global_dtors {dtors = [@dtor], priorities = [0 : i32, 32767 : i32]}
21+
// expected-error@+1{{dtors, priorities, and data must have the same number of elements}}
22+
llvm.mlir.global_dtors dtors = [@dtor], priorities = [0 : i32, 32767 : i32], data = [#llvm.zero]
2323

2424
// -----
2525

2626
// expected-error@+1{{'ctor' does not reference a valid LLVM function}}
27-
llvm.mlir.global_ctors {ctors = [@ctor], priorities = [0 : i32]}
27+
llvm.mlir.global_ctors ctors = [@ctor], priorities = [0 : i32], data = [#llvm.zero]
2828

2929
// -----
3030

3131
llvm.func @dtor()
3232

3333
// expected-error@+1{{'dtor' does not have a definition}}
34-
llvm.mlir.global_dtors {dtors = [@dtor], priorities = [0 : i32]}
34+
llvm.mlir.global_dtors dtors = [@dtor], priorities = [0 : i32], data = [#llvm.zero]
35+
36+
// -----
37+
38+
llvm.func @dtor() {
39+
llvm.return
40+
}
41+
42+
// expected-error@+1{{data element must be symbol or #llvm.zero}}
43+
llvm.mlir.global_dtors dtors = [@dtor], priorities = [0 : i32], data = [0 : i32]
3544

3645
////////////////////////////////////////////////////////////////////////////////
3746

‎mlir/test/Target/LLVMIR/Import/alias.ll

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,13 @@ entry:
6262

6363
; // -----
6464

65+
@glob.private2 = private constant [32 x i32] zeroinitializer
66+
@glob2 = weak_odr hidden alias [32 x i32], inttoptr (i64 add (i64 ptrtoint (ptr @glob.private2 to i64), i64 1234) to ptr)
67+
68+
; CHECK: llvm.mlir.alias weak_odr hidden @glob2 {dso_local} : !llvm.array<32 x i32> {
69+
70+
; // -----
71+
6572
@g1 = private global i32 0
6673
@g2 = internal constant ptr @a1
6774
@g3 = internal constant ptr @a2

‎mlir/test/Target/LLVMIR/Import/global-variables.ll

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -241,8 +241,8 @@
241241

242242
; // -----
243243

244-
; CHECK: llvm.mlir.global_ctors {ctors = [@foo, @bar], priorities = [0 : i32, 42 : i32]}
245-
; CHECK: llvm.mlir.global_dtors {dtors = [@foo], priorities = [0 : i32]}
244+
; CHECK: llvm.mlir.global_ctors ctors = [@foo, @bar], priorities = [0 : i32, 42 : i32], data = [#llvm.zero, #llvm.zero]
245+
; CHECK: llvm.mlir.global_dtors dtors = [@foo], priorities = [0 : i32], data = [#llvm.zero]
246246
@llvm.global_ctors = appending global [2 x { i32, ptr, ptr }] [{ i32, ptr, ptr } { i32 0, ptr @foo, ptr null }, { i32, ptr, ptr } { i32 42, ptr @bar, ptr null }]
247247
@llvm.global_dtors = appending global [1 x { i32, ptr, ptr }] [{ i32, ptr, ptr } { i32 0, ptr @foo, ptr null }]
248248

@@ -256,14 +256,23 @@ define void @bar() {
256256

257257
; // -----
258258

259-
; CHECK: llvm.mlir.global_ctors {ctors = [], priorities = []}
259+
; CHECK: llvm.mlir.global_ctors ctors = [], priorities = [], data = []
260260
@llvm.global_ctors = appending global [0 x { i32, ptr, ptr }] zeroinitializer
261261

262-
; CHECK: llvm.mlir.global_dtors {dtors = [], priorities = []}
262+
; CHECK: llvm.mlir.global_dtors dtors = [], priorities = [], data = []
263263
@llvm.global_dtors = appending global [0 x { i32, ptr, ptr }] zeroinitializer
264264

265265
; // -----
266266

267+
; llvm.mlir.global_dtors dtors = [@foo], priorities = [0 : i32], data = [@foo]
268+
@llvm.global_dtors = appending global [1 x { i32, ptr, ptr }] [{ i32, ptr, ptr } { i32 0, ptr @foo, ptr @foo }]
269+
270+
define void @foo() {
271+
ret void
272+
}
273+
274+
; // -----
275+
267276
; Visibility attribute.
268277

269278
; CHECK: llvm.mlir.global external hidden constant @hidden("string")

0 commit comments

Comments
 (0)