1 /*===-- llvm-c/Disassembler.h - Disassembler Public C Interface ---*- 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 provides a public interface to a disassembler library. *| 11 |* LLVM provides an implementation of this interface. *| 12 |* *| 13 \*===----------------------------------------------------------------------===*/ 14 15 #ifndef LLVM_C_DISASSEMBLER_H 16 #define LLVM_C_DISASSEMBLER_H 17 18 #include "llvm-c/DisassemblerTypes.h" 19 20 /** 21 * @defgroup LLVMCDisassembler Disassembler 22 * @ingroup LLVMC 23 * 24 * @{ 25 */ 26 27 #ifdef __cplusplus 28 extern "C" { 29 #endif /* !defined(__cplusplus) */ 30 31 /** 32 * Create a disassembler for the TripleName. Symbolic disassembly is supported 33 * by passing a block of information in the DisInfo parameter and specifying the 34 * TagType and callback functions as described above. These can all be passed 35 * as NULL. If successful, this returns a disassembler context. If not, it 36 * returns NULL. This function is equivalent to calling 37 * LLVMCreateDisasmCPUFeatures() with an empty CPU name and feature set. 38 */ 39 LLVMDisasmContextRef LLVMCreateDisasm(const char *TripleName, void *DisInfo, 40 int TagType, LLVMOpInfoCallback GetOpInfo, 41 LLVMSymbolLookupCallback SymbolLookUp); 42 43 /** 44 * Create a disassembler for the TripleName and a specific CPU. Symbolic 45 * disassembly is supported by passing a block of information in the DisInfo 46 * parameter and specifying the TagType and callback functions as described 47 * above. These can all be passed * as NULL. If successful, this returns a 48 * disassembler context. If not, it returns NULL. This function is equivalent 49 * to calling LLVMCreateDisasmCPUFeatures() with an empty feature set. 50 */ 51 LLVMDisasmContextRef LLVMCreateDisasmCPU(const char *Triple, const char *CPU, 52 void *DisInfo, int TagType, 53 LLVMOpInfoCallback GetOpInfo, 54 LLVMSymbolLookupCallback SymbolLookUp); 55 56 /** 57 * Create a disassembler for the TripleName, a specific CPU and specific feature 58 * string. Symbolic disassembly is supported by passing a block of information 59 * in the DisInfo parameter and specifying the TagType and callback functions as 60 * described above. These can all be passed * as NULL. If successful, this 61 * returns a disassembler context. If not, it returns NULL. 62 */ 63 LLVMDisasmContextRef 64 LLVMCreateDisasmCPUFeatures(const char *Triple, const char *CPU, 65 const char *Features, void *DisInfo, int TagType, 66 LLVMOpInfoCallback GetOpInfo, 67 LLVMSymbolLookupCallback SymbolLookUp); 68 69 /** 70 * Set the disassembler's options. Returns 1 if it can set the Options and 0 71 * otherwise. 72 */ 73 int LLVMSetDisasmOptions(LLVMDisasmContextRef DC, uint64_t Options); 74 75 /* The option to produce marked up assembly. */ 76 #define LLVMDisassembler_Option_UseMarkup 1 77 /* The option to print immediates as hex. */ 78 #define LLVMDisassembler_Option_PrintImmHex 2 79 /* The option use the other assembler printer variant */ 80 #define LLVMDisassembler_Option_AsmPrinterVariant 4 81 /* The option to set comment on instructions */ 82 #define LLVMDisassembler_Option_SetInstrComments 8 83 /* The option to print latency information alongside instructions */ 84 #define LLVMDisassembler_Option_PrintLatency 16 85 86 /** 87 * Dispose of a disassembler context. 88 */ 89 void LLVMDisasmDispose(LLVMDisasmContextRef DC); 90 91 /** 92 * Disassemble a single instruction using the disassembler context specified in 93 * the parameter DC. The bytes of the instruction are specified in the 94 * parameter Bytes, and contains at least BytesSize number of bytes. The 95 * instruction is at the address specified by the PC parameter. If a valid 96 * instruction can be disassembled, its string is returned indirectly in 97 * OutString whose size is specified in the parameter OutStringSize. This 98 * function returns the number of bytes in the instruction or zero if there was 99 * no valid instruction. 100 */ 101 size_t LLVMDisasmInstruction(LLVMDisasmContextRef DC, uint8_t *Bytes, 102 uint64_t BytesSize, uint64_t PC, 103 char *OutString, size_t OutStringSize); 104 105 /** 106 * @} 107 */ 108 109 #ifdef __cplusplus 110 } 111 #endif /* !defined(__cplusplus) */ 112 113 #endif /* LLVM_C_DISASSEMBLER_H */ 114