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 */
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
35extern "C" {
36#endif
37
38typedef 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#define	DIS_SPARC_V9_OPL	0x08
47
48/* x86 diassembler flags (mutually exclusive) */
49#define	DIS_X86_SIZE16		0x08
50#define	DIS_X86_SIZE32		0x10
51#define	DIS_X86_SIZE64		0x20
52
53/* generic disassembler flags */
54#define	DIS_OCTAL		0x40
55#define	DIS_NOIMMSYM		0x80
56
57typedef int (*dis_lookup_f)(void *, uint64_t, char *, size_t, uint64_t *,
58    size_t *);
59typedef int (*dis_read_f)(void *, uint64_t, void *, size_t);
60
61extern dis_handle_t *dis_handle_create(int, void *, dis_lookup_f, dis_read_f);
62extern void dis_handle_destroy(dis_handle_t *);
63
64extern int dis_disassemble(dis_handle_t *, uint64_t, char *, size_t);
65extern uint64_t dis_previnstr(dis_handle_t *, uint64_t, int n);
66extern void dis_set_data(dis_handle_t *, void *);
67extern void dis_flags_set(dis_handle_t *, int f);
68extern void dis_flags_clear(dis_handle_t *, int f);
69extern int dis_max_instrlen(dis_handle_t *);
70
71/* libdisasm errors */
72#define	E_DIS_NOMEM		1	/* Out of memory */
73#define	E_DIS_INVALFLAG		2	/* Invalid flag for this architecture */
74
75extern int dis_errno(void);
76extern const char *dis_strerror(int);
77
78#ifdef	__cplusplus
79}
80#endif
81
82#endif	/* _LIBDISASM_H */
83