mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-08-30 05:29:47 +00:00
Modules and ModuleProviders. Because the "ModuleProvider" simply materializes GlobalValues now, and doesn't provide modules, it's renamed to "GVMaterializer". Code that used to need a ModuleProvider to materialize Functions can now materialize the Functions directly. Functions no longer use a magic linkage to record that they're materializable; they simply ask the GVMaterializer. Because the C ABI must never change, we can't remove LLVMModuleProviderRef or the functions that refer to it. Instead, because Module now exposes the same functionality ModuleProvider used to, we store a Module* in any LLVMModuleProviderRef and translate in the wrapper methods. The bindings to other languages still use the ModuleProvider concept. It would probably be worth some time to update them to follow the C++ more closely, but I don't intend to do it. Fixes http://llvm.org/PR5737 and http://llvm.org/PR5735. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@94686 91177308-0d34-0410-b5e6-96231b3b80d8
136 lines
5.2 KiB
C++
136 lines
5.2 KiB
C++
//===-- llvm/Bitcode/ReaderWriter.h - Bitcode reader/writers ----*- C++ -*-===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This header defines interfaces to read and write LLVM bitcode files/streams.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_BITCODE_H
|
|
#define LLVM_BITCODE_H
|
|
|
|
#include <string>
|
|
|
|
namespace llvm {
|
|
class Module;
|
|
class MemoryBuffer;
|
|
class ModulePass;
|
|
class BitstreamWriter;
|
|
class LLVMContext;
|
|
class raw_ostream;
|
|
|
|
/// getLazyBitcodeModule - Read the header of the specified bitcode buffer
|
|
/// and prepare for lazy deserialization of function bodies. If successful,
|
|
/// this takes ownership of 'buffer' and returns a non-null pointer. On
|
|
/// error, this returns null, *does not* take ownership of Buffer, and fills
|
|
/// in *ErrMsg with an error description if ErrMsg is non-null.
|
|
Module *getLazyBitcodeModule(MemoryBuffer *Buffer,
|
|
LLVMContext& Context,
|
|
std::string *ErrMsg = 0);
|
|
|
|
/// ParseBitcodeFile - Read the specified bitcode file, returning the module.
|
|
/// If an error occurs, this returns null and fills in *ErrMsg if it is
|
|
/// non-null. This method *never* takes ownership of Buffer.
|
|
Module *ParseBitcodeFile(MemoryBuffer *Buffer, LLVMContext& Context,
|
|
std::string *ErrMsg = 0);
|
|
|
|
/// WriteBitcodeToFile - Write the specified module to the specified
|
|
/// raw output stream.
|
|
void WriteBitcodeToFile(const Module *M, raw_ostream &Out);
|
|
|
|
/// WriteBitcodeToStream - Write the specified module to the specified
|
|
/// raw output stream.
|
|
void WriteBitcodeToStream(const Module *M, BitstreamWriter &Stream);
|
|
|
|
/// createBitcodeWriterPass - Create and return a pass that writes the module
|
|
/// to the specified ostream.
|
|
ModulePass *createBitcodeWriterPass(raw_ostream &Str);
|
|
|
|
|
|
/// isBitcodeWrapper - Return true if the given bytes are the magic bytes
|
|
/// for an LLVM IR bitcode wrapper.
|
|
///
|
|
static inline bool isBitcodeWrapper(const unsigned char *BufPtr,
|
|
const unsigned char *BufEnd) {
|
|
// See if you can find the hidden message in the magic bytes :-).
|
|
// (Hint: it's a little-endian encoding.)
|
|
return BufPtr != BufEnd &&
|
|
BufPtr[0] == 0xDE &&
|
|
BufPtr[1] == 0xC0 &&
|
|
BufPtr[2] == 0x17 &&
|
|
BufPtr[3] == 0x0B;
|
|
}
|
|
|
|
/// isRawBitcode - Return true if the given bytes are the magic bytes for
|
|
/// raw LLVM IR bitcode (without a wrapper).
|
|
///
|
|
static inline bool isRawBitcode(const unsigned char *BufPtr,
|
|
const unsigned char *BufEnd) {
|
|
// These bytes sort of have a hidden message, but it's not in
|
|
// little-endian this time, and it's a little redundant.
|
|
return BufPtr != BufEnd &&
|
|
BufPtr[0] == 'B' &&
|
|
BufPtr[1] == 'C' &&
|
|
BufPtr[2] == 0xc0 &&
|
|
BufPtr[3] == 0xde;
|
|
}
|
|
|
|
/// isBitcode - Return true if the given bytes are the magic bytes for
|
|
/// LLVM IR bitcode, either with or without a wrapper.
|
|
///
|
|
static bool inline isBitcode(const unsigned char *BufPtr,
|
|
const unsigned char *BufEnd) {
|
|
return isBitcodeWrapper(BufPtr, BufEnd) ||
|
|
isRawBitcode(BufPtr, BufEnd);
|
|
}
|
|
|
|
/// SkipBitcodeWrapperHeader - Some systems wrap bc files with a special
|
|
/// header for padding or other reasons. The format of this header is:
|
|
///
|
|
/// struct bc_header {
|
|
/// uint32_t Magic; // 0x0B17C0DE
|
|
/// uint32_t Version; // Version, currently always 0.
|
|
/// uint32_t BitcodeOffset; // Offset to traditional bitcode file.
|
|
/// uint32_t BitcodeSize; // Size of traditional bitcode file.
|
|
/// ... potentially other gunk ...
|
|
/// };
|
|
///
|
|
/// This function is called when we find a file with a matching magic number.
|
|
/// In this case, skip down to the subsection of the file that is actually a
|
|
/// BC file.
|
|
static inline bool SkipBitcodeWrapperHeader(unsigned char *&BufPtr,
|
|
unsigned char *&BufEnd) {
|
|
enum {
|
|
KnownHeaderSize = 4*4, // Size of header we read.
|
|
OffsetField = 2*4, // Offset in bytes to Offset field.
|
|
SizeField = 3*4 // Offset in bytes to Size field.
|
|
};
|
|
|
|
// Must contain the header!
|
|
if (BufEnd-BufPtr < KnownHeaderSize) return true;
|
|
|
|
unsigned Offset = ( BufPtr[OffsetField ] |
|
|
(BufPtr[OffsetField+1] << 8) |
|
|
(BufPtr[OffsetField+2] << 16) |
|
|
(BufPtr[OffsetField+3] << 24));
|
|
unsigned Size = ( BufPtr[SizeField ] |
|
|
(BufPtr[SizeField +1] << 8) |
|
|
(BufPtr[SizeField +2] << 16) |
|
|
(BufPtr[SizeField +3] << 24));
|
|
|
|
// Verify that Offset+Size fits in the file.
|
|
if (Offset+Size > unsigned(BufEnd-BufPtr))
|
|
return true;
|
|
BufPtr += Offset;
|
|
BufEnd = BufPtr+Size;
|
|
return false;
|
|
}
|
|
} // End llvm namespace
|
|
|
|
#endif
|