[deliverable/binutils-gdb.git] / bfd / libnlm.h

/* BFD back-end data structures for NLM (NetWare Loadable Modules) files.
   Copyright (C) 1993 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.  */

#ifndef _LIBNLM_H_
#define _LIBNLM_H_ 1

#ifdef ARCH_SIZE
#  define NLM_ARCH_SIZE ARCH_SIZE
#endif
#include "nlm/common.h"
#include "nlm/internal.h"
#include "nlm/external.h"

/* A reloc for an imported NLM symbol.  Normal relocs are associated
   with sections, and include a symbol.  These relocs are associated
   with (undefined) symbols, and include a section.  */

struct nlm_relent
{
  /* Section of reloc.  */
  asection *section;
  /* Reloc info (sym_ptr_ptr field set only when canonicalized).  */
  arelent reloc;
};

/* Information we keep for an NLM symbol.  */

typedef struct
{
  /* BFD symbol.  */
  asymbol symbol;
  /* Number of reloc entries for imported symbol.  */
  bfd_size_type rcnt;
  /* Array of reloc information for imported symbol.  */
  struct nlm_relent *relocs;
} nlmNAME(symbol_type);

extern boolean nlm_mkobject PARAMS ((bfd *));
extern boolean nlm_set_arch_mach PARAMS ((bfd *, enum bfd_architecture,
					  unsigned long));

extern void nlmNAME(get_symbol_info)
     PARAMS ((bfd *, asymbol *, symbol_info *));
extern unsigned int nlmNAME(get_symtab_upper_bound)
     PARAMS ((bfd *));
extern unsigned int nlmNAME(get_symtab)
     PARAMS ((bfd *, asymbol **));
extern asymbol *nlmNAME(make_empty_symbol)
     PARAMS ((bfd *));
extern void nlmNAME(print_symbol)
     PARAMS ((bfd *, PTR, asymbol *, bfd_print_symbol_type));
extern unsigned int nlmNAME(get_reloc_upper_bound)
     PARAMS ((bfd *, asection *));
extern unsigned int nlmNAME(canonicalize_reloc)
     PARAMS ((bfd *, asection *, arelent **, asymbol **));
extern bfd_target *nlmNAME(object_p)
     PARAMS ((bfd *));
extern boolean nlmNAME(set_arch_mach)
     PARAMS ((bfd *, enum bfd_architecture, unsigned long));
extern boolean nlmNAME(set_section_contents)
     PARAMS ((bfd *, asection *, PTR, file_ptr, bfd_size_type));
extern boolean nlmNAME(write_object_contents)
     PARAMS ((bfd *));

/* Some private data is stashed away for future use using the tdata pointer
   in the bfd structure.  */

struct nlm_obj_tdata
{
  /* Actual data, but ref like ptr */
  Nlm_Internal_Fixed_Header	nlm_fixed_hdr[1];
  Nlm_Internal_Variable_Header	nlm_variable_hdr[1];
  Nlm_Internal_Version_Header	nlm_version_hdr[1];
  Nlm_Internal_Copyright_Header	nlm_copyright_hdr[1];
  Nlm_Internal_Extended_Header	nlm_extended_hdr[1];
  Nlm_Internal_Custom_Header	nlm_custom_hdr[1];
  /* BFD NLM symbols.  */
  nlmNAME(symbol_type)		*nlm_symbols;
  /* Lowest text and data VMA values.  */
  bfd_vma			nlm_text_low;
  bfd_vma			nlm_data_low;
  /* Caches for data read from object file.  */
  arelent *			nlm_reloc_fixups;
  asection **			nlm_reloc_fixup_secs;
};

