Skip to content

Commit c1d5865

Browse files
jhuber6jhuber6
authored
[AMDGPU] Call the FINI_ARRAY destructors in the correct order (llvm#71815)
Summary: The AMDGPU backend uses the linker-provided INIT_ARRAY and FINI_ARRAY sections to call all the global constructors in a single kernel. Previously this mistakenly used the same iteration logic for both arrays. The destructors stored in FINI_ARRAY are stored in the same order as the ones in the INIT_ARRAY section so we need to traverse it in reverse order.
1 parent af8ebfd commit c1d5865

File tree

4 files changed

+53
-48
lines changed

4 files changed

+53
-48
lines changed

‎llvm/lib/Target/AMDGPU/AMDGPUCtorDtorLowering.cpp

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,22 @@ static Function *createInitOrFiniKernelFunction(Module &M, bool IsCtor) {
5353
//
5454
// extern "C" void * __init_array_start[];
5555
// extern "C" void * __init_array_end[];
56+
// extern "C" void * __fini_array_start[];
57+
// extern "C" void * __fini_array_end[];
5658
//
5759
// using InitCallback = void();
60+
// using FiniCallback = void(void);
5861
//
5962
// void call_init_array_callbacks() {
6063
// for (auto start = __init_array_start; start != __init_array_end; ++start)
6164
// reinterpret_cast<InitCallback *>(*start)();
6265
// }
66+
//
67+
// void call_fini_array_callbacks() {
68+
// size_t fini_array_size = __fini_array_end - __fini_array_start;
69+
// for (size_t i = fini_array_size; i > 0; --i)
70+
// reinterpret_cast<FiniCallback *>(__fini_array_start[i - 1])();
71+
// }
6372
static void createInitOrFiniCalls(Function &F, bool IsCtor) {
6473
Module &M = *F.getParent();
6574
LLVMContext &C = M.getContext();
@@ -96,15 +105,39 @@ static void createInitOrFiniCalls(Function &F, bool IsCtor) {
96105
// for now we just call them with no arguments.
97106
auto *CallBackTy = FunctionType::get(IRB.getVoidTy(), {});
98107

99-
IRB.CreateCondBr(IRB.CreateICmpNE(Begin, End), LoopBB, ExitBB);
108+
Constant *Start = Begin;
109+
Constant *Stop = End;
110+
// The destructor array must be called in reverse order. Get a constant
111+
// expression to the end of the array and iterate backwards instead.
112+
if (!IsCtor) {
113+
Type *Int64Ty = IntegerType::getInt64Ty(C);
114+
auto *Offset = ConstantExpr::getSub(
115+
ConstantExpr::getAShr(
116+
ConstantExpr::getSub(ConstantExpr::getPtrToInt(End, Int64Ty),
117+
ConstantExpr::getPtrToInt(Begin, Int64Ty)),
118+
ConstantInt::get(Int64Ty, 3)),
119+
ConstantInt::get(Int64Ty, 1));
120+
Start = ConstantExpr::getGetElementPtr(
121+
ArrayType::get(IRB.getPtrTy(), 0), Begin,
122+
ArrayRef<Constant *>({ConstantInt::get(Int64Ty, 0), Offset}),
123+
/*InBounds=*/true);
124+
Stop = Begin;
125+
}
126+
127+
IRB.CreateCondBr(
128+
IRB.CreateCmp(IsCtor ? ICmpInst::ICMP_NE : ICmpInst::ICMP_UGE, Start,
129+
Stop),
130+
LoopBB, ExitBB);
100131
IRB.SetInsertPoint(LoopBB);
101132
auto *CallBackPHI = IRB.CreatePHI(PtrTy, 2, "ptr");
102133
auto *CallBack = IRB.CreateLoad(CallBackTy->getPointerTo(F.getAddressSpace()),
103134
CallBackPHI, "callback");
104135
IRB.CreateCall(CallBackTy, CallBack);
105-
auto *NewCallBack = IRB.CreateConstGEP1_64(PtrTy, CallBackPHI, 1, "next");
106-
auto *EndCmp = IRB.CreateICmpEQ(NewCallBack, End, "end");
107-
CallBackPHI->addIncoming(Begin, &F.getEntryBlock());
136+
auto *NewCallBack =
137+
IRB.CreateConstGEP1_64(PtrTy, CallBackPHI, IsCtor ? 1 : -1, "next");
138+
auto *EndCmp = IRB.CreateCmp(IsCtor ? ICmpInst::ICMP_EQ : ICmpInst::ICMP_ULT,
139+
NewCallBack, Stop, "end");
140+
CallBackPHI->addIncoming(Start, &F.getEntryBlock());
108141
CallBackPHI->addIncoming(NewCallBack, LoopBB);
109142
IRB.CreateCondBr(EndCmp, ExitBB, LoopBB);
110143
IRB.SetInsertPoint(ExitBB);

‎llvm/test/CodeGen/AMDGPU/lower-ctor-dtor-constexpr-alias.ll

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ define void @bar() addrspace(1) {
2525
ret void
2626
}
2727

28-
29-
3028
;.
3129
; CHECK: @[[LLVM_GLOBAL_CTORS:[a-zA-Z0-9_$"\\.-]+]] = appending addrspace(1) global [2 x { i32, ptr, ptr }] [{ i32, ptr, ptr } { i32 1, ptr @foo.alias, ptr null }, { i32, ptr, ptr } { i32 1, ptr inttoptr (i64 4096 to ptr), ptr null }]
3230
; CHECK: @[[LLVM_GLOBAL_DTORS:[a-zA-Z0-9_$"\\.-]+]] = appending addrspace(1) global [1 x { i32, ptr, ptr }] [{ i32, ptr, ptr } { i32 1, ptr addrspacecast (ptr addrspace(1) @bar to ptr), ptr null }]
@@ -65,13 +63,13 @@ define void @bar() addrspace(1) {
6563
; CHECK-LABEL: define weak_odr amdgpu_kernel void @amdgcn.device.fini(
6664
; CHECK-SAME: ) #[[ATTR2:[0-9]+]] {
6765
; CHECK-NEXT: entry:
68-
; CHECK-NEXT: br i1 icmp ne (ptr addrspace(1) @__fini_array_start, ptr addrspace(1) @__fini_array_end), label [[WHILE_ENTRY:%.*]], label [[WHILE_END:%.*]]
66+
; CHECK-NEXT: br i1 icmp uge (ptr addrspace(1) getelementptr inbounds ([0 x ptr], ptr addrspace(1) @__fini_array_start, i64 0, i64 sub (i64 ashr (i64 sub (i64 ptrtoint (ptr addrspace(1) @__fini_array_end to i64), i64 ptrtoint (ptr addrspace(1) @__fini_array_start to i64)), i64 3), i64 1)), ptr addrspace(1) @__fini_array_start), label [[WHILE_ENTRY:%.*]], label [[WHILE_END:%.*]]
6967
; CHECK: while.entry:
70-
; CHECK-NEXT: [[PTR:%.*]] = phi ptr addrspace(1) [ @__fini_array_start, [[ENTRY:%.*]] ], [ [[NEXT:%.*]], [[WHILE_ENTRY]] ]
68+
; CHECK-NEXT: [[PTR:%.*]] = phi ptr addrspace(1) [ getelementptr inbounds ([0 x ptr], ptr addrspace(1) @__fini_array_start, i64 0, i64 sub (i64 ashr (i64 sub (i64 ptrtoint (ptr addrspace(1) @__fini_array_end to i64), i64 ptrtoint (ptr addrspace(1) @__fini_array_start to i64)), i64 3), i64 1)), [[ENTRY:%.*]] ], [ [[NEXT:%.*]], [[WHILE_ENTRY]] ]
7169
; CHECK-NEXT: [[CALLBACK:%.*]] = load ptr, ptr addrspace(1) [[PTR]], align 8
7270
; CHECK-NEXT: call void [[CALLBACK]]()
73-
; CHECK-NEXT: [[NEXT]] = getelementptr ptr addrspace(1), ptr addrspace(1) [[PTR]], i64 1
74-
; CHECK-NEXT: [[END:%.*]] = icmp eq ptr addrspace(1) [[NEXT]], @__fini_array_end
71+
; CHECK-NEXT: [[NEXT]] = getelementptr ptr addrspace(1), ptr addrspace(1) [[PTR]], i64 -1
72+
; CHECK-NEXT: [[END:%.*]] = icmp ult ptr addrspace(1) [[NEXT]], @__fini_array_start
7573
; CHECK-NEXT: br i1 [[END]], label [[WHILE_END]], label [[WHILE_ENTRY]]
7674
; CHECK: while.end:
7775
; CHECK-NEXT: ret void

‎llvm/test/CodeGen/AMDGPU/lower-ctor-dtor.ll

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,19 @@
1212
@llvm.global_ctors = appending addrspace(1) global [1 x { i32, ptr, ptr }] [{ i32, ptr, ptr } { i32 1, ptr @foo, ptr null }]
1313
@llvm.global_dtors = appending addrspace(1) global [1 x { i32, ptr, ptr }] [{ i32, ptr, ptr } { i32 1, ptr @bar, ptr null }]
1414

15-
16-
17-
18-
1915
; VISIBILITY: FUNC WEAK PROTECTED {{.*}} amdgcn.device.init
2016
; VISIBILITY: OBJECT WEAK DEFAULT {{.*}} amdgcn.device.init.kd
2117
; VISIBILITY: FUNC WEAK PROTECTED {{.*}} amdgcn.device.fini
2218
; VISIBILITY: OBJECT WEAK DEFAULT {{.*}} amdgcn.device.fini.kd
19+
2320
; SECTION: .init_array.1 INIT_ARRAY {{.*}} {{.*}} 000008 00 WA 0 0 8
2421
; SECTION: .fini_array.1 FINI_ARRAY {{.*}} {{.*}} 000008 00 WA 0 0 8
22+
2523
; DISABLED-NOT: FUNC GLOBAL PROTECTED {{.*}} amdgcn.device.init
2624
; DISABLED-NOT: OBJECT GLOBAL DEFAULT {{.*}} amdgcn.device.init.kd
2725
; DISABLED-NOT: FUNC GLOBAL PROTECTED {{.*}} amdgcn.device.fini
2826
; DISABLED-NOT: OBJECT GLOBAL DEFAULT {{.*}} amdgcn.device.fini.kd
27+
2928
; METADATA: amdhsa.kernels:
3029
; METADATA: .kind: init
3130
; METADATA: .max_flat_workgroup_size: 1
@@ -53,13 +52,6 @@ define internal void @bar() {
5352
; CHECK: @[[__FINI_ARRAY_END:[a-zA-Z0-9_$"\\.-]+]] = external addrspace(1) constant [0 x ptr addrspace(1)]
5453
; CHECK: @[[LLVM_USED:[a-zA-Z0-9_$"\\.-]+]] = appending addrspace(1) global [2 x ptr] [ptr @amdgcn.device.init, ptr @amdgcn.device.fini], section "llvm.metadata"
5554
;.
56-
; CHECK-LABEL: define internal void @foo() {
57-
; CHECK-NEXT: ret void
58-
;
59-
;
60-
; CHECK-LABEL: define internal void @bar() {
61-
; CHECK-NEXT: ret void
62-
;
6355
;
6456
; CHECK-LABEL: define weak_odr amdgpu_kernel void @amdgcn.device.init(
6557
; CHECK-SAME: ) #[[ATTR0:[0-9]+]] {
@@ -79,18 +71,17 @@ define internal void @bar() {
7971
; CHECK-LABEL: define weak_odr amdgpu_kernel void @amdgcn.device.fini(
8072
; CHECK-SAME: ) #[[ATTR1:[0-9]+]] {
8173
; CHECK-NEXT: entry:
82-
; CHECK-NEXT: br i1 icmp ne (ptr addrspace(1) @__fini_array_start, ptr addrspace(1) @__fini_array_end), label [[WHILE_ENTRY:%.*]], label [[WHILE_END:%.*]]
74+
; CHECK-NEXT: br i1 icmp uge (ptr addrspace(1) getelementptr inbounds ([0 x ptr], ptr addrspace(1) @__fini_array_start, i64 0, i64 sub (i64 ashr (i64 sub (i64 ptrtoint (ptr addrspace(1) @__fini_array_end to i64), i64 ptrtoint (ptr addrspace(1) @__fini_array_start to i64)), i64 3), i64 1)), ptr addrspace(1) @__fini_array_start), label [[WHILE_ENTRY:%.*]], label [[WHILE_END:%.*]]
8375
; CHECK: while.entry:
84-
; CHECK-NEXT: [[PTR:%.*]] = phi ptr addrspace(1) [ @__fini_array_start, [[ENTRY:%.*]] ], [ [[NEXT:%.*]], [[WHILE_ENTRY]] ]
76+
; CHECK-NEXT: [[PTR:%.*]] = phi ptr addrspace(1) [ getelementptr inbounds ([0 x ptr], ptr addrspace(1) @__fini_array_start, i64 0, i64 sub (i64 ashr (i64 sub (i64 ptrtoint (ptr addrspace(1) @__fini_array_end to i64), i64 ptrtoint (ptr addrspace(1) @__fini_array_start to i64)), i64 3), i64 1)), [[ENTRY:%.*]] ], [ [[NEXT:%.*]], [[WHILE_ENTRY]] ]
8577
; CHECK-NEXT: [[CALLBACK:%.*]] = load ptr, ptr addrspace(1) [[PTR]], align 8
8678
; CHECK-NEXT: call void [[CALLBACK]]()
87-
; CHECK-NEXT: [[NEXT]] = getelementptr ptr addrspace(1), ptr addrspace(1) [[PTR]], i64 1
88-
; CHECK-NEXT: [[END:%.*]] = icmp eq ptr addrspace(1) [[NEXT]], @__fini_array_end
79+
; CHECK-NEXT: [[NEXT]] = getelementptr ptr addrspace(1), ptr addrspace(1) [[PTR]], i64 -1
80+
; CHECK-NEXT: [[END:%.*]] = icmp ult ptr addrspace(1) [[NEXT]], @__fini_array_start
8981
; CHECK-NEXT: br i1 [[END]], label [[WHILE_END]], label [[WHILE_ENTRY]]
9082
; CHECK: while.end:
9183
; CHECK-NEXT: ret void
9284
;
9385
;.
9486
; CHECK: attributes #[[ATTR0]] = { "amdgpu-flat-work-group-size"="1,1" "device-init" }
9587
; CHECK: attributes #[[ATTR1]] = { "amdgpu-flat-work-group-size"="1,1" "device-fini" }
96-
;.

‎llvm/test/CodeGen/AMDGPU/lower-multiple-ctor-dtor.ll

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
; RUN: llc -mtriple=amdgcn-amd-amdhsa -mcpu=gfx700 -filetype=obj -o - < %s | llvm-readelf -s - 2>&1 | FileCheck %s -check-prefix=CHECK-VIS
44

55

6-
; UTC_ARGS: --disable
76
@llvm.global_ctors = appending addrspace(1) global [2 x { i32, ptr, ptr }] [{ i32, ptr, ptr } { i32 1, ptr @foo, ptr null }, { i32, ptr, ptr } { i32 1, ptr @foo.5, ptr null }]
87
@llvm.global_dtors = appending addrspace(1) global [2 x { i32, ptr, ptr }] [{ i32, ptr, ptr } { i32 1, ptr @bar, ptr null }, { i32, ptr, ptr } { i32 1, ptr @bar.5, ptr null }]
98

9+
; UTC_ARGS: --disable
1010
; CHECK: @__init_array_start = external addrspace(1) constant [0 x ptr addrspace(1)]
1111
; CHECK: @__init_array_end = external addrspace(1) constant [0 x ptr addrspace(1)]
1212
; CHECK: @__fini_array_start = external addrspace(1) constant [0 x ptr addrspace(1)]
@@ -36,22 +36,6 @@ define internal void @bar.5() {
3636
ret void
3737
}
3838

39-
; CHECK-LABEL: define internal void @foo() {
40-
; CHECK-NEXT: ret void
41-
;
42-
;
43-
; CHECK-LABEL: define internal void @bar() {
44-
; CHECK-NEXT: ret void
45-
;
46-
;
47-
; CHECK-LABEL: define internal void @foo.5() {
48-
; CHECK-NEXT: ret void
49-
;
50-
;
51-
; CHECK-LABEL: define internal void @bar.5() {
52-
; CHECK-NEXT: ret void
53-
;
54-
;
5539
; CHECK-LABEL: define weak_odr amdgpu_kernel void @amdgcn.device.init(
5640
; CHECK-SAME: ) #[[ATTR0:[0-9]+]] {
5741
; CHECK-NEXT: entry:
@@ -70,14 +54,13 @@ define internal void @bar.5() {
7054
; CHECK-LABEL: define weak_odr amdgpu_kernel void @amdgcn.device.fini(
7155
; CHECK-SAME: ) #[[ATTR1:[0-9]+]] {
7256
; CHECK-NEXT: entry:
73-
; CHECK-NEXT: br i1 icmp ne (ptr addrspace(1) @__fini_array_start, ptr addrspace(1) @__fini_array_end), label [[WHILE_ENTRY:%.*]], label [[WHILE_END:%.*]]
57+
; CHECK-NEXT: br i1 icmp uge (ptr addrspace(1) getelementptr inbounds ([0 x ptr], ptr addrspace(1) @__fini_array_start, i64 0, i64 sub (i64 ashr (i64 sub (i64 ptrtoint (ptr addrspace(1) @__fini_array_end to i64), i64 ptrtoint (ptr addrspace(1) @__fini_array_start to i64)), i64 3), i64 1)), ptr addrspace(1) @__fini_array_start), label [[WHILE_ENTRY:%.*]], label [[WHILE_END:%.*]]
7458
; CHECK: while.entry:
75-
; CHECK-NEXT: [[PTR:%.*]] = phi ptr addrspace(1) [ @__fini_array_start, [[ENTRY:%.*]] ], [ [[NEXT:%.*]], [[WHILE_ENTRY]] ]
59+
; CHECK-NEXT: [[PTR:%.*]] = phi ptr addrspace(1) [ getelementptr inbounds ([0 x ptr], ptr addrspace(1) @__fini_array_start, i64 0, i64 sub (i64 ashr (i64 sub (i64 ptrtoint (ptr addrspace(1) @__fini_array_end to i64), i64 ptrtoint (ptr addrspace(1) @__fini_array_start to i64)), i64 3), i64 1)), [[ENTRY:%.*]] ], [ [[NEXT:%.*]], [[WHILE_ENTRY]] ]
7660
; CHECK-NEXT: [[CALLBACK:%.*]] = load ptr, ptr addrspace(1) [[PTR]], align 8
7761
; CHECK-NEXT: call void [[CALLBACK]]()
78-
; CHECK-NEXT: [[NEXT]] = getelementptr ptr addrspace(1), ptr addrspace(1) [[PTR]], i64 1
79-
; CHECK-NEXT: [[END:%.*]] = icmp eq ptr addrspace(1) [[NEXT]], @__fini_array_end
62+
; CHECK-NEXT: [[NEXT]] = getelementptr ptr addrspace(1), ptr addrspace(1) [[PTR]], i64 -1
63+
; CHECK-NEXT: [[END:%.*]] = icmp ult ptr addrspace(1) [[NEXT]], @__fini_array_start
8064
; CHECK-NEXT: br i1 [[END]], label [[WHILE_END]], label [[WHILE_ENTRY]]
8165
; CHECK: while.end:
8266
; CHECK-NEXT: ret void
83-
;

0 commit comments

Comments
 (0)