[binutils.git] / bfd / som.h

/* HP PA-RISC SOM object file format:  definitions internal to BFD.
   Copyright (C) 1990, 91, 92, 93, 94 Free Software Foundation, Inc.

   Contributed by the Center for Software Science at the
   University of Utah ([email protected]).

   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 2 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., 675 Mass Ave, Cambridge, MA 02139, USA.  */

#ifndef _SOM_H
#define _SOM_H

#include "../bfd/sysdep.h"
#include "libhppa.h"

#include <a.out.h>
#include <lst.h>
#include <ar.h>


#if defined(HOST_HPPABSD) || defined (HOST_HPPAOSF)
/* BSD uses a completely different scheme for object file identification.
   so for now, define _PA_RISC_ID to accept any random value for a model
   number.  */
#undef _PA_RISC_ID
#define _PA_RISC_ID(__m_num) 1
#endif /* HOST_HPPABSD */

#define FILE_HDR_SIZE sizeof(struct header)
#define AUX_HDR_SIZE sizeof(struct som_exec_auxhdr)

typedef struct som_symbol
  {
    asymbol symbol;
    short desc;
    char other;
    unsigned char type;
    unsigned int som_type;

    /* Structured like the ELF tc_data union.  Allows more code sharing
       in GAS this way.  */
    union
      {
	unsigned int hppa_arg_reloc;
	PTR any;
      }
    tc_data;

    /* Index of this symbol in the symbol table.  Only used when
       building relocation streams for incomplete objects.  */
    int index;

    /* How many times this symbol is used in a relocation.  By sorting
       the symbols from most used to least used we can significantly
       reduce the size of the relocation stream for incomplete objects.  */
    int reloc_count;

    /* The unwind descriptor bits associated with R_ENTRY relocations
       for functions (not enough room in a BFD reloc to store all the
       information, so we tack it onto the symbol associated with the
       function.  */
    char *unwind;
  }
som_symbol_type;

/* A structure containing all the magic information stored in a BFD's
   private data which needs to be copied during an objcopy/strip run.  */
struct som_exec_data
  {
    /* Sort-of a magic number.  BSD uses it to distinguish between
       native executables and hpux executables.  */
    short system_id;

    /* Magic exec flags.  These control things like whether or not
       null pointer dereferencing is allowed and the like.  */
    long exec_flags;

    /* Add more stuff here as needed.  Good examples of information
       we might want to pass would be presumed_dp, entry_* and maybe
       others from the file header.  */
  };

struct somdata
  {
    /* All the magic information about an executable which lives
       in the private BFD structure and needs to be copied from
       the input bfd to the output bfd during a objcopy/strip.  */
    struct som_exec_data *exec_data;

    /* These three fields are only used when writing files and are
       generated from scratch.  They need not be copied for objcopy
       or strip to work.  */
    struct header *file_hdr;
    struct copyright_aux_hdr *copyright_aux_hdr;
    struct user_string_aux_hdr *version_aux_hdr;

    /* Pointers to a saved copy of the symbol and string tables.  These
       need not be copied for objcopy or strip to work.  */
    som_symbol_type *symtab;
    char *stringtab;

    /* We remember these offsets so that after check_file_format, we have
       no dependencies on the particular format of the exec_hdr.
       These offsets need not be copied for objcopy or strip to work.  */

    file_ptr sym_filepos;
    file_ptr str_filepos;
    file_ptr reloc_filepos;
    unsigned stringtab_size;
  };

struct som_data_struct
  {
    struct somdata a;
  };

/* Used to keep extra SOM specific information for a given section.

   reloc_size holds the size of the relocation stream, note this
   is very different from the number of relocations as SOM relocations
   are variable length. 

   reloc_stream is the actual stream of relocation entries.

   The BFD section index may not exactly match a SOM subspace index,
   for this reason we keep track of the original SOM subspace index
   when a subspace is turned into a BFD section.  */

