mirror of
https://github.com/c64scene-ar/llvm-6502.git
synced 2024-12-19 01:34:32 +00:00
bd3327654b
disassembler API. Hooked this up to the ARM target so such tools as Darwin's otool(1) can now print things like branch targets for example this: blx _puts instead of this: blx #-36 And even print the expression encoded in the Mach-O relocation entried for things like this: movt r0, :upper16:((_foo-_bar)+1234) git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@129284 91177308-0d34-0410-b5e6-96231b3b80d8
150 lines
6.6 KiB
C
150 lines
6.6 KiB
C
/*===-- llvm-c/Disassembler.h - Disassembler Public C Interface ---*- C -*-===*\
|
|
|* *|
|
|
|* The LLVM Compiler Infrastructure *|
|
|
|* *|
|
|
|* This file is distributed under the University of Illinois Open Source *|
|
|
|* License. See LICENSE.TXT for details. *|
|
|
|* *|
|
|
|*===----------------------------------------------------------------------===*|
|
|
|* *|
|
|
|* This header provides public interface to a disassembler library. *|
|
|
|* LLVM provides an implementation of this interface. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_C_DISASSEMBLER_H
|
|
#define LLVM_C_DISASSEMBLER_H 1
|
|
|
|
#include <stddef.h>
|
|
#include "llvm/Support/DataTypes.h"
|
|
|
|
/**
|
|
* An opaque reference to a disassembler context.
|
|
*/
|
|
typedef void *LLVMDisasmContextRef;
|
|
|
|
/**
|
|
* The type for the operand information call back function. This is called to
|
|
* get the symbolic information for an operand of an instruction. Typically
|
|
* this is from the relocation information, symbol table, etc. That block of
|
|
* information is saved when the disassembler context is created and passed to
|
|
* the call back in the DisInfo parameter. The instruction containing operand
|
|
* is at the PC parameter. For some instruction sets, there can be more than
|
|
* one operand with symbolic information. To determine the symbolic operand
|
|
* infomation for each operand, the bytes for the specific operand in the
|
|
* instruction are specified by the Offset parameter and its byte widith is the
|
|
* size parameter. For instructions sets with fixed widths and one symbolic
|
|
* operand per instruction, the Offset parameter will be zero and Size parameter
|
|
* will be the instruction width. The information is returned in TagBuf and is
|
|
* Triple specific with its specific information defined by the value of
|
|
* TagType for that Triple. If symbolic information is returned the function
|
|
* returns 1 else it returns 0.
|
|
*/
|
|
typedef int (*LLVMOpInfoCallback)(void *DisInfo,
|
|
uint64_t PC,
|
|
uint64_t Offset,
|
|
uint64_t Size,
|
|
int TagType,
|
|
void *TagBuf);
|
|
|
|
/**
|
|
* The initial support in LLVM MC for the most general form of a relocatable
|
|
* expression is "AddSymbol - SubtractSymbol + Offset". For some Darwin targets
|
|
* this full form is encoded in the relocation information so that AddSymbol and
|
|
* SubtractSymbol can be link edited independent of each other. Many other
|
|
* platforms only allow a relocatable expression of the form AddSymbol + Offset
|
|
* to be encoded.
|
|
*
|
|
* The LLVMOpInfoCallback() for the TagType value of 1 uses the struct
|
|
* LLVMOpInfo1. The value of the relocatable expression for the operand,
|
|
* including any PC adjustment, is passed in to the call back in the Value
|
|
* field. The symbolic information about the operand is returned using all
|
|
* the fields of the structure with the Offset of the relocatable expression
|
|
* returned in the Value field. It is possible that some symbols in the
|
|
* relocatable expression were assembly temporary symbols, for example
|
|
* "Ldata - LpicBase + constant", and only the Values of the symbols without
|
|
* symbol names are present in the relocation information. The VariantKind
|
|
* type is one of the Target specific #defines below and is used to print
|
|
* operands like "_foo@GOT", ":lower16:_foo", etc.
|
|
*/
|
|
struct LLVMOpInfoSymbol1 {
|
|
uint64_t Present; /* 1 if this symbol is present */
|
|
char *Name; /* symbol name if not NULL */
|
|
uint64_t Value; /* symbol value if name is NULL */
|
|
};
|
|
struct LLVMOpInfo1 {
|
|
struct LLVMOpInfoSymbol1 AddSymbol;
|
|
struct LLVMOpInfoSymbol1 SubtractSymbol;
|
|
uint64_t Value;
|
|
uint64_t VariantKind;
|
|
};
|
|
|
|
/**
|
|
* The operand VariantKinds for symbolic disassembly.
|
|
*/
|
|
#define LLVMDisassembler_VariantKind_None 0 /* all targets */
|
|
|
|
/**
|
|
* The ARM target VariantKinds.
|
|
*/
|
|
#define LLVMDisassembler_VariantKind_ARM_HI16 1 /* :upper16: */
|
|
#define LLVMDisassembler_VariantKind_ARM_LO16 2 /* :lower16: */
|
|
|
|
/**
|
|
* The type for the symbol lookup function. This may be called by the
|
|
* disassembler for such things like adding a comment for a PC plus a constant
|
|
* offset load instruction to use a symbol name instead of a load address value.
|
|
* It is passed the block information is saved when the disassembler context is
|
|
* created and a value of a symbol to look up. If no symbol is found NULL is
|
|
* to be returned.
|
|
*/
|
|
typedef const char *(*LLVMSymbolLookupCallback)(void *DisInfo,
|
|
uint64_t SymbolValue);
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* !defined(__cplusplus) */
|
|
|
|
/**
|
|
* Create a disassembler for the TripleName. Symbolic disassembly is supported
|
|
* by passing a block of information in the DisInfo parameter and specifing the
|
|
* TagType and call back functions as described above. These can all be passed
|
|
* as NULL. If successfull this returns a disassembler context if not it
|
|
* returns NULL.
|
|
*/
|
|
extern LLVMDisasmContextRef
|
|
LLVMCreateDisasm(const char *TripleName,
|
|
void *DisInfo,
|
|
int TagType,
|
|
LLVMOpInfoCallback GetOpInfo,
|
|
LLVMSymbolLookupCallback SymbolLookUp);
|
|
|
|
/**
|
|
* Dispose of a disassembler context.
|
|
*/
|
|
extern void
|
|
LLVMDisasmDispose(LLVMDisasmContextRef DC);
|
|
|
|
/**
|
|
* Disassmble a single instruction using the disassembler context specified in
|
|
* the parameter DC. The bytes of the instuction are specified in the parameter
|
|
* Bytes, and contains at least BytesSize number of bytes. The instruction is
|
|
* at the address specified by the PC parameter. If a valid instruction can be
|
|
* disassembled its string is returned indirectly in OutString which whos size
|
|
* is specified in the parameter OutStringSize. This function returns the
|
|
* number of bytes in the instruction or zero if there was no valid instruction.
|
|
*/
|
|
extern size_t
|
|
LLVMDisasmInstruction(LLVMDisasmContextRef DC,
|
|
uint8_t *Bytes,
|
|
uint64_t BytesSize,
|
|
uint64_t PC,
|
|
char *OutString,
|
|
size_t OutStringSize);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* !defined(__cplusplus) */
|
|
|
|
#endif /* !defined(LLVM_C_DISASSEMBLER_H) */
|