include/llvm/Bytecode/BytecodeHandler.h

   1 //===-- BytecodeHandler.h - Handle Bytecode Parsing Events ------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Reid Spencer and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  This header file defines the interface to the Bytecode Handler. The handler
  11 //  is called by the Bytecode Reader to obtain out-of-band parsing events for
  12 //  tasks other then LLVM IR construction.
  13 //
  14 //===----------------------------------------------------------------------===//
  15
  16 #ifndef LLVM_BYTECODE_BYTECODEHANDLER_H
  17 #define LLVM_BYTECODE_BYTECODEHANDLER_H
  18
  19 #include "llvm/Module.h"
  20
  21 namespace llvm {
  22
  23 class ArrayType;
  24 class StructType;
  25 class PointerType;
  26 class PackedType;
  27 class ConstantArray;
  28 class Module;
  29
  30 /// This class provides the interface for handling bytecode events during
  31 /// reading of bytecode. The methods on this interface are invoked by the
  32 /// BytecodeReader as it discovers the content of a bytecode stream.
  33 /// This class provides a a clear separation of concerns between recognizing
  34 /// the semantic units of a bytecode file (the Reader) and deciding what to do
  35 /// with them (the Handler).
  36 ///
  37 /// The BytecodeReader recognizes the content of the bytecode file and
  38 /// calls the BytecodeHandler methods to let it perform additional tasks. This
  39 /// arrangement allows Bytecode files to be read and handled for a number of
  40 /// purposes simply by creating a subclass of BytecodeHandler. None of the
  41 /// parsing details need to be understood, only the meaning of the calls
  42 /// made on this interface.
  43 ///
  44 /// @see BytecodeHandler
  45 /// @brief Handle Bytecode Parsing Events
  46 class BytecodeHandler {
  47
  48 /// @name Constructors And Operators
  49 /// @{
  50 public:
  51   /// @brief Default constructor (empty)
  52   BytecodeHandler() {}
  53   /// @brief Virtual destructor (empty)
  54   virtual ~BytecodeHandler();
  55
  56 private:
  57   BytecodeHandler(const BytecodeHandler &);  // DO NOT IMPLEMENT
  58   void operator=(const BytecodeHandler &);  // DO NOT IMPLEMENT
  59
  60 /// @}
  61 /// @name Handler Methods
  62 /// @{
  63 public:
  64
  65   /// This method is called whenever the parser detects an error in the
  66   /// bytecode formatting. It gives the handler a chance to do something
  67   /// with the error message before the parser throws an exception to
  68   /// terminate the parsing.
  69   /// @brief Handle parsing errors.
  70   virtual void handleError(const std::string& str ) {}
  71
  72   /// This method is called at the beginning of a parse before anything is
  73   /// read in order to give the handler a chance to initialize.
  74   /// @brief Handle the start of a bytecode parse
  75   virtual void handleStart( Module* Mod, unsigned byteSize ) {}
  76
  77   /// This method is called at the end of a parse after everything has been
  78   /// read in order to give the handler a chance to terminate.
  79   /// @brief Handle the end of a bytecode parse
  80   virtual void handleFinish() {}
  81
  82   /// This method is called at the start of a module to indicate that a
  83   /// module is being parsed.
  84   /// @brief Handle the start of a module.
  85   virtual void handleModuleBegin(const std::string& moduleId) {}
  86
  87   /// This method is called at the end of a module to indicate that the module
  88   /// previously being parsed has concluded.
  89   /// @brief Handle the end of a module.
  90   virtual void handleModuleEnd(
  91     const std::string& moduleId ///< An identifier for the module
  92   ) {}
  93
  94   /// This method is called once the version information has been parsed. It
  95   /// provides the information about the version of the bytecode file being
  96   /// read.
  97   /// @brief Handle the bytecode prolog
  98   virtual void handleVersionInfo(
  99     unsigned char RevisionNum        ///< Byte code revision number
 100   ) {}
 101
 102   /// This method is called at the start of a module globals block which
 103   /// contains the global variables and the function placeholders
 104   virtual void handleModuleGlobalsBegin() {}
 105
 106   /// This method is called when a non-initialized global variable is
 107   /// recognized. Its type, constness, and linkage type are provided.
 108   /// @brief Handle a non-initialized global variable
 109   virtual void handleGlobalVariable(
 110     const Type* ElemType,     ///< The type of the global variable
 111     bool isConstant,          ///< Whether the GV is constant or not
 112     GlobalValue::LinkageTypes,///< The linkage type of the GV
 113     GlobalValue::VisibilityTypes,///< The visibility style of the GV
 114     unsigned SlotNum,         ///< Slot number of GV
 115     unsigned initSlot         ///< Slot number of GV's initializer (0 if none)
 116   ) {}
 117
 118   /// This method is called when a type list is recognized. It simply
 119   /// provides the number of types that the list contains. The handler
 120   /// should expect that number of calls to handleType.
 121   /// @brief Handle a type
 122   virtual void handleTypeList(
 123     unsigned numEntries ///< The number of entries in the type list
 124   ) {}
 125
 126   /// This method is called when a new type is recognized. The type is
 127   /// converted from the bytecode and passed to this method.
 128   /// @brief Handle a type
 129   virtual void handleType(
 130     const Type* Ty ///< The type that was just recognized
 131   ) {}
 132
 133   /// This method is called when the function prototype for a function is
 134   /// encountered in the module globals block.
 135   virtual void handleFunctionDeclaration(
 136     Function* Func ///< The function being declared
 137   ) {}
 138
 139   /// This method is called when a global variable is initialized with
 140   /// its constant value. Because of forward referencing, etc. this is
 141   /// done towards the end of the module globals block
 142   virtual void handleGlobalInitializer(GlobalVariable*, Constant* ) {}
 143
 144   /// This method is called for each dependent library name found
 145   /// in the module globals block.
 146   virtual void handleDependentLibrary(const std::string& libName) {}
 147
 148   /// This method is called if the module globals has a non-empty target
 149   /// triple
 150   virtual void handleTargetTriple(const std::string& triple) {}
 151
 152   /// This method is called at the end of the module globals block.
 153   /// @brief Handle end of module globals block.
 154   virtual void handleModuleGlobalsEnd() {}
 155
 156   /// @brief Handle start of a symbol table
 157   virtual void handleTypeSymbolTableBegin(
 158     TypeSymbolTable* ST  ///< The symbol table being filled
 159   ) {}
 160
 161   /// @brief Handle start of a symbol table
 162   virtual void handleValueSymbolTableBegin(
 163     Function* Func,       ///< The function to which the ST belongs or 0 for Mod
 164     ValueSymbolTable* ST  ///< The symbol table being filled
 165   ) {}
 166
 167   /// @brief Handle a named type in the symbol table
 168   virtual void handleSymbolTableType(
 169     unsigned i,              ///< The index of the type in this plane
 170     unsigned slot,           ///< Slot number of the named type
 171     const std::string& name  ///< Name of the type
 172   ) {}
 173
 174   /// @brief Handle a named value in the symbol table
 175   virtual void handleSymbolTableValue(
 176     unsigned i,              ///< The index of the value in this plane
 177     unsigned slot,           ///< Slot number of the named value
 178     const char *name, unsigned NameLen  ///< Name of the value.
 179   ) {}
 180
 181   /// @brief Handle the end of a value symbol table
 182   virtual void handleTypeSymbolTableEnd() {}
 183
 184   /// @brief Handle the end of a type symbol table
 185   virtual void handleValueSymbolTableEnd() {}
 186
 187   /// @brief Handle the beginning of a function body
 188   virtual void handleFunctionBegin(
 189     Function* Func, ///< The function being defined
 190     unsigned Size   ///< The size (in bytes) of the function's bytecode
 191   ) {}
 192
 193   /// @brief Handle the end of a function body
 194   virtual void handleFunctionEnd(
 195     Function* Func  ///< The function whose definition has just finished.
 196   ) {}
 197
 198   /// @brief Handle the beginning of a basic block
 199   virtual void handleBasicBlockBegin(
 200     unsigned blocknum ///< The block number of the block
 201   ) {}
 202
 203   /// This method is called for each instruction that is parsed.
 204   /// @returns true if the instruction is a block terminating instruction
 205   /// @brief Handle an instruction
 206   virtual bool handleInstruction(
 207     unsigned Opcode,                 ///< Opcode of the instruction
 208     const Type* iType,               ///< Instruction type
 209     unsigned *Operands, unsigned NumOps, ///< Vector of slot # operands
 210     Instruction *Inst,               ///< The resulting instruction
 211     unsigned Length                  ///< Length of instruction in bc bytes
 212   ) { return false; }
 213
 214   /// @brief Handle the end of a basic block
 215   virtual void handleBasicBlockEnd(
 216     unsigned blocknum  ///< The block number of the block just finished
 217   ) {}
 218
 219   /// @brief Handle start of global constants block.
 220   virtual void handleGlobalConstantsBegin() {}
 221
 222   /// @brief Handle a constant expression
 223   virtual void handleConstantExpression(
 224     unsigned Opcode,  ///< Opcode of primary expression operator
 225     Constant**Args, unsigned NumArgs, ///< expression args
 226     Constant* C ///< The constant value
 227   ) {}
 228
 229   /// @brief Handle a constant array
 230   virtual void handleConstantArray(
 231     const ArrayType* AT,                ///< Type of the array
 232     Constant**ElementSlots, unsigned NumElts,///< Slot nums for array values
 233     unsigned TypeSlot,                  ///< Slot # of type
 234     Constant* Val                       ///< The constant value
 235   ) {}
 236
 237   /// @brief Handle a constant structure
 238   virtual void handleConstantStruct(
 239     const StructType* ST,               ///< Type of the struct
 240     Constant**ElementSlots, unsigned NumElts,///< Slot nums for struct values
 241     Constant* Val                       ///< The constant value
 242   ) {}
 243
 244   /// @brief Handle a constant packed
 245   virtual void handleConstantPacked(
 246     const PackedType* PT,                ///< Type of the array
 247     Constant**ElementSlots, unsigned NumElts,///< Slot nums for packed values
 248     unsigned TypeSlot,                  ///< Slot # of type
 249     Constant* Val                       ///< The constant value
 250   ) {}
 251
 252   /// @brief Handle a constant pointer
 253   virtual void handleConstantPointer(
 254     const PointerType* PT, ///< Type of the pointer
 255     unsigned Slot,         ///< Slot num of initializer value
 256     GlobalValue* GV        ///< Referenced global value
 257   ) {}
 258
 259   /// @brief Handle a constant strings (array special case)
 260   virtual void handleConstantString(
 261     const ConstantArray* CA ///< Type of the string array
 262   ) {}
 263
 264   /// @brief Handle a primitive constant value
 265   virtual void handleConstantValue(
 266     Constant * c ///< The constant just defined
 267   ) {}
 268
 269   /// @brief Handle the end of the global constants
 270   virtual void handleGlobalConstantsEnd() {}
 271
 272   /// @brief Handle an alignment event
 273   virtual void handleAlignment(
 274     unsigned numBytes ///< The number of bytes added for alignment
 275   ) {}
 276
 277   /// @brief Handle a bytecode block
 278   virtual void handleBlock(
 279     unsigned BType,                ///< The type of block
 280     const unsigned char* StartPtr, ///< The start of the block
 281     unsigned Size                  ///< The size of the block
 282   ) {}
 283
 284 /// @}
 285
 286 };
 287
 288 }
 289 #endif