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 2009 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 /* 27 * Copyright (c) 2012, 2014 by Delphix. All rights reserved. 28 * Copyright (c) 2012 Joyent, Inc. All rights reserved. 29 * Copyright (c) 2014 Nexenta Systems, Inc. All rights reserved. 30 */ 31 32 #include <mdb/mdb_modapi.h> 33 #include <mdb/mdb_target.h> 34 #include <mdb/mdb_argvec.h> 35 #include <mdb/mdb_string.h> 36 #include <mdb/mdb_stdlib.h> 37 #include <mdb/mdb_err.h> 38 #include <mdb/mdb_debug.h> 39 #include <mdb/mdb_fmt.h> 40 #include <mdb/mdb_ctf.h> 41 #include <mdb/mdb_ctf_impl.h> 42 #include <mdb/mdb.h> 43 #include <mdb/mdb_tab.h> 44 45 #include <sys/isa_defs.h> 46 #include <sys/param.h> 47 #include <sys/sysmacros.h> 48 #include <netinet/in.h> 49 #include <strings.h> 50 #include <libctf.h> 51 #include <ctype.h> 52 53 typedef struct holeinfo { 54 ulong_t hi_offset; /* expected offset */ 55 uchar_t hi_isunion; /* represents a union */ 56 } holeinfo_t; 57 58 typedef struct printarg { 59 mdb_tgt_t *pa_tgt; /* current target */ 60 mdb_tgt_t *pa_realtgt; /* real target (for -i) */ 61 mdb_tgt_t *pa_immtgt; /* immediate target (for -i) */ 62 mdb_tgt_as_t pa_as; /* address space to use for i/o */ 63 mdb_tgt_addr_t pa_addr; /* base address for i/o */ 64 ulong_t pa_armemlim; /* limit on array elements to print */ 65 ulong_t pa_arstrlim; /* limit on array chars to print */ 66 const char *pa_delim; /* element delimiter string */ 67 const char *pa_prefix; /* element prefix string */ 68 const char *pa_suffix; /* element suffix string */ 69 holeinfo_t *pa_holes; /* hole detection information */ 70 int pa_nholes; /* size of holes array */ 71 int pa_flags; /* formatting flags (see below) */ 72 int pa_depth; /* previous depth */ 73 int pa_nest; /* array nesting depth */ 74 int pa_tab; /* tabstop width */ 75 uint_t pa_maxdepth; /* Limit max depth */ 76 uint_t pa_nooutdepth; /* don't print output past this depth */ 77 } printarg_t; 78 79 #define PA_SHOWTYPE 0x001 /* print type name */ 80 #define PA_SHOWBASETYPE 0x002 /* print base type name */ 81 #define PA_SHOWNAME 0x004 /* print member name */ 82 #define PA_SHOWADDR 0x008 /* print address */ 83 #define PA_SHOWVAL 0x010 /* print value */ 84 #define PA_SHOWHOLES 0x020 /* print holes in structs */ 85 #define PA_INTHEX 0x040 /* print integer values in hex */ 86 #define PA_INTDEC 0x080 /* print integer values in decimal */ 87 #define PA_NOSYMBOLIC 0x100 /* don't print ptrs as func+offset */ 88 89 #define IS_CHAR(e) \ 90 (((e).cte_format & (CTF_INT_CHAR | CTF_INT_SIGNED)) == \ 91 (CTF_INT_CHAR | CTF_INT_SIGNED) && (e).cte_bits == NBBY) 92 93 #define COMPOSITE_MASK ((1 << CTF_K_STRUCT) | \ 94 (1 << CTF_K_UNION) | (1 << CTF_K_ARRAY)) 95 #define IS_COMPOSITE(k) (((1 << k) & COMPOSITE_MASK) != 0) 96 97 #define SOU_MASK ((1 << CTF_K_STRUCT) | (1 << CTF_K_UNION)) 98 #define IS_SOU(k) (((1 << k) & SOU_MASK) != 0) 99 100 #define MEMBER_DELIM_ERR -1 101 #define MEMBER_DELIM_DONE 0 102 #define MEMBER_DELIM_PTR 1 103 #define MEMBER_DELIM_DOT 2 104 #define MEMBER_DELIM_LBR 3 105 106 typedef int printarg_f(const char *, const char *, 107 mdb_ctf_id_t, mdb_ctf_id_t, ulong_t, printarg_t *); 108 109 static int elt_print(const char *, mdb_ctf_id_t, mdb_ctf_id_t, ulong_t, int, 110 void *); 111 static void print_close_sou(printarg_t *, int); 112 113 /* 114 * Given an address, look up the symbol ID of the specified symbol in its 115 * containing module. We only support lookups for exact matches. 116 */ 117 static const char * 118 addr_to_sym(mdb_tgt_t *t, uintptr_t addr, char *name, size_t namelen, 119 GElf_Sym *symp, mdb_syminfo_t *sip) 120 { 121 const mdb_map_t *mp; 122 const char *p; 123 124 if (mdb_tgt_lookup_by_addr(t, addr, MDB_TGT_SYM_EXACT, name, 125 namelen, NULL, NULL) == -1) 126 return (NULL); /* address does not exactly match a symbol */ 127 128 if ((p = strrsplit(name, '`')) != NULL) { 129 if (mdb_tgt_lookup_by_name(t, name, p, symp, sip) == -1) 130 return (NULL); 131 return (p); 132 } 133 134 if ((mp = mdb_tgt_addr_to_map(t, addr)) == NULL) 135 return (NULL); /* address does not fall within a mapping */ 136 137 if (mdb_tgt_lookup_by_name(t, mp->map_name, name, symp, sip) == -1) 138 return (NULL); 139 140 return (name); 141 } 142 143 /* 144 * This lets dcmds be a little fancy with their processing of type arguments 145 * while still treating them more or less as a single argument. 146 * For example, if a command is invokes like this: 147 * 148 * ::<dcmd> proc_t ... 149 * 150 * this function will just copy "proc_t" into the provided buffer. If the 151 * command is instead invoked like this: 152 * 153 * ::<dcmd> struct proc ... 154 * 155 * this function will place the string "struct proc" into the provided buffer 156 * and increment the caller's argv and argc. This allows the caller to still 157 * treat the type argument logically as it would an other atomic argument. 158 */ 159 int 160 args_to_typename(int *argcp, const mdb_arg_t **argvp, char *buf, size_t len) 161 { 162 int argc = *argcp; 163 const mdb_arg_t *argv = *argvp; 164 165 if (argc < 1 || argv->a_type != MDB_TYPE_STRING) 166 return (DCMD_USAGE); 167 168 if (strcmp(argv->a_un.a_str, "struct") == 0 || 169 strcmp(argv->a_un.a_str, "enum") == 0 || 170 strcmp(argv->a_un.a_str, "union") == 0) { 171 if (argc <= 1) { 172 mdb_warn("%s is not a valid type\n", argv->a_un.a_str); 173 return (DCMD_ABORT); 174 } 175 176 if (argv[1].a_type != MDB_TYPE_STRING) 177 return (DCMD_USAGE); 178 179 (void) mdb_snprintf(buf, len, "%s %s", 180 argv[0].a_un.a_str, argv[1].a_un.a_str); 181 182 *argcp = argc - 1; 183 *argvp = argv + 1; 184 } else { 185 (void) mdb_snprintf(buf, len, "%s", argv[0].a_un.a_str); 186 } 187 188 return (0); 189 } 190 191 /*ARGSUSED*/ 192 int 193 cmd_sizeof(uintptr_t addr, uint_t flags, int argc, const mdb_arg_t *argv) 194 { 195 mdb_ctf_id_t id; 196 char tn[MDB_SYM_NAMLEN]; 197 int ret; 198 199 if (flags & DCMD_ADDRSPEC) 200 return (DCMD_USAGE); 201 202 if ((ret = args_to_typename(&argc, &argv, tn, sizeof (tn))) != 0) 203 return (ret); 204 205 if (argc != 1) 206 return (DCMD_USAGE); 207 208 if (mdb_ctf_lookup_by_name(tn, &id) != 0) { 209 mdb_warn("failed to look up type %s", tn); 210 return (DCMD_ERR); 211 } 212 213 if (flags & DCMD_PIPE_OUT) 214 mdb_printf("%#lr\n", mdb_ctf_type_size(id)); 215 else 216 mdb_printf("sizeof (%s) = %#lr\n", tn, mdb_ctf_type_size(id)); 217 218 return (DCMD_OK); 219 } 220 221 int 222 cmd_sizeof_tab(mdb_tab_cookie_t *mcp, uint_t flags, int argc, 223 const mdb_arg_t *argv) 224 { 225 char tn[MDB_SYM_NAMLEN]; 226 int ret; 227 228 if (argc == 0 && !(flags & DCMD_TAB_SPACE)) 229 return (0); 230 231 if (argc == 0 && (flags & DCMD_TAB_SPACE)) 232 return (mdb_tab_complete_type(mcp, NULL, MDB_TABC_NOPOINT)); 233 234 if ((ret = mdb_tab_typename(&argc, &argv, tn, sizeof (tn))) < 0) 235 return (ret); 236 237 if (argc == 1) 238 return (mdb_tab_complete_type(mcp, tn, MDB_TABC_NOPOINT)); 239 240 return (0); 241 } 242 243 /*ARGSUSED*/ 244 int 245 cmd_offsetof(uintptr_t addr, uint_t flags, int argc, const mdb_arg_t *argv) 246 { 247 const char *member; 248 mdb_ctf_id_t id; 249 ulong_t off; 250 char tn[MDB_SYM_NAMLEN]; 251 ssize_t sz; 252 int ret; 253 254 if (flags & DCMD_ADDRSPEC) 255 return (DCMD_USAGE); 256 257 if ((ret = args_to_typename(&argc, &argv, tn, sizeof (tn))) != 0) 258 return (ret); 259 260 if (argc != 2 || argv[1].a_type != MDB_TYPE_STRING) 261 return (DCMD_USAGE); 262 263 if (mdb_ctf_lookup_by_name(tn, &id) != 0) { 264 mdb_warn("failed to look up type %s", tn); 265 return (DCMD_ERR); 266 } 267 268 member = argv[1].a_un.a_str; 269 270 if (mdb_ctf_member_info(id, member, &off, &id) != 0) { 271 mdb_warn("failed to find member %s of type %s", member, tn); 272 return (DCMD_ERR); 273 } 274 275 if (flags & DCMD_PIPE_OUT) { 276 if (off % NBBY != 0) { 277 mdb_warn("member %s of type %s is not byte-aligned\n", 278 member, tn); 279 return (DCMD_ERR); 280 } 281 mdb_printf("%#lr", off / NBBY); 282 return (DCMD_OK); 283 } 284 285 mdb_printf("offsetof (%s, %s) = %#lr", 286 tn, member, off / NBBY); 287 if (off % NBBY != 0) 288 mdb_printf(".%lr", off % NBBY); 289 290 if ((sz = mdb_ctf_type_size(id)) > 0) 291 mdb_printf(", sizeof (...->%s) = %#lr", member, sz); 292 293 mdb_printf("\n"); 294 295 return (DCMD_OK); 296 } 297 298 /*ARGSUSED*/ 299 static int 300 enum_prefix_scan_cb(const char *name, int value, void *arg) 301 { 302 char *str = arg; 303 304 /* 305 * This function is called with every name in the enum. We make 306 * "arg" be the common prefix, if any. 307 */ 308 if (str[0] == 0) { 309 if (strlcpy(arg, name, MDB_SYM_NAMLEN) >= MDB_SYM_NAMLEN) 310 return (1); 311 return (0); 312 } 313 314 while (*name == *str) { 315 if (*str == 0) { 316 if (str != arg) { 317 str--; /* don't smother a name completely */ 318 } 319 break; 320 } 321 name++; 322 str++; 323 } 324 *str = 0; 325 326 return (str == arg); /* only continue if prefix is non-empty */ 327 } 328 329 struct enum_p2_info { 330 intmax_t e_value; /* value we're processing */ 331 char *e_buf; /* buffer for holding names */ 332 size_t e_size; /* size of buffer */ 333 size_t e_prefix; /* length of initial prefix */ 334 uint_t e_allprefix; /* apply prefix to first guy, too */ 335 uint_t e_bits; /* bits seen */ 336 uint8_t e_found; /* have we seen anything? */ 337 uint8_t e_first; /* does buf contain the first one? */ 338 uint8_t e_zero; /* have we seen a zero value? */ 339 }; 340 341 static int 342 enum_p2_cb(const char *name, int bit_arg, void *arg) 343 { 344 struct enum_p2_info *eiip = arg; 345 uintmax_t bit = bit_arg; 346 347 if (bit != 0 && !ISP2(bit)) 348 return (1); /* non-power-of-2; abort processing */ 349 350 if ((bit == 0 && eiip->e_zero) || 351 (bit != 0 && (eiip->e_bits & bit) != 0)) { 352 return (0); /* already seen this value */ 353 } 354 355 if (bit == 0) 356 eiip->e_zero = 1; 357 else 358 eiip->e_bits |= bit; 359 360 if (eiip->e_buf != NULL && (eiip->e_value & bit) != 0) { 361 char *buf = eiip->e_buf; 362 size_t prefix = eiip->e_prefix; 363 364 if (eiip->e_found) { 365 (void) strlcat(buf, "|", eiip->e_size); 366 367 if (eiip->e_first && !eiip->e_allprefix && prefix > 0) { 368 char c1 = buf[prefix]; 369 char c2 = buf[prefix + 1]; 370 buf[prefix] = '{'; 371 buf[prefix + 1] = 0; 372 mdb_printf("%s", buf); 373 buf[prefix] = c1; 374 buf[prefix + 1] = c2; 375 mdb_printf("%s", buf + prefix); 376 } else { 377 mdb_printf("%s", buf); 378 } 379 380 } 381 /* skip the common prefix as necessary */ 382 if ((eiip->e_found || eiip->e_allprefix) && 383 strlen(name) > prefix) 384 name += prefix; 385 386 (void) strlcpy(eiip->e_buf, name, eiip->e_size); 387 eiip->e_first = !eiip->e_found; 388 eiip->e_found = 1; 389 } 390 return (0); 391 } 392 393 static int 394 enum_is_p2(mdb_ctf_id_t id) 395 { 396 struct enum_p2_info eii; 397 bzero(&eii, sizeof (eii)); 398 399 return (mdb_ctf_type_kind(id) == CTF_K_ENUM && 400 mdb_ctf_enum_iter(id, enum_p2_cb, &eii) == 0 && 401 eii.e_bits != 0); 402 } 403 404 static int 405 enum_value_print_p2(mdb_ctf_id_t id, intmax_t value, uint_t allprefix) 406 { 407 struct enum_p2_info eii; 408 char prefix[MDB_SYM_NAMLEN + 2]; 409 intmax_t missed; 410 411 bzero(&eii, sizeof (eii)); 412 413 eii.e_value = value; 414 eii.e_buf = prefix; 415 eii.e_size = sizeof (prefix); 416 eii.e_allprefix = allprefix; 417 418 prefix[0] = 0; 419 if (mdb_ctf_enum_iter(id, enum_prefix_scan_cb, prefix) == 0) 420 eii.e_prefix = strlen(prefix); 421 422 if (mdb_ctf_enum_iter(id, enum_p2_cb, &eii) != 0 || eii.e_bits == 0) 423 return (-1); 424 425 missed = (value & ~(intmax_t)eii.e_bits); 426 427 if (eii.e_found) { 428 /* push out any final value, with a | if we missed anything */ 429 if (!eii.e_first) 430 (void) strlcat(prefix, "}", sizeof (prefix)); 431 if (missed != 0) 432 (void) strlcat(prefix, "|", sizeof (prefix)); 433 434 mdb_printf("%s", prefix); 435 } 436 437 if (!eii.e_found || missed) { 438 mdb_printf("%#llx", missed); 439 } 440 441 return (0); 442 } 443 444 struct enum_cbinfo { 445 uint_t e_flags; 446 const char *e_string; /* NULL for value searches */ 447 size_t e_prefix; 448 intmax_t e_value; 449 uint_t e_found; 450 mdb_ctf_id_t e_id; 451 }; 452 #define E_PRETTY 0x01 453 #define E_HEX 0x02 454 #define E_SEARCH_STRING 0x04 455 #define E_SEARCH_VALUE 0x08 456 #define E_ELIDE_PREFIX 0x10 457 458 static void 459 enum_print(struct enum_cbinfo *info, const char *name, int value) 460 { 461 uint_t flags = info->e_flags; 462 uint_t elide_prefix = (info->e_flags & E_ELIDE_PREFIX); 463 464 if (name != NULL && info->e_prefix && strlen(name) > info->e_prefix) 465 name += info->e_prefix; 466 467 if (flags & E_PRETTY) { 468 uint_t indent = 5 + ((flags & E_HEX) ? 8 : 11); 469 470 mdb_printf((flags & E_HEX)? "%8x " : "%11d ", value); 471 (void) mdb_inc_indent(indent); 472 if (name != NULL) { 473 mdb_iob_puts(mdb.m_out, name); 474 } else { 475 (void) enum_value_print_p2(info->e_id, value, 476 elide_prefix); 477 } 478 (void) mdb_dec_indent(indent); 479 mdb_printf("\n"); 480 } else { 481 mdb_printf("%#r\n", value); 482 } 483 } 484 485 static int 486 enum_cb(const char *name, int value, void *arg) 487 { 488 struct enum_cbinfo *info = arg; 489 uint_t flags = info->e_flags; 490 491 if (flags & E_SEARCH_STRING) { 492 if (strcmp(name, info->e_string) != 0) 493 return (0); 494 495 } else if (flags & E_SEARCH_VALUE) { 496 if (value != info->e_value) 497 return (0); 498 } 499 500 enum_print(info, name, value); 501 502 info->e_found = 1; 503 return (0); 504 } 505 506 void 507 enum_help(void) 508 { 509 mdb_printf("%s", 510 "Without an address and name, print all values for the enumeration \"enum\".\n" 511 "With an address, look up a particular value in \"enum\". With a name, look\n" 512 "up a particular name in \"enum\".\n"); 513 514 (void) mdb_dec_indent(2); 515 mdb_printf("\n%<b>OPTIONS%</b>\n"); 516 (void) mdb_inc_indent(2); 517 518 mdb_printf("%s", 519 " -e remove common prefixes from enum names\n" 520 " -x report enum values in hexadecimal\n"); 521 } 522 523 /*ARGSUSED*/ 524 int 525 cmd_enum(uintptr_t addr, uint_t flags, int argc, const mdb_arg_t *argv) 526 { 527 struct enum_cbinfo info; 528 529 char type[MDB_SYM_NAMLEN + sizeof ("enum ")]; 530 char tn2[MDB_SYM_NAMLEN + sizeof ("enum ")]; 531 char prefix[MDB_SYM_NAMLEN]; 532 mdb_ctf_id_t id; 533 mdb_ctf_id_t idr; 534 535 int i; 536 intmax_t search; 537 uint_t isp2; 538 539 info.e_flags = (flags & DCMD_PIPE_OUT)? 0 : E_PRETTY; 540 info.e_string = NULL; 541 info.e_value = 0; 542 info.e_found = 0; 543 544 i = mdb_getopts(argc, argv, 545 'e', MDB_OPT_SETBITS, E_ELIDE_PREFIX, &info.e_flags, 546 'x', MDB_OPT_SETBITS, E_HEX, &info.e_flags, 547 NULL); 548 549 argc -= i; 550 argv += i; 551 552 if ((i = args_to_typename(&argc, &argv, type, MDB_SYM_NAMLEN)) != 0) 553 return (i); 554 555 if (strchr(type, ' ') == NULL) { 556 /* 557 * Check as an enumeration tag first, and fall back 558 * to checking for a typedef. Yes, this means that 559 * anonymous enumerations whose typedefs conflict with 560 * an enum tag can't be accessed. Don't do that. 561 */ 562 (void) mdb_snprintf(tn2, sizeof (tn2), "enum %s", type); 563 564 if (mdb_ctf_lookup_by_name(tn2, &id) == 0) { 565 (void) strcpy(type, tn2); 566 } else if (mdb_ctf_lookup_by_name(type, &id) != 0) { 567 mdb_warn("types '%s', '%s'", tn2, type); 568 return (DCMD_ERR); 569 } 570 } else { 571 if (mdb_ctf_lookup_by_name(type, &id) != 0) { 572 mdb_warn("'%s'", type); 573 return (DCMD_ERR); 574 } 575 } 576 577 /* resolve it, and make sure we're looking at an enumeration */ 578 if (mdb_ctf_type_resolve(id, &idr) == -1) { 579 mdb_warn("unable to resolve '%s'", type); 580 return (DCMD_ERR); 581 } 582 if (mdb_ctf_type_kind(idr) != CTF_K_ENUM) { 583 mdb_warn("'%s': not an enumeration\n", type); 584 return (DCMD_ERR); 585 } 586 587 info.e_id = idr; 588 589 if (argc > 2) 590 return (DCMD_USAGE); 591 592 if (argc == 2) { 593 if (flags & DCMD_ADDRSPEC) { 594 mdb_warn("may only specify one of: name, address\n"); 595 return (DCMD_USAGE); 596 } 597 598 if (argv[1].a_type == MDB_TYPE_STRING) { 599 info.e_flags |= E_SEARCH_STRING; 600 info.e_string = argv[1].a_un.a_str; 601 } else if (argv[1].a_type == MDB_TYPE_IMMEDIATE) { 602 info.e_flags |= E_SEARCH_VALUE; 603 search = argv[1].a_un.a_val; 604 } else { 605 return (DCMD_USAGE); 606 } 607 } 608 609 if (flags & DCMD_ADDRSPEC) { 610 info.e_flags |= E_SEARCH_VALUE; 611 search = mdb_get_dot(); 612 } 613 614 if (info.e_flags & E_SEARCH_VALUE) { 615 if ((int)search != search) { 616 mdb_warn("value '%lld' out of enumeration range\n", 617 search); 618 } 619 info.e_value = search; 620 } 621 622 isp2 = enum_is_p2(idr); 623 if (isp2) 624 info.e_flags |= E_HEX; 625 626 if (DCMD_HDRSPEC(flags) && (info.e_flags & E_PRETTY)) { 627 if (info.e_flags & E_HEX) 628 mdb_printf("%<u>%8s %-64s%</u>\n", "VALUE", "NAME"); 629 else 630 mdb_printf("%<u>%11s %-64s%</u>\n", "VALUE", "NAME"); 631 } 632 633 /* if the enum is a power-of-two one, process it that way */ 634 if ((info.e_flags & E_SEARCH_VALUE) && isp2) { 635 enum_print(&info, NULL, info.e_value); 636 return (DCMD_OK); 637 } 638 639 prefix[0] = 0; 640 if ((info.e_flags & E_ELIDE_PREFIX) && 641 mdb_ctf_enum_iter(id, enum_prefix_scan_cb, prefix) == 0) 642 info.e_prefix = strlen(prefix); 643 644 if (mdb_ctf_enum_iter(idr, enum_cb, &info) == -1) { 645 mdb_warn("cannot walk '%s' as enum", type); 646 return (DCMD_ERR); 647 } 648 649 if (info.e_found == 0 && 650 (info.e_flags & (E_SEARCH_STRING | E_SEARCH_VALUE)) != 0) { 651 if (info.e_flags & E_SEARCH_STRING) 652 mdb_warn("name \"%s\" not in '%s'\n", info.e_string, 653 type); 654 else 655 mdb_warn("value %#lld not in '%s'\n", info.e_value, 656 type); 657 658 return (DCMD_ERR); 659 } 660 661 return (DCMD_OK); 662 } 663 664 static int 665 setup_vcb(const char *name, uintptr_t addr) 666 { 667 const char *p; 668 mdb_var_t *v; 669 670 if ((v = mdb_nv_lookup(&mdb.m_nv, name)) == NULL) { 671 if ((p = strbadid(name)) != NULL) { 672 mdb_warn("'%c' may not be used in a variable " 673 "name\n", *p); 674 return (DCMD_ABORT); 675 } 676 677 if ((v = mdb_nv_insert(&mdb.m_nv, name, NULL, addr, 0)) == NULL) 678 return (DCMD_ERR); 679 } else { 680 if (v->v_flags & MDB_NV_RDONLY) { 681 mdb_warn("variable %s is read-only\n", name); 682 return (DCMD_ABORT); 683 } 684 } 685 686 /* 687 * If there already exists a vcb for this variable, we may be 688 * calling the dcmd in a loop. We only create a vcb for this 689 * variable on the first invocation. 690 */ 691 if (mdb_vcb_find(v, mdb.m_frame) == NULL) 692 mdb_vcb_insert(mdb_vcb_create(v), mdb.m_frame); 693 694 return (0); 695 } 696 697 /*ARGSUSED*/ 698 int 699 cmd_list(uintptr_t addr, uint_t flags, int argc, const mdb_arg_t *argv) 700 { 701 int offset; 702 uintptr_t a, tmp; 703 int ret; 704 705 if (!(flags & DCMD_ADDRSPEC) || argc == 0) 706 return (DCMD_USAGE); 707 708 if (argv->a_type != MDB_TYPE_STRING) { 709 /* 710 * We are being given a raw offset in lieu of a type and 711 * member; confirm the number of arguments and argument 712 * type. 713 */ 714 if (argc != 1 || argv->a_type != MDB_TYPE_IMMEDIATE) 715 return (DCMD_USAGE); 716 717 offset = argv->a_un.a_val; 718 719 argv++; 720 argc--; 721 722 if (offset % sizeof (uintptr_t)) { 723 mdb_warn("offset must fall on a word boundary\n"); 724 return (DCMD_ABORT); 725 } 726 } else { 727 const char *member; 728 char buf[MDB_SYM_NAMLEN]; 729 int ret; 730 731 /* 732 * Check that we were provided 2 arguments: a type name 733 * and a member of that type. 734 */ 735 if (argc != 2) 736 return (DCMD_USAGE); 737 738 ret = args_to_typename(&argc, &argv, buf, sizeof (buf)); 739 if (ret != 0) 740 return (ret); 741 742 argv++; 743 argc--; 744 745 member = argv->a_un.a_str; 746 offset = mdb_ctf_offsetof_by_name(buf, member); 747 if (offset == -1) 748 return (DCMD_ABORT); 749 750 argv++; 751 argc--; 752 753 if (offset % (sizeof (uintptr_t)) != 0) { 754 mdb_warn("%s is not a word-aligned member\n", member); 755 return (DCMD_ABORT); 756 } 757 } 758 759 /* 760 * If we have any unchewed arguments, a variable name must be present. 761 */ 762 if (argc == 1) { 763 if (argv->a_type != MDB_TYPE_STRING) 764 return (DCMD_USAGE); 765 766 if ((ret = setup_vcb(argv->a_un.a_str, addr)) != 0) 767 return (ret); 768 769 } else if (argc != 0) { 770 return (DCMD_USAGE); 771 } 772 773 a = addr; 774 775 do { 776 mdb_printf("%lr\n", a); 777 778 if (mdb_vread(&tmp, sizeof (tmp), a + offset) == -1) { 779 mdb_warn("failed to read next pointer from object %p", 780 a); 781 return (DCMD_ERR); 782 } 783 784 a = tmp; 785 } while (a != addr && a != NULL); 786 787 return (DCMD_OK); 788 } 789 790 int 791 cmd_array(uintptr_t addr, uint_t flags, int argc, const mdb_arg_t *argv) 792 { 793 mdb_ctf_id_t id; 794 ssize_t elemsize = 0; 795 char tn[MDB_SYM_NAMLEN]; 796 int ret, nelem = -1; 797 798 mdb_tgt_t *t = mdb.m_target; 799 GElf_Sym sym; 800 mdb_ctf_arinfo_t ar; 801 mdb_syminfo_t s_info; 802 803 if (!(flags & DCMD_ADDRSPEC)) 804 return (DCMD_USAGE); 805 806 if (argc >= 2) { 807 ret = args_to_typename(&argc, &argv, tn, sizeof (tn)); 808 if (ret != 0) 809 return (ret); 810 811 if (argc == 1) /* unquoted compound type without count */ 812 return (DCMD_USAGE); 813 814 if (mdb_ctf_lookup_by_name(tn, &id) != 0) { 815 mdb_warn("failed to look up type %s", tn); 816 return (DCMD_ABORT); 817 } 818 819 if (argv[1].a_type == MDB_TYPE_IMMEDIATE) 820 nelem = argv[1].a_un.a_val; 821 else 822 nelem = mdb_strtoull(argv[1].a_un.a_str); 823 824 elemsize = mdb_ctf_type_size(id); 825 } else if (addr_to_sym(t, addr, tn, sizeof (tn), &sym, &s_info) 826 != NULL && mdb_ctf_lookup_by_symbol(&sym, &s_info, &id) 827 == 0 && mdb_ctf_type_kind(id) == CTF_K_ARRAY && 828 mdb_ctf_array_info(id, &ar) != -1) { 829 elemsize = mdb_ctf_type_size(id) / ar.mta_nelems; 830 nelem = ar.mta_nelems; 831 } else { 832 mdb_warn("no symbol information for %a", addr); 833 return (DCMD_ERR); 834 } 835 836 if (argc == 3 || argc == 1) { 837 if (argv[argc - 1].a_type != MDB_TYPE_STRING) 838 return (DCMD_USAGE); 839 840 if ((ret = setup_vcb(argv[argc - 1].a_un.a_str, addr)) != 0) 841 return (ret); 842 843 } else if (argc > 3) { 844 return (DCMD_USAGE); 845 } 846 847 for (; nelem > 0; nelem--) { 848 mdb_printf("%lr\n", addr); 849 addr = addr + elemsize; 850 } 851 852 return (DCMD_OK); 853 } 854 855 /* 856 * Print an integer bitfield in hexadecimal by reading the enclosing byte(s) 857 * and then shifting and masking the data in the lower bits of a uint64_t. 858 */ 859 static int 860 print_bitfield(ulong_t off, printarg_t *pap, ctf_encoding_t *ep) 861 { 862 mdb_tgt_addr_t addr = pap->pa_addr + off / NBBY; 863 size_t size = (ep->cte_bits + (NBBY - 1)) / NBBY; 864 uint64_t mask = (1ULL << ep->cte_bits) - 1; 865 uint64_t value = 0; 866 uint8_t *buf = (uint8_t *)&value; 867 uint8_t shift; 868 869 const char *format; 870 871 if (!(pap->pa_flags & PA_SHOWVAL)) 872 return (0); 873 874 if (ep->cte_bits > sizeof (value) * NBBY - 1) { 875 mdb_printf("??? (invalid bitfield size %u)", ep->cte_bits); 876 return (0); 877 } 878 879 /* 880 * On big-endian machines, we need to adjust the buf pointer to refer 881 * to the lowest 'size' bytes in 'value', and we need shift based on 882 * the offset from the end of the data, not the offset of the start. 883 */ 884 #ifdef _BIG_ENDIAN 885 buf += sizeof (value) - size; 886 off += ep->cte_bits; 887 #endif 888 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, buf, size, addr) != size) { 889 mdb_warn("failed to read %lu bytes at %llx", 890 (ulong_t)size, addr); 891 return (1); 892 } 893 894 shift = off % NBBY; 895 896 /* 897 * Offsets are counted from opposite ends on little- and 898 * big-endian machines. 899 */ 900 #ifdef _BIG_ENDIAN 901 shift = NBBY - shift; 902 #endif 903 904 /* 905 * If the bits we want do not begin on a byte boundary, shift the data 906 * right so that the value is in the lowest 'cte_bits' of 'value'. 907 */ 908 if (off % NBBY != 0) 909 value >>= shift; 910 value &= mask; 911 912 /* 913 * We default to printing signed bitfields as decimals, 914 * and unsigned bitfields in hexadecimal. If they specify 915 * hexadecimal, we treat the field as unsigned. 916 */ 917 if ((pap->pa_flags & PA_INTHEX) || 918 !(ep->cte_format & CTF_INT_SIGNED)) { 919 format = (pap->pa_flags & PA_INTDEC)? "%#llu" : "%#llx"; 920 } else { 921 int sshift = sizeof (value) * NBBY - ep->cte_bits; 922 923 /* sign-extend value, and print as a signed decimal */ 924 value = ((int64_t)value << sshift) >> sshift; 925 format = "%#lld"; 926 } 927 mdb_printf(format, value); 928 929 return (0); 930 } 931 932 /* 933 * Print out a character or integer value. We use some simple heuristics, 934 * described below, to determine the appropriate radix to use for output. 935 */ 936 static int 937 print_int_val(const char *type, ctf_encoding_t *ep, ulong_t off, 938 printarg_t *pap) 939 { 940 static const char *const sformat[] = { "%#d", "%#d", "%#d", "%#lld" }; 941 static const char *const uformat[] = { "%#u", "%#u", "%#u", "%#llu" }; 942 static const char *const xformat[] = { "%#x", "%#x", "%#x", "%#llx" }; 943 944 mdb_tgt_addr_t addr = pap->pa_addr + off / NBBY; 945 const char *const *fsp; 946 size_t size; 947 948 union { 949 uint64_t i8; 950 uint32_t i4; 951 uint16_t i2; 952 uint8_t i1; 953 time_t t; 954 ipaddr_t I; 955 } u; 956 957 if (!(pap->pa_flags & PA_SHOWVAL)) 958 return (0); 959 960 if (ep->cte_format & CTF_INT_VARARGS) { 961 mdb_printf("...\n"); 962 return (0); 963 } 964 965 /* 966 * If the size is not a power-of-two number of bytes in the range 1-8 967 * then we assume it is a bitfield and print it as such. 968 */ 969 size = ep->cte_bits / NBBY; 970 if (size > 8 || (ep->cte_bits % NBBY) != 0 || (size & (size - 1)) != 0) 971 return (print_bitfield(off, pap, ep)); 972 973 if (IS_CHAR(*ep)) { 974 mdb_printf("'"); 975 if (mdb_fmt_print(pap->pa_tgt, pap->pa_as, 976 addr, 1, 'C') == addr) 977 return (1); 978 mdb_printf("'"); 979 return (0); 980 } 981 982 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, &u.i8, size, addr) != size) { 983 mdb_warn("failed to read %lu bytes at %llx", 984 (ulong_t)size, addr); 985 return (1); 986 } 987 988 /* 989 * We pretty-print some integer based types. time_t values are 990 * printed as a calendar date and time, and IPv4 addresses as human 991 * readable dotted quads. 992 */ 993 if (!(pap->pa_flags & (PA_INTHEX | PA_INTDEC))) { 994 if (strcmp(type, "time_t") == 0 && u.t != 0) { 995 mdb_printf("%Y", u.t); 996 return (0); 997 } 998 if (strcmp(type, "ipaddr_t") == 0 || 999 strcmp(type, "in_addr_t") == 0) { 1000 mdb_printf("%I", u.I); 1001 return (0); 1002 } 1003 } 1004 1005 /* 1006 * The default format is hexadecimal. 1007 */ 1008 if (!(pap->pa_flags & PA_INTDEC)) 1009 fsp = xformat; 1010 else if (ep->cte_format & CTF_INT_SIGNED) 1011 fsp = sformat; 1012 else 1013 fsp = uformat; 1014 1015 switch (size) { 1016 case sizeof (uint8_t): 1017 mdb_printf(fsp[0], u.i1); 1018 break; 1019 case sizeof (uint16_t): 1020 mdb_printf(fsp[1], u.i2); 1021 break; 1022 case sizeof (uint32_t): 1023 mdb_printf(fsp[2], u.i4); 1024 break; 1025 case sizeof (uint64_t): 1026 mdb_printf(fsp[3], u.i8); 1027 break; 1028 } 1029 return (0); 1030 } 1031 1032 /*ARGSUSED*/ 1033 static int 1034 print_int(const char *type, const char *name, mdb_ctf_id_t id, 1035 mdb_ctf_id_t base, ulong_t off, printarg_t *pap) 1036 { 1037 ctf_encoding_t e; 1038 1039 if (!(pap->pa_flags & PA_SHOWVAL)) 1040 return (0); 1041 1042 if (mdb_ctf_type_encoding(base, &e) != 0) { 1043 mdb_printf("??? (%s)", mdb_strerror(errno)); 1044 return (0); 1045 } 1046 1047 return (print_int_val(type, &e, off, pap)); 1048 } 1049 1050 /* 1051 * Print out a floating point value. We only provide support for floats in 1052 * the ANSI-C float, double, and long double formats. 1053 */ 1054 /*ARGSUSED*/ 1055 static int 1056 print_float(const char *type, const char *name, mdb_ctf_id_t id, 1057 mdb_ctf_id_t base, ulong_t off, printarg_t *pap) 1058 { 1059 #ifndef _KMDB 1060 mdb_tgt_addr_t addr = pap->pa_addr + off / NBBY; 1061 ctf_encoding_t e; 1062 1063 union { 1064 float f; 1065 double d; 1066 long double ld; 1067 } u; 1068 1069 if (!(pap->pa_flags & PA_SHOWVAL)) 1070 return (0); 1071 1072 if (mdb_ctf_type_encoding(base, &e) == 0) { 1073 if (e.cte_format == CTF_FP_SINGLE && 1074 e.cte_bits == sizeof (float) * NBBY) { 1075 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, &u.f, 1076 sizeof (u.f), addr) != sizeof (u.f)) { 1077 mdb_warn("failed to read float at %llx", addr); 1078 return (1); 1079 } 1080 mdb_printf("%s", doubletos(u.f, 7, 'e')); 1081 1082 } else if (e.cte_format == CTF_FP_DOUBLE && 1083 e.cte_bits == sizeof (double) * NBBY) { 1084 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, &u.d, 1085 sizeof (u.d), addr) != sizeof (u.d)) { 1086 mdb_warn("failed to read float at %llx", addr); 1087 return (1); 1088 } 1089 mdb_printf("%s", doubletos(u.d, 7, 'e')); 1090 1091 } else if (e.cte_format == CTF_FP_LDOUBLE && 1092 e.cte_bits == sizeof (long double) * NBBY) { 1093 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, &u.ld, 1094 sizeof (u.ld), addr) != sizeof (u.ld)) { 1095 mdb_warn("failed to read float at %llx", addr); 1096 return (1); 1097 } 1098 mdb_printf("%s", longdoubletos(&u.ld, 16, 'e')); 1099 1100 } else { 1101 mdb_printf("??? (unsupported FP format %u / %u bits\n", 1102 e.cte_format, e.cte_bits); 1103 } 1104 } else 1105 mdb_printf("??? (%s)", mdb_strerror(errno)); 1106 #else 1107 mdb_printf("<FLOAT>"); 1108 #endif 1109 return (0); 1110 } 1111 1112 1113 /* 1114 * Print out a pointer value as a symbol name + offset or a hexadecimal value. 1115 * If the pointer itself is a char *, we attempt to read a bit of the data 1116 * referenced by the pointer and display it if it is a printable ASCII string. 1117 */ 1118 /*ARGSUSED*/ 1119 static int 1120 print_ptr(const char *type, const char *name, mdb_ctf_id_t id, 1121 mdb_ctf_id_t base, ulong_t off, printarg_t *pap) 1122 { 1123 mdb_tgt_addr_t addr = pap->pa_addr + off / NBBY; 1124 ctf_encoding_t e; 1125 uintptr_t value; 1126 char buf[256]; 1127 ssize_t len; 1128 1129 if (!(pap->pa_flags & PA_SHOWVAL)) 1130 return (0); 1131 1132 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, 1133 &value, sizeof (value), addr) != sizeof (value)) { 1134 mdb_warn("failed to read %s pointer at %llx", name, addr); 1135 return (1); 1136 } 1137 1138 if (pap->pa_flags & PA_NOSYMBOLIC) { 1139 mdb_printf("%#lx", value); 1140 return (0); 1141 } 1142 1143 mdb_printf("%a", value); 1144 1145 if (value == NULL || strcmp(type, "caddr_t") == 0) 1146 return (0); 1147 1148 if (mdb_ctf_type_kind(base) == CTF_K_POINTER && 1149 mdb_ctf_type_reference(base, &base) != -1 && 1150 mdb_ctf_type_resolve(base, &base) != -1 && 1151 mdb_ctf_type_encoding(base, &e) == 0 && IS_CHAR(e)) { 1152 if ((len = mdb_tgt_readstr(pap->pa_realtgt, pap->pa_as, 1153 buf, sizeof (buf), value)) >= 0 && strisprint(buf)) { 1154 if (len == sizeof (buf)) 1155 (void) strabbr(buf, sizeof (buf)); 1156 mdb_printf(" \"%s\"", buf); 1157 } 1158 } 1159 1160 return (0); 1161 } 1162 1163 1164 /* 1165 * Print out a fixed-size array. We special-case arrays of characters 1166 * and attempt to print them out as ASCII strings if possible. For other 1167 * arrays, we iterate over a maximum of pa_armemlim members and call 1168 * mdb_ctf_type_visit() again on each element to print its value. 1169 */ 1170 /*ARGSUSED*/ 1171 static int 1172 print_array(const char *type, const char *name, mdb_ctf_id_t id, 1173 mdb_ctf_id_t base, ulong_t off, printarg_t *pap) 1174 { 1175 mdb_tgt_addr_t addr = pap->pa_addr + off / NBBY; 1176 printarg_t pa = *pap; 1177 ssize_t eltsize; 1178 mdb_ctf_arinfo_t r; 1179 ctf_encoding_t e; 1180 uint_t i, kind, limit; 1181 int d, sou; 1182 char buf[8]; 1183 char *str; 1184 1185 if (!(pap->pa_flags & PA_SHOWVAL)) 1186 return (0); 1187 1188 if (pap->pa_depth == pap->pa_maxdepth) { 1189 mdb_printf("[ ... ]"); 1190 return (0); 1191 } 1192 1193 /* 1194 * Determine the base type and size of the array's content. If this 1195 * fails, we cannot print anything and just give up. 1196 */ 1197 if (mdb_ctf_array_info(base, &r) == -1 || 1198 mdb_ctf_type_resolve(r.mta_contents, &base) == -1 || 1199 (eltsize = mdb_ctf_type_size(base)) == -1) { 1200 mdb_printf("[ ??? ] (%s)", mdb_strerror(errno)); 1201 return (0); 1202 } 1203 1204 /* 1205 * Read a few bytes and determine if the content appears to be 1206 * printable ASCII characters. If so, read the entire array and 1207 * attempt to display it as a string if it is printable. 1208 */ 1209 if ((pap->pa_arstrlim == MDB_ARR_NOLIMIT || 1210 r.mta_nelems <= pap->pa_arstrlim) && 1211 mdb_ctf_type_encoding(base, &e) == 0 && IS_CHAR(e) && 1212 mdb_tgt_readstr(pap->pa_tgt, pap->pa_as, buf, 1213 MIN(sizeof (buf), r.mta_nelems), addr) > 0 && strisprint(buf)) { 1214 1215 str = mdb_alloc(r.mta_nelems + 1, UM_SLEEP | UM_GC); 1216 str[r.mta_nelems] = '\0'; 1217 1218 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, str, 1219 r.mta_nelems, addr) != r.mta_nelems) { 1220 mdb_warn("failed to read char array at %llx", addr); 1221 return (1); 1222 } 1223 1224 if (strisprint(str)) { 1225 mdb_printf("[ \"%s\" ]", str); 1226 return (0); 1227 } 1228 } 1229 1230 if (pap->pa_armemlim != MDB_ARR_NOLIMIT) 1231 limit = MIN(r.mta_nelems, pap->pa_armemlim); 1232 else 1233 limit = r.mta_nelems; 1234 1235 if (limit == 0) { 1236 mdb_printf("[ ... ]"); 1237 return (0); 1238 } 1239 1240 kind = mdb_ctf_type_kind(base); 1241 sou = IS_COMPOSITE(kind); 1242 1243 pa.pa_addr = addr; /* set base address to start of array */ 1244 pa.pa_maxdepth = pa.pa_maxdepth - pa.pa_depth - 1; 1245 pa.pa_nest += pa.pa_depth + 1; /* nesting level is current depth + 1 */ 1246 pa.pa_depth = 0; /* reset depth to 0 for new scope */ 1247 pa.pa_prefix = NULL; 1248 1249 if (sou) { 1250 pa.pa_delim = "\n"; 1251 mdb_printf("[\n"); 1252 } else { 1253 pa.pa_flags &= ~(PA_SHOWTYPE | PA_SHOWNAME | PA_SHOWADDR); 1254 pa.pa_delim = ", "; 1255 mdb_printf("[ "); 1256 } 1257 1258 for (i = 0; i < limit; i++, pa.pa_addr += eltsize) { 1259 if (i == limit - 1 && !sou) { 1260 if (limit < r.mta_nelems) 1261 pa.pa_delim = ", ... ]"; 1262 else 1263 pa.pa_delim = " ]"; 1264 } 1265 1266 if (mdb_ctf_type_visit(r.mta_contents, elt_print, &pa) == -1) { 1267 mdb_warn("failed to print array data"); 1268 return (1); 1269 } 1270 } 1271 1272 if (sou) { 1273 for (d = pa.pa_depth - 1; d >= 0; d--) 1274 print_close_sou(&pa, d); 1275 1276 if (limit < r.mta_nelems) { 1277 mdb_printf("%*s... ]", 1278 (pap->pa_depth + pap->pa_nest) * pap->pa_tab, ""); 1279 } else { 1280 mdb_printf("%*s]", 1281 (pap->pa_depth + pap->pa_nest) * pap->pa_tab, ""); 1282 } 1283 } 1284 1285 /* copy the hole array info, since it may have been grown */ 1286 pap->pa_holes = pa.pa_holes; 1287 pap->pa_nholes = pa.pa_nholes; 1288 1289 return (0); 1290 } 1291 1292 /* 1293 * Print out a struct or union header. We need only print the open brace 1294 * because mdb_ctf_type_visit() itself will automatically recurse through 1295 * all members of the given struct or union. 1296 */ 1297 /*ARGSUSED*/ 1298 static int 1299 print_sou(const char *type, const char *name, mdb_ctf_id_t id, 1300 mdb_ctf_id_t base, ulong_t off, printarg_t *pap) 1301 { 1302 mdb_tgt_addr_t addr = pap->pa_addr + off / NBBY; 1303 1304 /* 1305 * We have pretty-printing for some structures where displaying 1306 * structure contents has no value. 1307 */ 1308 if (pap->pa_flags & PA_SHOWVAL) { 1309 if (strcmp(type, "in6_addr_t") == 0 || 1310 strcmp(type, "struct in6_addr") == 0) { 1311 in6_addr_t in6addr; 1312 1313 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, &in6addr, 1314 sizeof (in6addr), addr) != sizeof (in6addr)) { 1315 mdb_warn("failed to read %s pointer at %llx", 1316 name, addr); 1317 return (1); 1318 } 1319 mdb_printf("%N", &in6addr); 1320 /* 1321 * Don't print anything further down in the 1322 * structure. 1323 */ 1324 pap->pa_nooutdepth = pap->pa_depth; 1325 return (0); 1326 } 1327 if (strcmp(type, "struct in_addr") == 0) { 1328 in_addr_t inaddr; 1329 1330 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, &inaddr, 1331 sizeof (inaddr), addr) != sizeof (inaddr)) { 1332 mdb_warn("failed to read %s pointer at %llx", 1333 name, addr); 1334 return (1); 1335 } 1336 mdb_printf("%I", inaddr); 1337 pap->pa_nooutdepth = pap->pa_depth; 1338 return (0); 1339 } 1340 } 1341 1342 if (pap->pa_depth == pap->pa_maxdepth) 1343 mdb_printf("{ ... }"); 1344 else 1345 mdb_printf("{"); 1346 pap->pa_delim = "\n"; 1347 return (0); 1348 } 1349 1350 /* 1351 * Print an enum value. We attempt to convert the value to the corresponding 1352 * enum name and print that if possible. 1353 */ 1354 /*ARGSUSED*/ 1355 static int 1356 print_enum(const char *type, const char *name, mdb_ctf_id_t id, 1357 mdb_ctf_id_t base, ulong_t off, printarg_t *pap) 1358 { 1359 mdb_tgt_addr_t addr = pap->pa_addr + off / NBBY; 1360 const char *ename; 1361 int value; 1362 int isp2 = enum_is_p2(base); 1363 int flags = pap->pa_flags | (isp2 ? PA_INTHEX : 0); 1364 1365 if (!(flags & PA_SHOWVAL)) 1366 return (0); 1367 1368 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, 1369 &value, sizeof (value), addr) != sizeof (value)) { 1370 mdb_warn("failed to read %s integer at %llx", name, addr); 1371 return (1); 1372 } 1373 1374 if (flags & PA_INTHEX) 1375 mdb_printf("%#x", value); 1376 else 1377 mdb_printf("%#d", value); 1378 1379 (void) mdb_inc_indent(8); 1380 mdb_printf(" ("); 1381 1382 if (!isp2 || enum_value_print_p2(base, value, 0) != 0) { 1383 ename = mdb_ctf_enum_name(base, value); 1384 if (ename == NULL) { 1385 ename = "???"; 1386 } 1387 mdb_printf("%s", ename); 1388 } 1389 mdb_printf(")"); 1390 (void) mdb_dec_indent(8); 1391 1392 return (0); 1393 } 1394 1395 /* 1396 * This will only get called if the structure isn't found in any available CTF 1397 * data. 1398 */ 1399 /*ARGSUSED*/ 1400 static int 1401 print_tag(const char *type, const char *name, mdb_ctf_id_t id, 1402 mdb_ctf_id_t base, ulong_t off, printarg_t *pap) 1403 { 1404 char basename[MDB_SYM_NAMLEN]; 1405 1406 if (pap->pa_flags & PA_SHOWVAL) 1407 mdb_printf("; "); 1408 1409 if (mdb_ctf_type_name(base, basename, sizeof (basename)) != NULL) 1410 mdb_printf("<forward declaration of %s>", basename); 1411 else 1412 mdb_printf("<forward declaration of unknown type>"); 1413 1414 return (0); 1415 } 1416 1417 static void 1418 print_hole(printarg_t *pap, int depth, ulong_t off, ulong_t endoff) 1419 { 1420 ulong_t bits = endoff - off; 1421 ulong_t size = bits / NBBY; 1422 ctf_encoding_t e; 1423 1424 static const char *const name = "<<HOLE>>"; 1425 char type[MDB_SYM_NAMLEN]; 1426 1427 int bitfield = 1428 (off % NBBY != 0 || 1429 bits % NBBY != 0 || 1430 size > 8 || 1431 (size & (size - 1)) != 0); 1432 1433 ASSERT(off < endoff); 1434 1435 if (bits > NBBY * sizeof (uint64_t)) { 1436 ulong_t end; 1437 1438 /* 1439 * The hole is larger than the largest integer type. To 1440 * handle this, we split up the hole at 8-byte-aligned 1441 * boundaries, recursing to print each subsection. For 1442 * normal C structures, we'll loop at most twice. 1443 */ 1444 for (; off < endoff; off = end) { 1445 end = P2END(off, NBBY * sizeof (uint64_t)); 1446 if (end > endoff) 1447 end = endoff; 1448 1449 ASSERT((end - off) <= NBBY * sizeof (uint64_t)); 1450 print_hole(pap, depth, off, end); 1451 } 1452 ASSERT(end == endoff); 1453 1454 return; 1455 } 1456 1457 if (bitfield) 1458 (void) mdb_snprintf(type, sizeof (type), "unsigned"); 1459 else 1460 (void) mdb_snprintf(type, sizeof (type), "uint%d_t", bits); 1461 1462 if (pap->pa_flags & (PA_SHOWTYPE | PA_SHOWNAME | PA_SHOWADDR)) 1463 mdb_printf("%*s", (depth + pap->pa_nest) * pap->pa_tab, ""); 1464 1465 if (pap->pa_flags & PA_SHOWADDR) { 1466 if (off % NBBY == 0) 1467 mdb_printf("%llx ", pap->pa_addr + off / NBBY); 1468 else 1469 mdb_printf("%llx.%lx ", 1470 pap->pa_addr + off / NBBY, off % NBBY); 1471 } 1472 1473 if (pap->pa_flags & PA_SHOWTYPE) 1474 mdb_printf("%s ", type); 1475 1476 if (pap->pa_flags & PA_SHOWNAME) 1477 mdb_printf("%s", name); 1478 1479 if (bitfield && (pap->pa_flags & PA_SHOWTYPE)) 1480 mdb_printf(" :%d", bits); 1481 1482 mdb_printf("%s ", (pap->pa_flags & PA_SHOWVAL)? " =" : ""); 1483 1484 /* 1485 * We fake up a ctf_encoding_t, and use print_int_val() to print 1486 * the value. Holes are always processed as unsigned integers. 1487 */ 1488 bzero(&e, sizeof (e)); 1489 e.cte_format = 0; 1490 e.cte_offset = 0; 1491 e.cte_bits = bits; 1492 1493 if (print_int_val(type, &e, off, pap) != 0) 1494 mdb_iob_discard(mdb.m_out); 1495 else 1496 mdb_iob_puts(mdb.m_out, pap->pa_delim); 1497 } 1498 1499 /* 1500 * The print_close_sou() function is called for each structure or union 1501 * which has been completed. For structures, we detect and print any holes 1502 * before printing the closing brace. 1503 */ 1504 static void 1505 print_close_sou(printarg_t *pap, int newdepth) 1506 { 1507 int d = newdepth + pap->pa_nest; 1508 1509 if ((pap->pa_flags & PA_SHOWHOLES) && !pap->pa_holes[d].hi_isunion) { 1510 ulong_t end = pap->pa_holes[d + 1].hi_offset; 1511 ulong_t expected = pap->pa_holes[d].hi_offset; 1512 1513 if (end < expected) 1514 print_hole(pap, newdepth + 1, end, expected); 1515 } 1516 /* if the struct is an array element, print a comma after the } */ 1517 mdb_printf("%*s}%s\n", d * pap->pa_tab, "", 1518 (newdepth == 0 && pap->pa_nest > 0)? "," : ""); 1519 } 1520 1521 static printarg_f *const printfuncs[] = { 1522 print_int, /* CTF_K_INTEGER */ 1523 print_float, /* CTF_K_FLOAT */ 1524 print_ptr, /* CTF_K_POINTER */ 1525 print_array, /* CTF_K_ARRAY */ 1526 print_ptr, /* CTF_K_FUNCTION */ 1527 print_sou, /* CTF_K_STRUCT */ 1528 print_sou, /* CTF_K_UNION */ 1529 print_enum, /* CTF_K_ENUM */ 1530 print_tag /* CTF_K_FORWARD */ 1531 }; 1532 1533 /* 1534 * The elt_print function is used as the mdb_ctf_type_visit callback. For 1535 * each element, we print an appropriate name prefix and then call the 1536 * print subroutine for this type class in the array above. 1537 */ 1538 static int 1539 elt_print(const char *name, mdb_ctf_id_t id, mdb_ctf_id_t base, 1540 ulong_t off, int depth, void *data) 1541 { 1542 char type[MDB_SYM_NAMLEN + sizeof (" <<12345678...>>")]; 1543 int kind, rc, d; 1544 printarg_t *pap = data; 1545 1546 for (d = pap->pa_depth - 1; d >= depth; d--) { 1547 if (d < pap->pa_nooutdepth) 1548 print_close_sou(pap, d); 1549 } 1550 1551 /* 1552 * Reset pa_nooutdepth if we've come back out of the structure we 1553 * didn't want to print. 1554 */ 1555 if (depth <= pap->pa_nooutdepth) 1556 pap->pa_nooutdepth = (uint_t)-1; 1557 1558 if (depth > pap->pa_maxdepth || depth > pap->pa_nooutdepth) 1559 return (0); 1560 1561 if (!mdb_ctf_type_valid(base) || 1562 (kind = mdb_ctf_type_kind(base)) == -1) 1563 return (-1); /* errno is set for us */ 1564 1565 if (mdb_ctf_type_name(id, type, MDB_SYM_NAMLEN) == NULL) 1566 (void) strcpy(type, "(?)"); 1567 1568 if (pap->pa_flags & PA_SHOWBASETYPE) { 1569 /* 1570 * If basetype is different and informative, concatenate 1571 * <<basetype>> (or <<baset...>> if it doesn't fit) 1572 * 1573 * We just use the end of the buffer to store the type name, and 1574 * only connect it up if that's necessary. 1575 */ 1576 1577 char *type_end = type + strlen(type); 1578 char *basetype; 1579 size_t sz; 1580 1581 (void) strlcat(type, " <<", sizeof (type)); 1582 1583 basetype = type + strlen(type); 1584 sz = sizeof (type) - (basetype - type); 1585 1586 *type_end = '\0'; /* restore the end of type for strcmp() */ 1587 1588 if (mdb_ctf_type_name(base, basetype, sz) != NULL && 1589 strcmp(basetype, type) != 0 && 1590 strcmp(basetype, "struct ") != 0 && 1591 strcmp(basetype, "enum ") != 0 && 1592 strcmp(basetype, "union ") != 0) { 1593 type_end[0] = ' '; /* reconnect */ 1594 if (strlcat(type, ">>", sizeof (type)) >= sizeof (type)) 1595 (void) strlcpy( 1596 type + sizeof (type) - 6, "...>>", 6); 1597 } 1598 } 1599 1600 if (pap->pa_flags & PA_SHOWHOLES) { 1601 ctf_encoding_t e; 1602 ssize_t nsize; 1603 ulong_t newoff; 1604 holeinfo_t *hole; 1605 int extra = IS_COMPOSITE(kind)? 1 : 0; 1606 1607 /* 1608 * grow the hole array, if necessary 1609 */ 1610 if (pap->pa_nest + depth + extra >= pap->pa_nholes) { 1611 int new = MAX(MAX(8, pap->pa_nholes * 2), 1612 pap->pa_nest + depth + extra + 1); 1613 1614 holeinfo_t *nhi = mdb_zalloc( 1615 sizeof (*nhi) * new, UM_NOSLEEP | UM_GC); 1616 1617 bcopy(pap->pa_holes, nhi, 1618 pap->pa_nholes * sizeof (*nhi)); 1619 1620 pap->pa_holes = nhi; 1621 pap->pa_nholes = new; 1622 } 1623 1624 hole = &pap->pa_holes[depth + pap->pa_nest]; 1625 1626 if (depth != 0 && off > hole->hi_offset) 1627 print_hole(pap, depth, hole->hi_offset, off); 1628 1629 /* compute the next expected offset */ 1630 if (kind == CTF_K_INTEGER && 1631 mdb_ctf_type_encoding(base, &e) == 0) 1632 newoff = off + e.cte_bits; 1633 else if ((nsize = mdb_ctf_type_size(base)) >= 0) 1634 newoff = off + nsize * NBBY; 1635 else { 1636 /* something bad happened, disable hole checking */ 1637 newoff = -1UL; /* ULONG_MAX */ 1638 } 1639 1640 hole->hi_offset = newoff; 1641 1642 if (IS_COMPOSITE(kind)) { 1643 hole->hi_isunion = (kind == CTF_K_UNION); 1644 hole++; 1645 hole->hi_offset = off; 1646 } 1647 } 1648 1649 if (pap->pa_flags & (PA_SHOWTYPE | PA_SHOWNAME | PA_SHOWADDR)) 1650 mdb_printf("%*s", (depth + pap->pa_nest) * pap->pa_tab, ""); 1651 1652 if (pap->pa_flags & PA_SHOWADDR) { 1653 if (off % NBBY == 0) 1654 mdb_printf("%llx ", pap->pa_addr + off / NBBY); 1655 else 1656 mdb_printf("%llx.%lx ", 1657 pap->pa_addr + off / NBBY, off % NBBY); 1658 } 1659 1660 if ((pap->pa_flags & PA_SHOWTYPE)) { 1661 mdb_printf("%s", type); 1662 /* 1663 * We want to avoid printing a trailing space when 1664 * dealing with pointers in a structure, so we end 1665 * up with: 1666 * 1667 * label_t *t_onfault = 0 1668 * 1669 * If depth is zero, always print the trailing space unless 1670 * we also have a prefix. 1671 */ 1672 if (type[strlen(type) - 1] != '*' || 1673 (depth == 0 && (!(pap->pa_flags & PA_SHOWNAME) || 1674 pap->pa_prefix == NULL))) 1675 mdb_printf(" "); 1676 } 1677 1678 if (pap->pa_flags & PA_SHOWNAME) { 1679 if (pap->pa_prefix != NULL && depth <= 1) 1680 mdb_printf("%s%s", pap->pa_prefix, 1681 (depth == 0) ? "" : pap->pa_suffix); 1682 mdb_printf("%s", name); 1683 } 1684 1685 if ((pap->pa_flags & PA_SHOWTYPE) && kind == CTF_K_INTEGER) { 1686 ctf_encoding_t e; 1687 1688 if (mdb_ctf_type_encoding(base, &e) == 0) { 1689 ulong_t bits = e.cte_bits; 1690 ulong_t size = bits / NBBY; 1691 1692 if (bits % NBBY != 0 || 1693 off % NBBY != 0 || 1694 size > 8 || 1695 size != mdb_ctf_type_size(base)) 1696 mdb_printf(" :%d", bits); 1697 } 1698 } 1699 1700 if (depth != 0 || 1701 ((pap->pa_flags & PA_SHOWNAME) && pap->pa_prefix != NULL)) 1702 mdb_printf("%s ", pap->pa_flags & PA_SHOWVAL ? " =" : ""); 1703 1704 if (depth == 0 && pap->pa_prefix != NULL) 1705 name = pap->pa_prefix; 1706 1707 pap->pa_depth = depth; 1708 if (kind <= CTF_K_UNKNOWN || kind >= CTF_K_TYPEDEF) { 1709 mdb_warn("unknown ctf for %s type %s kind %d\n", 1710 name, type, kind); 1711 return (-1); 1712 } 1713 rc = printfuncs[kind - 1](type, name, id, base, off, pap); 1714 1715 if (rc != 0) 1716 mdb_iob_discard(mdb.m_out); 1717 else 1718 mdb_iob_puts(mdb.m_out, pap->pa_delim); 1719 1720 return (rc); 1721 } 1722 1723 /* 1724 * Special semantics for pipelines. 1725 */ 1726 static int 1727 pipe_print(mdb_ctf_id_t id, ulong_t off, void *data) 1728 { 1729 printarg_t *pap = data; 1730 ssize_t size; 1731 static const char *const fsp[] = { "%#r", "%#r", "%#r", "%#llr" }; 1732 uintptr_t value; 1733 uintptr_t addr = pap->pa_addr + off / NBBY; 1734 mdb_ctf_id_t base; 1735 int enum_value; 1736 ctf_encoding_t e; 1737 1738 union { 1739 uint64_t i8; 1740 uint32_t i4; 1741 uint16_t i2; 1742 uint8_t i1; 1743 } u; 1744 1745 if (mdb_ctf_type_resolve(id, &base) == -1) { 1746 mdb_warn("could not resolve type"); 1747 return (-1); 1748 } 1749 1750 /* 1751 * If the user gives -a, then always print out the address of the 1752 * member. 1753 */ 1754 if ((pap->pa_flags & PA_SHOWADDR)) { 1755 mdb_printf("%#lr\n", addr); 1756 return (0); 1757 } 1758 1759 again: 1760 switch (mdb_ctf_type_kind(base)) { 1761 case CTF_K_POINTER: 1762 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, 1763 &value, sizeof (value), addr) != sizeof (value)) { 1764 mdb_warn("failed to read pointer at %p", addr); 1765 return (-1); 1766 } 1767 mdb_printf("%#lr\n", value); 1768 break; 1769 1770 case CTF_K_ENUM: 1771 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, &enum_value, 1772 sizeof (enum_value), addr) != sizeof (enum_value)) { 1773 mdb_warn("failed to read enum at %llx", addr); 1774 return (-1); 1775 } 1776 mdb_printf("%#r\n", enum_value); 1777 break; 1778 1779 case CTF_K_INTEGER: 1780 if (mdb_ctf_type_encoding(base, &e) != 0) { 1781 mdb_warn("could not get type encoding\n"); 1782 return (-1); 1783 } 1784 1785 /* 1786 * For immediate values, we just print out the value. 1787 */ 1788 size = e.cte_bits / NBBY; 1789 if (size > 8 || (e.cte_bits % NBBY) != 0 || 1790 (size & (size - 1)) != 0) { 1791 return (print_bitfield(off, pap, &e)); 1792 } 1793 1794 if (mdb_tgt_aread(pap->pa_tgt, pap->pa_as, &u.i8, size, 1795 addr) != size) { 1796 mdb_warn("failed to read %lu bytes at %p", 1797 (ulong_t)size, pap->pa_addr); 1798 return (-1); 1799 } 1800 1801 switch (size) { 1802 case sizeof (uint8_t): 1803 mdb_printf(fsp[0], u.i1); 1804 break; 1805 case sizeof (uint16_t): 1806 mdb_printf(fsp[1], u.i2); 1807 break; 1808 case sizeof (uint32_t): 1809 mdb_printf(fsp[2], u.i4); 1810 break; 1811 case sizeof (uint64_t): 1812 mdb_printf(fsp[3], u.i8); 1813 break; 1814 } 1815 mdb_printf("\n"); 1816 break; 1817 1818 case CTF_K_FUNCTION: 1819 case CTF_K_FLOAT: 1820 case CTF_K_ARRAY: 1821 case CTF_K_UNKNOWN: 1822 case CTF_K_STRUCT: 1823 case CTF_K_UNION: 1824 case CTF_K_FORWARD: 1825 /* 1826 * For these types, always print the address of the member 1827 */ 1828 mdb_printf("%#lr\n", addr); 1829 break; 1830 1831 default: 1832 mdb_warn("unknown type %d", mdb_ctf_type_kind(base)); 1833 break; 1834 } 1835 1836 return (0); 1837 } 1838 1839 static int 1840 parse_delimiter(char **strp) 1841 { 1842 switch (**strp) { 1843 case '\0': 1844 return (MEMBER_DELIM_DONE); 1845 1846 case '.': 1847 *strp = *strp + 1; 1848 return (MEMBER_DELIM_DOT); 1849 1850 case '[': 1851 *strp = *strp + 1; 1852 return (MEMBER_DELIM_LBR); 1853 1854 case '-': 1855 *strp = *strp + 1; 1856 if (**strp == '>') { 1857 *strp = *strp + 1; 1858 return (MEMBER_DELIM_PTR); 1859 } 1860 *strp = *strp - 1; 1861 /*FALLTHROUGH*/ 1862 default: 1863 return (MEMBER_DELIM_ERR); 1864 } 1865 } 1866 1867 static int 1868 deref(printarg_t *pap, size_t size) 1869 { 1870 uint32_t a32; 1871 mdb_tgt_as_t as = pap->pa_as; 1872 mdb_tgt_addr_t *ap = &pap->pa_addr; 1873 1874 if (size == sizeof (mdb_tgt_addr_t)) { 1875 if (mdb_tgt_aread(mdb.m_target, as, ap, size, *ap) == -1) { 1876 mdb_warn("could not dereference pointer %llx\n", *ap); 1877 return (-1); 1878 } 1879 } else { 1880 if (mdb_tgt_aread(mdb.m_target, as, &a32, size, *ap) == -1) { 1881 mdb_warn("could not dereference pointer %x\n", *ap); 1882 return (-1); 1883 } 1884 1885 *ap = (mdb_tgt_addr_t)a32; 1886 } 1887 1888 /* 1889 * We've dereferenced at least once, we must be on the real 1890 * target. If we were in the immediate target, reset to the real 1891 * target; it's reset as needed when we return to the print 1892 * routines. 1893 */ 1894 if (pap->pa_tgt == pap->pa_immtgt) 1895 pap->pa_tgt = pap->pa_realtgt; 1896 1897 return (0); 1898 } 1899 1900 static int 1901 parse_member(printarg_t *pap, const char *str, mdb_ctf_id_t id, 1902 mdb_ctf_id_t *idp, ulong_t *offp, int *last_deref) 1903 { 1904 int delim; 1905 char member[64]; 1906 char buf[128]; 1907 uint_t index; 1908 char *start = (char *)str; 1909 char *end; 1910 ulong_t off = 0; 1911 mdb_ctf_arinfo_t ar; 1912 mdb_ctf_id_t rid; 1913 int kind; 1914 ssize_t size; 1915 int non_array = FALSE; 1916 1917 /* 1918 * id always has the unresolved type for printing error messages 1919 * that include the type; rid always has the resolved type for 1920 * use in mdb_ctf_* calls. It is possible for this command to fail, 1921 * however, if the resolved type is in the parent and it is currently 1922 * unavailable. Note that we also can't print out the name of the 1923 * type, since that would also rely on looking up the resolved name. 1924 */ 1925 if (mdb_ctf_type_resolve(id, &rid) != 0) { 1926 mdb_warn("failed to resolve type"); 1927 return (-1); 1928 } 1929 1930 delim = parse_delimiter(&start); 1931 /* 1932 * If the user fails to specify an initial delimiter, guess -> for 1933 * pointer types and . for non-pointer types. 1934 */ 1935 if (delim == MEMBER_DELIM_ERR) 1936 delim = (mdb_ctf_type_kind(rid) == CTF_K_POINTER) ? 1937 MEMBER_DELIM_PTR : MEMBER_DELIM_DOT; 1938 1939 *last_deref = FALSE; 1940 1941 while (delim != MEMBER_DELIM_DONE) { 1942 switch (delim) { 1943 case MEMBER_DELIM_PTR: 1944 kind = mdb_ctf_type_kind(rid); 1945 if (kind != CTF_K_POINTER) { 1946 mdb_warn("%s is not a pointer type\n", 1947 mdb_ctf_type_name(id, buf, sizeof (buf))); 1948 return (-1); 1949 } 1950 1951 size = mdb_ctf_type_size(id); 1952 if (deref(pap, size) != 0) 1953 return (-1); 1954 1955 (void) mdb_ctf_type_reference(rid, &id); 1956 (void) mdb_ctf_type_resolve(id, &rid); 1957 1958 off = 0; 1959 break; 1960 1961 case MEMBER_DELIM_DOT: 1962 kind = mdb_ctf_type_kind(rid); 1963 if (kind != CTF_K_STRUCT && kind != CTF_K_UNION) { 1964 mdb_warn("%s is not a struct or union type\n", 1965 mdb_ctf_type_name(id, buf, sizeof (buf))); 1966 return (-1); 1967 } 1968 break; 1969 1970 case MEMBER_DELIM_LBR: 1971 end = strchr(start, ']'); 1972 if (end == NULL) { 1973 mdb_warn("no trailing ']'\n"); 1974 return (-1); 1975 } 1976 1977 (void) mdb_snprintf(member, end - start + 1, "%s", 1978 start); 1979 1980 index = mdb_strtoull(member); 1981 1982 switch (mdb_ctf_type_kind(rid)) { 1983 case CTF_K_POINTER: 1984 size = mdb_ctf_type_size(rid); 1985 1986 if (deref(pap, size) != 0) 1987 return (-1); 1988 1989 (void) mdb_ctf_type_reference(rid, &id); 1990 (void) mdb_ctf_type_resolve(id, &rid); 1991 1992 size = mdb_ctf_type_size(id); 1993 if (size <= 0) { 1994 mdb_warn("cannot dereference void " 1995 "type\n"); 1996 return (-1); 1997 } 1998 1999 pap->pa_addr += index * size; 2000 off = 0; 2001 2002 if (index == 0 && non_array) 2003 *last_deref = TRUE; 2004 break; 2005 2006 case CTF_K_ARRAY: 2007 (void) mdb_ctf_array_info(rid, &ar); 2008 2009 if (index >= ar.mta_nelems) { 2010 mdb_warn("index %r is outside of " 2011 "array bounds [0 .. %r]\n", 2012 index, ar.mta_nelems - 1); 2013 } 2014 2015 id = ar.mta_contents; 2016 (void) mdb_ctf_type_resolve(id, &rid); 2017 2018 size = mdb_ctf_type_size(id); 2019 if (size <= 0) { 2020 mdb_warn("cannot dereference void " 2021 "type\n"); 2022 return (-1); 2023 } 2024 2025 pap->pa_addr += index * size; 2026 off = 0; 2027 break; 2028 2029 default: 2030 mdb_warn("cannot index into non-array, " 2031 "non-pointer type\n"); 2032 return (-1); 2033 } 2034 2035 start = end + 1; 2036 delim = parse_delimiter(&start); 2037 continue; 2038 2039 case MEMBER_DELIM_ERR: 2040 default: 2041 mdb_warn("'%c' is not a valid delimiter\n", *start); 2042 return (-1); 2043 } 2044 2045 *last_deref = FALSE; 2046 non_array = TRUE; 2047 2048 /* 2049 * Find the end of the member name; assume that a member 2050 * name is at least one character long. 2051 */ 2052 for (end = start + 1; isalnum(*end) || *end == '_'; end++) 2053 continue; 2054 2055 (void) mdb_snprintf(member, end - start + 1, "%s", start); 2056 2057 if (mdb_ctf_member_info(rid, member, &off, &id) != 0) { 2058 mdb_warn("failed to find member %s of %s", member, 2059 mdb_ctf_type_name(id, buf, sizeof (buf))); 2060 return (-1); 2061 } 2062 (void) mdb_ctf_type_resolve(id, &rid); 2063 2064 pap->pa_addr += off / NBBY; 2065 2066 start = end; 2067 delim = parse_delimiter(&start); 2068 } 2069 2070 *idp = id; 2071 *offp = off; 2072 2073 return (0); 2074 } 2075 2076 static int 2077 cmd_print_tab_common(mdb_tab_cookie_t *mcp, uint_t flags, int argc, 2078 const mdb_arg_t *argv) 2079 { 2080 char tn[MDB_SYM_NAMLEN]; 2081 char member[64]; 2082 int delim, kind; 2083 int ret = 0; 2084 mdb_ctf_id_t id, rid; 2085 mdb_ctf_arinfo_t ar; 2086 char *start, *end; 2087 ulong_t dul; 2088 2089 if (argc == 0 && !(flags & DCMD_TAB_SPACE)) 2090 return (0); 2091 2092 if (argc == 0 && (flags & DCMD_TAB_SPACE)) 2093 return (mdb_tab_complete_type(mcp, NULL, MDB_TABC_NOPOINT | 2094 MDB_TABC_NOARRAY)); 2095 2096 if ((ret = mdb_tab_typename(&argc, &argv, tn, sizeof (tn))) < 0) 2097 return (ret); 2098 2099 if (argc == 1 && (!(flags & DCMD_TAB_SPACE) || ret == 1)) 2100 return (mdb_tab_complete_type(mcp, tn, MDB_TABC_NOPOINT | 2101 MDB_TABC_NOARRAY)); 2102 2103 if (argc == 1 && (flags & DCMD_TAB_SPACE)) 2104 return (mdb_tab_complete_member(mcp, tn, NULL)); 2105 2106 /* 2107 * This is the reason that tab completion was created. We're going to go 2108 * along and walk the delimiters until we find something a member that 2109 * we don't recognize, at which point we'll try and tab complete it. 2110 * Note that ::print takes multiple args, so this is going to operate on 2111 * whatever the last arg that we have is. 2112 */ 2113 if (mdb_ctf_lookup_by_name(tn, &id) != 0) 2114 return (1); 2115 2116 (void) mdb_ctf_type_resolve(id, &rid); 2117 start = (char *)argv[argc-1].a_un.a_str; 2118 delim = parse_delimiter(&start); 2119 2120 /* 2121 * If we hit the case where we actually have no delimiters, than we need 2122 * to make sure that we properly set up the fields the loops would. 2123 */ 2124 if (delim == MEMBER_DELIM_DONE) 2125 (void) mdb_snprintf(member, sizeof (member), "%s", start); 2126 2127 while (delim != MEMBER_DELIM_DONE) { 2128 switch (delim) { 2129 case MEMBER_DELIM_PTR: 2130 kind = mdb_ctf_type_kind(rid); 2131 if (kind != CTF_K_POINTER) 2132 return (1); 2133 2134 (void) mdb_ctf_type_reference(rid, &id); 2135 (void) mdb_ctf_type_resolve(id, &rid); 2136 break; 2137 case MEMBER_DELIM_DOT: 2138 kind = mdb_ctf_type_kind(rid); 2139 if (kind != CTF_K_STRUCT && kind != CTF_K_UNION) 2140 return (1); 2141 break; 2142 case MEMBER_DELIM_LBR: 2143 end = strchr(start, ']'); 2144 /* 2145 * We're not going to try and tab complete the indexes 2146 * here. So for now, punt on it. Also, we're not going 2147 * to try and validate you're within the bounds, just 2148 * that you get the type you asked for. 2149 */ 2150 if (end == NULL) 2151 return (1); 2152 2153 switch (mdb_ctf_type_kind(rid)) { 2154 case CTF_K_POINTER: 2155 (void) mdb_ctf_type_reference(rid, &id); 2156 (void) mdb_ctf_type_resolve(id, &rid); 2157 break; 2158 case CTF_K_ARRAY: 2159 (void) mdb_ctf_array_info(rid, &ar); 2160 id = ar.mta_contents; 2161 (void) mdb_ctf_type_resolve(id, &rid); 2162 break; 2163 default: 2164 return (1); 2165 } 2166 2167 start = end + 1; 2168 delim = parse_delimiter(&start); 2169 break; 2170 case MEMBER_DELIM_ERR: 2171 default: 2172 break; 2173 } 2174 2175 for (end = start + 1; isalnum(*end) || *end == '_'; end++) 2176 continue; 2177 2178 (void) mdb_snprintf(member, end - start + 1, start); 2179 2180 /* 2181 * We are going to try to resolve this name as a member. There 2182 * are a few two different questions that we need to answer. The 2183 * first is do we recognize this member. The second is are we at 2184 * the end of the string. If we encounter a member that we don't 2185 * recognize before the end, then we have to error out and can't 2186 * complete it. But if there are no more delimiters then we can 2187 * try and complete it. 2188 */ 2189 ret = mdb_ctf_member_info(rid, member, &dul, &id); 2190 start = end; 2191 delim = parse_delimiter(&start); 2192 if (ret != 0 && errno == EMDB_CTFNOMEMB) { 2193 if (delim != MEMBER_DELIM_DONE) 2194 return (1); 2195 continue; 2196 } else if (ret != 0) 2197 return (1); 2198 2199 if (delim == MEMBER_DELIM_DONE) 2200 return (mdb_tab_complete_member_by_id(mcp, rid, 2201 member)); 2202 2203 (void) mdb_ctf_type_resolve(id, &rid); 2204 } 2205 2206 /* 2207 * If we've reached here, then we need to try and tab complete the last 2208 * field, which is currently member, based on the ctf type id that we 2209 * already have in rid. 2210 */ 2211 return (mdb_tab_complete_member_by_id(mcp, rid, member)); 2212 } 2213 2214 int 2215 cmd_print_tab(mdb_tab_cookie_t *mcp, uint_t flags, int argc, 2216 const mdb_arg_t *argv) 2217 { 2218 int i, dummy; 2219 2220 /* 2221 * This getopts is only here to make the tab completion work better when 2222 * including options in the ::print arguments. None of the values should 2223 * be used. This should only be updated with additional arguments, if 2224 * they are added to cmd_print. 2225 */ 2226 i = mdb_getopts(argc, argv, 2227 'a', MDB_OPT_SETBITS, PA_SHOWADDR, &dummy, 2228 'C', MDB_OPT_SETBITS, TRUE, &dummy, 2229 'c', MDB_OPT_UINTPTR, &dummy, 2230 'd', MDB_OPT_SETBITS, PA_INTDEC, &dummy, 2231 'h', MDB_OPT_SETBITS, PA_SHOWHOLES, &dummy, 2232 'i', MDB_OPT_SETBITS, TRUE, &dummy, 2233 'L', MDB_OPT_SETBITS, TRUE, &dummy, 2234 'l', MDB_OPT_UINTPTR, &dummy, 2235 'n', MDB_OPT_SETBITS, PA_NOSYMBOLIC, &dummy, 2236 'p', MDB_OPT_SETBITS, TRUE, &dummy, 2237 's', MDB_OPT_UINTPTR, &dummy, 2238 'T', MDB_OPT_SETBITS, PA_SHOWTYPE | PA_SHOWBASETYPE, &dummy, 2239 't', MDB_OPT_SETBITS, PA_SHOWTYPE, &dummy, 2240 'x', MDB_OPT_SETBITS, PA_INTHEX, &dummy, 2241 NULL); 2242 2243 argc -= i; 2244 argv += i; 2245 2246 return (cmd_print_tab_common(mcp, flags, argc, argv)); 2247 } 2248 2249 /* 2250 * Recursively descend a print a given data structure. We create a struct of 2251 * the relevant print arguments and then call mdb_ctf_type_visit() to do the 2252 * traversal, using elt_print() as the callback for each element. 2253 */ 2254 /*ARGSUSED*/ 2255 int 2256 cmd_print(uintptr_t addr, uint_t flags, int argc, const mdb_arg_t *argv) 2257 { 2258 uintptr_t opt_c = MDB_ARR_NOLIMIT, opt_l = MDB_ARR_NOLIMIT; 2259 uint_t opt_C = FALSE, opt_L = FALSE, opt_p = FALSE, opt_i = FALSE; 2260 uintptr_t opt_s = (uintptr_t)-1ul; 2261 int uflags = (flags & DCMD_ADDRSPEC) ? PA_SHOWVAL : 0; 2262 mdb_ctf_id_t id; 2263 int err = DCMD_OK; 2264 2265 mdb_tgt_t *t = mdb.m_target; 2266 printarg_t pa; 2267 int d, i; 2268 2269 char s_name[MDB_SYM_NAMLEN]; 2270 mdb_syminfo_t s_info; 2271 GElf_Sym sym; 2272 2273 /* 2274 * If a new option is added, make sure the getopts above in 2275 * cmd_print_tab is also updated. 2276 */ 2277 i = mdb_getopts(argc, argv, 2278 'a', MDB_OPT_SETBITS, PA_SHOWADDR, &uflags, 2279 'C', MDB_OPT_SETBITS, TRUE, &opt_C, 2280 'c', MDB_OPT_UINTPTR, &opt_c, 2281 'd', MDB_OPT_SETBITS, PA_INTDEC, &uflags, 2282 'h', MDB_OPT_SETBITS, PA_SHOWHOLES, &uflags, 2283 'i', MDB_OPT_SETBITS, TRUE, &opt_i, 2284 'L', MDB_OPT_SETBITS, TRUE, &opt_L, 2285 'l', MDB_OPT_UINTPTR, &opt_l, 2286 'n', MDB_OPT_SETBITS, PA_NOSYMBOLIC, &uflags, 2287 'p', MDB_OPT_SETBITS, TRUE, &opt_p, 2288 's', MDB_OPT_UINTPTR, &opt_s, 2289 'T', MDB_OPT_SETBITS, PA_SHOWTYPE | PA_SHOWBASETYPE, &uflags, 2290 't', MDB_OPT_SETBITS, PA_SHOWTYPE, &uflags, 2291 'x', MDB_OPT_SETBITS, PA_INTHEX, &uflags, 2292 NULL); 2293 2294 if (uflags & PA_INTHEX) 2295 uflags &= ~PA_INTDEC; /* -x and -d are mutually exclusive */ 2296 2297 uflags |= PA_SHOWNAME; 2298 2299 if (opt_p && opt_i) { 2300 mdb_warn("-p and -i options are incompatible\n"); 2301 return (DCMD_ERR); 2302 } 2303 2304 argc -= i; 2305 argv += i; 2306 2307 if (argc != 0 && argv->a_type == MDB_TYPE_STRING) { 2308 const char *t_name = s_name; 2309 int ret; 2310 2311 if (strchr("+-", argv->a_un.a_str[0]) != NULL) 2312 return (DCMD_USAGE); 2313 2314 if ((ret = args_to_typename(&argc, &argv, s_name, 2315 sizeof (s_name))) != 0) 2316 return (ret); 2317 2318 if (mdb_ctf_lookup_by_name(t_name, &id) != 0) { 2319 if (!(flags & DCMD_ADDRSPEC) || opt_i || 2320 addr_to_sym(t, addr, s_name, sizeof (s_name), 2321 &sym, &s_info) == NULL || 2322 mdb_ctf_lookup_by_symbol(&sym, &s_info, &id) != 0) { 2323 2324 mdb_warn("failed to look up type %s", t_name); 2325 return (DCMD_ABORT); 2326 } 2327 } else { 2328 argc--; 2329 argv++; 2330 } 2331 2332 } else if (!(flags & DCMD_ADDRSPEC) || opt_i) { 2333 return (DCMD_USAGE); 2334 2335 } else if (addr_to_sym(t, addr, s_name, sizeof (s_name), 2336 &sym, &s_info) == NULL) { 2337 mdb_warn("no symbol information for %a", addr); 2338 return (DCMD_ERR); 2339 2340 } else if (mdb_ctf_lookup_by_symbol(&sym, &s_info, &id) != 0) { 2341 mdb_warn("no type data available for %a [%u]", addr, 2342 s_info.sym_id); 2343 return (DCMD_ERR); 2344 } 2345 2346 pa.pa_tgt = mdb.m_target; 2347 pa.pa_realtgt = pa.pa_tgt; 2348 pa.pa_immtgt = NULL; 2349 pa.pa_as = opt_p ? MDB_TGT_AS_PHYS : MDB_TGT_AS_VIRT; 2350 pa.pa_armemlim = mdb.m_armemlim; 2351 pa.pa_arstrlim = mdb.m_arstrlim; 2352 pa.pa_delim = "\n"; 2353 pa.pa_flags = uflags; 2354 pa.pa_nest = 0; 2355 pa.pa_tab = 4; 2356 pa.pa_prefix = NULL; 2357 pa.pa_suffix = NULL; 2358 pa.pa_holes = NULL; 2359 pa.pa_nholes = 0; 2360 pa.pa_depth = 0; 2361 pa.pa_maxdepth = opt_s; 2362 pa.pa_nooutdepth = (uint_t)-1; 2363 2364 if ((flags & DCMD_ADDRSPEC) && !opt_i) 2365 pa.pa_addr = opt_p ? mdb_get_dot() : addr; 2366 else 2367 pa.pa_addr = NULL; 2368 2369 if (opt_i) { 2370 const char *vargv[2]; 2371 uintmax_t dot = mdb_get_dot(); 2372 size_t outsize = mdb_ctf_type_size(id); 2373 vargv[0] = (const char *)˙ 2374 vargv[1] = (const char *)&outsize; 2375 pa.pa_immtgt = mdb_tgt_create(mdb_value_tgt_create, 2376 0, 2, vargv); 2377 pa.pa_tgt = pa.pa_immtgt; 2378 } 2379 2380 if (opt_c != MDB_ARR_NOLIMIT) 2381 pa.pa_arstrlim = opt_c; 2382 if (opt_C) 2383 pa.pa_arstrlim = MDB_ARR_NOLIMIT; 2384 if (opt_l != MDB_ARR_NOLIMIT) 2385 pa.pa_armemlim = opt_l; 2386 if (opt_L) 2387 pa.pa_armemlim = MDB_ARR_NOLIMIT; 2388 2389 if (argc > 0) { 2390 for (i = 0; i < argc; i++) { 2391 mdb_ctf_id_t mid; 2392 int last_deref; 2393 ulong_t off; 2394 int kind; 2395 char buf[MDB_SYM_NAMLEN]; 2396 2397 mdb_tgt_t *oldtgt = pa.pa_tgt; 2398 mdb_tgt_as_t oldas = pa.pa_as; 2399 mdb_tgt_addr_t oldaddr = pa.pa_addr; 2400 2401 if (argv->a_type == MDB_TYPE_STRING) { 2402 const char *member = argv[i].a_un.a_str; 2403 mdb_ctf_id_t rid; 2404 2405 if (parse_member(&pa, member, id, &mid, 2406 &off, &last_deref) != 0) { 2407 err = DCMD_ABORT; 2408 goto out; 2409 } 2410 2411 /* 2412 * If the member string ends with a "[0]" 2413 * (last_deref * is true) and the type is a 2414 * structure or union, * print "->" rather 2415 * than "[0]." in elt_print. 2416 */ 2417 (void) mdb_ctf_type_resolve(mid, &rid); 2418 kind = mdb_ctf_type_kind(rid); 2419 if (last_deref && IS_SOU(kind)) { 2420 char *end; 2421 (void) mdb_snprintf(buf, sizeof (buf), 2422 "%s", member); 2423 end = strrchr(buf, '['); 2424 *end = '\0'; 2425 pa.pa_suffix = "->"; 2426 member = &buf[0]; 2427 } else if (IS_SOU(kind)) { 2428 pa.pa_suffix = "."; 2429 } else { 2430 pa.pa_suffix = ""; 2431 } 2432 2433 pa.pa_prefix = member; 2434 } else { 2435 ulong_t moff; 2436 2437 moff = (ulong_t)argv[i].a_un.a_val; 2438 2439 if (mdb_ctf_offset_to_name(id, moff * NBBY, 2440 buf, sizeof (buf), 0, &mid, &off) == -1) { 2441 mdb_warn("invalid offset %lx\n", moff); 2442 err = DCMD_ABORT; 2443 goto out; 2444 } 2445 2446 pa.pa_prefix = buf; 2447 pa.pa_addr += moff - off / NBBY; 2448 pa.pa_suffix = strlen(buf) == 0 ? "" : "."; 2449 } 2450 2451 off %= NBBY; 2452 if (flags & DCMD_PIPE_OUT) { 2453 if (pipe_print(mid, off, &pa) != 0) { 2454 mdb_warn("failed to print type"); 2455 err = DCMD_ERR; 2456 goto out; 2457 } 2458 } else if (off != 0) { 2459 mdb_ctf_id_t base; 2460 (void) mdb_ctf_type_resolve(mid, &base); 2461 2462 if (elt_print("", mid, base, off, 0, 2463 &pa) != 0) { 2464 mdb_warn("failed to print type"); 2465 err = DCMD_ERR; 2466 goto out; 2467 } 2468 } else { 2469 if (mdb_ctf_type_visit(mid, elt_print, 2470 &pa) == -1) { 2471 mdb_warn("failed to print type"); 2472 err = DCMD_ERR; 2473 goto out; 2474 } 2475 2476 for (d = pa.pa_depth - 1; d >= 0; d--) 2477 print_close_sou(&pa, d); 2478 } 2479 2480 pa.pa_depth = 0; 2481 pa.pa_tgt = oldtgt; 2482 pa.pa_as = oldas; 2483 pa.pa_addr = oldaddr; 2484 pa.pa_delim = "\n"; 2485 } 2486 2487 } else if (flags & DCMD_PIPE_OUT) { 2488 if (pipe_print(id, 0, &pa) != 0) { 2489 mdb_warn("failed to print type"); 2490 err = DCMD_ERR; 2491 goto out; 2492 } 2493 } else { 2494 if (mdb_ctf_type_visit(id, elt_print, &pa) == -1) { 2495 mdb_warn("failed to print type"); 2496 err = DCMD_ERR; 2497 goto out; 2498 } 2499 2500 for (d = pa.pa_depth - 1; d >= 0; d--) 2501 print_close_sou(&pa, d); 2502 } 2503 2504 mdb_set_dot(addr + mdb_ctf_type_size(id)); 2505 err = DCMD_OK; 2506 out: 2507 if (pa.pa_immtgt) 2508 mdb_tgt_destroy(pa.pa_immtgt); 2509 return (err); 2510 } 2511 2512 void 2513 print_help(void) 2514 { 2515 mdb_printf( 2516 "-a show address of object\n" 2517 "-C unlimit the length of character arrays\n" 2518 "-c limit limit the length of character arrays\n" 2519 "-d output values in decimal\n" 2520 "-h print holes in structures\n" 2521 "-i interpret address as data of the given type\n" 2522 "-L unlimit the length of standard arrays\n" 2523 "-l limit limit the length of standard arrays\n" 2524 "-n don't print pointers as symbol offsets\n" 2525 "-p interpret address as a physical memory address\n" 2526 "-s depth limit the recursion depth\n" 2527 "-T show type and <<base type>> of object\n" 2528 "-t show type of object\n" 2529 "-x output values in hexadecimal\n" 2530 "\n" 2531 "type may be omitted if the C type of addr can be inferred.\n" 2532 "\n" 2533 "Members may be specified with standard C syntax using the\n" 2534 "array indexing operator \"[index]\", structure member\n" 2535 "operator \".\", or structure pointer operator \"->\".\n" 2536 "\n" 2537 "Offsets must use the $[ expression ] syntax\n"); 2538 } 2539 2540 static int 2541 printf_signed(mdb_ctf_id_t id, uintptr_t addr, ulong_t off, char *fmt, 2542 boolean_t sign) 2543 { 2544 ssize_t size; 2545 mdb_ctf_id_t base; 2546 ctf_encoding_t e; 2547 2548 union { 2549 uint64_t ui8; 2550 uint32_t ui4; 2551 uint16_t ui2; 2552 uint8_t ui1; 2553 int64_t i8; 2554 int32_t i4; 2555 int16_t i2; 2556 int8_t i1; 2557 } u; 2558 2559 if (mdb_ctf_type_resolve(id, &base) == -1) { 2560 mdb_warn("could not resolve type"); 2561 return (DCMD_ABORT); 2562 } 2563 2564 switch (mdb_ctf_type_kind(base)) { 2565 case CTF_K_ENUM: 2566 e.cte_format = CTF_INT_SIGNED; 2567 e.cte_offset = 0; 2568 e.cte_bits = mdb_ctf_type_size(id) * NBBY; 2569 break; 2570 case CTF_K_INTEGER: 2571 if (mdb_ctf_type_encoding(base, &e) != 0) { 2572 mdb_warn("could not get type encoding"); 2573 return (DCMD_ABORT); 2574 } 2575 break; 2576 default: 2577 mdb_warn("expected integer type\n"); 2578 return (DCMD_ABORT); 2579 } 2580 2581 if (sign) 2582 sign = e.cte_format & CTF_INT_SIGNED; 2583 2584 size = e.cte_bits / NBBY; 2585 2586 /* 2587 * Check to see if our life has been complicated by the presence of 2588 * a bitfield. If it has, we will print it using logic that is only 2589 * slightly different than that found in print_bitfield(), above. (In 2590 * particular, see the comments there for an explanation of the 2591 * endianness differences in this code.) 2592 */ 2593 if (size > 8 || (e.cte_bits % NBBY) != 0 || 2594 (size & (size - 1)) != 0) { 2595 uint64_t mask = (1ULL << e.cte_bits) - 1; 2596 uint64_t value = 0; 2597 uint8_t *buf = (uint8_t *)&value; 2598 uint8_t shift; 2599 2600 /* 2601 * Round our size up one byte. 2602 */ 2603 size = (e.cte_bits + (NBBY - 1)) / NBBY; 2604 2605 if (e.cte_bits > sizeof (value) * NBBY - 1) { 2606 mdb_printf("invalid bitfield size %u", e.cte_bits); 2607 return (DCMD_ABORT); 2608 } 2609 2610 #ifdef _BIG_ENDIAN 2611 buf += sizeof (value) - size; 2612 off += e.cte_bits; 2613 #endif 2614 2615 if (mdb_vread(buf, size, addr) == -1) { 2616 mdb_warn("failed to read %lu bytes at %p", size, addr); 2617 return (DCMD_ERR); 2618 } 2619 2620 shift = off % NBBY; 2621 #ifdef _BIG_ENDIAN 2622 shift = NBBY - shift; 2623 #endif 2624 2625 /* 2626 * If we have a bit offset within the byte, shift it down. 2627 */ 2628 if (off % NBBY != 0) 2629 value >>= shift; 2630 value &= mask; 2631 2632 if (sign) { 2633 int sshift = sizeof (value) * NBBY - e.cte_bits; 2634 value = ((int64_t)value << sshift) >> sshift; 2635 } 2636 2637 mdb_printf(fmt, value); 2638 return (0); 2639 } 2640 2641 if (mdb_vread(&u.i8, size, addr) == -1) { 2642 mdb_warn("failed to read %lu bytes at %p", (ulong_t)size, addr); 2643 return (DCMD_ERR); 2644 } 2645 2646 switch (size) { 2647 case sizeof (uint8_t): 2648 mdb_printf(fmt, (uint64_t)(sign ? u.i1 : u.ui1)); 2649 break; 2650 case sizeof (uint16_t): 2651 mdb_printf(fmt, (uint64_t)(sign ? u.i2 : u.ui2)); 2652 break; 2653 case sizeof (uint32_t): 2654 mdb_printf(fmt, (uint64_t)(sign ? u.i4 : u.ui4)); 2655 break; 2656 case sizeof (uint64_t): 2657 mdb_printf(fmt, (uint64_t)(sign ? u.i8 : u.ui8)); 2658 break; 2659 } 2660 2661 return (0); 2662 } 2663 2664 static int 2665 printf_int(mdb_ctf_id_t id, uintptr_t addr, ulong_t off, char *fmt) 2666 { 2667 return (printf_signed(id, addr, off, fmt, B_TRUE)); 2668 } 2669 2670 static int 2671 printf_uint(mdb_ctf_id_t id, uintptr_t addr, ulong_t off, char *fmt) 2672 { 2673 return (printf_signed(id, addr, off, fmt, B_FALSE)); 2674 } 2675 2676 /*ARGSUSED*/ 2677 static int 2678 printf_uint32(mdb_ctf_id_t id, uintptr_t addr, ulong_t off, char *fmt) 2679 { 2680 mdb_ctf_id_t base; 2681 ctf_encoding_t e; 2682 uint32_t value; 2683 2684 if (mdb_ctf_type_resolve(id, &base) == -1) { 2685 mdb_warn("could not resolve type\n"); 2686 return (DCMD_ABORT); 2687 } 2688 2689 if (mdb_ctf_type_kind(base) != CTF_K_INTEGER || 2690 mdb_ctf_type_encoding(base, &e) != 0 || 2691 e.cte_bits / NBBY != sizeof (value)) { 2692 mdb_warn("expected 32-bit integer type\n"); 2693 return (DCMD_ABORT); 2694 } 2695 2696 if (mdb_vread(&value, sizeof (value), addr) == -1) { 2697 mdb_warn("failed to read 32-bit value at %p", addr); 2698 return (DCMD_ERR); 2699 } 2700 2701 mdb_printf(fmt, value); 2702 2703 return (0); 2704 } 2705 2706 /*ARGSUSED*/ 2707 static int 2708 printf_ptr(mdb_ctf_id_t id, uintptr_t addr, ulong_t off, char *fmt) 2709 { 2710 uintptr_t value; 2711 mdb_ctf_id_t base; 2712 2713 if (mdb_ctf_type_resolve(id, &base) == -1) { 2714 mdb_warn("could not resolve type\n"); 2715 return (DCMD_ABORT); 2716 } 2717 2718 if (mdb_ctf_type_kind(base) != CTF_K_POINTER) { 2719 mdb_warn("expected pointer type\n"); 2720 return (DCMD_ABORT); 2721 } 2722 2723 if (mdb_vread(&value, sizeof (value), addr) == -1) { 2724 mdb_warn("failed to read pointer at %llx", addr); 2725 return (DCMD_ERR); 2726 } 2727 2728 mdb_printf(fmt, value); 2729 2730 return (0); 2731 } 2732 2733 /*ARGSUSED*/ 2734 static int 2735 printf_string(mdb_ctf_id_t id, uintptr_t addr, ulong_t off, char *fmt) 2736 { 2737 mdb_ctf_id_t base; 2738 mdb_ctf_arinfo_t r; 2739 char buf[1024]; 2740 ssize_t size; 2741 2742 if (mdb_ctf_type_resolve(id, &base) == -1) { 2743 mdb_warn("could not resolve type"); 2744 return (DCMD_ABORT); 2745 } 2746 2747 if (mdb_ctf_type_kind(base) == CTF_K_POINTER) { 2748 uintptr_t value; 2749 2750 if (mdb_vread(&value, sizeof (value), addr) == -1) { 2751 mdb_warn("failed to read pointer at %llx", addr); 2752 return (DCMD_ERR); 2753 } 2754 2755 if (mdb_readstr(buf, sizeof (buf) - 1, value) < 0) { 2756 mdb_warn("failed to read string at %llx", value); 2757 return (DCMD_ERR); 2758 } 2759 2760 mdb_printf(fmt, buf); 2761 return (0); 2762 } 2763 2764 if (mdb_ctf_type_kind(base) == CTF_K_ENUM) { 2765 const char *strval; 2766 int value; 2767 2768 if (mdb_vread(&value, sizeof (value), addr) == -1) { 2769 mdb_warn("failed to read pointer at %llx", addr); 2770 return (DCMD_ERR); 2771 } 2772 2773 if ((strval = mdb_ctf_enum_name(id, value))) { 2774 mdb_printf(fmt, strval); 2775 } else { 2776 (void) mdb_snprintf(buf, sizeof (buf), "<%d>", value); 2777 mdb_printf(fmt, buf); 2778 } 2779 2780 return (0); 2781 } 2782 2783 if (mdb_ctf_type_kind(base) != CTF_K_ARRAY) { 2784 mdb_warn("exepected pointer or array type\n"); 2785 return (DCMD_ABORT); 2786 } 2787 2788 if (mdb_ctf_array_info(base, &r) == -1 || 2789 mdb_ctf_type_resolve(r.mta_contents, &base) == -1 || 2790 (size = mdb_ctf_type_size(base)) == -1) { 2791 mdb_warn("can't determine array type"); 2792 return (DCMD_ABORT); 2793 } 2794 2795 if (size != 1) { 2796 mdb_warn("string format specifier requires " 2797 "an array of characters\n"); 2798 return (DCMD_ABORT); 2799 } 2800 2801 bzero(buf, sizeof (buf)); 2802 2803 if (mdb_vread(buf, MIN(r.mta_nelems, sizeof (buf) - 1), addr) == -1) { 2804 mdb_warn("failed to read array at %p", addr); 2805 return (DCMD_ERR); 2806 } 2807 2808 mdb_printf(fmt, buf); 2809 2810 return (0); 2811 } 2812 2813 /*ARGSUSED*/ 2814 static int 2815 printf_ipv6(mdb_ctf_id_t id, uintptr_t addr, ulong_t off, char *fmt) 2816 { 2817 mdb_ctf_id_t base; 2818 mdb_ctf_id_t ipv6_type, ipv6_base; 2819 in6_addr_t ipv6; 2820 2821 if (mdb_ctf_lookup_by_name("in6_addr_t", &ipv6_type) == -1) { 2822 mdb_warn("could not resolve in6_addr_t type\n"); 2823 return (DCMD_ABORT); 2824 } 2825 2826 if (mdb_ctf_type_resolve(id, &base) == -1) { 2827 mdb_warn("could not resolve type\n"); 2828 return (DCMD_ABORT); 2829 } 2830 2831 if (mdb_ctf_type_resolve(ipv6_type, &ipv6_base) == -1) { 2832 mdb_warn("could not resolve in6_addr_t type\n"); 2833 return (DCMD_ABORT); 2834 } 2835 2836 if (mdb_ctf_type_cmp(base, ipv6_base) != 0) { 2837 mdb_warn("requires argument of type in6_addr_t\n"); 2838 return (DCMD_ABORT); 2839 } 2840 2841 if (mdb_vread(&ipv6, sizeof (ipv6), addr) == -1) { 2842 mdb_warn("couldn't read in6_addr_t at %p", addr); 2843 return (DCMD_ERR); 2844 } 2845 2846 mdb_printf(fmt, &ipv6); 2847 2848 return (0); 2849 } 2850 2851 /* 2852 * To validate the format string specified to ::printf, we run the format 2853 * string through a very simple state machine that restricts us to a subset 2854 * of mdb_printf() functionality. 2855 */ 2856 enum { 2857 PRINTF_NOFMT = 1, /* no current format specifier */ 2858 PRINTF_PERC, /* processed '%' */ 2859 PRINTF_FMT, /* processing format specifier */ 2860 PRINTF_LEFT, /* processed '-', expecting width */ 2861 PRINTF_WIDTH, /* processing width */ 2862 PRINTF_QUES /* processed '?', expecting format */ 2863 }; 2864 2865 int 2866 cmd_printf_tab(mdb_tab_cookie_t *mcp, uint_t flags, int argc, 2867 const mdb_arg_t *argv) 2868 { 2869 int ii; 2870 char *f; 2871 2872 /* 2873 * If argc doesn't have more than what should be the format string, 2874 * ignore it. 2875 */ 2876 if (argc <= 1) 2877 return (0); 2878 2879 /* 2880 * Because we aren't leveraging the lex and yacc engine, we have to 2881 * manually walk the arguments to find both the first and last 2882 * open/close quote of the format string. 2883 */ 2884 f = strchr(argv[0].a_un.a_str, '"'); 2885 if (f == NULL) 2886 return (0); 2887 2888 f = strchr(f + 1, '"'); 2889 if (f != NULL) { 2890 ii = 0; 2891 } else { 2892 for (ii = 1; ii < argc; ii++) { 2893 if (argv[ii].a_type != MDB_TYPE_STRING) 2894 continue; 2895 f = strchr(argv[ii].a_un.a_str, '"'); 2896 if (f != NULL) 2897 break; 2898 } 2899 /* Never found */ 2900 if (ii == argc) 2901 return (0); 2902 } 2903 2904 ii++; 2905 argc -= ii; 2906 argv += ii; 2907 2908 return (cmd_print_tab_common(mcp, flags, argc, argv)); 2909 } 2910 2911 int 2912 cmd_printf(uintptr_t addr, uint_t flags, int argc, const mdb_arg_t *argv) 2913 { 2914 char type[MDB_SYM_NAMLEN]; 2915 int i, nfmts = 0, ret; 2916 mdb_ctf_id_t id; 2917 const char *fmt, *member; 2918 char **fmts, *last, *dest, f; 2919 int (**funcs)(mdb_ctf_id_t, uintptr_t, ulong_t, char *); 2920 int state = PRINTF_NOFMT; 2921 printarg_t pa; 2922 2923 if (!(flags & DCMD_ADDRSPEC)) 2924 return (DCMD_USAGE); 2925 2926 bzero(&pa, sizeof (pa)); 2927 pa.pa_as = MDB_TGT_AS_VIRT; 2928 pa.pa_realtgt = pa.pa_tgt = mdb.m_target; 2929 2930 if (argc == 0 || argv[0].a_type != MDB_TYPE_STRING) { 2931 mdb_warn("expected a format string\n"); 2932 return (DCMD_USAGE); 2933 } 2934 2935 /* 2936 * Our first argument is a format string; rip it apart and run it 2937 * through our state machine to validate that our input is within the 2938 * subset of mdb_printf() format strings that we allow. 2939 */ 2940 fmt = argv[0].a_un.a_str; 2941 /* 2942 * 'dest' must be large enough to hold a copy of the format string, 2943 * plus a NUL and up to 2 additional characters for each conversion 2944 * in the format string. This gives us a bloat factor of 5/2 ~= 3. 2945 * e.g. "%d" (strlen of 2) --> "%lld\0" (need 5 bytes) 2946 */ 2947 dest = mdb_zalloc(strlen(fmt) * 3, UM_SLEEP | UM_GC); 2948 fmts = mdb_zalloc(strlen(fmt) * sizeof (char *), UM_SLEEP | UM_GC); 2949 funcs = mdb_zalloc(strlen(fmt) * sizeof (void *), UM_SLEEP | UM_GC); 2950 last = dest; 2951 2952 for (i = 0; fmt[i] != '\0'; i++) { 2953 *dest++ = f = fmt[i]; 2954 2955 switch (state) { 2956 case PRINTF_NOFMT: 2957 state = f == '%' ? PRINTF_PERC : PRINTF_NOFMT; 2958 break; 2959 2960 case PRINTF_PERC: 2961 state = f == '-' ? PRINTF_LEFT : 2962 f >= '0' && f <= '9' ? PRINTF_WIDTH : 2963 f == '?' ? PRINTF_QUES : 2964 f == '%' ? PRINTF_NOFMT : PRINTF_FMT; 2965 break; 2966 2967 case PRINTF_LEFT: 2968 state = f >= '0' && f <= '9' ? PRINTF_WIDTH : 2969 f == '?' ? PRINTF_QUES : PRINTF_FMT; 2970 break; 2971 2972 case PRINTF_WIDTH: 2973 state = f >= '0' && f <= '9' ? PRINTF_WIDTH : 2974 PRINTF_FMT; 2975 break; 2976 2977 case PRINTF_QUES: 2978 state = PRINTF_FMT; 2979 break; 2980 } 2981 2982 if (state != PRINTF_FMT) 2983 continue; 2984 2985 dest--; 2986 2987 /* 2988 * Now check that we have one of our valid format characters. 2989 */ 2990 switch (f) { 2991 case 'a': 2992 case 'A': 2993 case 'p': 2994 funcs[nfmts] = printf_ptr; 2995 break; 2996 2997 case 'd': 2998 case 'q': 2999 case 'R': 3000 funcs[nfmts] = printf_int; 3001 *dest++ = 'l'; 3002 *dest++ = 'l'; 3003 break; 3004 3005 case 'I': 3006 funcs[nfmts] = printf_uint32; 3007 break; 3008 3009 case 'N': 3010 funcs[nfmts] = printf_ipv6; 3011 break; 3012 3013 case 'H': 3014 case 'o': 3015 case 'r': 3016 case 'u': 3017 case 'x': 3018 case 'X': 3019 funcs[nfmts] = printf_uint; 3020 *dest++ = 'l'; 3021 *dest++ = 'l'; 3022 break; 3023 3024 case 's': 3025 funcs[nfmts] = printf_string; 3026 break; 3027 3028 case 'Y': 3029 funcs[nfmts] = sizeof (time_t) == sizeof (int) ? 3030 printf_uint32 : printf_uint; 3031 break; 3032 3033 default: 3034 mdb_warn("illegal format string at or near " 3035 "'%c' (position %d)\n", f, i + 1); 3036 return (DCMD_ABORT); 3037 } 3038 3039 *dest++ = f; 3040 *dest++ = '\0'; 3041 fmts[nfmts++] = last; 3042 last = dest; 3043 state = PRINTF_NOFMT; 3044 } 3045 3046 argc--; 3047 argv++; 3048 3049 /* 3050 * Now we expect a type name. 3051 */ 3052 if ((ret = args_to_typename(&argc, &argv, type, sizeof (type))) != 0) 3053 return (ret); 3054 3055 argv++; 3056 argc--; 3057 3058 if (mdb_ctf_lookup_by_name(type, &id) != 0) { 3059 mdb_warn("failed to look up type %s", type); 3060 return (DCMD_ABORT); 3061 } 3062 3063 if (argc == 0) { 3064 mdb_warn("at least one member must be specified\n"); 3065 return (DCMD_USAGE); 3066 } 3067 3068 if (argc != nfmts) { 3069 mdb_warn("%s format specifiers (found %d, expected %d)\n", 3070 argc > nfmts ? "missing" : "extra", nfmts, argc); 3071 return (DCMD_ABORT); 3072 } 3073 3074 for (i = 0; i < argc; i++) { 3075 mdb_ctf_id_t mid; 3076 ulong_t off; 3077 int ignored; 3078 3079 if (argv[i].a_type != MDB_TYPE_STRING) { 3080 mdb_warn("expected only type member arguments\n"); 3081 return (DCMD_ABORT); 3082 } 3083 3084 if (strcmp((member = argv[i].a_un.a_str), ".") == 0) { 3085 /* 3086 * We allow "." to be specified to denote the current 3087 * value of dot. 3088 */ 3089 if (funcs[i] != printf_ptr && funcs[i] != printf_uint && 3090 funcs[i] != printf_int) { 3091 mdb_warn("expected integer or pointer format " 3092 "specifier for '.'\n"); 3093 return (DCMD_ABORT); 3094 } 3095 3096 mdb_printf(fmts[i], mdb_get_dot()); 3097 continue; 3098 } 3099 3100 pa.pa_addr = addr; 3101 3102 if (parse_member(&pa, member, id, &mid, &off, &ignored) != 0) 3103 return (DCMD_ABORT); 3104 3105 if ((ret = funcs[i](mid, pa.pa_addr, off, fmts[i])) != 0) { 3106 mdb_warn("failed to print member '%s'\n", member); 3107 return (ret); 3108 } 3109 } 3110 3111 mdb_printf("%s", last); 3112 3113 return (DCMD_OK); 3114 } 3115 3116 static char _mdb_printf_help[] = 3117 "The format string argument is a printf(3C)-like format string that is a\n" 3118 "subset of the format strings supported by mdb_printf(). The type argument\n" 3119 "is the name of a type to be used to interpret the memory referenced by dot.\n" 3120 "The member should either be a field in the specified structure, or the\n" 3121 "special member '.', denoting the value of dot (and treated as a pointer).\n" 3122 "The number of members must match the number of format specifiers in the\n" 3123 "format string.\n" 3124 "\n" 3125 "The following format specifiers are recognized by ::printf:\n" 3126 "\n" 3127 " %% Prints the '%' symbol.\n" 3128 " %a Prints the member in symbolic form.\n" 3129 " %d Prints the member as a decimal integer. If the member is a signed\n" 3130 " integer type, the output will be signed.\n" 3131 " %H Prints the member as a human-readable size.\n" 3132 " %I Prints the member as an IPv4 address (must be 32-bit integer type).\n" 3133 " %N Prints the member as an IPv6 address (must be of type in6_addr_t).\n" 3134 " %o Prints the member as an unsigned octal integer.\n" 3135 " %p Prints the member as a pointer, in hexadecimal.\n" 3136 " %q Prints the member in signed octal. Honk if you ever use this!\n" 3137 " %r Prints the member as an unsigned value in the current output radix.\n" 3138 " %R Prints the member as a signed value in the current output radix.\n" 3139 " %s Prints the member as a string (requires a pointer or an array of\n" 3140 " characters).\n" 3141 " %u Prints the member as an unsigned decimal integer.\n" 3142 " %x Prints the member in hexadecimal.\n" 3143 " %X Prints the member in hexadecimal, using the characters A-F as the\n" 3144 " digits for the values 10-15.\n" 3145 " %Y Prints the member as a time_t as the string " 3146 "'year month day HH:MM:SS'.\n" 3147 "\n" 3148 "The following field width specifiers are recognized by ::printf:\n" 3149 "\n" 3150 " %n Field width is set to the specified decimal value.\n" 3151 " %? Field width is set to the maximum width of a hexadecimal pointer\n" 3152 " value. This is 8 in an ILP32 environment, and 16 in an LP64\n" 3153 " environment.\n" 3154 "\n" 3155 "The following flag specifers are recognized by ::printf:\n" 3156 "\n" 3157 " %- Left-justify the output within the specified field width. If the\n" 3158 " width of the output is less than the specified field width, the\n" 3159 " output will be padded with blanks on the right-hand side. Without\n" 3160 " %-, values are right-justified by default.\n" 3161 "\n" 3162 " %0 Zero-fill the output field if the output is right-justified and the\n" 3163 " width of the output is less than the specified field width. Without\n" 3164 " %0, right-justified values are prepended with blanks in order to\n" 3165 " fill the field.\n" 3166 "\n" 3167 "Examples: \n" 3168 "\n" 3169 " ::walk proc | " 3170 "::printf \"%-6d %s\\n\" proc_t p_pidp->pid_id p_user.u_psargs\n" 3171 " ::walk thread | " 3172 "::printf \"%?p %3d %a\\n\" kthread_t . t_pri t_startpc\n" 3173 " ::walk zone | " 3174 "::printf \"%-40s %20s\\n\" zone_t zone_name zone_nodename\n" 3175 " ::walk ire | " 3176 "::printf \"%Y %I\\n\" ire_t ire_create_time ire_u.ire4_u.ire4_addr\n" 3177 "\n"; 3178 3179 void 3180 printf_help(void) 3181 { 3182 mdb_printf("%s", _mdb_printf_help); 3183 } 3184