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