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/* We want reloc.h to provide PA 2.0 defines.  */
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
55typedef 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  }
86som_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.  */
90struct 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
109struct 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
141struct som_data_struct
142  {
143    struct somdata a;
144  };
145
146struct som_subspace_dictionary_record
147  {
148    int space_index;
149    unsigned int access_control_bits : 7;
150    unsigned int memory_resident : 1;
151    unsigned int dup_common : 1;
152    unsigned int is_common : 1;
153    unsigned int is_loadable : 1;
154    unsigned int quadrant : 2;
155    unsigned int initially_frozen : 1;
156    unsigned int is_first : 1;
157    unsigned int code_only : 1;
158    unsigned int sort_key : 8;
159    unsigned int replicate_init	: 1;
160    unsigned int continuation : 1;
161    unsigned int is_tspecific : 1;
162    unsigned int is_comdat : 1;
163    unsigned int reserved : 4;
164    int file_loc_init_value;
165    unsigned int initialization_length;
166    unsigned int subspace_start;
167    unsigned int subspace_length;
168    unsigned int reserved2 : 5;
169    unsigned int alignment :27;
170    union name_pt name;
171    int fixup_request_index;
172    unsigned int fixup_request_quantity;
173  };
174
175/* Substructure of som_section_data_struct used to hold information
176   which can't be represented by the generic BFD section structure,
177   but which must be copied during objcopy or strip.  */
178struct som_copyable_section_data_struct
179  {
180    /* Various fields in space and subspace headers that we need
181       to pass around.  */
182    unsigned int sort_key : 8;
183    unsigned int access_control_bits : 7;
184    unsigned int is_defined : 1;
185    unsigned int is_private : 1;
186    unsigned int quadrant : 2;
187    unsigned int is_comdat : 1;
188    unsigned int is_common : 1;
189    unsigned int dup_common : 1;
190
191    /* For subspaces, this points to the section which represents the
192       space in which the subspace is contained.  For spaces it points
193       back to the section for this space.  */
194    asection *container;
195
196    /* The user-specified space number.  It is wrong to use this as
197       an index since duplicates and holes are allowed.  */
198    int space_number;
199
200    /* Add more stuff here as needed.  Good examples of information
201       we might want to pass would be initialization pointers,
202       and the many subspace flags we do not represent yet.  */
203  };
204
205/* Used to keep extra SOM specific information for a given section.
206
207   reloc_size holds the size of the relocation stream, note this
208   is very different from the number of relocations as SOM relocations
209   are variable length.
210
211   reloc_stream is the actual stream of relocation entries.  */
212
213struct som_section_data_struct
214  {
215    struct som_copyable_section_data_struct *copy_data;
216    unsigned int reloc_size;
217    char *reloc_stream;
218    struct space_dictionary_record *space_dict;
219    struct som_subspace_dictionary_record *subspace_dict;
220  };
221
222#define somdata(bfd)			((bfd)->tdata.som_data->a)
223#define obj_som_exec_data(bfd)		(somdata(bfd).exec_data)
224#define obj_som_file_hdr(bfd)		(somdata(bfd).file_hdr)
225#define obj_som_exec_hdr(bfd)		(somdata(bfd).exec_hdr)
226#define obj_som_copyright_hdr(bfd)	(somdata(bfd).copyright_aux_hdr)
227#define obj_som_version_hdr(bfd)	(somdata(bfd).version_aux_hdr)
228#define obj_som_compilation_unit(bfd)	(somdata(bfd).comp_unit)
229#define obj_som_symtab(bfd)		(somdata(bfd).symtab)
230#define obj_som_stringtab(bfd)		(somdata(bfd).stringtab)
231#define obj_som_sym_filepos(bfd)	(somdata(bfd).sym_filepos)
232#define obj_som_str_filepos(bfd)	(somdata(bfd).str_filepos)
233#define obj_som_stringtab_size(bfd)	(somdata(bfd).stringtab_size)
234#define obj_som_reloc_filepos(bfd)	(somdata(bfd).reloc_filepos)
235#define obj_som_sorted_syms(bfd)	(somdata(bfd).sorted_syms)
236#define som_section_data(sec) \
237  ((struct som_section_data_struct *)sec->used_by_bfd)
238#define som_symbol_data(symbol)		((som_symbol_type *) symbol)
239
240/* Defines groups of basic relocations.  FIXME:  These should
241   be the only basic relocations created by GAS.  The rest
242   should be internal to the BFD backend.
243
244   The idea is both SOM and ELF define these basic relocation
245   types so they map into a SOM or ELF specific relocation as
246   appropriate.  This allows GAS to share much more code
247   between the two object formats.  */
248
249#define R_HPPA_NONE			R_NO_RELOCATION
250#define	R_HPPA				R_CODE_ONE_SYMBOL
251#define	R_HPPA_PCREL_CALL		R_PCREL_CALL
252#define R_HPPA_ABS_CALL			R_ABS_CALL
253#define	R_HPPA_GOTOFF			R_DP_RELATIVE
254#define R_HPPA_ENTRY			R_ENTRY
255#define R_HPPA_EXIT			R_EXIT
256#define R_HPPA_COMPLEX			R_COMP1
257#define R_HPPA_BEGIN_BRTAB		R_BEGIN_BRTAB
258#define R_HPPA_END_BRTAB		R_END_BRTAB
259#define R_HPPA_BEGIN_TRY		R_BEGIN_TRY
260#define R_HPPA_END_TRY			R_END_TRY
261
262/* Exported functions, mostly for use by GAS.  */
263bfd_boolean bfd_som_set_section_attributes
264  PARAMS ((asection *, int, int, unsigned int, int));
265bfd_boolean bfd_som_set_subsection_attributes
266  PARAMS ((asection *, asection *, int, unsigned int, int, int, int, int));
267void bfd_som_set_symbol_type PARAMS ((asymbol *, unsigned int));
268bfd_boolean bfd_som_attach_aux_hdr PARAMS ((bfd *, int, char *));
269int ** hppa_som_gen_reloc_type
270  PARAMS ((bfd *, int, int, enum hppa_reloc_field_selector_type_alt,
271	   int, asymbol *));
272bfd_boolean bfd_som_attach_compilation_unit
273  PARAMS ((bfd *, const char *, const char *, const char *, const char *));
274
275#endif /* _SOM_H */
276