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 /* 23 * Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved. 24 * Copyright (c) 2013 by Delphix. All rights reserved. 25 * Copyright (c) 2012 Joyent, Inc. All rights reserved. 26 */ 27 28 #ifndef _MDB_MODAPI_H 29 #define _MDB_MODAPI_H 30 31 /* 32 * MDB Module API 33 * 34 * The debugger provides a set of interfaces for use in writing loadable 35 * debugger modules. Modules that call functions not listed in this header 36 * file may not be compatible with future versions of the debugger. 37 */ 38 39 #include <sys/types.h> 40 #include <sys/null.h> 41 #include <gelf.h> 42 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 /* 48 * Make sure that TRUE, FALSE, MIN, and MAX have the usual definitions 49 * so module writers can depend on these macros and defines. 50 * Make sure NULL is available to module writers by including <sys/null.h>. 51 */ 52 53 #ifndef TRUE 54 #define TRUE 1 55 #endif 56 57 #ifndef FALSE 58 #define FALSE 0 59 #endif 60 61 #ifndef MIN 62 #define MIN(x, y) ((x) < (y) ? (x) : (y)) 63 #endif 64 65 #ifndef MAX 66 #define MAX(x, y) ((x) > (y) ? (x) : (y)) 67 #endif 68 69 #define MDB_API_VERSION 4 /* Current API version number */ 70 71 /* 72 * Debugger command function flags: 73 */ 74 #define DCMD_ADDRSPEC 0x01 /* Dcmd invoked with explicit address */ 75 #define DCMD_LOOP 0x02 /* Dcmd invoked in loop with ,cnt syntax */ 76 #define DCMD_LOOPFIRST 0x04 /* Dcmd invoked as first iteration of LOOP */ 77 #define DCMD_PIPE 0x08 /* Dcmd invoked with input from pipe */ 78 #define DCMD_PIPE_OUT 0x10 /* Dcmd invoked with output set to pipe */ 79 80 #define DCMD_HDRSPEC(fl) (((fl) & DCMD_LOOPFIRST) || !((fl) & DCMD_LOOP)) 81 82 /* 83 * Debugger tab command function flags 84 */ 85 #define DCMD_TAB_SPACE 0x01 /* Tab cb invoked with trailing space */ 86 87 /* 88 * Debugger command function return values: 89 */ 90 #define DCMD_OK 0 /* Dcmd completed successfully */ 91 #define DCMD_ERR 1 /* Dcmd failed due to an error */ 92 #define DCMD_USAGE 2 /* Dcmd usage error; abort and print usage */ 93 #define DCMD_NEXT 3 /* Invoke next dcmd in precedence list */ 94 #define DCMD_ABORT 4 /* Dcmd failed; abort current loop or pipe */ 95 96 #define OFFSETOF(s, m) (size_t)(&(((s *)0)->m)) 97 98 extern int mdb_prop_postmortem; /* Are we looking at a static dump? */ 99 extern int mdb_prop_kernel; /* Are we looking at a kernel? */ 100 101 typedef enum { 102 MDB_TYPE_STRING, /* a_un.a_str is valid */ 103 MDB_TYPE_IMMEDIATE, /* a_un.a_val is valid */ 104 MDB_TYPE_CHAR /* a_un.a_char is valid */ 105 } mdb_type_t; 106 107 typedef struct mdb_arg { 108 mdb_type_t a_type; 109 union { 110 const char *a_str; 111 uintmax_t a_val; 112 char a_char; 113 } a_un; 114 } mdb_arg_t; 115 116 typedef struct mdb_tab_cookie mdb_tab_cookie_t; 117 typedef int mdb_dcmd_f(uintptr_t, uint_t, int, const mdb_arg_t *); 118 typedef int mdb_dcmd_tab_f(mdb_tab_cookie_t *, uint_t, int, 119 const mdb_arg_t *); 120 121 typedef struct mdb_dcmd { 122 const char *dc_name; /* Command name */ 123 const char *dc_usage; /* Usage message (optional) */ 124 const char *dc_descr; /* Description */ 125 mdb_dcmd_f *dc_funcp; /* Command function */ 126 void (*dc_help)(void); /* Command help function (or NULL) */ 127 mdb_dcmd_tab_f *dc_tabp; /* Tab completion function */ 128 } mdb_dcmd_t; 129 130 #define WALK_ERR -1 /* Walk fatal error (terminate walk) */ 131 #define WALK_NEXT 0 /* Walk should continue to next step */ 132 #define WALK_DONE 1 /* Walk is complete (no errors) */ 133 134 typedef int (*mdb_walk_cb_t)(uintptr_t, const void *, void *); 135 136 typedef struct mdb_walk_state { 137 mdb_walk_cb_t walk_callback; /* Callback to issue */ 138 void *walk_cbdata; /* Callback private data */ 139 uintptr_t walk_addr; /* Current address */ 140 void *walk_data; /* Walk private data */ 141 void *walk_arg; /* Walk private argument */ 142 const void *walk_layer; /* Data from underlying layer */ 143 } mdb_walk_state_t; 144 145 typedef struct mdb_walker { 146 const char *walk_name; /* Walk type name */ 147 const char *walk_descr; /* Walk description */ 148 int (*walk_init)(mdb_walk_state_t *); /* Walk constructor */ 149 int (*walk_step)(mdb_walk_state_t *); /* Walk iterator */ 150 void (*walk_fini)(mdb_walk_state_t *); /* Walk destructor */ 151 void *walk_init_arg; /* Walk constructor argument */ 152 } mdb_walker_t; 153 154 typedef struct mdb_modinfo { 155 ushort_t mi_dvers; /* Debugger version number */ 156 const mdb_dcmd_t *mi_dcmds; /* NULL-terminated list of dcmds */ 157 const mdb_walker_t *mi_walkers; /* NULL-terminated list of walks */ 158 } mdb_modinfo_t; 159 160 typedef struct mdb_bitmask { 161 const char *bm_name; /* String name to print */ 162 u_longlong_t bm_mask; /* Mask for bits */ 163 u_longlong_t bm_bits; /* Result required for value & mask */ 164 } mdb_bitmask_t; 165 166 typedef struct mdb_pipe { 167 uintptr_t *pipe_data; /* Array of pipe values */ 168 size_t pipe_len; /* Array length */ 169 } mdb_pipe_t; 170 171 typedef struct mdb_object { 172 const char *obj_name; /* name of object */ 173 const char *obj_fullname; /* full name of object */ 174 uintptr_t obj_base; /* base address of object */ 175 uintptr_t obj_size; /* in memory size of object in bytes */ 176 } mdb_object_t; 177 178 typedef struct mdb_symbol { 179 const char *sym_name; /* name of symbol */ 180 const char *sym_object; /* name of containing object */ 181 const GElf_Sym *sym_sym; /* ELF symbol information */ 182 uint_t sym_table; /* symbol table id */ 183 uint_t sym_id; /* symbol identifier */ 184 } mdb_symbol_t; 185 186 extern int mdb_pwalk(const char *, mdb_walk_cb_t, void *, uintptr_t); 187 extern int mdb_walk(const char *, mdb_walk_cb_t, void *); 188 189 extern int mdb_pwalk_dcmd(const char *, const char *, 190 int, const mdb_arg_t *, uintptr_t); 191 192 extern int mdb_walk_dcmd(const char *, const char *, int, const mdb_arg_t *); 193 194 extern int mdb_layered_walk(const char *, mdb_walk_state_t *); 195 196 extern int mdb_call_dcmd(const char *, uintptr_t, 197 uint_t, int, const mdb_arg_t *); 198 199 extern int mdb_add_walker(const mdb_walker_t *); 200 extern int mdb_remove_walker(const char *); 201 202 extern ssize_t mdb_vread(void *, size_t, uintptr_t); 203 extern ssize_t mdb_vwrite(const void *, size_t, uintptr_t); 204 205 extern ssize_t mdb_aread(void *, size_t, uintptr_t, void *); 206 extern ssize_t mdb_awrite(const void *, size_t, uintptr_t, void *); 207 208 extern ssize_t mdb_fread(void *, size_t, uintptr_t); 209 extern ssize_t mdb_fwrite(const void *, size_t, uintptr_t); 210 211 extern ssize_t mdb_pread(void *, size_t, uint64_t); 212 extern ssize_t mdb_pwrite(const void *, size_t, uint64_t); 213 214 extern ssize_t mdb_readstr(char *, size_t, uintptr_t); 215 extern ssize_t mdb_writestr(const char *, uintptr_t); 216 217 extern ssize_t mdb_readsym(void *, size_t, const char *); 218 extern ssize_t mdb_writesym(const void *, size_t, const char *); 219 220 extern ssize_t mdb_readvar(void *, const char *); 221 extern ssize_t mdb_writevar(const void *, const char *); 222 223 #define MDB_SYM_NAMLEN 1024 /* Recommended max name len */ 224 225 #define MDB_SYM_FUZZY 0 /* Match closest address */ 226 #define MDB_SYM_EXACT 1 /* Match exact address only */ 227 228 #define MDB_OBJ_EXEC ((const char *)0L) /* Primary executable file */ 229 #define MDB_OBJ_RTLD ((const char *)1L) /* Run-time link-editor */ 230 #define MDB_OBJ_EVERY ((const char *)-1L) /* All known symbols */ 231 232 extern int mdb_lookup_by_name(const char *, GElf_Sym *); 233 extern int mdb_lookup_by_obj(const char *, const char *, GElf_Sym *); 234 extern int mdb_lookup_by_addr(uintptr_t, uint_t, char *, size_t, GElf_Sym *); 235 236 typedef uintptr_t mdb_tid_t; 237 typedef uint64_t mdb_reg_t; 238 239 extern int mdb_getareg(mdb_tid_t, const char *, mdb_reg_t *); 240 241 #define MDB_OPT_SETBITS 1 /* Set specified flag bits */ 242 #define MDB_OPT_CLRBITS 2 /* Clear specified flag bits */ 243 #define MDB_OPT_STR 3 /* const char * argument */ 244 #define MDB_OPT_UINTPTR 4 /* uintptr_t argument */ 245 #define MDB_OPT_UINT64 5 /* uint64_t argument */ 246 #define MDB_OPT_UINTPTR_SET 6 /* boolean_t+uintptr_t args */ 247 248 extern int mdb_getopts(int, const mdb_arg_t *, ...); 249 250 extern u_longlong_t mdb_strtoull(const char *); 251 252 #define UM_NOSLEEP 0x0 /* Do not call failure handler; may fail */ 253 #define UM_SLEEP 0x1 /* Can block for memory; will always succeed */ 254 #define UM_GC 0x2 /* Garbage-collect this block automatically */ 255 256 extern void *mdb_alloc(size_t, uint_t); 257 extern void *mdb_zalloc(size_t, uint_t); 258 extern void mdb_free(void *, size_t); 259 260 extern size_t mdb_snprintf(char *, size_t, const char *, ...); 261 extern void mdb_printf(const char *, ...); 262 extern void mdb_warn(const char *, ...); 263 extern void mdb_flush(void); 264 265 extern int mdb_ffs(uintmax_t); 266 267 extern void mdb_nhconvert(void *, const void *, size_t); 268 269 #define MDB_DUMP_RELATIVE 0x0001 /* Start numbering at 0 */ 270 #define MDB_DUMP_ALIGN 0x0002 /* Enforce paragraph alignment */ 271 #define MDB_DUMP_PEDANT 0x0004 /* Full-width addresses */ 272 #define MDB_DUMP_ASCII 0x0008 /* Display ASCII values */ 273 #define MDB_DUMP_HEADER 0x0010 /* Display a header */ 274 #define MDB_DUMP_TRIM 0x0020 /* Trim at boundaries */ 275 #define MDB_DUMP_SQUISH 0x0040 /* Eliminate redundant lines */ 276 #define MDB_DUMP_NEWDOT 0x0080 /* Update dot when done */ 277 #define MDB_DUMP_ENDIAN 0x0100 /* Adjust for endianness */ 278 #define MDB_DUMP_WIDTH(x) ((((x) - 1) & 0xf) << 16) /* paragraphs/line */ 279 #define MDB_DUMP_GROUP(x) ((((x) - 1) & 0xff) << 20) /* bytes/group */ 280 281 typedef ssize_t (*mdb_dumpptr_cb_t)(void *, size_t, uintptr_t, void *); 282 typedef ssize_t (*mdb_dump64_cb_t)(void *, size_t, uint64_t, void *); 283 284 extern int mdb_dumpptr(uintptr_t, size_t, uint_t, mdb_dumpptr_cb_t, void *); 285 extern int mdb_dump64(uint64_t, uint64_t, uint_t, mdb_dump64_cb_t, void *); 286 287 extern const char *mdb_one_bit(int, int, int); 288 extern const char *mdb_inval_bits(int, int, int); 289 290 extern ulong_t mdb_inc_indent(ulong_t); 291 extern ulong_t mdb_dec_indent(ulong_t); 292 293 extern int mdb_eval(const char *); 294 extern void mdb_set_dot(uintmax_t); 295 extern uintmax_t mdb_get_dot(void); 296 297 extern void mdb_get_pipe(mdb_pipe_t *); 298 extern void mdb_set_pipe(const mdb_pipe_t *); 299 300 extern ssize_t mdb_get_xdata(const char *, void *, size_t); 301 302 typedef int (*mdb_object_cb_t)(mdb_object_t *, void *); 303 extern int mdb_object_iter(mdb_object_cb_t, void *); 304 305 #define MDB_SYMTAB 1 /* Normal symbol table (.symtab) */ 306 #define MDB_DYNSYM 2 /* Dynamic symbol table (.dynsym) */ 307 308 #define MDB_BIND_LOCAL 0x0001 /* Local (static-scope) symbols */ 309 #define MDB_BIND_GLOBAL 0x0002 /* Global symbols */ 310 #define MDB_BIND_WEAK 0x0004 /* Weak binding symbols */ 311 #define MDB_BIND_ANY 0x0007 /* Any of the above */ 312 313 #define MDB_TYPE_NOTYPE 0x0100 /* Symbol has no type */ 314 #define MDB_TYPE_OBJECT 0x0200 /* Symbol refers to data */ 315 #define MDB_TYPE_FUNC 0x0400 /* Symbol refers to text */ 316 #define MDB_TYPE_SECT 0x0800 /* Symbol refers to a section */ 317 #define MDB_TYPE_FILE 0x1000 /* Symbol refers to a source file */ 318 #define MDB_TYPE_COMMON 0x2000 /* Symbol refers to a common block */ 319 #define MDB_TYPE_TLS 0x4000 /* Symbol refers to TLS */ 320 321 #define MDB_TYPE_ANY 0x7f00 /* Any of the above */ 322 323 typedef int (*mdb_symbol_cb_t)(mdb_symbol_t *, void *); 324 extern int mdb_symbol_iter(const char *, uint_t, uint_t, mdb_symbol_cb_t, 325 void *); 326 327 #define MDB_STATE_IDLE 0 /* Target is idle (not running yet) */ 328 #define MDB_STATE_RUNNING 1 /* Target is currently executing */ 329 #define MDB_STATE_STOPPED 2 /* Target is stopped */ 330 #define MDB_STATE_UNDEAD 3 /* Target is undead (zombie) */ 331 #define MDB_STATE_DEAD 4 /* Target is dead (core dump) */ 332 #define MDB_STATE_LOST 5 /* Target lost by debugger */ 333 334 extern int mdb_get_state(void); 335 336 #define MDB_CALLBACK_STCHG 1 337 #define MDB_CALLBACK_PROMPT 2 338 339 typedef void (*mdb_callback_f)(void *); 340 341 extern void *mdb_callback_add(int, mdb_callback_f, void *); 342 extern void mdb_callback_remove(void *); 343 344 #define MDB_TABC_ALL_TYPES 0x1 /* Include array types in type output */ 345 #define MDB_TABC_MEMBERS 0x2 /* Tab comp. types with members */ 346 #define MDB_TABC_NOPOINT 0x4 /* Tab comp. everything but pointers */ 347 #define MDB_TABC_NOARRAY 0x8 /* Don't include array data in output */ 348 349 /* 350 * Module's interaction path 351 */ 352 extern void mdb_tab_insert(mdb_tab_cookie_t *, const char *); 353 extern void mdb_tab_setmbase(mdb_tab_cookie_t *, const char *); 354 355 /* 356 * Tab completion utility functions for modules. 357 */ 358 extern int mdb_tab_complete_type(mdb_tab_cookie_t *, const char *, uint_t); 359 extern int mdb_tab_complete_member(mdb_tab_cookie_t *, const char *, 360 const char *); 361 extern int mdb_tab_typename(int *, const mdb_arg_t **, char *buf, size_t len); 362 363 /* 364 * Tab completion functions for common signatures. 365 */ 366 extern int mdb_tab_complete_mt(mdb_tab_cookie_t *, uint_t, int, 367 const mdb_arg_t *); 368 369 extern size_t strlcat(char *, const char *, size_t); 370 extern char *strcat(char *, const char *); 371 extern char *strcpy(char *, const char *); 372 extern char *strncpy(char *, const char *, size_t); 373 374 /* Need to be consistent with <string.h> C++ definitions */ 375 #if __cplusplus >= 199711L 376 extern const char *strchr(const char *, int); 377 #ifndef _STRCHR_INLINE 378 #define _STRCHR_INLINE 379 extern "C++" { 380 inline char *strchr(char *__s, int __c) { 381 return (char *)strchr((const char *)__s, __c); 382 } 383 } 384 #endif /* _STRCHR_INLINE */ 385 extern const char *strrchr(const char *, int); 386 #ifndef _STRRCHR_INLINE 387 #define _STRRCHR_INLINE 388 extern "C++" { 389 inline char *strrchr(char *__s, int __c) { 390 return (char *)strrchr((const char *)__s, __c); 391 } 392 } 393 #endif /* _STRRCHR_INLINE */ 394 extern const char *strstr(const char *, const char *); 395 #ifndef _STRSTR_INLINE 396 #define _STRSTR_INLINE 397 extern "C++" { 398 inline char *strstr(char *__s1, const char *__s2) { 399 return (char *)strstr((const char *)__s1, __s2); 400 } 401 } 402 #endif /* _STRSTR_INLINE */ 403 #else 404 extern char *strchr(const char *, int); 405 extern char *strrchr(const char *, int); 406 extern char *strstr(const char *, const char *); 407 #endif /* __cplusplus >= 199711L */ 408 409 extern int strcmp(const char *, const char *); 410 extern int strncmp(const char *, const char *, size_t); 411 extern int strcasecmp(const char *, const char *); 412 extern int strncasecmp(const char *, const char *, size_t); 413 414 extern size_t strlen(const char *); 415 416 extern int bcmp(const void *, const void *, size_t); 417 extern void bcopy(const void *, void *, size_t); 418 extern void bzero(void *, size_t); 419 420 extern void *memcpy(void *, const void *, size_t); 421 extern void *memmove(void *, const void *, size_t); 422 extern int memcmp(const void *, const void *, size_t); 423 /* Need to be consistent with <string.h> C++ definitions */ 424 #if __cplusplus >= 199711L 425 extern const void *memchr(const void *, int, size_t); 426 #ifndef _MEMCHR_INLINE 427 #define _MEMCHR_INLINE 428 extern "C++" { 429 inline void *memchr(void * __s, int __c, size_t __n) { 430 return (void *)memchr((const void *)__s, __c, __n); 431 } 432 } 433 #endif /* _MEMCHR_INLINE */ 434 #else 435 extern void *memchr(const void *, int, size_t); 436 #endif /* __cplusplus >= 199711L */ 437 extern void *memset(void *, int, size_t); 438 extern void *memccpy(void *, const void *, int, size_t); 439 440 extern void *bsearch(const void *, const void *, size_t, size_t, 441 int (*)(const void *, const void *)); 442 443 extern void qsort(void *, size_t, size_t, 444 int (*)(const void *, const void *)); 445 446 #ifdef __cplusplus 447 } 448 #endif 449 450 #endif /* _MDB_MODAPI_H */ 451