struct som_section_data_struct
  {
    unsigned int is_space : 1;
    unsigned int is_subspace : 1;
    unsigned int reloc_size;
    char *reloc_stream;
    asection *containing_space;
    struct space_dictionary_record space_dict;
    struct subspace_dictionary_record subspace_dict;
  };

#define somdata(bfd)			((bfd)->tdata.som_data->a)
#define obj_som_exec_data(bfd)		(somdata(bfd).exec_data)
#define obj_som_file_hdr(bfd)		(somdata(bfd).file_hdr)
#define obj_som_copyright_hdr(bfd)	(somdata(bfd).copyright_aux_hdr)
#define obj_som_version_hdr(bfd)	(somdata(bfd).version_aux_hdr)
#define obj_som_symtab(bfd)		(somdata(bfd).symtab)
#define obj_som_stringtab(bfd)		(somdata(bfd).stringtab)
#define obj_som_sym_filepos(bfd)	(somdata(bfd).sym_filepos)
#define obj_som_str_filepos(bfd)	(somdata(bfd).str_filepos)
#define obj_som_stringtab_size(bfd)	(somdata(bfd).stringtab_size)
#define obj_som_reloc_filepos(bfd)	(somdata(bfd).reloc_filepos)
#define som_section_data(sec) \
  ((struct som_section_data_struct *)sec->used_by_bfd)
#define som_symbol_data(symbol) \
  ((som_symbol_type *) symbol)


/* Defines groups of basic relocations.  FIXME:  These should
   be the only basic relocations created by GAS.  The rest
   should be internal to the BFD backend.

   The idea is both SOM and ELF define these basic relocation
   types so they map into a SOM or ELF specific reloation as
   appropriate.  This allows GAS to share much more code 
   between the two object formats.  */

#define R_HPPA_NONE			R_NO_RELOCATION
#define	R_HPPA				R_CODE_ONE_SYMBOL
#define	R_HPPA_ABS_CALL			R_ABS_CALL
#define	R_HPPA_PCREL_CALL		R_PCREL_CALL
#define	R_HPPA_GOTOFF			R_DP_RELATIVE
#define	R_HPPA_COMPLEX			R_COMP1
#define	R_HPPA_COMPLEX_PCREL_CALL	R_COMP2
#define	R_HPPA_COMPLEX_ABS_CALL		R_COMP3
#define R_HPPA_ENTRY			R_ENTRY
#define R_HPPA_EXIT			R_EXIT

/* Exported functions, mostly for use by GAS.  */
void bfd_som_set_section_attributes PARAMS ((asection *, int, int,
					     unsigned int, int));
void bfd_som_set_subsection_attributes PARAMS ((asection *, asection *,
						int, unsigned int, int));
void bfd_som_set_symbol_type PARAMS ((asymbol *, unsigned int));
void bfd_som_attach_unwind_info PARAMS ((asymbol *, char *));
boolean bfd_som_attach_aux_hdr PARAMS ((bfd *, int, char *));
int ** hppa_som_gen_reloc_type
  PARAMS ((bfd *, int, int, enum hppa_reloc_field_selector_type_alt));
