2 Copyright (C) 1994-2023 Free Software Foundation, Inc.
4 This file is part of GNU Binutils.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston,
19 MA 02110-1301, USA. */
22 /* Written by Steve Chamberlain (sac@cygnus.com)
24 This module reads a coff file and builds a really simple type tree
25 which can be read by other programs. The first application is a
26 coff->sysroff converter. It can be tested with coffdump.c. */
30 #include "libiberty.h"
31 #include "coff/internal.h"
32 #include "../bfd/libcoff.h"
36 static int lofile
= 1;
38 static struct coff_scope
* top_scope
;
39 static struct coff_scope
* file_scope
;
40 static struct coff_ofile
* ofile
;
41 static struct coff_symbol
* last_function_symbol
;
42 static struct coff_type
* last_function_type
;
43 static struct coff_type
* last_struct
;
44 static struct coff_type
* last_enum
;
45 static struct coff_sfile
* cur_sfile
;
46 static struct coff_symbol
** tindex
;
47 static asymbol
** syms
;
49 static struct coff_ptr_struct
* rawsyms
;
50 static unsigned int rawcount
;
53 #define N(x) ((x)->_n._n_nptr[1])
62 #define INDEXOF(p) ((struct coff_ptr_struct *)(p)-(rawsyms))
65 static struct coff_scope
*
68 return (struct coff_scope
*) (xcalloc (sizeof (struct coff_scope
), 1));
71 static struct coff_symbol
*
74 return (struct coff_symbol
*) (xcalloc (sizeof (struct coff_symbol
), 1));
78 push_scope (int slink
)
80 struct coff_scope
*n
= empty_scope ();
86 if (top_scope
->list_tail
)
88 top_scope
->list_tail
->next
= n
;
92 top_scope
->list_head
= n
;
94 top_scope
->list_tail
= n
;
97 n
->parent
= top_scope
;
105 /* PR 17512: file: 809933ac. */
106 if (top_scope
== NULL
)
107 fatal (_("Out of context scope change encountered"));
108 top_scope
= top_scope
->parent
;
112 do_sections_p1 (struct coff_ofile
*head
)
116 struct coff_section
*all
= (struct coff_section
*) (xcalloc (abfd
->section_count
+ 1,
117 sizeof (struct coff_section
)));
118 head
->nsections
= abfd
->section_count
+ 1;
119 head
->sections
= all
;
121 for (idx
= 0, section
= abfd
->sections
; section
; section
= section
->next
, idx
++)
124 unsigned int i
= section
->target_index
;
128 /* PR 17512: file: 2d6effca. */
129 if (i
> abfd
->section_count
)
130 fatal (_("Invalid section target index: %u"), i
);
132 relsize
= bfd_get_reloc_upper_bound (abfd
, section
);
134 bfd_fatal (bfd_get_filename (abfd
));
137 relpp
= (arelent
**) xmalloc (relsize
);
138 relcount
= bfd_canonicalize_reloc (abfd
, section
, relpp
, syms
);
140 bfd_fatal (bfd_get_filename (abfd
));
142 head
->sections
[i
].name
= (char *) (section
->name
);
143 head
->sections
[i
].code
= section
->flags
& SEC_CODE
;
144 head
->sections
[i
].data
= section
->flags
& SEC_DATA
;
145 if (strcmp (section
->name
, ".bss") == 0)
146 head
->sections
[i
].data
= 1;
147 head
->sections
[i
].address
= section
->lma
;
148 head
->sections
[i
].size
= bfd_section_size (section
);
149 head
->sections
[i
].number
= idx
;
150 head
->sections
[i
].nrelocs
= section
->reloc_count
;
151 head
->sections
[i
].relocs
=
152 (struct coff_reloc
*) (xcalloc (section
->reloc_count
,
153 sizeof (struct coff_reloc
)));
154 head
->sections
[i
].bfd_section
= section
;
156 head
->sections
[0].name
= "ABSOLUTE";
157 head
->sections
[0].code
= 0;
158 head
->sections
[0].data
= 0;
159 head
->sections
[0].address
= 0;
160 head
->sections
[0].size
= 0;
161 head
->sections
[0].number
= 0;
165 do_sections_p2 (struct coff_ofile
*head
)
169 for (section
= abfd
->sections
; section
; section
= section
->next
)
173 /* PR 17512: file: 7c1a36e8.
174 A corrupt COFF binary might have a reloc count but no relocs.
176 if (section
->relocation
== NULL
)
179 for (j
= 0; j
< section
->reloc_count
; j
++)
182 int i
= section
->target_index
;
183 struct coff_reloc
*r
;
184 arelent
*sr
= section
->relocation
+ j
;
186 if (i
> head
->nsections
)
187 fatal (_("Invalid section target index: %d"), i
);
188 /* PR 17512: file: db850ff4. */
189 if (j
>= head
->sections
[i
].nrelocs
)
190 fatal (_("Target section has insufficient relocs"));
191 r
= head
->sections
[i
].relocs
+ j
;
192 r
->offset
= sr
->address
;
193 r
->addend
= sr
->addend
;
194 idx
= ((coff_symbol_type
*) (sr
->sym_ptr_ptr
[0]))->native
- rawsyms
;
198 fatal (_("Symbol index %u encountered when there are no symbols"), idx
);
199 non_fatal (_("Invalid symbol index %u encountered"), idx
);
202 r
->symbol
= tindex
[idx
];
207 static struct coff_where
*
208 do_where (unsigned int i
)
210 struct internal_syment
*sym
;
211 struct coff_where
*where
=
212 (struct coff_where
*) (xmalloc (sizeof (struct coff_where
)));
215 fatal ("Invalid symbol index: %d\n", i
);
217 sym
= &rawsyms
[i
].u
.syment
;
218 where
->offset
= sym
->n_value
;
220 if (sym
->n_scnum
== -1)
223 switch (sym
->n_sclass
)
226 where
->where
= coff_where_member_of_struct
;
227 where
->offset
= sym
->n_value
/ 8;
228 where
->bitoffset
= sym
->n_value
% 8;
229 where
->bitsize
= rawsyms
[i
+ 1].u
.auxent
.x_sym
.x_misc
.x_lnsz
.x_size
;
232 where
->where
= coff_where_member_of_enum
;
236 where
->where
= coff_where_member_of_struct
;
240 where
->where
= coff_where_stack
;
246 where
->where
= coff_where_memory
;
247 /* PR 17512: file: 07a37c40. */
248 /* PR 17512: file: 0c2eb101. */
249 if (sym
->n_scnum
>= ofile
->nsections
|| sym
->n_scnum
< 0)
251 non_fatal (_("Invalid section number (%d) encountered"),
253 where
->section
= ofile
->sections
;
256 where
->section
= &ofile
->sections
[sym
->n_scnum
];
260 where
->where
= coff_where_register
;
263 where
->where
= coff_where_entag
;
267 where
->where
= coff_where_strtag
;
270 where
->where
= coff_where_typedef
;
273 fatal (_("Unrecognized symbol class: %d"), sym
->n_sclass
);
279 static struct coff_line
*
280 do_lines (int i
, char *name ATTRIBUTE_UNUSED
)
282 struct coff_line
*res
= (struct coff_line
*) xcalloc (sizeof (struct coff_line
), 1);
286 /* Find out if this function has any line numbers in the table. */
287 for (s
= abfd
->sections
; s
; s
= s
->next
)
289 /* PR 17512: file: 07a37c40.
290 A corrupt COFF binary can have a linenumber count in the header
291 but no line number table. This should be reported elsewhere, but
292 do not rely upon this. */
293 if (s
->lineno
== NULL
)
296 for (l
= 0; l
< s
->lineno_count
; l
++)
298 if (s
->lineno
[l
].line_number
== 0)
300 if (rawsyms
+ i
== ((coff_symbol_type
*) (&(s
->lineno
[l
].u
.sym
[0])))->native
)
302 /* These lines are for this function - so count them and stick them on. */
304 /* Find the linenumber of the top of the function, since coff linenumbers
305 are relative to the start of the function. */
306 int start_line
= rawsyms
[i
+ 3].u
.auxent
.x_sym
.x_misc
.x_lnsz
.x_lnno
;
310 /* PR 17512: file: c2825452. */
311 l
+ c
+ 1 < s
->lineno_count
312 && s
->lineno
[l
+ c
+ 1].line_number
;
316 /* Add two extra records, one for the prologue and one for the epilogue. */
319 res
->lines
= (int *) (xcalloc (sizeof (int), c
));
320 res
->addresses
= (int *) (xcalloc (sizeof (int), c
));
321 res
->lines
[0] = start_line
;
322 res
->addresses
[0] = rawsyms
[i
].u
.syment
.n_value
- s
->vma
;
324 /* PR 17512: file: c2825452. */
325 l
+ c
+ 1 < s
->lineno_count
326 && s
->lineno
[l
+ c
+ 1].line_number
;
329 res
->lines
[c
+ 1] = s
->lineno
[l
+ c
].line_number
+ start_line
- 1;
330 res
->addresses
[c
+ 1] = s
->lineno
[l
+ c
].u
.offset
;
340 static struct coff_type
*
341 do_type (unsigned int i
)
343 struct internal_syment
*sym
;
344 combined_entry_type
*aux
;
345 struct coff_type
*res
= (struct coff_type
*) xmalloc (sizeof (struct coff_type
));
351 fatal (_("Type entry %u does not have enough symbolic information"), i
);
353 if (!rawsyms
[i
].is_sym
)
354 fatal (_("Type entry %u does not refer to a symbol"), i
);
355 sym
= &rawsyms
[i
].u
.syment
;
357 if (sym
->n_numaux
== 0 || i
>= rawcount
-1 || rawsyms
[i
+ 1].is_sym
)
360 aux
= &rawsyms
[i
+ 1];
364 res
->type
= coff_basic_type
;
365 res
->u
.basic
= type
& 0xf;
371 if (sym
->n_numaux
&& sym
->n_sclass
== C_STAT
)
373 /* This is probably a section definition. */
374 res
->type
= coff_secdef_type
;
376 fatal (_("Section definition needs a section length"));
377 res
->size
= aux
->u
.auxent
.x_scn
.x_scnlen
;
379 /* PR 17512: file: 081c955d.
380 Fill in the asecdef structure as well. */
381 res
->u
.asecdef
.address
= 0;
382 res
->u
.asecdef
.size
= 0;
388 /* Don't know what this is, let's make it a simple int. */
389 res
->size
= INT_SIZE
;
390 res
->u
.basic
= T_UINT
;
394 /* Else it could be a function or pointer to void. */
406 res
->size
= SHORT_SIZE
;
410 res
->size
= INT_SIZE
;
414 res
->size
= LONG_SIZE
;
417 res
->size
= FLOAT_SIZE
;
420 res
->size
= DOUBLE_SIZE
;
427 fatal (_("Aggregate definition needs auxiliary information"));
431 unsigned int idx
= INDEXOF (aux
->u
.auxent
.x_sym
.x_tagndx
.p
);
433 /* Referring to a struct defined elsewhere. */
434 res
->type
= coff_structref_type
;
435 res
->u
.astructref
.ref
= tindex
[idx
];
436 res
->size
= res
->u
.astructref
.ref
?
437 res
->u
.astructref
.ref
->type
->size
: 0;
441 /* A definition of a struct. */
443 res
->type
= coff_structdef_type
;
444 res
->u
.astructdef
.elements
= empty_scope ();
445 res
->u
.astructdef
.idx
= 0;
446 res
->u
.astructdef
.isstruct
= (type
& 0xf) == T_STRUCT
;
447 res
->size
= aux
->u
.auxent
.x_sym
.x_misc
.x_lnsz
.x_size
;
452 /* No auxents - it's anonymous. */
453 res
->type
= coff_structref_type
;
454 res
->u
.astructref
.ref
= 0;
460 fatal (_("Enum definition needs auxiliary information"));
463 unsigned int idx
= INDEXOF (aux
->u
.auxent
.x_sym
.x_tagndx
.p
);
465 /* Referring to a enum defined elsewhere. */
466 res
->type
= coff_enumref_type
;
467 res
->u
.aenumref
.ref
= tindex
[idx
];
468 /* PR 17512: file: b85b67e8. */
469 if (res
->u
.aenumref
.ref
)
470 res
->size
= res
->u
.aenumref
.ref
->type
->size
;
476 /* A definition of an enum. */
478 res
->type
= coff_enumdef_type
;
479 res
->u
.aenumdef
.elements
= empty_scope ();
480 res
->size
= aux
->u
.auxent
.x_sym
.x_misc
.x_lnsz
.x_size
;
487 for (which_dt
= 5; which_dt
>= 0; which_dt
--)
489 switch ((type
>> ((which_dt
* 2) + 4)) & 0x3)
495 struct coff_type
*ptr
= ((struct coff_type
*)
496 xmalloc (sizeof (struct coff_type
)));
500 fatal (_("Array definition needs auxiliary information"));
501 els
= (dimind
< DIMNUM
502 ? aux
->u
.auxent
.x_sym
.x_fcnary
.x_ary
.x_dimen
[dimind
]
506 ptr
->type
= coff_array_type
;
507 /* PR 17512: file: ae1971e2.
508 Check for integer overflow. */
516 non_fatal (_("Out of range sum for els (%#x) * size (%#x)"), els
, res
->size
);
518 ptr
->u
.array
.dim
= els
;
519 ptr
->u
.array
.array_of
= res
;
525 struct coff_type
*ptr
=
526 (struct coff_type
*) xmalloc (sizeof (struct coff_type
));
528 ptr
->size
= PTR_SIZE
;
529 ptr
->type
= coff_pointer_type
;
530 ptr
->u
.pointer
.points_to
= res
;
536 struct coff_type
*ptr
537 = (struct coff_type
*) xmalloc (sizeof (struct coff_type
));
540 ptr
->type
= coff_function_type
;
541 ptr
->u
.function
.function_returns
= res
;
542 ptr
->u
.function
.parameters
= empty_scope ();
543 ptr
->u
.function
.lines
= do_lines (i
, N(sym
));
544 ptr
->u
.function
.code
= 0;
545 last_function_type
= ptr
;
554 static struct coff_visible
*
557 struct internal_syment
*sym
= &rawsyms
[i
].u
.syment
;
558 struct coff_visible
*visible
=
559 (struct coff_visible
*) (xmalloc (sizeof (struct coff_visible
)));
560 enum coff_vis_type t
;
562 switch (sym
->n_sclass
)
567 t
= coff_vis_member_of_struct
;
570 t
= coff_vis_member_of_enum
;
573 t
= coff_vis_regparam
;
576 t
= coff_vis_register
;
586 t
= coff_vis_autoparam
;
593 t
= coff_vis_int_def
;
596 if (sym
->n_scnum
== N_UNDEF
)
601 t
= coff_vis_ext_ref
;
604 t
= coff_vis_ext_def
;
607 fatal (_("Unrecognised symbol class: %d"), sym
->n_sclass
);
614 /* Define a symbol and attach to block B. */
617 do_define (unsigned int i
, struct coff_scope
*b
)
619 static int symbol_index
;
620 struct internal_syment
*sym
;
621 struct coff_symbol
*s
= empty_symbol ();
624 fatal (_("ICE: do_define called without a block"));
626 fatal (_("Out of range symbol index: %u"), i
);
628 sym
= &rawsyms
[i
].u
.syment
;
629 s
->number
= ++symbol_index
;
631 s
->sfile
= cur_sfile
;
632 /* Glue onto the ofile list. */
635 if (ofile
->symbol_list_tail
)
636 ofile
->symbol_list_tail
->next_in_ofile_list
= s
;
638 ofile
->symbol_list_head
= s
;
639 ofile
->symbol_list_tail
= s
;
640 /* And the block list. */
643 b
->vars_tail
->next
= s
;
649 s
->type
= do_type (i
);
650 s
->where
= do_where (i
);
651 s
->visible
= do_visible (i
);
655 /* We remember the lowest address in each section for each source file. */
656 if (s
->where
->where
== coff_where_memory
657 && s
->type
->type
== coff_secdef_type
)
659 struct coff_isection
*is
;
661 /* PR 17512: file: 4676c97f. */
662 if (cur_sfile
== NULL
)
663 non_fatal (_("Section referenced before any file is defined"));
666 is
= cur_sfile
->section
+ s
->where
->section
->number
;
670 is
->low
= s
->where
->offset
;
671 /* PR 17512: file: 37e7a80d.
672 Check for integer overflow computing low + size. */
676 a
= s
->where
->offset
;
681 non_fatal (_("Out of range sum for offset (%#x) + size (%#x)"),
682 is
->low
, s
->type
->size
);
684 /* PR 17512: file: 37e7a80d. */
685 if (is
->high
< s
->where
->offset
)
686 fatal (_("Out of range type size: %u"), s
->type
->size
);
688 is
->parent
= s
->where
->section
;
693 if (s
->type
->type
== coff_function_type
)
694 last_function_symbol
= s
;
696 return i
+ sym
->n_numaux
+ 1;
699 static struct coff_ofile
*
704 struct coff_ofile
*head
=
705 (struct coff_ofile
*) xmalloc (sizeof (struct coff_ofile
));
708 head
->source_head
= 0;
709 head
->source_tail
= 0;
711 head
->symbol_list_tail
= 0;
712 head
->symbol_list_head
= 0;
713 do_sections_p1 (head
);
716 for (i
= 0; i
< rawcount
;)
718 struct internal_syment
*sym
= &rawsyms
[i
].u
.syment
;
720 switch (sym
->n_sclass
)
724 /* New source file announced. */
725 struct coff_sfile
*n
=
726 (struct coff_sfile
*) xmalloc (sizeof (struct coff_sfile
));
728 n
->section
= (struct coff_isection
*) xcalloc (sizeof (struct coff_isection
), abfd
->section_count
+ 1);
739 file_scope
= n
->scope
= top_scope
;
741 if (head
->source_tail
)
742 head
->source_tail
->next
= n
;
744 head
->source_head
= n
;
745 head
->source_tail
= n
;
747 i
+= sym
->n_numaux
+ 1;
756 /* Function start. */
758 /* PR 17512: file: 0ef7fbaf. */
759 if (last_function_type
)
760 last_function_type
->u
.function
.code
= top_scope
;
761 /* PR 17512: file: 22908266. */
762 if (sym
->n_scnum
< ofile
->nsections
&& sym
->n_scnum
>= 0)
763 top_scope
->sec
= ofile
->sections
+ sym
->n_scnum
;
765 top_scope
->sec
= NULL
;
766 top_scope
->offset
= sym
->n_value
;
770 /* PR 17512: file: e92e42e1. */
771 if (top_scope
== NULL
)
772 fatal (_("Function start encountered without a top level scope."));
773 top_scope
->size
= sym
->n_value
- top_scope
->offset
+ 1;
776 i
+= sym
->n_numaux
+ 1;
788 /* PR 17512: file: af7e8e83. */
789 if (sym
->n_scnum
< ofile
->nsections
&& sym
->n_scnum
>= 0)
790 top_scope
->sec
= ofile
->sections
+ sym
->n_scnum
;
792 top_scope
->sec
= NULL
;
793 top_scope
->offset
= sym
->n_value
;
797 if (top_scope
== NULL
)
798 fatal (_("Block start encountered without a scope for it."));
799 top_scope
->size
= sym
->n_value
- top_scope
->offset
+ 1;
802 i
+= sym
->n_numaux
+ 1;
807 if (last_function_symbol
== NULL
)
808 fatal (_("Function arguments encountered without a function definition"));
809 i
= do_define (i
, last_function_symbol
->type
->u
.function
.parameters
);
814 /* PR 17512: file: 43ab21f4. */
815 if (last_struct
== NULL
)
816 fatal (_("Structure element encountered without a structure definition"));
817 i
= do_define (i
, last_struct
->u
.astructdef
.elements
);
820 if (last_enum
== NULL
)
821 fatal (_("Enum element encountered without an enum definition"));
822 i
= do_define (i
, last_enum
->u
.aenumdef
.elements
);
827 /* Various definition. */
828 if (top_scope
== NULL
)
829 fatal (_("Aggregate definition encountered without a scope"));
830 i
= do_define (i
, top_scope
);
834 if (file_scope
== NULL
)
835 fatal (_("Label definition encountered without a file scope"));
836 i
= do_define (i
, file_scope
);
842 if (top_scope
== NULL
)
843 fatal (_("Variable definition encountered without a scope"));
844 i
= do_define (i
, top_scope
);
847 i
+= sym
->n_numaux
+ 1;
850 fatal (_("Unrecognised symbol class: %d"), sym
->n_sclass
);
853 do_sections_p2 (head
);
858 coff_grok (bfd
*inabfd
)
861 struct coff_ofile
*p
;
864 if (! bfd_family_coff (abfd
))
866 non_fatal (_("%s: is not a COFF format file"), bfd_get_filename (abfd
));
870 storage
= bfd_get_symtab_upper_bound (abfd
);
873 bfd_fatal (bfd_get_filename (abfd
));
875 syms
= (asymbol
**) xmalloc (storage
);
876 symcount
= bfd_canonicalize_symtab (abfd
, syms
);
878 bfd_fatal (bfd_get_filename (abfd
));
879 rawsyms
= obj_raw_syments (abfd
);
880 rawcount
= obj_raw_syment_count (abfd
);
881 tindex
= (struct coff_symbol
**) (xcalloc (sizeof (struct coff_symbol
*), rawcount
));