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 2008 Sun Microsystems, Inc.  All rights reserved.
23 * Use is subject to license terms.
24 */
25
26/*
27 * Copyright (c) 2012 by Delphix. All rights reserved.
28 * Copyright (c) 2017 Joyent, Inc. All rights reserved.
29 */
30
31#ifndef	_MDB_H
32#define	_MDB_H
33
34#include <mdb/mdb_nv.h>
35#include <mdb/mdb_io.h>
36#include <mdb/mdb_gelf.h>
37#include <mdb/mdb_addrvec.h>
38#include <mdb/mdb_argvec.h>
39#include <mdb/mdb_target.h>
40#include <mdb/mdb_disasm.h>
41#include <mdb/mdb_demangle.h>
42#include <mdb/mdb_module.h>
43#include <mdb/mdb_modapi.h>
44#include <mdb/mdb_list.h>
45#include <mdb/mdb_vcb.h>
46#include <mdb/mdb_ctf.h>
47#include <mdb/mdb_tab.h>
48#ifdef _KMDB
49#include <kmdb/kmdb_wr.h>
50#endif
51
52#ifdef	__cplusplus
53extern "C" {
54#endif
55
56#define	MDB_ERR_PARSE	1	/* Error occurred in lexer or parser */
57#define	MDB_ERR_NOMEM	2	/* Failed to allocate needed memory */
58#define	MDB_ERR_PAGER	3	/* User quit current command from pager */
59#define	MDB_ERR_SIGINT	4	/* User interrupt: abort current command */
60#define	MDB_ERR_QUIT	5	/* User request: quit debugger */
61#define	MDB_ERR_ASSERT	6	/* Assertion failure: abort current command */
62#define	MDB_ERR_API	7	/* API function error: abort current command */
63#define	MDB_ERR_ABORT	8	/* User abort or resume: abort to top level */
64#define	MDB_ERR_OUTPUT	9	/* Write to m_out failed: abort to top level */
65
66#define	MDB_ERR_IS_FATAL(err)	\
67	((err) == MDB_ERR_QUIT || (err) == MDB_ERR_ABORT || \
68	(err) == MDB_ERR_OUTPUT)
69
70#define	MDB_DEF_RADIX	16	/* Default output radix */
71#define	MDB_DEF_NARGS	6	/* Default # of arguments in stack trace */
72#define	MDB_DEF_HISTLEN	128	/* Default length of command history */
73#define	MDB_DEF_SYMDIST	0x8000	/* Default symbol distance for addresses */
74#define	MDB_DEF_ARRMEM	32	/* Default number of array members to print */
75#define	MDB_DEF_ARRSTR	1024	/* Default number of array chars to print */
76
77#define	MDB_ARR_NOLIMIT	-1UL	/* No limit on number of array elements */
78
79#define	MDB_FL_PSYM	0x000001	/* Print dot as symbol + offset */
80#define	MDB_FL_LOG	0x000002	/* Logging is enabled */
81#define	MDB_FL_NOMODS	0x000004	/* Skip automatic mdb module loading */
82#define	MDB_FL_USECUP	0x000008	/* Use term cup init sequences */
83#define	MDB_FL_ADB	0x000010	/* Enable stricter adb(1) compat */
84#define	MDB_FL_SHOWLMID	0x000020	/* Show link map id with symbol names */
85#define	MDB_FL_IGNEOF	0x000040	/* Ignore EOF as a synonym for ::quit */
86#define	MDB_FL_REPLAST	0x000080	/* Naked newline repeats prev command */
87#define	MDB_FL_PAGER	0x000100	/* Enable pager by default */
88#define	MDB_FL_LATEST	0x000200	/* Replace verstring with "latest" */
89#define	MDB_FL_VCREATE	0x000400	/* Victim process created by debugger */
90#define	MDB_FL_JOBCTL	0x000800	/* Victim process jobctl on same tty */
91#define	MDB_FL_DEMANGLE	0x001000	/* Demangle symbols as part of %a */
92#define	MDB_FL_EXEC	0x002000	/* Debugger exec'd by a prev instance */
93#define	MDB_FL_NOCTF	0x004000	/* Skip automatic CTF data loading */
94#define	MDB_FL_BPTNOSYMSTOP 0x008000	/* Stop on def bkpts for unk symbols */
95#define	MDB_FL_TERMGUESS 0x010000	/* m_termtype derived from userland */
96#define	MDB_FL_READBACK	0x020000	/* Read value back after write */
97#ifdef _KMDB
98#define	MDB_FL_NOUNLOAD	0x040000	/* Don't allow debugger unload */
99#endif
100#define	MDB_FL_LMRAW	0x080000	/* Show unres link map object names */
101#define	MDB_FL_AUTOWRAP	0x100000	/* Autowrap lines at term width */
102
103#define	MDB_FL_VOLATILE	0x0001	/* Mask of all volatile flags to save/restore */
104
105#define	MDB_EM_ASK	0	/* Ask what to do on an exec */
106#define	MDB_EM_STOP	1	/* Stop after an exec */
107#define	MDB_EM_FOLLOW	2	/* Follow an exec */
108
109#define	MDB_FM_ASK	0	/* Ask what to do on a fork */
110#define	MDB_FM_PARENT	1	/* Follow parent process on a fork */
111#define	MDB_FM_CHILD	2	/* Follow child process on a fork */
112
113#define	MDB_PROMPTLEN	35	/* Maximum prompt length */
114
115struct kmdb_promif;
116
117typedef struct mdb {
118	uint_t m_tgtflags;	/* Target open flags (see mdb_target.h) */
119	uint_t m_flags;		/* Miscellaneous flags (see above) */
120	uint_t m_debug;		/* Debugging flags (see mdb_debug.h) */
121	int m_radix;		/* Default radix for output formatting */
122	int m_nargs;		/* Default number of arguments in stack trace */
123	int m_histlen;		/* Length of command history */
124	size_t m_symdist;	/* Distance from sym for addr match (0=smart) */
125	const char *m_pname;	/* Program basename from argv[0] */
126	char m_promptraw[MDB_PROMPTLEN + 1]; /* Un-expanded prompt */
127	char m_prompt[MDB_PROMPTLEN + 1]; /* Prompt for interactive mode */
128	size_t m_promptlen;	/* Length of prompt in bytes */
129	const char *m_shell;	/* Shell for ! commands and pipelines */
130	char *m_root;		/* Root for path construction */
131	char *m_ipathstr;	/* Path string for include path */
132	char *m_lpathstr;	/* Path string for library path */
133	const char **m_ipath;	/* Path for $< and $<< macro files */
134	size_t m_ipathlen;	/* Length of underlying ipath buffer */
135	const char **m_lpath;	/* Path for :: loadable modules */
136	size_t m_lpathlen;	/* Length of underlying lpath buffer */
137	mdb_modinfo_t m_rminfo;	/* Root debugger module information */
138	mdb_module_t m_rmod;	/* Root debugger module (builtins) */
139	mdb_module_t *m_mhead;	/* Head of module list (in load order) */
140	mdb_module_t *m_mtail;	/* Tail of module list (in load order) */
141	mdb_list_t m_tgtlist;	/* List of active target backends */
142	mdb_tgt_t *m_target;	/* Current debugger target backend */
143	mdb_nv_t m_disasms;	/* Hash of available disassemblers */
144	mdb_disasm_t *m_disasm;	/* Current disassembler backend */
145	char *m_defdisasm;	/* Deferred diassembler selection */
146	mdb_nv_t m_modules;	/* Name/value hash for loadable modules */
147	mdb_nv_t m_dcmds;	/* Name/value hash for extended commands */
148	mdb_nv_t m_walkers;	/* Name/value hash for walk operations */
149	mdb_nv_t m_nv;		/* Name/value hash for named variables */
150	mdb_var_t *m_dot;	/* Variable reference for '.' */
151	uintmax_t m_incr;	/* Current increment */
152	uintmax_t m_raddr;	/* Most recent address specified to a dcmd */
153	uintmax_t m_dcount;	/* Most recent count specified to a dcmd */
154	mdb_var_t *m_rvalue;	/* Most recent value printed */
155	mdb_var_t *m_roffset;	/* Most recent offset from an instruction */
156	mdb_var_t *m_proffset;	/* Previous value of m_roffset */
157	mdb_var_t *m_rcount;	/* Most recent count on $< dcmd */
158	mdb_iob_t *m_in;	/* Input stream */
159	mdb_iob_t *m_out;	/* Output stream */
160	mdb_iob_t *m_err;	/* Error stream */
161	mdb_iob_t *m_null;	/* Null stream */
162	char *m_termtype;	/* Interactive mode terminal type */
163	mdb_io_t *m_term;	/* Terminal for interactive mode */
164	mdb_io_t *m_log;	/* Log file i/o backend (NULL if not logging) */
165	mdb_module_t *m_lmod;	/* Pointer to loading module, if in load */
166	mdb_list_t m_lastc;	/* Last executed command list */
167	mdb_gelf_symtab_t *m_prsym;   /* Private symbol table */
168	mdb_demangler_t *m_demangler; /* Demangler (see <mdb/mdb_demangle.h>) */
169	mdb_list_t m_flist;	/* Stack of execution frames */
170	struct mdb_frame *volatile m_frame; /* Current stack frame */
171	struct mdb_frame *volatile m_fmark; /* Stack marker for pager */
172	uint_t m_fid;		/* Next frame identifier number to assign */
173	uint_t m_depth;		/* Depth of m_frame stack */
174	volatile uint_t m_intr;	/* Don't allow SIGINT if set */
175	volatile uint_t m_pend;	/* Pending SIGINT count */
176	pid_t m_pgid;		/* Debugger process group id */
177	uint_t m_rdvers;	/* Librtld_db version number */
178	uint_t m_ctfvers;	/* Libctf version number */
179	ulong_t m_armemlim;	/* Limit on number of array members to print */
180	ulong_t m_arstrlim;	/* Limit on number of array chars to print */
181	uchar_t m_execmode;	/* Follow exec behavior */
182	uchar_t m_forkmode;	/* Follow fork behavior */
183	char **m_env;		/* Current environment */
184	mdb_list_t m_cblist;	/* List of callbacks */
185	mdb_nv_t m_macaliases;	/* Name/value hash of ADB macro aliases */
186	ctf_file_t *m_synth;	/* Container for synthetic types */
187	int m_lastret;		/* Result of running the last command */
188#ifdef _KMDB
189	struct dpi_ops *m_dpi;	/* DPI ops vector */
190	struct kdi *m_kdi;	/* KDI ops vector */
191	size_t m_pagesize;	/* Base page size for this machine */
192	caddr_t m_dseg;		/* Debugger segment address */
193	size_t m_dsegsz;	/* Debugger segment size */
194	mdb_nv_t m_dmodctl;	/* dmod name -> kmdb_modctl hash */
195	kmdb_wr_t *m_drvwrhead;	/* Driver work request queue */
196	kmdb_wr_t *m_drvwrtail;	/* Driver work request queue */
197	kmdb_wr_t *m_dbgwrhead;	/* Debugger request queue */
198	kmdb_wr_t *m_dbgwrtail;	/* Debugger request queue */
199	struct cons_polledio *m_pio; /* Polled I/O struct from kernel */
200	struct kmdb_promif *m_promif; /* Debugger/PROM interface state */
201#endif
202} mdb_t;
203
204#ifdef _MDB_PRIVATE
205mdb_t mdb;
206#else
207extern mdb_t mdb;
208#endif
209
210#ifdef _MDB
211
212#define	MDB_CONFIG_ENV_VAR "_MDB_CONFIG"
213
214extern void mdb_create(const char *, const char *);
215extern void mdb_destroy(void);
216
217extern int mdb_call_idcmd(mdb_idcmd_t *, uintmax_t, uintmax_t, uint_t,
218    mdb_argvec_t *, mdb_addrvec_t *, mdb_vcb_t *);
219extern void mdb_call_tab(mdb_idcmd_t *, mdb_tab_cookie_t *, uint_t, uintmax_t,
220    mdb_arg_t *);
221
222extern int mdb_call(uintmax_t, uintmax_t, uint_t);
223extern int mdb_run(void);
224
225extern const char *mdb_get_prompt(void);
226extern int mdb_set_prompt(const char *);
227extern void mdb_set_ipath(const char *);
228extern void mdb_set_lpath(const char *);
229
230extern const char **mdb_path_alloc(const char *, size_t *);
231extern const char **mdb_path_dup(const char *[], size_t, size_t *);
232extern void mdb_path_free(const char *[], size_t);
233
234extern uintmax_t mdb_dot_incr(const char *);
235extern uintmax_t mdb_dot_decr(const char *);
236
237extern mdb_iwalker_t *mdb_walker_lookup(const char *);
238extern mdb_idcmd_t *mdb_dcmd_lookup(const char *);
239extern void mdb_dcmd_usage(const mdb_idcmd_t *, mdb_iob_t *);
240
241extern void mdb_pservice_init(void);
242
243extern void mdb_intr_enable(void);
244extern void mdb_intr_disable(void);
245
246extern char *mdb_get_config(void);
247extern void mdb_set_config(const char *);
248
249extern mdb_module_t *mdb_get_module(void);
250
251#endif /* _MDB */
252
253#ifdef	__cplusplus
254}
255#endif
256
257#endif	/* _MDB_H */
258