1 //===-- BitcodeWriterPass.h - Bitcode writing pass --------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
11 /// This file provides a bitcode writing pass.
13 //===----------------------------------------------------------------------===//
15 #ifndef LLVM_BITCODE_BITCODEWRITERPASS_H
16 #define LLVM_BITCODE_BITCODEWRITERPASS_H
18 #include "llvm/ADT/StringRef.h"
24 class PreservedAnalyses;
26 /// \brief Create and return a pass that writes the module to the specified
27 /// ostream. Note that this pass is designed for use with the legacy pass
30 /// If \c ShouldPreserveUseListOrder, encode use-list order so it can be
31 /// reproduced when deserialized.
32 ModulePass *createBitcodeWriterPass(raw_ostream &Str,
33 bool ShouldPreserveUseListOrder = false);
35 /// \brief Pass for writing a module of IR out to a bitcode file.
37 /// Note that this is intended for use with the new pass manager. To construct
38 /// a pass for the legacy pass manager, use the function above.
39 class BitcodeWriterPass {
41 bool ShouldPreserveUseListOrder;
44 /// \brief Construct a bitcode writer pass around a particular output stream.
46 /// If \c ShouldPreserveUseListOrder, encode use-list order so it can be
47 /// reproduced when deserialized.
48 explicit BitcodeWriterPass(raw_ostream &OS,
49 bool ShouldPreserveUseListOrder = false)
50 : OS(OS), ShouldPreserveUseListOrder(ShouldPreserveUseListOrder) {}
52 /// \brief Run the bitcode writer pass, and output the module to the selected
54 PreservedAnalyses run(Module &M);
56 static StringRef name() { return "BitcodeWriterPass"; }