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