include/llvm/Bitcode/BitCodes.h

   1 //===- BitCodes.h - Enum values for the bitcode format ----------*- 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 Bitcode enum values.
  11 //
  12 // The enum values defined in this file should be considered permanent.  If
  13 // new features are added, they should have values added at the end of the
  14 // respective lists.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_BITCODE_BITCODES_H
  19 #define LLVM_BITCODE_BITCODES_H
  20
  21 #include "llvm/ADT/SmallVector.h"
  22 #include "llvm/Support/DataTypes.h"
  23 #include <cassert>
  24
  25 namespace llvm {
  26 namespace bitc {
  27   enum StandardWidths {
  28     BlockIDWidth = 8,  // We use VBR-8 for block IDs.
  29     CodeLenWidth = 4,  // Codelen are VBR-4.
  30     BlockSizeWidth = 32  // BlockSize up to 2^32 32-bit words = 16GB per block.
  31   };
  32
  33   // The standard abbrev namespace always has a way to exit a block, enter a
  34   // nested block, define abbrevs, and define an unabbreviated record.
  35   enum FixedAbbrevIDs {
  36     END_BLOCK = 0,  // Must be zero to guarantee termination for broken bitcode.
  37     ENTER_SUBBLOCK = 1,
  38
  39     /// DEFINE_ABBREV - Defines an abbrev for the current block.  It consists
  40     /// of a vbr5 for # operand infos.  Each operand info is emitted with a
  41     /// single bit to indicate if it is a literal encoding.  If so, the value is
  42     /// emitted with a vbr8.  If not, the encoding is emitted as 3 bits followed
  43     /// by the info value as a vbr5 if needed.
  44     DEFINE_ABBREV = 2,
  45
  46     // UNABBREV_RECORDs are emitted with a vbr6 for the record code, followed by
  47     // a vbr6 for the # operands, followed by vbr6's for each operand.
  48     UNABBREV_RECORD = 3,
  49
  50     // This is not a code, this is a marker for the first abbrev assignment.
  51     FIRST_APPLICATION_ABBREV = 4
  52   };
  53
  54   /// StandardBlockIDs - All bitcode files can optionally include a BLOCKINFO
  55   /// block, which contains metadata about other blocks in the file.
  56   enum StandardBlockIDs {
  57     /// BLOCKINFO_BLOCK is used to define metadata about blocks, for example,
  58     /// standard abbrevs that should be available to all blocks of a specified
  59     /// ID.
  60     BLOCKINFO_BLOCK_ID = 0,
  61
  62     // Block IDs 1-7 are reserved for future expansion.
  63     FIRST_APPLICATION_BLOCKID = 8
  64   };
  65
  66   /// BlockInfoCodes - The blockinfo block contains metadata about user-defined
  67   /// blocks.
  68   enum BlockInfoCodes {
  69     BLOCKINFO_CODE_SETBID = 1  // SETBID: [blockid#]
  70     // DEFINE_ABBREV has magic semantics here, applying to the current SETBID'd
  71     // block, instead of the BlockInfo block.
  72     // BLOCKNAME: give string name to block, if desired.
  73   };
  74
  75 } // End bitc namespace
  76
  77 /// BitCodeAbbrevOp - This describes one or more operands in an abbreviation.
  78 /// This is actually a union of two different things:
  79 ///   1. It could be a literal integer value ("the operand is always 17").
  80 ///   2. It could be an encoding specification ("this operand encoded like so").
  81 ///
  82 class BitCodeAbbrevOp {
  83   uint64_t Val;           // A literal value or data for an encoding.
  84   bool IsLiteral : 1;     // Indicate whether this is a literal value or not.
  85   unsigned Enc   : 3;     // The encoding to use.
  86 public:
  87   enum Encoding {
  88     Fixed = 1,  // A fixed width field, Val specifies number of bits.
  89     VBR   = 2,  // A VBR field where Val specifies the width of each chunk.
  90     Array = 3,  // A sequence of fields, next field species elt encoding.
  91     Char6 = 4,  // A 6-bit fixed field which maps to [a-zA-Z0-9._].
  92     Blob  = 5   // 32-bit aligned array of 8-bit characters.
  93   };
  94
  95   explicit BitCodeAbbrevOp(uint64_t V) :  Val(V), IsLiteral(true) {}
  96   explicit BitCodeAbbrevOp(Encoding E, uint64_t Data = 0)
  97     : Val(Data), IsLiteral(false), Enc(E) {}
  98
  99   bool isLiteral() const { return IsLiteral; }
 100   bool isEncoding() const { return !IsLiteral; }
 101
 102   // Accessors for literals.
 103   uint64_t getLiteralValue() const { assert(isLiteral()); return Val; }
 104
 105   // Accessors for encoding info.
 106   Encoding getEncoding() const { assert(isEncoding()); return (Encoding)Enc; }
 107   uint64_t getEncodingData() const {
 108     assert(isEncoding() && hasEncodingData());
 109     return Val;
 110   }
 111
 112   bool hasEncodingData() const { return hasEncodingData(getEncoding()); }
 113   static bool hasEncodingData(Encoding E) {
 114     switch (E) {
 115     default: assert(0 && "Unknown encoding");
 116     case Fixed:
 117     case VBR:
 118       return true;
 119     case Array:
 120     case Char6:
 121     case Blob:
 122       return false;
 123     }
 124   }
 125
 126   /// isChar6 - Return true if this character is legal in the Char6 encoding.
 127   static bool isChar6(char C) {
 128     if (C >= 'a' && C <= 'z') return true;
 129     if (C >= 'A' && C <= 'Z') return true;
 130     if (C >= '0' && C <= '9') return true;
 131     if (C == '.' || C == '_') return true;
 132     return false;
 133   }
 134   static unsigned EncodeChar6(char C) {
 135     if (C >= 'a' && C <= 'z') return C-'a';
 136     if (C >= 'A' && C <= 'Z') return C-'A'+26;
 137     if (C >= '0' && C <= '9') return C-'0'+26+26;
 138     if (C == '.') return 62;
 139     if (C == '_') return 63;
 140     assert(0 && "Not a value Char6 character!");
 141     return 0;
 142   }
 143
 144   static char DecodeChar6(unsigned V) {
 145     assert((V & ~63) == 0 && "Not a Char6 encoded character!");
 146     if (V < 26) return V+'a';
 147     if (V < 26+26) return V-26+'A';
 148     if (V < 26+26+10) return V-26-26+'0';
 149     if (V == 62) return '.';
 150     if (V == 63) return '_';
 151     assert(0 && "Not a value Char6 character!");
 152     return ' ';
 153   }
 154
 155 };
 156
 157 /// BitCodeAbbrev - This class represents an abbreviation record.  An
 158 /// abbreviation allows a complex record that has redundancy to be stored in a
 159 /// specialized format instead of the fully-general, fully-vbr, format.
 160 class BitCodeAbbrev {
 161   SmallVector<BitCodeAbbrevOp, 8> OperandList;
 162   unsigned char RefCount; // Number of things using this.
 163   ~BitCodeAbbrev() {}
 164 public:
 165   BitCodeAbbrev() : RefCount(1) {}
 166
 167   void addRef() { ++RefCount; }
 168   void dropRef() { if (--RefCount == 0) delete this; }
 169
 170   unsigned getNumOperandInfos() const {
 171     return static_cast<unsigned>(OperandList.size());
 172   }
 173   const BitCodeAbbrevOp &getOperandInfo(unsigned N) const {
 174     return OperandList[N];
 175   }
 176
 177   void Add(const BitCodeAbbrevOp &OpInfo) {
 178     OperandList.push_back(OpInfo);
 179   }
 180 };
 181 } // End llvm namespace
 182
 183 #endif