[deliverable/binutils-gdb.git] / bfd / libcoff-in.h

/* BFD COFF object file private structure.
   Copyright (C) 1990, 91, 92, 93, 94, 1995 Free Software Foundation, Inc.
   Written by Cygnus Support.

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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */

#include "bfdlink.h"

/* Object file tdata; access macros */

#define coff_data(bfd)		((bfd)->tdata.coff_obj_data)
#define exec_hdr(bfd)		(coff_data(bfd)->hdr)
#define obj_pe(bfd)             (coff_data(bfd)->pe)
#define obj_symbols(bfd)	(coff_data(bfd)->symbols)
#define	obj_sym_filepos(bfd)	(coff_data(bfd)->sym_filepos)

#define obj_relocbase(bfd)	(coff_data(bfd)->relocbase)
#define obj_raw_syments(bfd)	(coff_data(bfd)->raw_syments)
#define obj_raw_syment_count(bfd)	(coff_data(bfd)->raw_syment_count)
#define obj_convert(bfd)	(coff_data(bfd)->conversion_table)
#define obj_conv_table_size(bfd) (coff_data(bfd)->conv_table_size)

#define obj_coff_external_syms(bfd) (coff_data (bfd)->external_syms)
#define obj_coff_keep_syms(bfd)	(coff_data (bfd)->keep_syms)
#define obj_coff_strings(bfd)	(coff_data (bfd)->strings)
#define obj_coff_keep_strings(bfd) (coff_data (bfd)->keep_strings)
#define obj_coff_sym_hashes(bfd) (coff_data (bfd)->sym_hashes)

/* `Tdata' information kept for COFF files.  */

typedef struct coff_tdata
{
  struct   coff_symbol_struct *symbols;	/* symtab for input bfd */
  unsigned int *conversion_table;
  int conv_table_size;
  file_ptr sym_filepos;

  struct coff_ptr_struct *raw_syments;
  unsigned int raw_syment_count;

  /* These are only valid once writing has begun */
  long int relocbase;

  /* These members communicate important constants about the symbol table
     to GDB's symbol-reading code.  These `constants' unfortunately vary
     from coff implementation to implementation...  */
  unsigned local_n_btmask;
  unsigned local_n_btshft;
  unsigned local_n_tmask;
  unsigned local_n_tshift;
  unsigned local_symesz;
  unsigned local_auxesz;
  unsigned local_linesz;

  /* The unswapped external symbols.  May be NULL.  Read by
     _bfd_coff_get_external_symbols.  */
  PTR external_syms;
  /* If this is true, the external_syms may not be freed.  */
  boolean keep_syms;

  /* The string table.  May be NULL.  Read by
     _bfd_coff_read_string_table.  */
  char *strings;
  /* If this is true, the strings may not be freed.  */
  boolean keep_strings;

  /* is this a PE format coff file */
  int pe;
  /* Used by the COFF backend linker.  */
  struct coff_link_hash_entry **sym_hashes;

  struct bfd_link_info *link_info;
} coff_data_type;

/* Tdata for pe image files. */
typedef struct pe_tdata
{
  coff_data_type coff;
  struct internal_extra_pe_aouthdr pe_opthdr;
  int dll;
  int has_reloc_section;
} pe_data_type;

#define pe_data(bfd)		((bfd)->tdata.pe_obj_data)

/* Tdata for XCOFF files.  */

struct xcoff_tdata
{
  /* Basic COFF information.  */
  coff_data_type coff;

  /* TOC value.  */
  bfd_vma toc;

  /* .text alignment from optional header.  */
  int text_align_power;

  /* .data alignment from optional header.  */
  int data_align_power;

  /* modtype from optional header.  */
  short modtype;

  /* maxdata from optional header.  */
  bfd_size_type maxdata;

  /* maxstack from optional header.  */
  bfd_size_type maxstack;
};

#define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)

/* We take the address of the first element of a asymbol to ensure that the
 * macro is only ever applied to an asymbol.  */
#define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))

/* The used_by_bfd field of a section may be set to a pointer to this
   structure.  */

struct coff_section_tdata
{
  /* The relocs, swapped into COFF internal form.  This may be NULL.  */
  struct internal_reloc *relocs;
  /* If this is true, the relocs entry may not be freed.  */
  boolean keep_relocs;
  /* The section contents.  This may be NULL.  */
  bfd_byte *contents;
  /* If this is true, the contents entry may not be freed.  */
  boolean keep_contents;
  /* Information cached by coff_find_nearest_line.  */
  bfd_vma offset;
  unsigned int i;
  const char *function;
  int line_base;
  /* Available for individual backends.  */
  PTR tdata;
};

