1 //===-- llvm/Bitcode/ReaderWriter.h - Bitcode reader/writers ----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by Chris Lattner and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This header defines interfaces to read and write LLVM bitcode files/streams.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_BITCODE_H
15 #define LLVM_BITCODE_H
26 /// getBitcodeModuleProvider - Read the header of the specified bitcode buffer
27 /// and prepare for lazy deserialization of function bodies. If successful,
28 /// this takes ownership of 'buffer' and returns a non-null pointer. On
29 /// error, this returns null, *does not* take ownership of Buffer, and fills
30 /// in *ErrMsg with an error description if ErrMsg is non-null.
31 ModuleProvider *getBitcodeModuleProvider(MemoryBuffer *Buffer,
32 std::string *ErrMsg = 0);
34 /// ParseBitcodeFile - Read the specified bitcode file, returning the module.
35 /// If an error occurs, this returns null and fills in *ErrMsg if it is
36 /// non-null. This method *never* takes ownership of Buffer.
37 Module *ParseBitcodeFile(MemoryBuffer *Buffer, std::string *ErrMsg = 0);
39 /// WriteBitcodeToFile - Write the specified module to the specified output
41 void WriteBitcodeToFile(const Module *M, std::ostream &Out);
43 /// CreateBitcodeWriterPass - Create and return a pass that writes the module
44 /// to the specified ostream.
45 ModulePass *CreateBitcodeWriterPass(std::ostream &Str);
46 } // End llvm namespace