blob: 3adcc3c47a3f568535904b31ff9f7f965b2d43f2 [file] [log] [blame]
Kevin Enderbyf3070dc2011-03-28 18:25:07 +00001/*===-- llvm-c/Disassembler.h - Disassembler Public C Interface ---*- C -*-===*\
2|* *|
Chandler Carruth2946cd72019-01-19 08:50:56 +00003|* 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 *|
Kevin Enderbyf3070dc2011-03-28 18:25:07 +00007|* *|
8|*===----------------------------------------------------------------------===*|
9|* *|
Chris Lattnere8bf2d52011-05-22 04:44:48 +000010|* This header provides a public interface to a disassembler library. *|
Kevin Enderbyf3070dc2011-03-28 18:25:07 +000011|* LLVM provides an implementation of this interface. *|
12|* *|
13\*===----------------------------------------------------------------------===*/
14
15#ifndef LLVM_C_DISASSEMBLER_H
Chris Lattnere8bf2d52011-05-22 04:44:48 +000016#define LLVM_C_DISASSEMBLER_H
Kevin Enderbyf3070dc2011-03-28 18:25:07 +000017
David Blaikie3d94e9f2018-03-29 00:29:44 +000018#include "llvm-c/DisassemblerTypes.h"
Kevin Enderbyf3070dc2011-03-28 18:25:07 +000019
20/**
Gregory Szorc34c863a2012-03-21 03:54:29 +000021 * @defgroup LLVMCDisassembler Disassembler
22 * @ingroup LLVMC
23 *
24 * @{
25 */
26
Kevin Enderbyf3070dc2011-03-28 18:25:07 +000027#ifdef __cplusplus
28extern "C" {
29#endif /* !defined(__cplusplus) */
30
31/**
32 * Create a disassembler for the TripleName. Symbolic disassembly is supported
Chris Lattnere8bf2d52011-05-22 04:44:48 +000033 * 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
Bradley Smith7a770752014-09-30 16:31:40 +000036 * returns NULL. This function is equivalent to calling
37 * LLVMCreateDisasmCPUFeatures() with an empty CPU name and feature set.
Kevin Enderbyf3070dc2011-03-28 18:25:07 +000038 */
Chris Lattnere8bf2d52011-05-22 04:44:48 +000039LLVMDisasmContextRef LLVMCreateDisasm(const char *TripleName, void *DisInfo,
40 int TagType, LLVMOpInfoCallback GetOpInfo,
41 LLVMSymbolLookupCallback SymbolLookUp);
Kevin Enderbyf3070dc2011-03-28 18:25:07 +000042
43/**
Jim Grosbach0ca9d5b2012-12-07 23:53:27 +000044 * 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
Bradley Smith7a770752014-09-30 16:31:40 +000048 * disassembler context. If not, it returns NULL. This function is equivalent
49 * to calling LLVMCreateDisasmCPUFeatures() with an empty feature set.
Jim Grosbach0ca9d5b2012-12-07 23:53:27 +000050 */
51LLVMDisasmContextRef LLVMCreateDisasmCPU(const char *Triple, const char *CPU,
52 void *DisInfo, int TagType,
53 LLVMOpInfoCallback GetOpInfo,
54 LLVMSymbolLookupCallback SymbolLookUp);
55
56/**
Bradley Smith7a770752014-09-30 16:31:40 +000057 * 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 */
63LLVMDisasmContextRef
64LLVMCreateDisasmCPUFeatures(const char *Triple, const char *CPU,
65 const char *Features, void *DisInfo, int TagType,
66 LLVMOpInfoCallback GetOpInfo,
67 LLVMSymbolLookupCallback SymbolLookUp);
68
69/**
Kevin Enderby62183c42012-10-22 22:31:46 +000070 * Set the disassembler's options. Returns 1 if it can set the Options and 0
71 * otherwise.
72 */
73int LLVMSetDisasmOptions(LLVMDisasmContextRef DC, uint64_t Options);
74
75/* The option to produce marked up assembly. */
76#define LLVMDisassembler_Option_UseMarkup 1
Kevin Enderby168ffb32012-12-05 18:13:19 +000077/* The option to print immediates as hex. */
78#define LLVMDisassembler_Option_PrintImmHex 2
Kevin Enderby85cf5312012-12-18 23:47:28 +000079/* The option use the other assembler printer variant */
80#define LLVMDisassembler_Option_AsmPrinterVariant 4
Quentin Colombet93a98aa2013-10-01 22:14:56 +000081/* The option to set comment on instructions */
82#define LLVMDisassembler_Option_SetInstrComments 8
Quentin Colombet5f09cb02013-10-02 22:07:57 +000083 /* The option to print latency information alongside instructions */
84#define LLVMDisassembler_Option_PrintLatency 16
Kevin Enderby62183c42012-10-22 22:31:46 +000085
86/**
Kevin Enderbyf3070dc2011-03-28 18:25:07 +000087 * Dispose of a disassembler context.
88 */
Chris Lattnere8bf2d52011-05-22 04:44:48 +000089void LLVMDisasmDispose(LLVMDisasmContextRef DC);
Kevin Enderbyf3070dc2011-03-28 18:25:07 +000090
91/**
Chris Lattnere8bf2d52011-05-22 04:44:48 +000092 * 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.
Kevin Enderbyf3070dc2011-03-28 18:25:07 +0000100 */
Chris Lattnere8bf2d52011-05-22 04:44:48 +0000101size_t LLVMDisasmInstruction(LLVMDisasmContextRef DC, uint8_t *Bytes,
102 uint64_t BytesSize, uint64_t PC,
103 char *OutString, size_t OutStringSize);
Kevin Enderbyf3070dc2011-03-28 18:25:07 +0000104
Gregory Szorc34c863a2012-03-21 03:54:29 +0000105/**
106 * @}
107 */
108
Kevin Enderbyf3070dc2011-03-28 18:25:07 +0000109#ifdef __cplusplus
110}
111#endif /* !defined(__cplusplus) */
112
Eugene Zelenko35623fb2016-03-28 17:40:08 +0000113#endif /* LLVM_C_DISASSEMBLER_H */