/* An accessor macro for the coff_section_tdata structure.  */
#define coff_section_data(abfd, sec) \
  ((struct coff_section_tdata *) (sec)->used_by_bfd)

/* COFF linker hash table entries.  */

struct coff_link_hash_entry
{
  struct bfd_link_hash_entry root;

  /* Symbol index in output file.  Set to -1 initially.  Set to -2 if
     there is a reloc against this symbol.  */
  long indx;

  /* Symbol type.  */
  unsigned short type;

  /* Symbol class.  */
  unsigned char class;

  /* Number of auxiliary entries.  */
  char numaux;

  /* BFD to take auxiliary entries from.  */
  bfd *auxbfd;

  /* Pointer to array of auxiliary entries, if any.  */
  union internal_auxent *aux;
};

/* COFF linker hash table.  */

struct coff_link_hash_table
{
  struct bfd_link_hash_table root;
};

/* Look up an entry in a COFF linker hash table.  */

#define coff_link_hash_lookup(table, string, create, copy, follow)	\
  ((struct coff_link_hash_entry *)					\
   bfd_link_hash_lookup (&(table)->root, (string), (create),		\
			 (copy), (follow)))

/* Traverse a COFF linker hash table.  */

#define coff_link_hash_traverse(table, func, info)			\
  (bfd_link_hash_traverse						\
   (&(table)->root,							\
    (boolean (*) PARAMS ((struct bfd_link_hash_entry *, PTR))) (func),	\
    (info)))

/* Get the COFF linker hash table from a link_info structure.  */

#define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))

/* Functions in coffgen.c.  */
extern const bfd_target *coff_object_p PARAMS ((bfd *));
extern struct sec *coff_section_from_bfd_index PARAMS ((bfd *, int));
extern long coff_get_symtab_upper_bound PARAMS ((bfd *));
extern long coff_get_symtab PARAMS ((bfd *, asymbol **));
extern int coff_count_linenumbers PARAMS ((bfd *));
extern struct coff_symbol_struct *coff_symbol_from PARAMS ((bfd *, asymbol *));
extern boolean coff_renumber_symbols PARAMS ((bfd *, int *));
extern void coff_mangle_symbols PARAMS ((bfd *));
extern boolean coff_write_symbols PARAMS ((bfd *));
extern boolean coff_write_linenumbers PARAMS ((bfd *));
extern alent *coff_get_lineno PARAMS ((bfd *, asymbol *));
extern asymbol *coff_section_symbol PARAMS ((bfd *, char *));
extern boolean _bfd_coff_get_external_symbols PARAMS ((bfd *));
extern const char *_bfd_coff_read_string_table PARAMS ((bfd *));
extern boolean _bfd_coff_free_symbols PARAMS ((bfd *));
extern struct coff_ptr_struct *coff_get_normalized_symtab PARAMS ((bfd *));
extern long coff_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
extern asymbol *coff_make_empty_symbol PARAMS ((bfd *));
extern void coff_print_symbol PARAMS ((bfd *, PTR filep, asymbol *,
				       bfd_print_symbol_type how));
extern void coff_get_symbol_info PARAMS ((bfd *, asymbol *,
					  symbol_info *ret));
extern asymbol *coff_bfd_make_debug_symbol PARAMS ((bfd *, PTR,
						    unsigned long));
extern boolean coff_find_nearest_line PARAMS ((bfd *,
					       asection *,
					       asymbol **,
					       bfd_vma offset,
					       CONST char **filename_ptr,
					       CONST char **functionname_ptr,
					       unsigned int *line_ptr));
extern int coff_sizeof_headers PARAMS ((bfd *, boolean reloc));
extern boolean bfd_coff_reloc16_relax_section
  PARAMS ((bfd *, asection *, struct bfd_link_info *, boolean *));
extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
  PARAMS ((bfd *, struct bfd_link_info *, struct bfd_link_order *,
	   bfd_byte *, boolean relocateable, asymbol **));
extern bfd_vma bfd_coff_reloc16_get_value PARAMS ((arelent *,
						   struct bfd_link_info *,
						   asection *));
extern void bfd_perform_slip PARAMS ((bfd *abfd, unsigned int slip,
				      asection *input_section,
				      bfd_vma val));