#define nlm_tdata(bfd)			((bfd) -> tdata.nlm_obj_data)
#define nlm_fixed_header(bfd)		(nlm_tdata(bfd) -> nlm_fixed_hdr)
#define nlm_variable_header(bfd)	(nlm_tdata(bfd) -> nlm_variable_hdr)
#define nlm_version_header(bfd)		(nlm_tdata(bfd) -> nlm_version_hdr)
#define nlm_copyright_header(bfd)	(nlm_tdata(bfd) -> nlm_copyright_hdr)
#define nlm_extended_header(bfd)	(nlm_tdata(bfd) -> nlm_extended_hdr)
#define nlm_custom_header(bfd)		(nlm_tdata(bfd) -> nlm_custom_hdr)
#define nlm_get_symbols(bfd)		(nlm_tdata(bfd) -> nlm_symbols)
#define nlm_set_symbols(bfd, p)		(nlm_tdata(bfd) -> nlm_symbols = (p))
#define nlm_set_text_low(bfd, i)	(nlm_tdata(bfd) -> nlm_text_low = (i))
#define nlm_get_text_low(bfd)		(nlm_tdata(bfd) -> nlm_text_low)
#define nlm_set_data_low(bfd, i)	(nlm_tdata(bfd) -> nlm_data_low = (i))
#define nlm_get_data_low(bfd)		(nlm_tdata(bfd) -> nlm_data_low)
#define nlm_relocation_fixups(bfd)	(nlm_tdata(bfd) -> nlm_reloc_fixups)
#define nlm_relocation_fixup_secs(bfd)	(nlm_tdata(bfd)->nlm_reloc_fixup_secs)

/* We store some function pointer in the backend structure.  This lets
   different NLM targets share most of the same code, while providing
   slightly different code where necessary.  */

struct nlm_backend_data
{
  /* Machine architecture.  */
  enum bfd_architecture arch;
  /* Read a relocation fixup from abfd.  The reloc information is
     machine specific.  The second argument is the symbol if this is
     an import, or NULL if this is a reloc fixup.  This function
     should set the third argument to the section which the reloc
     belongs in, and the fourth argument to the reloc itself; it does
     not need to fill in the sym_ptr_ptr field for a reloc against an
     import symbol.  */
  boolean (*nlm_read_reloc) PARAMS ((bfd *, nlmNAME(symbol_type) *,
				     asection **, arelent *));
  /* Write a relocation fixup to abfd.  */
  boolean (*nlm_write_reloc) PARAMS ((bfd *, asection *, arelent *));
  /* To make objcopy to an i386 NLM work, the i386 backend needs a
     chance to work over the relocs.  This is a bit icky.  */
  boolean (*nlm_mangle_relocs) PARAMS ((bfd *, asection *, PTR data,
					bfd_vma offset,
					bfd_size_type count));
};

#define nlm_backend(bfd) \
  ((struct nlm_backend_data *)((bfd) -> xvec -> backend_data))
#define nlm_architecture(bfd) \
  (nlm_backend(bfd) ? nlm_backend(bfd) -> arch : bfd_arch_unknown)
#define nlm_read_reloc_func(bfd) \
  (nlm_backend(bfd) ? nlm_backend(bfd) -> nlm_read_reloc : 0)
#define nlm_write_reloc_func(bfd) \
  (nlm_backend(bfd) ? nlm_backend(bfd) -> nlm_write_reloc : 0)
#define nlm_mangle_relocs_func(bfd) \
  (nlm_backend(bfd) ? nlm_backend(bfd) -> nlm_mangle_relocs : 0)

/* The NLM code, data, and uninitialized sections have no names defined
   in the NLM, but bfd wants to give them names, so use the traditional
   UNIX names.  */

#define NLM_CODE_NAME			".text"
#define NLM_INITIALIZED_DATA_NAME	".data"
#define NLM_UNINITIALIZED_DATA_NAME	".bss"

#endif /* _LIBNLM_H_ */
Commit	Line	Data
c3e964b9 FF	1	/* BFD back-end data structures for NLM (NetWare Loadable Modules) files.
	2	Copyright (C) 1993 Free Software Foundation, Inc.
	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
	21	#ifndef _LIBNLM_H_
	22	#define _LIBNLM_H_ 1
	23
7389debf ILT	24	#ifdef ARCH_SIZE
	25	# define NLM_ARCH_SIZE ARCH_SIZE
	26	#endif
c3e964b9 FF	27	#include "nlm/common.h"
	28	#include "nlm/internal.h"
	29	#include "nlm/external.h"
	30
7389debf ILT	31	/* A reloc for an imported NLM symbol. Normal relocs are associated
	32	with sections, and include a symbol. These relocs are associated
	33	with (undefined) symbols, and include a section. */
