1 /*===-- llvm-c/Disassembler.h - Disassembler Public C Interface ---*- C -*-===*\ 2 |* *| 3 |* Part of the LLVM Project, under the Apache License v2.0 with LLVM *| 4 |* Exceptions. *| 5 |* See https://llvm.org/LICENSE.txt for license information. *| 6 |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *| 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 #include "llvm-c/ExternC.h" 20 #include "llvm-c/Visibility.h" 21 22 /** 23 * @defgroup LLVMCDisassembler Disassembler 24 * @ingroup LLVMC 25 * 26 * @{ 27 */ 28 29 LLVM_C_EXTERN_C_BEGIN 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 LLVM_C_ABI LLVMDisasmContextRef LLVMCreateDisasm( 40 const char *TripleName, void *DisInfo, int TagType, 41 LLVMOpInfoCallback GetOpInfo, 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 LLVM_C_ABI LLVMDisasmContextRef LLVMCreateDisasmCPU( 52 const char *Triple, const char *CPU, void *DisInfo, int TagType, 53 LLVMOpInfoCallback GetOpInfo, LLVMSymbolLookupCallback SymbolLookUp); 54 55 /** 56 * Create a disassembler for the TripleName, a specific CPU and specific feature 57 * string. Symbolic disassembly is supported by passing a block of information 58 * in the DisInfo parameter and specifying the TagType and callback functions as 59 * described above. These can all be passed * as NULL. If successful, this 60 * returns a disassembler context. If not, it returns NULL. 61 */ 62 LLVM_C_ABI LLVMDisasmContextRef LLVMCreateDisasmCPUFeatures( 63 const char *Triple, const char *CPU, const char *Features, void *DisInfo, 64 int TagType, LLVMOpInfoCallback GetOpInfo, 65 LLVMSymbolLookupCallback SymbolLookUp); 66 67 /** 68 * Set the disassembler's options. Returns 1 if it can set the Options and 0 69 * otherwise. 70 */ 71 LLVM_C_ABI int LLVMSetDisasmOptions(LLVMDisasmContextRef DC, uint64_t Options); 72 73 /* The option to produce marked up assembly. */ 74 #define LLVMDisassembler_Option_UseMarkup 1 75 /* The option to print immediates as hex. */ 76 #define LLVMDisassembler_Option_PrintImmHex 2 77 /* The option use the other assembler printer variant */ 78 #define LLVMDisassembler_Option_AsmPrinterVariant 4 79 /* The option to set comment on instructions */ 80 #define LLVMDisassembler_Option_SetInstrComments 8 81 /* The option to print latency information alongside instructions */ 82 #define LLVMDisassembler_Option_PrintLatency 16 83 /* The option to print in color */ 84 #define LLVMDisassembler_Option_Color 32 85 86 /** 87 * Dispose of a disassembler context. 88 */ 89 LLVM_C_ABI 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 LLVM_C_ABI 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 LLVM_C_EXTERN_C_END 110 111 #endif /* LLVM_C_DISASSEMBLER_H */ 112