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  */
  28
  29 #ifndef _LIBDISASM_H
  30 #define _LIBDISASM_H
  31
  32 #include <sys/types.h>
  33
  34 #ifdef  __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 typedef struct dis_handle dis_handle_t;
  39
  40 #define DIS_DEFAULT             0x0
  41
  42 /* generic size flags */
  43 #define DIS_SIZE_16             0x1000
  44 #define DIS_SIZE_24             0x2000
  45 #define DIS_SIZE_32             0x4000
  46 #define DIS_SIZE_64             0x8000
  47
  48 /* SPARC disassembler flags */
  49 #define DIS_SPARC_V8            0x001
  50 #define DIS_SPARC_V9            0x002
  51 #define DIS_SPARC_V9_SGI        0x004
  52 #define DIS_SPARC_V9_OPL        0x008
  53
  54 /* x86 diassembler flags */
  55 #define DIS_X86                 0x010
  56
  57 /* s390 disassembler flags */
  58 #define DIS_S3X0                0x020
  59
  60 /* generic disassembler flags */
  61 #define DIS_OCTAL               0x040
  62 #define DIS_NOIMMSYM            0x080
  63
  64 #define DIS_ARCH_MASK           (DIS_SPARC_V8 | \
  65                 DIS_SPARC_V9 | DIS_SPARC_V9_SGI | DIS_SPARC_V9_OPL | \
  66                 DIS_X86 | DIS_S3X0)
  67 #define DIS_SIZE_MASK           (DIS_SIZE_16 | \
  68                 DIS_SIZE_24 | DIS_SIZE_32 | DIS_SIZE_64)
  69
  70 #define DIS_SIZE_CHECK(value, allowed_sizes) \
  71         ((((value) & ~(allowed_sizes)) & DIS_SIZE_MASK) == 0)
  72
  73 typedef int (*dis_lookup_f)(void *, uint64_t, char *, size_t, uint64_t *,
  74     size_t *);
  75 typedef int (*dis_read_f)(void *, uint64_t, void *, size_t);
  76
  77 extern dis_handle_t *dis_handle_create(int, void *, dis_lookup_f, dis_read_f);
  78 extern void dis_handle_destroy(dis_handle_t *);
  79
  80 extern int dis_disassemble(dis_handle_t *, uint64_t, char *, size_t);
  81 extern uint64_t dis_previnstr(dis_handle_t *, uint64_t, int n);
  82 extern void dis_set_data(dis_handle_t *, void *);
  83 extern void dis_flags_set(dis_handle_t *, int f);
  84 extern void dis_flags_clear(dis_handle_t *, int f);
  85 extern int dis_max_instrlen(dis_handle_t *);
  86 extern int dis_min_instrlen(dis_handle_t *);
  87 extern int dis_instrlen(dis_handle_t *, uint64_t);
  88
  89 /* libdisasm errors */
  90 #define E_DIS_NOMEM             1       /* Out of memory */
  91 #define E_DIS_INVALFLAG         2       /* Invalid flag for this architecture */
  92 #define E_DIS_UNSUPARCH         3       /* Unsupported architecture */
  93
  94 extern int dis_errno(void);
  95 extern const char *dis_strerror(int);
  96
  97 #ifdef  __cplusplus
  98 }
  99 #endif
 100
 101 #endif  /* _LIBDISASM_H */