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