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

/* BFD COFF object file private structure.
   Copyright (C) 1990, 1991, 1992, 1993, 1994 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., 675 Mass Ave, Cambridge, MA 02139, 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_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_strings(bfd)	(coff_data (bfd)->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;

  /* Used by the COFF backend linker.  */
  PTR external_syms;
  char *strings;
  struct coff_link_hash_entry **sym_hashes;
} coff_data_type;

/* 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)))

/* 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 *));
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 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 boolean _bfd_coff_link_add_symbols
  PARAMS ((bfd *, struct bfd_link_info *));
extern boolean _bfd_coff_final_link
  PARAMS ((bfd *, struct bfd_link_info *));

/* And more taken from the source .. */
Commit	Line	Data
075caafd	1	/* BFD COFF object file private structure.
326e32d7	2	Copyright (C) 1990, 1991, 1992, 1993, 1994 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
	19	Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
	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)
	27	#define obj_symbols(bfd) (coff_data(bfd)->symbols)
	28	#define obj_sym_filepos(bfd) (coff_data(bfd)->sym_filepos)
	29
	30	#define obj_relocbase(bfd) (coff_data(bfd)->relocbase)
	31	#define obj_raw_syments(bfd) (coff_data(bfd)->raw_syments)
326e32d7	32	#define obj_raw_syment_count(bfd) (coff_data(bfd)->raw_syment_count)
075caafd ILT	33	#define obj_convert(bfd) (coff_data(bfd)->conversion_table)
075caafd ILT	34	#define obj_conv_table_size(bfd) (coff_data(bfd)->conv_table_size)
075caafd	35
69645d10 ILT	36	#define obj_coff_external_syms(bfd) (coff_data (bfd)->external_syms)
	37	#define obj_coff_strings(bfd) (coff_data (bfd)->strings)
	38	#define obj_coff_sym_hashes(bfd) (coff_data (bfd)->sym_hashes)
075caafd ILT	39
	40	/* `Tdata' information kept for COFF files. */
	41
	42	typedef struct coff_tdata
	43	{
	44	struct coff_symbol_struct symbols; / symtab for input bfd */
	45	unsigned int *conversion_table;
	46	int conv_table_size;
	47	file_ptr sym_filepos;
	48
075caafd	49	struct coff_ptr_struct *raw_syments;
075caafd	50	unsigned int raw_syment_count;
075caafd ILT	51
	52	/* These are only valid once writing has begun */
	53	long int relocbase;
	54
	55	/* These members communicate important constants about the symbol table
	56	to GDB's symbol-reading code. These `constants' unfortunately vary
	57	from coff implementation to implementation... */
	58	unsigned local_n_btmask;
	59	unsigned local_n_btshft;
	60	unsigned local_n_tmask;
	61	unsigned local_n_tshift;
	62	unsigned local_symesz;
	63	unsigned local_auxesz;
	64	unsigned local_linesz;
69645d10 ILT	65
	66	/* Used by the COFF backend linker. */
	67	PTR external_syms;
	68	char *strings;
	69	struct coff_link_hash_entry **sym_hashes;
075caafd ILT	70	} coff_data_type;
	71
	72	/* We take the address of the first element of a asymbol to ensure that the
	73	* macro is only ever applied to an asymbol. */
	74	#define coffsymbol(asymbol) ((coff_symbol_type *)(&((asymbol)->the_bfd)))
	75
69645d10 ILT	76	/* COFF linker hash table entries. */
	77
	78	struct coff_link_hash_entry
	79	{
	80	struct bfd_link_hash_entry root;
	81
	82	/* Symbol index in output file. Set to -1 initially. Set to -2 if
	83	there is a reloc against this symbol. */
	84	long indx;
	85
	86	/* Symbol type. */
	87	unsigned short type;
	88
	89	/* Symbol class. */
	90	unsigned char class;
	91
	92	/* Number of auxiliary entries. */
	93	char numaux;
	94
	95	/* BFD to take auxiliary entries from. */
	96	bfd *auxbfd;
	97
	98	/* Pointer to array of auxiliary entries, if any. */
	99	union internal_auxent *aux;
	100	};
	101
	102	/* COFF linker hash table. */
	103
	104	struct coff_link_hash_table
	105	{
	106	struct bfd_link_hash_table root;
	107	};
	108
	109	/* Look up an entry in a COFF linker hash table. */
	110
	111	#define coff_link_hash_lookup(table, string, create, copy, follow) \
	112	((struct coff_link_hash_entry *) \
	113	bfd_link_hash_lookup (&(table)->root, (string), (create), \
	114	(copy), (follow)))
	115
	116	/* Traverse a COFF linker hash table. */
	117
	118	#define coff_link_hash_traverse(table, func, info) \
	119	(bfd_link_hash_traverse \
	120	(&(table)->root, \
	121	(boolean () PARAMS ((struct bfd_link_hash_entry , PTR))) (func), \
	122	(info)))
	123
	124	/* Get the COFF linker hash table from a link_info structure. */
	125
	126	#define coff_hash_table(p) ((struct coff_link_hash_table *) ((p)->hash))
	127
