xref: /illumos-gate/usr/src/lib/libdisasm/common/libdisasm.h (revision 40cb5e5daa7b80bb70fcf8dadfb20f9281566331)
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 2006 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_LIBDISASM_H
28 #define	_LIBDISASM_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
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		0x01
44 #define	DIS_SPARC_V9		0x02
45 #define	DIS_SPARC_V9_SGI	0x04
46 
47 /* x86 diassembler flags (mutually exclusive) */
48 #define	DIS_X86_SIZE16		0x08
49 #define	DIS_X86_SIZE32		0x10
50 #define	DIS_X86_SIZE64		0x20
51 
52 /* generic disassembler flags */
53 #define	DIS_OCTAL		0x40
54 
55 typedef int (*dis_lookup_f)(void *, uint64_t, char *, size_t, uint64_t *,
56     size_t *);
57 typedef int (*dis_read_f)(void *, uint64_t, void *, size_t);
58 
59 extern dis_handle_t *dis_handle_create(int, void *, dis_lookup_f, dis_read_f);
60 extern void dis_handle_destroy(dis_handle_t *);
61 
62 extern int dis_disassemble(dis_handle_t *, uint64_t, char *, size_t);
63 extern uint64_t dis_previnstr(dis_handle_t *, uint64_t, int n);
64 extern void dis_set_data(dis_handle_t *, void *);
65 extern int dis_max_instrlen(dis_handle_t *);
66 
67 /* libdisasm errors */
68 #define	E_DIS_NOMEM		1	/* Out of memory */
69 #define	E_DIS_INVALFLAG		2	/* Invalid flag for this architecture */
70 
71 extern int dis_errno(void);
72 extern const char *dis_strerror(int);
73 
74 #ifdef	__cplusplus
75 }
76 #endif
77 
78 #endif	/* _LIBDISASM_H */
79