lib/Bytecode/Reader/Reader.h

   1 //===-- Reader.h - Interface To Bytecode Reading ----------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Reid Spencer and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This header file defines the interface to the Bytecode Reader which is
  11 //  responsible for correctly interpreting bytecode files (backwards compatible)
  12 //  and materializing a module from the bytecode read.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef BYTECODE_PARSER_H
  17 #define BYTECODE_PARSER_H
  18
  19 #include "llvm/Constants.h"
  20 #include "llvm/DerivedTypes.h"
  21 #include "llvm/GlobalValue.h"
  22 #include "llvm/Function.h"
  23 #include "llvm/ModuleProvider.h"
  24 #include "llvm/Bytecode/Analyzer.h"
  25 #include <utility>
  26 #include <map>
  27 #include <setjmp.h>
  28
  29 namespace llvm {
  30
  31 // Forward declarations
  32 class BytecodeHandler;
  33 class TypeSymbolTable;
  34 class ValueSymbolTable;
  35
  36 /// This class defines the interface for parsing a buffer of bytecode. The
  37 /// parser itself takes no action except to call the various functions of
  38 /// the handler interface. The parser's sole responsibility is the correct
  39 /// interpretation of the bytecode buffer. The handler is responsible for
  40 /// instantiating and keeping track of all values. As a convenience, the parser
  41 /// is responsible for materializing types and will pass them through the
  42 /// handler interface as necessary.
  43 /// @see BytecodeHandler
  44 /// @brief Bytecode Reader interface
  45 class BytecodeReader : public ModuleProvider {
  46
  47 /// @name Constructors
  48 /// @{
  49 public:
  50   /// @brief Default constructor. By default, no handler is used.
  51   BytecodeReader(BytecodeHandler* h = 0) {
  52     decompressedBlock = 0;
  53     Handler = h;
  54   }
  55
  56   ~BytecodeReader() {
  57     freeState();
  58     if (decompressedBlock) {
  59       ::free(decompressedBlock);
  60       decompressedBlock = 0;
  61     }
  62   }
  63
  64 /// @}
  65 /// @name Types
  66 /// @{
  67 public:
  68
  69   /// @brief A convenience type for the buffer pointer
  70   typedef const unsigned char* BufPtr;
  71
  72   /// @brief The type used for a vector of potentially abstract types
  73   typedef std::vector<PATypeHolder> TypeListTy;
  74
  75   /// This type provides a vector of Value* via the User class for
  76   /// storage of Values that have been constructed when reading the
  77   /// bytecode. Because of forward referencing, constant replacement
  78   /// can occur so we ensure that our list of Value* is updated
  79   /// properly through those transitions. This ensures that the
  80   /// correct Value* is in our list when it comes time to associate
  81   /// constants with global variables at the end of reading the
  82   /// globals section.
  83   /// @brief A list of values as a User of those Values.
  84   class ValueList : public User {
  85     std::vector<Use> Uses;
  86   public:
  87     ValueList() : User(Type::VoidTy, Value::ArgumentVal, 0, 0) {}
  88
  89     // vector compatibility methods
  90     unsigned size() const { return getNumOperands(); }
  91     void push_back(Value *V) {
  92       Uses.push_back(Use(V, this));
  93       OperandList = &Uses[0];
  94       ++NumOperands;
  95     }
  96     Value *back() const { return Uses.back(); }
  97     void pop_back() { Uses.pop_back(); --NumOperands; }
  98     bool empty() const { return NumOperands == 0; }
  99     virtual void print(std::ostream& os) const {
 100       for (unsigned i = 0; i < size(); ++i) {
 101         os << i << " ";
 102         getOperand(i)->print(os);
 103         os << "\n";
 104       }
 105     }
 106   };
 107
 108   /// @brief A 2 dimensional table of values
 109   typedef std::vector<ValueList*> ValueTable;
 110
 111   /// This map is needed so that forward references to constants can be looked
 112   /// up by Type and slot number when resolving those references.
 113   /// @brief A mapping of a Type/slot pair to a Constant*.
 114   typedef std::map<std::pair<unsigned,unsigned>, Constant*> ConstantRefsType;
 115
 116   /// For lazy read-in of functions, we need to save the location in the
 117   /// data stream where the function is located. This structure provides that
 118   /// information. Lazy read-in is used mostly by the JIT which only wants to
 119   /// resolve functions as it needs them.
 120   /// @brief Keeps pointers to function contents for later use.
 121   struct LazyFunctionInfo {
 122     const unsigned char *Buf, *EndBuf;
 123     LazyFunctionInfo(const unsigned char *B = 0, const unsigned char *EB = 0)
 124       : Buf(B), EndBuf(EB) {}
 125   };
 126
 127   /// @brief A mapping of functions to their LazyFunctionInfo for lazy reading.
 128   typedef std::map<Function*, LazyFunctionInfo> LazyFunctionMap;
 129
 130   /// @brief A list of global variables and the slot number that initializes
 131   /// them.
 132   typedef std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitsList;
 133
 134   /// This type maps a typeslot/valueslot pair to the corresponding Value*.
 135   /// It is used for dealing with forward references as values are read in.
 136   /// @brief A map for dealing with forward references of values.
 137   typedef std::map<std::pair<unsigned,unsigned>,Value*> ForwardReferenceMap;
 138
 139 /// @}
 140 /// @name Methods
 141 /// @{
 142 public:
 143   /// @returns true if an error occurred
 144   /// @brief Main interface to parsing a bytecode buffer.
 145   bool ParseBytecode(
 146      volatile BufPtr Buf,         ///< Beginning of the bytecode buffer
 147      unsigned Length,             ///< Length of the bytecode buffer
 148      const std::string &ModuleID, ///< An identifier for the module constructed.
 149      std::string* ErrMsg = 0      ///< Optional place for error message
 150   );
 151
 152   /// @brief Parse all function bodies
 153   bool ParseAllFunctionBodies(std::string* ErrMsg);
 154
 155   /// @brief Parse the next function of specific type
 156   bool ParseFunction(Function* Func, std::string* ErrMsg) ;
 157
 158   /// This method is abstract in the parent ModuleProvider class. Its
 159   /// implementation is identical to the ParseFunction method.
 160   /// @see ParseFunction
 161   /// @brief Make a specific function materialize.
 162   virtual bool materializeFunction(Function *F, std::string *ErrMsg = 0) {
 163     LazyFunctionMap::iterator Fi = LazyFunctionLoadMap.find(F);
 164     if (Fi == LazyFunctionLoadMap.end())
 165       return false;
 166     if (ParseFunction(F,ErrMsg))
 167       return true;
 168     return false;
 169   }
 170
 171   /// This method is abstract in the parent ModuleProvider class. Its
 172   /// implementation is identical to ParseAllFunctionBodies.
 173   /// @see ParseAllFunctionBodies
 174   /// @brief Make the whole module materialize
 175   virtual Module* materializeModule(std::string *ErrMsg = 0) {
 176     if (ParseAllFunctionBodies(ErrMsg))
 177       return 0;
 178     return TheModule;
 179   }
 180
 181   /// This method is provided by the parent ModuleProvde class and overriden
 182   /// here. It simply releases the module from its provided and frees up our
 183   /// state.
 184   /// @brief Release our hold on the generated module
 185   Module* releaseModule(std::string *ErrInfo = 0) {
 186     // Since we're losing control of this Module, we must hand it back complete
 187     Module *M = ModuleProvider::releaseModule(ErrInfo);
 188     freeState();
 189     return M;
 190   }
 191
 192 /// @}
 193 /// @name Parsing Units For Subclasses
 194 /// @{
 195 protected:
 196   /// @brief Parse whole module scope
 197   void ParseModule();
 198
 199   /// @brief Parse the version information block
 200   void ParseVersionInfo();
 201
 202   /// @brief Parse the ModuleGlobalInfo block
 203   void ParseModuleGlobalInfo();
 204
 205   /// @brief Parse a value symbol table
 206   void ParseTypeSymbolTable(TypeSymbolTable *ST);
 207
 208   /// @brief Parse a value symbol table
 209   void ParseValueSymbolTable(Function* Func, ValueSymbolTable *ST);
 210
 211   /// @brief Parse functions lazily.
 212   void ParseFunctionLazily();
 213
 214   ///  @brief Parse a function body
 215   void ParseFunctionBody(Function* Func);
 216
 217   /// @brief Parse global types
 218   void ParseGlobalTypes();
 219
 220   /// @brief Parse a basic block (for LLVM 1.0 basic block blocks)
 221   BasicBlock* ParseBasicBlock(unsigned BlockNo);
 222
 223   /// @brief parse an instruction list (for post LLVM 1.0 instruction lists
 224   /// with blocks differentiated by terminating instructions.
 225   unsigned ParseInstructionList(
 226     Function* F   ///< The function into which BBs will be inserted
 227   );
 228
 229   /// @brief Parse a single instruction.
 230   void ParseInstruction(
 231     std::vector<unsigned>& Args,   ///< The arguments to be filled in
 232     BasicBlock* BB             ///< The BB the instruction goes in
 233   );
 234
 235   /// @brief Parse the whole constant pool
 236   void ParseConstantPool(ValueTable& Values, TypeListTy& Types,
 237                          bool isFunction);
 238
 239   /// @brief Parse a single constant pool value
 240   Value *ParseConstantPoolValue(unsigned TypeID);
 241
 242   /// @brief Parse a block of types constants
 243   void ParseTypes(TypeListTy &Tab, unsigned NumEntries);
 244
 245   /// @brief Parse a single type constant
 246   const Type *ParseType();
 247
 248   /// @brief Parse a string constants block
 249   void ParseStringConstants(unsigned NumEntries, ValueTable &Tab);
 250
 251   /// @brief Release our memory.
 252   void freeState() {
 253     freeTable(FunctionValues);
 254     freeTable(ModuleValues);
 255   }
 256
 257 /// @}
 258 /// @name Data
 259 /// @{
 260 private:
 261   std::string ErrorMsg; ///< A place to hold an error message through longjmp
 262   jmp_buf context;      ///< Where to return to if an error occurs.
 263   char*  decompressedBlock; ///< Result of decompression
 264   BufPtr MemStart;     ///< Start of the memory buffer
 265   BufPtr MemEnd;       ///< End of the memory buffer
 266   BufPtr BlockStart;   ///< Start of current block being parsed
 267   BufPtr BlockEnd;     ///< End of current block being parsed
 268   BufPtr At;           ///< Where we're currently parsing at
 269
 270   /// Information about the module, extracted from the bytecode revision number.
 271   ///
 272   unsigned char RevisionNum;        // The rev # itself
 273
 274   /// @brief This vector is used to deal with forward references to types in
 275   /// a module.
 276   TypeListTy ModuleTypes;
 277
 278   /// @brief This is an inverse mapping of ModuleTypes from the type to an
 279   /// index.  Because refining types causes the index of this map to be
 280   /// invalidated, any time we refine a type, we clear this cache and recompute
 281   /// it next time we need it.  These entries are ordered by the pointer value.
 282   std::vector<std::pair<const Type*, unsigned> > ModuleTypeIDCache;
 283
 284   /// @brief This vector is used to deal with forward references to types in
 285   /// a function.
 286   TypeListTy FunctionTypes;
 287
 288   /// When the ModuleGlobalInfo section is read, we create a Function object
 289   /// for each function in the module. When the function is loaded, after the
 290   /// module global info is read, this Function is populated. Until then, the
 291   /// functions in this vector just hold the function signature.
 292   std::vector<Function*> FunctionSignatureList;
 293
 294   /// @brief This is the table of values belonging to the current function
 295   ValueTable FunctionValues;
 296
 297   /// @brief This is the table of values belonging to the module (global)
 298   ValueTable ModuleValues;
 299
 300   /// @brief This keeps track of function level forward references.
 301   ForwardReferenceMap ForwardReferences;
 302
 303   /// @brief The basic blocks we've parsed, while parsing a function.
 304   std::vector<BasicBlock*> ParsedBasicBlocks;
 305
 306   /// This maintains a mapping between <Type, Slot #>'s and forward references
 307   /// to constants.  Such values may be referenced before they are defined, and
 308   /// if so, the temporary object that they represent is held here.  @brief
 309   /// Temporary place for forward references to constants.
 310   ConstantRefsType ConstantFwdRefs;
 311
 312   /// Constant values are read in after global variables.  Because of this, we
 313   /// must defer setting the initializers on global variables until after module
 314   /// level constants have been read.  In the mean time, this list keeps track
 315   /// of what we must do.
 316   GlobalInitsList GlobalInits;
 317
 318   // For lazy reading-in of functions, we need to save away several pieces of
 319   // information about each function: its begin and end pointer in the buffer
 320   // and its FunctionSlot.
 321   LazyFunctionMap LazyFunctionLoadMap;
 322
 323   /// This stores the parser's handler which is used for handling tasks other
 324   /// just than reading bytecode into the IR. If this is non-null, calls on
 325   /// the (polymorphic) BytecodeHandler interface (see llvm/Bytecode/Handler.h)
 326   /// will be made to report the logical structure of the bytecode file. What
 327   /// the handler does with the events it receives is completely orthogonal to
 328   /// the business of parsing the bytecode and building the IR.  This is used,
 329   /// for example, by the llvm-abcd tool for analysis of byte code.
 330   /// @brief Handler for parsing events.
 331   BytecodeHandler* Handler;
 332
 333
 334 /// @}
 335 /// @name Implementation Details
 336 /// @{
 337 private:
 338   /// @brief Determines if this module has a function or not.
 339   bool hasFunctions() { return ! FunctionSignatureList.empty(); }
 340
 341   /// @brief Determines if the type id has an implicit null value.
 342   bool hasImplicitNull(unsigned TyID );
 343
 344   /// @brief Converts a type slot number to its Type*
 345   const Type *getType(unsigned ID);
 346
 347   /// @brief Read in a type id and turn it into a Type*
 348   inline const Type* readType();
 349
 350   /// @brief Converts a Type* to its type slot number
 351   unsigned getTypeSlot(const Type *Ty);
 352
 353   /// @brief Gets the global type corresponding to the TypeId
 354   const Type *getGlobalTableType(unsigned TypeId);
 355
 356   /// @brief Get a value from its typeid and slot number
 357   Value* getValue(unsigned TypeID, unsigned num, bool Create = true);
 358
 359   /// @brief Get a basic block for current function
 360   BasicBlock *getBasicBlock(unsigned ID);
 361
 362   /// @brief Get a constant value from its typeid and value slot.
 363   Constant* getConstantValue(unsigned typeSlot, unsigned valSlot);
 364
 365   /// @brief Convenience function for getting a constant value when
 366   /// the Type has already been resolved.
 367   Constant* getConstantValue(const Type *Ty, unsigned valSlot) {
 368     return getConstantValue(getTypeSlot(Ty), valSlot);
 369   }
 370
 371   /// @brief Insert a newly created value
 372   unsigned insertValue(Value *V, unsigned Type, ValueTable &Table);
 373
 374   /// @brief Insert the arguments of a function.
 375   void insertArguments(Function* F );
 376
 377   /// @brief Resolve all references to the placeholder (if any) for the
 378   /// given constant.
 379   void ResolveReferencesToConstant(Constant *C, unsigned Typ, unsigned Slot);
 380
 381   /// @brief Free a table, making sure to free the ValueList in the table.
 382   void freeTable(ValueTable &Tab) {
 383     while (!Tab.empty()) {
 384       delete Tab.back();
 385       Tab.pop_back();
 386     }
 387   }
 388
 389   inline void error(const std::string& errmsg);
 390
 391   BytecodeReader(const BytecodeReader &);  // DO NOT IMPLEMENT
 392   void operator=(const BytecodeReader &);  // DO NOT IMPLEMENT
 393
 394   // This enum provides the values of the well-known type slots that are always
 395   // emitted as the first few types in the table by the BytecodeWriter class.
 396   enum WellKnownTypeSlots {
 397     VoidTypeSlot = 0, ///< TypeID == VoidTyID
 398     FloatTySlot  = 1, ///< TypeID == FloatTyID
 399     DoubleTySlot = 2, ///< TypeID == DoubleTyID
 400     LabelTySlot  = 3, ///< TypeID == LabelTyID
 401     BoolTySlot   = 4, ///< TypeID == IntegerTyID, width = 1
 402     Int8TySlot   = 5, ///< TypeID == IntegerTyID, width = 8
 403     Int16TySlot  = 6, ///< TypeID == IntegerTyID, width = 16
 404     Int32TySlot  = 7, ///< TypeID == IntegerTyID, width = 32
 405     Int64TySlot  = 8  ///< TypeID == IntegerTyID, width = 64
 406   };
 407
 408 /// @}
 409 /// @name Reader Primitives
 410 /// @{
 411 private:
 412
 413   /// @brief Is there more to parse in the current block?
 414   inline bool moreInBlock();
 415
 416   /// @brief Have we read past the end of the block
 417   inline void checkPastBlockEnd(const char * block_name);
 418
 419   /// @brief Align to 32 bits
 420   inline void align32();
 421
 422   /// @brief Read an unsigned integer as 32-bits
 423   inline unsigned read_uint();
 424
 425   /// @brief Read an unsigned integer with variable bit rate encoding
 426   inline unsigned read_vbr_uint();
 427
 428   /// @brief Read an unsigned integer of no more than 24-bits with variable
 429   /// bit rate encoding.
 430   inline unsigned read_vbr_uint24();
 431
 432   /// @brief Read an unsigned 64-bit integer with variable bit rate encoding.
 433   inline uint64_t read_vbr_uint64();
 434
 435   /// @brief Read a signed 64-bit integer with variable bit rate encoding.
 436   inline int64_t read_vbr_int64();
 437
 438   /// @brief Read a string
 439   inline std::string read_str();
 440
 441   /// @brief Read a float value
 442   inline void read_float(float& FloatVal);
 443
 444   /// @brief Read a double value
 445   inline void read_double(double& DoubleVal);
 446
 447   /// @brief Read an arbitrary data chunk of fixed length
 448   inline void read_data(void *Ptr, void *End);
 449
 450   /// @brief Read a bytecode block header
 451   inline void read_block(unsigned &Type, unsigned &Size);
 452 /// @}
 453 };
 454
 455 /// @brief A function for creating a BytecodeAnalzer as a handler
 456 /// for the Bytecode reader.
 457 BytecodeHandler* createBytecodeAnalyzerHandler(BytecodeAnalysis& bca,
 458                                                std::ostream* output );
 459
 460
 461 } // End llvm namespace
 462
 463 // vim: sw=2
 464 #endif