c3e964b9	34
7389debf	35	struct nlm_relent
c3e964b9	36	{
7389debf ILT	37	/* Section of reloc. */
	38	asection *section;
	39	/* Reloc info (sym_ptr_ptr field set only when canonicalized). */
	40	arelent reloc;
	41	};
	42
	43	/* Information we keep for an NLM symbol. */
c3e964b9 FF	44
	45	typedef struct
	46	{
7389debf	47	/* BFD symbol. */
c3e964b9	48	asymbol symbol;
7389debf ILT	49	/* Number of reloc entries for imported symbol. */
	50	bfd_size_type rcnt;
	51	/* Array of reloc information for imported symbol. */
	52	struct nlm_relent *relocs;
	53	} nlmNAME(symbol_type);
	54
	55	extern boolean nlm_mkobject PARAMS ((bfd *));
	56	extern boolean nlm_set_arch_mach PARAMS ((bfd *, enum bfd_architecture,
	57	unsigned long));
	58
	59	extern void nlmNAME(get_symbol_info)
	60	PARAMS ((bfd , asymbol , symbol_info *));
	61	extern unsigned int nlmNAME(get_symtab_upper_bound)
	62	PARAMS ((bfd *));
	63	extern unsigned int nlmNAME(get_symtab)
	64	PARAMS ((bfd , asymbol *));
	65	extern asymbol *nlmNAME(make_empty_symbol)
	66	PARAMS ((bfd *));
	67	extern void nlmNAME(print_symbol)
	68	PARAMS ((bfd , PTR, asymbol , bfd_print_symbol_type));
	69	extern unsigned int nlmNAME(get_reloc_upper_bound)
	70	PARAMS ((bfd , asection ));
	71	extern unsigned int nlmNAME(canonicalize_reloc)
	72	PARAMS ((bfd , asection , arelent , asymbol ));
	73	extern bfd_target *nlmNAME(object_p)
	74	PARAMS ((bfd *));
	75	extern boolean nlmNAME(set_arch_mach)
	76	PARAMS ((bfd *, enum bfd_architecture, unsigned long));
	77	extern boolean nlmNAME(set_section_contents)
	78	PARAMS ((bfd , asection , PTR, file_ptr, bfd_size_type));
	79	extern boolean nlmNAME(write_object_contents)
	80	PARAMS ((bfd *));
c3e964b9 FF	81
	82	/* Some private data is stashed away for future use using the tdata pointer
	83	in the bfd structure. */
	84
	85	struct nlm_obj_tdata
	86	{
	87	/* Actual data, but ref like ptr */
f03b1f0d FF	88	Nlm_Internal_Fixed_Header nlm_fixed_hdr[1];
	89	Nlm_Internal_Variable_Header nlm_variable_hdr[1];
	90	Nlm_Internal_Version_Header nlm_version_hdr[1];
	91	Nlm_Internal_Copyright_Header nlm_copyright_hdr[1];
	92	Nlm_Internal_Extended_Header nlm_extended_hdr[1];
	93	Nlm_Internal_Custom_Header nlm_custom_hdr[1];
7389debf ILT	94	/* BFD NLM symbols. */
	95	nlmNAME(symbol_type) *nlm_symbols;
	96	/* Lowest text and data VMA values. */
	97	bfd_vma nlm_text_low;
	98	bfd_vma nlm_data_low;
	99	/* Caches for data read from object file. */
	100	arelent * nlm_reloc_fixups;
	101	asection ** nlm_reloc_fixup_secs;
c3e964b9 FF	102	};
	103
	104	#define nlm_tdata(bfd) ((bfd) -> tdata.nlm_obj_data)
