1 //===--- Tranforms.cpp - Tranformations to ARC mode -----------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "Transforms.h"
11 #include "Internals.h"
12 #include "clang/Sema/SemaDiagnostic.h"
13 #include "clang/AST/RecursiveASTVisitor.h"
14 #include "clang/AST/StmtVisitor.h"
15 #include "clang/Analysis/DomainSpecific/CocoaConventions.h"
16 #include "clang/Lex/Lexer.h"
17 #include "clang/Basic/SourceManager.h"
18 #include "llvm/ADT/StringSwitch.h"
19 #include "llvm/ADT/DenseSet.h"
20 #include <map>
21 
22 using namespace clang;
23 using namespace arcmt;
24 using namespace trans;
25 
26 ASTTraverser::~ASTTraverser() { }
27 
28 //===----------------------------------------------------------------------===//
29 // Helpers.
30 //===----------------------------------------------------------------------===//
31 
32 /// \brief True if the class is one that does not support weak.
33 static bool isClassInWeakBlacklist(ObjCInterfaceDecl *cls) {
34   if (!cls)
35     return false;
36 
37   bool inList = llvm::StringSwitch<bool>(cls->getName())
38                  .Case("NSColorSpace", true)
39                  .Case("NSFont", true)
40                  .Case("NSFontPanel", true)
41                  .Case("NSImage", true)
42                  .Case("NSLazyBrowserCell", true)
43                  .Case("NSWindow", true)
44                  .Case("NSWindowController", true)
45                  .Case("NSViewController", true)
46                  .Case("NSMenuView", true)
47                  .Case("NSPersistentUIWindowInfo", true)
48                  .Case("NSTableCellView", true)
49                  .Case("NSATSTypeSetter", true)
50                  .Case("NSATSGlyphStorage", true)
51                  .Case("NSLineFragmentRenderingContext", true)
52                  .Case("NSAttributeDictionary", true)
53                  .Case("NSParagraphStyle", true)
54                  .Case("NSTextTab", true)
55                  .Case("NSSimpleHorizontalTypesetter", true)
56                  .Case("_NSCachedAttributedString", true)
57                  .Case("NSStringDrawingTextStorage", true)
58                  .Case("NSTextView", true)
59                  .Case("NSSubTextStorage", true)
60                  .Default(false);
61 
62   if (inList)
63     return true;
64 
65   return isClassInWeakBlacklist(cls->getSuperClass());
66 }
67 
68 bool trans::canApplyWeak(ASTContext &Ctx, QualType type,
69                          bool AllowOnUnknownClass) {
70   if (!Ctx.getLangOptions().ObjCRuntimeHasWeak)
71     return false;
72 
73   QualType T = type;
74   if (T.isNull())
75     return false;
76 
77   while (const PointerType *ptr = T->getAs<PointerType>())
78     T = ptr->getPointeeType();
79   if (const ObjCObjectPointerType *ObjT = T->getAs<ObjCObjectPointerType>()) {
80     ObjCInterfaceDecl *Class = ObjT->getInterfaceDecl();
81     if (!AllowOnUnknownClass && (!Class || Class->getName() == "NSObject"))
82       return false; // id/NSObject is not safe for weak.
83     if (!AllowOnUnknownClass && !Class->hasDefinition())
84       return false; // forward classes are not verifiable, therefore not safe.
85     if (Class->isArcWeakrefUnavailable())
86       return false;
87     if (isClassInWeakBlacklist(Class))
88       return false;
89   }
90 
91   return true;
92 }
93 
94 /// \brief 'Loc' is the end of a statement range. This returns the location
95 /// immediately after the semicolon following the statement.
96 /// If no semicolon is found or the location is inside a macro, the returned
97 /// source location will be invalid.
98 SourceLocation trans::findLocationAfterSemi(SourceLocation loc,
99                                             ASTContext &Ctx) {
100   SourceLocation SemiLoc = findSemiAfterLocation(loc, Ctx);
101   if (SemiLoc.isInvalid())
102     return SourceLocation();
103   return SemiLoc.getLocWithOffset(1);
104 }
105 
106 /// \brief \arg Loc is the end of a statement range. This returns the location
107 /// of the semicolon following the statement.
108 /// If no semicolon is found or the location is inside a macro, the returned
109 /// source location will be invalid.
110 SourceLocation trans::findSemiAfterLocation(SourceLocation loc,
111                                             ASTContext &Ctx) {
112   SourceManager &SM = Ctx.getSourceManager();
113   if (loc.isMacroID()) {
114     if (!Lexer::isAtEndOfMacroExpansion(loc, SM, Ctx.getLangOptions(), &loc))
115       return SourceLocation();
116   }
117   loc = Lexer::getLocForEndOfToken(loc, /*Offset=*/0, SM, Ctx.getLangOptions());
118 
119   // Break down the source location.
120   std::pair<FileID, unsigned> locInfo = SM.getDecomposedLoc(loc);
121 
122   // Try to load the file buffer.
123   bool invalidTemp = false;
124   StringRef file = SM.getBufferData(locInfo.first, &invalidTemp);
125   if (invalidTemp)
126     return SourceLocation();
127 
128   const char *tokenBegin = file.data() + locInfo.second;
129 
130   // Lex from the start of the given location.
131   Lexer lexer(SM.getLocForStartOfFile(locInfo.first),
132               Ctx.getLangOptions(),
133               file.begin(), tokenBegin, file.end());
134   Token tok;
135   lexer.LexFromRawLexer(tok);
136   if (tok.isNot(tok::semi))
137     return SourceLocation();
138 
139   return tok.getLocation();
140 }
141 
142 bool trans::hasSideEffects(Expr *E, ASTContext &Ctx) {
143   if (!E || !E->HasSideEffects(Ctx))
144     return false;
145 
146   E = E->IgnoreParenCasts();
147   ObjCMessageExpr *ME = dyn_cast<ObjCMessageExpr>(E);
148   if (!ME)
149     return true;
150   switch (ME->getMethodFamily()) {
151   case OMF_autorelease:
152   case OMF_dealloc:
153   case OMF_release:
154   case OMF_retain:
155     switch (ME->getReceiverKind()) {
156     case ObjCMessageExpr::SuperInstance:
157       return false;
158     case ObjCMessageExpr::Instance:
159       return hasSideEffects(ME->getInstanceReceiver(), Ctx);
160     default:
161       break;
162     }
163     break;
164   default:
165     break;
166   }
167 
168   return true;
169 }
170 
171 bool trans::isGlobalVar(Expr *E) {
172   E = E->IgnoreParenCasts();
173   if (DeclRefExpr *DRE = dyn_cast<DeclRefExpr>(E))
174     return DRE->getDecl()->getDeclContext()->isFileContext() &&
175            DRE->getDecl()->getLinkage() == ExternalLinkage;
176   if (ConditionalOperator *condOp = dyn_cast<ConditionalOperator>(E))
177     return isGlobalVar(condOp->getTrueExpr()) &&
178            isGlobalVar(condOp->getFalseExpr());
179 
180   return false;
181 }
182 
183 StringRef trans::getNilString(ASTContext &Ctx) {
184   if (Ctx.Idents.get("nil").hasMacroDefinition())
185     return "nil";
186   else
187     return "0";
188 }
189 
190 namespace {
191 
192 class ReferenceClear : public RecursiveASTVisitor<ReferenceClear> {
193   ExprSet &Refs;
194 public:
195   ReferenceClear(ExprSet &refs) : Refs(refs) { }
196   bool VisitDeclRefExpr(DeclRefExpr *E) { Refs.erase(E); return true; }
197   bool VisitBlockDeclRefExpr(BlockDeclRefExpr *E) { Refs.erase(E); return true; }
198 };
199 
200 class ReferenceCollector : public RecursiveASTVisitor<ReferenceCollector> {
201   ValueDecl *Dcl;
202   ExprSet &Refs;
203 
204 public:
205   ReferenceCollector(ValueDecl *D, ExprSet &refs)
206     : Dcl(D), Refs(refs) { }
207 
208   bool VisitDeclRefExpr(DeclRefExpr *E) {
209     if (E->getDecl() == Dcl)
210       Refs.insert(E);
211     return true;
212   }
213 
214   bool VisitBlockDeclRefExpr(BlockDeclRefExpr *E) {
215     if (E->getDecl() == Dcl)
216       Refs.insert(E);
217     return true;
218   }
219 };
220 
221 class RemovablesCollector : public RecursiveASTVisitor<RemovablesCollector> {
222   ExprSet &Removables;
223 
224 public:
225   RemovablesCollector(ExprSet &removables)
226   : Removables(removables) { }
227 
228   bool shouldWalkTypesOfTypeLocs() const { return false; }
229 
230   bool TraverseStmtExpr(StmtExpr *E) {
231     CompoundStmt *S = E->getSubStmt();
232     for (CompoundStmt::body_iterator
233         I = S->body_begin(), E = S->body_end(); I != E; ++I) {
234       if (I != E - 1)
235         mark(*I);
236       TraverseStmt(*I);
237     }
238     return true;
239   }
240 
241   bool VisitCompoundStmt(CompoundStmt *S) {
242     for (CompoundStmt::body_iterator
243         I = S->body_begin(), E = S->body_end(); I != E; ++I)
244       mark(*I);
245     return true;
246   }
247 
248   bool VisitIfStmt(IfStmt *S) {
249     mark(S->getThen());
250     mark(S->getElse());
251     return true;
252   }
253 
254   bool VisitWhileStmt(WhileStmt *S) {
255     mark(S->getBody());
256     return true;
257   }
258 
259   bool VisitDoStmt(DoStmt *S) {
260     mark(S->getBody());
261     return true;
262   }
263 
264   bool VisitForStmt(ForStmt *S) {
265     mark(S->getInit());
266     mark(S->getInc());
267     mark(S->getBody());
268     return true;
269   }
270 
271 private:
272   void mark(Stmt *S) {
273     if (!S) return;
274 
275     while (LabelStmt *Label = dyn_cast<LabelStmt>(S))
276       S = Label->getSubStmt();
277     S = S->IgnoreImplicit();
278     if (Expr *E = dyn_cast<Expr>(S))
279       Removables.insert(E);
280   }
281 };
282 
283 } // end anonymous namespace
284 
285 void trans::clearRefsIn(Stmt *S, ExprSet &refs) {
286   ReferenceClear(refs).TraverseStmt(S);
287 }
288 
289 void trans::collectRefs(ValueDecl *D, Stmt *S, ExprSet &refs) {
290   ReferenceCollector(D, refs).TraverseStmt(S);
291 }
292 
293 void trans::collectRemovables(Stmt *S, ExprSet &exprs) {
294   RemovablesCollector(exprs).TraverseStmt(S);
295 }
296 
297 //===----------------------------------------------------------------------===//
298 // MigrationContext
299 //===----------------------------------------------------------------------===//
300 
301 namespace {
302 
303 class ASTTransform : public RecursiveASTVisitor<ASTTransform> {
304   MigrationContext &MigrateCtx;
305   typedef RecursiveASTVisitor<ASTTransform> base;
306 
307 public:
308   ASTTransform(MigrationContext &MigrateCtx) : MigrateCtx(MigrateCtx) { }
309 
310   bool shouldWalkTypesOfTypeLocs() const { return false; }
311 
312   bool TraverseObjCImplementationDecl(ObjCImplementationDecl *D) {
313     ObjCImplementationContext ImplCtx(MigrateCtx, D);
314     for (MigrationContext::traverser_iterator
315            I = MigrateCtx.traversers_begin(),
316            E = MigrateCtx.traversers_end(); I != E; ++I)
317       (*I)->traverseObjCImplementation(ImplCtx);
318 
319     return base::TraverseObjCImplementationDecl(D);
320   }
321 
322   bool TraverseStmt(Stmt *rootS) {
323     if (!rootS)
324       return true;
325 
326     BodyContext BodyCtx(MigrateCtx, rootS);
327     for (MigrationContext::traverser_iterator
328            I = MigrateCtx.traversers_begin(),
329            E = MigrateCtx.traversers_end(); I != E; ++I)
330       (*I)->traverseBody(BodyCtx);
331 
332     return true;
333   }
334 };
335 
336 }
337 
338 MigrationContext::~MigrationContext() {
339   for (traverser_iterator
340          I = traversers_begin(), E = traversers_end(); I != E; ++I)
341     delete *I;
342 }
343 
344 bool MigrationContext::isGCOwnedNonObjC(QualType T) {
345   while (!T.isNull()) {
346     if (const AttributedType *AttrT = T->getAs<AttributedType>()) {
347       if (AttrT->getAttrKind() == AttributedType::attr_objc_ownership)
348         return !AttrT->getModifiedType()->isObjCRetainableType();
349     }
350 
351     if (T->isArrayType())
352       T = Pass.Ctx.getBaseElementType(T);
353     else if (const PointerType *PT = T->getAs<PointerType>())
354       T = PT->getPointeeType();
355     else if (const ReferenceType *RT = T->getAs<ReferenceType>())
356       T = RT->getPointeeType();
357     else
358       break;
359   }
360 
361   return false;
362 }
363 
364 bool MigrationContext::rewritePropertyAttribute(StringRef fromAttr,
365                                                 StringRef toAttr,
366                                                 SourceLocation atLoc) {
367   if (atLoc.isMacroID())
368     return false;
369 
370   SourceManager &SM = Pass.Ctx.getSourceManager();
371 
372   // Break down the source location.
373   std::pair<FileID, unsigned> locInfo = SM.getDecomposedLoc(atLoc);
374 
375   // Try to load the file buffer.
376   bool invalidTemp = false;
377   StringRef file = SM.getBufferData(locInfo.first, &invalidTemp);
378   if (invalidTemp)
379     return false;
380 
381   const char *tokenBegin = file.data() + locInfo.second;
382 
383   // Lex from the start of the given location.
384   Lexer lexer(SM.getLocForStartOfFile(locInfo.first),
385               Pass.Ctx.getLangOptions(),
386               file.begin(), tokenBegin, file.end());
387   Token tok;
388   lexer.LexFromRawLexer(tok);
389   if (tok.isNot(tok::at)) return false;
390   lexer.LexFromRawLexer(tok);
391   if (tok.isNot(tok::raw_identifier)) return false;
392   if (StringRef(tok.getRawIdentifierData(), tok.getLength())
393         != "property")
394     return false;
395   lexer.LexFromRawLexer(tok);
396   if (tok.isNot(tok::l_paren)) return false;
397 
398   Token BeforeTok = tok;
399   Token AfterTok;
400   AfterTok.startToken();
401   SourceLocation AttrLoc;
402 
403   lexer.LexFromRawLexer(tok);
404   if (tok.is(tok::r_paren))
405     return false;
406 
407   while (1) {
408     if (tok.isNot(tok::raw_identifier)) return false;
409     StringRef ident(tok.getRawIdentifierData(), tok.getLength());
410     if (ident == fromAttr) {
411       if (!toAttr.empty()) {
412         Pass.TA.replaceText(tok.getLocation(), fromAttr, toAttr);
413         return true;
414       }
415       // We want to remove the attribute.
416       AttrLoc = tok.getLocation();
417     }
418 
419     do {
420       lexer.LexFromRawLexer(tok);
421       if (AttrLoc.isValid() && AfterTok.is(tok::unknown))
422         AfterTok = tok;
423     } while (tok.isNot(tok::comma) && tok.isNot(tok::r_paren));
424     if (tok.is(tok::r_paren))
425       break;
426     if (AttrLoc.isInvalid())
427       BeforeTok = tok;
428     lexer.LexFromRawLexer(tok);
429   }
430 
431   if (toAttr.empty() && AttrLoc.isValid() && AfterTok.isNot(tok::unknown)) {
432     // We want to remove the attribute.
433     if (BeforeTok.is(tok::l_paren) && AfterTok.is(tok::r_paren)) {
434       Pass.TA.remove(SourceRange(BeforeTok.getLocation(),
435                                  AfterTok.getLocation()));
436     } else if (BeforeTok.is(tok::l_paren) && AfterTok.is(tok::comma)) {
437       Pass.TA.remove(SourceRange(AttrLoc, AfterTok.getLocation()));
438     } else {
439       Pass.TA.remove(SourceRange(BeforeTok.getLocation(), AttrLoc));
440     }
441 
442     return true;
443   }
444 
445   return false;
446 }
447 
448 bool MigrationContext::addPropertyAttribute(StringRef attr,
449                                             SourceLocation atLoc) {
450   if (atLoc.isMacroID())
451     return false;
452 
453   SourceManager &SM = Pass.Ctx.getSourceManager();
454 
455   // Break down the source location.
456   std::pair<FileID, unsigned> locInfo = SM.getDecomposedLoc(atLoc);
457 
458   // Try to load the file buffer.
459   bool invalidTemp = false;
460   StringRef file = SM.getBufferData(locInfo.first, &invalidTemp);
461   if (invalidTemp)
462     return false;
463 
464   const char *tokenBegin = file.data() + locInfo.second;
465 
466   // Lex from the start of the given location.
467   Lexer lexer(SM.getLocForStartOfFile(locInfo.first),
468               Pass.Ctx.getLangOptions(),
469               file.begin(), tokenBegin, file.end());
470   Token tok;
471   lexer.LexFromRawLexer(tok);
472   if (tok.isNot(tok::at)) return false;
473   lexer.LexFromRawLexer(tok);
474   if (tok.isNot(tok::raw_identifier)) return false;
475   if (StringRef(tok.getRawIdentifierData(), tok.getLength())
476         != "property")
477     return false;
478   lexer.LexFromRawLexer(tok);
479 
480   if (tok.isNot(tok::l_paren)) {
481     Pass.TA.insert(tok.getLocation(), std::string("(") + attr.str() + ") ");
482     return true;
483   }
484 
485   lexer.LexFromRawLexer(tok);
486   if (tok.is(tok::r_paren)) {
487     Pass.TA.insert(tok.getLocation(), attr);
488     return true;
489   }
490 
491   if (tok.isNot(tok::raw_identifier)) return false;
492 
493   Pass.TA.insert(tok.getLocation(), std::string(attr) + ", ");
494   return true;
495 }
496 
497 void MigrationContext::traverse(TranslationUnitDecl *TU) {
498   for (traverser_iterator
499          I = traversers_begin(), E = traversers_end(); I != E; ++I)
500     (*I)->traverseTU(*this);
501 
502   ASTTransform(*this).TraverseDecl(TU);
503 }
504 
505 static void GCRewriteFinalize(MigrationPass &pass) {
506   ASTContext &Ctx = pass.Ctx;
507   TransformActions &TA = pass.TA;
508   DeclContext *DC = Ctx.getTranslationUnitDecl();
509   Selector FinalizeSel =
510    Ctx.Selectors.getNullarySelector(&pass.Ctx.Idents.get("finalize"));
511 
512   typedef DeclContext::specific_decl_iterator<ObjCImplementationDecl>
513   impl_iterator;
514   for (impl_iterator I = impl_iterator(DC->decls_begin()),
515        E = impl_iterator(DC->decls_end()); I != E; ++I) {
516     for (ObjCImplementationDecl::instmeth_iterator
517          MI = (*I)->instmeth_begin(),
518          ME = (*I)->instmeth_end(); MI != ME; ++MI) {
519       ObjCMethodDecl *MD = *MI;
520       if (!MD->hasBody())
521         continue;
522 
523       if (MD->isInstanceMethod() && MD->getSelector() == FinalizeSel) {
524         ObjCMethodDecl *FinalizeM = MD;
525         Transaction Trans(TA);
526         TA.insert(FinalizeM->getSourceRange().getBegin(),
527                   "#if !__has_feature(objc_arc)\n");
528         CharSourceRange::getTokenRange(FinalizeM->getSourceRange());
529         const SourceManager &SM = pass.Ctx.getSourceManager();
530         const LangOptions &LangOpts = pass.Ctx.getLangOptions();
531         bool Invalid;
532         std::string str = "\n#endif\n";
533         str += Lexer::getSourceText(
534                   CharSourceRange::getTokenRange(FinalizeM->getSourceRange()),
535                                     SM, LangOpts, &Invalid);
536         TA.insertAfterToken(FinalizeM->getSourceRange().getEnd(), str);
537 
538         break;
539       }
540     }
541   }
542 }
543 
544 //===----------------------------------------------------------------------===//
545 // getAllTransformations.
546 //===----------------------------------------------------------------------===//
547 
548 static void traverseAST(MigrationPass &pass) {
549   MigrationContext MigrateCtx(pass);
550 
551   if (pass.isGCMigration()) {
552     MigrateCtx.addTraverser(new GCCollectableCallsTraverser);
553     MigrateCtx.addTraverser(new GCAttrsTraverser());
554   }
555   MigrateCtx.addTraverser(new PropertyRewriteTraverser());
556 
557   MigrateCtx.traverse(pass.Ctx.getTranslationUnitDecl());
558 }
559 
560 static void independentTransforms(MigrationPass &pass) {
561   rewriteAutoreleasePool(pass);
562   removeRetainReleaseDeallocFinalize(pass);
563   rewriteUnusedInitDelegate(pass);
564   removeZeroOutPropsInDeallocFinalize(pass);
565   makeAssignARCSafe(pass);
566   rewriteUnbridgedCasts(pass);
567   rewriteBlockObjCVariable(pass);
568   checkAPIUses(pass);
569   traverseAST(pass);
570 }
571 
572 std::vector<TransformFn> arcmt::getAllTransformations(
573                                                LangOptions::GCMode OrigGCMode,
574                                                bool NoFinalizeRemoval) {
575   std::vector<TransformFn> transforms;
576 
577   if (OrigGCMode ==  LangOptions::GCOnly && NoFinalizeRemoval)
578     transforms.push_back(GCRewriteFinalize);
579   transforms.push_back(independentTransforms);
580   // This depends on previous transformations removing various expressions.
581   transforms.push_back(removeEmptyStatementsAndDeallocFinalize);
582 
583   return transforms;
584 }
585