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