1//===-------------------- NVPTXAliasAnalysis.h ------------------*- 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 is the NVPTX address space based alias analysis pass.
10//===----------------------------------------------------------------------===//
11
12#ifndef LLVM_LIB_TARGET_NVPTX_NVPTXALIASANALYSIS_H
13#define LLVM_LIB_TARGET_NVPTX_NVPTXALIASANALYSIS_H
14
15#include "llvm/Analysis/AliasAnalysis.h"
16
17namespace llvm {
18
19class MemoryLocation;
20struct NVPTXOptions;
21
22class NVPTXAAResult : public AAResultBase {
23 const NVPTXOptions &CLOpts;
24
25public:
26 explicit NVPTXAAResult(const NVPTXOptions &CLOpts) : CLOpts(CLOpts) {}
27 NVPTXAAResult(NVPTXAAResult &&Arg)
28 : AAResultBase(std::move(Arg)), CLOpts(Arg.CLOpts) {}
29
30 /// Handle invalidation events from the new pass manager.
31 ///
32 /// This result does not depend on the IR and so remains valid.
33 bool invalidate(Function &, const PreservedAnalyses &,
34 FunctionAnalysisManager::Invalidator &Inv) {
35 return false;
36 }
37
38 AliasResult alias(const MemoryLocation &LocA, const MemoryLocation &LocB,
39 AAQueryInfo &AAQI, const Instruction *CtxI = nullptr);
40
41 ModRefInfo getModRefInfoMask(const MemoryLocation &Loc, AAQueryInfo &AAQI,
42 bool IgnoreLocals);
43
44 MemoryEffects getMemoryEffects(const CallBase *Call, AAQueryInfo &AAQI);
45
46 MemoryEffects getMemoryEffects(const Function *F) {
47 return MemoryEffects::unknown();
48 }
49};
50
51/// Analysis pass providing a never-invalidated alias analysis result.
52class NVPTXAA : public AnalysisInfoMixin<NVPTXAA> {
53 friend AnalysisInfoMixin<NVPTXAA>;
54
55 static AnalysisKey Key;
56
57public:
58 using Result = NVPTXAAResult;
59
60 NVPTXAAResult run(Function &F, AnalysisManager<Function> &AM);
61};
62
63/// Legacy wrapper pass to provide the NVPTXAAResult object.
64class NVPTXAAWrapperPass : public ImmutablePass {
65 std::unique_ptr<NVPTXAAResult> Result;
66
67public:
68 static char ID;
69
70 NVPTXAAWrapperPass();
71
72 NVPTXAAResult &getResult() { return *Result; }
73 const NVPTXAAResult &getResult() const { return *Result; }
74
75 bool doInitialization(Module &M) override;
76
77 bool doFinalization(Module &M) override {
78 Result.reset();
79 return false;
80 }
81
82 void getAnalysisUsage(AnalysisUsage &AU) const override;
83};
84
85// Wrapper around ExternalAAWrapperPass so that the default
86// constructor gets the callback.
87// Note that NVPTXAA will run before BasicAA for compile time considerations.
88class NVPTXExternalAAWrapper : public ExternalAAWrapperPass {
89public:
90 static char ID;
91
92 NVPTXExternalAAWrapper()
93 : ExternalAAWrapperPass(
94 [](Pass &P, Function &, AAResults &AAR) {
95 if (auto *WrapperPass =
96 P.getAnalysisIfAvailable<NVPTXAAWrapperPass>())
97 AAR.addAAResult(AAResult&: WrapperPass->getResult());
98 },
99 /*RunEarly=*/true) {}
100
101 StringRef getPassName() const override {
102 return "NVPTX Address space based Alias Analysis Wrapper";
103 }
104};
105
106ImmutablePass *createNVPTXAAWrapperPass();
107ImmutablePass *createNVPTXExternalAAWrapperPass();
108
109} // end namespace llvm
110
111#endif // LLVM_LIB_TARGET_NVPTX_NVPTXALIASANALYSIS_H
112