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 class BytecodeHandler; ///< Forward declare the handler interface
  32
  33 /// This class defines the interface for parsing a buffer of bytecode. The
  34 /// parser itself takes no action except to call the various functions of
  35 /// the handler interface. The parser's sole responsibility is the correct
  36 /// interpretation of the bytecode buffer. The handler is responsible for
  37 /// instantiating and keeping track of all values. As a convenience, the parser
  38 /// is responsible for materializing types and will pass them through the
  39 /// handler interface as necessary.
  40 /// @see BytecodeHandler
  41 /// @brief Bytecode Reader interface
  42 class BytecodeReader : public ModuleProvider {
  43
  44 /// @name Constructors
  45 /// @{
  46 public:
  47   /// @brief Default constructor. By default, no handler is used.
  48   BytecodeReader(BytecodeHandler* h = 0) {
  49     decompressedBlock = 0;
  50     Handler = h;
  51   }
  52
  53   ~BytecodeReader() {
  54     freeState();
  55     if (decompressedBlock) {
  56       ::free(decompressedBlock);
  57       decompressedBlock = 0;
  58     }
  59   }
  60
  61 /// @}
  62 /// @name Types
  63 /// @{
  64 public:
  65
  66   /// @brief A convenience type for the buffer pointer
  67   typedef const unsigned char* BufPtr;
  68
  69   /// @brief The type used for a vector of potentially abstract types
  70   typedef std::vector<PATypeHolder> TypeListTy;
  71
  72   /// This type provides a vector of Value* via the User class for
  73   /// storage of Values that have been constructed when reading the
  74   /// bytecode. Because of forward referencing, constant replacement
  75   /// can occur so we ensure that our list of Value* is updated
  76   /// properly through those transitions. This ensures that the
  77   /// correct Value* is in our list when it comes time to associate
  78   /// constants with global variables at the end of reading the
  79   /// globals section.
  80   /// @brief A list of values as a User of those Values.
  81   class ValueList : public User {
  82     std::vector<Use> Uses;
  83   public:
  84     ValueList() : User(Type::VoidTy, Value::ArgumentVal, 0, 0) {}
  85
  86     // vector compatibility methods
  87     unsigned size() const { return getNumOperands(); }
  88     void push_back(Value *V) {
  89       Uses.push_back(Use(V, this));
  90       OperandList = &Uses[0];
  91       ++NumOperands;
  92     }
  93     Value *back() const { return Uses.back(); }
  94     void pop_back() { Uses.pop_back(); --NumOperands; }
  95     bool empty() const { return NumOperands == 0; }
  96     virtual void print(std::ostream& os) const {
  97       for (unsigned i = 0; i < size(); ++i) {
  98         os << i << " ";
  99         getOperand(i)->print(os);
 100         os << "\n";
 101       }
 102     }
 103   };
 104
 105   /// @brief A 2 dimensional table of values
 106   typedef std::vector<ValueList*> ValueTable;
 107
 108   /// This map is needed so that forward references to constants can be looked
 109   /// up by Type and slot number when resolving those references.
 110   /// @brief A mapping of a Type/slot pair to a Constant*.
 111   typedef std::map<std::pair<unsigned,unsigned>, Constant*> ConstantRefsType;
 112
 113   /// For lazy read-in of functions, we need to save the location in the
 114   /// data stream where the function is located. This structure provides that
 115   /// information. Lazy read-in is used mostly by the JIT which only wants to
 116   /// resolve functions as it needs them.
 117   /// @brief Keeps pointers to function contents for later use.
 118   struct LazyFunctionInfo {
 119     const unsigned char *Buf, *EndBuf;
 120     LazyFunctionInfo(const unsigned char *B = 0, const unsigned char *EB = 0)
 121       : Buf(B), EndBuf(EB) {}
 122   };
 123
 124   /// @brief A mapping of functions to their LazyFunctionInfo for lazy reading.
 125   typedef std::map<Function*, LazyFunctionInfo> LazyFunctionMap;
 126
 127   /// @brief A list of global variables and the slot number that initializes
 128   /// them.
 129   typedef std::vector<std::pair<GlobalVariable*, unsigned> > GlobalInitsList;
 130
 131   /// This type maps a typeslot/valueslot pair to the corresponding Value*.
 132   /// It is used for dealing with forward references as values are read in.
 133   /// @brief A map for dealing with forward references of values.
 134   typedef std::map<std::pair<unsigned,unsigned>,Value*> ForwardReferenceMap;
 135
 136 /// @}
 137 /// @name Methods
 138 /// @{
 139 public:
 140   /// @returns true if an error occurred
 141   /// @brief Main interface to parsing a bytecode buffer.
 142   bool ParseBytecode(
 143      volatile BufPtr Buf,         ///< Beginning of the bytecode buffer
 144      unsigned Length,             ///< Length of the bytecode buffer
 145      const std::string &ModuleID, ///< An identifier for the module constructed.
 146      std::string* ErrMsg = 0      ///< Optional place for error message
 147   );
 148
 149   /// @brief Parse all function bodies
 150   bool ParseAllFunctionBodies(std::string* ErrMsg);
 151
 152   /// @brief Parse the next function of specific type
 153   bool ParseFunction(Function* Func, std::string* ErrMsg) ;
 154
 155   /// This method is abstract in the parent ModuleProvider class. Its
 156   /// implementation is identical to the ParseFunction method.
 157   /// @see ParseFunction
 158   /// @brief Make a specific function materialize.
 159   virtual bool materializeFunction(Function *F, std::string *ErrMsg = 0) {
 160     LazyFunctionMap::iterator Fi = LazyFunctionLoadMap.find(F);
 161     if (Fi == LazyFunctionLoadMap.end())
 162       return false;
 163     if (ParseFunction(F,ErrMsg))
 164       return true;
 165     return false;
 166   }
 167
 168   /// This method is abstract in the parent ModuleProvider class. Its
 169   /// implementation is identical to ParseAllFunctionBodies.
 170   /// @see ParseAllFunctionBodies
 171   /// @brief Make the whole module materialize
 172   virtual Module* materializeModule(std::string *ErrMsg = 0) {
 173     if (ParseAllFunctionBodies(ErrMsg))
 174       return 0;
 175     return TheModule;
 176   }
 177
 178   /// This method is provided by the parent ModuleProvde class and overriden
 179   /// here. It simply releases the module from its provided and frees up our
 180   /// state.
 181   /// @brief Release our hold on the generated module
 182   Module* releaseModule(std::string *ErrInfo = 0) {
 183     // Since we're losing control of this Module, we must hand it back complete
 184     Module *M = ModuleProvider::releaseModule();
 185     freeState();
 186     return M;
 187   }
 188
 189 /// @}
 190 /// @name Parsing Units For Subclasses
 191 /// @{
 192 protected:
 193   /// @brief Parse whole module scope
 194   void ParseModule();
 195
 196   /// @brief Parse the version information block
 197   void ParseVersionInfo();
 198
 199   /// @brief Parse the ModuleGlobalInfo block
 200   void ParseModuleGlobalInfo();
 201
 202   /// @brief Parse a symbol table
 203   void ParseSymbolTable( Function* Func, SymbolTable *ST);
 204
 205   /// @brief Parse functions lazily.
 206   void ParseFunctionLazily();
 207
 208   ///  @brief Parse a function body
 209   void ParseFunctionBody(Function* Func);
 210
 211   /// @brief Parse the type list portion of a compaction table
 212   void ParseCompactionTypes(unsigned NumEntries);
 213
 214   /// @brief Parse a compaction table
 215   void ParseCompactionTable();
 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   /// Convert previous opcode values into the current value and/or construct
 230   /// the instruction. This function handles all *abnormal* cases for
 231   /// instruction generation based on obsolete opcode values. The normal cases
 232   /// are handled by the ParseInstruction function.
 233   Instruction* handleObsoleteOpcodes(
 234     unsigned &opcode,   ///< The old opcode, possibly updated by this function
 235     std::vector<unsigned> &Oprnds, ///< The operands to the instruction
 236     unsigned &iType,    ///< The type code from the bytecode file
 237     const Type* InstTy, ///< The type of the instruction
 238     BasicBlock* BB      ///< The basic block to insert into, if we need to
 239   );
 240
 241   /// @brief Parse a single instruction.
 242   void ParseInstruction(
 243     std::vector<unsigned>& Args,   ///< The arguments to be filled in
 244     BasicBlock* BB             ///< The BB the instruction goes in
 245   );
 246
 247   /// @brief Parse the whole constant pool
 248   void ParseConstantPool(ValueTable& Values, TypeListTy& Types,
 249                          bool isFunction);
 250
 251   /// @brief Parse a single constant pool value
 252   Value *ParseConstantPoolValue(unsigned TypeID);
 253
 254   /// @brief Parse a block of types constants
 255   void ParseTypes(TypeListTy &Tab, unsigned NumEntries);
 256
 257   /// @brief Parse a single type constant
 258   const Type *ParseType();
 259
 260   /// @brief Parse a string constants block
 261   void ParseStringConstants(unsigned NumEntries, ValueTable &Tab);
 262
 263   /// @brief Release our memory.
 264   void freeState() {
 265     freeTable(FunctionValues);
 266     freeTable(ModuleValues);
 267   }
 268
 269 /// @}
 270 /// @name Data
 271 /// @{
 272 private:
 273   std::string ErrorMsg; ///< A place to hold an error message through longjmp
 274   jmp_buf context;      ///< Where to return to if an error occurs.
 275   char*  decompressedBlock; ///< Result of decompression
 276   BufPtr MemStart;     ///< Start of the memory buffer
 277   BufPtr MemEnd;       ///< End of the memory buffer
 278   BufPtr BlockStart;   ///< Start of current block being parsed
 279   BufPtr BlockEnd;     ///< End of current block being parsed
 280   BufPtr At;           ///< Where we're currently parsing at
 281
 282   /// Information about the module, extracted from the bytecode revision number.
 283   ///
 284   unsigned char RevisionNum;        // The rev # itself
 285
 286   /// Flags to distinguish LLVM 1.0 & 1.1 bytecode formats (revision #0)
 287
 288   /// Revision #0 had an explicit alignment of data only for the
 289   /// ModuleGlobalInfo block.  This was fixed to be like all other blocks in 1.2
 290   bool hasInconsistentModuleGlobalInfo;
 291
 292   /// Revision #0 also explicitly encoded zero values for primitive types like
 293   /// int/sbyte/etc.
 294   bool hasExplicitPrimitiveZeros;
 295
 296   // Flags to control features specific the LLVM 1.2 and before (revision #1)
 297
 298   /// LLVM 1.2 and earlier required that getelementptr structure indices were
 299   /// ubyte constants and that sequential type indices were longs.
 300   bool hasRestrictedGEPTypes;
 301
 302   /// LLVM 1.2 and earlier had class Type deriving from Value and the Type
 303   /// objects were located in the "Type Type" plane of various lists in read
 304   /// by the bytecode reader. In LLVM 1.3 this is no longer the case. Types are
 305   /// completely distinct from Values. Consequently, Types are written in fixed
 306   /// locations in LLVM 1.3. This flag indicates that the older Type derived
 307   /// from Value style of bytecode file is being read.
 308   bool hasTypeDerivedFromValue;
 309
 310   /// LLVM 1.2 and earlier encoded block headers as two uint (8 bytes), one for
 311   /// the size and one for the type. This is a bit wasteful, especially for
 312   /// small files where the 8 bytes per block is a large fraction of the total
 313   /// block size. In LLVM 1.3, the block type and length are encoded into a
 314   /// single uint32 by restricting the number of block types (limit 31) and the
 315   /// maximum size of a block (limit 2^27-1=134,217,727). Note that the module
 316   /// block still uses the 8-byte format so the maximum size of a file can be
 317   /// 2^32-1 bytes long.
 318   bool hasLongBlockHeaders;
 319
 320   /// LLVM 1.2 and earlier wrote type slot numbers as vbr_uint32. In LLVM 1.3
 321   /// this has been reduced to vbr_uint24. It shouldn't make much difference
 322   /// since we haven't run into a module with > 24 million types, but for safety
 323   /// the 24-bit restriction has been enforced in 1.3 to free some bits in
 324   /// various places and to ensure consistency. In particular, global vars are
 325   /// restricted to 24-bits.
 326   bool has32BitTypes;
 327
 328   /// LLVM 1.2 and earlier did not provide a target triple nor a list of
 329   /// libraries on which the bytecode is dependent. LLVM 1.3 provides these
 330   /// features, for use in future versions of LLVM.
 331   bool hasNoDependentLibraries;
 332
 333   /// LLVM 1.3 and earlier caused blocks and other fields to start on 32-bit
 334   /// aligned boundaries. This can lead to as much as 30% bytecode size overhead
 335   /// in various corner cases (lots of long instructions). In LLVM 1.4,
 336   /// alignment of bytecode fields was done away with completely.
 337   bool hasAlignment;
 338
 339   // In version 4 and earlier, the bytecode format did not support the 'undef'
 340   // constant.
 341   bool hasNoUndefValue;
 342
 343   // In version 4 and earlier, the bytecode format did not save space for flags
 344   // in the global info block for functions.
 345   bool hasNoFlagsForFunctions;
 346
 347   // In version 4 and earlier, there was no opcode space reserved for the
 348   // unreachable instruction.
 349   bool hasNoUnreachableInst;
 350
 351   // In version 5 and prior, instructions were signless. In version 6,
 352   // instructions became signed. For example in version 5 we have the DIV
 353   // instruction but in version 6 we have FDIV, SDIV and UDIV to replace it.
 354   // This causes a renumbering of the instruction codes in version 6 that must
 355   // be dealt with when reading old bytecode files.
 356   bool hasSignlessInstructions;
 357
 358   /// In release 1.7 we changed intrinsic functions to not be overloaded. There
 359   /// is no bytecode change for this, but to optimize the auto-upgrade of calls
 360   /// to intrinsic functions, we save a mapping of old function definitions to
 361   /// the new ones so call instructions can be upgraded efficiently.
 362   std::map<Function*,Function*> upgradedFunctions;
 363
 364   /// CompactionTypes - If a compaction table is active in the current function,
 365   /// this is the mapping that it contains.  We keep track of what resolved type
 366   /// it is as well as what global type entry it is.
 367   std::vector<std::pair<const Type*, unsigned> > CompactionTypes;
 368
 369   /// @brief If a compaction table is active in the current function,
 370   /// this is the mapping that it contains.
 371   std::vector<std::vector<Value*> > CompactionValues;
 372
 373   /// @brief This vector is used to deal with forward references to types in
 374   /// a module.
 375   TypeListTy ModuleTypes;
 376
 377   /// @brief This is an inverse mapping of ModuleTypes from the type to an
 378   /// index.  Because refining types causes the index of this map to be
 379   /// invalidated, any time we refine a type, we clear this cache and recompute
 380   /// it next time we need it.  These entries are ordered by the pointer value.
 381   std::vector<std::pair<const Type*, unsigned> > ModuleTypeIDCache;
 382
 383   /// @brief This vector is used to deal with forward references to types in
 384   /// a function.
 385   TypeListTy FunctionTypes;
 386
 387   /// When the ModuleGlobalInfo section is read, we create a Function object
 388   /// for each function in the module. When the function is loaded, after the
 389   /// module global info is read, this Function is populated. Until then, the
 390   /// functions in this vector just hold the function signature.
 391   std::vector<Function*> FunctionSignatureList;
 392
 393   /// @brief This is the table of values belonging to the current function
 394   ValueTable FunctionValues;
 395
 396   /// @brief This is the table of values belonging to the module (global)
 397   ValueTable ModuleValues;
 398
 399   /// @brief This keeps track of function level forward references.
 400   ForwardReferenceMap ForwardReferences;
 401
 402   /// @brief The basic blocks we've parsed, while parsing a function.
 403   std::vector<BasicBlock*> ParsedBasicBlocks;
 404
 405   /// This maintains a mapping between <Type, Slot #>'s and forward references
 406   /// to constants.  Such values may be referenced before they are defined, and
 407   /// if so, the temporary object that they represent is held here.  @brief
 408   /// Temporary place for forward references to constants.
 409   ConstantRefsType ConstantFwdRefs;
 410
 411   /// Constant values are read in after global variables.  Because of this, we
 412   /// must defer setting the initializers on global variables until after module
 413   /// level constants have been read.  In the mean time, this list keeps track
 414   /// of what we must do.
 415   GlobalInitsList GlobalInits;
 416
 417   // For lazy reading-in of functions, we need to save away several pieces of
 418   // information about each function: its begin and end pointer in the buffer
 419   // and its FunctionSlot.
 420   LazyFunctionMap LazyFunctionLoadMap;
 421
 422   /// This stores the parser's handler which is used for handling tasks other
 423   /// just than reading bytecode into the IR. If this is non-null, calls on
 424   /// the (polymorphic) BytecodeHandler interface (see llvm/Bytecode/Handler.h)
 425   /// will be made to report the logical structure of the bytecode file. What
 426   /// the handler does with the events it receives is completely orthogonal to
 427   /// the business of parsing the bytecode and building the IR.  This is used,
 428   /// for example, by the llvm-abcd tool for analysis of byte code.
 429   /// @brief Handler for parsing events.
 430   BytecodeHandler* Handler;
 431
 432
 433 /// @}
 434 /// @name Implementation Details
 435 /// @{
 436 private:
 437   /// @brief Determines if this module has a function or not.
 438   bool hasFunctions() { return ! FunctionSignatureList.empty(); }
 439
 440   /// @brief Determines if the type id has an implicit null value.
 441   bool hasImplicitNull(unsigned TyID );
 442
 443   /// @brief Converts a type slot number to its Type*
 444   const Type *getType(unsigned ID);
 445
 446   /// @brief Converts a pre-sanitized type slot number to its Type* and
 447   /// sanitizes the type id.
 448   inline const Type* getSanitizedType(unsigned& ID );
 449
 450   /// @brief Read in and get a sanitized type id
 451   inline const Type* readSanitizedType();
 452
 453   /// @brief Converts a Type* to its type slot number
 454   unsigned getTypeSlot(const Type *Ty);
 455
 456   /// @brief Converts a normal type slot number to a compacted type slot num.
 457   unsigned getCompactionTypeSlot(unsigned type);
 458
 459   /// @brief Gets the global type corresponding to the TypeId
 460   const Type *getGlobalTableType(unsigned TypeId);
 461
 462   /// This is just like getTypeSlot, but when a compaction table is in use,
 463   /// it is ignored.
 464   unsigned getGlobalTableTypeSlot(const Type *Ty);
 465
 466   /// @brief Get a value from its typeid and slot number
 467   Value* getValue(unsigned TypeID, unsigned num, bool Create = true);
 468
 469   /// @brief Get a value from its type and slot number, ignoring compaction
 470   /// tables.
 471   Value *getGlobalTableValue(unsigned TyID, unsigned SlotNo);
 472
 473   /// @brief Get a basic block for current function
 474   BasicBlock *getBasicBlock(unsigned ID);
 475
 476   /// @brief Get a constant value from its typeid and value slot.
 477   Constant* getConstantValue(unsigned typeSlot, unsigned valSlot);
 478
 479   /// @brief Convenience function for getting a constant value when
 480   /// the Type has already been resolved.
 481   Constant* getConstantValue(const Type *Ty, unsigned valSlot) {
 482     return getConstantValue(getTypeSlot(Ty), valSlot);
 483   }
 484
 485   /// @brief Insert a newly created value
 486   unsigned insertValue(Value *V, unsigned Type, ValueTable &Table);
 487
 488   /// @brief Insert the arguments of a function.
 489   void insertArguments(Function* F );
 490
 491   /// @brief Resolve all references to the placeholder (if any) for the
 492   /// given constant.
 493   void ResolveReferencesToConstant(Constant *C, unsigned Typ, unsigned Slot);
 494
 495   /// @brief Free a table, making sure to free the ValueList in the table.
 496   void freeTable(ValueTable &Tab) {
 497     while (!Tab.empty()) {
 498       delete Tab.back();
 499       Tab.pop_back();
 500     }
 501   }
 502
 503   inline void error(const std::string& errmsg);
 504
 505   BytecodeReader(const BytecodeReader &);  // DO NOT IMPLEMENT
 506   void operator=(const BytecodeReader &);  // DO NOT IMPLEMENT
 507
 508 /// @}
 509 /// @name Reader Primitives
 510 /// @{
 511 private:
 512
 513   /// @brief Is there more to parse in the current block?
 514   inline bool moreInBlock();
 515
 516   /// @brief Have we read past the end of the block
 517   inline void checkPastBlockEnd(const char * block_name);
 518
 519   /// @brief Align to 32 bits
 520   inline void align32();
 521
 522   /// @brief Read an unsigned integer as 32-bits
 523   inline unsigned read_uint();
 524
 525   /// @brief Read an unsigned integer with variable bit rate encoding
 526   inline unsigned read_vbr_uint();
 527
 528   /// @brief Read an unsigned integer of no more than 24-bits with variable
 529   /// bit rate encoding.
 530   inline unsigned read_vbr_uint24();
 531
 532   /// @brief Read an unsigned 64-bit integer with variable bit rate encoding.
 533   inline uint64_t read_vbr_uint64();
 534
 535   /// @brief Read a signed 64-bit integer with variable bit rate encoding.
 536   inline int64_t read_vbr_int64();
 537
 538   /// @brief Read a string
 539   inline std::string read_str();
 540
 541   /// @brief Read a float value
 542   inline void read_float(float& FloatVal);
 543
 544   /// @brief Read a double value
 545   inline void read_double(double& DoubleVal);
 546
 547   /// @brief Read an arbitrary data chunk of fixed length
 548   inline void read_data(void *Ptr, void *End);
 549
 550   /// @brief Read a bytecode block header
 551   inline void read_block(unsigned &Type, unsigned &Size);
 552
 553   /// @brief Read a type identifier and sanitize it.
 554   inline bool read_typeid(unsigned &TypeId);
 555
 556   /// @brief Recalculate type ID for pre 1.3 bytecode files.
 557   inline bool sanitizeTypeId(unsigned &TypeId );
 558 /// @}
 559 };
 560
 561 /// @brief A function for creating a BytecodeAnalzer as a handler
 562 /// for the Bytecode reader.
 563 BytecodeHandler* createBytecodeAnalyzerHandler(BytecodeAnalysis& bca,
 564                                                std::ostream* output );
 565
 566
 567 } // End llvm namespace
 568
 569 // vim: sw=2
 570 #endif