bfd/som.h

   1 /* HP PA-RISC SOM object file format:  definitions internal to BFD.
   2    Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1998, 2000, 2001,
   3    2002, 2003 Free Software Foundation, Inc.
   4
   5    Contributed by the Center for Software Science at the
   6    University of Utah (pa-gdb-bugs@cs.utah.edu).
   7
   8    This file is part of BFD, the Binary File Descriptor library.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 2 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  23    02111-1307, USA.  */
  24
  25 #ifndef _SOM_H
  26 #define _SOM_H
  27
  28 #include "libhppa.h"
  29
  30 /* Enable PA2.0 if available */
  31 #define PA_2_0
  32
  33 #include <a.out.h>
  34 #include <lst.h>
  35 #include <ar.h>
  36
  37 /* The SOM BFD backend doesn't currently use anything from these
  38    two include files, but it's likely to need them in the future.  */
  39 #ifdef R_DLT_REL
  40 #include <shl.h>
  41 #include <dl.h>
  42 #endif
  43
  44 #if defined(HOST_HPPABSD) || defined (HOST_HPPAOSF)
  45 /* BSD uses a completely different scheme for object file identification.
  46    so for now, define _PA_RISC_ID to accept any random value for a model
  47    number.  */
  48 #undef _PA_RISC_ID
  49 #define _PA_RISC_ID(__m_num) 1
  50 #endif /* HOST_HPPABSD */
  51
  52 #define FILE_HDR_SIZE sizeof (struct header)
  53 #define AUX_HDR_SIZE sizeof (struct som_exec_auxhdr)
  54
  55 typedef struct som_symbol
  56   {
  57     asymbol symbol;
  58     unsigned int som_type;
  59
  60     /* Structured like the ELF tc_data union.  Allows more code sharing
  61        in GAS this way.  */
  62     union
  63       {
  64         struct
  65         {
  66           unsigned int hppa_arg_reloc;
  67           unsigned int hppa_priv_level;
  68         } ap;
  69         PTR any;
  70       }
  71     tc_data;
  72
  73     /* Index of this symbol in the symbol table.  Only used when
  74        building relocation streams for incomplete objects.  */
  75     int index;
  76
  77     /* How many times this symbol is used in a relocation.  By sorting
  78        the symbols from most used to least used we can significantly
  79        reduce the size of the relocation stream for incomplete objects.  */
  80     int reloc_count;
  81
  82     /* During object file writing, the offset of the name of this symbol
  83        in the SOM string table.  */
  84     int stringtab_offset;
  85   }
  86 som_symbol_type;
  87
  88 /* A structure containing all the magic information stored in a BFD's
  89    private data which needs to be copied during an objcopy/strip run.  */
  90 struct som_exec_data
  91   {
  92     /* Sort-of a magic number.  BSD uses it to distinguish between
  93        native executables and hpux executables.  */
  94     short system_id;
  95
  96     /* Magic exec flags.  These control things like whether or not
  97        null pointer dereferencing is allowed and the like.  */
  98     long exec_flags;
  99
 100     /* We must preserve the version identifier too.  Some versions
 101        of the HP linker do not grok NEW_VERSION_ID for reasons unknown.  */
 102     unsigned int version_id;
 103
 104     /* Add more stuff here as needed.  Good examples of information
 105        we might want to pass would be presumed_dp, entry_* and maybe
 106        others from the file header.  */
 107   };
 108
 109 struct somdata
 110   {
 111     /* All the magic information about an executable which lives
 112        in the private BFD structure and needs to be copied from
 113        the input bfd to the output bfd during an objcopy/strip.  */
 114     struct som_exec_data *exec_data;
 115
 116     /* These three fields are only used when writing files and are
 117        generated from scratch.  They need not be copied for objcopy
 118        or strip to work.  */
 119     struct header *file_hdr;
 120     struct copyright_aux_hdr *copyright_aux_hdr;
 121     struct user_string_aux_hdr *version_aux_hdr;
 122     struct som_exec_auxhdr *exec_hdr;
 123     COMPUNIT *comp_unit;
 124
 125     /* Pointers to a saved copy of the symbol and string tables.  These
 126        need not be copied for objcopy or strip to work.  */
 127     som_symbol_type *symtab;
 128     char *stringtab;
 129     asymbol **sorted_syms;
 130
 131     /* We remember these offsets so that after check_file_format, we have
 132        no dependencies on the particular format of the exec_hdr.
 133        These offsets need not be copied for objcopy or strip to work.  */
 134
 135     file_ptr sym_filepos;
 136     file_ptr str_filepos;
 137     file_ptr reloc_filepos;
 138     unsigned stringtab_size;
 139   };
 140
 141 struct som_data_struct
 142   {
 143     struct somdata a;
 144   };
 145
 146 /* Substructure of som_section_data_struct used to hold information
 147    which can't be represented by the generic BFD section structure,
 148    but which must be copied during objcopy or strip.  */
 149 struct som_copyable_section_data_struct
 150   {
 151     /* Various fields in space and subspace headers that we need
 152        to pass around.  */
 153     unsigned int sort_key : 8;
 154     unsigned int access_control_bits : 7;
 155     unsigned int is_defined : 1;
 156     unsigned int is_private : 1;
 157     unsigned int quadrant : 2;
 158
 159     /* For subspaces, this points to the section which represents the
 160        space in which the subspace is contained.  For spaces it points
 161        back to the section for this space.  */
 162     asection *container;
 163
 164     /* The user-specified space number.  It is wrong to use this as
 165        an index since duplicates and holes are allowed.  */
 166     int space_number;
 167
 168     /* Add more stuff here as needed.  Good examples of information
 169        we might want to pass would be initialization pointers,
 170        and the many subspace flags we do not represent yet.  */
 171   };
 172
 173 /* Used to keep extra SOM specific information for a given section.
 174
 175    reloc_size holds the size of the relocation stream, note this
 176    is very different from the number of relocations as SOM relocations
 177    are variable length.
 178
 179    reloc_stream is the actual stream of relocation entries.  */
 180
 181 struct som_section_data_struct
 182   {
 183     struct som_copyable_section_data_struct *copy_data;
 184     unsigned int reloc_size;
 185     char *reloc_stream;
 186     struct space_dictionary_record *space_dict;
 187     struct subspace_dictionary_record *subspace_dict;
 188   };
 189
 190 #define somdata(bfd)                    ((bfd)->tdata.som_data->a)
 191 #define obj_som_exec_data(bfd)          (somdata(bfd).exec_data)
 192 #define obj_som_file_hdr(bfd)           (somdata(bfd).file_hdr)
 193 #define obj_som_exec_hdr(bfd)           (somdata(bfd).exec_hdr)
 194 #define obj_som_copyright_hdr(bfd)      (somdata(bfd).copyright_aux_hdr)
 195 #define obj_som_version_hdr(bfd)        (somdata(bfd).version_aux_hdr)
 196 #define obj_som_compilation_unit(bfd)   (somdata(bfd).comp_unit)
 197 #define obj_som_symtab(bfd)             (somdata(bfd).symtab)
 198 #define obj_som_stringtab(bfd)          (somdata(bfd).stringtab)
 199 #define obj_som_sym_filepos(bfd)        (somdata(bfd).sym_filepos)
 200 #define obj_som_str_filepos(bfd)        (somdata(bfd).str_filepos)
 201 #define obj_som_stringtab_size(bfd)     (somdata(bfd).stringtab_size)
 202 #define obj_som_reloc_filepos(bfd)      (somdata(bfd).reloc_filepos)
 203 #define obj_som_sorted_syms(bfd)        (somdata(bfd).sorted_syms)
 204 #define som_section_data(sec) \
 205   ((struct som_section_data_struct *)sec->used_by_bfd)
 206 #define som_symbol_data(symbol)         ((som_symbol_type *) symbol)
 207
 208 /* Defines groups of basic relocations.  FIXME:  These should
 209    be the only basic relocations created by GAS.  The rest
 210    should be internal to the BFD backend.
 211
 212    The idea is both SOM and ELF define these basic relocation
 213    types so they map into a SOM or ELF specific reloation as
 214    appropriate.  This allows GAS to share much more code
 215    between the two object formats.  */
 216
 217 #define R_HPPA_NONE                     R_NO_RELOCATION
 218 #define R_HPPA                          R_CODE_ONE_SYMBOL
 219 #define R_HPPA_PCREL_CALL               R_PCREL_CALL
 220 #define R_HPPA_ABS_CALL                 R_ABS_CALL
 221 #define R_HPPA_GOTOFF                   R_DP_RELATIVE
 222 #define R_HPPA_ENTRY                    R_ENTRY
 223 #define R_HPPA_EXIT                     R_EXIT
 224 #define R_HPPA_COMPLEX                  R_COMP1
 225 #define R_HPPA_BEGIN_BRTAB              R_BEGIN_BRTAB
 226 #define R_HPPA_END_BRTAB                R_END_BRTAB
 227 #define R_HPPA_BEGIN_TRY                R_BEGIN_TRY
 228 #define R_HPPA_END_TRY                  R_END_TRY
 229
 230 /* Exported functions, mostly for use by GAS.  */
 231 bfd_boolean bfd_som_set_section_attributes
 232   PARAMS ((asection *, int, int, unsigned int, int));
 233 bfd_boolean bfd_som_set_subsection_attributes
 234   PARAMS ((asection *, asection *, int, unsigned int, int));
 235 void bfd_som_set_symbol_type PARAMS ((asymbol *, unsigned int));
 236 bfd_boolean bfd_som_attach_aux_hdr PARAMS ((bfd *, int, char *));
 237 int ** hppa_som_gen_reloc_type
 238   PARAMS ((bfd *, int, int, enum hppa_reloc_field_selector_type_alt,
 239            int, asymbol *));
 240 bfd_boolean bfd_som_attach_compilation_unit
 241   PARAMS ((bfd *, const char *, const char *, const char *, const char *));
 242
 243 #endif /* _SOM_H */