/* Functions in cofflink.c.  */

extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
  PARAMS ((bfd *));
extern const char *_bfd_coff_internal_syment_name
  PARAMS ((bfd *, const struct internal_syment *, char *));
extern boolean _bfd_coff_link_add_symbols
  PARAMS ((bfd *, struct bfd_link_info *));
extern boolean _bfd_coff_final_link
  PARAMS ((bfd *, struct bfd_link_info *));
extern struct internal_reloc *_bfd_coff_read_internal_relocs
  PARAMS ((bfd *, asection *, boolean, bfd_byte *, boolean,
	   struct internal_reloc *));
extern boolean _bfd_coff_generic_relocate_section
  PARAMS ((bfd *, struct bfd_link_info *, bfd *, asection *, bfd_byte *,
	   struct internal_reloc *, struct internal_syment *, asection **));

/* And more taken from the source .. */
Commit	Line	Data
075caafd	1	/* BFD COFF object file private structure.
beee31b1	2	Copyright (C) 1990, 91, 92, 93, 94, 1995 Free Software Foundation, Inc.
075caafd ILT	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
beee31b1	19	Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */
075caafd	20
69645d10	21	#include "bfdlink.h"
075caafd ILT	22
	23	/* Object file tdata; access macros */
	24
	25	#define coff_data(bfd) ((bfd)->tdata.coff_obj_data)
	26	#define exec_hdr(bfd) (coff_data(bfd)->hdr)
beee31b1	27	#define obj_pe(bfd) (coff_data(bfd)->pe)
075caafd ILT	28	#define obj_symbols(bfd) (coff_data(bfd)->symbols)
	29	#define obj_sym_filepos(bfd) (coff_data(bfd)->sym_filepos)
	30
	31	#define obj_relocbase(bfd) (coff_data(bfd)->relocbase)
	32	#define obj_raw_syments(bfd) (coff_data(bfd)->raw_syments)
326e32d7	33	#define obj_raw_syment_count(bfd) (coff_data(bfd)->raw_syment_count)
075caafd ILT	34	#define obj_convert(bfd) (coff_data(bfd)->conversion_table)
075caafd ILT	35	#define obj_conv_table_size(bfd) (coff_data(bfd)->conv_table_size)
075caafd	36
69645d10	37	#define obj_coff_external_syms(bfd) (coff_data (bfd)->external_syms)
beee31b1	38	#define obj_coff_keep_syms(bfd) (coff_data (bfd)->keep_syms)
69645d10	39	#define obj_coff_strings(bfd) (coff_data (bfd)->strings)
beee31b1	40	#define obj_coff_keep_strings(bfd) (coff_data (bfd)->keep_strings)
69645d10	41	#define obj_coff_sym_hashes(bfd) (coff_data (bfd)->sym_hashes)
075caafd ILT	42
	43	/* `Tdata' information kept for COFF files. */
	44
	45	typedef struct coff_tdata
	46	{
	47	struct coff_symbol_struct symbols; / symtab for input bfd */
	48	unsigned int *conversion_table;
	49	int conv_table_size;
	50	file_ptr sym_filepos;
	51
075caafd	52	struct coff_ptr_struct *raw_syments;
075caafd	53	unsigned int raw_syment_count;
075caafd ILT	54
	55	/* These are only valid once writing has begun */
	56	long int relocbase;
	57
	58	/* These members communicate important constants about the symbol table
	59	to GDB's symbol-reading code. These `constants' unfortunately vary
	60	from coff implementation to implementation... */
	61	unsigned local_n_btmask;
	62	unsigned local_n_btshft;
	63	unsigned local_n_tmask;
	64	unsigned local_n_tshift;
	65	unsigned local_symesz;
	66	unsigned local_auxesz;
	67	unsigned local_linesz;
69645d10	68
beee31b1 SC	69	/* The unswapped external symbols. May be NULL. Read by
beee31b1 SC	70	_bfd_coff_get_external_symbols. */
69645d10	71	PTR external_syms;
beee31b1 SC	72	/* If this is true, the external_syms may not be freed. */
	73	boolean keep_syms;
	74
	75	/* The string table. May be NULL. Read by
	76	_bfd_coff_read_string_table. */
69645d10	77	char *strings;
beee31b1 SC	78	/* If this is true, the strings may not be freed. */
	79	boolean keep_strings;
	80
	81	/* is this a PE format coff file */
	82	int pe;
	83	/* Used by the COFF backend linker. */
69645d10	84	struct coff_link_hash_entry **sym_hashes;
beee31b1 SC	85
beee31b1 SC	86	struct bfd_link_info *link_info;
075caafd ILT	87	} coff_data_type;
075caafd ILT	88
beee31b1 SC	89	/* Tdata for pe image files. */
	90	typedef struct pe_tdata
	91	{
	92	coff_data_type coff;
	93	struct internal_extra_pe_aouthdr pe_opthdr;
	94	int dll;
	95	int has_reloc_section;
	96	} pe_data_type;
	97
	98	#define pe_data(bfd) ((bfd)->tdata.pe_obj_data)
	99
