annotate clang/lib/ARCMigrate/TransZeroOutPropsInDealloc.cpp @ 176:de4ac79aef9d

...
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Mon, 25 May 2020 17:13:11 +0900
parents 0572611fdcc8
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
150
anatofuz
parents:
diff changeset
1 //===--- TransZeroOutPropsInDealloc.cpp - Transformations to ARC mode -----===//
anatofuz
parents:
diff changeset
2 //
anatofuz
parents:
diff changeset
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
anatofuz
parents:
diff changeset
4 // See https://llvm.org/LICENSE.txt for license information.
anatofuz
parents:
diff changeset
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
anatofuz
parents:
diff changeset
6 //
anatofuz
parents:
diff changeset
7 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
8 //
anatofuz
parents:
diff changeset
9 // removeZeroOutPropsInDealloc:
anatofuz
parents:
diff changeset
10 //
anatofuz
parents:
diff changeset
11 // Removes zero'ing out "strong" @synthesized properties in a -dealloc method.
anatofuz
parents:
diff changeset
12 //
anatofuz
parents:
diff changeset
13 //===----------------------------------------------------------------------===//
anatofuz
parents:
diff changeset
14
anatofuz
parents:
diff changeset
15 #include "Transforms.h"
anatofuz
parents:
diff changeset
16 #include "Internals.h"
anatofuz
parents:
diff changeset
17 #include "clang/AST/ASTContext.h"
anatofuz
parents:
diff changeset
18
anatofuz
parents:
diff changeset
19 using namespace clang;
anatofuz
parents:
diff changeset
20 using namespace arcmt;
anatofuz
parents:
diff changeset
21 using namespace trans;
anatofuz
parents:
diff changeset
22
anatofuz
parents:
diff changeset
23 namespace {
anatofuz
parents:
diff changeset
24
anatofuz
parents:
diff changeset
25 class ZeroOutInDeallocRemover :
anatofuz
parents:
diff changeset
26 public RecursiveASTVisitor<ZeroOutInDeallocRemover> {
anatofuz
parents:
diff changeset
27 typedef RecursiveASTVisitor<ZeroOutInDeallocRemover> base;
anatofuz
parents:
diff changeset
28
anatofuz
parents:
diff changeset
29 MigrationPass &Pass;
anatofuz
parents:
diff changeset
30
anatofuz
parents:
diff changeset
31 llvm::DenseMap<ObjCPropertyDecl*, ObjCPropertyImplDecl*> SynthesizedProperties;
anatofuz
parents:
diff changeset
32 ImplicitParamDecl *SelfD;
anatofuz
parents:
diff changeset
33 ExprSet Removables;
anatofuz
parents:
diff changeset
34 Selector FinalizeSel;
anatofuz
parents:
diff changeset
35
anatofuz
parents:
diff changeset
36 public:
anatofuz
parents:
diff changeset
37 ZeroOutInDeallocRemover(MigrationPass &pass) : Pass(pass), SelfD(nullptr) {
anatofuz
parents:
diff changeset
38 FinalizeSel =
anatofuz
parents:
diff changeset
39 Pass.Ctx.Selectors.getNullarySelector(&Pass.Ctx.Idents.get("finalize"));
anatofuz
parents:
diff changeset
40 }
anatofuz
parents:
diff changeset
41
anatofuz
parents:
diff changeset
42 bool VisitObjCMessageExpr(ObjCMessageExpr *ME) {
anatofuz
parents:
diff changeset
43 ASTContext &Ctx = Pass.Ctx;
anatofuz
parents:
diff changeset
44 TransformActions &TA = Pass.TA;
anatofuz
parents:
diff changeset
45
anatofuz
parents:
diff changeset
46 if (ME->getReceiverKind() != ObjCMessageExpr::Instance)
anatofuz
parents:
diff changeset
47 return true;
anatofuz
parents:
diff changeset
48 Expr *receiver = ME->getInstanceReceiver();
anatofuz
parents:
diff changeset
49 if (!receiver)
anatofuz
parents:
diff changeset
50 return true;
anatofuz
parents:
diff changeset
51
anatofuz
parents:
diff changeset
52 DeclRefExpr *refE = dyn_cast<DeclRefExpr>(receiver->IgnoreParenCasts());
anatofuz
parents:
diff changeset
53 if (!refE || refE->getDecl() != SelfD)
anatofuz
parents:
diff changeset
54 return true;
anatofuz
parents:
diff changeset
55
anatofuz
parents:
diff changeset
56 bool BackedBySynthesizeSetter = false;
anatofuz
parents:
diff changeset
57 for (llvm::DenseMap<ObjCPropertyDecl*, ObjCPropertyImplDecl*>::iterator
anatofuz
parents:
diff changeset
58 P = SynthesizedProperties.begin(),
anatofuz
parents:
diff changeset
59 E = SynthesizedProperties.end(); P != E; ++P) {
anatofuz
parents:
diff changeset
60 ObjCPropertyDecl *PropDecl = P->first;
anatofuz
parents:
diff changeset
61 if (PropDecl->getSetterName() == ME->getSelector()) {
anatofuz
parents:
diff changeset
62 BackedBySynthesizeSetter = true;
anatofuz
parents:
diff changeset
63 break;
anatofuz
parents:
diff changeset
64 }
anatofuz
parents:
diff changeset
65 }
anatofuz
parents:
diff changeset
66 if (!BackedBySynthesizeSetter)
anatofuz
parents:
diff changeset
67 return true;
anatofuz
parents:
diff changeset
68
anatofuz
parents:
diff changeset
69 // Remove the setter message if RHS is null
anatofuz
parents:
diff changeset
70 Transaction Trans(TA);
anatofuz
parents:
diff changeset
71 Expr *RHS = ME->getArg(0);
anatofuz
parents:
diff changeset
72 bool RHSIsNull =
anatofuz
parents:
diff changeset
73 RHS->isNullPointerConstant(Ctx,
anatofuz
parents:
diff changeset
74 Expr::NPC_ValueDependentIsNull);
anatofuz
parents:
diff changeset
75 if (RHSIsNull && isRemovable(ME))
anatofuz
parents:
diff changeset
76 TA.removeStmt(ME);
anatofuz
parents:
diff changeset
77
anatofuz
parents:
diff changeset
78 return true;
anatofuz
parents:
diff changeset
79 }
anatofuz
parents:
diff changeset
80
anatofuz
parents:
diff changeset
81 bool VisitPseudoObjectExpr(PseudoObjectExpr *POE) {
anatofuz
parents:
diff changeset
82 if (isZeroingPropIvar(POE) && isRemovable(POE)) {
anatofuz
parents:
diff changeset
83 Transaction Trans(Pass.TA);
anatofuz
parents:
diff changeset
84 Pass.TA.removeStmt(POE);
anatofuz
parents:
diff changeset
85 }
anatofuz
parents:
diff changeset
86
anatofuz
parents:
diff changeset
87 return true;
anatofuz
parents:
diff changeset
88 }
anatofuz
parents:
diff changeset
89
anatofuz
parents:
diff changeset
90 bool VisitBinaryOperator(BinaryOperator *BOE) {
anatofuz
parents:
diff changeset
91 if (isZeroingPropIvar(BOE) && isRemovable(BOE)) {
anatofuz
parents:
diff changeset
92 Transaction Trans(Pass.TA);
anatofuz
parents:
diff changeset
93 Pass.TA.removeStmt(BOE);
anatofuz
parents:
diff changeset
94 }
anatofuz
parents:
diff changeset
95
anatofuz
parents:
diff changeset
96 return true;
anatofuz
parents:
diff changeset
97 }
anatofuz
parents:
diff changeset
98
anatofuz
parents:
diff changeset
99 bool TraverseObjCMethodDecl(ObjCMethodDecl *D) {
anatofuz
parents:
diff changeset
100 if (D->getMethodFamily() != OMF_dealloc &&
anatofuz
parents:
diff changeset
101 !(D->isInstanceMethod() && D->getSelector() == FinalizeSel))
anatofuz
parents:
diff changeset
102 return true;
anatofuz
parents:
diff changeset
103 if (!D->hasBody())
anatofuz
parents:
diff changeset
104 return true;
anatofuz
parents:
diff changeset
105
anatofuz
parents:
diff changeset
106 ObjCImplDecl *IMD = dyn_cast<ObjCImplDecl>(D->getDeclContext());
anatofuz
parents:
diff changeset
107 if (!IMD)
anatofuz
parents:
diff changeset
108 return true;
anatofuz
parents:
diff changeset
109
anatofuz
parents:
diff changeset
110 SelfD = D->getSelfDecl();
anatofuz
parents:
diff changeset
111 collectRemovables(D->getBody(), Removables);
anatofuz
parents:
diff changeset
112
anatofuz
parents:
diff changeset
113 // For a 'dealloc' method use, find all property implementations in
anatofuz
parents:
diff changeset
114 // this class implementation.
anatofuz
parents:
diff changeset
115 for (auto *PID : IMD->property_impls()) {
anatofuz
parents:
diff changeset
116 if (PID->getPropertyImplementation() ==
anatofuz
parents:
diff changeset
117 ObjCPropertyImplDecl::Synthesize) {
anatofuz
parents:
diff changeset
118 ObjCPropertyDecl *PD = PID->getPropertyDecl();
anatofuz
parents:
diff changeset
119 ObjCMethodDecl *setterM = PD->getSetterMethodDecl();
anatofuz
parents:
diff changeset
120 if (!(setterM && setterM->isDefined())) {
173
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
121 ObjCPropertyAttribute::Kind AttrKind = PD->getPropertyAttributes();
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
122 if (AttrKind & (ObjCPropertyAttribute::kind_retain |
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
123 ObjCPropertyAttribute::kind_copy |
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
124 ObjCPropertyAttribute::kind_strong))
0572611fdcc8 reorgnization done
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 150
diff changeset
125 SynthesizedProperties[PD] = PID;
150
anatofuz
parents:
diff changeset
126 }
anatofuz
parents:
diff changeset
127 }
anatofuz
parents:
diff changeset
128 }
anatofuz
parents:
diff changeset
129
anatofuz
parents:
diff changeset
130 // Now, remove all zeroing of ivars etc.
anatofuz
parents:
diff changeset
131 base::TraverseObjCMethodDecl(D);
anatofuz
parents:
diff changeset
132
anatofuz
parents:
diff changeset
133 // clear out for next method.
anatofuz
parents:
diff changeset
134 SynthesizedProperties.clear();
anatofuz
parents:
diff changeset
135 SelfD = nullptr;
anatofuz
parents:
diff changeset
136 Removables.clear();
anatofuz
parents:
diff changeset
137 return true;
anatofuz
parents:
diff changeset
138 }
anatofuz
parents:
diff changeset
139
anatofuz
parents:
diff changeset
140 bool TraverseFunctionDecl(FunctionDecl *D) { return true; }
anatofuz
parents:
diff changeset
141 bool TraverseBlockDecl(BlockDecl *block) { return true; }
anatofuz
parents:
diff changeset
142 bool TraverseBlockExpr(BlockExpr *block) { return true; }
anatofuz
parents:
diff changeset
143
anatofuz
parents:
diff changeset
144 private:
anatofuz
parents:
diff changeset
145 bool isRemovable(Expr *E) const {
anatofuz
parents:
diff changeset
146 return Removables.count(E);
anatofuz
parents:
diff changeset
147 }
anatofuz
parents:
diff changeset
148
anatofuz
parents:
diff changeset
149 bool isZeroingPropIvar(Expr *E) {
anatofuz
parents:
diff changeset
150 E = E->IgnoreParens();
anatofuz
parents:
diff changeset
151 if (BinaryOperator *BO = dyn_cast<BinaryOperator>(E))
anatofuz
parents:
diff changeset
152 return isZeroingPropIvar(BO);
anatofuz
parents:
diff changeset
153 if (PseudoObjectExpr *PO = dyn_cast<PseudoObjectExpr>(E))
anatofuz
parents:
diff changeset
154 return isZeroingPropIvar(PO);
anatofuz
parents:
diff changeset
155 return false;
anatofuz
parents:
diff changeset
156 }
anatofuz
parents:
diff changeset
157
anatofuz
parents:
diff changeset
158 bool isZeroingPropIvar(BinaryOperator *BOE) {
anatofuz
parents:
diff changeset
159 if (BOE->getOpcode() == BO_Comma)
anatofuz
parents:
diff changeset
160 return isZeroingPropIvar(BOE->getLHS()) &&
anatofuz
parents:
diff changeset
161 isZeroingPropIvar(BOE->getRHS());
anatofuz
parents:
diff changeset
162
anatofuz
parents:
diff changeset
163 if (BOE->getOpcode() != BO_Assign)
anatofuz
parents:
diff changeset
164 return false;
anatofuz
parents:
diff changeset
165
anatofuz
parents:
diff changeset
166 Expr *LHS = BOE->getLHS();
anatofuz
parents:
diff changeset
167 if (ObjCIvarRefExpr *IV = dyn_cast<ObjCIvarRefExpr>(LHS)) {
anatofuz
parents:
diff changeset
168 ObjCIvarDecl *IVDecl = IV->getDecl();
anatofuz
parents:
diff changeset
169 if (!IVDecl->getType()->isObjCObjectPointerType())
anatofuz
parents:
diff changeset
170 return false;
anatofuz
parents:
diff changeset
171 bool IvarBacksPropertySynthesis = false;
anatofuz
parents:
diff changeset
172 for (llvm::DenseMap<ObjCPropertyDecl*, ObjCPropertyImplDecl*>::iterator
anatofuz
parents:
diff changeset
173 P = SynthesizedProperties.begin(),
anatofuz
parents:
diff changeset
174 E = SynthesizedProperties.end(); P != E; ++P) {
anatofuz
parents:
diff changeset
175 ObjCPropertyImplDecl *PropImpDecl = P->second;
anatofuz
parents:
diff changeset
176 if (PropImpDecl && PropImpDecl->getPropertyIvarDecl() == IVDecl) {
anatofuz
parents:
diff changeset
177 IvarBacksPropertySynthesis = true;
anatofuz
parents:
diff changeset
178 break;
anatofuz
parents:
diff changeset
179 }
anatofuz
parents:
diff changeset
180 }
anatofuz
parents:
diff changeset
181 if (!IvarBacksPropertySynthesis)
anatofuz
parents:
diff changeset
182 return false;
anatofuz
parents:
diff changeset
183 }
anatofuz
parents:
diff changeset
184 else
anatofuz
parents:
diff changeset
185 return false;
anatofuz
parents:
diff changeset
186
anatofuz
parents:
diff changeset
187 return isZero(BOE->getRHS());
anatofuz
parents:
diff changeset
188 }
anatofuz
parents:
diff changeset
189
anatofuz
parents:
diff changeset
190 bool isZeroingPropIvar(PseudoObjectExpr *PO) {
anatofuz
parents:
diff changeset
191 BinaryOperator *BO = dyn_cast<BinaryOperator>(PO->getSyntacticForm());
anatofuz
parents:
diff changeset
192 if (!BO) return false;
anatofuz
parents:
diff changeset
193 if (BO->getOpcode() != BO_Assign) return false;
anatofuz
parents:
diff changeset
194
anatofuz
parents:
diff changeset
195 ObjCPropertyRefExpr *PropRefExp =
anatofuz
parents:
diff changeset
196 dyn_cast<ObjCPropertyRefExpr>(BO->getLHS()->IgnoreParens());
anatofuz
parents:
diff changeset
197 if (!PropRefExp) return false;
anatofuz
parents:
diff changeset
198
anatofuz
parents:
diff changeset
199 // TODO: Using implicit property decl.
anatofuz
parents:
diff changeset
200 if (PropRefExp->isImplicitProperty())
anatofuz
parents:
diff changeset
201 return false;
anatofuz
parents:
diff changeset
202
anatofuz
parents:
diff changeset
203 if (ObjCPropertyDecl *PDecl = PropRefExp->getExplicitProperty()) {
anatofuz
parents:
diff changeset
204 if (!SynthesizedProperties.count(PDecl))
anatofuz
parents:
diff changeset
205 return false;
anatofuz
parents:
diff changeset
206 }
anatofuz
parents:
diff changeset
207
anatofuz
parents:
diff changeset
208 return isZero(cast<OpaqueValueExpr>(BO->getRHS())->getSourceExpr());
anatofuz
parents:
diff changeset
209 }
anatofuz
parents:
diff changeset
210
anatofuz
parents:
diff changeset
211 bool isZero(Expr *E) {
anatofuz
parents:
diff changeset
212 if (E->isNullPointerConstant(Pass.Ctx, Expr::NPC_ValueDependentIsNull))
anatofuz
parents:
diff changeset
213 return true;
anatofuz
parents:
diff changeset
214
anatofuz
parents:
diff changeset
215 return isZeroingPropIvar(E);
anatofuz
parents:
diff changeset
216 }
anatofuz
parents:
diff changeset
217 };
anatofuz
parents:
diff changeset
218
anatofuz
parents:
diff changeset
219 } // anonymous namespace
anatofuz
parents:
diff changeset
220
anatofuz
parents:
diff changeset
221 void trans::removeZeroOutPropsInDeallocFinalize(MigrationPass &pass) {
anatofuz
parents:
diff changeset
222 ZeroOutInDeallocRemover trans(pass);
anatofuz
parents:
diff changeset
223 trans.TraverseDecl(pass.Ctx.getTranslationUnitDecl());
anatofuz
parents:
diff changeset
224 }