LLVM  17.0.0git
ObjCARCAliasAnalysis.h
Go to the documentation of this file.
1 //===- ObjCARCAliasAnalysis.h - ObjC ARC Alias Analysis ---------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 /// \file
9 /// This file declares a simple ARC-aware AliasAnalysis using special knowledge
10 /// of Objective C to enhance other optimization passes which rely on the Alias
11 /// Analysis infrastructure.
12 ///
13 /// WARNING: This file knows about certain library functions. It recognizes them
14 /// by name, and hardwires knowledge of their semantics.
15 ///
16 /// WARNING: This file knows about how certain Objective-C library functions are
17 /// used. Naive LLVM IR transformations which would otherwise be
18 /// behavior-preserving may break these assumptions.
19 ///
20 //===----------------------------------------------------------------------===//
21 
22 #ifndef LLVM_ANALYSIS_OBJCARCALIASANALYSIS_H
23 #define LLVM_ANALYSIS_OBJCARCALIASANALYSIS_H
24 
26 #include "llvm/Pass.h"
27 
28 namespace llvm {
29 namespace objcarc {
30 
31 /// This is a simple alias analysis implementation that uses knowledge
32 /// of ARC constructs to answer queries.
33 ///
34 /// TODO: This class could be generalized to know about other ObjC-specific
35 /// tricks. Such as knowing that ivars in the non-fragile ABI are non-aliasing
36 /// even though their offsets are dynamic.
37 class ObjCARCAAResult : public AAResultBase {
38  const DataLayout &DL;
39 
40 public:
41  explicit ObjCARCAAResult(const DataLayout &DL) : DL(DL) {}
43  : AAResultBase(std::move(Arg)), DL(Arg.DL) {}
44 
45  /// Handle invalidation events from the new pass manager.
46  ///
47  /// By definition, this result is stateless and so remains valid.
50  return false;
51  }
52 
53  AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB,
54  AAQueryInfo &AAQI, const Instruction *CtxI);
56  bool IgnoreLocals);
57 
60 
62  ModRefInfo getModRefInfo(const CallBase *Call, const MemoryLocation &Loc,
63  AAQueryInfo &AAQI);
64 };
65 
66 /// Analysis pass providing a never-invalidated alias analysis result.
67 class ObjCARCAA : public AnalysisInfoMixin<ObjCARCAA> {
69  static AnalysisKey Key;
70 
71 public:
73 
75 };
76 
77 } // namespace objcarc
78 } // namespace llvm
79 
80 #endif
llvm::PreservedAnalyses
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:152
llvm::objcarc::ObjCARCAAResult::getModRefInfoMask
ModRefInfo getModRefInfoMask(const MemoryLocation &Loc, AAQueryInfo &AAQI, bool IgnoreLocals)
Definition: ObjCARCAliasAnalysis.cpp:72
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
llvm::DataLayout
A parsed version of the target data layout string in and methods for querying it.
Definition: DataLayout.h:114
llvm::objcarc::ObjCARCAAResult::getMemoryEffects
MemoryEffects getMemoryEffects(const Function *F)
Definition: ObjCARCAliasAnalysis.cpp:97
llvm::objcarc::ObjCARCAAResult::ObjCARCAAResult
ObjCARCAAResult(ObjCARCAAResult &&Arg)
Definition: ObjCARCAliasAnalysis.h:42
llvm::Function
Definition: Function.h:59
Pass.h
llvm::objcarc::ObjCARCAAResult
This is a simple alias analysis implementation that uses knowledge of ARC constructs to answer querie...
Definition: ObjCARCAliasAnalysis.h:37
llvm::AliasResult
The possible results of an alias query.
Definition: AliasAnalysis.h:83
F
#define F(x, y, z)
Definition: MD5.cpp:55
AliasAnalysis.h
llvm::MemoryEffects
Summary of how a function affects memory in the program.
Definition: ModRef.h:63
Arg
amdgpu Simplify well known AMD library false FunctionCallee Value * Arg
Definition: AMDGPULibCalls.cpp:187
llvm::AAQueryInfo
This class stores info we want to provide to or retain within an alias query.
Definition: AliasAnalysis.h:233
llvm::Instruction
Definition: Instruction.h:41
llvm::AnalysisManager::Invalidator
API to communicate dependencies between analyses during invalidation.
Definition: PassManager.h:661
llvm::objcarc::ObjCARCAAResult::getModRefInfo
ModRefInfo getModRefInfo(const CallBase *Call, const MemoryLocation &Loc, AAQueryInfo &AAQI)
Definition: ObjCARCAliasAnalysis.cpp:111
llvm::objcarc::ObjCARCAA::Result
ObjCARCAAResult Result
Definition: ObjCARCAliasAnalysis.h:72
llvm::AnalysisKey
A special type used by analysis passes to provide an address that identifies that particular analysis...
Definition: PassManager.h:69
llvm::objcarc::ObjCARCAA
Analysis pass providing a never-invalidated alias analysis result.
Definition: ObjCARCAliasAnalysis.h:67
llvm::objcarc::ObjCARCAAResult::alias
AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB, AAQueryInfo &AAQI, const Instruction *CtxI)
Definition: ObjCARCAliasAnalysis.cpp:37
llvm::objcarc::ObjCARCAAResult::ObjCARCAAResult
ObjCARCAAResult(const DataLayout &DL)
Definition: ObjCARCAliasAnalysis.h:41
llvm::ModRefInfo
ModRefInfo
Flags indicating whether a memory access modifies or references memory.
Definition: ModRef.h:27
llvm::move
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Definition: STLExtras.h:1862
llvm::AnalysisInfoMixin
A CRTP mix-in that provides informational APIs needed for analysis passes.
Definition: PassManager.h:394
llvm::objcarc::ObjCARCAA::run
ObjCARCAAResult run(Function &F, FunctionAnalysisManager &AM)
Definition: ObjCARCAliasAnalysis.cpp:139
llvm::objcarc::ObjCARCAAResult::invalidate
bool invalidate(Function &, const PreservedAnalyses &, FunctionAnalysisManager::Invalidator &)
Handle invalidation events from the new pass manager.
Definition: ObjCARCAliasAnalysis.h:48
DL
MachineBasicBlock MachineBasicBlock::iterator DebugLoc DL
Definition: AArch64SLSHardening.cpp:76
std
Definition: BitVector.h:851
llvm::AAResultBase::getModRefInfo
ModRefInfo getModRefInfo(const CallBase *Call, const MemoryLocation &Loc, AAQueryInfo &AAQI)
Definition: AliasAnalysis.h:826
llvm::AAResultBase::getMemoryEffects
MemoryEffects getMemoryEffects(const CallBase *Call, AAQueryInfo &AAQI)
Definition: AliasAnalysis.h:818
llvm::CallBase
Base class for all callable instructions (InvokeInst and CallInst) Holds everything related to callin...
Definition: InstrTypes.h:1184
llvm::AnalysisManager
A container for analyses that lazily runs them and caches their results.
Definition: InstructionSimplify.h:42
llvm::AAResultBase
A base class to help implement the function alias analysis results concept.
Definition: AliasAnalysis.h:794
llvm::MemoryLocation
Representation for a specific memory location.
Definition: MemoryLocation.h:211