include/llvm/Bitcode/BitstreamReader.h

   1 //===- BitstreamReader.h - Low-level bitstream reader interface -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This header defines the BitstreamReader class.  This class can be used to
  11 // read an arbitrary bitstream, regardless of its contents.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_BITCODE_BITSTREAMREADER_H
  16 #define LLVM_BITCODE_BITSTREAMREADER_H
  17
  18 #include "llvm/Bitcode/BitCodes.h"
  19 #include "llvm/Support/Endian.h"
  20 #include "llvm/Support/StreamingMemoryObject.h"
  21 #include <climits>
  22 #include <string>
  23 #include <vector>
  24
  25 namespace llvm {
  26
  27 class Deserializer;
  28
  29 /// This class is used to read from an LLVM bitcode stream, maintaining
  30 /// information that is global to decoding the entire file. While a file is
  31 /// being read, multiple cursors can be independently advanced or skipped around
  32 /// within the file.  These are represented by the BitstreamCursor class.
  33 class BitstreamReader {
  34 public:
  35   /// This contains information emitted to BLOCKINFO_BLOCK blocks. These
  36   /// describe abbreviations that all blocks of the specified ID inherit.
  37   struct BlockInfo {
  38     unsigned BlockID;
  39     std::vector<IntrusiveRefCntPtr<BitCodeAbbrev>> Abbrevs;
  40     std::string Name;
  41
  42     std::vector<std::pair<unsigned, std::string> > RecordNames;
  43   };
  44 private:
  45   std::unique_ptr<MemoryObject> BitcodeBytes;
  46
  47   std::vector<BlockInfo> BlockInfoRecords;
  48
  49   /// This is set to true if we don't care about the block/record name
  50   /// information in the BlockInfo block. Only llvm-bcanalyzer uses this.
  51   bool IgnoreBlockInfoNames;
  52
  53   BitstreamReader(const BitstreamReader&) LLVM_DELETED_FUNCTION;
  54   void operator=(const BitstreamReader&) LLVM_DELETED_FUNCTION;
  55 public:
  56   BitstreamReader() : IgnoreBlockInfoNames(true) {
  57   }
  58
  59   BitstreamReader(const unsigned char *Start, const unsigned char *End)
  60       : IgnoreBlockInfoNames(true) {
  61     init(Start, End);
  62   }
  63
  64   BitstreamReader(MemoryObject *bytes) : IgnoreBlockInfoNames(true) {
  65     BitcodeBytes.reset(bytes);
  66   }
  67
  68   BitstreamReader(BitstreamReader &&Other) {
  69     *this = std::move(Other);
  70   }
  71
  72   BitstreamReader &operator=(BitstreamReader &&Other) {
  73     BitcodeBytes = std::move(Other.BitcodeBytes);
  74     // Explicitly swap block info, so that nothing gets destroyed twice.
  75     std::swap(BlockInfoRecords, Other.BlockInfoRecords);
  76     IgnoreBlockInfoNames = Other.IgnoreBlockInfoNames;
  77     return *this;
  78   }
  79
  80   void init(const unsigned char *Start, const unsigned char *End) {
  81     assert(((End-Start) & 3) == 0 &&"Bitcode stream not a multiple of 4 bytes");
  82     BitcodeBytes.reset(getNonStreamedMemoryObject(Start, End));
  83   }
  84
  85   MemoryObject &getBitcodeBytes() { return *BitcodeBytes; }
  86
  87   /// This is called by clients that want block/record name information.
  88   void CollectBlockInfoNames() { IgnoreBlockInfoNames = false; }
  89   bool isIgnoringBlockInfoNames() { return IgnoreBlockInfoNames; }
  90
  91   //===--------------------------------------------------------------------===//
  92   // Block Manipulation
  93   //===--------------------------------------------------------------------===//
  94
  95   /// Return true if we've already read and processed the block info block for
  96   /// this Bitstream. We only process it for the first cursor that walks over
  97   /// it.
  98   bool hasBlockInfoRecords() const { return !BlockInfoRecords.empty(); }
  99
 100   /// If there is block info for the specified ID, return it, otherwise return
 101   /// null.
 102   const BlockInfo *getBlockInfo(unsigned BlockID) const {
 103     // Common case, the most recent entry matches BlockID.
 104     if (!BlockInfoRecords.empty() && BlockInfoRecords.back().BlockID == BlockID)
 105       return &BlockInfoRecords.back();
 106
 107     for (unsigned i = 0, e = static_cast<unsigned>(BlockInfoRecords.size());
 108          i != e; ++i)
 109       if (BlockInfoRecords[i].BlockID == BlockID)
 110         return &BlockInfoRecords[i];
 111     return nullptr;
 112   }
 113
 114   BlockInfo &getOrCreateBlockInfo(unsigned BlockID) {
 115     if (const BlockInfo *BI = getBlockInfo(BlockID))
 116       return *const_cast<BlockInfo*>(BI);
 117
 118     // Otherwise, add a new record.
 119     BlockInfoRecords.push_back(BlockInfo());
 120     BlockInfoRecords.back().BlockID = BlockID;
 121     return BlockInfoRecords.back();
 122   }
 123
 124   /// Takes block info from the other bitstream reader.
 125   ///
 126   /// This is a "take" operation because BlockInfo records are non-trivial, and
 127   /// indeed rather expensive.
 128   void takeBlockInfo(BitstreamReader &&Other) {
 129     assert(!hasBlockInfoRecords());
 130     BlockInfoRecords = std::move(Other.BlockInfoRecords);
 131   }
 132 };
 133
 134 /// When advancing through a bitstream cursor, each advance can discover a few
 135 /// different kinds of entries:
 136 struct BitstreamEntry {
 137   enum {
 138     Error,    // Malformed bitcode was found.
 139     EndBlock, // We've reached the end of the current block, (or the end of the
 140               // file, which is treated like a series of EndBlock records.
 141     SubBlock, // This is the start of a new subblock of a specific ID.
 142     Record    // This is a record with a specific AbbrevID.
 143   } Kind;
 144
 145   unsigned ID;
 146
 147   static BitstreamEntry getError() {
 148     BitstreamEntry E; E.Kind = Error; return E;
 149   }
 150   static BitstreamEntry getEndBlock() {
 151     BitstreamEntry E; E.Kind = EndBlock; return E;
 152   }
 153   static BitstreamEntry getSubBlock(unsigned ID) {
 154     BitstreamEntry E; E.Kind = SubBlock; E.ID = ID; return E;
 155   }
 156   static BitstreamEntry getRecord(unsigned AbbrevID) {
 157     BitstreamEntry E; E.Kind = Record; E.ID = AbbrevID; return E;
 158   }
 159 };
 160
 161 /// This represents a position within a bitcode file. There may be multiple
 162 /// independent cursors reading within one bitstream, each maintaining their own
 163 /// local state.
 164 ///
 165 /// Unlike iterators, BitstreamCursors are heavy-weight objects that should not
 166 /// be passed by value.
 167 class BitstreamCursor {
 168   friend class Deserializer;
 169   BitstreamReader *BitStream;
 170   size_t NextChar;
 171
 172   /// This is the current data we have pulled from the stream but have not
 173   /// returned to the client. This is specifically and intentionally defined to
 174   /// follow the word size of the host machine for efficiency. We use word_t in
 175   /// places that are aware of this to make it perfectly explicit what is going
 176   /// on.
 177   typedef uint32_t word_t;
 178   word_t CurWord;
 179
 180   /// This is the number of bits in CurWord that are valid. This is always from
 181   /// [0...31/63] inclusive (depending on word size).
 182   unsigned BitsInCurWord;
 183
 184   // This is the declared size of code values used for the current block, in
 185   // bits.
 186   unsigned CurCodeSize;
 187
 188   /// Abbrevs installed at in this block.
 189   std::vector<IntrusiveRefCntPtr<BitCodeAbbrev>> CurAbbrevs;
 190
 191   struct Block {
 192     unsigned PrevCodeSize;
 193     std::vector<IntrusiveRefCntPtr<BitCodeAbbrev>> PrevAbbrevs;
 194     explicit Block(unsigned PCS) : PrevCodeSize(PCS) {}
 195   };
 196
 197   /// This tracks the codesize of parent blocks.
 198   SmallVector<Block, 8> BlockScope;
 199
 200
 201 public:
 202   BitstreamCursor() { init(nullptr); }
 203
 204   explicit BitstreamCursor(BitstreamReader &R) { init(&R); }
 205
 206   void init(BitstreamReader *R) {
 207     freeState();
 208
 209     BitStream = R;
 210     NextChar = 0;
 211     CurWord = 0;
 212     BitsInCurWord = 0;
 213     CurCodeSize = 2;
 214   }
 215
 216   void freeState();
 217
 218   bool isEndPos(size_t pos) {
 219     return BitStream->getBitcodeBytes().isObjectEnd(static_cast<uint64_t>(pos));
 220   }
 221
 222   bool canSkipToPos(size_t pos) const {
 223     // pos can be skipped to if it is a valid address or one byte past the end.
 224     return pos == 0 || BitStream->getBitcodeBytes().isValidAddress(
 225         static_cast<uint64_t>(pos - 1));
 226   }
 227
 228   bool AtEndOfStream() {
 229     return BitsInCurWord == 0 && isEndPos(NextChar);
 230   }
 231
 232   /// Return the number of bits used to encode an abbrev #.
 233   unsigned getAbbrevIDWidth() const { return CurCodeSize; }
 234
 235   /// Return the bit # of the bit we are reading.
 236   uint64_t GetCurrentBitNo() const {
 237     return NextChar*CHAR_BIT - BitsInCurWord;
 238   }
 239
 240   BitstreamReader *getBitStreamReader() {
 241     return BitStream;
 242   }
 243   const BitstreamReader *getBitStreamReader() const {
 244     return BitStream;
 245   }
 246
 247   /// Flags that modify the behavior of advance().
 248   enum {
 249     /// If this flag is used, the advance() method does not automatically pop
 250     /// the block scope when the end of a block is reached.
 251     AF_DontPopBlockAtEnd = 1,
 252
 253     /// If this flag is used, abbrev entries are returned just like normal
 254     /// records.
 255     AF_DontAutoprocessAbbrevs = 2
 256   };
 257
 258       /// Advance the current bitstream, returning the next entry in the stream.
 259       BitstreamEntry advance(unsigned Flags = 0) {
 260     while (1) {
 261       unsigned Code = ReadCode();
 262       if (Code == bitc::END_BLOCK) {
 263         // Pop the end of the block unless Flags tells us not to.
 264         if (!(Flags & AF_DontPopBlockAtEnd) && ReadBlockEnd())
 265           return BitstreamEntry::getError();
 266         return BitstreamEntry::getEndBlock();
 267       }
 268
 269       if (Code == bitc::ENTER_SUBBLOCK)
 270         return BitstreamEntry::getSubBlock(ReadSubBlockID());
 271
 272       if (Code == bitc::DEFINE_ABBREV &&
 273           !(Flags & AF_DontAutoprocessAbbrevs)) {
 274         // We read and accumulate abbrev's, the client can't do anything with
 275         // them anyway.
 276         ReadAbbrevRecord();
 277         continue;
 278       }
 279
 280       return BitstreamEntry::getRecord(Code);
 281     }
 282   }
 283
 284   /// This is a convenience function for clients that don't expect any
 285   /// subblocks. This just skips over them automatically.
 286   BitstreamEntry advanceSkippingSubblocks(unsigned Flags = 0) {
 287     while (1) {
 288       // If we found a normal entry, return it.
 289       BitstreamEntry Entry = advance(Flags);
 290       if (Entry.Kind != BitstreamEntry::SubBlock)
 291         return Entry;
 292
 293       // If we found a sub-block, just skip over it and check the next entry.
 294       if (SkipBlock())
 295         return BitstreamEntry::getError();
 296     }
 297   }
 298
 299   /// Reset the stream to the specified bit number.
 300   void JumpToBit(uint64_t BitNo) {
 301     uintptr_t ByteNo = uintptr_t(BitNo/8) & ~(sizeof(word_t)-1);
 302     unsigned WordBitNo = unsigned(BitNo & (sizeof(word_t)*8-1));
 303     assert(canSkipToPos(ByteNo) && "Invalid location");
 304
 305     // Move the cursor to the right word.
 306     NextChar = ByteNo;
 307     BitsInCurWord = 0;
 308     CurWord = 0;
 309
 310     // Skip over any bits that are already consumed.
 311     if (WordBitNo) {
 312       if (sizeof(word_t) > 4)
 313         Read64(WordBitNo);
 314       else
 315         Read(WordBitNo);
 316     }
 317   }
 318
 319
 320   uint32_t Read(unsigned NumBits) {
 321     assert(NumBits && NumBits <= 32 &&
 322            "Cannot return zero or more than 32 bits!");
 323
 324     // If the field is fully contained by CurWord, return it quickly.
 325     if (BitsInCurWord >= NumBits) {
 326       uint32_t R = uint32_t(CurWord) & (~0U >> (32-NumBits));
 327       CurWord >>= NumBits;
 328       BitsInCurWord -= NumBits;
 329       return R;
 330     }
 331
 332     // If we run out of data, stop at the end of the stream.
 333     if (isEndPos(NextChar)) {
 334       CurWord = 0;
 335       BitsInCurWord = 0;
 336       return 0;
 337     }
 338
 339     uint32_t R = uint32_t(CurWord);
 340
 341     // Read the next word from the stream.
 342     uint8_t Array[sizeof(word_t)] = {0};
 343
 344     BitStream->getBitcodeBytes().readBytes(Array, sizeof(Array), NextChar);
 345
 346     // Handle big-endian byte-swapping if necessary.
 347     support::detail::packed_endian_specific_integral
 348       <word_t, support::little, support::unaligned> EndianValue;
 349     memcpy(&EndianValue, Array, sizeof(Array));
 350
 351     CurWord = EndianValue;
 352
 353     NextChar += sizeof(word_t);
 354
 355     // Extract NumBits-BitsInCurWord from what we just read.
 356     unsigned BitsLeft = NumBits-BitsInCurWord;
 357
 358     // Be careful here, BitsLeft is in the range [1..32]/[1..64] inclusive.
 359     R |= uint32_t((CurWord & (word_t(~0ULL) >> (sizeof(word_t)*8-BitsLeft)))
 360                     << BitsInCurWord);
 361
 362     // BitsLeft bits have just been used up from CurWord.  BitsLeft is in the
 363     // range [1..32]/[1..64] so be careful how we shift.
 364     if (BitsLeft != sizeof(word_t)*8)
 365       CurWord >>= BitsLeft;
 366     else
 367       CurWord = 0;
 368     BitsInCurWord = sizeof(word_t)*8-BitsLeft;
 369     return R;
 370   }
 371
 372   uint64_t Read64(unsigned NumBits) {
 373     if (NumBits <= 32) return Read(NumBits);
 374
 375     uint64_t V = Read(32);
 376     return V | (uint64_t)Read(NumBits-32) << 32;
 377   }
 378
 379   uint32_t ReadVBR(unsigned NumBits) {
 380     uint32_t Piece = Read(NumBits);
 381     if ((Piece & (1U << (NumBits-1))) == 0)
 382       return Piece;
 383
 384     uint32_t Result = 0;
 385     unsigned NextBit = 0;
 386     while (1) {
 387       Result |= (Piece & ((1U << (NumBits-1))-1)) << NextBit;
 388
 389       if ((Piece & (1U << (NumBits-1))) == 0)
 390         return Result;
 391
 392       NextBit += NumBits-1;
 393       Piece = Read(NumBits);
 394     }
 395   }
 396
 397   // Read a VBR that may have a value up to 64-bits in size. The chunk size of
 398   // the VBR must still be <= 32 bits though.
 399   uint64_t ReadVBR64(unsigned NumBits) {
 400     uint32_t Piece = Read(NumBits);
 401     if ((Piece & (1U << (NumBits-1))) == 0)
 402       return uint64_t(Piece);
 403
 404     uint64_t Result = 0;
 405     unsigned NextBit = 0;
 406     while (1) {
 407       Result |= uint64_t(Piece & ((1U << (NumBits-1))-1)) << NextBit;
 408
 409       if ((Piece & (1U << (NumBits-1))) == 0)
 410         return Result;
 411
 412       NextBit += NumBits-1;
 413       Piece = Read(NumBits);
 414     }
 415   }
 416
 417 private:
 418   void SkipToFourByteBoundary() {
 419     // If word_t is 64-bits and if we've read less than 32 bits, just dump
 420     // the bits we have up to the next 32-bit boundary.
 421     if (sizeof(word_t) > 4 &&
 422         BitsInCurWord >= 32) {
 423       CurWord >>= BitsInCurWord-32;
 424       BitsInCurWord = 32;
 425       return;
 426     }
 427
 428     BitsInCurWord = 0;
 429     CurWord = 0;
 430   }
 431 public:
 432
 433   unsigned ReadCode() {
 434     return Read(CurCodeSize);
 435   }
 436
 437
 438   // Block header:
 439   //    [ENTER_SUBBLOCK, blockid, newcodelen, <align4bytes>, blocklen]
 440
 441   /// Having read the ENTER_SUBBLOCK code, read the BlockID for the block.
 442   unsigned ReadSubBlockID() {
 443     return ReadVBR(bitc::BlockIDWidth);
 444   }
 445
 446   /// Having read the ENTER_SUBBLOCK abbrevid and a BlockID, skip over the body
 447   /// of this block. If the block record is malformed, return true.
 448   bool SkipBlock() {
 449     // Read and ignore the codelen value.  Since we are skipping this block, we
 450     // don't care what code widths are used inside of it.
 451     ReadVBR(bitc::CodeLenWidth);
 452     SkipToFourByteBoundary();
 453     unsigned NumFourBytes = Read(bitc::BlockSizeWidth);
 454
 455     // Check that the block wasn't partially defined, and that the offset isn't
 456     // bogus.
 457     size_t SkipTo = GetCurrentBitNo() + NumFourBytes*4*8;
 458     if (AtEndOfStream() || !canSkipToPos(SkipTo/8))
 459       return true;
 460
 461     JumpToBit(SkipTo);
 462     return false;
 463   }
 464
 465   /// Having read the ENTER_SUBBLOCK abbrevid, enter the block, and return true
 466   /// if the block has an error.
 467   bool EnterSubBlock(unsigned BlockID, unsigned *NumWordsP = nullptr);
 468
 469   bool ReadBlockEnd() {
 470     if (BlockScope.empty()) return true;
 471
 472     // Block tail:
 473     //    [END_BLOCK, <align4bytes>]
 474     SkipToFourByteBoundary();
 475
 476     popBlockScope();
 477     return false;
 478   }
 479
 480 private:
 481
 482   void popBlockScope() {
 483     CurCodeSize = BlockScope.back().PrevCodeSize;
 484
 485     CurAbbrevs = std::move(BlockScope.back().PrevAbbrevs);
 486     BlockScope.pop_back();
 487   }
 488
 489   //===--------------------------------------------------------------------===//
 490   // Record Processing
 491   //===--------------------------------------------------------------------===//
 492
 493 private:
 494   void readAbbreviatedLiteral(const BitCodeAbbrevOp &Op,
 495                               SmallVectorImpl<uint64_t> &Vals);
 496   void readAbbreviatedField(const BitCodeAbbrevOp &Op,
 497                             SmallVectorImpl<uint64_t> &Vals);
 498   void skipAbbreviatedField(const BitCodeAbbrevOp &Op);
 499
 500 public:
 501
 502   /// Return the abbreviation for the specified AbbrevId.
 503   const BitCodeAbbrev *getAbbrev(unsigned AbbrevID) {
 504     unsigned AbbrevNo = AbbrevID-bitc::FIRST_APPLICATION_ABBREV;
 505     assert(AbbrevNo < CurAbbrevs.size() && "Invalid abbrev #!");
 506     return CurAbbrevs[AbbrevNo].get();
 507   }
 508
 509   /// Read the current record and discard it.
 510   void skipRecord(unsigned AbbrevID);
 511
 512   unsigned readRecord(unsigned AbbrevID, SmallVectorImpl<uint64_t> &Vals,
 513                       StringRef *Blob = nullptr);
 514
 515   //===--------------------------------------------------------------------===//
 516   // Abbrev Processing
 517   //===--------------------------------------------------------------------===//
 518   void ReadAbbrevRecord();
 519
 520   bool ReadBlockInfoBlock();
 521 };
 522
 523 } // End llvm namespace
 524
 525 #endif