xref: /titanic_41/usr/src/lib/libdisasm/common/libdisasm.h (revision 37238c400dc66cf9c1d1ad1934bd55b5599ad318)
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  */
27 
28 #ifndef	_LIBDISASM_H
29 #define	_LIBDISASM_H
30 
31 #include <sys/types.h>
32 
33 #ifdef	__cplusplus
34 extern "C" {
35 #endif
36 
37 typedef struct dis_handle dis_handle_t;
38 
39 #define	DIS_DEFAULT		0x0
40 
41 /* SPARC disassembler flags */
42 #define	DIS_SPARC_V8		0x001
43 #define	DIS_SPARC_V9		0x002
44 #define	DIS_SPARC_V9_SGI	0x004
45 #define	DIS_SPARC_V9_OPL	0x008
46 
47 /* x86 diassembler flags */
48 #define	DIS_X86_SIZE16		0x100
49 #define	DIS_X86_SIZE32		0x010
50 #define	DIS_X86_SIZE64		0x020
51 
52 /* generic disassembler flags */
53 #define	DIS_OCTAL		0x040
54 #define	DIS_NOIMMSYM		0x080
55 
56 #define	DIS_ARCH_MASK		(DIS_SPARC_V8 | \
57 		DIS_SPARC_V9 | DIS_SPARC_V9_SGI | DIS_SPARC_V9_OPL | \
58 		DIS_X86_SIZE16 | DIS_X86_SIZE32 | DIS_X86_SIZE64)
59 
60 typedef int (*dis_lookup_f)(void *, uint64_t, char *, size_t, uint64_t *,
61     size_t *);
62 typedef int (*dis_read_f)(void *, uint64_t, void *, size_t);
63 
64 extern dis_handle_t *dis_handle_create(int, void *, dis_lookup_f, dis_read_f);
65 extern void dis_handle_destroy(dis_handle_t *);
66 
67 extern int dis_disassemble(dis_handle_t *, uint64_t, char *, size_t);
68 extern uint64_t dis_previnstr(dis_handle_t *, uint64_t, int n);
69 extern void dis_set_data(dis_handle_t *, void *);
70 extern void dis_flags_set(dis_handle_t *, int f);
71 extern void dis_flags_clear(dis_handle_t *, int f);
72 extern int dis_max_instrlen(dis_handle_t *);
73 extern int dis_min_instrlen(dis_handle_t *);
74 extern int dis_instrlen(dis_handle_t *, uint64_t);
75 
76 /* libdisasm errors */
77 #define	E_DIS_NOMEM		1	/* Out of memory */
78 #define	E_DIS_INVALFLAG		2	/* Invalid flag for this architecture */
79 #define	E_DIS_UNSUPARCH		3	/* Unsupported architecture */
80 
81 extern int dis_errno(void);
82 extern const char *dis_strerror(int);
83 
84 #ifdef	__cplusplus
85 }
86 #endif
87 
88 #endif	/* _LIBDISASM_H */
89