xref: /titanic_51/usr/src/lib/libdisasm/common/libdisasm.h (revision dc0093f44ee4fac928e006850f8ed53f68277af5)
1*dc0093f4Seschrock /*
2*dc0093f4Seschrock  * CDDL HEADER START
3*dc0093f4Seschrock  *
4*dc0093f4Seschrock  * The contents of this file are subject to the terms of the
5*dc0093f4Seschrock  * Common Development and Distribution License (the "License").
6*dc0093f4Seschrock  * You may not use this file except in compliance with the License.
7*dc0093f4Seschrock  *
8*dc0093f4Seschrock  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9*dc0093f4Seschrock  * or http://www.opensolaris.org/os/licensing.
10*dc0093f4Seschrock  * See the License for the specific language governing permissions
11*dc0093f4Seschrock  * and limitations under the License.
12*dc0093f4Seschrock  *
13*dc0093f4Seschrock  * When distributing Covered Code, include this CDDL HEADER in each
14*dc0093f4Seschrock  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15*dc0093f4Seschrock  * If applicable, add the following below this CDDL HEADER, with the
16*dc0093f4Seschrock  * fields enclosed by brackets "[]" replaced with your own identifying
17*dc0093f4Seschrock  * information: Portions Copyright [yyyy] [name of copyright owner]
18*dc0093f4Seschrock  *
19*dc0093f4Seschrock  * CDDL HEADER END
20*dc0093f4Seschrock  */
21*dc0093f4Seschrock 
22*dc0093f4Seschrock /*
23*dc0093f4Seschrock  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
24*dc0093f4Seschrock  * Use is subject to license terms.
25*dc0093f4Seschrock  */
26*dc0093f4Seschrock 
27*dc0093f4Seschrock #ifndef	_LIBDISASM_H
28*dc0093f4Seschrock #define	_LIBDISASM_H
29*dc0093f4Seschrock 
30*dc0093f4Seschrock #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*dc0093f4Seschrock 
32*dc0093f4Seschrock #include <sys/types.h>
33*dc0093f4Seschrock 
34*dc0093f4Seschrock #ifdef	__cplusplus
35*dc0093f4Seschrock extern "C" {
36*dc0093f4Seschrock #endif
37*dc0093f4Seschrock 
38*dc0093f4Seschrock typedef struct dis_handle dis_handle_t;
39*dc0093f4Seschrock 
40*dc0093f4Seschrock #define	DIS_DEFAULT		0x0
41*dc0093f4Seschrock 
42*dc0093f4Seschrock /* SPARC disassembler flags */
43*dc0093f4Seschrock #define	DIS_SPARC_V8		0x01
44*dc0093f4Seschrock #define	DIS_SPARC_V9		0x02
45*dc0093f4Seschrock #define	DIS_SPARC_V9_SGI	0x04
46*dc0093f4Seschrock 
47*dc0093f4Seschrock /* x86 diassembler flags (mutually exclusive) */
48*dc0093f4Seschrock #define	DIS_X86_SIZE16		0x08
49*dc0093f4Seschrock #define	DIS_X86_SIZE32		0x10
50*dc0093f4Seschrock #define	DIS_X86_SIZE64		0x20
51*dc0093f4Seschrock 
52*dc0093f4Seschrock /* generic disassembler flags */
53*dc0093f4Seschrock #define	DIS_OCTAL		0x40
54*dc0093f4Seschrock 
55*dc0093f4Seschrock typedef int (*dis_lookup_f)(void *, uint64_t, char *, size_t, uint64_t *,
56*dc0093f4Seschrock     size_t *);
57*dc0093f4Seschrock typedef int (*dis_read_f)(void *, uint64_t, void *, size_t);
58*dc0093f4Seschrock 
59*dc0093f4Seschrock extern dis_handle_t *dis_handle_create(int, void *, dis_lookup_f, dis_read_f);
60*dc0093f4Seschrock extern void dis_handle_destroy(dis_handle_t *);
61*dc0093f4Seschrock 
62*dc0093f4Seschrock extern int dis_disassemble(dis_handle_t *, uint64_t, char *, size_t);
63*dc0093f4Seschrock extern uint64_t dis_previnstr(dis_handle_t *, uint64_t, int n);
64*dc0093f4Seschrock extern void dis_set_data(dis_handle_t *, void *);
65*dc0093f4Seschrock extern int dis_max_instrlen(dis_handle_t *);
66*dc0093f4Seschrock 
67*dc0093f4Seschrock /* libdisasm errors */
68*dc0093f4Seschrock #define	E_DIS_NOMEM		1	/* Out of memory */
69*dc0093f4Seschrock #define	E_DIS_INVALFLAG		2	/* Invalid flag for this architecture */
70*dc0093f4Seschrock 
71*dc0093f4Seschrock extern int dis_errno(void);
72*dc0093f4Seschrock extern const char *dis_strerror(int);
73*dc0093f4Seschrock 
74*dc0093f4Seschrock #ifdef	__cplusplus
75*dc0093f4Seschrock }
76*dc0093f4Seschrock #endif
77*dc0093f4Seschrock 
78*dc0093f4Seschrock #endif	/* _LIBDISASM_H */
79