bfd/libaout.h

   1 /* BFD back-end data structures for a.out (and similar) files.
   2    Copyright (C) 1990-1991 Free Software Foundation, Inc.
   3    Written by Cygnus Support.
   4
   5 This file is part of BFD, the Binary File Descriptor library.
   6
   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.
  11
  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.
  16
  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., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20
  21 /* We try to encapsulate the differences in the various a.out file
  22    variants in a few routines, and otherwise share large masses of code.
  23    This means we only have to fix bugs in one place, most of the time.  */
  24
  25 /* $Id$ */
  26
  27 #ifdef __STDC__
  28 #define CAT3(a,b,c) a##b##c
  29 #else
  30 #define CAT3(a,b,c) a/**/b/**/c
  31 #endif
  32
  33 /* Parameterize the a.out code based on whether it is being built
  34    for a 32-bit architecture or a 64-bit architecture.  */
  35 #if ARCH_SIZE==64
  36 #define GET_WORD bfd_h_get_64
  37 #define GET_SWORD (int64_type)GET_WORD
  38 #define PUT_WORD bfd_h_put_64
  39 #define NAME(x,y) CAT3(x,_64_,y)
  40 #define JNAME(x) CAT(x,_64)
  41 #define BYTES_IN_WORD 8
  42 #else
  43 #define GET_WORD bfd_h_get_32
  44 #define GET_SWORD (int32_type)GET_WORD
  45 #define PUT_WORD bfd_h_put_32
  46 #define NAME(x,y) CAT3(x,_32_,y)
  47 #define JNAME(x) CAT(x,_32)
  48 #define BYTES_IN_WORD 4
  49 #endif
  50
  51 #define adata(bfd)              ((struct aoutdata *) ((bfd)->tdata))
  52 #define exec_hdr(bfd)           (adata(bfd)->hdr)
  53 #define obj_textsec(bfd)        (adata(bfd)->textsec)
  54 #define obj_datasec(bfd)        (adata(bfd)->datasec)
  55 #define obj_bsssec(bfd)         (adata(bfd)->bsssec)
  56 #define obj_sym_filepos(bfd)    (adata(bfd)->sym_filepos)
  57 #define obj_str_filepos(bfd)    (adata(bfd)->str_filepos)
  58
  59 #define obj_reloc_entry_size(bfd) (adata(bfd)->reloc_entry_size)
  60
  61 /* Declare these types at file level, since they are used in parameter
  62    lists, which have wierd scope.  */
  63 struct external_exec;
  64 struct internal_exec;
  65
  66 typedef struct aout_symbol {
  67   asymbol symbol;
  68   short desc;
  69   char other;
  70   unsigned char type;
  71 } aout_symbol_type;
  72
  73 struct aoutdata {
  74   struct internal_exec *hdr;               /* exec file header */
  75   aout_symbol_type *symbols;            /* symtab for input bfd */
  76
  77
  78   /* For ease, we do this */
  79   asection *textsec;
  80   asection *datasec;
  81   asection *bsssec;
  82
  83   /* We remember these offsets so that after check_file_format, we have
  84      no dependencies on the particular format of the exec_hdr.  */
  85   file_ptr sym_filepos;
  86   file_ptr str_filepos;
  87
  88   /* Size of a relocation entry */
  89   unsigned reloc_entry_size;
  90 };
  91
  92
  93 #define obj_outsymbols(bfd) ((PTR)(((struct aoutdata *) ((bfd)->tdata))->outsymbols))
  94
  95
  96 /* We take the address of the first element of an asymbol to ensure that the
  97  * macro is only ever applied to an asymbol */
  98 #define aout_symbol(asymbol) ((aout_symbol_type *)(&(asymbol)->the_bfd))
  99
 100 /*#define obj_symbols(bfd) ((((struct aoutdata *) ((bfd)->tdata))->symbols))*/
 101 #define obj_aout_symbols(bfd) ((((struct aoutdata *) (bfd)->tdata))->symbols)
 102 #define obj_arch_flags(bfd) ((((struct aoutdata *) (bfd)->tdata))->arch_flags)
 103
 104 #define get_tdata(x)  ((struct aoutdata *)((x)->tdata))
 105
 106 /* Prototype declarations for functions defined in aoutx.h  */
 107
 108 PROTO (boolean, NAME(aout,squirt_out_relocs),(bfd *abfd, asection *section));
 109
 110 PROTO (bfd_target *, NAME(aout,some_aout_object_p), (bfd *abfd,
 111                                           bfd_target *(*callback)()));
 112 PROTO (boolean, NAME(aout,mkobject), (bfd *abfd));
 113 PROTO (enum machine_type, NAME(aout,machine_type), (enum bfd_architecture arch,
 114                                                 unsigned long machine));
 115 PROTO (boolean, NAME(aout,set_arch_mach), (bfd *abfd, enum bfd_architecture arch,
 116                                                 unsigned long machine));
 117
 118 PROTO (boolean, NAME(aout,new_section_hook), (bfd *abfd, asection *newsect));
 119 PROTO (boolean, NAME(aout,set_section_contents), (bfd *abfd, sec_ptr section,
 120                          PTR location, file_ptr offset, bfd_size_type count));
 121
 122 PROTO (asymbol *,NAME(aout,make_empty_symbol), (bfd *abfd));
 123 PROTO (boolean, NAME(aout,slurp_symbol_table), (bfd *abfd));
 124 PROTO (void,    NAME(aout,write_syms), (bfd *abfd));
 125 PROTO (void,    NAME(aout,reclaim_symbol_table), (bfd *abfd));
 126 PROTO (unsigned int, NAME(aout,get_symtab_upper_bound), (bfd *abfd));
 127 PROTO (unsigned int, NAME(aout,get_symtab), (bfd *abfd, asymbol **location));
 128 PROTO (boolean, NAME(aout,slurp_reloc_table), (bfd *abfd, sec_ptr asect,
 129                                          asymbol **symbols));
 130 PROTO (unsigned int, NAME(aout,canonicalize_reloc), (bfd *abfd, sec_ptr section,
 131                                          arelent **relptr, asymbol **symbols));
 132 PROTO (unsigned int, NAME(aout,get_reloc_upper_bound), (bfd *abfd, sec_ptr asect));
 133 PROTO (void,    NAME(aout,reclaim_reloc), (bfd *ignore_abfd, sec_ptr ignore));
 134 PROTO (alent *, NAME(aout,get_lineno), (bfd *ignore_abfd, asymbol *ignore_symbol));
 135 PROTO (void,    NAME(aout,print_symbol), (bfd *ignore_abfd, PTR file,
 136                             asymbol *symbol, bfd_print_symbol_type how));
 137 PROTO (boolean, NAME(aout,close_and_cleanup), (bfd *abfd));
 138 PROTO (boolean, NAME(aout,find_nearest_line), (bfd *abfd, asection *section,
 139       asymbol **symbols, bfd_vma offset, CONST char **filename_ptr,
 140       CONST char **functionname_ptr, unsigned int *line_ptr));
 141 PROTO (int,     NAME(aout,sizeof_headers), (bfd *ignore_abfd, boolean exec));
 142
 143
 144 PROTO (void,    NAME(aout,swap_exec_header_in), (bfd *abfd,
 145                          struct external_exec *raw_bytes, struct internal_exec *execp));
 146
 147 PROTO (void,    NAME(aout,swap_exec_header_out),(bfd *abfd, struct internal_exec *execp,
 148                          struct external_exec *raw_bytes));
 149
 150 /* A.out uses the generic versions of these routines... */
 151
 152 #define aout_32_get_section_contents    bfd_generic_get_section_contents
 153 #define aout_32_close_and_cleanup       bfd_generic_close_and_cleanup
 154
 155 #define aout_64_get_section_contents    bfd_generic_get_section_contents
 156 #define aout_64_close_and_cleanup       bfd_generic_close_and_cleanup
 157
 158 /* Calculate the file positions of the parts of a newly read aout header */
 159 #define WORK_OUT_FILE_POSITIONS(abfd, execp)                            \
 160   obj_datasec (abfd)->vma = N_DATADDR(*execp);                          \
 161   obj_bsssec (abfd)->vma = N_BSSADDR(*execp);                           \
 162   obj_textsec (abfd)->vma = N_TXTADDR(*execp);                          \
 163                                                                         \
 164   /* The file offsets of the sections */                                \
 165   obj_textsec (abfd)->filepos = N_TXTOFF (*execp);                      \
 166   obj_datasec (abfd)->filepos = N_DATOFF (*execp);                      \
 167                                                                         \
 168   /* The file offsets of the relocation info */                         \
 169   obj_textsec (abfd)->rel_filepos = N_TRELOFF(*execp);                  \
 170   obj_datasec (abfd)->rel_filepos = N_DRELOFF(*execp);                  \
 171                                                                         \
 172   /* The file offsets of the string table and symbol table.  */         \
 173   obj_sym_filepos (abfd) = N_SYMOFF (*execp);                           \
 174   obj_str_filepos (abfd) = N_STROFF (*execp);                           \
 175
 176
 177 #define WRITE_HEADERS(abfd, execp)                                            \
 178       {                                                                       \
 179         if ((obj_textsec(abfd)->vma & 0xff )== EXEC_BYTES_SIZE)  \
 180                 abfd->flags |= D_PAGED;                 \
 181         else                                            \
 182                 abfd->flags &= ~D_PAGED;                \
 183         if (abfd->flags & D_PAGED)                                            \
 184             {                                                                 \
 185               execp->a_text = obj_textsec (abfd)->size + EXEC_BYTES_SIZE;     \
 186               N_SET_MAGIC (*execp, ZMAGIC);                                   \
 187             }                                                                 \
 188         else                                                                  \
 189             {                                                                 \
 190               execp->a_text = obj_textsec (abfd)->size;                       \
 191               if (abfd->flags & WP_TEXT)                                      \
 192                 { N_SET_MAGIC (*execp, NMAGIC); }                             \
 193               else                                                            \
 194                 { N_SET_MAGIC(*execp, OMAGIC); }                              \
 195             }                                                                 \
 196         if (abfd->flags & D_PAGED)                                            \
 197             {                                                                 \
 198               data_pad = ((obj_datasec(abfd)->size + PAGE_SIZE -1)            \
 199                           & (- PAGE_SIZE)) - obj_datasec(abfd)->size;         \
 200                                                                               \
 201               if (data_pad > obj_bsssec(abfd)->size)                          \
 202                 execp->a_bss = 0;                                             \
 203               else                                                            \
 204                 execp->a_bss = obj_bsssec(abfd)->size - data_pad;             \
 205               execp->a_data = obj_datasec(abfd)->size + data_pad;             \
 206             }                                                                 \
 207         else                                                                  \
 208             {                                                                 \
 209               execp->a_data = obj_datasec (abfd)->size;                       \
 210               execp->a_bss = obj_bsssec (abfd)->size;                         \
 211             }                                                                 \
 212                                                                               \
 213         execp->a_syms = bfd_get_symcount (abfd) * EXTERNAL_LIST_SIZE;         \
 214         execp->a_entry = bfd_get_start_address (abfd);                        \
 215                                                                               \
 216         execp->a_trsize = ((obj_textsec (abfd)->reloc_count) *                \
 217                            obj_reloc_entry_size (abfd));                      \
 218         execp->a_drsize = ((obj_datasec (abfd)->reloc_count) *                \
 219                            obj_reloc_entry_size (abfd));                      \
 220         NAME(aout,swap_exec_header_out) (abfd, execp, &exec_bytes);           \
 221                                                                               \
 222         bfd_seek (abfd, 0L, false);                                           \
 223         bfd_write ((PTR) &exec_bytes, 1, EXEC_BYTES_SIZE, abfd);              \
 224         /* Now write out reloc info, followed by syms and strings */          \
 225                                                                               \
 226         if (bfd_get_symcount (abfd) != 0)                                     \
 227             {                                                                 \
 228               bfd_seek (abfd,                                                 \
 229                         (long)(N_SYMOFF(*execp)), false);                     \
 230                                                                               \
 231               NAME(aout,write_syms)(abfd);                                    \
 232                                                                               \
 233               bfd_seek (abfd,   (long)(N_TRELOFF(*execp)), false);            \
 234                                                                               \
 235               if (!NAME(aout,squirt_out_relocs) (abfd, obj_textsec (abfd))) return false; \
 236               bfd_seek (abfd, (long)(N_DRELOFF(*execp)), false);              \
 237                                                                               \
 238               if (!NAME(aout,squirt_out_relocs)(abfd, obj_datasec (abfd))) return false; \
 239             }                                                                 \
 240       }