-
Notifications
You must be signed in to change notification settings - Fork 10.3k
/
ARCEntryPointBuilder.h
336 lines (285 loc) · 11.5 KB
/
ARCEntryPointBuilder.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
//===--- ARCEntryPointBuilder.h ---------------------------------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_LLVMPASSES_ARCENTRYPOINTBUILDER_H
#define SWIFT_LLVMPASSES_ARCENTRYPOINTBUILDER_H
#include "swift/Basic/NullablePtr.h"
#include "llvm/IR/IRBuilder.h"
#include "llvm/IR/Module.h"
#include "llvm/ADT/APInt.h"
namespace swift {
/// A class for building ARC entry points. It is a composition wrapper around an
/// IRBuilder and a constant Cache. It cannot be moved or copied. It is meant
/// to be created once and passed around by reference.
class ARCEntryPointBuilder {
using IRBuilder = llvm::IRBuilder<>;
using Constant = llvm::Constant;
using Type = llvm::Type;
using Function = llvm::Function;
using Instruction = llvm::Instruction;
using CallInst = llvm::CallInst;
using Value = llvm::Value;
using Module = llvm::Module;
using AttributeSet = llvm::AttributeSet;
using Attribute = llvm::Attribute;
using APInt = llvm::APInt;
// The builder which we are wrapping.
IRBuilder B;
// The constant cache.
NullablePtr<Constant> Retain;
NullablePtr<Constant> Release;
NullablePtr<Constant> CheckUnowned;
NullablePtr<Constant> RetainN;
NullablePtr<Constant> ReleaseN;
NullablePtr<Constant> UnknownRetainN;
NullablePtr<Constant> UnknownReleaseN;
NullablePtr<Constant> BridgeRetainN;
NullablePtr<Constant> BridgeReleaseN;
// The type cache.
NullablePtr<Type> ObjectPtrTy;
NullablePtr<Type> BridgeObjectPtrTy;
public:
ARCEntryPointBuilder(Function &F) : B(&*F.begin()), Retain(), ObjectPtrTy() {}
~ARCEntryPointBuilder() = default;
ARCEntryPointBuilder(ARCEntryPointBuilder &&) = delete;
ARCEntryPointBuilder(const ARCEntryPointBuilder &) = delete;
ARCEntryPointBuilder &operator=(const ARCEntryPointBuilder &) = delete;
void operator=(ARCEntryPointBuilder &&C) = delete;
void setInsertPoint(Instruction *I) {
B.SetInsertPoint(I);
}
Value *createInsertValue(Value *V1, Value *V2, unsigned Idx) {
return B.CreateInsertValue(V1, V2, Idx);
}
Value *createExtractValue(Value *V, unsigned Idx) {
return B.CreateExtractValue(V, Idx);
}
Value *createIntToPtr(Value *V, Type *Ty) {
return B.CreateIntToPtr(V, Ty);
}
CallInst *createRetain(Value *V) {
// Cast just to make sure that we have the right type.
V = B.CreatePointerCast(V, getObjectPtrTy());
// Create the call.
CallInst *CI = B.CreateCall(getRetain(), V);
CI->setTailCall(true);
return CI;
}
CallInst *createRelease(Value *V) {
// Cast just to make sure that we have the right type.
V = B.CreatePointerCast(V, getObjectPtrTy());
// Create the call.
CallInst *CI = B.CreateCall(getRelease(), V);
CI->setTailCall(true);
return CI;
}
CallInst *createCheckUnowned(Value *V) {
// Cast just to make sure that we have the right type.
V = B.CreatePointerCast(V, getObjectPtrTy());
CallInst *CI = B.CreateCall(getCheckUnowned(), V);
CI->setTailCall(true);
return CI;
}
CallInst *createRetainN(Value *V, uint32_t n) {
// Cast just to make sure that we have the right object type.
V = B.CreatePointerCast(V, getObjectPtrTy());
CallInst *CI = B.CreateCall(getRetainN(), {V, getIntConstant(n)});
CI->setTailCall(true);
return CI;
}
CallInst *createReleaseN(Value *V, uint32_t n) {
// Cast just to make sure we have the right object type.
V = B.CreatePointerCast(V, getObjectPtrTy());
CallInst *CI = B.CreateCall(getReleaseN(), {V, getIntConstant(n)});
CI->setTailCall(true);
return CI;
}
CallInst *createUnknownRetainN(Value *V, uint32_t n) {
// Cast just to make sure that we have the right object type.
V = B.CreatePointerCast(V, getObjectPtrTy());
CallInst *CI = B.CreateCall(getUnknownRetainN(), {V, getIntConstant(n)});
CI->setTailCall(true);
return CI;
}
CallInst *createUnknownReleaseN(Value *V, uint32_t n) {
// Cast just to make sure we have the right object type.
V = B.CreatePointerCast(V, getObjectPtrTy());
CallInst *CI = B.CreateCall(getUnknownReleaseN(), {V, getIntConstant(n)});
CI->setTailCall(true);
return CI;
}
CallInst *createBridgeRetainN(Value *V, uint32_t n) {
// Cast just to make sure we have the right object type.
V = B.CreatePointerCast(V, getBridgeObjectPtrTy());
CallInst *CI = B.CreateCall(getBridgeRetainN(), {V, getIntConstant(n)});
CI->setTailCall(true);
return CI;
}
CallInst *createBridgeReleaseN(Value *V, uint32_t n) {
// Cast just to make sure we have the right object type.
V = B.CreatePointerCast(V, getBridgeObjectPtrTy());
CallInst *CI = B.CreateCall(getBridgeReleaseN(), {V, getIntConstant(n)});
CI->setTailCall(true);
return CI;
}
private:
Module &getModule() {
return *B.GetInsertBlock()->getModule();
}
/// getRetain - Return a callable function for swift_retain.
Constant *getRetain() {
if (Retain)
return Retain.get();
auto *ObjectPtrTy = getObjectPtrTy();
auto &M = getModule();
auto AttrList = AttributeSet::get(
M.getContext(), AttributeSet::FunctionIndex, Attribute::NoUnwind);
Retain = M.getOrInsertFunction("swift_retain", AttrList,
Type::getVoidTy(M.getContext()),
ObjectPtrTy, nullptr);
return Retain.get();
}
/// getRelease - Return a callable function for swift_release.
Constant *getRelease() {
if (Release)
return Release.get();
auto *ObjectPtrTy = getObjectPtrTy();
auto &M = getModule();
auto AttrList = AttributeSet::get(
M.getContext(), AttributeSet::FunctionIndex, Attribute::NoUnwind);
Release = M.getOrInsertFunction("swift_release", AttrList,
Type::getVoidTy(M.getContext()),
ObjectPtrTy, nullptr);
return Release.get();
}
Constant *getCheckUnowned() {
if (CheckUnowned)
return CheckUnowned.get();
auto *ObjectPtrTy = getObjectPtrTy();
auto &M = getModule();
auto AttrList = AttributeSet::get(M.getContext(), 1, Attribute::NoCapture);
AttrList = AttrList.addAttribute(
M.getContext(), AttributeSet::FunctionIndex, Attribute::NoUnwind);
CheckUnowned = M.getOrInsertFunction("swift_checkUnowned", AttrList,
Type::getVoidTy(M.getContext()),
ObjectPtrTy, nullptr);
return CheckUnowned.get();
}
/// getRetainN - Return a callable function for swift_retain_n.
Constant *getRetainN() {
if (RetainN)
return RetainN.get();
auto *ObjectPtrTy = getObjectPtrTy();
auto &M = getModule();
auto *Int32Ty = Type::getInt32Ty(M.getContext());
auto AttrList = AttributeSet::get(
M.getContext(), AttributeSet::FunctionIndex, Attribute::NoUnwind);
RetainN = M.getOrInsertFunction("swift_retain_n", AttrList,
Type::getVoidTy(M.getContext()),
ObjectPtrTy, Int32Ty, nullptr);
return RetainN.get();
}
/// Return a callable function for swift_release_n.
Constant *getReleaseN() {
if (ReleaseN)
return ReleaseN.get();
auto *ObjectPtrTy = getObjectPtrTy();
auto &M = getModule();
auto *Int32Ty = Type::getInt32Ty(M.getContext());
auto AttrList = AttributeSet::get(
M.getContext(), AttributeSet::FunctionIndex, Attribute::NoUnwind);
ReleaseN = M.getOrInsertFunction("swift_release_n", AttrList,
Type::getVoidTy(M.getContext()),
ObjectPtrTy, Int32Ty, nullptr);
return ReleaseN.get();
}
/// getUnknownRetainN - Return a callable function for swift_unknownRetain_n.
Constant *getUnknownRetainN() {
if (UnknownRetainN)
return UnknownRetainN.get();
auto *ObjectPtrTy = getObjectPtrTy();
auto &M = getModule();
auto *Int32Ty = Type::getInt32Ty(M.getContext());
auto AttrList = AttributeSet::get(
M.getContext(), AttributeSet::FunctionIndex, Attribute::NoUnwind);
UnknownRetainN = M.getOrInsertFunction("swift_unknownRetain_n", AttrList,
Type::getVoidTy(M.getContext()),
ObjectPtrTy, Int32Ty, nullptr);
return UnknownRetainN.get();
}
/// Return a callable function for swift_unknownRelease_n.
Constant *getUnknownReleaseN() {
if (UnknownReleaseN)
return UnknownReleaseN.get();
auto *ObjectPtrTy = getObjectPtrTy();
auto &M = getModule();
auto *Int32Ty = Type::getInt32Ty(M.getContext());
auto AttrList = AttributeSet::get(
M.getContext(), AttributeSet::FunctionIndex, Attribute::NoUnwind);
UnknownReleaseN = M.getOrInsertFunction("swift_unknownRelease_n", AttrList,
Type::getVoidTy(M.getContext()),
ObjectPtrTy, Int32Ty, nullptr);
return UnknownReleaseN.get();
}
/// Return a callable function for swift_bridgeRetain_n.
Constant *getBridgeRetainN() {
if (BridgeRetainN)
return BridgeRetainN.get();
auto *BridgeObjectPtrTy = getBridgeObjectPtrTy();
auto &M = getModule();
auto *Int32Ty = Type::getInt32Ty(M.getContext());
auto AttrList = AttributeSet::get(
M.getContext(), AttributeSet::FunctionIndex, Attribute::NoUnwind);
BridgeRetainN = M.getOrInsertFunction("swift_bridgeObjectRetain_n",
AttrList, BridgeObjectPtrTy,
BridgeObjectPtrTy,
Int32Ty, nullptr);
return BridgeRetainN.get();
}
/// Return a callable function for swift_bridgeRelease_n.
Constant *getBridgeReleaseN() {
if (BridgeReleaseN)
return BridgeReleaseN.get();
auto &M = getModule();
auto *Int32Ty = Type::getInt32Ty(M.getContext());
auto AttrList = AttributeSet::get(
M.getContext(), AttributeSet::FunctionIndex, Attribute::NoUnwind);
BridgeReleaseN = M.getOrInsertFunction("swift_bridgeObjectRelease_n",
AttrList,
Type::getVoidTy(M.getContext()),
BridgeObjectPtrTy, Int32Ty,
nullptr);
return BridgeReleaseN.get();
}
Type *getObjectPtrTy() {
if (ObjectPtrTy)
return ObjectPtrTy.get();
auto &M = getModule();
ObjectPtrTy = M.getTypeByName("swift.refcounted")->getPointerTo();
assert(ObjectPtrTy && "Could not find the swift heap object type by name");
return ObjectPtrTy.get();
}
Type *getBridgeObjectPtrTy() {
if (BridgeObjectPtrTy)
return BridgeObjectPtrTy.get();
auto &M = getModule();
BridgeObjectPtrTy = M.getTypeByName("swift.bridge")->getPointerTo();
assert(BridgeObjectPtrTy && "Could not find the swift bridge object type by name");
return BridgeObjectPtrTy.get();
}
Constant *getIntConstant(uint32_t constant) {
auto &M = getModule();
auto *Int32Ty = Type::getInt32Ty(M.getContext());
return Constant::getIntegerValue(Int32Ty, APInt(32, constant));
}
};
} // end swift namespace
#endif