5f710a3a ILT	100	/* Tdata for XCOFF files. */
	101
	102	struct xcoff_tdata
	103	{
	104	/* Basic COFF information. */
	105	coff_data_type coff;
	106
	107	/* TOC value. */
	108	bfd_vma toc;
	109
	110	/* .text alignment from optional header. */
	111	int text_align_power;
	112
	113	/* .data alignment from optional header. */
	114	int data_align_power;
	115
	116	/* modtype from optional header. */
	117	short modtype;
	118
	119	/* maxdata from optional header. */
	120	bfd_size_type maxdata;
	121
	122	/* maxstack from optional header. */
	123	bfd_size_type maxstack;
	124	};
	125
	126	#define xcoff_data(abfd) ((abfd)->tdata.xcoff_obj_data)
beee31b1	127
075caafd ILT	128	/* We take the address of the first element of a asymbol to ensure that the
	129	* macro is only ever applied to an asymbol. */
	130	#define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
	131
beee31b1 SC	132	/* The used_by_bfd field of a section may be set to a pointer to this
	133	structure. */
	134
	135	struct coff_section_tdata
	136	{
	137	/* The relocs, swapped into COFF internal form. This may be NULL. */
	138	struct internal_reloc *relocs;
	139	/* If this is true, the relocs entry may not be freed. */
	140	boolean keep_relocs;
	141	/* The section contents. This may be NULL. */
	142	bfd_byte *contents;
	143	/* If this is true, the contents entry may not be freed. */
	144	boolean keep_contents;
5f710a3a ILT	145	/* Information cached by coff_find_nearest_line. */
	146	bfd_vma offset;
	147	unsigned int i;
	148	const char *function;
	149	int line_base;
a208a70f ILT	150	/* Available for individual backends. */
a208a70f ILT	151	PTR tdata;
beee31b1 SC	152	};
	153
	154	/* An accessor macro for the coff_section_tdata structure. */
	155	#define coff_section_data(abfd, sec) \
	156	((struct coff_section_tdata *) (sec)->used_by_bfd)
	157
69645d10 ILT	158	/* COFF linker hash table entries. */
	159
	160	struct coff_link_hash_entry
	161	{
	162	struct bfd_link_hash_entry root;
	163
	164	/* Symbol index in output file. Set to -1 initially. Set to -2 if
	165	there is a reloc against this symbol. */
	166	long indx;
	167
	168	/* Symbol type. */
	169	unsigned short type;
	170
	171	/* Symbol class. */
	172	unsigned char class;
	173
	174	/* Number of auxiliary entries. */
	175	char numaux;
	176
	177	/* BFD to take auxiliary entries from. */
	178	bfd *auxbfd;
	179
	180	/* Pointer to array of auxiliary entries, if any. */
	181	union internal_auxent *aux;
	182	};
	183
	184	/* COFF linker hash table. */
	185
	186	struct coff_link_hash_table
	187	{
	188	struct bfd_link_hash_table root;
	189	};
	190
	191	/* Look up an entry in a COFF linker hash table. */
	192
	193	#define coff_link_hash_lookup(table, string, create, copy, follow) \
	194	((struct coff_link_hash_entry *) \
	195	bfd_link_hash_lookup (&(table)->root, (string), (create), \
	196	(copy), (follow)))
	197
	198	/* Traverse a COFF linker hash table. */
	199
	200	#define coff_link_hash_traverse(table, func, info) \
	201	(bfd_link_hash_traverse \
	202	(&(table)->root, \
	203	(boolean () PARAMS ((struct bfd_link_hash_entry , PTR))) (func), \
	204	(info)))
	205
	206	/* Get the COFF linker hash table from a link_info structure. */
	207
	208	#define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
	209
