LLVM  14.0.0git
Internalize.h
Go to the documentation of this file.
1 //====- Internalize.h - Internalization API ---------------------*- 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 //
9 // This pass loops over all of the functions and variables in the input module.
10 // If the function or variable does not need to be preserved according to the
11 // client supplied callback, it is marked as internal.
12 //
13 // This transformation would not be legal in a regular compilation, but it gets
14 // extra information from the linker about what is safe.
15 //
16 // For example: Internalizing a function with external linkage. Only if we are
17 // told it is only used from within this module, it is safe to do it.
18 //
19 //===----------------------------------------------------------------------===//
20 
21 #ifndef LLVM_TRANSFORMS_IPO_INTERNALIZE_H
22 #define LLVM_TRANSFORMS_IPO_INTERNALIZE_H
23 
24 #include "llvm/ADT/DenseMap.h"
25 #include "llvm/ADT/StringSet.h"
26 #include "llvm/IR/GlobalValue.h"
27 #include "llvm/IR/PassManager.h"
28 #include <functional>
29 
30 namespace llvm {
31 class Module;
32 class CallGraph;
33 
34 /// A pass that internalizes all functions and variables other than those that
35 /// must be preserved according to \c MustPreserveGV.
36 class InternalizePass : public PassInfoMixin<InternalizePass> {
37  struct ComdatInfo {
38  // The number of members. A comdat with one member which is not externally
39  // visible can be freely dropped.
40  size_t Size = 0;
41  // Whether the comdat has an externally visible member.
42  bool External = false;
43  };
44 
45  bool IsWasm = false;
46 
47  /// Client supplied callback to control wheter a symbol must be preserved.
48  const std::function<bool(const GlobalValue &)> MustPreserveGV;
49  /// Set of symbols private to the compiler that this pass should not touch.
50  StringSet<> AlwaysPreserved;
51 
52  /// Return false if we're allowed to internalize this GV.
53  bool shouldPreserveGV(const GlobalValue &GV);
54  /// Internalize GV if it is possible to do so, i.e. it is not externally
55  /// visible and is not a member of an externally visible comdat.
56  bool maybeInternalize(GlobalValue &GV,
58  /// If GV is part of a comdat and is externally visible, keep track of its
59  /// comdat so that we don't internalize any of its members.
60  void checkComdat(GlobalValue &GV,
62 
63 public:
65  InternalizePass(std::function<bool(const GlobalValue &)> MustPreserveGV)
66  : MustPreserveGV(std::move(MustPreserveGV)) {}
67 
68  /// Run the internalizer on \p TheModule, returns true if any changes was
69  /// made.
70  ///
71  /// If the CallGraph \p CG is supplied, it will be updated when
72  /// internalizing a function (by removing any edge from the "external node")
73  bool internalizeModule(Module &TheModule, CallGraph *CG = nullptr);
74 
76 };
77 
78 /// Helper function to internalize functions and variables in a Module.
79 inline bool
81  std::function<bool(const GlobalValue &)> MustPreserveGV,
82  CallGraph *CG = nullptr) {
83  return InternalizePass(std::move(MustPreserveGV))
84  .internalizeModule(TheModule, CG);
85 }
86 } // end namespace llvm
87 
88 #endif // LLVM_TRANSFORMS_IPO_INTERNALIZE_H
llvm::Check::Size
@ Size
Definition: FileCheck.h:73
llvm::PreservedAnalyses
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:155
llvm
This is an optimization pass for GlobalISel generic memory operations.
Definition: AllocatorList.h:23
llvm::PassInfoMixin
A CRTP mix-in to automatically provide informational APIs needed for passes.
Definition: PassManager.h:374
llvm::InternalizePass::internalizeModule
bool internalizeModule(Module &TheModule, CallGraph *CG=nullptr)
Run the internalizer on TheModule, returns true if any changes was made.
Definition: Internalize.cpp:173
llvm::InternalizePass
A pass that internalizes all functions and variables other than those that must be preserved accordin...
Definition: Internalize.h:36
llvm::CallGraph
The basic data container for the call graph of a Module of IR.
Definition: CallGraph.h:73
DenseMap.h
GlobalValue.h
llvm::InternalizePass::InternalizePass
InternalizePass()
Definition: Internalize.cpp:264
llvm::InternalizePass::InternalizePass
InternalizePass(std::function< bool(const GlobalValue &)> MustPreserveGV)
Definition: Internalize.h:65
llvm::GlobalValue
Definition: GlobalValue.h:44
move
compiles ldr LCPI1_0 ldr ldr mov lsr tst moveq r1 ldr LCPI1_1 and r0 bx lr It would be better to do something like to fold the shift into the conditional move
Definition: README.txt:546
llvm::DenseMap
Definition: DenseMap.h:714
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:1658
function
print Print MemDeps of function
Definition: MemDepPrinter.cpp:83
llvm::Module
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:67
llvm::internalizeModule
bool internalizeModule(Module &TheModule, std::function< bool(const GlobalValue &)> MustPreserveGV, CallGraph *CG=nullptr)
Helper function to internalize functions and variables in a Module.
Definition: Internalize.h:80
llvm::StringSet
StringSet - A wrapper for StringMap that provides set-like functionality.
Definition: StringSet.h:22
llvm::InternalizePass::run
PreservedAnalyses run(Module &M, ModuleAnalysisManager &AM)
Definition: Internalize.cpp:266
Module
Machine Check Debug Module
Definition: MachineCheckDebugify.cpp:122
StringSet.h
std
Definition: BitVector.h:838
PassManager.h
llvm::AnalysisManager
A container for analyses that lazily runs them and caches their results.
Definition: InstructionSimplify.h:44