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) 2012 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 53 extern "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 0x00001 /* Print dot as symbol + offset when possible */ 80 #define MDB_FL_LOG 0x00002 /* Logging is enabled */ 81 #define MDB_FL_NOMODS 0x00004 /* Skip automatic mdb module loading */ 82 #define MDB_FL_USECUP 0x00008 /* Use terminal cup initialization sequences */ 83 #define MDB_FL_ADB 0x00010 /* Enable stricter adb(1) compatibility */ 84 #define MDB_FL_SHOWLMID 0x00020 /* Always show link map id with symbol names */ 85 #define MDB_FL_IGNEOF 0x00040 /* Ignore EOF as a synonym for ::quit */ 86 #define MDB_FL_REPLAST 0x00080 /* Naked newline repeats previous command */ 87 #define MDB_FL_PAGER 0x00100 /* Enable pager by default */ 88 #define MDB_FL_LATEST 0x00200 /* Replace version string with "latest" */ 89 #define MDB_FL_VCREATE 0x00400 /* Victim process was created by debugger */ 90 #define MDB_FL_JOBCTL 0x00800 /* Victim process jobctl stopped on same tty */ 91 #define MDB_FL_DEMANGLE 0x01000 /* Demangle symbols as part of %a processing */ 92 #define MDB_FL_EXEC 0x02000 /* Debugger exec'd by a previous instance */ 93 #define MDB_FL_NOCTF 0x04000 /* Skip automatic CTF data loading */ 94 #define MDB_FL_BPTNOSYMSTOP 0x08000 /* Stop on deferred bkpts for unk symbols */ 95 #define MDB_FL_TERMGUESS 0x10000 /* m_termtype derived from userland */ 96 #define MDB_FL_READBACK 0x20000 /* Read value back after write */ 97 #ifdef _KMDB 98 #define MDB_FL_NOUNLOAD 0x40000 /* Don't allow debugger unload */ 99 #endif 100 #define MDB_FL_LMRAW 0x80000 /* Show unresolved link map object names */ 101 102 #define MDB_FL_VOLATILE 0x0001 /* Mask of all volatile flags to save/restore */ 103 104 #define MDB_EM_ASK 0 /* Ask what to do on an exec */ 105 #define MDB_EM_STOP 1 /* Stop after an exec */ 106 #define MDB_EM_FOLLOW 2 /* Follow an exec */ 107 108 #define MDB_FM_ASK 0 /* Ask what to do on a fork */ 109 #define MDB_FM_PARENT 1 /* Follow parent process on a fork */ 110 #define MDB_FM_CHILD 2 /* Follow child process on a fork */ 111 112 #define MDB_PROMPTLEN 35 /* Maximum prompt length */ 113 114 struct kmdb_promif; 115 116 typedef struct mdb { 117 uint_t m_tgtflags; /* Target open flags (see mdb_target.h) */ 118 uint_t m_flags; /* Miscellaneous flags (see above) */ 119 uint_t m_debug; /* Debugging flags (see mdb_debug.h) */ 120 int m_radix; /* Default radix for output formatting */ 121 int m_nargs; /* Default number of arguments in stack trace */ 122 int m_histlen; /* Length of command history */ 123 size_t m_symdist; /* Distance from sym for addr match (0=smart) */ 124 const char *m_pname; /* Program basename from argv[0] */ 125 char m_promptraw[MDB_PROMPTLEN + 1]; /* Un-expanded prompt */ 126 char m_prompt[MDB_PROMPTLEN + 1]; /* Prompt for interactive mode */ 127 size_t m_promptlen; /* Length of prompt in bytes */ 128 const char *m_shell; /* Shell for ! commands and pipelines */ 129 char *m_root; /* Root for path construction */ 130 char *m_ipathstr; /* Path string for include path */ 131 char *m_lpathstr; /* Path string for library path */ 132 const char **m_ipath; /* Path for $< and $<< macro files */ 133 size_t m_ipathlen; /* Length of underlying ipath buffer */ 134 const char **m_lpath; /* Path for :: loadable modules */ 135 size_t m_lpathlen; /* Length of underlying lpath buffer */ 136 mdb_modinfo_t m_rminfo; /* Root debugger module information */ 137 mdb_module_t m_rmod; /* Root debugger module (builtins) */ 138 mdb_module_t *m_mhead; /* Head of module list (in load order) */ 139 mdb_module_t *m_mtail; /* Tail of module list (in load order) */ 140 mdb_list_t m_tgtlist; /* List of active target backends */ 141 mdb_tgt_t *m_target; /* Current debugger target backend */ 142 mdb_nv_t m_disasms; /* Hash of available disassemblers */ 143 mdb_disasm_t *m_disasm; /* Current disassembler backend */ 144 char *m_defdisasm; /* Deferred diassembler selection */ 145 mdb_nv_t m_modules; /* Name/value hash for loadable modules */ 146 mdb_nv_t m_dcmds; /* Name/value hash for extended commands */ 147 mdb_nv_t m_walkers; /* Name/value hash for walk operations */ 148 mdb_nv_t m_nv; /* Name/value hash for named variables */ 149 mdb_var_t *m_dot; /* Variable reference for '.' */ 150 uintmax_t m_incr; /* Current increment */ 151 uintmax_t m_raddr; /* Most recent address specified to a dcmd */ 152 uintmax_t m_dcount; /* Most recent count specified to a dcmd */ 153 mdb_var_t *m_rvalue; /* Most recent value printed */ 154 mdb_var_t *m_roffset; /* Most recent offset from an instruction */ 155 mdb_var_t *m_proffset; /* Previous value of m_roffset */ 156 mdb_var_t *m_rcount; /* Most recent count on $< dcmd */ 157 mdb_iob_t *m_in; /* Input stream */ 158 mdb_iob_t *m_out; /* Output stream */ 159 mdb_iob_t *m_err; /* Error stream */ 160 mdb_iob_t *m_null; /* Null stream */ 161 char *m_termtype; /* Interactive mode terminal type */ 162 mdb_io_t *m_term; /* Terminal for interactive mode */ 163 mdb_io_t *m_log; /* Log file i/o backend (NULL if not logging) */ 164 mdb_module_t *m_lmod; /* Pointer to loading module, if in load */ 165 mdb_list_t m_lastc; /* Last executed command list */ 166 mdb_gelf_symtab_t *m_prsym; /* Private symbol table */ 167 mdb_demangler_t *m_demangler; /* Demangler (see <mdb/mdb_demangle.h>) */ 168 mdb_list_t m_flist; /* Stack of execution frames */ 169 struct mdb_frame *volatile m_frame; /* Current stack frame */ 170 struct mdb_frame *volatile m_fmark; /* Stack marker for pager */ 171 uint_t m_fid; /* Next frame identifier number to assign */ 172 uint_t m_depth; /* Depth of m_frame stack */ 173 volatile uint_t m_intr; /* Don't allow SIGINT if set */ 174 volatile uint_t m_pend; /* Pending SIGINT count */ 175 pid_t m_pgid; /* Debugger process group id */ 176 uint_t m_rdvers; /* Librtld_db version number */ 177 uint_t m_ctfvers; /* Libctf version number */ 178 ulong_t m_armemlim; /* Limit on number of array members to print */ 179 ulong_t m_arstrlim; /* Limit on number of array chars to print */ 180 uchar_t m_execmode; /* Follow exec behavior */ 181 uchar_t m_forkmode; /* Follow fork behavior */ 182 char **m_env; /* Current environment */ 183 mdb_list_t m_cblist; /* List of callbacks */ 184 mdb_nv_t m_macaliases; /* Name/value hash of ADB macro aliases */ 185 ctf_file_t *m_synth; /* Container for synthetic types */ 186 int m_lastret; /* Result of running the last command */ 187 #ifdef _KMDB 188 struct dpi_ops *m_dpi; /* DPI ops vector */ 189 struct kdi *m_kdi; /* KDI ops vector */ 190 size_t m_pagesize; /* Base page size for this machine */ 191 caddr_t m_dseg; /* Debugger segment address */ 192 size_t m_dsegsz; /* Debugger segment size */ 193 mdb_nv_t m_dmodctl; /* dmod name -> kmdb_modctl hash */ 194 kmdb_wr_t *m_drvwrhead; /* Driver work request queue */ 195 kmdb_wr_t *m_drvwrtail; /* Driver work request queue */ 196 kmdb_wr_t *m_dbgwrhead; /* Debugger request queue */ 197 kmdb_wr_t *m_dbgwrtail; /* Debugger request queue */ 198 struct cons_polledio *m_pio; /* Polled I/O struct from kernel */ 199 struct kmdb_promif *m_promif; /* Debugger/PROM interface state */ 200 #endif 201 } mdb_t; 202 203 #ifdef _MDB_PRIVATE 204 mdb_t mdb; 205 #else 206 extern mdb_t mdb; 207 #endif 208 209 #ifdef _MDB 210 211 #define MDB_CONFIG_ENV_VAR "_MDB_CONFIG" 212 213 extern void mdb_create(const char *, const char *); 214 extern void mdb_destroy(void); 215 216 extern int mdb_call_idcmd(mdb_idcmd_t *, uintmax_t, uintmax_t, uint_t, 217 mdb_argvec_t *, mdb_addrvec_t *, mdb_vcb_t *); 218 extern void mdb_call_tab(mdb_idcmd_t *, mdb_tab_cookie_t *, uint_t, uintmax_t, 219 mdb_arg_t *); 220 221 extern int mdb_call(uintmax_t, uintmax_t, uint_t); 222 extern int mdb_run(void); 223 224 extern const char *mdb_get_prompt(void); 225 extern int mdb_set_prompt(const char *); 226 extern void mdb_set_ipath(const char *); 227 extern void mdb_set_lpath(const char *); 228 229 extern const char **mdb_path_alloc(const char *, size_t *); 230 extern const char **mdb_path_dup(const char *[], size_t, size_t *); 231 extern void mdb_path_free(const char *[], size_t); 232 233 extern uintmax_t mdb_dot_incr(const char *); 234 extern uintmax_t mdb_dot_decr(const char *); 235 236 extern mdb_iwalker_t *mdb_walker_lookup(const char *); 237 extern mdb_idcmd_t *mdb_dcmd_lookup(const char *); 238 extern void mdb_dcmd_usage(const mdb_idcmd_t *, mdb_iob_t *); 239 240 extern void mdb_pservice_init(void); 241 242 extern void mdb_intr_enable(void); 243 extern void mdb_intr_disable(void); 244 245 extern char *mdb_get_config(void); 246 extern void mdb_set_config(const char *); 247 248 extern mdb_module_t *mdb_get_module(void); 249 250 #endif /* _MDB */ 251 252 #ifdef __cplusplus 253 } 254 #endif 255 256 #endif /* _MDB_H */ 257