/* BFD back-end data structures for a.out (and similar) files. Copyright (C) 1990-2024 Free Software Foundation, Inc. Written by Cygnus Support. This file is part of BFD, the Binary File Descriptor library. This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA. */ #ifndef LIBAOUT_H #define LIBAOUT_H /* We try to encapsulate the differences in the various a.out file variants in a few routines, and otherwise share large masses of code. This means we only have to fix bugs in one place, most of the time. */ #include "bfdlink.h" /* Macros for accessing components in an aout header. */ #define H_PUT_64 bfd_h_put_64 #define H_PUT_32 bfd_h_put_32 #define H_PUT_16 bfd_h_put_16 #define H_PUT_8 bfd_h_put_8 #define H_PUT_S64 bfd_h_put_signed_64 #define H_PUT_S32 bfd_h_put_signed_32 #define H_PUT_S16 bfd_h_put_signed_16 #define H_PUT_S8 bfd_h_put_signed_8 #define H_GET_64 bfd_h_get_64 #define H_GET_32 bfd_h_get_32 #define H_GET_16 bfd_h_get_16 #define H_GET_8 bfd_h_get_8 #define H_GET_S64 bfd_h_get_signed_64 #define H_GET_S32 bfd_h_get_signed_32 #define H_GET_S16 bfd_h_get_signed_16 #define H_GET_S8 bfd_h_get_signed_8 /* Parameterize the a.out code based on whether it is being built for a 32-bit architecture or a 64-bit architecture. */ /* Do not "beautify" the CONCAT* macro args. Traditional C will not remove whitespace added here, and thus will fail to concatenate the tokens. */ #if ARCH_SIZE==64 #define GET_WORD H_GET_64 #define GET_SWORD H_GET_S64 #define GET_MAGIC H_GET_32 #define PUT_WORD H_PUT_64 #define PUT_MAGIC H_PUT_32 #ifndef NAME #define NAME(x,y) CONCAT3 (x,_64_,y) #endif #define JNAME(x) CONCAT2 (x,_64) #define BYTES_IN_WORD 8 #else #if ARCH_SIZE==16 #define GET_WORD H_GET_16 #define GET_SWORD H_GET_S16 #define GET_MAGIC H_GET_16 #define PUT_WORD H_PUT_16 #define PUT_MAGIC H_PUT_16 #ifndef NAME #define NAME(x,y) CONCAT3 (x,_16_,y) #endif #define JNAME(x) CONCAT2 (x,_16) #define BYTES_IN_WORD 2 #else /* ARCH_SIZE == 32 */ #define GET_WORD H_GET_32 #define GET_SWORD H_GET_S32 #define GET_MAGIC H_GET_32 #define PUT_WORD H_PUT_32 #define PUT_MAGIC H_PUT_32 #ifndef NAME #define NAME(x,y) CONCAT3 (x,_32_,y) #endif #define JNAME(x) CONCAT2 (x,_32) #define BYTES_IN_WORD 4 #endif /* ARCH_SIZE==32 */ #endif /* ARCH_SIZE==64 */ /* Declare at file level, since used in parameter lists, which have weird scope. */ struct external_exec; struct external_nlist; struct reloc_ext_external; struct reloc_std_external; /* a.out backend linker hash table entries. */ struct aout_link_hash_entry { struct bfd_link_hash_entry root; /* Whether this symbol has been written out. */ bool written; /* Symbol index in output file. */ int indx; }; /* a.out backend linker hash table. */ struct aout_link_hash_table { struct bfd_link_hash_table root; }; /* Look up an entry in an a.out link hash table. */ #define aout_link_hash_lookup(table, string, create, copy, follow) \ ((struct aout_link_hash_entry *) \ bfd_link_hash_lookup (&(table)->root, (string), (create), (copy), (follow))) /* Traverse an a.out link hash table. */ #define aout_link_hash_traverse(table, func, info) \ (bfd_link_hash_traverse \ (&(table)->root, \ (bool (*) (struct bfd_link_hash_entry *, void *)) (func), \ (info))) /* Get the a.out link hash table from the info structure. This is just a cast. */ #define aout_hash_table(p) ((struct aout_link_hash_table *) ((p)->hash)) /* Back-end information for various a.out targets. */ struct aout_backend_data { /* Are ZMAGIC files mapped contiguously? If so, the text section may need more padding, if the segment size (granularity for memory access control) is larger than the page size. */ unsigned char zmagic_mapped_contiguous; /* If this flag is set, ZMAGIC/NMAGIC file headers get mapped in with the text section, which starts immediately after the file header. If not, the text section starts on the next page. */ unsigned char text_includes_header; /* If this flag is set, then if the entry address is not in the first SEGMENT_SIZE bytes of the text section, it is taken to be the address of the start of the text section. This can be useful for kernels. */ unsigned char entry_is_text_address; /* The value to pass to N_SET_FLAGS. */ unsigned char exec_hdr_flags; /* If the text section VMA isn't specified, and we need an absolute address, use this as the default. If we're producing a relocatable file, zero is always used. */ /* ?? Perhaps a callback would be a better choice? Will this do anything reasonable for a format that handles multiple CPUs with different load addresses for each? */ bfd_vma default_text_vma; /* Callback for setting the page and segment sizes, if they can't be trivially determined from the architecture. */ bool (*set_sizes) (bfd *); /* zmagic files only. For go32, the length of the exec header contributes to the size of the text section in the file for alignment purposes but does *not* get counted in the length of the text section. */ unsigned char exec_header_not_counted; /* Callback from the add symbols phase of the linker code to handle a dynamic object. */ bool (*add_dynamic_symbols) (bfd *, struct bfd_link_info *, struct external_nlist **, bfd_size_type *, char **); /* Callback from the add symbols phase of the linker code to handle adding a single symbol to the global linker hash table. */ bool (*add_one_symbol) (struct bfd_link_info *, bfd *, const char *, flagword, asection *, bfd_vma, const char *, bool, bool, struct bfd_link_hash_entry **); /* Called to handle linking a dynamic object. */ bool (*link_dynamic_object) (struct bfd_link_info *, bfd *); /* Called for each global symbol being written out by the linker. This should write out the dynamic symbol information. */ bool (*write_dynamic_symbol) (bfd *, struct bfd_link_info *, struct aout_link_hash_entry *); /* If this callback is not NULL, the linker calls it for each reloc. RELOC is a pointer to the unswapped reloc. If *SKIP is set to TRUE, the reloc will be skipped. *RELOCATION may be changed to change the effects of the relocation. */ bool (*check_dynamic_reloc) (struct bfd_link_info *info, bfd *input_bfd, asection *input_section, struct aout_link_hash_entry *h, void * reloc, bfd_byte *contents, bool *skip, bfd_vma *relocation); /* Called at the end of a link to finish up any dynamic linking information. */ bool (*finish_dynamic_link) (bfd *, struct bfd_link_info *); }; #define aout_backend_info(abfd) \ ((const struct aout_backend_data *)((abfd)->xvec->backend_data)) /* This is the layout in memory of a "struct exec" while we process it. All 'lengths' are given as a number of bytes. All 'alignments' are for relinkable files only; an alignment of 'n' indicates the corresponding segment must begin at an address that is a multiple of (2**n). */ struct internal_exec { long a_info; /* Magic number and flags, packed. */ bfd_vma a_text; /* Length of text, in bytes. */ bfd_vma a_data; /* Length of data, in bytes. */ bfd_vma a_bss; /* Length of uninitialized data area in mem. */ bfd_vma a_syms; /* Length of symbol table data in file. */ bfd_vma a_entry; /* Start address. */ bfd_vma a_trsize; /* Length of text's relocation info, in bytes. */ bfd_vma a_drsize; /* Length of data's relocation info, in bytes. */ /* Added for i960 */ bfd_vma a_tload; /* Text runtime load address. */ bfd_vma a_dload; /* Data runtime load address. */ unsigned char a_talign; /* Alignment of text segment. */ unsigned char a_dalign; /* Alignment of data segment. */ unsigned char a_balign; /* Alignment of bss segment. */ char a_relaxable; /* Enough info for linker relax. */ }; /* Magic number is written < MSB > 3130292827262524232221201918171615141312111009080706050403020100 < FLAGS >< MACHINE TYPE >< MAGIC NUMBER > */ /* Magic number for NetBSD is 3130292827262524232221201918171615141312111009080706050403020100 < FLAGS >< MACHINE TYPE >< MAGIC NUMBER > */ enum machine_type { M_UNKNOWN = 0, M_68010 = 1, M_68020 = 2, M_SPARC = 3, /* Skip a bunch so we don't run into any of SUN's numbers. */ /* Make these up for the ns32k. */ M_NS32032 = (64), /* NS32032 running ? */ M_NS32532 = (64 + 5), /* NS32532 running mach. */ M_386 = 100, M_29K = 101, /* AMD 29000. */ M_386_DYNIX = 102, /* Sequent running dynix. */ M_ARM = 103, /* Advanced Risc Machines ARM. */ M_SPARCLET = 131, /* SPARClet = M_SPARC + 128. */ M_386_NETBSD = 134, /* NetBSD/i386 binary. */ M_68K_NETBSD = 135, /* NetBSD/m68k binary. */ M_68K4K_NETBSD = 136, /* NetBSD/m68k4k binary. */ M_532_NETBSD = 137, /* NetBSD/ns32k binary. */ M_SPARC_NETBSD = 138, /* NetBSD/sparc binary. */ M_PMAX_NETBSD = 139, /* NetBSD/pmax (MIPS little-endian) binary. */ M_VAX_NETBSD = 140, /* NetBSD/vax binary. */ M_ALPHA_NETBSD = 141, /* NetBSD/alpha binary. */ M_ARM6_NETBSD = 143, /* NetBSD/arm32 binary. */ M_SPARCLET_1 = 147, /* 0x93, reserved. */ M_POWERPC_NETBSD = 149, /* NetBSD/powerpc (big-endian) binary. */ M_VAX4K_NETBSD = 150, /* NetBSD/vax 4K pages binary. */ M_MIPS1 = 151, /* MIPS R2000/R3000 binary. */ M_MIPS2 = 152, /* MIPS R4000/R6000 binary. */ M_88K_OPENBSD = 153, /* OpenBSD/m88k binary. */ M_HPPA_OPENBSD = 154, /* OpenBSD/hppa binary. */ M_SPARC64_NETBSD = 156, /* NetBSD/sparc64 binary. */ M_X86_64_NETBSD = 157, /* NetBSD/amd64 binary. */ M_SPARCLET_2 = 163, /* 0xa3, reserved. */ M_SPARCLET_3 = 179, /* 0xb3, reserved. */ M_SPARCLET_4 = 195, /* 0xc3, reserved. */ M_HP200 = 200, /* HP 200 (68010) BSD binary. */ M_HP300 = (300 % 256), /* HP 300 (68020+68881) BSD binary. */ M_HPUX = (0x20c % 256), /* HP 200/300 HPUX binary. */ M_SPARCLET_5 = 211, /* 0xd3, reserved. */ M_SPARCLET_6 = 227, /* 0xe3, reserved. */ /*M_SPARCLET_7 = 243 / * 0xf3, reserved. */ M_SPARCLITE_LE = 243, M_CRIS = 255 /* Axis CRIS binary. */ }; #define N_DYNAMIC(execp) ((execp)->a_info & 0x80000000) #ifndef N_MAGIC # define N_MAGIC(execp) ((execp)->a_info & 0xffff) #endif #ifndef N_MACHTYPE # define N_MACHTYPE(execp) ((enum machine_type)(((execp)->a_info >> 16) & 0xff)) #endif #ifndef N_FLAGS # define N_FLAGS(execp) (((execp)->a_info >> 24) & 0xff) #endif #ifndef N_SET_INFO # define N_SET_INFO(execp, magic, type, flags) \ ((execp)->a_info = ((magic) & 0xffff) \ | (((int)(type) & 0xff) << 16) \ | (((flags) & 0xffu) << 24)) #endif #ifndef N_SET_DYNAMIC # define N_SET_DYNAMIC(execp, dynamic) \ ((execp)->a_info = (dynamic) ? (long) ((execp)->a_info | 0x80000000) : \ ((execp)->a_info & 0x7fffffff)) #endif #ifndef N_SET_MAGIC # define N_SET_MAGIC(execp, magic) \ ((execp)->a_info = (((execp)->a_info & 0xffff0000) | ((magic) & 0xffff))) #endif #ifndef N_SET_MACHTYPE # define N_SET_MACHTYPE(execp, machtype) \ ((execp)->a_info = \ ((execp)->a_info & 0xff00ffff) | ((((int) (machtype)) &0xff) << 16)) #endif #ifndef N_SET_FLAGS # define N_SET_FLAGS(execp, flags) \ ((execp)->a_info = \ ((execp)->a_info & 0x00ffffff) | (((flags) & 0xffu) << 24)) #endif typedef struct aout_symbol { asymbol symbol; short desc; char other; unsigned char type; } aout_symbol_type; /* The `tdata' struct for all a.out-like object file formats. Various things depend on this struct being around any time an a.out file is being handled. An example is dbxread.c in GDB. */ enum aout_subformat { default_format = 0, /* Used on HP 9000/300 running HP/UX. */ gnu_encap_format, /* Used on Linux, 386BSD, etc. See include/aout/aout64.h. */ q_magic_format }; enum aout_magic { undecided_magic = 0, z_magic, o_magic, n_magic, i_magic }; struct aoutdata { struct internal_exec *hdr; /* Exec file header. */ aout_symbol_type *symbols; /* Symtab for input bfd. */ /* For ease, we do this. */ asection *textsec; asection *datasec; asection *bsssec; /* We remember these offsets so that after check_file_format, we have no dependencies on the particular format of the exec_hdr. */ file_ptr sym_filepos; file_ptr str_filepos; /* Size of a relocation entry in external form. */ unsigned reloc_entry_size; /* Size of a symbol table entry in external form. */ unsigned symbol_entry_size; /* Page size - needed for alignment of demand paged files. */ unsigned long page_size; /* Segment size - needed for alignment of demand paged files. */ unsigned long segment_size; /* Zmagic disk block size - need to align the start of the text section in ZMAGIC binaries. Normally the same as page_size. */ unsigned long zmagic_disk_block_size; unsigned exec_bytes_size; unsigned vma_adjusted : 1; /* Used when a bfd supports several highly similar formats. */ enum aout_subformat subformat; enum aout_magic magic; /* A buffer for find_nearest_line. */ char *line_buf; /* The external symbol information. */ struct external_nlist *external_syms; bfd_size_type external_sym_count; char *external_strings; bfd_size_type external_string_size; struct aout_link_hash_entry **sym_hashes; /* A pointer for shared library information. */ void * dynamic_info; /* A mapping from local symbols to offsets into the global offset table, used when linking on SunOS. This is indexed by the symbol index. */ bfd_vma *local_got_offsets; }; struct aout_data_struct { struct aoutdata a; struct internal_exec e; }; #define adata(bfd) ((bfd)->tdata.aout_data->a) #define exec_hdr(bfd) (adata (bfd).hdr) #define obj_aout_symbols(bfd) (adata (bfd).symbols) #define obj_textsec(bfd) (adata (bfd).textsec) #define obj_datasec(bfd) (adata (bfd).datasec) #define obj_bsssec(bfd) (adata (bfd).bsssec) #define obj_sym_filepos(bfd) (adata (bfd).sym_filepos) #define obj_str_filepos(bfd) (adata (bfd).str_filepos) #define obj_reloc_entry_size(bfd) (adata (bfd).reloc_entry_size) #define obj_symbol_entry_size(bfd) (adata (bfd).symbol_entry_size) #define obj_aout_subformat(bfd) (adata (bfd).subformat) #define obj_aout_external_syms(bfd) (adata (bfd).external_syms) #define obj_aout_external_sym_count(bfd) (adata (bfd).external_sym_count) #define obj_aout_external_strings(bfd) (adata (bfd).external_strings) #define obj_aout_external_string_size(bfd) (adata (bfd).external_string_size) #define obj_aout_sym_hashes(bfd) (adata (bfd).sym_hashes) #define obj_aout_dynamic_info(bfd) (adata (bfd).dynamic_info) /* We take the address of the first element of an asymbol to ensure that the macro is only ever applied to an asymbol. */ #define aout_symbol(asymbol) ((aout_symbol_type *)(&(asymbol)->the_bfd)) /* Prototype declarations for functions defined in aoutx.h. */ extern bool NAME (aout, squirt_out_relocs) (bfd *, asection *); extern bool NAME (aout, make_sections) (bfd *); extern bfd_cleanup NAME (aout, some_aout_object_p) (bfd *, struct internal_exec *, bfd_cleanup (*) (bfd *)); extern bool NAME (aout, mkobject) (bfd *); extern enum machine_type NAME (aout, machine_type) (enum bfd_architecture, unsigned long, bool *); extern bool NAME (aout, set_arch_mach) (bfd *, enum bfd_architecture, unsigned long); extern bool NAME (aout, new_section_hook) (bfd *, asection *); extern bool NAME (aout, set_section_contents) (bfd *, sec_ptr, const void *, file_ptr, bfd_size_type); extern asymbol * NAME (aout, make_empty_symbol) (bfd *); extern bool NAME (aout, translate_symbol_table) (bfd *, aout_symbol_type *, struct external_nlist *, bfd_size_type, char *, bfd_size_type, bool); extern bool NAME (aout, slurp_symbol_table) (bfd *); extern bool NAME (aout, write_syms) (bfd *); extern void NAME (aout, reclaim_symbol_table) (bfd *); extern long NAME (aout, get_symtab_upper_bound) (bfd *); extern long NAME (aout, canonicalize_symtab) (bfd *, asymbol **); extern void NAME (aout, swap_ext_reloc_in) (bfd *, struct reloc_ext_external *, arelent *, asymbol **, bfd_size_type); extern void NAME (aout, swap_std_reloc_in) (bfd *, struct reloc_std_external *, arelent *, asymbol **, bfd_size_type); extern reloc_howto_type * NAME (aout, reloc_type_lookup) (bfd *, bfd_reloc_code_real_type); extern reloc_howto_type * NAME (aout, reloc_name_lookup) (bfd *, const char *); extern bool NAME (aout, slurp_reloc_table) (bfd *, sec_ptr, asymbol **); extern long NAME (aout, canonicalize_reloc) (bfd *, sec_ptr, arelent **, asymbol **); extern long NAME (aout, get_reloc_upper_bound) (bfd *, sec_ptr); extern void NAME (aout, reclaim_reloc) (bfd *, sec_ptr); extern alent * NAME (aout, get_lineno) (bfd *, asymbol *); extern void NAME (aout, print_symbol) (bfd *, void *, asymbol *, bfd_print_symbol_type); extern void NAME (aout, get_symbol_info) (bfd *, asymbol *, symbol_info *); extern bool NAME (aout, find_nearest_line) (bfd *, asymbol **, asection *, bfd_vma, const char **, const char **, unsigned int *, unsigned int *); extern long NAME (aout, read_minisymbols) (bfd *, bool, void * *, unsigned int *); extern asymbol * NAME (aout, minisymbol_to_symbol) (bfd *, bool, const void *, asymbol *); extern int NAME (aout, sizeof_headers) (bfd *, struct bfd_link_info *); extern bool NAME (aout, adjust_sizes_and_vmas) (bfd *); extern void NAME (aout, swap_exec_header_in) (bfd *, struct external_exec *, struct internal_exec *); extern bool NAME (aout, swap_exec_header_out) (bfd *, struct internal_exec *, struct external_exec *); extern struct bfd_hash_entry * NAME (aout, link_hash_newfunc) (struct bfd_hash_entry *, struct bfd_hash_table *, const char *); extern bool NAME (aout, link_hash_table_init) (struct aout_link_hash_table *, bfd *, struct bfd_hash_entry *(*) (struct bfd_hash_entry *, struct bfd_hash_table *, const char *), unsigned int); extern struct bfd_link_hash_table * NAME (aout, link_hash_table_create) (bfd *); extern bool NAME (aout, link_add_symbols) (bfd *, struct bfd_link_info *); extern bool NAME (aout, final_link) (bfd *, struct bfd_link_info *, void (*) (bfd *, file_ptr *, file_ptr *, file_ptr *)); extern bool NAME (aout, bfd_free_cached_info) (bfd *); #define aout_32_find_inliner_info _bfd_nosymbols_find_inliner_info #if 0 /* Are these needed? */ #define aout_16_find_inliner_info _bfd_nosymbols_find_inliner_info #define aout_64_find_inliner_info _bfd_nosymbols_find_inliner_info #endif /* A.out uses the generic versions of these routines... */ #define aout_16_get_section_contents _bfd_generic_get_section_contents #define aout_32_get_section_contents _bfd_generic_get_section_contents #define aout_64_get_section_contents _bfd_generic_get_section_contents #ifndef aout_32_bfd_is_local_label_name #define aout_32_bfd_is_local_label_name bfd_generic_is_local_label_name #endif #ifndef aout_32_bfd_is_target_special_symbol #define aout_32_bfd_is_target_special_symbol _bfd_bool_bfd_asymbol_false #endif #ifndef WRITE_HEADERS #define WRITE_HEADERS(abfd, execp) \ { \ if (adata(abfd).magic == undecided_magic) \ NAME (aout, adjust_sizes_and_vmas) (abfd); \ \ execp->a_syms = bfd_get_symcount (abfd) * EXTERNAL_NLIST_SIZE; \ execp->a_entry = bfd_get_start_address (abfd); \ \ execp->a_trsize = ((obj_textsec (abfd)->reloc_count) \ * obj_reloc_entry_size (abfd)); \ execp->a_drsize = ((obj_datasec (abfd)->reloc_count) \ * obj_reloc_entry_size (abfd)); \ if (!NAME (aout, swap_exec_header_out) (abfd, execp, &exec_bytes)) \ return false; \ \ if (bfd_seek (abfd, 0, SEEK_SET) != 0 \ || bfd_write (&exec_bytes, EXEC_BYTES_SIZE, \ abfd) != EXEC_BYTES_SIZE) \ return false; \ /* Now write out reloc info, followed by syms and strings. */ \ \ if (bfd_get_outsymbols (abfd) != NULL \ && bfd_get_symcount (abfd) != 0) \ { \ if (bfd_seek (abfd, N_SYMOFF (execp), SEEK_SET) != 0) \ return false; \ \ if (! NAME (aout, write_syms) (abfd)) \ return false; \ } \ \ if (bfd_seek (abfd, N_TRELOFF (execp), SEEK_SET) != 0) \ return false; \ if (!NAME (aout, squirt_out_relocs) (abfd, obj_textsec (abfd))) \ return false; \ \ if (bfd_seek (abfd, N_DRELOFF (execp), SEEK_SET) != 0) \ return false; \ if (!NAME (aout, squirt_out_relocs) (abfd, obj_datasec (abfd))) \ return false; \ } #endif /* Test if a read-only section can be merged with .text. This is possible if: 1. Section has file contents and is read-only. 2. The VMA of the section is after the end of .text and before the start of .data. 3. The image is demand-pageable (otherwise, a_text in the header will not reflect the gap between .text and .data). */ #define aout_section_merge_with_text_p(abfd, sec) \ (((sec)->flags & (SEC_HAS_CONTENTS | SEC_READONLY)) == \ (SEC_HAS_CONTENTS | SEC_READONLY) \ && obj_textsec (abfd) != NULL \ && obj_datasec (abfd) != NULL \ && (sec)->vma >= (obj_textsec (abfd)->vma + \ obj_textsec (abfd)->size) \ && ((sec)->vma + (sec)->size) <= obj_datasec (abfd)->vma \ && ((abfd)->flags & D_PAGED) != 0) #endif /* ! defined (LIBAOUT_H) */