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 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 /* SPARC disassembler flags */
  43 #define DIS_SPARC_V8            0x001
  44 #define DIS_SPARC_V9            0x002
  45 #define DIS_SPARC_V9_SGI        0x004
  46 #define DIS_SPARC_V9_OPL        0x008
  47
  48 /* x86 diassembler flags */
  49 #define DIS_X86_SIZE16          0x100
  50 #define DIS_X86_SIZE32          0x010
  51 #define DIS_X86_SIZE64          0x020
  52
  53 /* s390 disassembler flags */
  54 #define DIS_S370                0x200
  55 #define DIS_S390_31             0x400
  56 #define DIS_S390_64             0x800
  57
  58 /* generic disassembler flags */
  59 #define DIS_OCTAL               0x040
  60 #define DIS_NOIMMSYM            0x080
  61
  62 #define DIS_ARCH_MASK           (DIS_SPARC_V8 | \
  63                 DIS_SPARC_V9 | DIS_SPARC_V9_SGI | DIS_SPARC_V9_OPL | \
  64                 DIS_X86_SIZE16 | DIS_X86_SIZE32 | DIS_X86_SIZE64 | \
  65                 DIS_S370 | DIS_S390_31 | DIS_S390_64)
  66
  67 typedef int (*dis_lookup_f)(void *, uint64_t, char *, size_t, uint64_t *,
  68     size_t *);
  69 typedef int (*dis_read_f)(void *, uint64_t, void *, size_t);
  70
  71 extern dis_handle_t *dis_handle_create(int, void *, dis_lookup_f, dis_read_f);
  72 extern void dis_handle_destroy(dis_handle_t *);
  73
  74 extern int dis_disassemble(dis_handle_t *, uint64_t, char *, size_t);
  75 extern uint64_t dis_previnstr(dis_handle_t *, uint64_t, int n);
  76 extern void dis_set_data(dis_handle_t *, void *);
  77 extern void dis_flags_set(dis_handle_t *, int f);
  78 extern void dis_flags_clear(dis_handle_t *, int f);
  79 extern int dis_max_instrlen(dis_handle_t *);
  80 extern int dis_min_instrlen(dis_handle_t *);
  81 extern int dis_instrlen(dis_handle_t *, uint64_t);
  82
  83 /* libdisasm errors */
  84 #define E_DIS_NOMEM             1       /* Out of memory */
  85 #define E_DIS_INVALFLAG         2       /* Invalid flag for this architecture */
  86 #define E_DIS_UNSUPARCH         3       /* Unsupported architecture */
  87
  88 extern int dis_errno(void);
  89 extern const char *dis_strerror(int);
  90
  91 #ifdef  __cplusplus
  92 }
  93 #endif
  94
  95 #endif  /* _LIBDISASM_H */