#endif /* _SOM_H */
Commit	Line	Data
176ed088	1	/* HP PA-RISC SOM object file format: definitions internal to BFD.
4359a7ef	2	Copyright (C) 1990, 91, 92, 93, 94 Free Software Foundation, Inc.
176ed088 JL	3
	4	Contributed by the Center for Software Science at the
	5	University of Utah ([email protected]).
	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"
4e64845c	27	#include "libhppa.h"
176ed088 JL	28
176ed088 JL	29	#include <a.out.h>
6863eb4b JL	30	#include <lst.h>
6863eb4b JL	31	#include <ar.h>
176ed088 JL	32
176ed088 JL	33
7b5f6e48	34	#if defined(HOST_HPPABSD) \|\| defined (HOST_HPPAOSF)
176ed088 JL	35	/* BSD uses a completely different scheme for object file identification.
	36	so for now, define _PA_RISC_ID to accept any random value for a model
	37	number. */
	38	#undef _PA_RISC_ID
	39	#define _PA_RISC_ID(__m_num) 1
	40	#endif /* HOST_HPPABSD */
	41
	42	#define FILE_HDR_SIZE sizeof(struct header)
	43	#define AUX_HDR_SIZE sizeof(struct som_exec_auxhdr)
	44
	45	typedef struct som_symbol
	46	{
	47	asymbol symbol;
	48	short desc;
	49	char other;
	50	unsigned char type;
	51	unsigned int som_type;
	52
	53	/* Structured like the ELF tc_data union. Allows more code sharing
	54	in GAS this way. */
	55	union
	56	{
	57	unsigned int hppa_arg_reloc;
	58	PTR any;
	59	}
	60	tc_data;
	61
	62	/* Index of this symbol in the symbol table. Only used when
	63	building relocation streams for incomplete objects. */
	64	int index;
	65
	66	/* How many times this symbol is used in a relocation. By sorting
	67	the symbols from most used to least used we can significantly
	68	reduce the size of the relocation stream for incomplete objects. */
	69	int reloc_count;
	70
	71	/* The unwind descriptor bits associated with R_ENTRY relocations
	72	for functions (not enough room in a BFD reloc to store all the
	73	information, so we tack it onto the symbol associated with the
	74	function. */
	75	char *unwind;
	76	}
	77	som_symbol_type;
	78
4359a7ef JL	79	/* A structure containing all the magic information stored in a BFD's
	80	private data which needs to be copied during an objcopy/strip run. */
	81	struct som_exec_data
	82	{
	83	/* Sort-of a magic number. BSD uses it to distinguish between
	84	native executables and hpux executables. */
	85	short system_id;
	86
	87	/* Magic exec flags. These control things like whether or not
	88	null pointer dereferencing is allowed and the like. */
	89	long exec_flags;
	90
	91	/* Add more stuff here as needed. Good examples of information
	92	we might want to pass would be presumed_dp, entry_* and maybe
	93	others from the file header. */
	94	};
	95
176ed088 JL	96	struct somdata
176ed088 JL	97	{
4359a7ef JL	98	/* All the magic information about an executable which lives
	99	in the private BFD structure and needs to be copied from
	100	the input bfd to the output bfd during a objcopy/strip. */
	101	struct som_exec_data *exec_data;
	102
	103	/* These three fields are only used when writing files and are
	104	generated from scratch. They need not be copied for objcopy
	105	or strip to work. */
176ed088	106	struct header *file_hdr;
6863eb4b JL	107	struct copyright_aux_hdr *copyright_aux_hdr;
6863eb4b JL	108	struct user_string_aux_hdr *version_aux_hdr;
4359a7ef JL	109
	110	/* Pointers to a saved copy of the symbol and string tables. These
	111	need not be copied for objcopy or strip to work. */
176ed088 JL	112	som_symbol_type *symtab;
	113	char *stringtab;
	114
	115	/* We remember these offsets so that after check_file_format, we have
4359a7ef JL	116	no dependencies on the particular format of the exec_hdr.
4359a7ef JL	117	These offsets need not be copied for objcopy or strip to work. */
176ed088 JL	118
	119	file_ptr sym_filepos;
	120	file_ptr str_filepos;
	121	file_ptr reloc_filepos;
176ed088 JL	122	unsigned stringtab_size;
	123	};
	124
	125	struct som_data_struct
	126	{
	127	struct somdata a;
	128	};
	129
	130	/* Used to keep extra SOM specific information for a given section.
	131
	132	reloc_size holds the size of the relocation stream, note this
	133	is very different from the number of relocations as SOM relocations
	134	are variable length.
	135
	136	reloc_stream is the actual stream of relocation entries.
	137
	138	The BFD section index may not exactly match a SOM subspace index,
	139	for this reason we keep track of the original SOM subspace index
	140	when a subspace is turned into a BFD section. */
	141
	142	struct som_section_data_struct
	143	{
4359a7ef JL	144	unsigned int is_space : 1;
4359a7ef JL	145	unsigned int is_subspace : 1;
176ed088 JL	146	unsigned int reloc_size;
176ed088 JL	147	char *reloc_stream;
176ed088	148	asection *containing_space;
176ed088	149	struct space_dictionary_record space_dict;
176ed088 JL	150	struct subspace_dictionary_record subspace_dict;
	151	};
	152
	153	#define somdata(bfd) ((bfd)->tdata.som_data->a)
