xref: /freebsd/contrib/llvm-project/llvm/lib/Bitcode/Writer/BitcodeWriterPass.cpp (revision 67be1e195acfaec99ce4fffeb17111ce085755f7)
1 //===- BitcodeWriterPass.cpp - Bitcode writing pass -----------------------===//
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 // BitcodeWriterPass implementation.
10 //
11 //===----------------------------------------------------------------------===//
12 
13 #include "llvm/Bitcode/BitcodeWriterPass.h"
14 #include "llvm/Analysis/ModuleSummaryAnalysis.h"
15 #include "llvm/Bitcode/BitcodeWriter.h"
16 #include "llvm/IR/PassManager.h"
17 #include "llvm/InitializePasses.h"
18 #include "llvm/Pass.h"
19 using namespace llvm;
20 
21 PreservedAnalyses BitcodeWriterPass::run(Module &M, ModuleAnalysisManager &AM) {
22   // RemoveDIs: there's no bitcode representation of the DPValue debug-info,
23   // convert to dbg.values before writing out.
24   bool IsNewDbgInfoFormat = M.IsNewDbgInfoFormat;
25   if (IsNewDbgInfoFormat)
26     M.convertFromNewDbgValues();
27 
28   const ModuleSummaryIndex *Index =
29       EmitSummaryIndex ? &(AM.getResult<ModuleSummaryIndexAnalysis>(M))
30                        : nullptr;
31   WriteBitcodeToFile(M, OS, ShouldPreserveUseListOrder, Index, EmitModuleHash);
32 
33   if (IsNewDbgInfoFormat)
34     M.convertToNewDbgValues();
35 
36   return PreservedAnalyses::all();
37 }
38 
39 namespace {
40   class WriteBitcodePass : public ModulePass {
41     raw_ostream &OS; // raw_ostream to print on
42     bool ShouldPreserveUseListOrder;
43 
44   public:
45     static char ID; // Pass identification, replacement for typeid
46     WriteBitcodePass() : ModulePass(ID), OS(dbgs()) {
47       initializeWriteBitcodePassPass(*PassRegistry::getPassRegistry());
48     }
49 
50     explicit WriteBitcodePass(raw_ostream &o, bool ShouldPreserveUseListOrder)
51         : ModulePass(ID), OS(o),
52           ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {
53       initializeWriteBitcodePassPass(*PassRegistry::getPassRegistry());
54     }
55 
56     StringRef getPassName() const override { return "Bitcode Writer"; }
57 
58     bool runOnModule(Module &M) override {
59       // RemoveDIs: there's no bitcode representation of the DPValue debug-info,
60       // convert to dbg.values before writing out.
61       bool IsNewDbgInfoFormat = M.IsNewDbgInfoFormat;
62       if (IsNewDbgInfoFormat)
63         M.convertFromNewDbgValues();
64 
65       WriteBitcodeToFile(M, OS, ShouldPreserveUseListOrder, /*Index=*/nullptr,
66                          /*EmitModuleHash=*/false);
67 
68       if (IsNewDbgInfoFormat)
69         M.convertToNewDbgValues();
70       return false;
71     }
72     void getAnalysisUsage(AnalysisUsage &AU) const override {
73       AU.setPreservesAll();
74     }
75   };
76 }
77 
78 char WriteBitcodePass::ID = 0;
79 INITIALIZE_PASS_BEGIN(WriteBitcodePass, "write-bitcode", "Write Bitcode", false,
80                       true)
81 INITIALIZE_PASS_DEPENDENCY(ModuleSummaryIndexWrapperPass)
82 INITIALIZE_PASS_END(WriteBitcodePass, "write-bitcode", "Write Bitcode", false,
83                     true)
84 
85 ModulePass *llvm::createBitcodeWriterPass(raw_ostream &Str,
86                                           bool ShouldPreserveUseListOrder) {
87   return new WriteBitcodePass(Str, ShouldPreserveUseListOrder);
88 }
89 
90 bool llvm::isBitcodeWriterPass(Pass *P) {
91   return P->getPassID() == (llvm::AnalysisID)&WriteBitcodePass::ID;
92 }
93