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 * Copyright 2018 Joyent, Inc.
26 */
27
28#ifndef _KVM_H
29#define	_KVM_H
30
31/*
32 * The kmdb target
33 */
34
35#include <mdb/mdb_modapi.h>
36#include <mdb/mdb_target.h>
37#include <kmdb/kmdb_dpi.h>
38#include <kmdb/kvm_isadep.h>
39
40#include <sys/kobj.h>
41
42#ifdef __cplusplus
43extern "C" {
44#endif
45
46#define	KM_F_PRIMARY		1
47
48#define	KMT_TRAP_NOTENUM	-1	/* Glob for unnamed traps */
49#define	KMT_TRAP_ALL		-2	/* Glob for all traps */
50
51typedef struct kmt_module {
52	mdb_list_t	km_list;	/* List forward/back pointers */
53	char		*km_name;	/* Module name */
54	char		km_seen;
55	GElf_Ehdr	km_ehdr;
56
57	mdb_gelf_symtab_t *km_symtab;
58	Shdr		km_symtab_hdr;
59	Shdr		km_strtab_hdr;
60	const void	*km_symtab_va;
61	const void	*km_strtab_va;
62
63	uintptr_t	km_text_va;
64	size_t		km_text_size;
65	uintptr_t	km_data_va;
66	size_t		km_data_size;
67	uintptr_t	km_bss_va;
68	size_t		km_bss_size;
69	const void	*km_ctf_va;
70	size_t		km_ctf_size;
71
72	ctf_file_t	*km_ctfp;
73	struct modctl	km_modctl;
74	struct module	km_module;
75	int		km_flags;
76} kmt_module_t;
77
78typedef struct kmt_data {
79	const mdb_tgt_regdesc_t	*kmt_rds;	/* Register description table */
80	mdb_nv_t	kmt_modules;		/* Hash table of modules */
81	mdb_list_t	kmt_modlist;		/* List of mods in load order */
82	const char	*kmt_rtld_name;		/* Module containing krtld */
83	caddr_t		kmt_writemap;		/* Used to map PAs for writes */
84	size_t		kmt_writemapsz;		/* Size of same */
85	mdb_map_t	kmt_map;		/* Persistant map for callers */
86	ulong_t		*kmt_trapmap;
87	size_t		kmt_trapmax;
88	int		kmt_symavail;		/* Symbol resolution allowed */
89	uint_t		kmt_narmedbpts;		/* Number of armed brkpts */
90#if defined(__i386) || defined(__amd64)
91	struct {
92		GElf_Sym	_kmt_cmnint;
93		GElf_Sym	_kmt_cmntrap;
94		GElf_Sym	_kmt_sysenter;
95		GElf_Sym	_kmt_brand_sysenter;
96#if defined(__amd64)
97		GElf_Sym	_kmt_syscall;
98		GElf_Sym	_kmt_brand_syscall;
99#endif
100	} kmt_intrsyms;
101#endif
102} kmt_data_t;
103
104#if defined(__i386) || defined(__amd64)
105#define	kmt_cmnint	kmt_intrsyms._kmt_cmnint
106#define	kmt_cmntrap	kmt_intrsyms._kmt_cmntrap
107#endif
108
109typedef struct kmt_defbp {
110	mdb_list_t dbp_bplist;
111	char *dbp_objname;
112	char *dbp_symname;
113	int dbp_ref;
114} kmt_defbp_t;
115
116typedef struct kmt_brkpt {
117	uintptr_t kb_addr;			/* Breakpoint address */
118	mdb_instr_t kb_oinstr;			/* Replaced instruction */
119} kmt_brkpt_t;
120
121typedef struct kmt_bparg {
122	uintptr_t ka_addr;			/* Explicit address */
123	char *ka_symbol;			/* Symbolic name */
124	kmt_defbp_t *ka_defbp;
125} kmt_bparg_t;
126
127extern void kmt_printregs(const mdb_tgt_gregset_t *gregs);
128
129extern const char *kmt_def_dismode(void);
130
131extern void kmt_init_isadep(mdb_tgt_t *);
132extern void kmt_startup_isadep(mdb_tgt_t *);
133
134extern ssize_t kmt_write(mdb_tgt_t *, const void *, size_t, uintptr_t);
135extern ssize_t kmt_pwrite(mdb_tgt_t *, const void *, size_t, physaddr_t);
136extern ssize_t kmt_rw(mdb_tgt_t *, void *, size_t, uint64_t,
137    ssize_t (*)(void *, size_t, uint64_t));
138extern ssize_t kmt_writer(void *, size_t, uint64_t);
139extern ssize_t kmt_ioread(mdb_tgt_t *, void *, size_t, uintptr_t);
140extern ssize_t kmt_iowrite(mdb_tgt_t *, const void *, size_t, uintptr_t);
141
142extern int kmt_step_out(mdb_tgt_t *, uintptr_t *);
143extern int kmt_next(mdb_tgt_t *, uintptr_t *);
144
145extern int kmt_stack(uintptr_t, uint_t, int, const mdb_arg_t *);
146extern int kmt_stackv(uintptr_t, uint_t, int, const mdb_arg_t *);
147extern int kmt_stackr(uintptr_t, uint_t, int, const mdb_arg_t *);
148extern int kmt_cpustack(uintptr_t, uint_t, int, const mdb_arg_t *, int, int);
149
150extern const char *kmt_trapname(int);
151
152#ifdef __cplusplus
153}
154#endif
155
156#endif /* _KVM_H */
157