1 /* stabs.c -- Parse COFF debugging information
2 Copyright 1996, 2000 Free Software Foundation, Inc.
3 Written by Ian Lance Taylor <ian@cygnus.com>.
5 This file is part of GNU Binutils.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
22 /* This file contains code which parses COFF debugging information. */
25 #include "coff/internal.h"
27 #include "libiberty.h"
31 /* FIXME: We should not need this BFD internal file. We need it for
32 the N_BTMASK, etc., values. */
35 /* These macros extract the right mask and shifts for this BFD. They
36 assume that there is a local variable named ABFD. This is so that
37 macros like ISFCN and DECREF, from coff/internal.h, will work
38 without modification. */
39 #define N_BTMASK (coff_data (abfd)->local_n_btmask)
40 #define N_BTSHFT (coff_data (abfd)->local_n_btshft)
41 #define N_TMASK (coff_data (abfd)->local_n_tmask)
42 #define N_TSHIFT (coff_data (abfd)->local_n_tshift)
44 /* This structure is used to hold the symbols, as well as the current
45 location within the symbols. */
51 /* The number of symbols. */
53 /* The index of the current symbol. */
55 /* The index of the current symbol in the COFF symbol table (where
56 each auxent counts as a symbol). */
60 /* The largest basic type we are prepared to handle. */
62 #define T_MAX (T_LNGDBL)
64 /* This structure is used to hold slots. */
68 /* Next set of slots. */
69 struct coff_slots *next;
71 #define COFF_SLOTS (16)
72 debug_type slots[COFF_SLOTS];
75 /* This structure is used to map symbol indices to types. */
80 struct coff_slots *slots;
82 debug_type basic[T_MAX + 1];
85 static debug_type *coff_get_slot PARAMS ((struct coff_types *, int));
86 static debug_type parse_coff_type
87 PARAMS ((bfd *, struct coff_symbols *, struct coff_types *, long, int,
88 union internal_auxent *, boolean, PTR));
89 static debug_type parse_coff_base_type
90 PARAMS ((bfd *, struct coff_symbols *, struct coff_types *, long, int,
91 union internal_auxent *, PTR));
92 static debug_type parse_coff_struct_type
93 PARAMS ((bfd *, struct coff_symbols *, struct coff_types *, int,
94 union internal_auxent *, PTR));
95 static debug_type parse_coff_enum_type
96 PARAMS ((bfd *, struct coff_symbols *, struct coff_types *,
97 union internal_auxent *, PTR));
98 static boolean parse_coff_symbol
99 PARAMS ((bfd *, struct coff_types *, asymbol *, long,
100 struct internal_syment *, PTR, debug_type, boolean));
101 static boolean external_coff_symbol_p PARAMS ((int sym_class));
103 /* Return the slot for a type. */
106 coff_get_slot (types, indx)
107 struct coff_types *types;
110 struct coff_slots **pps;
114 while (indx >= COFF_SLOTS)
118 *pps = (struct coff_slots *) xmalloc (sizeof **pps);
119 memset (*pps, 0, sizeof **pps);
127 *pps = (struct coff_slots *) xmalloc (sizeof **pps);
128 memset (*pps, 0, sizeof **pps);
131 return (*pps)->slots + indx;
134 /* Parse a COFF type code in NTYPE. */
137 parse_coff_type (abfd, symbols, types, coff_symno, ntype, pauxent, useaux,
140 struct coff_symbols *symbols;
141 struct coff_types *types;
144 union internal_auxent *pauxent;
150 if ((ntype & ~N_BTMASK) != 0)
154 newtype = DECREF (ntype);
158 type = parse_coff_type (abfd, symbols, types, coff_symno, newtype,
159 pauxent, useaux, dhandle);
160 type = debug_make_pointer_type (dhandle, type);
162 else if (ISFCN (ntype))
164 type = parse_coff_type (abfd, symbols, types, coff_symno, newtype,
165 pauxent, useaux, dhandle);
166 type = debug_make_function_type (dhandle, type, (debug_type *) NULL,
169 else if (ISARY (ntype))
180 /* FIXME: If pauxent->x_sym.x_tagndx.l == 0, gdb sets
181 the c_naux field of the syment to 0. */
183 /* Move the dimensions down, so that the next array
184 picks up the next one. */
185 dim = pauxent->x_sym.x_fcnary.x_ary.x_dimen;
187 for (i = 0; *dim != 0 && i < DIMNUM - 1; i++, dim++)
192 type = parse_coff_type (abfd, symbols, types, coff_symno, newtype,
193 pauxent, false, dhandle);
194 type = debug_make_array_type (dhandle, type,
195 parse_coff_base_type (abfd, symbols,
204 non_fatal (_("parse_coff_type: Bad type code 0x%x"), ntype);
205 return DEBUG_TYPE_NULL;
211 if (pauxent != NULL && pauxent->x_sym.x_tagndx.l > 0)
215 /* This is a reference to an existing type. FIXME: gdb checks
216 that the class is not C_STRTAG, nor C_UNTAG, nor C_ENTAG. */
217 slot = coff_get_slot (types, pauxent->x_sym.x_tagndx.l);
218 if (*slot != DEBUG_TYPE_NULL)
221 return debug_make_indirect_type (dhandle, slot, (const char *) NULL);
224 /* If the aux entry has already been used for something, useaux will
225 have been set to false, indicating that parse_coff_base_type
226 should not use it. We need to do it this way, rather than simply
227 passing pauxent as NULL, because we need to be able handle
228 multiple array dimensions while still discarding pauxent after
229 having handled all of them. */
233 return parse_coff_base_type (abfd, symbols, types, coff_symno, ntype,
237 /* Parse a basic COFF type in NTYPE. */
240 parse_coff_base_type (abfd, symbols, types, coff_symno, ntype, pauxent,
243 struct coff_symbols *symbols;
244 struct coff_types *types;
247 union internal_auxent *pauxent;
257 && types->basic[ntype] != DEBUG_TYPE_NULL)
258 return types->basic[ntype];
266 ret = debug_make_void_type (dhandle);
271 ret = debug_make_void_type (dhandle);
276 ret = debug_make_int_type (dhandle, 1, false);
281 ret = debug_make_int_type (dhandle, 2, false);
286 /* FIXME: Perhaps the size should depend upon the architecture. */
287 ret = debug_make_int_type (dhandle, 4, false);
292 ret = debug_make_int_type (dhandle, 4, false);
297 ret = debug_make_float_type (dhandle, 4);
302 ret = debug_make_float_type (dhandle, 8);
307 ret = debug_make_float_type (dhandle, 12);
308 name = "long double";
312 ret = debug_make_int_type (dhandle, 1, true);
313 name = "unsigned char";
317 ret = debug_make_int_type (dhandle, 2, true);
318 name = "unsigned short";
322 ret = debug_make_int_type (dhandle, 4, true);
323 name = "unsigned int";
327 ret = debug_make_int_type (dhandle, 4, true);
328 name = "unsigned long";
333 ret = debug_make_struct_type (dhandle, true, 0,
334 (debug_field *) NULL);
336 ret = parse_coff_struct_type (abfd, symbols, types, ntype, pauxent,
339 slot = coff_get_slot (types, coff_symno);
347 ret = debug_make_struct_type (dhandle, false, 0, (debug_field *) NULL);
349 ret = parse_coff_struct_type (abfd, symbols, types, ntype, pauxent,
352 slot = coff_get_slot (types, coff_symno);
360 ret = debug_make_enum_type (dhandle, (const char **) NULL,
361 (bfd_signed_vma *) NULL);
363 ret = parse_coff_enum_type (abfd, symbols, types, pauxent, dhandle);
365 slot = coff_get_slot (types, coff_symno);
373 ret = debug_name_type (dhandle, name, ret);
378 types->basic[ntype] = ret;
383 /* Parse a struct type. */
386 parse_coff_struct_type (abfd, symbols, types, ntype, pauxent, dhandle)
388 struct coff_symbols *symbols;
389 struct coff_types *types;
391 union internal_auxent *pauxent;
400 symend = pauxent->x_sym.x_fcnary.x_fcn.x_endndx.l;
403 fields = (debug_field *) xmalloc (alloc * sizeof *fields);
408 && symbols->coff_symno < symend
409 && symbols->symno < symbols->symcount)
412 long this_coff_symno;
413 struct internal_syment syment;
414 union internal_auxent auxent;
415 union internal_auxent *psubaux;
416 bfd_vma bitpos = 0, bitsize = 0;
418 sym = symbols->syms[symbols->symno];
420 if (! bfd_coff_get_syment (abfd, sym, &syment))
422 non_fatal (_("bfd_coff_get_syment failed: %s"),
423 bfd_errmsg (bfd_get_error ()));
424 return DEBUG_TYPE_NULL;
427 this_coff_symno = symbols->coff_symno;
430 symbols->coff_symno += 1 + syment.n_numaux;
432 if (syment.n_numaux == 0)
436 if (! bfd_coff_get_auxent (abfd, sym, 0, &auxent))
438 non_fatal (_("bfd_coff_get_auxent failed: %s"),
439 bfd_errmsg (bfd_get_error ()));
440 return DEBUG_TYPE_NULL;
445 switch (syment.n_sclass)
449 bitpos = 8 * bfd_asymbol_value (sym);
454 bitpos = bfd_asymbol_value (sym);
455 bitsize = auxent.x_sym.x_misc.x_lnsz.x_size;
468 ftype = parse_coff_type (abfd, symbols, types, this_coff_symno,
469 syment.n_type, psubaux, true, dhandle);
470 f = debug_make_field (dhandle, bfd_asymbol_name (sym), ftype,
471 bitpos, bitsize, DEBUG_VISIBILITY_PUBLIC);
472 if (f == DEBUG_FIELD_NULL)
473 return DEBUG_TYPE_NULL;
475 if (count + 1 >= alloc)
478 fields = ((debug_field *)
479 xrealloc (fields, alloc * sizeof *fields));
487 fields[count] = DEBUG_FIELD_NULL;
489 return debug_make_struct_type (dhandle, ntype == T_STRUCT,
490 pauxent->x_sym.x_misc.x_lnsz.x_size,
494 /* Parse an enum type. */
497 parse_coff_enum_type (abfd, symbols, types, pauxent, dhandle)
499 struct coff_symbols *symbols;
500 struct coff_types *types ATTRIBUTE_UNUSED;
501 union internal_auxent *pauxent;
507 bfd_signed_vma *vals;
511 symend = pauxent->x_sym.x_fcnary.x_fcn.x_endndx.l;
514 names = (const char **) xmalloc (alloc * sizeof *names);
515 vals = (bfd_signed_vma *) xmalloc (alloc * sizeof *vals);
520 && symbols->coff_symno < symend
521 && symbols->symno < symbols->symcount)
524 struct internal_syment syment;
526 sym = symbols->syms[symbols->symno];
528 if (! bfd_coff_get_syment (abfd, sym, &syment))
530 non_fatal (_("bfd_coff_get_syment failed: %s"),
531 bfd_errmsg (bfd_get_error ()));
532 return DEBUG_TYPE_NULL;
536 symbols->coff_symno += 1 + syment.n_numaux;
538 switch (syment.n_sclass)
541 if (count + 1 >= alloc)
544 names = ((const char **)
545 xrealloc (names, alloc * sizeof *names));
546 vals = ((bfd_signed_vma *)
547 xrealloc (vals, alloc * sizeof *vals));
550 names[count] = bfd_asymbol_name (sym);
551 vals[count] = bfd_asymbol_value (sym);
563 return debug_make_enum_type (dhandle, names, vals);
566 /* Handle a single COFF symbol. */
569 parse_coff_symbol (abfd, types, sym, coff_symno, psyment, dhandle, type,
571 bfd *abfd ATTRIBUTE_UNUSED;
572 struct coff_types *types;
575 struct internal_syment *psyment;
578 boolean within_function;
580 switch (psyment->n_sclass)
586 if (! debug_record_variable (dhandle, bfd_asymbol_name (sym), type,
587 DEBUG_LOCAL, bfd_asymbol_value (sym)))
593 if (! debug_record_variable (dhandle, bfd_asymbol_name (sym), type,
594 DEBUG_GLOBAL, bfd_asymbol_value (sym)))
599 if (! debug_record_variable (dhandle, bfd_asymbol_name (sym), type,
603 bfd_asymbol_value (sym)))
608 /* FIXME: We may need to convert the register number. */
609 if (! debug_record_variable (dhandle, bfd_asymbol_name (sym), type,
610 DEBUG_REGISTER, bfd_asymbol_value (sym)))
618 if (! debug_record_parameter (dhandle, bfd_asymbol_name (sym), type,
619 DEBUG_PARM_STACK, bfd_asymbol_value (sym)))
624 /* FIXME: We may need to convert the register number. */
625 if (! debug_record_parameter (dhandle, bfd_asymbol_name (sym), type,
626 DEBUG_PARM_REG, bfd_asymbol_value (sym)))
631 type = debug_name_type (dhandle, bfd_asymbol_name (sym), type);
632 if (type == DEBUG_TYPE_NULL)
642 type = debug_tag_type (dhandle, bfd_asymbol_name (sym), type);
643 if (type == DEBUG_TYPE_NULL)
646 /* Store the named type into the slot, so that references get
648 slot = coff_get_slot (types, coff_symno);
660 /* Determine if a symbol has external visibility. */
663 external_coff_symbol_p (sym_class)
677 /* This is the main routine. It looks through all the symbols and
681 parse_coff (abfd, syms, symcount, dhandle)
687 struct coff_symbols symbols;
688 struct coff_types types;
696 boolean within_function;
697 long this_coff_symno;
700 symbols.symcount = symcount;
702 symbols.coff_symno = 0;
705 for (i = 0; i <= T_MAX; i++)
706 types.basic[i] = DEBUG_TYPE_NULL;
714 within_function = false;
716 while (symbols.symno < symcount)
720 struct internal_syment syment;
721 union internal_auxent auxent;
722 union internal_auxent *paux;
725 sym = syms[symbols.symno];
727 if (! bfd_coff_get_syment (abfd, sym, &syment))
729 non_fatal (_("bfd_coff_get_syment failed: %s"),
730 bfd_errmsg (bfd_get_error ()));
734 name = bfd_asymbol_name (sym);
736 this_coff_symno = symbols.coff_symno;
739 symbols.coff_symno += 1 + syment.n_numaux;
741 /* We only worry about the first auxent, because that is the
742 only one which is relevant for debugging information. */
743 if (syment.n_numaux == 0)
747 if (! bfd_coff_get_auxent (abfd, sym, 0, &auxent))
749 non_fatal (_("bfd_coff_get_auxent failed: %s"),
750 bfd_errmsg (bfd_get_error ()));
756 if (this_coff_symno == next_c_file && syment.n_sclass != C_FILE)
758 /* The last C_FILE symbol points to the first external
760 if (! debug_set_filename (dhandle, "*globals*"))
764 switch (syment.n_sclass)
773 /* Just ignore these classes. */
777 next_c_file = syment.n_value;
778 if (! debug_set_filename (dhandle, name))
783 /* Ignore static symbols with a type of T_NULL. These
784 represent section entries. */
785 if (syment.n_type == T_NULL)
790 if (ISFCN (syment.n_type))
793 fnclass = syment.n_sclass;
794 fntype = syment.n_type;
795 if (syment.n_numaux > 0)
796 fnend = bfd_asymbol_value (sym) + auxent.x_sym.x_misc.x_fsize;
799 linenos = BFD_SEND (abfd, _get_lineno, (abfd, sym));
802 type = parse_coff_type (abfd, &symbols, &types, this_coff_symno,
803 syment.n_type, paux, true, dhandle);
804 if (type == DEBUG_TYPE_NULL)
806 if (! parse_coff_symbol (abfd, &types, sym, this_coff_symno, &syment,
807 dhandle, type, within_function))
812 if (strcmp (name, ".bf") == 0)
816 non_fatal (_("%ld: .bf without preceding function"),
821 type = parse_coff_type (abfd, &symbols, &types, this_coff_symno,
822 DECREF (fntype), paux, false, dhandle);
823 if (type == DEBUG_TYPE_NULL)
826 if (! debug_record_function (dhandle, fnname, type,
827 external_coff_symbol_p (fnclass),
828 bfd_asymbol_value (sym)))
836 if (syment.n_numaux == 0)
839 base = auxent.x_sym.x_misc.x_lnsz.x_lnno - 1;
841 addr = bfd_get_section_vma (abfd, bfd_get_section (sym));
845 while (linenos->line_number != 0)
847 if (! debug_record_line (dhandle,
848 linenos->line_number + base,
849 linenos->u.offset + addr))
860 within_function = true;
862 else if (strcmp (name, ".ef") == 0)
864 if (! within_function)
866 non_fatal (_("%ld: unexpected .ef\n"), this_coff_symno);
870 if (bfd_asymbol_value (sym) > fnend)
871 fnend = bfd_asymbol_value (sym);
872 if (! debug_end_function (dhandle, fnend))
876 within_function = false;
881 if (strcmp (name, ".bb") == 0)
883 if (! debug_start_block (dhandle, bfd_asymbol_value (sym)))
886 else if (strcmp (name, ".eb") == 0)
888 if (! debug_end_block (dhandle, bfd_asymbol_value (sym)))
894 type = parse_coff_type (abfd, &symbols, &types, this_coff_symno,
895 syment.n_type, paux, true, dhandle);
896 if (type == DEBUG_TYPE_NULL)
898 if (! parse_coff_symbol (abfd, &types, sym, this_coff_symno, &syment,
899 dhandle, type, within_function))