1 //===-- BytecodeHandler.h - Handle Bytecode Parsing Events ------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
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.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_BYTECODE_BYTECODEHANDLER_H
17 #define LLVM_BYTECODE_BYTECODEHANDLER_H
19 #include "llvm/Module.h"
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).
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.
44 /// @see BytecodeHandler
45 /// @brief Handle Bytecode Parsing Events
46 class BytecodeHandler {
48 /// @name Constructors And Operators
51 /// @brief Default constructor (empty)
53 /// @brief Virtual destructor (empty)
54 virtual ~BytecodeHandler();
57 BytecodeHandler(const BytecodeHandler &); // DO NOT IMPLEMENT
58 void operator=(const BytecodeHandler &); // DO NOT IMPLEMENT
61 /// @name Handler Methods
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 ) {}
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 ) {}
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() {}
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) {}
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
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
97 /// @brief Handle the bytecode prolog
98 virtual void handleVersionInfo(
99 unsigned char RevisionNum ///< Byte code revision number
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() {}
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)
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
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
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
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* ) {}
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) {}
148 /// This method is called if the module globals has a non-empty target
150 virtual void handleTargetTriple(const std::string& triple) {}
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() {}
156 /// This method is called at the beginning of a compaction table.
157 /// @brief Handle start of compaction table.
158 virtual void handleCompactionTableBegin() {}
160 /// @brief Handle start of a compaction table plane
161 virtual void handleCompactionTablePlane(
162 unsigned Ty, ///< The type of the plane (slot number)
163 unsigned NumEntries ///< The number of entries in the plane
166 /// @brief Handle a type entry in the compaction table
167 virtual void handleCompactionTableType(
168 unsigned i, ///< Index in the plane of this type
169 unsigned TypSlot, ///< Slot number for this type
170 const Type* ///< The type referenced by this slot
173 /// @brief Handle a value entry in the compaction table
174 virtual void handleCompactionTableValue(
175 unsigned i, ///< Index in the compaction table's type plane
176 unsigned TypSlot, ///< The slot (plane) of the type of this value
177 unsigned ValSlot ///< The global value slot of the value
180 /// @brief Handle end of a compaction table
181 virtual void handleCompactionTableEnd() {}
183 /// @brief Handle start of a symbol table
184 virtual void handleTypeSymbolTableBegin(
185 TypeSymbolTable* ST ///< The symbol table being filled
188 /// @brief Handle start of a symbol table
189 virtual void handleValueSymbolTableBegin(
190 Function* Func, ///< The function to which the ST belongs or 0 for Mod
191 ValueSymbolTable* ST ///< The symbol table being filled
194 /// @brief Handle a named type in the symbol table
195 virtual void handleSymbolTableType(
196 unsigned i, ///< The index of the type in this plane
197 unsigned slot, ///< Slot number of the named type
198 const std::string& name ///< Name of the type
201 /// @brief Handle a named value in the symbol table
202 virtual void handleSymbolTableValue(
203 unsigned i, ///< The index of the value in this plane
204 unsigned slot, ///< Slot number of the named value
205 const std::string& name ///< Name of the value.
208 /// @brief Handle the end of a value symbol table
209 virtual void handleTypeSymbolTableEnd() {}
211 /// @brief Handle the end of a type symbol table
212 virtual void handleValueSymbolTableEnd() {}
214 /// @brief Handle the beginning of a function body
215 virtual void handleFunctionBegin(
216 Function* Func, ///< The function being defined
217 unsigned Size ///< The size (in bytes) of the function's bytecode
220 /// @brief Handle the end of a function body
221 virtual void handleFunctionEnd(
222 Function* Func ///< The function whose definition has just finished.
225 /// @brief Handle the beginning of a basic block
226 virtual void handleBasicBlockBegin(
227 unsigned blocknum ///< The block number of the block
230 /// This method is called for each instruction that is parsed.
231 /// @returns true if the instruction is a block terminating instruction
232 /// @brief Handle an instruction
233 virtual bool handleInstruction(
234 unsigned Opcode, ///< Opcode of the instruction
235 const Type* iType, ///< Instruction type
236 unsigned *Operands, unsigned NumOps, ///< Vector of slot # operands
237 Instruction *Inst, ///< The resulting instruction
238 unsigned Length ///< Length of instruction in bc bytes
241 /// @brief Handle the end of a basic block
242 virtual void handleBasicBlockEnd(
243 unsigned blocknum ///< The block number of the block just finished
246 /// @brief Handle start of global constants block.
247 virtual void handleGlobalConstantsBegin() {}
249 /// @brief Handle a constant expression
250 virtual void handleConstantExpression(
251 unsigned Opcode, ///< Opcode of primary expression operator
252 Constant**Args, unsigned NumArgs, ///< expression args
253 Constant* C ///< The constant value
256 /// @brief Handle a constant array
257 virtual void handleConstantArray(
258 const ArrayType* AT, ///< Type of the array
259 Constant**ElementSlots, unsigned NumElts,///< Slot nums for array values
260 unsigned TypeSlot, ///< Slot # of type
261 Constant* Val ///< The constant value
264 /// @brief Handle a constant structure
265 virtual void handleConstantStruct(
266 const StructType* ST, ///< Type of the struct
267 Constant**ElementSlots, unsigned NumElts,///< Slot nums for struct values
268 Constant* Val ///< The constant value
271 /// @brief Handle a constant packed
272 virtual void handleConstantPacked(
273 const PackedType* PT, ///< Type of the array
274 Constant**ElementSlots, unsigned NumElts,///< Slot nums for packed values
275 unsigned TypeSlot, ///< Slot # of type
276 Constant* Val ///< The constant value
279 /// @brief Handle a constant pointer
280 virtual void handleConstantPointer(
281 const PointerType* PT, ///< Type of the pointer
282 unsigned Slot, ///< Slot num of initializer value
283 GlobalValue* GV ///< Referenced global value
286 /// @brief Handle a constant strings (array special case)
287 virtual void handleConstantString(
288 const ConstantArray* CA ///< Type of the string array
291 /// @brief Handle a primitive constant value
292 virtual void handleConstantValue(
293 Constant * c ///< The constant just defined
296 /// @brief Handle the end of the global constants
297 virtual void handleGlobalConstantsEnd() {}
299 /// @brief Handle an alignment event
300 virtual void handleAlignment(
301 unsigned numBytes ///< The number of bytes added for alignment
304 /// @brief Handle a bytecode block
305 virtual void handleBlock(
306 unsigned BType, ///< The type of block
307 const unsigned char* StartPtr, ///< The start of the block
308 unsigned Size ///< The size of the block
311 /// @brief Handle a variable bit rate 32 bit unsigned
312 virtual void handleVBR32(
313 unsigned Size ///< Number of bytes the vbr_uint took up
316 /// @brief Handle a variable bit rate 64 bit unsigned
317 virtual void handleVBR64(
318 unsigned Size ///< Number of byte sthe vbr_uint64 took up