075caafd	210	/* Functions in coffgen.c. */
69645d10	211	extern const bfd_target coff_object_p PARAMS ((bfd ));
075caafd	212	extern struct sec coff_section_from_bfd_index PARAMS ((bfd , int));
326e32d7 ILT	213	extern long coff_get_symtab_upper_bound PARAMS ((bfd *));
	214	extern long coff_get_symtab PARAMS ((bfd , asymbol *));
	215	extern int coff_count_linenumbers PARAMS ((bfd *));
075caafd	216	extern struct coff_symbol_struct coff_symbol_from PARAMS ((bfd , asymbol *));
beee31b1	217	extern boolean coff_renumber_symbols PARAMS ((bfd , int ));
075caafd	218	extern void coff_mangle_symbols PARAMS ((bfd *));
69645d10	219	extern boolean coff_write_symbols PARAMS ((bfd *));
326e32d7	220	extern boolean coff_write_linenumbers PARAMS ((bfd *));
075caafd ILT	221	extern alent coff_get_lineno PARAMS ((bfd , asymbol *));
075caafd ILT	222	extern asymbol coff_section_symbol PARAMS ((bfd , char *));
beee31b1 SC	223	extern boolean _bfd_coff_get_external_symbols PARAMS ((bfd *));
	224	extern const char _bfd_coff_read_string_table PARAMS ((bfd ));
	225	extern boolean _bfd_coff_free_symbols PARAMS ((bfd *));
075caafd	226	extern struct coff_ptr_struct coff_get_normalized_symtab PARAMS ((bfd ));
326e32d7	227	extern long coff_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
075caafd ILT	228	extern asymbol coff_make_empty_symbol PARAMS ((bfd ));
	229	extern void coff_print_symbol PARAMS ((bfd , PTR filep, asymbol ,
	230	bfd_print_symbol_type how));
326e32d7 ILT	231	extern void coff_get_symbol_info PARAMS ((bfd , asymbol ,
	232	symbol_info *ret));
	233	extern asymbol coff_bfd_make_debug_symbol PARAMS ((bfd , PTR,
	234	unsigned long));
075caafd ILT	235	extern boolean coff_find_nearest_line PARAMS ((bfd *,
	236	asection *,
	237	asymbol **,
	238	bfd_vma offset,
	239	CONST char **filename_ptr,
	240	CONST char **functionname_ptr,
	241	unsigned int *line_ptr));
	242	extern int coff_sizeof_headers PARAMS ((bfd *, boolean reloc));
326e32d7 ILT	243	extern boolean bfd_coff_reloc16_relax_section
326e32d7 ILT	244	PARAMS ((bfd , asection , struct bfd_link_info , boolean ));
075caafd	245	extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
326e32d7 ILT	246	PARAMS ((bfd , struct bfd_link_info , struct bfd_link_order *,
326e32d7 ILT	247	bfd_byte , boolean relocateable, asymbol *));
075caafd	248	extern bfd_vma bfd_coff_reloc16_get_value PARAMS ((arelent *,
326e32d7 ILT	249	struct bfd_link_info *,
	250	asection *));
	251	extern void bfd_perform_slip PARAMS ((bfd *abfd, unsigned int slip,
	252	asection *input_section,
	253	bfd_vma val));
075caafd	254
69645d10 ILT	255	/* Functions in cofflink.c. */
	256
	257	extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
	258	PARAMS ((bfd *));
a208a70f ILT	259	extern const char *_bfd_coff_internal_syment_name
a208a70f ILT	260	PARAMS ((bfd , const struct internal_syment , char *));
69645d10 ILT	261	extern boolean _bfd_coff_link_add_symbols
	262	PARAMS ((bfd , struct bfd_link_info ));
	263	extern boolean _bfd_coff_final_link
	264	PARAMS ((bfd , struct bfd_link_info ));
beee31b1 SC	265	extern struct internal_reloc *_bfd_coff_read_internal_relocs
	266	PARAMS ((bfd , asection , boolean, bfd_byte *, boolean,
	267	struct internal_reloc *));
	268	extern boolean _bfd_coff_generic_relocate_section
	269	PARAMS ((bfd , struct bfd_link_info , bfd , asection , bfd_byte *,
	270	struct internal_reloc , struct internal_syment , asection **));
69645d10	271
075caafd ILT	272	/* And more taken from the source .. */
075caafd ILT	273