usr/src/lib/libdisasm/common/libdisasm.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21
  22 /*
  23  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
  24  * Use is subject to license terms.
  25  * Copyright 2012 Joshua M. Clulow <josh@sysmgr.org>
  26  * Copyright 2015-2017 Josef 'Jeff' Sipek <jeffpc@josefsipek.net>
  27  * Copyright 2018, Joyent, Inc.
  28  */
  29
  30 #ifndef _LIBDISASM_H
  31 #define _LIBDISASM_H
  32
  33 #include <sys/types.h>
  34
  35 #ifdef  __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 typedef struct dis_handle dis_handle_t;
  40
  41 #define DIS_DEFAULT             0x0
  42
  43 /* generic size flags */
  44 #define DIS_SIZE_16             0x1000
  45 #define DIS_SIZE_24             0x2000
  46 #define DIS_SIZE_32             0x4000
  47 #define DIS_SIZE_64             0x8000
  48
  49 /* SPARC disassembler flags */
  50 #define DIS_SPARC_V8            0x001
  51 #define DIS_SPARC_V9            0x002
  52 #define DIS_SPARC_V9_SGI        0x004
  53 #define DIS_SPARC_V9_OPL        0x008
  54
  55 /* x86 diassembler flags */
  56 #define DIS_X86                 0x010
  57
  58 /* s390 disassembler flags */
  59 #define DIS_S3X0                0x020
  60
  61 /* risc-v disassembler flags */
  62 #define DIS_RISCV               0x100
  63
  64 /* generic disassembler flags */
  65 #define DIS_OCTAL               0x040
  66 #define DIS_NOIMMSYM            0x080
  67
  68 #define DIS_ARCH_MASK           (DIS_SPARC_V8 | \
  69                 DIS_SPARC_V9 | DIS_SPARC_V9_SGI | DIS_SPARC_V9_OPL | \
  70                 DIS_X86 | DIS_S3X0 | DIS_RISCV)
  71 #define DIS_SIZE_MASK           (DIS_SIZE_16 | \
  72                 DIS_SIZE_24 | DIS_SIZE_32 | DIS_SIZE_64)
  73
  74 #define DIS_SIZE_CHECK(value, allowed_sizes) \
  75         ((((value) & ~(allowed_sizes)) & DIS_SIZE_MASK) == 0)
  76
  77 typedef int (*dis_lookup_f)(void *, uint64_t, char *, size_t, uint64_t *,
  78     size_t *);
  79 typedef int (*dis_read_f)(void *, uint64_t, void *, size_t);
  80
  81 extern dis_handle_t *dis_handle_create(int, void *, dis_lookup_f, dis_read_f);
  82 extern void dis_handle_destroy(dis_handle_t *);
  83
  84 extern int dis_disassemble(dis_handle_t *, uint64_t, char *, size_t);
  85 extern uint64_t dis_previnstr(dis_handle_t *, uint64_t, int n);
  86 extern void dis_set_data(dis_handle_t *, void *);
  87 extern void dis_flags_set(dis_handle_t *, int f);
  88 extern void dis_flags_clear(dis_handle_t *, int f);
  89 extern int dis_max_instrlen(dis_handle_t *);
  90 extern int dis_min_instrlen(dis_handle_t *);
  91 extern int dis_instrlen(dis_handle_t *, uint64_t);
  92
  93 /* libdisasm errors */
  94 #define E_DIS_NOMEM             1       /* Out of memory */
  95 #define E_DIS_INVALFLAG         2       /* Invalid flag for this architecture */
  96 #define E_DIS_UNSUPARCH         3       /* Unsupported architecture */
  97
  98 extern int dis_errno(void);
  99 extern const char *dis_strerror(int);
 100
 101 #ifdef  __cplusplus
 102 }
 103 #endif
 104
 105 #endif  /* _LIBDISASM_H */