xref: /illumos-gate/usr/src/cmd/mdb/common/kmdb/kmdb_kdi.h (revision 9164a50bf932130cbb5097a16f6986873ce0e6e5)
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  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _KMDB_KDI_H
27 #define	_KMDB_KDI_H
28 
29 #include <sys/types.h>
30 #include <sys/kdi.h>
31 #include <sys/modctl.h>
32 #include <gelf.h>
33 
34 #include <kmdb/kmdb_auxv.h>
35 #include <mdb/mdb_target.h>
36 #include <kmdb/kmdb_kdi_isadep.h>
37 
38 /*
39  * The following directive tells the mapfile generator that only those
40  * prototypes and declarations ending with a "Driver OK" comment should be
41  * included in the mapfile.
42  *
43  * MAPFILE: export "Driver OK"
44  */
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 struct module;
51 
52 /*
53  * KDI initialization
54  */
55 extern void kmdb_kdi_init(kdi_t *, kmdb_auxv_t *);
56 extern void kmdb_kdi_init_isadep(kdi_t *, kmdb_auxv_t *);
57 extern void kmdb_kdi_end_init(void);
58 
59 /*
60  * Debugger -> Kernel functions for use when the kernel is stopped
61  */
62 extern int kmdb_kdi_mods_changed(void);
63 extern int kmdb_kdi_mod_iter(int (*)(struct modctl *, void *), void *);
64 extern int kmdb_kdi_mod_isloaded(struct modctl *);
65 extern int kmdb_kdi_mod_haschanged(struct modctl *, struct module *,
66     struct modctl *, struct module *);
67 extern ssize_t kmdb_kdi_pread(void *, size_t, physaddr_t);
68 extern ssize_t kmdb_kdi_pwrite(void *, size_t, physaddr_t);
69 extern void kmdb_kdi_stop_slaves(int, int);
70 extern void kmdb_kdi_start_slaves(void);
71 extern void kmdb_kdi_slave_wait(void);
72 extern void kmdb_kdi_kmdb_enter(void);	/* Driver OK */
73 extern void kmdb_kdi_system_claim(void);
74 extern void kmdb_kdi_system_release(void);
75 extern size_t kmdb_kdi_range_is_nontoxic(uintptr_t, size_t, int);
76 extern void kmdb_kdi_flush_caches(void);
77 extern struct cons_polledio *kmdb_kdi_get_polled_io(void);
78 extern int kmdb_kdi_vtop(uintptr_t, physaddr_t *);
79 extern kdi_dtrace_state_t kmdb_kdi_dtrace_get_state(void);
80 extern int kmdb_kdi_dtrace_set(int);
81 
82 /*
83  * Driver -> Debugger notifications
84  */
85 
86 extern int kmdb_kdi_get_unload_request(void);			/* Driver OK */
87 extern void kmdb_kdi_set_unload_request(void);			/* Driver OK */
88 
89 #define	KMDB_KDI_FL_NOMODS		0x1
90 #define	KMDB_KDI_FL_NOCTF		0x2
91 
92 extern int kmdb_kdi_get_flags(void);				/* Driver OK */
93 
94 /*
95  * Debugger -> Kernel functions for use only when the kernel is running
96  */
97 extern uintptr_t kmdb_kdi_lookup_by_name(char *, char *);
98 
99 #ifdef __cplusplus
100 }
101 #endif
102 
103 #endif /* _KMDB_KDI_H */
104