LLVM 17.0.0git
Go to the documentation of this file.
1//===- BitcodeWriterPass.cpp - Bitcode writing pass -----------------------===//
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
9// BitcodeWriterPass implementation.
16#include "llvm/IR/PassManager.h"
18#include "llvm/Pass.h"
19using namespace llvm;
23 EmitSummaryIndex ? &(AM.getResult<ModuleSummaryIndexAnalysis>(M))
24 : nullptr;
25 WriteBitcodeToFile(M, OS, ShouldPreserveUseListOrder, Index, EmitModuleHash);
29namespace {
30 class WriteBitcodePass : public ModulePass {
31 raw_ostream &OS; // raw_ostream to print on
32 bool ShouldPreserveUseListOrder;
33 bool EmitSummaryIndex;
34 bool EmitModuleHash;
36 public:
37 static char ID; // Pass identification, replacement for typeid
38 WriteBitcodePass() : ModulePass(ID), OS(dbgs()) {
40 }
42 explicit WriteBitcodePass(raw_ostream &o, bool ShouldPreserveUseListOrder,
43 bool EmitSummaryIndex, bool EmitModuleHash)
44 : ModulePass(ID), OS(o),
45 ShouldPreserveUseListOrder(ShouldPreserveUseListOrder),
46 EmitSummaryIndex(EmitSummaryIndex), EmitModuleHash(EmitModuleHash) {
48 }
50 StringRef getPassName() const override { return "Bitcode Writer"; }
52 bool runOnModule(Module &M) override {
54 EmitSummaryIndex
55 ? &(getAnalysis<ModuleSummaryIndexWrapperPass>().getIndex())
56 : nullptr;
57 WriteBitcodeToFile(M, OS, ShouldPreserveUseListOrder, Index,
58 EmitModuleHash);
59 return false;
60 }
61 void getAnalysisUsage(AnalysisUsage &AU) const override {
62 AU.setPreservesAll();
63 if (EmitSummaryIndex)
65 }
66 };
69char WriteBitcodePass::ID = 0;
70INITIALIZE_PASS_BEGIN(WriteBitcodePass, "write-bitcode", "Write Bitcode", false,
71 true)
73INITIALIZE_PASS_END(WriteBitcodePass, "write-bitcode", "Write Bitcode", false,
74 true)
77 bool ShouldPreserveUseListOrder,
78 bool EmitSummaryIndex, bool EmitModuleHash) {
79 return new WriteBitcodePass(Str, ShouldPreserveUseListOrder,
80 EmitSummaryIndex, EmitModuleHash);
84 return P->getPassID() == (llvm::AnalysisID)&WriteBitcodePass::ID;
basic Basic Alias true
write Write Bitcode
write bitcode
This file provides a bitcode writing pass.
This is the interface to build a ModuleSummaryIndex for a module.
#define P(N)
This header defines various interfaces for pass management in LLVM.
Definition: PassSupport.h:55
#define INITIALIZE_PASS_END(passName, arg, name, cfg, analysis)
Definition: PassSupport.h:59
#define INITIALIZE_PASS_BEGIN(passName, arg, name, cfg, analysis)
Definition: PassSupport.h:52
raw_pwrite_stream & OS
A container for analyses that lazily runs them and caches their results.
Definition: PassManager.h:620
PassT::Result & getResult(IRUnitT &IR, ExtraArgTs... ExtraArgs)
Get the result of an analysis pass for a given IR unit.
Definition: PassManager.h:774
Represent the analysis usage information of a pass.
AnalysisUsage & addRequired()
void setPreservesAll()
Set by analyses that do not transform their input at all.
PreservedAnalyses run(Module &M, ModuleAnalysisManager &)
Run the bitcode writer pass, and output the module to the selected output stream.
ModulePass class - This class is used to implement unstructured interprocedural optimizations and ana...
Definition: Pass.h:248
Analysis pass to provide the ModuleSummaryIndex object.
Legacy wrapper pass to provide the ModuleSummaryIndex object.
Class to hold module path string table and global value map, and encapsulate methods for operating on...
A Module instance is used to store all the information related to an LLVM module.
Definition: Module.h:65
static PassRegistry * getPassRegistry()
getPassRegistry - Access the global registry object, which is automatically initialized at applicatio...
Pass interface - Implemented by all 'passes'.
Definition: Pass.h:91
A set of analyses that are preserved following a run of a transformation pass.
Definition: PassManager.h:152
static PreservedAnalyses all()
Construct a special preserved set that preserves all passes.
Definition: PassManager.h:158
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:50
This class implements an extremely fast bulk output stream that can only output to a stream.
Definition: raw_ostream.h:52
unsigned ID
LLVM IR allows to use arbitrary numbers as calling convention identifiers.
Definition: CallingConv.h:24
This is an optimization pass for GlobalISel generic memory operations.
Definition: AddressRanges.h:18
Error write(MCStreamer &Out, ArrayRef< std::string > Inputs)
Definition: DWP.cpp:551
void WriteBitcodeToFile(const Module &M, raw_ostream &Out, bool ShouldPreserveUseListOrder=false, const ModuleSummaryIndex *Index=nullptr, bool GenerateHash=false, ModuleHash *ModHash=nullptr)
Write the specified module to the specified raw output stream.
ModulePass * createBitcodeWriterPass(raw_ostream &Str, bool ShouldPreserveUseListOrder=false, bool EmitSummaryIndex=false, bool EmitModuleHash=false)
Create and return a pass that writes the module to the specified ostream.
void initializeWriteBitcodePassPass(PassRegistry &)
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
Definition: Debug.cpp:163
const void * AnalysisID
Definition: Pass.h:47
bool isBitcodeWriterPass(Pass *P)
Check whether a pass is a BitcodeWriterPass.