1b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner//===- BitstreamWriter.h - Low-level bitstream writer interface -*- C++ -*-===// 2b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// 3b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// The LLVM Compiler Infrastructure 4b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// 57ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// This file is distributed under the University of Illinois Open Source 67ed47a13356daed2a34cd2209a31f92552e3bdd8Chris Lattner// License. See LICENSE.TXT for details. 7b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// 8b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner//===----------------------------------------------------------------------===// 9b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// 10b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// This header defines the BitstreamWriter class. This class can be used to 11b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// write an arbitrary bitstream, regardless of its contents. 12b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// 13b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner//===----------------------------------------------------------------------===// 14b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 15674be02d525d4e24bc6943ed9274958c580bcfbcJakub Staszak#ifndef LLVM_BITCODE_BITSTREAMWRITER_H 16674be02d525d4e24bc6943ed9274958c580bcfbcJakub Staszak#define LLVM_BITCODE_BITSTREAMWRITER_H 17b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 18f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/ADT/ArrayRef.h" 19f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/ADT/Optional.h" 20acbceeae4d7bdfbbc3437c60a5a3e26449888a15Daniel Dunbar#include "llvm/ADT/SmallVector.h" 21255f89faee13dc491cb64fbeae3c763e7e2ea4e6Chandler Carruth#include "llvm/ADT/StringRef.h" 22b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner#include "llvm/Bitcode/BitCodes.h" 23f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar#include "llvm/Support/Endian.h" 24b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner#include <vector> 25b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 26b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattnernamespace llvm { 27b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 28b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattnerclass BitstreamWriter { 29acbceeae4d7bdfbbc3437c60a5a3e26449888a15Daniel Dunbar SmallVectorImpl<char> &Out; 30b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 31b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner /// CurBit - Always between 0 and 31 inclusive, specifies the next bit to use. 32b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner unsigned CurBit; 33d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 34b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner /// CurValue - The current value. Only bits < CurBit are valid. 35b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner uint32_t CurValue; 36d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 37e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// CurCodeSize - This is the declared size of code values used for the 38e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// current block, in bits. 39b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner unsigned CurCodeSize; 402a5e354f2053fccfa35aa997935aa7100f4c2223Chris Lattner 41e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// BlockInfoCurBID - When emitting a BLOCKINFO_BLOCK, this is the currently 42e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// selected BLOCK ID. 43e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner unsigned BlockInfoCurBID; 44d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 452a5e354f2053fccfa35aa997935aa7100f4c2223Chris Lattner /// CurAbbrevs - Abbrevs installed at in this block. 4637ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines std::vector<IntrusiveRefCntPtr<BitCodeAbbrev>> CurAbbrevs; 472a5e354f2053fccfa35aa997935aa7100f4c2223Chris Lattner 48b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner struct Block { 49b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner unsigned PrevCodeSize; 50f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar size_t StartSizeWord; 5137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines std::vector<IntrusiveRefCntPtr<BitCodeAbbrev>> PrevAbbrevs; 52f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Block(unsigned PCS, size_t SSW) : PrevCodeSize(PCS), StartSizeWord(SSW) {} 53b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner }; 54d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 55b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner /// BlockScope - This tracks the current blocks that we have entered. 56b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner std::vector<Block> BlockScope; 57d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 58e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// BlockInfo - This contains information emitted to BLOCKINFO_BLOCK blocks. 59e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// These describe abbreviations that all blocks of the specified ID inherit. 60e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner struct BlockInfo { 61e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner unsigned BlockID; 6237ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines std::vector<IntrusiveRefCntPtr<BitCodeAbbrev>> Abbrevs; 63e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner }; 64e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner std::vector<BlockInfo> BlockInfoRecords; 65d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 66a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar void WriteByte(unsigned char Value) { 67a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar Out.push_back(Value); 68a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar } 69a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar 70a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar void WriteWord(unsigned Value) { 71f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Value = support::endian::byte_swap<uint32_t, support::little>(Value); 72f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Out.append(reinterpret_cast<const char *>(&Value), 73f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar reinterpret_cast<const char *>(&Value + 1)); 74a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar } 75a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar 76f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar size_t GetBufferOffset() const { return Out.size(); } 77a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar 78f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar size_t GetWordIndex() const { 79f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar size_t Offset = GetBufferOffset(); 80a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar assert((Offset & 3) == 0 && "Not 32-bit aligned"); 81a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar return Offset / 4; 82a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar } 83a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar 84b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattnerpublic: 85acbceeae4d7bdfbbc3437c60a5a3e26449888a15Daniel Dunbar explicit BitstreamWriter(SmallVectorImpl<char> &O) 86b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner : Out(O), CurBit(0), CurValue(0), CurCodeSize(2) {} 87b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 88b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner ~BitstreamWriter() { 8936b56886974eae4f9c5ebc96befd3e7bfe5de338Stephen Hines assert(CurBit == 0 && "Unflushed data remaining"); 902a5e354f2053fccfa35aa997935aa7100f4c2223Chris Lattner assert(BlockScope.empty() && CurAbbrevs.empty() && "Block imbalance"); 91b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 9238e77214558f3a5f917896df575de1c01ee60f47Chris Lattner 93b7e7886c79cd273f68eb47b534135322fa76c68dDouglas Gregor /// \brief Retrieve the current position in the stream, in bits. 94a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar uint64_t GetCurrentBitNo() const { return GetBufferOffset() * 8 + CurBit; } 95b7e7886c79cd273f68eb47b534135322fa76c68dDouglas Gregor 96f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// \brief Retrieve the number of bits currently used to encode an abbrev ID. 97f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned GetAbbrevIDWidth() const { return CurCodeSize; } 98f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 99b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner //===--------------------------------------------------------------------===// 100b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // Basic Primitives for emitting bits to the stream. 101b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner //===--------------------------------------------------------------------===// 102d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 103f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// Backpatch a 32-bit word in the output at the given bit offset 104f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// with the specified value. 105f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void BackpatchWord(uint64_t BitNo, unsigned NewWord) { 106f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar using namespace llvm::support; 107f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned ByteNo = BitNo / 8; 108f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar assert((!endian::readAtBitAlignment<uint32_t, little, unaligned>( 109f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar &Out[ByteNo], BitNo & 7)) && 110f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "Expected to be patching over 0-value placeholders"); 111f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar endian::writeAtBitAlignment<uint32_t, little, unaligned>( 112f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar &Out[ByteNo], NewWord, BitNo & 7); 113f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 114f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 115b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner void Emit(uint32_t Val, unsigned NumBits) { 116c62a4b0f03269fdad85fa683d57f1bd2b80a5c7aChris Lattner assert(NumBits && NumBits <= 32 && "Invalid value size!"); 117b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner assert((Val & ~(~0U >> (32-NumBits))) == 0 && "High bits set!"); 118b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner CurValue |= Val << CurBit; 119b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner if (CurBit + NumBits < 32) { 120b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner CurBit += NumBits; 121b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner return; 122b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 123d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 124b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // Add the current word. 125a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar WriteWord(CurValue); 126d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 127b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner if (CurBit) 128a0c96a068ca7027644b5f1972f9c388fa542d278Jeff Cohen CurValue = Val >> (32-CurBit); 129b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner else 130b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner CurValue = 0; 131b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner CurBit = (CurBit+NumBits) & 31; 132b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 133d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 134b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner void Emit64(uint64_t Val, unsigned NumBits) { 135b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner if (NumBits <= 32) 136b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner Emit((uint32_t)Val, NumBits); 137b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner else { 138b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner Emit((uint32_t)Val, 32); 139b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner Emit((uint32_t)(Val >> 32), NumBits-32); 140b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 141b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 142d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 143b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner void FlushToWord() { 144b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner if (CurBit) { 145a8d16bbdfba55b309234cecbabad015a13683781Daniel Dunbar WriteWord(CurValue); 146b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner CurBit = 0; 147b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner CurValue = 0; 148b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 149b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 150d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 151b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner void EmitVBR(uint32_t Val, unsigned NumBits) { 15291fcb7f42099f11f8ea298c4b231d801998bf2ddDuncan Sands assert(NumBits <= 32 && "Too many bits to emit!"); 153b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner uint32_t Threshold = 1U << (NumBits-1); 154d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 155b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // Emit the bits with VBR encoding, NumBits-1 bits at a time. 156b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner while (Val >= Threshold) { 157b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner Emit((Val & ((1 << (NumBits-1))-1)) | (1 << (NumBits-1)), NumBits); 158b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner Val >>= NumBits-1; 159b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 160d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 161b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner Emit(Val, NumBits); 162b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 163d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 164b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner void EmitVBR64(uint64_t Val, unsigned NumBits) { 16591fcb7f42099f11f8ea298c4b231d801998bf2ddDuncan Sands assert(NumBits <= 32 && "Too many bits to emit!"); 166b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner if ((uint32_t)Val == Val) 167b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner return EmitVBR((uint32_t)Val, NumBits); 168d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 169578d5f4b80a52906a31f1b22329bc2113b79a866Duncan Sands uint32_t Threshold = 1U << (NumBits-1); 170d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 171b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // Emit the bits with VBR encoding, NumBits-1 bits at a time. 172b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner while (Val >= Threshold) { 173b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner Emit(((uint32_t)Val & ((1 << (NumBits-1))-1)) | 174b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner (1 << (NumBits-1)), NumBits); 175b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner Val >>= NumBits-1; 176b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 177d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 178b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner Emit((uint32_t)Val, NumBits); 179b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 180d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 181b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner /// EmitCode - Emit the specified code. 182b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner void EmitCode(unsigned Val) { 183b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner Emit(Val, CurCodeSize); 184b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 185d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 186b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner //===--------------------------------------------------------------------===// 187b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // Block Manipulation 188b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner //===--------------------------------------------------------------------===// 189d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 190e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// getBlockInfo - If there is block info for the specified ID, return it, 191e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// otherwise return null. 192e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner BlockInfo *getBlockInfo(unsigned BlockID) { 193e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner // Common case, the most recent entry matches BlockID. 194e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner if (!BlockInfoRecords.empty() && BlockInfoRecords.back().BlockID == BlockID) 195e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner return &BlockInfoRecords.back(); 196d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 19734cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng for (unsigned i = 0, e = static_cast<unsigned>(BlockInfoRecords.size()); 19834cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng i != e; ++i) 199e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner if (BlockInfoRecords[i].BlockID == BlockID) 200e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner return &BlockInfoRecords[i]; 201dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines return nullptr; 202e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner } 203d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 204b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner void EnterSubblock(unsigned BlockID, unsigned CodeLen) { 205b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // Block header: 206b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // [ENTER_SUBBLOCK, blockid, newcodelen, <align4bytes>, blocklen] 207b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner EmitCode(bitc::ENTER_SUBBLOCK); 208b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner EmitVBR(BlockID, bitc::BlockIDWidth); 209b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner EmitVBR(CodeLen, bitc::CodeLenWidth); 210b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner FlushToWord(); 211d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 212f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar size_t BlockSizeWordIndex = GetWordIndex(); 213e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner unsigned OldCodeSize = CurCodeSize; 214d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 215b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // Emit a placeholder, which will be replaced when the block is popped. 216b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner Emit(0, bitc::BlockSizeWidth); 217d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 218b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner CurCodeSize = CodeLen; 219d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 220e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner // Push the outer block's abbrev set onto the stack, start out with an 221e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner // empty abbrev set. 2226948897e478cbd66626159776a8017b3c18579b9Pirama Arumuga Nainar BlockScope.emplace_back(OldCodeSize, BlockSizeWordIndex); 223e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner BlockScope.back().PrevAbbrevs.swap(CurAbbrevs); 224e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner 225e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner // If there is a blockinfo for this BlockID, add all the predefined abbrevs 226e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner // to the abbrev list. 227e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner if (BlockInfo *Info = getBlockInfo(BlockID)) { 22837ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines CurAbbrevs.insert(CurAbbrevs.end(), Info->Abbrevs.begin(), 22937ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines Info->Abbrevs.end()); 230e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner } 231b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 232d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 233b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner void ExitBlock() { 234b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner assert(!BlockScope.empty() && "Block scope imbalance!"); 23536d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner const Block &B = BlockScope.back(); 236d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 237b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // Block tail: 238b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // [END_BLOCK, <align4bytes>] 239b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner EmitCode(bitc::END_BLOCK); 240b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner FlushToWord(); 241b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 242b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // Compute the size of the block, in words, not counting the size field. 243f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar size_t SizeInWords = GetWordIndex() - B.StartSizeWord - 1; 244f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar uint64_t BitNo = uint64_t(B.StartSizeWord) * 32; 245d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 246b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // Update the block size field in the header of this sub-block. 247f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar BackpatchWord(BitNo, SizeInWords); 248d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 24936d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner // Restore the inner block's code size and abbrev table. 250b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner CurCodeSize = B.PrevCodeSize; 25137ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines CurAbbrevs = std::move(B.PrevAbbrevs); 25236d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner BlockScope.pop_back(); 253b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 254d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 255b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner //===--------------------------------------------------------------------===// 256b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // Record Emission 257b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner //===--------------------------------------------------------------------===// 258d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 2593c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattnerprivate: 26096153a45fd706db8731ba17bdf848912c8033e1dChris Lattner /// EmitAbbreviatedLiteral - Emit a literal value according to its abbrev 261170a15e98dc6900df1ae40d03c5f0622d792fb45Joe Abbey /// record. This is a no-op, since the abbrev specifies the literal to use. 26296153a45fd706db8731ba17bdf848912c8033e1dChris Lattner template<typename uintty> 26396153a45fd706db8731ba17bdf848912c8033e1dChris Lattner void EmitAbbreviatedLiteral(const BitCodeAbbrevOp &Op, uintty V) { 26496153a45fd706db8731ba17bdf848912c8033e1dChris Lattner assert(Op.isLiteral() && "Not a literal"); 26596153a45fd706db8731ba17bdf848912c8033e1dChris Lattner // If the abbrev specifies the literal value to use, don't emit 26696153a45fd706db8731ba17bdf848912c8033e1dChris Lattner // anything. 26796153a45fd706db8731ba17bdf848912c8033e1dChris Lattner assert(V == Op.getLiteralValue() && 26896153a45fd706db8731ba17bdf848912c8033e1dChris Lattner "Invalid abbrev for record!"); 26996153a45fd706db8731ba17bdf848912c8033e1dChris Lattner } 270170a15e98dc6900df1ae40d03c5f0622d792fb45Joe Abbey 2713c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner /// EmitAbbreviatedField - Emit a single scalar field value with the specified 2723c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner /// encoding. 2733c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner template<typename uintty> 2743c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner void EmitAbbreviatedField(const BitCodeAbbrevOp &Op, uintty V) { 27596153a45fd706db8731ba17bdf848912c8033e1dChris Lattner assert(!Op.isLiteral() && "Literals should use EmitAbbreviatedLiteral!"); 276170a15e98dc6900df1ae40d03c5f0622d792fb45Joe Abbey 2773c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner // Encode the value as we are commanded. 2783c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner switch (Op.getEncoding()) { 27950bee42b54cd9aec5f49566307df2b0cf23afcf6Craig Topper default: llvm_unreachable("Unknown encoding!"); 2803c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner case BitCodeAbbrevOp::Fixed: 281c62a4b0f03269fdad85fa683d57f1bd2b80a5c7aChris Lattner if (Op.getEncodingData()) 282c62a4b0f03269fdad85fa683d57f1bd2b80a5c7aChris Lattner Emit((unsigned)V, (unsigned)Op.getEncodingData()); 2833c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner break; 2843c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner case BitCodeAbbrevOp::VBR: 285c62a4b0f03269fdad85fa683d57f1bd2b80a5c7aChris Lattner if (Op.getEncodingData()) 286c62a4b0f03269fdad85fa683d57f1bd2b80a5c7aChris Lattner EmitVBR64(V, (unsigned)Op.getEncodingData()); 2873c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner break; 28828e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner case BitCodeAbbrevOp::Char6: 28928e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner Emit(BitCodeAbbrevOp::EncodeChar6((char)V), 6); 29028e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner break; 291d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman } 2923c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner } 293170a15e98dc6900df1ae40d03c5f0622d792fb45Joe Abbey 294298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// EmitRecordWithAbbrevImpl - This is the core implementation of the record 295298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// emission code. If BlobData is non-null, then it specifies an array of 296298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// data that should be emitted as part of the Blob or Array operand that is 297f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// known to exist at the end of the record. If Code is specified, then 298f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// it is the record code to emit before the Vals, which must not contain 299f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar /// the code. 300f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar template <typename uintty> 301f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void EmitRecordWithAbbrevImpl(unsigned Abbrev, ArrayRef<uintty> Vals, 302f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar StringRef Blob, Optional<unsigned> Code) { 3032b1d3d76d78353d3d7c793d437c6ee355dd0f9abDaniel Dunbar const char *BlobData = Blob.data(); 3042b1d3d76d78353d3d7c793d437c6ee355dd0f9abDaniel Dunbar unsigned BlobLen = (unsigned) Blob.size(); 30540728791f5c8c77d3460a30fcdce6d1fac72aa0dChris Lattner unsigned AbbrevNo = Abbrev-bitc::FIRST_APPLICATION_ABBREV; 30640728791f5c8c77d3460a30fcdce6d1fac72aa0dChris Lattner assert(AbbrevNo < CurAbbrevs.size() && "Invalid abbrev #!"); 30737ed9c199ca639565f6ce88105f9e39e898d82d0Stephen Hines const BitCodeAbbrev *Abbv = CurAbbrevs[AbbrevNo].get(); 30840728791f5c8c77d3460a30fcdce6d1fac72aa0dChris Lattner 30940728791f5c8c77d3460a30fcdce6d1fac72aa0dChris Lattner EmitCode(Abbrev); 31040728791f5c8c77d3460a30fcdce6d1fac72aa0dChris Lattner 311f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar unsigned i = 0, e = static_cast<unsigned>(Abbv->getNumOperandInfos()); 312f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (Code) { 313f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar assert(e && "Expected non-empty abbreviation"); 314f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const BitCodeAbbrevOp &Op = Abbv->getOperandInfo(i++); 315f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 316f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar if (Op.isLiteral()) 317f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EmitAbbreviatedLiteral(Op, Code.getValue()); 318f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar else { 319f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar assert(Op.getEncoding() != BitCodeAbbrevOp::Array && 320f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar Op.getEncoding() != BitCodeAbbrevOp::Blob && 321f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar "Expected literal or scalar"); 322f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EmitAbbreviatedField(Op, Code.getValue()); 323f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 324f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar } 325f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar 32640728791f5c8c77d3460a30fcdce6d1fac72aa0dChris Lattner unsigned RecordIdx = 0; 327f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (; i != e; ++i) { 32840728791f5c8c77d3460a30fcdce6d1fac72aa0dChris Lattner const BitCodeAbbrevOp &Op = Abbv->getOperandInfo(i); 32996153a45fd706db8731ba17bdf848912c8033e1dChris Lattner if (Op.isLiteral()) { 33096153a45fd706db8731ba17bdf848912c8033e1dChris Lattner assert(RecordIdx < Vals.size() && "Invalid abbrev/record"); 33196153a45fd706db8731ba17bdf848912c8033e1dChris Lattner EmitAbbreviatedLiteral(Op, Vals[RecordIdx]); 33296153a45fd706db8731ba17bdf848912c8033e1dChris Lattner ++RecordIdx; 333dcd006bf7be859367f35db2417a42c83451431e8Chris Lattner } else if (Op.getEncoding() == BitCodeAbbrevOp::Array) { 33440728791f5c8c77d3460a30fcdce6d1fac72aa0dChris Lattner // Array case. 335f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar assert(i + 2 == e && "array op not second to last?"); 33640728791f5c8c77d3460a30fcdce6d1fac72aa0dChris Lattner const BitCodeAbbrevOp &EltEnc = Abbv->getOperandInfo(++i); 33740728791f5c8c77d3460a30fcdce6d1fac72aa0dChris Lattner 338298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner // If this record has blob data, emit it, otherwise we must have record 339298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner // entries to encode this way. 340298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner if (BlobData) { 341298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner assert(RecordIdx == Vals.size() && 342298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner "Blob data and record entries specified for array!"); 343298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner // Emit a vbr6 to indicate the number of elements present. 344298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner EmitVBR(static_cast<uint32_t>(BlobLen), 6); 345170a15e98dc6900df1ae40d03c5f0622d792fb45Joe Abbey 346298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner // Emit each field. 347298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner for (unsigned i = 0; i != BlobLen; ++i) 348298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner EmitAbbreviatedField(EltEnc, (unsigned char)BlobData[i]); 349170a15e98dc6900df1ae40d03c5f0622d792fb45Joe Abbey 350298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner // Know that blob data is consumed for assertion below. 351dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines BlobData = nullptr; 352298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner } else { 353298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner // Emit a vbr6 to indicate the number of elements present. 354298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner EmitVBR(static_cast<uint32_t>(Vals.size()-RecordIdx), 6); 355298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner 356298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner // Emit each field. 357298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner for (unsigned e = Vals.size(); RecordIdx != e; ++RecordIdx) 358298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner EmitAbbreviatedField(EltEnc, Vals[RecordIdx]); 359298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner } 360dcd006bf7be859367f35db2417a42c83451431e8Chris Lattner } else if (Op.getEncoding() == BitCodeAbbrevOp::Blob) { 361298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner // If this record has blob data, emit it, otherwise we must have record 362298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner // entries to encode this way. 363170a15e98dc6900df1ae40d03c5f0622d792fb45Joe Abbey 364298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner if (BlobData) { 365298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner assert(RecordIdx == Vals.size() && 366298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner "Blob data and record entries specified for blob operand!"); 367170a15e98dc6900df1ae40d03c5f0622d792fb45Joe Abbey 368de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar assert(Blob.data() == BlobData && "BlobData got moved"); 369de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar assert(Blob.size() == BlobLen && "BlobLen got changed"); 370de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar emitBlob(Blob); 371dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines BlobData = nullptr; 372298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner } else { 373de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar emitBlob(Vals.slice(RecordIdx)); 374dcd006bf7be859367f35db2417a42c83451431e8Chris Lattner } 375dcd006bf7be859367f35db2417a42c83451431e8Chris Lattner } else { // Single scalar field. 376dcd006bf7be859367f35db2417a42c83451431e8Chris Lattner assert(RecordIdx < Vals.size() && "Invalid abbrev/record"); 377dcd006bf7be859367f35db2417a42c83451431e8Chris Lattner EmitAbbreviatedField(Op, Vals[RecordIdx]); 378dcd006bf7be859367f35db2417a42c83451431e8Chris Lattner ++RecordIdx; 37940728791f5c8c77d3460a30fcdce6d1fac72aa0dChris Lattner } 380b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 38140728791f5c8c77d3460a30fcdce6d1fac72aa0dChris Lattner assert(RecordIdx == Vals.size() && "Not all record operands emitted!"); 382dce4a407a24b04eebc6a376f8e62b41aaa7b071fStephen Hines assert(BlobData == nullptr && 383298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner "Blob data specified for record that doesn't use it!"); 384298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner } 385170a15e98dc6900df1ae40d03c5f0622d792fb45Joe Abbey 386298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattnerpublic: 387de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar /// Emit a blob, including flushing before and tail-padding. 388de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar template <class UIntTy> 389de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void emitBlob(ArrayRef<UIntTy> Bytes, bool ShouldEmitSize = true) { 390de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // Emit a vbr6 to indicate the number of elements present. 391de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar if (ShouldEmitSize) 392de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar EmitVBR(static_cast<uint32_t>(Bytes.size()), 6); 393de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 394de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // Flush to a 32-bit alignment boundary. 395de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar FlushToWord(); 396de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 397de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // Emit literal bytes. 398de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar for (const auto &B : Bytes) { 399de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar assert(isUInt<8>(B) && "Value too large to emit as byte"); 400de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar WriteByte((unsigned char)B); 401de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 402de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar 403de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar // Align end to 32-bits. 404de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar while (GetBufferOffset() & 3) 405de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar WriteByte(0); 406de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 407de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar void emitBlob(StringRef Bytes, bool ShouldEmitSize = true) { 408de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar emitBlob(makeArrayRef((const uint8_t *)Bytes.data(), Bytes.size()), 409de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar ShouldEmitSize); 410de2d8694e25a814696358e95141f4b1aa4d8847ePirama Arumuga Nainar } 411298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner 412298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// EmitRecord - Emit the specified record to the stream, using an abbrev if 413298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// we have one to compress the output. 414f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar template <typename Container> 415f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void EmitRecord(unsigned Code, const Container &Vals, unsigned Abbrev = 0) { 416298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner if (!Abbrev) { 417298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner // If we don't have an abbrev to use, emit this in its fully unabbreviated 418298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner // form. 419f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar auto Count = static_cast<uint32_t>(makeArrayRef(Vals).size()); 420298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner EmitCode(bitc::UNABBREV_RECORD); 421298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner EmitVBR(Code, 6); 422f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EmitVBR(Count, 6); 423f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar for (unsigned i = 0, e = Count; i != e; ++i) 424298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner EmitVBR64(Vals[i], 6); 425298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner return; 426298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner } 427298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner 428f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EmitRecordWithAbbrevImpl(Abbrev, makeArrayRef(Vals), StringRef(), Code); 429298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner } 430170a15e98dc6900df1ae40d03c5f0622d792fb45Joe Abbey 431298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// EmitRecordWithAbbrev - Emit a record with the specified abbreviation. 432298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// Unlike EmitRecord, the code for the record should be included in Vals as 433298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// the first entry. 434f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar template <typename Container> 435f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void EmitRecordWithAbbrev(unsigned Abbrev, const Container &Vals) { 436f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EmitRecordWithAbbrevImpl(Abbrev, makeArrayRef(Vals), StringRef(), None); 437298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner } 438170a15e98dc6900df1ae40d03c5f0622d792fb45Joe Abbey 439298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// EmitRecordWithBlob - Emit the specified record to the stream, using an 440298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// abbrev that includes a blob at the end. The blob data to emit is 441298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// specified by the pointer and length specified at the end. In contrast to 442298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// EmitRecord, this routine expects that the first entry in Vals is the code 443298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// of the record. 444f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar template <typename Container> 445f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void EmitRecordWithBlob(unsigned Abbrev, const Container &Vals, 4462928c83b010f7cfdb0f819199d806f6942a7d995Daniel Dunbar StringRef Blob) { 447f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EmitRecordWithAbbrevImpl(Abbrev, makeArrayRef(Vals), Blob, None); 4482b1d3d76d78353d3d7c793d437c6ee355dd0f9abDaniel Dunbar } 449f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar template <typename Container> 450f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void EmitRecordWithBlob(unsigned Abbrev, const Container &Vals, 451298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner const char *BlobData, unsigned BlobLen) { 452f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return EmitRecordWithAbbrevImpl(Abbrev, makeArrayRef(Vals), 453f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar StringRef(BlobData, BlobLen), None); 454b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner } 455e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner 456298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// EmitRecordWithArray - Just like EmitRecordWithBlob, works with records 457298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner /// that end with an array. 458f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar template <typename Container> 459f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void EmitRecordWithArray(unsigned Abbrev, const Container &Vals, 460f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar StringRef Array) { 461f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar EmitRecordWithAbbrevImpl(Abbrev, makeArrayRef(Vals), Array, None); 4622b1d3d76d78353d3d7c793d437c6ee355dd0f9abDaniel Dunbar } 463f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar template <typename Container> 464f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar void EmitRecordWithArray(unsigned Abbrev, const Container &Vals, 465f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar const char *ArrayData, unsigned ArrayLen) { 466f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar return EmitRecordWithAbbrevImpl(Abbrev, makeArrayRef(Vals), 467f3ef5332fa3f4d5ec72c178a2b19dac363a19383Pirama Arumuga Nainar StringRef(ArrayData, ArrayLen), None); 468298a82dd0d042479e419c4fa2219c1a08c1becc4Chris Lattner } 469170a15e98dc6900df1ae40d03c5f0622d792fb45Joe Abbey 47036d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner //===--------------------------------------------------------------------===// 47136d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner // Abbrev Emission 47236d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner //===--------------------------------------------------------------------===// 473d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 474e17b658c792abd4a1552144b8a8808e44970da76Chris Lattnerprivate: 475e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner // Emit the abbreviation as a DEFINE_ABBREV record. 476e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner void EncodeAbbrev(BitCodeAbbrev *Abbv) { 47736d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner EmitCode(bitc::DEFINE_ABBREV); 47836d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner EmitVBR(Abbv->getNumOperandInfos(), 5); 47934cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng for (unsigned i = 0, e = static_cast<unsigned>(Abbv->getNumOperandInfos()); 48034cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng i != e; ++i) { 48136d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner const BitCodeAbbrevOp &Op = Abbv->getOperandInfo(i); 48236d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner Emit(Op.isLiteral(), 1); 48336d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner if (Op.isLiteral()) { 48436d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner EmitVBR64(Op.getLiteralValue(), 8); 48536d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner } else { 48636d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner Emit(Op.getEncoding(), 3); 48736d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner if (Op.hasEncodingData()) 48836d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner EmitVBR64(Op.getEncodingData(), 5); 48936d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner } 49036d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner } 491e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner } 492e17b658c792abd4a1552144b8a8808e44970da76Chris Lattnerpublic: 493d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 494e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// EmitAbbrev - This emits an abbreviation to the stream. Note that this 495e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// method takes ownership of the specified abbrev. 496e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner unsigned EmitAbbrev(BitCodeAbbrev *Abbv) { 497e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner // Emit the abbreviation as a record. 498e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner EncodeAbbrev(Abbv); 49936d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner CurAbbrevs.push_back(Abbv); 50034cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng return static_cast<unsigned>(CurAbbrevs.size())-1 + 50134cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng bitc::FIRST_APPLICATION_ABBREV; 50236d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner } 503d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 504e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner //===--------------------------------------------------------------------===// 505e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner // BlockInfo Block Emission 506e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner //===--------------------------------------------------------------------===// 507d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 508e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// EnterBlockInfoBlock - Start emitting the BLOCKINFO_BLOCK. 509e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner void EnterBlockInfoBlock(unsigned CodeWidth) { 510e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner EnterSubblock(bitc::BLOCKINFO_BLOCK_ID, CodeWidth); 5119ca3b8984794cb62d4e3bd0ccc16d2404d85b96bJan Sjödin BlockInfoCurBID = ~0U; 512e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner } 513d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukmanprivate: 514e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// SwitchToBlockID - If we aren't already talking about the specified block 515e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// ID, emit a BLOCKINFO_CODE_SETBID record. 516e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner void SwitchToBlockID(unsigned BlockID) { 517e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner if (BlockInfoCurBID == BlockID) return; 518e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner SmallVector<unsigned, 2> V; 519e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner V.push_back(BlockID); 520e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner EmitRecord(bitc::BLOCKINFO_CODE_SETBID, V); 521e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner BlockInfoCurBID = BlockID; 522e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner } 523e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner 524e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner BlockInfo &getOrCreateBlockInfo(unsigned BlockID) { 525e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner if (BlockInfo *BI = getBlockInfo(BlockID)) 526e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner return *BI; 527d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 528e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner // Otherwise, add a new record. 5296948897e478cbd66626159776a8017b3c18579b9Pirama Arumuga Nainar BlockInfoRecords.emplace_back(); 530e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner BlockInfoRecords.back().BlockID = BlockID; 531e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner return BlockInfoRecords.back(); 532e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner } 533d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 534e17b658c792abd4a1552144b8a8808e44970da76Chris Lattnerpublic: 535d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 536e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// EmitBlockInfoAbbrev - Emit a DEFINE_ABBREV record for the specified 537e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner /// BlockID. 538e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner unsigned EmitBlockInfoAbbrev(unsigned BlockID, BitCodeAbbrev *Abbv) { 539e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner SwitchToBlockID(BlockID); 540e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner EncodeAbbrev(Abbv); 541d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 542e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner // Add the abbrev to the specified block record. 543e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner BlockInfo &Info = getOrCreateBlockInfo(BlockID); 544e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner Info.Abbrevs.push_back(Abbv); 545d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 546e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner return Info.Abbrevs.size()-1+bitc::FIRST_APPLICATION_ABBREV; 547e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner } 548b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner}; 549b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 550b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 551b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner} // End llvm namespace 552b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 553b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner#endif 554