4359a7ef	154	#define obj_som_exec_data(bfd) (somdata(bfd).exec_data)
176ed088	155	#define obj_som_file_hdr(bfd) (somdata(bfd).file_hdr)
6863eb4b JL	156	#define obj_som_copyright_hdr(bfd) (somdata(bfd).copyright_aux_hdr)
6863eb4b JL	157	#define obj_som_version_hdr(bfd) (somdata(bfd).version_aux_hdr)
176ed088 JL	158	#define obj_som_symtab(bfd) (somdata(bfd).symtab)
	159	#define obj_som_stringtab(bfd) (somdata(bfd).stringtab)
	160	#define obj_som_sym_filepos(bfd) (somdata(bfd).sym_filepos)
	161	#define obj_som_str_filepos(bfd) (somdata(bfd).str_filepos)
	162	#define obj_som_stringtab_size(bfd) (somdata(bfd).stringtab_size)
	163	#define obj_som_reloc_filepos(bfd) (somdata(bfd).reloc_filepos)
	164	#define som_section_data(sec) \
	165	((struct som_section_data_struct *)sec->used_by_bfd)
	166	#define som_symbol_data(symbol) \
44fd6622	167	((som_symbol_type *) symbol)
176ed088 JL	168
	169
	170	/* Defines groups of basic relocations. FIXME: These should
	171	be the only basic relocations created by GAS. The rest
	172	should be internal to the BFD backend.
	173
	174	The idea is both SOM and ELF define these basic relocation
	175	types so they map into a SOM or ELF specific reloation as
	176	appropriate. This allows GAS to share much more code
	177	between the two object formats. */
	178
	179	#define R_HPPA_NONE R_NO_RELOCATION
	180	#define R_HPPA R_CODE_ONE_SYMBOL
	181	#define R_HPPA_ABS_CALL R_ABS_CALL
	182	#define R_HPPA_PCREL_CALL R_PCREL_CALL
	183	#define R_HPPA_GOTOFF R_DP_RELATIVE
	184	#define R_HPPA_COMPLEX R_COMP1
	185	#define R_HPPA_COMPLEX_PCREL_CALL R_COMP2
	186	#define R_HPPA_COMPLEX_ABS_CALL R_COMP3
	187	#define R_HPPA_ENTRY R_ENTRY
	188	#define R_HPPA_EXIT R_EXIT
	189
6863eb4b JL	190	/* Exported functions, mostly for use by GAS. */
6863eb4b JL	191	void bfd_som_set_section_attributes PARAMS ((asection *, int, int,
44fd6622	192	unsigned int, int));
6863eb4b JL	193	void bfd_som_set_subsection_attributes PARAMS ((asection , asection ,
	194	int, unsigned int, int));
	195	void bfd_som_set_symbol_type PARAMS ((asymbol *, unsigned int));
	196	void bfd_som_attach_unwind_info PARAMS ((asymbol , char ));
44fd6622 JL	197	boolean bfd_som_attach_aux_hdr PARAMS ((bfd , int, char ));
	198	int ** hppa_som_gen_reloc_type
	199	PARAMS ((bfd *, int, int, enum hppa_reloc_field_selector_type_alt));
176ed088	200	#endif /* _SOM_H */