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   // The size of the bicode. 0 if we don't know it yet.
 173   size_t Size;
 174
 175   /// This is the current data we have pulled from the stream but have not
 176   /// returned to the client. This is specifically and intentionally defined to
 177   /// follow the word size of the host machine for efficiency. We use word_t in
 178   /// places that are aware of this to make it perfectly explicit what is going
 179   /// on.
 180   typedef size_t word_t;
 181   word_t CurWord;
 182
 183   /// This is the number of bits in CurWord that are valid. This is always from
 184   /// [0...bits_of(size_t)-1] inclusive.
 185   unsigned BitsInCurWord;
 186
 187   // This is the declared size of code values used for the current block, in
 188   // bits.
 189   unsigned CurCodeSize;
 190
 191   /// Abbrevs installed at in this block.
 192   std::vector<IntrusiveRefCntPtr<BitCodeAbbrev>> CurAbbrevs;
 193
 194   struct Block {
 195     unsigned PrevCodeSize;
 196     std::vector<IntrusiveRefCntPtr<BitCodeAbbrev>> PrevAbbrevs;
 197     explicit Block(unsigned PCS) : PrevCodeSize(PCS) {}
 198   };
 199
 200   /// This tracks the codesize of parent blocks.
 201   SmallVector<Block, 8> BlockScope;
 202
 203
 204 public:
 205   BitstreamCursor() { init(nullptr); }
 206
 207   explicit BitstreamCursor(BitstreamReader &R) { init(&R); }
 208
 209   void init(BitstreamReader *R) {
 210     freeState();
 211
 212     BitStream = R;
 213     NextChar = 0;
 214     Size = 0;
 215     BitsInCurWord = 0;
 216     CurCodeSize = 2;
 217   }
 218
 219   void freeState();
 220
 221   bool canSkipToPos(size_t pos) const {
 222     // pos can be skipped to if it is a valid address or one byte past the end.
 223     return pos == 0 || BitStream->getBitcodeBytes().isValidAddress(
 224         static_cast<uint64_t>(pos - 1));
 225   }
 226
 227   bool AtEndOfStream() {
 228     if (BitsInCurWord != 0)
 229       return false;
 230     if (Size != 0)
 231       return Size == NextChar;
 232     fillCurWord();
 233     return BitsInCurWord == 0;
 234   }
 235
 236   /// Return the number of bits used to encode an abbrev #.
 237   unsigned getAbbrevIDWidth() const { return CurCodeSize; }
 238
 239   /// Return the bit # of the bit we are reading.
 240   uint64_t GetCurrentBitNo() const {
 241     return NextChar*CHAR_BIT - BitsInCurWord;
 242   }
 243
 244   BitstreamReader *getBitStreamReader() {
 245     return BitStream;
 246   }
 247   const BitstreamReader *getBitStreamReader() const {
 248     return BitStream;
 249   }
 250
 251   /// Flags that modify the behavior of advance().
 252   enum {
 253     /// If this flag is used, the advance() method does not automatically pop
 254     /// the block scope when the end of a block is reached.
 255     AF_DontPopBlockAtEnd = 1,
 256
 257     /// If this flag is used, abbrev entries are returned just like normal
 258     /// records.
 259     AF_DontAutoprocessAbbrevs = 2
 260   };
 261
 262       /// Advance the current bitstream, returning the next entry in the stream.
 263       BitstreamEntry advance(unsigned Flags = 0) {
 264     while (1) {
 265       unsigned Code = ReadCode();
 266       if (Code == bitc::END_BLOCK) {
 267         // Pop the end of the block unless Flags tells us not to.
 268         if (!(Flags & AF_DontPopBlockAtEnd) && ReadBlockEnd())
 269           return BitstreamEntry::getError();
 270         return BitstreamEntry::getEndBlock();
 271       }
 272
 273       if (Code == bitc::ENTER_SUBBLOCK)
 274         return BitstreamEntry::getSubBlock(ReadSubBlockID());
 275
 276       if (Code == bitc::DEFINE_ABBREV &&
 277           !(Flags & AF_DontAutoprocessAbbrevs)) {
 278         // We read and accumulate abbrev's, the client can't do anything with
 279         // them anyway.
 280         ReadAbbrevRecord();
 281         continue;
 282       }
 283
 284       return BitstreamEntry::getRecord(Code);
 285     }
 286   }
 287
 288   /// This is a convenience function for clients that don't expect any
 289   /// subblocks. This just skips over them automatically.
 290   BitstreamEntry advanceSkippingSubblocks(unsigned Flags = 0) {
 291     while (1) {
 292       // If we found a normal entry, return it.
 293       BitstreamEntry Entry = advance(Flags);
 294       if (Entry.Kind != BitstreamEntry::SubBlock)
 295         return Entry;
 296
 297       // If we found a sub-block, just skip over it and check the next entry.
 298       if (SkipBlock())
 299         return BitstreamEntry::getError();
 300     }
 301   }
 302
 303   /// Reset the stream to the specified bit number.
 304   void JumpToBit(uint64_t BitNo) {
 305     uintptr_t ByteNo = uintptr_t(BitNo/8) & ~(sizeof(word_t)-1);
 306     unsigned WordBitNo = unsigned(BitNo & (sizeof(word_t)*8-1));
 307     assert(canSkipToPos(ByteNo) && "Invalid location");
 308
 309     // Move the cursor to the right word.
 310     NextChar = ByteNo;
 311     BitsInCurWord = 0;
 312
 313     // Skip over any bits that are already consumed.
 314     if (WordBitNo)
 315       Read(WordBitNo);
 316   }
 317
 318   void fillCurWord() {
 319     assert(Size == 0 || NextChar < (unsigned)Size);
 320
 321     // Read the next word from the stream.
 322     uint8_t Array[sizeof(word_t)] = {0};
 323
 324     uint64_t BytesRead =
 325         BitStream->getBitcodeBytes().readBytes(Array, sizeof(Array), NextChar);
 326
 327     // If we run out of data, stop at the end of the stream.
 328     if (BytesRead == 0) {
 329       Size = NextChar;
 330       return;
 331     }
 332
 333     CurWord =
 334         support::endian::read<word_t, support::little, support::unaligned>(
 335             Array);
 336     NextChar += BytesRead;
 337     BitsInCurWord = BytesRead * 8;
 338   }
 339
 340   word_t Read(unsigned NumBits) {
 341     assert(NumBits && NumBits <= sizeof(word_t) * 8 &&
 342            "Cannot return zero or more than BitsInWord bits!");
 343
 344     static const unsigned Mask = sizeof(word_t) > 4 ? 0x3f : 0x1f;
 345
 346     // If the field is fully contained by CurWord, return it quickly.
 347     if (BitsInCurWord >= NumBits) {
 348       word_t R = CurWord & ((word_t(1) << NumBits) - 1);
 349
 350       // Use a mask to avoid undefined behavior.
 351       CurWord >>= (NumBits & Mask);
 352
 353       BitsInCurWord -= NumBits;
 354       return R;
 355     }
 356
 357     word_t R = BitsInCurWord ? CurWord : 0;
 358     unsigned BitsLeft = NumBits - BitsInCurWord;
 359
 360     fillCurWord();
 361
 362     // If we run out of data, stop at the end of the stream.
 363     if (BitsLeft > BitsInCurWord)
 364       return 0;
 365
 366     word_t R2 = CurWord & ((word_t(1) << BitsLeft) - 1);
 367
 368     // Use a mask to avoid undefined behavior.
 369     CurWord >>= (BitsLeft & Mask);
 370
 371     BitsInCurWord -= BitsLeft;
 372
 373     R |= R2 << (NumBits - BitsLeft);
 374
 375     return R;
 376   }
 377
 378   uint32_t ReadVBR(unsigned NumBits) {
 379     uint32_t Piece = Read(NumBits);
 380     if ((Piece & (1U << (NumBits-1))) == 0)
 381       return Piece;
 382
 383     uint32_t Result = 0;
 384     unsigned NextBit = 0;
 385     while (1) {
 386       Result |= (Piece & ((1U << (NumBits-1))-1)) << NextBit;
 387
 388       if ((Piece & (1U << (NumBits-1))) == 0)
 389         return Result;
 390
 391       NextBit += NumBits-1;
 392       Piece = Read(NumBits);
 393     }
 394   }
 395
 396   // Read a VBR that may have a value up to 64-bits in size. The chunk size of
 397   // the VBR must still be <= 32 bits though.
 398   uint64_t ReadVBR64(unsigned NumBits) {
 399     uint32_t Piece = Read(NumBits);
 400     if ((Piece & (1U << (NumBits-1))) == 0)
 401       return uint64_t(Piece);
 402
 403     uint64_t Result = 0;
 404     unsigned NextBit = 0;
 405     while (1) {
 406       Result |= uint64_t(Piece & ((1U << (NumBits-1))-1)) << NextBit;
 407
 408       if ((Piece & (1U << (NumBits-1))) == 0)
 409         return Result;
 410
 411       NextBit += NumBits-1;
 412       Piece = Read(NumBits);
 413     }
 414   }
 415
 416 private:
 417   void SkipToFourByteBoundary() {
 418     // If word_t is 64-bits and if we've read less than 32 bits, just dump
 419     // the bits we have up to the next 32-bit boundary.
 420     if (sizeof(word_t) > 4 &&
 421         BitsInCurWord >= 32) {
 422       CurWord >>= BitsInCurWord-32;
 423       BitsInCurWord = 32;
 424       return;
 425     }
 426
 427     BitsInCurWord = 0;
 428   }
 429 public:
 430
 431   unsigned ReadCode() {
 432     return Read(CurCodeSize);
 433   }
 434
 435
 436   // Block header:
 437   //    [ENTER_SUBBLOCK, blockid, newcodelen, <align4bytes>, blocklen]
 438
 439   /// Having read the ENTER_SUBBLOCK code, read the BlockID for the block.
 440   unsigned ReadSubBlockID() {
 441     return ReadVBR(bitc::BlockIDWidth);
 442   }
 443
 444   /// Having read the ENTER_SUBBLOCK abbrevid and a BlockID, skip over the body
 445   /// of this block. If the block record is malformed, return true.
 446   bool SkipBlock() {
 447     // Read and ignore the codelen value.  Since we are skipping this block, we
 448     // don't care what code widths are used inside of it.
 449     ReadVBR(bitc::CodeLenWidth);
 450     SkipToFourByteBoundary();
 451     unsigned NumFourBytes = Read(bitc::BlockSizeWidth);
 452
 453     // Check that the block wasn't partially defined, and that the offset isn't
 454     // bogus.
 455     size_t SkipTo = GetCurrentBitNo() + NumFourBytes*4*8;
 456     if (AtEndOfStream() || !canSkipToPos(SkipTo/8))
 457       return true;
 458
 459     JumpToBit(SkipTo);
 460     return false;
 461   }
 462
 463   /// Having read the ENTER_SUBBLOCK abbrevid, enter the block, and return true
 464   /// if the block has an error.
 465   bool EnterSubBlock(unsigned BlockID, unsigned *NumWordsP = nullptr);
 466
 467   bool ReadBlockEnd() {
 468     if (BlockScope.empty()) return true;
 469
 470     // Block tail:
 471     //    [END_BLOCK, <align4bytes>]
 472     SkipToFourByteBoundary();
 473
 474     popBlockScope();
 475     return false;
 476   }
 477
 478 private:
 479
 480   void popBlockScope() {
 481     CurCodeSize = BlockScope.back().PrevCodeSize;
 482
 483     CurAbbrevs = std::move(BlockScope.back().PrevAbbrevs);
 484     BlockScope.pop_back();
 485   }
 486
 487   //===--------------------------------------------------------------------===//
 488   // Record Processing
 489   //===--------------------------------------------------------------------===//
 490
 491 public:
 492
 493   /// Return the abbreviation for the specified AbbrevId.
 494   const BitCodeAbbrev *getAbbrev(unsigned AbbrevID) {
 495     unsigned AbbrevNo = AbbrevID-bitc::FIRST_APPLICATION_ABBREV;
 496     assert(AbbrevNo < CurAbbrevs.size() && "Invalid abbrev #!");
 497     return CurAbbrevs[AbbrevNo].get();
 498   }
 499
 500   /// Read the current record and discard it.
 501   void skipRecord(unsigned AbbrevID);
 502
 503   unsigned readRecord(unsigned AbbrevID, SmallVectorImpl<uint64_t> &Vals,
 504                       StringRef *Blob = nullptr);
 505
 506   //===--------------------------------------------------------------------===//
 507   // Abbrev Processing
 508   //===--------------------------------------------------------------------===//
 509   void ReadAbbrevRecord();
 510
 511   bool ReadBlockInfoBlock();
 512 };
 513
 514 } // End llvm namespace
 515
 516 #endif