f03b1f0d FF	105	#define nlm_fixed_header(bfd) (nlm_tdata(bfd) -> nlm_fixed_hdr)
	106	#define nlm_variable_header(bfd) (nlm_tdata(bfd) -> nlm_variable_hdr)
	107	#define nlm_version_header(bfd) (nlm_tdata(bfd) -> nlm_version_hdr)
	108	#define nlm_copyright_header(bfd) (nlm_tdata(bfd) -> nlm_copyright_hdr)
	109	#define nlm_extended_header(bfd) (nlm_tdata(bfd) -> nlm_extended_hdr)
	110	#define nlm_custom_header(bfd) (nlm_tdata(bfd) -> nlm_custom_hdr)
7389debf ILT	111	#define nlm_get_symbols(bfd) (nlm_tdata(bfd) -> nlm_symbols)
	112	#define nlm_set_symbols(bfd, p) (nlm_tdata(bfd) -> nlm_symbols = (p))
	113	#define nlm_set_text_low(bfd, i) (nlm_tdata(bfd) -> nlm_text_low = (i))
	114	#define nlm_get_text_low(bfd) (nlm_tdata(bfd) -> nlm_text_low)
	115	#define nlm_set_data_low(bfd, i) (nlm_tdata(bfd) -> nlm_data_low = (i))
	116	#define nlm_get_data_low(bfd) (nlm_tdata(bfd) -> nlm_data_low)
	117	#define nlm_relocation_fixups(bfd) (nlm_tdata(bfd) -> nlm_reloc_fixups)
	118	#define nlm_relocation_fixup_secs(bfd) (nlm_tdata(bfd)->nlm_reloc_fixup_secs)
	119
	120	/* We store some function pointer in the backend structure. This lets
	121	different NLM targets share most of the same code, while providing
	122	slightly different code where necessary. */
	123
	124	struct nlm_backend_data
	125	{
	126	/* Machine architecture. */
	127	enum bfd_architecture arch;
	128	/* Read a relocation fixup from abfd. The reloc information is
	129	machine specific. The second argument is the symbol if this is
	130	an import, or NULL if this is a reloc fixup. This function
	131	should set the third argument to the section which the reloc
	132	belongs in, and the fourth argument to the reloc itself; it does
	133	not need to fill in the sym_ptr_ptr field for a reloc against an
	134	import symbol. */
	135	boolean (nlm_read_reloc) PARAMS ((bfd , nlmNAME(symbol_type) *,
	136	asection *, arelent ));
	137	/* Write a relocation fixup to abfd. */
	138	boolean (nlm_write_reloc) PARAMS ((bfd , asection , arelent ));
	139	/* To make objcopy to an i386 NLM work, the i386 backend needs a
	140	chance to work over the relocs. This is a bit icky. */
	141	boolean (nlm_mangle_relocs) PARAMS ((bfd , asection *, PTR data,
	142	bfd_vma offset,
	143	bfd_size_type count));
	144	};
	145
	146	#define nlm_backend(bfd) \
	147	((struct nlm_backend_data *)((bfd) -> xvec -> backend_data))
	148	#define nlm_architecture(bfd) \
	149	(nlm_backend(bfd) ? nlm_backend(bfd) -> arch : bfd_arch_unknown)
	150	#define nlm_read_reloc_func(bfd) \
	151	(nlm_backend(bfd) ? nlm_backend(bfd) -> nlm_read_reloc : 0)
	152	#define nlm_write_reloc_func(bfd) \
	153	(nlm_backend(bfd) ? nlm_backend(bfd) -> nlm_write_reloc : 0)
	154	#define nlm_mangle_relocs_func(bfd) \
	155	(nlm_backend(bfd) ? nlm_backend(bfd) -> nlm_mangle_relocs : 0)
c3e964b9 FF	156
	157	/* The NLM code, data, and uninitialized sections have no names defined
	158	in the NLM, but bfd wants to give them names, so use the traditional
	159	UNIX names. */
	160
	161	#define NLM_CODE_NAME ".text"
	162	#define NLM_INITIALIZED_DATA_NAME ".data"
	163	#define NLM_UNINITIALIZED_DATA_NAME ".bss"
	164
	165	#endif /* _LIBNLM_H_ */