075caafd	128	/* Functions in coffgen.c. */
69645d10	129	extern const bfd_target coff_object_p PARAMS ((bfd ));
075caafd	130	extern struct sec coff_section_from_bfd_index PARAMS ((bfd , int));
326e32d7 ILT	131	extern long coff_get_symtab_upper_bound PARAMS ((bfd *));
	132	extern long coff_get_symtab PARAMS ((bfd , asymbol *));
	133	extern int coff_count_linenumbers PARAMS ((bfd *));
075caafd	134	extern struct coff_symbol_struct coff_symbol_from PARAMS ((bfd , asymbol *));
326e32d7	135	extern boolean coff_renumber_symbols PARAMS ((bfd *));
075caafd	136	extern void coff_mangle_symbols PARAMS ((bfd *));
69645d10	137	extern boolean coff_write_symbols PARAMS ((bfd *));
326e32d7	138	extern boolean coff_write_linenumbers PARAMS ((bfd *));
075caafd ILT	139	extern alent coff_get_lineno PARAMS ((bfd , asymbol *));
	140	extern asymbol coff_section_symbol PARAMS ((bfd , char *));
	141	extern struct coff_ptr_struct coff_get_normalized_symtab PARAMS ((bfd ));
326e32d7	142	extern long coff_get_reloc_upper_bound PARAMS ((bfd *, sec_ptr));
075caafd ILT	143	extern asymbol coff_make_empty_symbol PARAMS ((bfd ));
	144	extern void coff_print_symbol PARAMS ((bfd , PTR filep, asymbol ,
	145	bfd_print_symbol_type how));
326e32d7 ILT	146	extern void coff_get_symbol_info PARAMS ((bfd , asymbol ,
	147	symbol_info *ret));
	148	extern asymbol coff_bfd_make_debug_symbol PARAMS ((bfd , PTR,
	149	unsigned long));
075caafd ILT	150	extern boolean coff_find_nearest_line PARAMS ((bfd *,
	151	asection *,
	152	asymbol **,
	153	bfd_vma offset,
	154	CONST char **filename_ptr,
	155	CONST char **functionname_ptr,
	156	unsigned int *line_ptr));
	157	extern int coff_sizeof_headers PARAMS ((bfd *, boolean reloc));
326e32d7 ILT	158	extern boolean bfd_coff_reloc16_relax_section
326e32d7 ILT	159	PARAMS ((bfd , asection , struct bfd_link_info , boolean ));
075caafd	160	extern bfd_byte *bfd_coff_reloc16_get_relocated_section_contents
326e32d7 ILT	161	PARAMS ((bfd , struct bfd_link_info , struct bfd_link_order *,
326e32d7 ILT	162	bfd_byte , boolean relocateable, asymbol *));
075caafd	163	extern bfd_vma bfd_coff_reloc16_get_value PARAMS ((arelent *,
326e32d7 ILT	164	struct bfd_link_info *,
	165	asection *));
	166	extern void bfd_perform_slip PARAMS ((bfd *abfd, unsigned int slip,
	167	asection *input_section,
	168	bfd_vma val));
075caafd	169
69645d10 ILT	170	/* Functions in cofflink.c. */
	171
	172	extern struct bfd_link_hash_table *_bfd_coff_link_hash_table_create
	173	PARAMS ((bfd *));
	174	extern boolean _bfd_coff_link_add_symbols
	175	PARAMS ((bfd , struct bfd_link_info ));
	176	extern boolean _bfd_coff_final_link
	177	PARAMS ((bfd , struct bfd_link_info ));
	178
075caafd ILT	179	/* And more taken from the source .. */
075caafd ILT	180