mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-08-25 00:29:20 +00:00
By taking a reference we can do the ownership transfer in one place instead of expecting every caller to do it. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@216492 91177308-0d34-0410-b5e6-96231b3b80d8
177 lines
6.8 KiB
C++
177 lines
6.8 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_READERWRITER_H
|
|
#define LLVM_BITCODE_READERWRITER_H
|
|
|
|
#include "llvm/Support/ErrorOr.h"
|
|
#include "llvm/Support/MemoryBuffer.h"
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
namespace llvm {
|
|
class BitstreamWriter;
|
|
class DataStreamer;
|
|
class LLVMContext;
|
|
class Module;
|
|
class ModulePass;
|
|
class raw_ostream;
|
|
|
|
/// Read the header of the specified bitcode buffer and prepare for lazy
|
|
/// deserialization of function bodies. If successful, this takes ownership
|
|
/// of 'buffer. On error, this *does not* take ownership of Buffer.
|
|
ErrorOr<Module *> getLazyBitcodeModule(std::unique_ptr<MemoryBuffer> &Buffer,
|
|
LLVMContext &Context);
|
|
|
|
/// getStreamedBitcodeModule - Read the header of the specified stream
|
|
/// and prepare for lazy deserialization and streaming of function bodies.
|
|
/// On error, this returns null, and fills in *ErrMsg with an error
|
|
/// description if ErrMsg is non-null.
|
|
Module *getStreamedBitcodeModule(const std::string &name,
|
|
DataStreamer *streamer,
|
|
LLVMContext &Context,
|
|
std::string *ErrMsg = nullptr);
|
|
|
|
/// Read the header of the specified bitcode buffer and extract just the
|
|
/// triple information. If successful, this returns a string. On error, this
|
|
/// returns "".
|
|
std::string getBitcodeTargetTriple(MemoryBufferRef Buffer,
|
|
LLVMContext &Context);
|
|
|
|
/// Read the specified bitcode file, returning the module.
|
|
ErrorOr<Module *> parseBitcodeFile(MemoryBufferRef Buffer,
|
|
LLVMContext &Context);
|
|
|
|
/// WriteBitcodeToFile - Write the specified module to the specified
|
|
/// raw output stream. For streams where it matters, the given stream
|
|
/// should be in "binary" mode.
|
|
void WriteBitcodeToFile(const Module *M, raw_ostream &Out);
|
|
|
|
|
|
/// isBitcodeWrapper - Return true if the given bytes are the magic bytes
|
|
/// for an LLVM IR bitcode wrapper.
|
|
///
|
|
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).
|
|
///
|
|
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.
|
|
///
|
|
inline bool 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.
|
|
/// If 'VerifyBufferSize' is true, check that the buffer is large enough to
|
|
/// contain the whole bitcode file.
|
|
inline bool SkipBitcodeWrapperHeader(const unsigned char *&BufPtr,
|
|
const unsigned char *&BufEnd,
|
|
bool VerifyBufferSize) {
|
|
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 (VerifyBufferSize && Offset+Size > unsigned(BufEnd-BufPtr))
|
|
return true;
|
|
BufPtr += Offset;
|
|
BufEnd = BufPtr+Size;
|
|
return false;
|
|
}
|
|
|
|
const std::error_category &BitcodeErrorCategory();
|
|
enum class BitcodeError {
|
|
ConflictingMETADATA_KINDRecords,
|
|
CouldNotFindFunctionInStream,
|
|
ExpectedConstant,
|
|
InsufficientFunctionProtos,
|
|
InvalidBitcodeSignature,
|
|
InvalidBitcodeWrapperHeader,
|
|
InvalidConstantReference,
|
|
InvalidID, // A read identifier is not found in the table it should be in.
|
|
InvalidInstructionWithNoBB,
|
|
InvalidRecord, // A read record doesn't have the expected size or structure
|
|
InvalidTypeForValue, // Type read OK, but is invalid for its use
|
|
InvalidTYPETable,
|
|
InvalidType, // We were unable to read a type
|
|
MalformedBlock, // We are unable to advance in the stream.
|
|
MalformedGlobalInitializerSet,
|
|
InvalidMultipleBlocks, // We found multiple blocks of a kind that should
|
|
// have only one
|
|
NeverResolvedValueFoundInFunction,
|
|
NeverResolvedFunctionFromBlockAddress,
|
|
InvalidValue // Invalid version, inst number, attr number, etc
|
|
};
|
|
inline std::error_code make_error_code(BitcodeError E) {
|
|
return std::error_code(static_cast<int>(E), BitcodeErrorCategory());
|
|
}
|
|
|
|
} // End llvm namespace
|
|
|
|
namespace std {
|
|
template <> struct is_error_code_enum<llvm::BitcodeError> : std::true_type {};
|
|
}
|
|
|
|
#endif
|