1 //===- ObjCARCAliasAnalysis.cpp - ObjC ARC Optimization -------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 /// This file defines a simple ARC-aware AliasAnalysis using special knowledge
11 /// of Objective C to enhance other optimization passes which rely on the Alias
12 /// Analysis infrastructure.
14 /// WARNING: This file knows about certain library functions. It recognizes them
15 /// by name, and hardwires knowledge of their semantics.
17 /// WARNING: This file knows about how certain Objective-C library functions are
18 /// used. Naive LLVM IR transformations which would otherwise be
19 /// behavior-preserving may break these assumptions.
21 //===----------------------------------------------------------------------===//
24 #include "ObjCARCAliasAnalysis.h"
25 #include "llvm/IR/Instruction.h"
26 #include "llvm/InitializePasses.h"
27 #include "llvm/PassAnalysisSupport.h"
28 #include "llvm/PassSupport.h"
30 #define DEBUG_TYPE "objc-arc-aa"
38 using namespace llvm::objcarc;
40 // Register this pass...
41 char ObjCARCAliasAnalysis::ID = 0;
42 INITIALIZE_AG_PASS(ObjCARCAliasAnalysis, AliasAnalysis, "objc-arc-aa",
43 "ObjC-ARC-Based Alias Analysis", false, true, false)
45 ImmutablePass *llvm::createObjCARCAliasAnalysisPass() {
46 return new ObjCARCAliasAnalysis();
49 bool ObjCARCAliasAnalysis::doInitialization(Module &M) {
50 InitializeAliasAnalysis(this, &M.getDataLayout());
55 ObjCARCAliasAnalysis::getAnalysisUsage(AnalysisUsage &AU) const {
57 AliasAnalysis::getAnalysisUsage(AU);
60 AliasAnalysis::AliasResult
61 ObjCARCAliasAnalysis::alias(const MemoryLocation &LocA,
62 const MemoryLocation &LocB) {
64 return AliasAnalysis::alias(LocA, LocB);
66 // First, strip off no-ops, including ObjC-specific no-ops, and try making a
67 // precise alias query.
68 const Value *SA = GetRCIdentityRoot(LocA.Ptr);
69 const Value *SB = GetRCIdentityRoot(LocB.Ptr);
71 AliasAnalysis::alias(MemoryLocation(SA, LocA.Size, LocA.AATags),
72 MemoryLocation(SB, LocB.Size, LocB.AATags));
73 if (Result != MayAlias)
76 // If that failed, climb to the underlying object, including climbing through
77 // ObjC-specific no-ops, and try making an imprecise alias query.
78 const Value *UA = GetUnderlyingObjCPtr(SA, *DL);
79 const Value *UB = GetUnderlyingObjCPtr(SB, *DL);
80 if (UA != SA || UB != SB) {
81 Result = AliasAnalysis::alias(MemoryLocation(UA), MemoryLocation(UB));
82 // We can't use MustAlias or PartialAlias results here because
83 // GetUnderlyingObjCPtr may return an offsetted pointer value.
84 if (Result == NoAlias)
88 // If that failed, fail. We don't need to chain here, since that's covered
89 // by the earlier precise query.
93 bool ObjCARCAliasAnalysis::pointsToConstantMemory(const MemoryLocation &Loc,
96 return AliasAnalysis::pointsToConstantMemory(Loc, OrLocal);
98 // First, strip off no-ops, including ObjC-specific no-ops, and try making
99 // a precise alias query.
100 const Value *S = GetRCIdentityRoot(Loc.Ptr);
101 if (AliasAnalysis::pointsToConstantMemory(
102 MemoryLocation(S, Loc.Size, Loc.AATags), OrLocal))
105 // If that failed, climb to the underlying object, including climbing through
106 // ObjC-specific no-ops, and try making an imprecise alias query.
107 const Value *U = GetUnderlyingObjCPtr(S, *DL);
109 return AliasAnalysis::pointsToConstantMemory(MemoryLocation(U), OrLocal);
111 // If that failed, fail. We don't need to chain here, since that's covered
112 // by the earlier precise query.
116 AliasAnalysis::ModRefBehavior
117 ObjCARCAliasAnalysis::getModRefBehavior(ImmutableCallSite CS) {
118 // We have nothing to do. Just chain to the next AliasAnalysis.
119 return AliasAnalysis::getModRefBehavior(CS);
122 AliasAnalysis::ModRefBehavior
123 ObjCARCAliasAnalysis::getModRefBehavior(const Function *F) {
125 return AliasAnalysis::getModRefBehavior(F);
127 switch (GetFunctionClass(F)) {
128 case ARCInstKind::NoopCast:
129 return DoesNotAccessMemory;
134 return AliasAnalysis::getModRefBehavior(F);
137 AliasAnalysis::ModRefResult
138 ObjCARCAliasAnalysis::getModRefInfo(ImmutableCallSite CS,
139 const MemoryLocation &Loc) {
141 return AliasAnalysis::getModRefInfo(CS, Loc);
143 switch (GetBasicARCInstKind(CS.getInstruction())) {
144 case ARCInstKind::Retain:
145 case ARCInstKind::RetainRV:
146 case ARCInstKind::Autorelease:
147 case ARCInstKind::AutoreleaseRV:
148 case ARCInstKind::NoopCast:
149 case ARCInstKind::AutoreleasepoolPush:
150 case ARCInstKind::FusedRetainAutorelease:
151 case ARCInstKind::FusedRetainAutoreleaseRV:
152 // These functions don't access any memory visible to the compiler.
153 // Note that this doesn't include objc_retainBlock, because it updates
154 // pointers when it copies block data.
160 return AliasAnalysis::getModRefInfo(CS, Loc);
163 AliasAnalysis::ModRefResult
164 ObjCARCAliasAnalysis::getModRefInfo(ImmutableCallSite CS1,
165 ImmutableCallSite CS2) {
166 // TODO: Theoretically we could check for dependencies between objc_* calls
167 // and OnlyAccessesArgumentPointees calls or other well-behaved calls.
168 return AliasAnalysis::getModRefInfo(CS1, CS2);