BitCodes.h revision 1f6efa3996dd1929fbc129203ce5009b620e6969
1b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner//===- BitCodes.h - Enum values for the bitcode format ----------*- 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 Bitcode enum values. 11b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// 12b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// The enum values defined in this file should be considered permanent. If 13b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// new features are added, they should have values added at the end of the 14b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// respective lists. 15b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner// 16b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner//===----------------------------------------------------------------------===// 17b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 18b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner#ifndef LLVM_BITCODE_BITCODES_H 19b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner#define LLVM_BITCODE_BITCODES_H 20b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 2136d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner#include "llvm/ADT/SmallVector.h" 221f6efa3996dd1929fbc129203ce5009b620e6969Michael J. Spencer#include "llvm/Support/DataTypes.h" 2336d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner#include <cassert> 2436d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner 25b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattnernamespace llvm { 26b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattnernamespace bitc { 27b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner enum StandardWidths { 28b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner BlockIDWidth = 8, // We use VBR-8 for block IDs. 29b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner CodeLenWidth = 4, // Codelen are VBR-4. 301a26daa9c336abd7790d5e3366ed46288248aca0Zhongxing Xu BlockSizeWidth = 32 // BlockSize up to 2^32 32-bit words = 16GB per block. 31b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner }; 32d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 33a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner // The standard abbrev namespace always has a way to exit a block, enter a 34b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // nested block, define abbrevs, and define an unabbreviated record. 35a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner enum FixedAbbrevIDs { 36b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner END_BLOCK = 0, // Must be zero to guarantee termination for broken bitcode. 37b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner ENTER_SUBBLOCK = 1, 3836d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner 3936d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner /// DEFINE_ABBREV - Defines an abbrev for the current block. It consists 4036d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner /// of a vbr5 for # operand infos. Each operand info is emitted with a 4136d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner /// single bit to indicate if it is a literal encoding. If so, the value is 4236d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner /// emitted with a vbr8. If not, the encoding is emitted as 3 bits followed 4336d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner /// by the info value as a vbr5 if needed. 44d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman DEFINE_ABBREV = 2, 45d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 4636d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner // UNABBREV_RECORDs are emitted with a vbr6 for the record code, followed by 4736d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner // a vbr6 for the # operands, followed by vbr6's for each operand. 48b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner UNABBREV_RECORD = 3, 49d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 50b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner // This is not a code, this is a marker for the first abbrev assignment. 51a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner FIRST_APPLICATION_ABBREV = 4 52b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner }; 53d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 54a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner /// StandardBlockIDs - All bitcode files can optionally include a BLOCKINFO 55a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner /// block, which contains metadata about other blocks in the file. 56a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner enum StandardBlockIDs { 57a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner /// BLOCKINFO_BLOCK is used to define metadata about blocks, for example, 58a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner /// standard abbrevs that should be available to all blocks of a specified 59a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner /// ID. 60a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner BLOCKINFO_BLOCK_ID = 0, 61d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 62a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner // Block IDs 1-7 are reserved for future expansion. 63a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner FIRST_APPLICATION_BLOCKID = 8 64a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner }; 65d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 66a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner /// BlockInfoCodes - The blockinfo block contains metadata about user-defined 67a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner /// blocks. 68a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner enum BlockInfoCodes { 69e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner // DEFINE_ABBREV has magic semantics here, applying to the current SETBID'd 70e17b658c792abd4a1552144b8a8808e44970da76Chris Lattner // block, instead of the BlockInfo block. 71f9a3ec86c138177c7d9b3a9d119e6d2247d14bd8Chris Lattner 72f9a3ec86c138177c7d9b3a9d119e6d2247d14bd8Chris Lattner BLOCKINFO_CODE_SETBID = 1, // SETBID: [blockid#] 73f9a3ec86c138177c7d9b3a9d119e6d2247d14bd8Chris Lattner BLOCKINFO_CODE_BLOCKNAME = 2, // BLOCKNAME: [name] 74f9a3ec86c138177c7d9b3a9d119e6d2247d14bd8Chris Lattner BLOCKINFO_CODE_SETRECORDNAME = 3 // BLOCKINFO_CODE_SETRECORDNAME: [id, name] 75a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner }; 76d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 77b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner} // End bitc namespace 7836d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner 7936d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner/// BitCodeAbbrevOp - This describes one or more operands in an abbreviation. 8036d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner/// This is actually a union of two different things: 8136d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner/// 1. It could be a literal integer value ("the operand is always 17"). 8236d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner/// 2. It could be an encoding specification ("this operand encoded like so"). 8336d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner/// 8436d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattnerclass BitCodeAbbrevOp { 85299b2d2070165eccea3fb61f7387fa016b847338Chris Lattner uint64_t Val; // A literal value or data for an encoding. 86299b2d2070165eccea3fb61f7387fa016b847338Chris Lattner bool IsLiteral : 1; // Indicate whether this is a literal value or not. 87299b2d2070165eccea3fb61f7387fa016b847338Chris Lattner unsigned Enc : 3; // The encoding to use. 8836d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattnerpublic: 8936d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner enum Encoding { 9028e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner Fixed = 1, // A fixed width field, Val specifies number of bits. 913c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner VBR = 2, // A VBR field where Val specifies the width of each chunk. 9228e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner Array = 3, // A sequence of fields, next field species elt encoding. 93dcd006bf7be859367f35db2417a42c83451431e8Chris Lattner Char6 = 4, // A 6-bit fixed field which maps to [a-zA-Z0-9._]. 94ce8f9fe3c9ea50127eab28930506fc3b93390553Chris Lattner Blob = 5 // 32-bit aligned array of 8-bit characters. 9536d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner }; 96d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 97cdf2b3b2f88d6f961b664e3f67a8ee37b46b0d27Dan Gohman explicit BitCodeAbbrevOp(uint64_t V) : Val(V), IsLiteral(true) {} 98cdf2b3b2f88d6f961b664e3f67a8ee37b46b0d27Dan Gohman explicit BitCodeAbbrevOp(Encoding E, uint64_t Data = 0) 9936d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner : Val(Data), IsLiteral(false), Enc(E) {} 100d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 10136d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner bool isLiteral() const { return IsLiteral; } 10236d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner bool isEncoding() const { return !IsLiteral; } 10336d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner 10436d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner // Accessors for literals. 10536d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner uint64_t getLiteralValue() const { assert(isLiteral()); return Val; } 106d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 10736d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner // Accessors for encoding info. 10836d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner Encoding getEncoding() const { assert(isEncoding()); return (Encoding)Enc; } 1093c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner uint64_t getEncodingData() const { 1103c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner assert(isEncoding() && hasEncodingData()); 1113c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner return Val; 1123c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner } 113d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 11436d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner bool hasEncodingData() const { return hasEncodingData(getEncoding()); } 11536d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner static bool hasEncodingData(Encoding E) { 1163c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner switch (E) { 1173c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner default: assert(0 && "Unknown encoding"); 1183c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner case Fixed: 1193c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner case VBR: 1203c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner return true; 1213c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner case Array: 12228e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner case Char6: 123dcd006bf7be859367f35db2417a42c83451431e8Chris Lattner case Blob: 1243c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner return false; 1253c074f61ed2bd1d8d48c3851d827a06b80d2608bChris Lattner } 12636d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner } 127d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 12828e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner /// isChar6 - Return true if this character is legal in the Char6 encoding. 12928e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner static bool isChar6(char C) { 13028e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (C >= 'a' && C <= 'z') return true; 13128e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (C >= 'A' && C <= 'Z') return true; 13228e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (C >= '0' && C <= '9') return true; 13328e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (C == '.' || C == '_') return true; 13428e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner return false; 13528e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner } 13628e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner static unsigned EncodeChar6(char C) { 13728e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (C >= 'a' && C <= 'z') return C-'a'; 13828e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (C >= 'A' && C <= 'Z') return C-'A'+26; 13928e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (C >= '0' && C <= '9') return C-'0'+26+26; 14028e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (C == '.') return 62; 14128e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (C == '_') return 63; 14228e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner assert(0 && "Not a value Char6 character!"); 143332376bc601fcff8d8a4558c2834ddd0189c12d1Jeff Cohen return 0; 14428e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner } 145d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 14628e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner static char DecodeChar6(unsigned V) { 14728e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner assert((V & ~63) == 0 && "Not a Char6 encoded character!"); 14828e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (V < 26) return V+'a'; 14928e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (V < 26+26) return V-26+'A'; 15028e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (V < 26+26+10) return V-26-26+'0'; 15128e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (V == 62) return '.'; 15228e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner if (V == 63) return '_'; 15328e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner assert(0 && "Not a value Char6 character!"); 154332376bc601fcff8d8a4558c2834ddd0189c12d1Jeff Cohen return ' '; 15528e4c4c9b3b9bf8939405df24b87062c1f10a9a3Chris Lattner } 156d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 15736d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner}; 15836d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner 159a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner/// BitCodeAbbrev - This class represents an abbreviation record. An 160a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner/// abbreviation allows a complex record that has redundancy to be stored in a 161a727d5502c8e23c090da658bf14c5ebc1169a070Chris Lattner/// specialized format instead of the fully-general, fully-vbr, format. 16236d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattnerclass BitCodeAbbrev { 16336d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner SmallVector<BitCodeAbbrevOp, 8> OperandList; 164299b2d2070165eccea3fb61f7387fa016b847338Chris Lattner unsigned char RefCount; // Number of things using this. 165299b2d2070165eccea3fb61f7387fa016b847338Chris Lattner ~BitCodeAbbrev() {} 16636d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattnerpublic: 167299b2d2070165eccea3fb61f7387fa016b847338Chris Lattner BitCodeAbbrev() : RefCount(1) {} 168d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 169299b2d2070165eccea3fb61f7387fa016b847338Chris Lattner void addRef() { ++RefCount; } 170299b2d2070165eccea3fb61f7387fa016b847338Chris Lattner void dropRef() { if (--RefCount == 0) delete this; } 171299b2d2070165eccea3fb61f7387fa016b847338Chris Lattner 17234cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng unsigned getNumOperandInfos() const { 17334cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng return static_cast<unsigned>(OperandList.size()); 17434cd4a484e532cc463fd5a4bf59b88d13c5467c1Evan Cheng } 17536d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner const BitCodeAbbrevOp &getOperandInfo(unsigned N) const { 17636d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner return OperandList[N]; 17736d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner } 178d3ff4a188e823baa141c288d31eb532ddf632b6eMisha Brukman 17936d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner void Add(const BitCodeAbbrevOp &OpInfo) { 18036d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner OperandList.push_back(OpInfo); 18136d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner } 18236d5e7d31be61f631ace0488f0d6cd71b8f31a16Chris Lattner}; 183b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner} // End llvm namespace 184b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner 185b35ca9db9ce25e6b61aa3eaee41464f647d34899Chris Lattner#endif 186