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  * 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 /* SPARC disassembler flags */
44 #define	DIS_SPARC_V8		0x001
45 #define	DIS_SPARC_V9		0x002
46 #define	DIS_SPARC_V9_SGI	0x004
47 #define	DIS_SPARC_V9_OPL	0x008
48 
49 /* x86 diassembler flags */
50 #define	DIS_X86_SIZE16		0x100
51 #define	DIS_X86_SIZE32		0x010
52 #define	DIS_X86_SIZE64		0x020
53 
54 /* s390 disassembler flags */
55 #define	DIS_S370		0x200
56 #define	DIS_S390_31		0x400
57 #define	DIS_S390_64		0x800
58 
59 /* risc-v disassembler flags */
60 #define	DIS_RISCV_32		0x2000
61 #define	DIS_RISCV_64		0x4000
62 
63 /* generic disassembler flags */
64 #define	DIS_OCTAL		0x040
65 #define	DIS_NOIMMSYM		0x080
66 
67 #define	DIS_ARCH_MASK		(DIS_SPARC_V8 | \
68 		DIS_SPARC_V9 | DIS_SPARC_V9_SGI | DIS_SPARC_V9_OPL | \
69 		DIS_X86_SIZE16 | DIS_X86_SIZE32 | DIS_X86_SIZE64 | \
70 		DIS_S370 | DIS_S390_31 | DIS_S390_64 | DIS_RISCV_32 | \
71 		DIS_RISCV_64)
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 */
102