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 2006 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #pragma ident "%Z%%M% %I% %E% SMI" 27 28 /* 29 * DWARF to tdata conversion 30 * 31 * For the most part, conversion is straightforward, proceeding in two passes. 32 * On the first pass, we iterate through every die, creating new type nodes as 33 * necessary. Referenced tdesc_t's are created in an uninitialized state, thus 34 * allowing type reference pointers to be filled in. If the tdesc_t 35 * corresponding to a given die can be completely filled out (sizes and offsets 36 * calculated, and so forth) without using any referenced types, the tdesc_t is 37 * marked as resolved. Consider an array type. If the type corresponding to 38 * the array contents has not yet been processed, we will create a blank tdesc 39 * for the contents type (only the type ID will be filled in, relying upon the 40 * later portion of the first pass to encounter and complete the referenced 41 * type). We will then attempt to determine the size of the array. If the 42 * array has a byte size attribute, we will have completely characterized the 43 * array type, and will be able to mark it as resolved. The lack of a byte 44 * size attribute, on the other hand, will prevent us from fully resolving the 45 * type, as the size will only be calculable with reference to the contents 46 * type, which has not, as yet, been encountered. The array type will thus be 47 * left without the resolved flag, and the first pass will continue. 48 * 49 * When we begin the second pass, we will have created tdesc_t nodes for every 50 * type in the section. We will traverse the tree, from the iidescs down, 51 * processing each unresolved node. As the referenced nodes will have been 52 * populated, the array type used in our example above will be able to use the 53 * size of the referenced types (if available) to determine its own type. The 54 * traversal will be repeated until all types have been resolved or we have 55 * failed to make progress. When all tdescs have been resolved, the conversion 56 * is complete. 57 * 58 * There are, as always, a few special cases that are handled during the first 59 * and second passes: 60 * 61 * 1. Empty enums - GCC will occasionally emit an enum without any members. 62 * Later on in the file, it will emit the same enum type, though this time 63 * with the full complement of members. All references to the memberless 64 * enum need to be redirected to the full definition. During the first 65 * pass, each enum is entered in dm_enumhash, along with a pointer to its 66 * corresponding tdesc_t. If, during the second pass, we encounter a 67 * memberless enum, we use the hash to locate the full definition. All 68 * tdescs referencing the empty enum are then redirected. 69 * 70 * 2. Forward declarations - If the compiler sees a forward declaration for 71 * a structure, followed by the definition of that structure, it will emit 72 * DWARF data for both the forward declaration and the definition. We need 73 * to resolve the forward declarations when possible, by redirecting 74 * forward-referencing tdescs to the actual struct/union definitions. This 75 * redirection is done completely within the first pass. We begin by 76 * recording all forward declarations in dw_fwdhash. When we define a 77 * structure, we check to see if there have been any corresponding forward 78 * declarations. If so, we redirect the tdescs which referenced the forward 79 * declarations to the structure or union definition. 80 * 81 * XXX see if a post traverser will allow the elimination of repeated pass 2 82 * traversals. 83 */ 84 85 #include <stdio.h> 86 #include <stdlib.h> 87 #include <strings.h> 88 #include <errno.h> 89 #include <libelf.h> 90 #include <libdwarf.h> 91 #include <libgen.h> 92 #include <dwarf.h> 93 94 #include "ctf_headers.h" 95 #include "ctftools.h" 96 #include "memory.h" 97 #include "list.h" 98 #include "traverse.h" 99 100 /* The version of DWARF which we support. */ 101 #define DWARF_VERSION 2 102 103 /* 104 * We need to define a couple of our own intrinsics, to smooth out some of the 105 * differences between the GCC and DevPro DWARF emitters. See the referenced 106 * routines and the special cases in the file comment for more details. 107 * 108 * Type IDs are 32 bits wide. We're going to use the top of that field to 109 * indicate types that we've created ourselves. 110 */ 111 #define TID_FILEMAX 0x3fffffff /* highest tid from file */ 112 #define TID_VOID 0x40000001 /* see die_void() */ 113 #define TID_LONG 0x40000002 /* see die_array() */ 114 115 #define TID_MFGTID_BASE 0x40000003 /* first mfg'd tid */ 116 117 /* 118 * To reduce the staggering amount of error-handling code that would otherwise 119 * be required, the attribute-retrieval routines handle most of their own 120 * errors. If the following flag is supplied as the value of the `req' 121 * argument, they will also handle the absence of a requested attribute by 122 * terminating the program. 123 */ 124 #define DW_ATTR_REQ 1 125 126 #define TDESC_HASH_BUCKETS 511 127 128 typedef struct dwarf { 129 Dwarf_Debug dw_dw; /* for libdwarf */ 130 Dwarf_Error dw_err; /* for libdwarf */ 131 Dwarf_Unsigned dw_maxoff; /* highest legal offset in this cu */ 132 tdata_t *dw_td; /* root of the tdesc/iidesc tree */ 133 hash_t *dw_tidhash; /* hash of tdescs by t_id */ 134 hash_t *dw_fwdhash; /* hash of fwd decls by name */ 135 hash_t *dw_enumhash; /* hash of memberless enums by name */ 136 tdesc_t *dw_void; /* manufactured void type */ 137 tdesc_t *dw_long; /* manufactured long type for arrays */ 138 size_t dw_ptrsz; /* size of a pointer in this file */ 139 tid_t dw_mfgtid_last; /* last mfg'd type ID used */ 140 uint_t dw_nunres; /* count of unresolved types */ 141 char *dw_cuname; /* name of compilation unit */ 142 } dwarf_t; 143 144 static void die_create_one(dwarf_t *, Dwarf_Die); 145 static void die_create(dwarf_t *, Dwarf_Die); 146 147 static tid_t 148 mfgtid_next(dwarf_t *dw) 149 { 150 return (++dw->dw_mfgtid_last); 151 } 152 153 static void 154 tdesc_add(dwarf_t *dw, tdesc_t *tdp) 155 { 156 hash_add(dw->dw_tidhash, tdp); 157 } 158 159 static tdesc_t * 160 tdesc_lookup(dwarf_t *dw, int tid) 161 { 162 tdesc_t tmpl, *tdp; 163 164 tmpl.t_id = tid; 165 166 if (hash_find(dw->dw_tidhash, &tmpl, (void **)&tdp)) 167 return (tdp); 168 else 169 return (NULL); 170 } 171 172 /* 173 * Resolve a tdesc down to a node which should have a size. Returns the size, 174 * zero if the size hasn't yet been determined. 175 */ 176 static size_t 177 tdesc_size(tdesc_t *tdp) 178 { 179 for (;;) { 180 switch (tdp->t_type) { 181 case INTRINSIC: 182 case POINTER: 183 case ARRAY: 184 case FUNCTION: 185 case STRUCT: 186 case UNION: 187 case ENUM: 188 return (tdp->t_size); 189 190 case FORWARD: 191 return (0); 192 193 case TYPEDEF: 194 case VOLATILE: 195 case CONST: 196 case RESTRICT: 197 tdp = tdp->t_tdesc; 198 continue; 199 200 case 0: /* not yet defined */ 201 return (0); 202 203 default: 204 terminate("tdp %u: tdesc_size on unknown type %d\n", 205 tdp->t_id, tdp->t_type); 206 } 207 } 208 } 209 210 static size_t 211 tdesc_bitsize(tdesc_t *tdp) 212 { 213 for (;;) { 214 switch (tdp->t_type) { 215 case INTRINSIC: 216 return (tdp->t_intr->intr_nbits); 217 218 case ARRAY: 219 case FUNCTION: 220 case STRUCT: 221 case UNION: 222 case ENUM: 223 case POINTER: 224 return (tdp->t_size); 225 226 case FORWARD: 227 return (0); 228 229 case TYPEDEF: 230 case VOLATILE: 231 case RESTRICT: 232 case CONST: 233 tdp = tdp->t_tdesc; 234 continue; 235 236 case 0: /* not yet defined */ 237 return (0); 238 239 default: 240 terminate("tdp %u: tdesc_bitsize on unknown type %d\n", 241 tdp->t_id, tdp->t_type); 242 } 243 } 244 } 245 246 static tdesc_t * 247 tdesc_basetype(tdesc_t *tdp) 248 { 249 for (;;) { 250 switch (tdp->t_type) { 251 case TYPEDEF: 252 case VOLATILE: 253 case RESTRICT: 254 case CONST: 255 tdp = tdp->t_tdesc; 256 break; 257 case 0: /* not yet defined */ 258 return (NULL); 259 default: 260 return (tdp); 261 } 262 } 263 } 264 265 static Dwarf_Off 266 die_off(dwarf_t *dw, Dwarf_Die die) 267 { 268 Dwarf_Off off; 269 270 if (dwarf_dieoffset(die, &off, &dw->dw_err) == DW_DLV_OK) 271 return (off); 272 273 terminate("failed to get offset for die: %s\n", 274 dwarf_errmsg(dw->dw_err)); 275 /*NOTREACHED*/ 276 return (0); 277 } 278 279 static Dwarf_Die 280 die_sibling(dwarf_t *dw, Dwarf_Die die) 281 { 282 Dwarf_Die sib; 283 int rc; 284 285 if ((rc = dwarf_siblingof(dw->dw_dw, die, &sib, &dw->dw_err)) == 286 DW_DLV_OK) 287 return (sib); 288 else if (rc == DW_DLV_NO_ENTRY) 289 return (NULL); 290 291 terminate("die %llu: failed to find type sibling: %s\n", 292 die_off(dw, die), dwarf_errmsg(dw->dw_err)); 293 /*NOTREACHED*/ 294 return (NULL); 295 } 296 297 static Dwarf_Die 298 die_child(dwarf_t *dw, Dwarf_Die die) 299 { 300 Dwarf_Die child; 301 int rc; 302 303 if ((rc = dwarf_child(die, &child, &dw->dw_err)) == DW_DLV_OK) 304 return (child); 305 else if (rc == DW_DLV_NO_ENTRY) 306 return (NULL); 307 308 terminate("die %llu: failed to find type child: %s\n", 309 die_off(dw, die), dwarf_errmsg(dw->dw_err)); 310 /*NOTREACHED*/ 311 return (NULL); 312 } 313 314 static Dwarf_Half 315 die_tag(dwarf_t *dw, Dwarf_Die die) 316 { 317 Dwarf_Half tag; 318 319 if (dwarf_tag(die, &tag, &dw->dw_err) == DW_DLV_OK) 320 return (tag); 321 322 terminate("die %llu: failed to get tag for type: %s\n", 323 die_off(dw, die), dwarf_errmsg(dw->dw_err)); 324 /*NOTREACHED*/ 325 return (0); 326 } 327 328 static Dwarf_Attribute 329 die_attr(dwarf_t *dw, Dwarf_Die die, Dwarf_Half name, int req) 330 { 331 Dwarf_Attribute attr; 332 int rc; 333 334 if ((rc = dwarf_attr(die, name, &attr, &dw->dw_err)) == DW_DLV_OK) { 335 return (attr); 336 } else if (rc == DW_DLV_NO_ENTRY) { 337 if (req) { 338 terminate("die %llu: no attr 0x%x\n", die_off(dw, die), 339 name); 340 } else { 341 return (NULL); 342 } 343 } 344 345 terminate("die %llu: failed to get attribute for type: %s\n", 346 die_off(dw, die), dwarf_errmsg(dw->dw_err)); 347 /*NOTREACHED*/ 348 return (NULL); 349 } 350 351 static Dwarf_Half 352 die_attr_form(dwarf_t *dw, Dwarf_Attribute attr) 353 { 354 Dwarf_Half form; 355 356 if (dwarf_whatform(attr, &form, &dw->dw_err) == DW_DLV_OK) 357 return (form); 358 359 terminate("failed to get attribute form for type: %s\n", 360 dwarf_errmsg(dw->dw_err)); 361 /*NOTREACHED*/ 362 return (0); 363 } 364 365 static int 366 die_signed(dwarf_t *dw, Dwarf_Die die, Dwarf_Half name, Dwarf_Signed *valp, 367 int req) 368 { 369 Dwarf_Attribute attr; 370 Dwarf_Signed val; 371 372 if ((attr = die_attr(dw, die, name, req)) == NULL) 373 return (0); /* die_attr will terminate for us if necessary */ 374 375 if (dwarf_formsdata(attr, &val, &dw->dw_err) != DW_DLV_OK) { 376 terminate("die %llu: failed to get signed (form 0x%x)\n", 377 die_off(dw, die), die_attr_form(dw, attr)); 378 } 379 380 dwarf_dealloc(dw->dw_dw, attr, DW_DLA_ATTR); 381 382 *valp = val; 383 return (1); 384 } 385 386 static int 387 die_unsigned(dwarf_t *dw, Dwarf_Die die, Dwarf_Half name, Dwarf_Unsigned *valp, 388 int req) 389 { 390 Dwarf_Attribute attr; 391 Dwarf_Unsigned val; 392 393 if ((attr = die_attr(dw, die, name, req)) == NULL) 394 return (0); /* die_attr will terminate for us if necessary */ 395 396 if (dwarf_formudata(attr, &val, &dw->dw_err) != DW_DLV_OK) { 397 terminate("die %llu: failed to get unsigned (form 0x%x)\n", 398 die_off(dw, die), die_attr_form(dw, attr)); 399 } 400 401 dwarf_dealloc(dw->dw_dw, attr, DW_DLA_ATTR); 402 403 *valp = val; 404 return (1); 405 } 406 407 static int 408 die_bool(dwarf_t *dw, Dwarf_Die die, Dwarf_Half name, Dwarf_Bool *valp, int req) 409 { 410 Dwarf_Attribute attr; 411 Dwarf_Bool val; 412 413 if ((attr = die_attr(dw, die, name, req)) == NULL) 414 return (0); /* die_attr will terminate for us if necessary */ 415 416 if (dwarf_formflag(attr, &val, &dw->dw_err) != DW_DLV_OK) { 417 terminate("die %llu: failed to get bool (form 0x%x)\n", 418 die_off(dw, die), die_attr_form(dw, attr)); 419 } 420 421 dwarf_dealloc(dw->dw_dw, attr, DW_DLA_ATTR); 422 423 *valp = val; 424 return (1); 425 } 426 427 static int 428 die_string(dwarf_t *dw, Dwarf_Die die, Dwarf_Half name, char **strp, int req) 429 { 430 Dwarf_Attribute attr; 431 char *str; 432 433 if ((attr = die_attr(dw, die, name, req)) == NULL) 434 return (0); /* die_attr will terminate for us if necessary */ 435 436 if (dwarf_formstring(attr, &str, &dw->dw_err) != DW_DLV_OK) { 437 terminate("die %llu: failed to get string (form 0x%x)\n", 438 die_off(dw, die), die_attr_form(dw, attr)); 439 } 440 441 *strp = xstrdup(str); 442 dwarf_dealloc(dw->dw_dw, str, DW_DLA_STRING); 443 444 return (1); 445 } 446 447 static Dwarf_Off 448 die_attr_ref(dwarf_t *dw, Dwarf_Die die, Dwarf_Half name) 449 { 450 Dwarf_Attribute attr; 451 Dwarf_Off off; 452 453 attr = die_attr(dw, die, name, DW_ATTR_REQ); 454 455 if (dwarf_formref(attr, &off, &dw->dw_err) != DW_DLV_OK) { 456 terminate("die %llu: failed to get ref (form 0x%x)\n", 457 die_off(dw, die), die_attr_form(dw, attr)); 458 } 459 460 dwarf_dealloc(dw->dw_dw, attr, DW_DLA_ATTR); 461 462 return (off); 463 } 464 465 static char * 466 die_name(dwarf_t *dw, Dwarf_Die die) 467 { 468 char *str = NULL; 469 470 (void) die_string(dw, die, DW_AT_name, &str, 0); 471 472 return (str); 473 } 474 475 static int 476 die_isdecl(dwarf_t *dw, Dwarf_Die die) 477 { 478 Dwarf_Bool val; 479 480 return (die_bool(dw, die, DW_AT_declaration, &val, 0) && val); 481 } 482 483 static int 484 die_isglobal(dwarf_t *dw, Dwarf_Die die) 485 { 486 Dwarf_Signed vis; 487 Dwarf_Bool ext; 488 489 /* 490 * Some compilers (gcc) use DW_AT_external to indicate function 491 * visibility. Others (Sun) use DW_AT_visibility. 492 */ 493 if (die_signed(dw, die, DW_AT_visibility, &vis, 0)) 494 return (vis == DW_VIS_exported); 495 else 496 return (die_bool(dw, die, DW_AT_external, &ext, 0) && ext); 497 } 498 499 static tdesc_t * 500 die_add(dwarf_t *dw, Dwarf_Off off) 501 { 502 tdesc_t *tdp = xcalloc(sizeof (tdesc_t)); 503 504 tdp->t_id = off; 505 506 tdesc_add(dw, tdp); 507 508 return (tdp); 509 } 510 511 static tdesc_t * 512 die_lookup_pass1(dwarf_t *dw, Dwarf_Die die, Dwarf_Half name) 513 { 514 Dwarf_Off ref = die_attr_ref(dw, die, name); 515 tdesc_t *tdp; 516 517 if ((tdp = tdesc_lookup(dw, ref)) != NULL) 518 return (tdp); 519 520 return (die_add(dw, ref)); 521 } 522 523 static int 524 die_mem_offset(dwarf_t *dw, Dwarf_Die die, Dwarf_Half name, 525 Dwarf_Unsigned *valp, int req) 526 { 527 Dwarf_Attribute attr; 528 Dwarf_Locdesc *loc; 529 Dwarf_Signed locnum; 530 531 if ((attr = die_attr(dw, die, name, req)) == NULL) 532 return (0); /* die_attr will terminate for us if necessary */ 533 534 if (dwarf_loclist(attr, &loc, &locnum, &dw->dw_err) != DW_DLV_OK) { 535 terminate("die %llu: failed to get mem offset location list\n", 536 die_off(dw, die)); 537 } 538 539 dwarf_dealloc(dw->dw_dw, attr, DW_DLA_ATTR); 540 541 if (locnum != 1 || loc->ld_s->lr_atom != DW_OP_plus_uconst) { 542 terminate("die %llu: cannot parse member offset\n", 543 die_off(dw, die)); 544 } 545 546 *valp = loc->ld_s->lr_number; 547 548 dwarf_dealloc(dw->dw_dw, loc->ld_s, DW_DLA_LOC_BLOCK); 549 dwarf_dealloc(dw->dw_dw, loc, DW_DLA_LOCDESC); 550 551 return (1); 552 } 553 554 static tdesc_t * 555 tdesc_intr_common(dwarf_t *dw, int tid, const char *name, size_t sz) 556 { 557 tdesc_t *tdp; 558 intr_t *intr; 559 560 intr = xcalloc(sizeof (intr_t)); 561 intr->intr_type = INTR_INT; 562 intr->intr_signed = 1; 563 intr->intr_nbits = sz * NBBY; 564 565 tdp = xcalloc(sizeof (tdesc_t)); 566 tdp->t_name = xstrdup(name); 567 tdp->t_size = sz; 568 tdp->t_id = tid; 569 tdp->t_type = INTRINSIC; 570 tdp->t_intr = intr; 571 tdp->t_flags = TDESC_F_RESOLVED; 572 573 tdesc_add(dw, tdp); 574 575 return (tdp); 576 } 577 578 /* 579 * Manufacture a void type. Used for gcc-emitted stabs, where the lack of a 580 * type reference implies a reference to a void type. A void *, for example 581 * will be represented by a pointer die without a DW_AT_type. CTF requires 582 * that pointer nodes point to something, so we'll create a void for use as 583 * the target. Note that the DWARF data may already create a void type. Ours 584 * would then be a duplicate, but it'll be removed in the self-uniquification 585 * merge performed at the completion of DWARF->tdesc conversion. 586 */ 587 static tdesc_t * 588 tdesc_intr_void(dwarf_t *dw) 589 { 590 if (dw->dw_void == NULL) 591 dw->dw_void = tdesc_intr_common(dw, TID_VOID, "void", 0); 592 593 return (dw->dw_void); 594 } 595 596 static tdesc_t * 597 tdesc_intr_long(dwarf_t *dw) 598 { 599 if (dw->dw_long == NULL) { 600 dw->dw_long = tdesc_intr_common(dw, TID_LONG, "long", 601 dw->dw_ptrsz); 602 } 603 604 return (dw->dw_long); 605 } 606 607 /* 608 * Used for creating bitfield types. We create a copy of an existing intrinsic, 609 * adjusting the size of the copy to match what the caller requested. The 610 * caller can then use the copy as the type for a bitfield structure member. 611 */ 612 static tdesc_t * 613 tdesc_intr_clone(dwarf_t *dw, tdesc_t *old, size_t bitsz) 614 { 615 tdesc_t *new = xcalloc(sizeof (tdesc_t)); 616 617 if (!(old->t_flags & TDESC_F_RESOLVED)) { 618 terminate("tdp %u: attempt to make a bit field from an " 619 "unresolved type\n", old->t_id); 620 } 621 622 new->t_name = xstrdup(old->t_name); 623 new->t_size = old->t_size; 624 new->t_id = mfgtid_next(dw); 625 new->t_type = INTRINSIC; 626 new->t_flags = TDESC_F_RESOLVED; 627 628 new->t_intr = xcalloc(sizeof (intr_t)); 629 bcopy(old->t_intr, new->t_intr, sizeof (intr_t)); 630 new->t_intr->intr_nbits = bitsz; 631 632 tdesc_add(dw, new); 633 634 return (new); 635 } 636 637 static void 638 tdesc_array_create(dwarf_t *dw, Dwarf_Die dim, tdesc_t *arrtdp, 639 tdesc_t *dimtdp) 640 { 641 Dwarf_Unsigned uval; 642 Dwarf_Signed sval; 643 tdesc_t *ctdp; 644 Dwarf_Die dim2; 645 ardef_t *ar; 646 647 if ((dim2 = die_sibling(dw, dim)) == NULL) { 648 ctdp = arrtdp; 649 } else if (die_tag(dw, dim2) == DW_TAG_subrange_type) { 650 ctdp = xcalloc(sizeof (tdesc_t)); 651 ctdp->t_id = mfgtid_next(dw); 652 debug(3, "die %llu: creating new type %u for sub-dimension\n", 653 die_off(dw, dim2), ctdp->t_id); 654 tdesc_array_create(dw, dim2, arrtdp, ctdp); 655 } else { 656 terminate("die %llu: unexpected non-subrange node in array\n", 657 die_off(dw, dim2)); 658 } 659 660 dimtdp->t_type = ARRAY; 661 dimtdp->t_ardef = ar = xcalloc(sizeof (ardef_t)); 662 663 /* 664 * Array bounds can be signed or unsigned, but there are several kinds 665 * of signless forms (data1, data2, etc) that take their sign from the 666 * routine that is trying to interpret them. That is, data1 can be 667 * either signed or unsigned, depending on whether you use the signed or 668 * unsigned accessor function. GCC will use the signless forms to store 669 * unsigned values which have their high bit set, so we need to try to 670 * read them first as unsigned to get positive values. We could also 671 * try signed first, falling back to unsigned if we got a negative 672 * value. 673 */ 674 if (die_unsigned(dw, dim, DW_AT_upper_bound, &uval, 0)) 675 ar->ad_nelems = uval + 1; 676 else if (die_signed(dw, dim, DW_AT_upper_bound, &sval, 0)) 677 ar->ad_nelems = sval + 1; 678 else 679 ar->ad_nelems = 0; 680 681 /* 682 * Different compilers use different index types. Force the type to be 683 * a common, known value (long). 684 */ 685 ar->ad_idxtype = tdesc_intr_long(dw); 686 ar->ad_contents = ctdp; 687 688 if (ar->ad_contents->t_size != 0) { 689 dimtdp->t_size = ar->ad_contents->t_size * ar->ad_nelems; 690 dimtdp->t_flags |= TDESC_F_RESOLVED; 691 } 692 } 693 694 /* 695 * Create a tdesc from an array node. Some arrays will come with byte size 696 * attributes, and thus can be resolved immediately. Others don't, and will 697 * need to wait until the second pass for resolution. 698 */ 699 static void 700 die_array_create(dwarf_t *dw, Dwarf_Die arr, Dwarf_Off off, tdesc_t *tdp) 701 { 702 tdesc_t *arrtdp = die_lookup_pass1(dw, arr, DW_AT_type); 703 Dwarf_Unsigned uval; 704 Dwarf_Die dim; 705 706 debug(3, "die %llu: creating array\n", off); 707 708 if ((dim = die_child(dw, arr)) == NULL || 709 die_tag(dw, dim) != DW_TAG_subrange_type) 710 terminate("die %llu: failed to retrieve array bounds\n", off); 711 712 tdesc_array_create(dw, dim, arrtdp, tdp); 713 714 if (die_unsigned(dw, arr, DW_AT_byte_size, &uval, 0)) { 715 tdesc_t *dimtdp; 716 int flags; 717 718 tdp->t_size = uval; 719 720 /* 721 * Ensure that sub-dimensions have sizes too before marking 722 * as resolved. 723 */ 724 flags = TDESC_F_RESOLVED; 725 for (dimtdp = tdp->t_ardef->ad_contents; 726 dimtdp->t_type == ARRAY; 727 dimtdp = dimtdp->t_ardef->ad_contents) { 728 if (!(dimtdp->t_flags & TDESC_F_RESOLVED)) { 729 flags = 0; 730 break; 731 } 732 } 733 734 tdp->t_flags |= flags; 735 } 736 737 debug(3, "die %llu: array nelems %u size %u\n", off, 738 tdp->t_ardef->ad_nelems, tdp->t_size); 739 } 740 741 /*ARGSUSED1*/ 742 static int 743 die_array_resolve(tdesc_t *tdp, tdesc_t **tdpp, void *private) 744 { 745 dwarf_t *dw = private; 746 size_t sz; 747 748 if (tdp->t_flags & TDESC_F_RESOLVED) 749 return (1); 750 751 debug(3, "trying to resolve array %d (cont %d)\n", tdp->t_id, 752 tdp->t_ardef->ad_contents->t_id); 753 754 if ((sz = tdesc_size(tdp->t_ardef->ad_contents)) == 0) { 755 debug(3, "unable to resolve array %s (%d) contents %d\n", 756 tdesc_name(tdp), tdp->t_id, 757 tdp->t_ardef->ad_contents->t_id); 758 759 dw->dw_nunres++; 760 return (1); 761 } 762 763 tdp->t_size = sz * tdp->t_ardef->ad_nelems; 764 tdp->t_flags |= TDESC_F_RESOLVED; 765 766 debug(3, "resolved array %d: %u bytes\n", tdp->t_id, tdp->t_size); 767 768 return (1); 769 } 770 771 /*ARGSUSED1*/ 772 static int 773 die_array_failed(tdesc_t *tdp, tdesc_t **tdpp, void *private) 774 { 775 tdesc_t *cont = tdp->t_ardef->ad_contents; 776 777 if (tdp->t_flags & TDESC_F_RESOLVED) 778 return (1); 779 780 fprintf(stderr, "Array %d: failed to size contents type %s (%d)\n", 781 tdp->t_id, tdesc_name(cont), cont->t_id); 782 783 return (1); 784 } 785 786 /* 787 * Most enums (those with members) will be resolved during this first pass. 788 * Others - those without members (see the file comment) - won't be, and will 789 * need to wait until the second pass when they can be matched with their full 790 * definitions. 791 */ 792 static void 793 die_enum_create(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp) 794 { 795 Dwarf_Die mem; 796 Dwarf_Unsigned uval; 797 Dwarf_Signed sval; 798 799 debug(3, "die %llu: creating enum\n", off); 800 801 tdp->t_type = ENUM; 802 803 (void) die_unsigned(dw, die, DW_AT_byte_size, &uval, DW_ATTR_REQ); 804 tdp->t_size = uval; 805 806 if ((mem = die_child(dw, die)) != NULL) { 807 elist_t **elastp = &tdp->t_emem; 808 809 do { 810 elist_t *el; 811 812 if (die_tag(dw, mem) != DW_TAG_enumerator) { 813 /* Nested type declaration */ 814 die_create_one(dw, mem); 815 continue; 816 } 817 818 el = xcalloc(sizeof (elist_t)); 819 el->el_name = die_name(dw, mem); 820 821 if (die_signed(dw, mem, DW_AT_const_value, &sval, 0)) { 822 el->el_number = sval; 823 } else if (die_unsigned(dw, mem, DW_AT_const_value, 824 &uval, 0)) { 825 el->el_number = uval; 826 } else { 827 terminate("die %llu: enum %llu: member without " 828 "value\n", off, die_off(dw, mem)); 829 } 830 831 debug(3, "die %llu: enum %llu: created %s = %d\n", off, 832 die_off(dw, mem), el->el_name, el->el_number); 833 834 *elastp = el; 835 elastp = &el->el_next; 836 837 } while ((mem = die_sibling(dw, mem)) != NULL); 838 839 hash_add(dw->dw_enumhash, tdp); 840 841 tdp->t_flags |= TDESC_F_RESOLVED; 842 843 if (tdp->t_name != NULL) { 844 iidesc_t *ii = xcalloc(sizeof (iidesc_t)); 845 ii->ii_type = II_SOU; 846 ii->ii_name = xstrdup(tdp->t_name); 847 ii->ii_dtype = tdp; 848 849 iidesc_add(dw->dw_td->td_iihash, ii); 850 } 851 } 852 } 853 854 static int 855 die_enum_match(void *arg1, void *arg2) 856 { 857 tdesc_t *tdp = arg1, **fullp = arg2; 858 859 if (tdp->t_emem != NULL) { 860 *fullp = tdp; 861 return (-1); /* stop the iteration */ 862 } 863 864 return (0); 865 } 866 867 /*ARGSUSED1*/ 868 static int 869 die_enum_resolve(tdesc_t *tdp, tdesc_t **tdpp, void *private) 870 { 871 dwarf_t *dw = private; 872 tdesc_t *full = NULL; 873 874 if (tdp->t_flags & TDESC_F_RESOLVED) 875 return (1); 876 877 (void) hash_find_iter(dw->dw_enumhash, tdp, die_enum_match, &full); 878 879 /* 880 * The answer to this one won't change from iteration to iteration, 881 * so don't even try. 882 */ 883 if (full == NULL) { 884 terminate("tdp %u: enum %s has no members\n", tdp->t_id, 885 tdesc_name(tdp)); 886 } 887 888 debug(3, "tdp %u: enum %s redirected to %u\n", tdp->t_id, 889 tdesc_name(tdp), full->t_id); 890 891 tdp->t_flags |= TDESC_F_RESOLVED; 892 893 return (1); 894 } 895 896 static int 897 die_fwd_map(void *arg1, void *arg2) 898 { 899 tdesc_t *fwd = arg1, *sou = arg2; 900 901 debug(3, "tdp %u: mapped forward %s to sou %u\n", fwd->t_id, 902 tdesc_name(fwd), sou->t_id); 903 fwd->t_tdesc = sou; 904 905 return (0); 906 } 907 908 /* 909 * Structures and unions will never be resolved during the first pass, as we 910 * won't be able to fully determine the member sizes. The second pass, which 911 * have access to sizing information, will be able to complete the resolution. 912 */ 913 static void 914 die_sou_create(dwarf_t *dw, Dwarf_Die str, Dwarf_Off off, tdesc_t *tdp, 915 int type, const char *typename) 916 { 917 Dwarf_Unsigned sz, bitsz, bitoff; 918 Dwarf_Die mem; 919 mlist_t *ml, **mlastp; 920 iidesc_t *ii; 921 922 tdp->t_type = (die_isdecl(dw, str) ? FORWARD : type); 923 924 debug(3, "die %llu: creating %s %s\n", off, 925 (tdp->t_type == FORWARD ? "forward decl" : typename), 926 tdesc_name(tdp)); 927 928 if (tdp->t_type == FORWARD) { 929 hash_add(dw->dw_fwdhash, tdp); 930 return; 931 } 932 933 (void) hash_find_iter(dw->dw_fwdhash, tdp, die_fwd_map, tdp); 934 935 (void) die_unsigned(dw, str, DW_AT_byte_size, &sz, DW_ATTR_REQ); 936 tdp->t_size = sz; 937 938 if ((mem = die_child(dw, str)) == NULL) 939 terminate("die %llu: %s has no members", off, typename); 940 941 mlastp = &tdp->t_members; 942 943 do { 944 Dwarf_Off memoff = die_off(dw, mem); 945 Dwarf_Half tag = die_tag(dw, mem); 946 Dwarf_Unsigned mloff; 947 948 if (tag != DW_TAG_member) { 949 /* Nested type declaration */ 950 die_create_one(dw, mem); 951 continue; 952 } 953 954 debug(3, "die %llu: mem %llu: creating member\n", off, memoff); 955 956 ml = xcalloc(sizeof (mlist_t)); 957 958 if ((ml->ml_name = die_name(dw, mem)) == NULL) { 959 terminate("die %llu: mem %llu: member has no name\n", 960 off, memoff); 961 } 962 963 ml->ml_type = die_lookup_pass1(dw, mem, DW_AT_type); 964 965 if (die_mem_offset(dw, mem, DW_AT_data_member_location, 966 &mloff, 0)) { 967 debug(3, "die %llu: got mloff %llx\n", off, 968 (u_longlong_t)mloff); 969 ml->ml_offset = mloff * 8; 970 } 971 972 if (die_unsigned(dw, mem, DW_AT_bit_size, &bitsz, 0)) 973 ml->ml_size = bitsz; 974 else 975 ml->ml_size = tdesc_bitsize(ml->ml_type); 976 977 if (die_unsigned(dw, mem, DW_AT_bit_offset, &bitoff, 0)) { 978 #ifdef _BIG_ENDIAN 979 ml->ml_offset += bitoff; 980 #else 981 ml->ml_offset += (dw->dw_ptrsz * NBBY - bitoff - 982 ml->ml_size); 983 #endif 984 } 985 986 debug(3, "die %llu: mem %llu: created %s (off %u sz %u)\n", 987 off, memoff, ml->ml_name, ml->ml_offset, ml->ml_size); 988 989 *mlastp = ml; 990 mlastp = &ml->ml_next; 991 } while ((mem = die_sibling(dw, mem)) != NULL); 992 993 /* 994 * GCC will attempt to eliminate unused types, thus decreasing the 995 * size of the emitted dwarf. That is, if you declare a foo_t in your 996 * header, include said header in your source file, and neglect to 997 * actually use (directly or indirectly) the foo_t in the source file, 998 * the foo_t won't make it into the emitted DWARF. So, at least, goes 999 * the theory. 1000 * 1001 * Occasionally, it'll emit the DW_TAG_structure_type for the foo_t, 1002 * and then neglect to emit the members. Strangely, the loner struct 1003 * tag will always be followed by a proper nested declaration of 1004 * something else. This is clearly a bug, but we're not going to have 1005 * time to get it fixed before this goo goes back, so we'll have to work 1006 * around it. If we see a no-membered struct with a nested declaration 1007 * (i.e. die_child of the struct tag won't be null), we'll ignore it. 1008 * Being paranoid, we won't simply remove it from the hash. Instead, 1009 * we'll decline to create an iidesc for it, thus ensuring that this 1010 * type won't make it into the output file. To be safe, we'll also 1011 * change the name. 1012 */ 1013 if (tdp->t_members == NULL) { 1014 const char *old = tdesc_name(tdp); 1015 size_t newsz = 7 + strlen(old) + 1; 1016 char *new = xmalloc(newsz); 1017 (void) snprintf(new, newsz, "orphan %s", old); 1018 1019 debug(3, "die %llu: worked around %s %s\n", off, typename, old); 1020 1021 if (tdp->t_name != NULL) 1022 free(tdp->t_name); 1023 tdp->t_name = new; 1024 1025 } 1026 1027 if (tdp->t_name != NULL && tdp->t_members != NULL) { 1028 ii = xcalloc(sizeof (iidesc_t)); 1029 ii->ii_type = II_SOU; 1030 ii->ii_name = xstrdup(tdp->t_name); 1031 ii->ii_dtype = tdp; 1032 1033 iidesc_add(dw->dw_td->td_iihash, ii); 1034 } 1035 } 1036 1037 static void 1038 die_struct_create(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp) 1039 { 1040 die_sou_create(dw, die, off, tdp, STRUCT, "struct"); 1041 } 1042 1043 static void 1044 die_union_create(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp) 1045 { 1046 die_sou_create(dw, die, off, tdp, UNION, "union"); 1047 } 1048 1049 /*ARGSUSED1*/ 1050 static int 1051 die_sou_resolve(tdesc_t *tdp, tdesc_t **tdpp, void *private) 1052 { 1053 dwarf_t *dw = private; 1054 mlist_t *ml; 1055 tdesc_t *mt; 1056 1057 if (tdp->t_flags & TDESC_F_RESOLVED) 1058 return (1); 1059 1060 debug(3, "resolving sou %s\n", tdesc_name(tdp)); 1061 1062 for (ml = tdp->t_members; ml != NULL; ml = ml->ml_next) { 1063 if (ml->ml_size == 0) { 1064 if ((ml->ml_size = tdesc_bitsize(ml->ml_type)) == 0) { 1065 dw->dw_nunres++; 1066 return (1); 1067 } 1068 } 1069 1070 if ((mt = tdesc_basetype(ml->ml_type)) == NULL) { 1071 dw->dw_nunres++; 1072 return (1); 1073 } 1074 1075 if (ml->ml_size != 0 && mt->t_type == INTRINSIC && 1076 mt->t_intr->intr_nbits != ml->ml_size) { 1077 /* 1078 * This member is a bitfield, and needs to reference 1079 * an intrinsic type with the same width. If the 1080 * currently-referenced type isn't of the same width, 1081 * we'll copy it, adjusting the width of the copy to 1082 * the size we'd like. 1083 */ 1084 debug(3, "tdp %u: creating bitfield for %d bits\n", 1085 tdp->t_id, ml->ml_size); 1086 1087 ml->ml_type = tdesc_intr_clone(dw, mt, ml->ml_size); 1088 } 1089 } 1090 1091 tdp->t_flags |= TDESC_F_RESOLVED; 1092 1093 return (1); 1094 } 1095 1096 /*ARGSUSED1*/ 1097 static int 1098 die_sou_failed(tdesc_t *tdp, tdesc_t **tdpp, void *private) 1099 { 1100 const char *typename = (tdp->t_type == STRUCT ? "struct" : "union"); 1101 mlist_t *ml; 1102 1103 if (tdp->t_flags & TDESC_F_RESOLVED) 1104 return (1); 1105 1106 for (ml = tdp->t_members; ml != NULL; ml = ml->ml_next) { 1107 if (ml->ml_size == 0) { 1108 fprintf(stderr, "%s %d: failed to size member %s of " 1109 "type %s (%d)\n", typename, tdp->t_id, ml->ml_name, 1110 tdesc_name(ml->ml_type), ml->ml_type->t_id); 1111 } 1112 } 1113 1114 return (1); 1115 } 1116 1117 static void 1118 die_funcptr_create(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp) 1119 { 1120 Dwarf_Attribute attr; 1121 Dwarf_Half tag; 1122 Dwarf_Die arg; 1123 fndef_t *fn; 1124 int i; 1125 1126 debug(3, "die %llu: creating function pointer\n", off); 1127 1128 /* 1129 * We'll begin by processing any type definition nodes that may be 1130 * lurking underneath this one. 1131 */ 1132 for (arg = die_child(dw, die); arg != NULL; 1133 arg = die_sibling(dw, arg)) { 1134 if ((tag = die_tag(dw, arg)) != DW_TAG_formal_parameter && 1135 tag != DW_TAG_unspecified_parameters) { 1136 /* Nested type declaration */ 1137 die_create_one(dw, arg); 1138 } 1139 } 1140 1141 if (die_isdecl(dw, die)) { 1142 /* 1143 * This is a prototype. We don't add prototypes to the 1144 * tree, so we're going to drop the tdesc. Unfortunately, 1145 * it has already been added to the tree. Nobody will reference 1146 * it, though, and it will be leaked. 1147 */ 1148 return; 1149 } 1150 1151 fn = xcalloc(sizeof (fndef_t)); 1152 1153 tdp->t_type = FUNCTION; 1154 1155 if ((attr = die_attr(dw, die, DW_AT_type, 0)) != NULL) { 1156 dwarf_dealloc(dw->dw_dw, attr, DW_DLA_ATTR); 1157 fn->fn_ret = die_lookup_pass1(dw, die, DW_AT_type); 1158 } else { 1159 fn->fn_ret = tdesc_intr_void(dw); 1160 } 1161 1162 /* 1163 * Count the arguments to the function, then read them in. 1164 */ 1165 for (fn->fn_nargs = 0, arg = die_child(dw, die); arg != NULL; 1166 arg = die_sibling(dw, arg)) { 1167 if ((tag = die_tag(dw, arg)) == DW_TAG_formal_parameter) 1168 fn->fn_nargs++; 1169 else if (tag == DW_TAG_unspecified_parameters && 1170 fn->fn_nargs > 0) 1171 fn->fn_vargs = 1; 1172 } 1173 1174 if (fn->fn_nargs != 0) { 1175 debug(3, "die %llu: adding %d argument%s\n", off, fn->fn_nargs, 1176 (fn->fn_nargs > 1 ? "s" : "")); 1177 1178 fn->fn_args = xcalloc(sizeof (tdesc_t *) * fn->fn_nargs); 1179 for (i = 0, arg = die_child(dw, die); 1180 arg != NULL && i < fn->fn_nargs; 1181 arg = die_sibling(dw, arg)) { 1182 if (die_tag(dw, arg) != DW_TAG_formal_parameter) 1183 continue; 1184 1185 fn->fn_args[i++] = die_lookup_pass1(dw, arg, 1186 DW_AT_type); 1187 } 1188 } 1189 1190 tdp->t_fndef = fn; 1191 tdp->t_flags |= TDESC_F_RESOLVED; 1192 } 1193 1194 /* 1195 * GCC and DevPro use different names for the base types. While the terms are 1196 * the same, they are arranged in a different order. Some terms, such as int, 1197 * are implied in one, and explicitly named in the other. Given a base type 1198 * as input, this routine will return a common name, along with an intr_t 1199 * that reflects said name. 1200 */ 1201 static intr_t * 1202 die_base_name_parse(const char *name, char **newp) 1203 { 1204 char buf[100]; 1205 char *base, *c; 1206 int nlong = 0, nshort = 0, nchar = 0, nint = 0; 1207 int sign = 1; 1208 char fmt = '\0'; 1209 intr_t *intr; 1210 1211 if (strlen(name) > sizeof (buf) - 1) 1212 terminate("base type name \"%s\" is too long\n", name); 1213 1214 strncpy(buf, name, sizeof (buf)); 1215 1216 for (c = strtok(buf, " "); c != NULL; c = strtok(NULL, " ")) { 1217 if (strcmp(c, "signed") == 0) 1218 sign = 1; 1219 else if (strcmp(c, "unsigned") == 0) 1220 sign = 0; 1221 else if (strcmp(c, "long") == 0) 1222 nlong++; 1223 else if (strcmp(c, "char") == 0) { 1224 nchar++; 1225 fmt = 'c'; 1226 } else if (strcmp(c, "short") == 0) 1227 nshort++; 1228 else if (strcmp(c, "int") == 0) 1229 nint++; 1230 else { 1231 /* 1232 * If we don't recognize any of the tokens, we'll tell 1233 * the caller to fall back to the dwarf-provided 1234 * encoding information. 1235 */ 1236 return (NULL); 1237 } 1238 } 1239 1240 if (nchar > 1 || nshort > 1 || nint > 1 || nlong > 2) 1241 return (NULL); 1242 1243 if (nchar > 0) { 1244 if (nlong > 0 || nshort > 0 || nint > 0) 1245 return (NULL); 1246 1247 base = "char"; 1248 1249 } else if (nshort > 0) { 1250 if (nlong > 0) 1251 return (NULL); 1252 1253 base = "short"; 1254 1255 } else if (nlong > 0) { 1256 base = "long"; 1257 1258 } else { 1259 base = "int"; 1260 } 1261 1262 intr = xcalloc(sizeof (intr_t)); 1263 intr->intr_type = INTR_INT; 1264 intr->intr_signed = sign; 1265 intr->intr_iformat = fmt; 1266 1267 snprintf(buf, sizeof (buf), "%s%s%s", 1268 (sign ? "" : "unsigned "), 1269 (nlong > 1 ? "long " : ""), 1270 base); 1271 1272 *newp = xstrdup(buf); 1273 return (intr); 1274 } 1275 1276 typedef struct fp_size_map { 1277 size_t fsm_typesz[2]; /* size of {32,64} type */ 1278 uint_t fsm_enc[3]; /* CTF_FP_* for {bare,cplx,imagry} type */ 1279 } fp_size_map_t; 1280 1281 static const fp_size_map_t fp_encodings[] = { 1282 { { 4, 4 }, { CTF_FP_SINGLE, CTF_FP_CPLX, CTF_FP_IMAGRY } }, 1283 { { 8, 8 }, { CTF_FP_DOUBLE, CTF_FP_DCPLX, CTF_FP_DIMAGRY } }, 1284 #ifdef __sparc 1285 { { 16, 16 }, { CTF_FP_LDOUBLE, CTF_FP_LDCPLX, CTF_FP_LDIMAGRY } }, 1286 #else 1287 { { 12, 16 }, { CTF_FP_LDOUBLE, CTF_FP_LDCPLX, CTF_FP_LDIMAGRY } }, 1288 #endif 1289 { { 0, 0 } } 1290 }; 1291 1292 static uint_t 1293 die_base_type2enc(dwarf_t *dw, Dwarf_Off off, Dwarf_Signed enc, size_t sz) 1294 { 1295 const fp_size_map_t *map = fp_encodings; 1296 uint_t szidx = dw->dw_ptrsz == sizeof (uint64_t); 1297 uint_t mult = 1, col = 0; 1298 1299 if (enc == DW_ATE_complex_float) { 1300 mult = 2; 1301 col = 1; 1302 } else if (enc == DW_ATE_imaginary_float || 1303 enc == DW_ATE_SUN_imaginary_float) 1304 col = 2; 1305 1306 while (map->fsm_typesz[szidx] != 0) { 1307 if (map->fsm_typesz[szidx] * mult == sz) 1308 return (map->fsm_enc[col]); 1309 map++; 1310 } 1311 1312 terminate("die %llu: unrecognized real type size %u\n", off, sz); 1313 /*NOTREACHED*/ 1314 return (0); 1315 } 1316 1317 static intr_t * 1318 die_base_from_dwarf(dwarf_t *dw, Dwarf_Die base, Dwarf_Off off, size_t sz) 1319 { 1320 intr_t *intr = xcalloc(sizeof (intr_t)); 1321 Dwarf_Signed enc; 1322 1323 (void) die_signed(dw, base, DW_AT_encoding, &enc, DW_ATTR_REQ); 1324 1325 switch (enc) { 1326 case DW_ATE_unsigned: 1327 case DW_ATE_address: 1328 intr->intr_type = INTR_INT; 1329 break; 1330 case DW_ATE_unsigned_char: 1331 intr->intr_type = INTR_INT; 1332 intr->intr_iformat = 'c'; 1333 break; 1334 case DW_ATE_signed: 1335 intr->intr_type = INTR_INT; 1336 intr->intr_signed = 1; 1337 break; 1338 case DW_ATE_signed_char: 1339 intr->intr_type = INTR_INT; 1340 intr->intr_signed = 1; 1341 intr->intr_iformat = 'c'; 1342 break; 1343 case DW_ATE_boolean: 1344 intr->intr_type = INTR_INT; 1345 intr->intr_signed = 1; 1346 intr->intr_iformat = 'b'; 1347 break; 1348 case DW_ATE_float: 1349 case DW_ATE_complex_float: 1350 case DW_ATE_imaginary_float: 1351 case DW_ATE_SUN_imaginary_float: 1352 case DW_ATE_SUN_interval_float: 1353 intr->intr_type = INTR_REAL; 1354 intr->intr_signed = 1; 1355 intr->intr_fformat = die_base_type2enc(dw, off, enc, sz); 1356 break; 1357 default: 1358 terminate("die %llu: unknown base type encoding 0x%llx\n", 1359 off, enc); 1360 } 1361 1362 return (intr); 1363 } 1364 1365 static void 1366 die_base_create(dwarf_t *dw, Dwarf_Die base, Dwarf_Off off, tdesc_t *tdp) 1367 { 1368 Dwarf_Unsigned sz; 1369 intr_t *intr; 1370 char *new; 1371 1372 debug(3, "die %llu: creating base type\n", off); 1373 1374 /* 1375 * The compilers have their own clever (internally inconsistent) ideas 1376 * as to what base types should look like. Some times gcc will, for 1377 * example, use DW_ATE_signed_char for char. Other times, however, it 1378 * will use DW_ATE_signed. Needless to say, this causes some problems 1379 * down the road, particularly with merging. We do, however, use the 1380 * DWARF idea of type sizes, as this allows us to avoid caring about 1381 * the data model. 1382 */ 1383 (void) die_unsigned(dw, base, DW_AT_byte_size, &sz, DW_ATTR_REQ); 1384 1385 if (tdp->t_name == NULL) 1386 terminate("die %llu: base type without name\n", off); 1387 1388 /* XXX make a name parser for float too */ 1389 if ((intr = die_base_name_parse(tdp->t_name, &new)) != NULL) { 1390 /* Found it. We'll use the parsed version */ 1391 debug(3, "die %llu: name \"%s\" remapped to \"%s\"\n", off, 1392 tdesc_name(tdp), new); 1393 1394 free(tdp->t_name); 1395 tdp->t_name = new; 1396 } else { 1397 /* 1398 * We didn't recognize the type, so we'll create an intr_t 1399 * based on the DWARF data. 1400 */ 1401 debug(3, "die %llu: using dwarf data for base \"%s\"\n", off, 1402 tdesc_name(tdp)); 1403 1404 intr = die_base_from_dwarf(dw, base, off, sz); 1405 } 1406 1407 intr->intr_nbits = sz * 8; 1408 1409 tdp->t_type = INTRINSIC; 1410 tdp->t_intr = intr; 1411 tdp->t_size = sz; 1412 1413 tdp->t_flags |= TDESC_F_RESOLVED; 1414 } 1415 1416 static void 1417 die_through_create(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp, 1418 int type, const char *typename) 1419 { 1420 Dwarf_Attribute attr; 1421 1422 debug(3, "die %llu: creating %s\n", off, typename); 1423 1424 tdp->t_type = type; 1425 1426 if ((attr = die_attr(dw, die, DW_AT_type, 0)) != NULL) { 1427 dwarf_dealloc(dw->dw_dw, attr, DW_DLA_ATTR); 1428 tdp->t_tdesc = die_lookup_pass1(dw, die, DW_AT_type); 1429 } else { 1430 tdp->t_tdesc = tdesc_intr_void(dw); 1431 } 1432 1433 if (type == POINTER) 1434 tdp->t_size = dw->dw_ptrsz; 1435 1436 tdp->t_flags |= TDESC_F_RESOLVED; 1437 1438 if (type == TYPEDEF) { 1439 iidesc_t *ii = xcalloc(sizeof (iidesc_t)); 1440 ii->ii_type = II_TYPE; 1441 ii->ii_name = xstrdup(tdp->t_name); 1442 ii->ii_dtype = tdp; 1443 1444 iidesc_add(dw->dw_td->td_iihash, ii); 1445 } 1446 } 1447 1448 static void 1449 die_typedef_create(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp) 1450 { 1451 die_through_create(dw, die, off, tdp, TYPEDEF, "typedef"); 1452 } 1453 1454 static void 1455 die_const_create(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp) 1456 { 1457 die_through_create(dw, die, off, tdp, CONST, "const"); 1458 } 1459 1460 static void 1461 die_pointer_create(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp) 1462 { 1463 die_through_create(dw, die, off, tdp, POINTER, "pointer"); 1464 } 1465 1466 static void 1467 die_restrict_create(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp) 1468 { 1469 die_through_create(dw, die, off, tdp, RESTRICT, "restrict"); 1470 } 1471 1472 static void 1473 die_volatile_create(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp) 1474 { 1475 die_through_create(dw, die, off, tdp, VOLATILE, "volatile"); 1476 } 1477 1478 /*ARGSUSED3*/ 1479 static void 1480 die_function_create(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp) 1481 { 1482 Dwarf_Die arg; 1483 Dwarf_Half tag; 1484 iidesc_t *ii; 1485 char *name; 1486 1487 debug(3, "die %llu: creating function definition\n", off); 1488 1489 /* 1490 * We'll begin by processing any type definition nodes that may be 1491 * lurking underneath this one. 1492 */ 1493 for (arg = die_child(dw, die); arg != NULL; 1494 arg = die_sibling(dw, arg)) { 1495 if ((tag = die_tag(dw, arg)) != DW_TAG_formal_parameter && 1496 tag != DW_TAG_variable) { 1497 /* Nested type declaration */ 1498 die_create_one(dw, arg); 1499 } 1500 } 1501 1502 if (die_isdecl(dw, die) || (name = die_name(dw, die)) == NULL) { 1503 /* 1504 * We process neither prototypes nor subprograms without 1505 * names. 1506 */ 1507 return; 1508 } 1509 1510 ii = xcalloc(sizeof (iidesc_t)); 1511 ii->ii_type = die_isglobal(dw, die) ? II_GFUN : II_SFUN; 1512 ii->ii_name = name; 1513 if (ii->ii_type == II_SFUN) 1514 ii->ii_owner = xstrdup(dw->dw_cuname); 1515 1516 debug(3, "die %llu: function %s is %s\n", off, ii->ii_name, 1517 (ii->ii_type == II_GFUN ? "global" : "static")); 1518 1519 if (die_attr(dw, die, DW_AT_type, 0) != NULL) 1520 ii->ii_dtype = die_lookup_pass1(dw, die, DW_AT_type); 1521 else 1522 ii->ii_dtype = tdesc_intr_void(dw); 1523 1524 for (arg = die_child(dw, die); arg != NULL; 1525 arg = die_sibling(dw, arg)) { 1526 char *name; 1527 1528 debug(3, "die %llu: looking at sub member at %llu\n", 1529 off, die_off(dw, die)); 1530 1531 if (die_tag(dw, arg) != DW_TAG_formal_parameter) 1532 continue; 1533 1534 if ((name = die_name(dw, arg)) == NULL) { 1535 terminate("die %llu: func arg %d has no name\n", 1536 off, ii->ii_nargs + 1); 1537 } 1538 1539 if (strcmp(name, "...") == 0) { 1540 free(name); 1541 ii->ii_vargs = 1; 1542 continue; 1543 } 1544 1545 ii->ii_nargs++; 1546 } 1547 1548 if (ii->ii_nargs > 0) { 1549 int i; 1550 1551 debug(3, "die %llu: function has %d argument%s\n", off, 1552 ii->ii_nargs, (ii->ii_nargs == 1 ? "" : "s")); 1553 1554 ii->ii_args = xcalloc(sizeof (tdesc_t) * ii->ii_nargs); 1555 1556 for (arg = die_child(dw, die), i = 0; 1557 arg != NULL && i < ii->ii_nargs; 1558 arg = die_sibling(dw, arg)) { 1559 if (die_tag(dw, arg) != DW_TAG_formal_parameter) 1560 continue; 1561 1562 ii->ii_args[i++] = die_lookup_pass1(dw, arg, 1563 DW_AT_type); 1564 } 1565 } 1566 1567 iidesc_add(dw->dw_td->td_iihash, ii); 1568 } 1569 1570 /*ARGSUSED3*/ 1571 static void 1572 die_variable_create(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp) 1573 { 1574 iidesc_t *ii; 1575 char *name; 1576 1577 debug(3, "die %llu: creating object definition\n", off); 1578 1579 if (die_isdecl(dw, die) || (name = die_name(dw, die)) == NULL) 1580 return; /* skip prototypes and nameless objects */ 1581 1582 ii = xcalloc(sizeof (iidesc_t)); 1583 ii->ii_type = die_isglobal(dw, die) ? II_GVAR : II_SVAR; 1584 ii->ii_name = name; 1585 ii->ii_dtype = die_lookup_pass1(dw, die, DW_AT_type); 1586 if (ii->ii_type == II_SVAR) 1587 ii->ii_owner = xstrdup(dw->dw_cuname); 1588 1589 iidesc_add(dw->dw_td->td_iihash, ii); 1590 } 1591 1592 /*ARGSUSED2*/ 1593 static int 1594 die_fwd_resolve(tdesc_t *fwd, tdesc_t **fwdp, void *private) 1595 { 1596 if (fwd->t_flags & TDESC_F_RESOLVED) 1597 return (1); 1598 1599 if (fwd->t_tdesc != NULL) { 1600 debug(3, "tdp %u: unforwarded %s\n", fwd->t_id, 1601 tdesc_name(fwd)); 1602 *fwdp = fwd->t_tdesc; 1603 } 1604 1605 fwd->t_flags |= TDESC_F_RESOLVED; 1606 1607 return (1); 1608 } 1609 1610 /*ARGSUSED*/ 1611 static void 1612 die_lexblk_descend(dwarf_t *dw, Dwarf_Die die, Dwarf_Off off, tdesc_t *tdp) 1613 { 1614 Dwarf_Die child = die_child(dw, die); 1615 1616 if (child != NULL) 1617 die_create(dw, child); 1618 } 1619 1620 /* 1621 * Used to map the die to a routine which can parse it, using the tag to do the 1622 * mapping. While the processing of most tags entails the creation of a tdesc, 1623 * there are a few which don't - primarily those which result in the creation of 1624 * iidescs which refer to existing tdescs. 1625 */ 1626 1627 #define DW_F_NOTDP 0x1 /* Don't create a tdesc for the creator */ 1628 1629 typedef struct die_creator { 1630 Dwarf_Half dc_tag; 1631 uint16_t dc_flags; 1632 void (*dc_create)(dwarf_t *, Dwarf_Die, Dwarf_Off, tdesc_t *); 1633 } die_creator_t; 1634 1635 static const die_creator_t die_creators[] = { 1636 { DW_TAG_array_type, 0, die_array_create }, 1637 { DW_TAG_enumeration_type, 0, die_enum_create }, 1638 { DW_TAG_lexical_block, DW_F_NOTDP, die_lexblk_descend }, 1639 { DW_TAG_pointer_type, 0, die_pointer_create }, 1640 { DW_TAG_structure_type, 0, die_struct_create }, 1641 { DW_TAG_subroutine_type, 0, die_funcptr_create }, 1642 { DW_TAG_typedef, 0, die_typedef_create }, 1643 { DW_TAG_union_type, 0, die_union_create }, 1644 { DW_TAG_base_type, 0, die_base_create }, 1645 { DW_TAG_const_type, 0, die_const_create }, 1646 { DW_TAG_subprogram, DW_F_NOTDP, die_function_create }, 1647 { DW_TAG_variable, DW_F_NOTDP, die_variable_create }, 1648 { DW_TAG_volatile_type, 0, die_volatile_create }, 1649 { DW_TAG_restrict_type, 0, die_restrict_create }, 1650 { 0, NULL } 1651 }; 1652 1653 static const die_creator_t * 1654 die_tag2ctor(Dwarf_Half tag) 1655 { 1656 const die_creator_t *dc; 1657 1658 for (dc = die_creators; dc->dc_create != NULL; dc++) { 1659 if (dc->dc_tag == tag) 1660 return (dc); 1661 } 1662 1663 return (NULL); 1664 } 1665 1666 static void 1667 die_create_one(dwarf_t *dw, Dwarf_Die die) 1668 { 1669 Dwarf_Off off = die_off(dw, die); 1670 const die_creator_t *dc; 1671 Dwarf_Half tag; 1672 tdesc_t *tdp; 1673 1674 debug(3, "die %llu: create_one\n", off); 1675 1676 if (off > dw->dw_maxoff) { 1677 terminate("illegal die offset %llu (max %llu)\n", off, 1678 dw->dw_maxoff); 1679 } 1680 1681 tag = die_tag(dw, die); 1682 1683 if ((dc = die_tag2ctor(tag)) == NULL) { 1684 debug(2, "die %llu: ignoring tag type %x\n", off, tag); 1685 return; 1686 } 1687 1688 if ((tdp = tdesc_lookup(dw, off)) == NULL && 1689 !(dc->dc_flags & DW_F_NOTDP)) { 1690 tdp = xcalloc(sizeof (tdesc_t)); 1691 tdp->t_id = off; 1692 tdesc_add(dw, tdp); 1693 } 1694 1695 if (tdp != NULL) 1696 tdp->t_name = die_name(dw, die); 1697 1698 dc->dc_create(dw, die, off, tdp); 1699 } 1700 1701 static void 1702 die_create(dwarf_t *dw, Dwarf_Die die) 1703 { 1704 do { 1705 die_create_one(dw, die); 1706 } while ((die = die_sibling(dw, die)) != NULL); 1707 } 1708 1709 static tdtrav_cb_f die_resolvers[] = { 1710 NULL, 1711 NULL, /* intrinsic */ 1712 NULL, /* pointer */ 1713 die_array_resolve, /* array */ 1714 NULL, /* function */ 1715 die_sou_resolve, /* struct */ 1716 die_sou_resolve, /* union */ 1717 die_enum_resolve, /* enum */ 1718 die_fwd_resolve, /* forward */ 1719 NULL, /* typedef */ 1720 NULL, /* typedef unres */ 1721 NULL, /* volatile */ 1722 NULL, /* const */ 1723 NULL, /* restrict */ 1724 }; 1725 1726 static tdtrav_cb_f die_fail_reporters[] = { 1727 NULL, 1728 NULL, /* intrinsic */ 1729 NULL, /* pointer */ 1730 die_array_failed, /* array */ 1731 NULL, /* function */ 1732 die_sou_failed, /* struct */ 1733 die_sou_failed, /* union */ 1734 NULL, /* enum */ 1735 NULL, /* forward */ 1736 NULL, /* typedef */ 1737 NULL, /* typedef unres */ 1738 NULL, /* volatile */ 1739 NULL, /* const */ 1740 NULL, /* restrict */ 1741 }; 1742 1743 static void 1744 die_resolve(dwarf_t *dw) 1745 { 1746 int last = -1; 1747 int pass = 0; 1748 1749 do { 1750 pass++; 1751 dw->dw_nunres = 0; 1752 1753 (void) iitraverse_hash(dw->dw_td->td_iihash, 1754 &dw->dw_td->td_curvgen, NULL, NULL, die_resolvers, dw); 1755 1756 debug(3, "resolve: pass %d, %u left\n", pass, dw->dw_nunres); 1757 1758 if (dw->dw_nunres == last) { 1759 fprintf(stderr, "%s: failed to resolve the following " 1760 "types:\n", progname); 1761 1762 (void) iitraverse_hash(dw->dw_td->td_iihash, 1763 &dw->dw_td->td_curvgen, NULL, NULL, 1764 die_fail_reporters, dw); 1765 1766 terminate("failed to resolve types\n"); 1767 } 1768 1769 last = dw->dw_nunres; 1770 1771 } while (dw->dw_nunres != 0); 1772 } 1773 1774 static size_t 1775 elf_ptrsz(Elf *elf) 1776 { 1777 GElf_Ehdr ehdr; 1778 1779 if (gelf_getehdr(elf, &ehdr) == NULL) { 1780 terminate("failed to read ELF header: %s\n", 1781 elf_errmsg(elf_errno())); 1782 } 1783 1784 if (ehdr.e_ident[EI_CLASS] == ELFCLASS32) 1785 return (4); 1786 else if (ehdr.e_ident[EI_CLASS] == ELFCLASS64) 1787 return (8); 1788 else 1789 terminate("unknown ELF class %d\n", ehdr.e_ident[EI_CLASS]); 1790 1791 /*NOTREACHED*/ 1792 return (0); 1793 } 1794 1795 /*ARGSUSED*/ 1796 int 1797 dw_read(tdata_t *td, Elf *elf, const char *filename) 1798 { 1799 Dwarf_Unsigned abboff, hdrlen, nxthdr; 1800 Dwarf_Half vers, addrsz; 1801 Dwarf_Die cu, child; 1802 dwarf_t dw; 1803 char *prod = NULL; 1804 int rc; 1805 1806 bzero(&dw, sizeof (dwarf_t)); 1807 dw.dw_td = td; 1808 dw.dw_ptrsz = elf_ptrsz(elf); 1809 dw.dw_mfgtid_last = TID_MFGTID_BASE; 1810 dw.dw_tidhash = hash_new(TDESC_HASH_BUCKETS, tdesc_idhash, tdesc_idcmp); 1811 dw.dw_fwdhash = hash_new(TDESC_HASH_BUCKETS, tdesc_namehash, 1812 tdesc_namecmp); 1813 dw.dw_enumhash = hash_new(TDESC_HASH_BUCKETS, tdesc_namehash, 1814 tdesc_namecmp); 1815 1816 if ((rc = dwarf_elf_init(elf, DW_DLC_READ, NULL, NULL, &dw.dw_dw, 1817 &dw.dw_err)) == DW_DLV_NO_ENTRY) { 1818 errno = ENOENT; 1819 return (-1); 1820 } else if (rc != DW_DLV_OK) { 1821 if (dwarf_errno(dw.dw_err) == DW_DLE_DEBUG_INFO_NULL) { 1822 /* 1823 * There's no type data in the DWARF section, but 1824 * libdwarf is too clever to handle that properly. 1825 */ 1826 return (0); 1827 } 1828 1829 terminate("failed to initialize DWARF: %s\n", 1830 dwarf_errmsg(dw.dw_err)); 1831 } 1832 1833 if ((rc = dwarf_next_cu_header(dw.dw_dw, &hdrlen, &vers, &abboff, 1834 &addrsz, &nxthdr, &dw.dw_err)) != DW_DLV_OK || 1835 (cu = die_sibling(&dw, NULL)) == NULL || 1836 (child = die_child(&dw, cu)) == NULL) 1837 terminate("file does not contain dwarf type data " 1838 "(try compiling with -g)\n"); 1839 1840 dw.dw_maxoff = nxthdr - 1; 1841 1842 if (dw.dw_maxoff > TID_FILEMAX) 1843 terminate("file contains too many types\n"); 1844 1845 debug(1, "DWARF version: %d\n", vers); 1846 if (vers != DWARF_VERSION) { 1847 terminate("file contains incompatible version %d DWARF code " 1848 "(version 2 required)\n", vers); 1849 } 1850 1851 if (die_string(&dw, cu, DW_AT_producer, &prod, 0)) { 1852 debug(1, "DWARF emitter: %s\n", prod); 1853 free(prod); 1854 } 1855 1856 if ((dw.dw_cuname = die_name(&dw, cu)) != NULL) { 1857 char *base = xstrdup(basename(dw.dw_cuname)); 1858 free(dw.dw_cuname); 1859 dw.dw_cuname = base; 1860 1861 debug(1, "CU name: %s\n", dw.dw_cuname); 1862 } 1863 1864 die_create(&dw, child); 1865 1866 if ((rc = dwarf_next_cu_header(dw.dw_dw, &hdrlen, &vers, &abboff, 1867 &addrsz, &nxthdr, &dw.dw_err)) != DW_DLV_NO_ENTRY) 1868 terminate("multiple compilation units not supported\n"); 1869 1870 (void) dwarf_finish(dw.dw_dw, &dw.dw_err); 1871 1872 die_resolve(&dw); 1873 1874 /* leak the dwarf_t */ 1875 1876 return (0); 1877 } 1878