1
0
mirror of https://github.com/RPCS3/llvm-mirror.git synced 2024-10-29 23:12:55 +01:00
llvm-mirror/lib/Bytecode/Reader/ReaderInternals.h

228 lines
7.9 KiB
C
Raw Normal View History

2001-06-06 22:29:01 +02:00
//===-- ReaderInternals.h - Definitions internal to the reader ---*- C++ -*--=//
//
// This header file defines various stuff that is used by the bytecode reader.
//
//===----------------------------------------------------------------------===//
#ifndef READER_INTERNALS_H
#define READER_INTERNALS_H
#include "llvm/Bytecode/Primitives.h"
#include "llvm/DerivedTypes.h"
#include "llvm/Function.h"
#include "llvm/Constant.h"
2001-06-06 22:29:01 +02:00
#include <utility>
#include <map>
2001-06-06 22:29:01 +02:00
// Enable to trace to figure out what the heck is going on when parsing fails
#define TRACE_LEVEL 0
#if TRACE_LEVEL // ByteCodeReading_TRACEer
#define BCR_TRACE(n, X) \
if (n < TRACE_LEVEL) std::cerr << std::string(n*2, ' ') << X
#else
#define BCR_TRACE(n, X)
#endif
2001-06-06 22:29:01 +02:00
typedef unsigned char uchar;
struct RawInst { // The raw fields out of the bytecode stream...
unsigned NumOperands;
unsigned Opcode;
const Type *Ty;
unsigned Arg1, Arg2;
union {
unsigned Arg3;
std::vector<unsigned> *VarArgs; // Contains arg #3,4,5... if NumOperands > 3
2001-06-06 22:29:01 +02:00
};
};
class BytecodeParser : public AbstractTypeUser {
std::string Error; // Error message string goes here...
BytecodeParser(const BytecodeParser &); // DO NOT IMPLEMENT
void operator=(const BytecodeParser &); // DO NOT IMPLEMENT
2001-06-06 22:29:01 +02:00
public:
BytecodeParser() {
// Define this in case we don't see a ModuleGlobalInfo block.
FirstDerivedTyID = Type::FirstDerivedTyID;
}
~BytecodeParser() {
freeTable(Values);
freeTable(LateResolveValues);
freeTable(ModuleValues);
}
2001-06-06 22:29:01 +02:00
Module *ParseBytecode(const uchar *Buf, const uchar *EndBuf,
const std::string &ModuleID);
std::string getError() const { return Error; }
2002-04-04 21:24:11 +02:00
void dump() const {
std::cerr << "BytecodeParser instance!\n";
2002-04-04 21:24:11 +02:00
}
2001-06-06 22:29:01 +02:00
private: // All of this data is transient across calls to ParseBytecode
struct ValueList : public User {
ValueList() : User(Type::TypeTy, Value::TypeVal) {
}
~ValueList() {}
// vector compatibility methods
unsigned size() const { return getNumOperands(); }
void push_back(Value *V) { Operands.push_back(Use(V, this)); }
Value *back() const { return Operands.back(); }
void pop_back() { Operands.pop_back(); }
bool empty() const { return Operands.empty(); }
virtual void print(std::ostream& OS) const {
OS << "Bytecode Reader UseHandle!";
}
};
Module *TheModule; // Current Module being read into...
// Information about the module, extracted from the bytecode revision number.
unsigned char RevisionNum; // The rev # itself
unsigned char FirstDerivedTyID; // First variable index to use for type
bool HasImplicitZeroInitializer; // Is entry 0 of every slot implicity zeros?
bool isBigEndian, hasLongPointers;// Information about the target compiled for
bool hasInternalMarkerOnly; // Only types of linkage are intern/external
typedef std::vector<ValueList*> ValueTable;
2001-06-06 22:29:01 +02:00
ValueTable Values, LateResolveValues;
ValueTable ModuleValues;
// GlobalRefs - This maintains a mapping between <Type, Slot #>'s and forward
// references to global values or constants. Such values may be referenced
// before they are defined, and if so, the temporary object that they
// represent is held here.
//
typedef std::map<std::pair<const Type *, unsigned>, Value*> GlobalRefsType;
GlobalRefsType GlobalRefs;
// TypesLoaded - This vector mirrors the Values[TypeTyID] plane. It is used
// to deal with forward references to types.
//
typedef std::vector<PATypeHandle<Type> > TypeValuesListTy;
TypeValuesListTy ModuleTypeValues;
TypeValuesListTy FunctionTypeValues;
2001-06-06 22:29:01 +02:00
// When the ModuleGlobalInfo section is read, we create a function object for
// each function in the module. When the function is loaded, this function is
// filled in.
//
std::vector<std::pair<Function*, unsigned> > FunctionSignatureList;
// Constant values are read in after global variables. Because of this, we
// must defer setting the initializers on global variables until after module
// level constants have been read. In the mean time, this list keeps track of
// what we must do.
2001-06-06 22:29:01 +02:00
//
std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInits;
2001-06-06 22:29:01 +02:00
private:
void freeTable(ValueTable &Tab) {
while (!Tab.empty()) {
delete Tab.back();
Tab.pop_back();
}
}
bool ParseModule (const uchar * Buf, const uchar *End);
bool ParseVersionInfo (const uchar *&Buf, const uchar *End);
bool ParseModuleGlobalInfo(const uchar *&Buf, const uchar *End);
bool ParseSymbolTable (const uchar *&Buf, const uchar *End, SymbolTable *);
bool ParseFunction (const uchar *&Buf, const uchar *End);
2001-06-06 22:29:01 +02:00
bool ParseBasicBlock (const uchar *&Buf, const uchar *End, BasicBlock *&);
bool ParseInstruction (const uchar *&Buf, const uchar *End, Instruction *&,
BasicBlock *BB /*HACK*/);
2001-06-06 22:29:01 +02:00
bool ParseRawInst (const uchar *&Buf, const uchar *End, RawInst &);
bool ParseGlobalTypes(const uchar *&Buf, const uchar *EndBuf);
2001-06-06 22:29:01 +02:00
bool ParseConstantPool(const uchar *&Buf, const uchar *EndBuf,
ValueTable &Tab, TypeValuesListTy &TypeTab);
bool parseConstantValue(const uchar *&Buf, const uchar *End,
const Type *Ty, Constant *&V);
bool parseTypeConstants(const uchar *&Buf, const uchar *EndBuf,
TypeValuesListTy &Tab, unsigned NumEntries);
const Type *parseTypeConstant(const uchar *&Buf, const uchar *EndBuf);
2001-06-06 22:29:01 +02:00
Value *getValue(const Type *Ty, unsigned num, bool Create = true);
const Type *getType(unsigned ID);
Constant *getConstantValue(const Type *Ty, unsigned num);
2001-06-06 22:29:01 +02:00
int insertValue(Value *V, ValueTable &Table); // -1 = Failure
void setValueTo(ValueTable &D, unsigned Slot, Value *V);
2001-06-06 22:29:01 +02:00
bool postResolveValues(ValueTable &ValTab);
bool getTypeSlot(const Type *Ty, unsigned &Slot);
// resolve all references to the placeholder (if any) for the given value
void ResolveReferencesToValue(Value *Val, unsigned Slot);
// refineAbstractType - The callback method is invoked when one of the
// elements of TypeValues becomes more concrete...
//
virtual void refineAbstractType(const DerivedType *OldTy, const Type *NewTy);
2001-06-06 22:29:01 +02:00
};
template<class SuperType>
class PlaceholderDef : public SuperType {
unsigned ID;
PlaceholderDef(); // DO NOT IMPLEMENT
void operator=(const PlaceholderDef &); // DO NOT IMPLEMENT
2001-06-06 22:29:01 +02:00
public:
PlaceholderDef(const Type *Ty, unsigned id) : SuperType(Ty), ID(id) {}
unsigned getID() { return ID; }
};
struct InstPlaceHolderHelper : public Instruction {
InstPlaceHolderHelper(const Type *Ty) : Instruction(Ty, UserOp1, "") {}
virtual const char *getOpcodeName() const { return "placeholder"; }
2001-06-06 22:29:01 +02:00
virtual Instruction *clone() const { abort(); return 0; }
};
struct BBPlaceHolderHelper : public BasicBlock {
BBPlaceHolderHelper(const Type *Ty) : BasicBlock() {
assert(Ty == Type::LabelTy);
2001-06-06 22:29:01 +02:00
}
};
struct ConstantPlaceHolderHelper : public Constant {
ConstantPlaceHolderHelper(const Type *Ty)
: Constant(Ty) {}
virtual bool isNullValue() const { return false; }
};
typedef PlaceholderDef<InstPlaceHolderHelper> ValPHolder;
2001-06-06 22:29:01 +02:00
typedef PlaceholderDef<BBPlaceHolderHelper> BBPHolder;
typedef PlaceholderDef<ConstantPlaceHolderHelper> ConstPHolder;
2001-06-06 22:29:01 +02:00
static inline unsigned getValueIDNumberFromPlaceHolder(Value *Val) {
if (isa<Constant>(Val))
return ((ConstPHolder*)Val)->getID();
// else discriminate by type
switch (Val->getType()->getPrimitiveID()) {
case Type::LabelTyID: return ((BBPHolder*)Val)->getID();
default: return ((ValPHolder*)Val)->getID();
2001-06-06 22:29:01 +02:00
}
}
static inline bool readBlock(const uchar *&Buf, const uchar *EndBuf,
unsigned &Type, unsigned &Size) {
#if DEBUG_OUTPUT
bool Result = read(Buf, EndBuf, Type) || read(Buf, EndBuf, Size);
std::cerr << "StartLoc = " << ((unsigned)Buf & 4095)
2001-06-06 22:29:01 +02:00
<< " Type = " << Type << " Size = " << Size << endl;
return Result;
#else
return read(Buf, EndBuf, Type) || read(Buf, EndBuf, Size);
#endif
}
#endif