libasm.h revision 25b3c049e70834cf33790a28643ab058b507b35c
125b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Interface for libasm. 225b3c049e70834cf33790a28643ab058b507b35cBen Cheng Copyright (C) 2002, 2005, 2008 Red Hat, Inc. 325b3c049e70834cf33790a28643ab058b507b35cBen Cheng This file is part of Red Hat elfutils. 425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 525b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat elfutils is free software; you can redistribute it and/or modify 625b3c049e70834cf33790a28643ab058b507b35cBen Cheng it under the terms of the GNU General Public License as published by the 725b3c049e70834cf33790a28643ab058b507b35cBen Cheng Free Software Foundation; version 2 of the License. 825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 925b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat elfutils is distributed in the hope that it will be useful, but 1025b3c049e70834cf33790a28643ab058b507b35cBen Cheng WITHOUT ANY WARRANTY; without even the implied warranty of 1125b3c049e70834cf33790a28643ab058b507b35cBen Cheng MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 1225b3c049e70834cf33790a28643ab058b507b35cBen Cheng General Public License for more details. 1325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 1425b3c049e70834cf33790a28643ab058b507b35cBen Cheng You should have received a copy of the GNU General Public License along 1525b3c049e70834cf33790a28643ab058b507b35cBen Cheng with Red Hat elfutils; if not, write to the Free Software Foundation, 1625b3c049e70834cf33790a28643ab058b507b35cBen Cheng Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA. 1725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 1825b3c049e70834cf33790a28643ab058b507b35cBen Cheng Red Hat elfutils is an included package of the Open Invention Network. 1925b3c049e70834cf33790a28643ab058b507b35cBen Cheng An included package of the Open Invention Network is a package for which 2025b3c049e70834cf33790a28643ab058b507b35cBen Cheng Open Invention Network licensees cross-license their patents. No patent 2125b3c049e70834cf33790a28643ab058b507b35cBen Cheng license is granted, either expressly or impliedly, by designation as an 2225b3c049e70834cf33790a28643ab058b507b35cBen Cheng included package. Should you wish to participate in the Open Invention 2325b3c049e70834cf33790a28643ab058b507b35cBen Cheng Network licensing program, please visit www.openinventionnetwork.com 2425b3c049e70834cf33790a28643ab058b507b35cBen Cheng <http://www.openinventionnetwork.com>. */ 2525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 2625b3c049e70834cf33790a28643ab058b507b35cBen Cheng#ifndef _LIBASM_H 2725b3c049e70834cf33790a28643ab058b507b35cBen Cheng#define _LIBASM_H 1 2825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 2925b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <stdbool.h> 3025b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <stdint.h> 3125b3c049e70834cf33790a28643ab058b507b35cBen Cheng 3225b3c049e70834cf33790a28643ab058b507b35cBen Cheng#include <libebl.h> 3325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 3425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 3525b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Opaque type for the assembler context descriptor. */ 3625b3c049e70834cf33790a28643ab058b507b35cBen Chengtypedef struct AsmCtx AsmCtx_t; 3725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 3825b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Opaque type for a section. */ 3925b3c049e70834cf33790a28643ab058b507b35cBen Chengtypedef struct AsmScn AsmScn_t; 4025b3c049e70834cf33790a28643ab058b507b35cBen Cheng 4125b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Opaque type for a section group. */ 4225b3c049e70834cf33790a28643ab058b507b35cBen Chengtypedef struct AsmScnGrp AsmScnGrp_t; 4325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 4425b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Opaque type for a symbol. */ 4525b3c049e70834cf33790a28643ab058b507b35cBen Chengtypedef struct AsmSym AsmSym_t; 4625b3c049e70834cf33790a28643ab058b507b35cBen Cheng 4725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 4825b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Opaque type for the disassembler context descriptor. */ 4925b3c049e70834cf33790a28643ab058b507b35cBen Chengtypedef struct DisasmCtx DisasmCtx_t; 5025b3c049e70834cf33790a28643ab058b507b35cBen Cheng 5125b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Type used for callback functions to retrieve symbol name. The 5225b3c049e70834cf33790a28643ab058b507b35cBen Cheng symbol reference is in the section designated by the second parameter 5325b3c049e70834cf33790a28643ab058b507b35cBen Cheng at an offset described by the first parameter. The value is the 5425b3c049e70834cf33790a28643ab058b507b35cBen Cheng third parameter. */ 5525b3c049e70834cf33790a28643ab058b507b35cBen Chengtypedef int (*DisasmGetSymCB_t) (GElf_Addr, Elf32_Word, GElf_Addr, char **, 5625b3c049e70834cf33790a28643ab058b507b35cBen Cheng size_t *, void *); 5725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 5825b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Output function callback. */ 5925b3c049e70834cf33790a28643ab058b507b35cBen Chengtypedef int (*DisasmOutputCB_t) (char *, size_t, void *); 6025b3c049e70834cf33790a28643ab058b507b35cBen Cheng 6125b3c049e70834cf33790a28643ab058b507b35cBen Cheng 6225b3c049e70834cf33790a28643ab058b507b35cBen Cheng#ifdef __cplusplus 6325b3c049e70834cf33790a28643ab058b507b35cBen Chengextern "C" { 6425b3c049e70834cf33790a28643ab058b507b35cBen Cheng#endif 6525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 6625b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Create output file and return descriptor for assembler context. If 6725b3c049e70834cf33790a28643ab058b507b35cBen Cheng TEXTP is true the output is an assembler format text file. 6825b3c049e70834cf33790a28643ab058b507b35cBen Cheng Otherwise an object file is created. The MACHINE parameter 6925b3c049e70834cf33790a28643ab058b507b35cBen Cheng corresponds to an EM_ constant from <elf.h>, KLASS specifies the 7025b3c049e70834cf33790a28643ab058b507b35cBen Cheng class (32- or 64-bit), and DATA specifies the byte order (little or 7125b3c049e70834cf33790a28643ab058b507b35cBen Cheng big endian). */ 7225b3c049e70834cf33790a28643ab058b507b35cBen Chengextern AsmCtx_t *asm_begin (const char *fname, Ebl *ebl, bool textp); 7325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 7425b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Abort the operation on the assembler context and free all resources. */ 7525b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_abort (AsmCtx_t *ctx); 7625b3c049e70834cf33790a28643ab058b507b35cBen Cheng 7725b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Finalize output file and free all resources. */ 7825b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_end (AsmCtx_t *ctx); 7925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 8025b3c049e70834cf33790a28643ab058b507b35cBen Cheng 8125b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Return handle for the named section. If it was not used before 8225b3c049e70834cf33790a28643ab058b507b35cBen Cheng create it. */ 8325b3c049e70834cf33790a28643ab058b507b35cBen Chengextern AsmScn_t *asm_newscn (AsmCtx_t *ctx, const char *scnname, 8425b3c049e70834cf33790a28643ab058b507b35cBen Cheng GElf_Word type, GElf_Xword flags); 8525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 8625b3c049e70834cf33790a28643ab058b507b35cBen Cheng 8725b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Similar to 'asm_newscn', but make it part of section group GRP. */ 8825b3c049e70834cf33790a28643ab058b507b35cBen Chengextern AsmScn_t *asm_newscn_ingrp (AsmCtx_t *ctx, const char *scnname, 8925b3c049e70834cf33790a28643ab058b507b35cBen Cheng GElf_Word type, GElf_Xword flags, 9025b3c049e70834cf33790a28643ab058b507b35cBen Cheng AsmScnGrp_t *grp); 9125b3c049e70834cf33790a28643ab058b507b35cBen Cheng 9225b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Create new subsection NR in the given section. */ 9325b3c049e70834cf33790a28643ab058b507b35cBen Chengextern AsmScn_t *asm_newsubscn (AsmScn_t *asmscn, unsigned int nr); 9425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 9525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 9625b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Return handle for new section group. The signature symbol can be 9725b3c049e70834cf33790a28643ab058b507b35cBen Cheng set later. */ 9825b3c049e70834cf33790a28643ab058b507b35cBen Chengextern AsmScnGrp_t *asm_newscngrp (AsmCtx_t *ctx, const char *grpname, 9925b3c049e70834cf33790a28643ab058b507b35cBen Cheng AsmSym_t *signature, Elf32_Word flags); 10025b3c049e70834cf33790a28643ab058b507b35cBen Cheng 10125b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Set or overwrite signature symbol for group. */ 10225b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_scngrp_newsignature (AsmScnGrp_t *grp, AsmSym_t *signature); 10325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 10425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 10525b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Add zero terminated string STR of size LEN to (sub)section ASMSCN. */ 10625b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_addstrz (AsmScn_t *asmscn, const char *str, size_t len); 10725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 10825b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Add 8-bit signed integer NUM to (sub)section ASMSCN. */ 10925b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_addint8 (AsmScn_t *asmscn, int8_t num); 11025b3c049e70834cf33790a28643ab058b507b35cBen Cheng 11125b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Add 8-bit unsigned integer NUM to (sub)section ASMSCN. */ 11225b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_adduint8 (AsmScn_t *asmscn, uint8_t num); 11325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 11425b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Add 16-bit signed integer NUM to (sub)section ASMSCN. */ 11525b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_addint16 (AsmScn_t *asmscn, int16_t num); 11625b3c049e70834cf33790a28643ab058b507b35cBen Cheng 11725b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Add 16-bit unsigned integer NUM to (sub)section ASMSCN. */ 11825b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_adduint16 (AsmScn_t *asmscn, uint16_t num); 11925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 12025b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Add 32-bit signed integer NUM to (sub)section ASMSCN. */ 12125b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_addint32 (AsmScn_t *asmscn, int32_t num); 12225b3c049e70834cf33790a28643ab058b507b35cBen Cheng 12325b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Add 32-bit unsigned integer NUM to (sub)section ASMSCN. */ 12425b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_adduint32 (AsmScn_t *asmscn, uint32_t num); 12525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 12625b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Add 64-bit signed integer NUM to (sub)section ASMSCN. */ 12725b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_addint64 (AsmScn_t *asmscn, int64_t num); 12825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 12925b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Add 64-bit unsigned integer NUM to (sub)section ASMSCN. */ 13025b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_adduint64 (AsmScn_t *asmscn, uint64_t num); 13125b3c049e70834cf33790a28643ab058b507b35cBen Cheng 13225b3c049e70834cf33790a28643ab058b507b35cBen Cheng 13325b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Add signed little endian base 128 integer NUM to (sub)section ASMSCN. */ 13425b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_addsleb128 (AsmScn_t *asmscn, int32_t num); 13525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 13625b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Add unsigned little endian base 128 integer NUM to (sub)section ASMSCN. */ 13725b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_adduleb128 (AsmScn_t *asmscn, uint32_t num); 13825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 13925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 14025b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Define new symbol NAME for current position in given section ASMSCN. */ 14125b3c049e70834cf33790a28643ab058b507b35cBen Chengextern AsmSym_t *asm_newsym (AsmScn_t *asmscn, const char *name, 14225b3c049e70834cf33790a28643ab058b507b35cBen Cheng GElf_Xword size, int type, int binding); 14325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 14425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 14525b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Define new common symbol NAME with given SIZE and alignment. */ 14625b3c049e70834cf33790a28643ab058b507b35cBen Chengextern AsmSym_t *asm_newcomsym (AsmCtx_t *ctx, const char *name, 14725b3c049e70834cf33790a28643ab058b507b35cBen Cheng GElf_Xword size, GElf_Addr align); 14825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 14925b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Define new common symbol NAME with given SIZE, VALUE, TYPE, and BINDING. */ 15025b3c049e70834cf33790a28643ab058b507b35cBen Chengextern AsmSym_t *asm_newabssym (AsmCtx_t *ctx, const char *name, 15125b3c049e70834cf33790a28643ab058b507b35cBen Cheng GElf_Xword size, GElf_Addr value, 15225b3c049e70834cf33790a28643ab058b507b35cBen Cheng int type, int binding); 15325b3c049e70834cf33790a28643ab058b507b35cBen Cheng 15425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 15525b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Align (sub)section offset according to VALUE. */ 15625b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_align (AsmScn_t *asmscn, GElf_Word value); 15725b3c049e70834cf33790a28643ab058b507b35cBen Cheng 15825b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Set the byte pattern used to fill gaps created by alignment. */ 15925b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_fill (AsmScn_t *asmscn, void *bytes, size_t len); 16025b3c049e70834cf33790a28643ab058b507b35cBen Cheng 16125b3c049e70834cf33790a28643ab058b507b35cBen Cheng 16225b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Return ELF descriptor created for the output file of the given context. */ 16325b3c049e70834cf33790a28643ab058b507b35cBen Chengextern Elf *asm_getelf (AsmCtx_t *ctx); 16425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 16525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 16625b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Return error code of last failing function call. This value is kept 16725b3c049e70834cf33790a28643ab058b507b35cBen Cheng separately for each thread. */ 16825b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int asm_errno (void); 16925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 17025b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Return error string for ERROR. If ERROR is zero, return error string 17125b3c049e70834cf33790a28643ab058b507b35cBen Cheng for most recent error or NULL is none occurred. If ERROR is -1 the 17225b3c049e70834cf33790a28643ab058b507b35cBen Cheng behaviour is similar to the last case except that not NULL but a legal 17325b3c049e70834cf33790a28643ab058b507b35cBen Cheng string is returned. */ 17425b3c049e70834cf33790a28643ab058b507b35cBen Chengextern const char *asm_errmsg (int __error); 17525b3c049e70834cf33790a28643ab058b507b35cBen Cheng 17625b3c049e70834cf33790a28643ab058b507b35cBen Cheng 17725b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Create context descriptor for disassembler. */ 17825b3c049e70834cf33790a28643ab058b507b35cBen Chengextern DisasmCtx_t *disasm_begin (Ebl *ebl, Elf *elf, DisasmGetSymCB_t symcb); 17925b3c049e70834cf33790a28643ab058b507b35cBen Cheng 18025b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Release descriptor for disassembler. */ 18125b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int disasm_end (DisasmCtx_t *ctx); 18225b3c049e70834cf33790a28643ab058b507b35cBen Cheng 18325b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Produce of disassembly output for given memory, store text in 18425b3c049e70834cf33790a28643ab058b507b35cBen Cheng provided buffer. */ 18525b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int disasm_str (DisasmCtx_t *ctx, const uint8_t **startp, 18625b3c049e70834cf33790a28643ab058b507b35cBen Cheng const uint8_t *end, GElf_Addr addr, const char *fmt, 18725b3c049e70834cf33790a28643ab058b507b35cBen Cheng char **bufp, size_t len, void *symcbarg); 18825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 18925b3c049e70834cf33790a28643ab058b507b35cBen Cheng/* Produce disassembly output for given memory and output it using the 19025b3c049e70834cf33790a28643ab058b507b35cBen Cheng given callback functions. */ 19125b3c049e70834cf33790a28643ab058b507b35cBen Chengextern int disasm_cb (DisasmCtx_t *ctx, const uint8_t **startp, 19225b3c049e70834cf33790a28643ab058b507b35cBen Cheng const uint8_t *end, GElf_Addr addr, const char *fmt, 19325b3c049e70834cf33790a28643ab058b507b35cBen Cheng DisasmOutputCB_t outcb, void *outcbarg, void *symcbarg); 19425b3c049e70834cf33790a28643ab058b507b35cBen Cheng 19525b3c049e70834cf33790a28643ab058b507b35cBen Cheng#ifdef __cplusplus 19625b3c049e70834cf33790a28643ab058b507b35cBen Cheng} 19725b3c049e70834cf33790a28643ab058b507b35cBen Cheng#endif 19825b3c049e70834cf33790a28643ab058b507b35cBen Cheng 19925b3c049e70834cf33790a28643ab058b507b35cBen Cheng#endif /* libasm.h */ 200