/* DO NOT EDIT!  -*- buffer-read-only: t -*-  This file is automatically 

   generated from "bfd-in.h", "init.c", "opncls.c", "libbfd.c", 

   "bfdio.c", "bfdwin.c", "section.c", "archures.c", "reloc.c", 

   "syms.c", "bfd.c", "archive.c", "corefile.c", "targets.c", "format.c", 

   "linker.c" and "simple.c".

   Run "make headers" in your build bfd/ to regenerate.  */

/* Main header file for the bfd library -- portable access to object files.

   Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,

   1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007

   Free Software Foundation, Inc.

   Contributed 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 3 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., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */

#ifndef __BFD_H_SEEN__

#define __BFD_H_SEEN__

#ifdef __cplusplus

extern "C" {

#endif

#include "ansidecl.h"

#include "symcat.h"

#if defined (__STDC__) || defined (ALMOST_STDC) || defined (HAVE_STRINGIZE)

#ifndef SABER

/* This hack is to avoid a problem with some strict ANSI C preprocessors.

   The problem is, "32_" is not a valid preprocessing token, and we don't

   want extra underscores (e.g., "nlm_32_").  The XCONCAT2 macro will

   cause the inner CONCAT2 macros to be evaluated first, producing

   still-valid pp-tokens.  Then the final concatenation can be done.  */

#undef CONCAT4

#define CONCAT4(a,b,c,d) XCONCAT2(CONCAT2(a,b),CONCAT2(c,d))

#endif

#endif

/* This is a utility macro to handle the situation where the code

   wants to place a constant string into the code, followed by a

   comma and then the length of the string.  Doing this by hand

   is error prone, so using this macro is safer.  */

#define STRING_COMMA_LEN(STR) (STR), (sizeof (STR) - 1)

/* Unfortunately it is not possible to use the STRING_COMMA_LEN macro

   to create the arguments to another macro, since the preprocessor

   will mis-count the number of arguments to the outer macro (by not

   evaluating STRING_COMMA_LEN and so missing the comma).  This is a

   problem for example when trying to use STRING_COMMA_LEN to build

   the arguments to the strncmp() macro.  Hence this alternative

   definition of strncmp is provided here.

   Note - these macros do NOT work if STR2 is not a constant string.  */

#define CONST_STRNEQ(STR1,STR2) (strncmp ((STR1), (STR2), sizeof (STR2) - 1) == 0)

  /* strcpy() can have a similar problem, but since we know we are

     copying a constant string, we can use memcpy which will be faster

     since there is no need to check for a NUL byte inside STR.  We

     can also save time if we do not need to copy the terminating NUL.  */

#define LITMEMCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2) - 1)

#define LITSTRCPY(DEST,STR2) memcpy ((DEST), (STR2), sizeof (STR2))

/* The word size used by BFD on the host.  This may be 64 with a 32

   bit target if the host is 64 bit, or if other 64 bit targets have

   been selected with --enable-targets, or if --enable-64-bit-bfd.  */

#define BFD_ARCH_SIZE 32

/* The word size of the default bfd target.  */

#define BFD_DEFAULT_TARGET_SIZE 32

#define BFD_HOST_64BIT_LONG 0

#define BFD_HOST_64BIT_LONG_LONG 1

#define BFD_HOST_LONG_LONG @BFD_HOST_LONG_LONG@

#if 1

#define BFD_HOST_64_BIT long long

#define BFD_HOST_U_64_BIT unsigned long long

typedef BFD_HOST_64_BIT bfd_int64_t;

typedef BFD_HOST_U_64_BIT bfd_uint64_t;

#endif

#if BFD_ARCH_SIZE >= 64

#define BFD64

#endif

#ifndef INLINE

#if __GNUC__ >= 2

#define INLINE __inline__

#else

#define INLINE

#endif

#endif

/* Declaring a type wide enough to hold a host long and a host pointer.  */

#define BFD_HOSTPTR_T	unsigned long

typedef BFD_HOSTPTR_T bfd_hostptr_t;

/* Forward declaration.  */

typedef struct bfd bfd;

/* Boolean type used in bfd.  Too many systems define their own

   versions of "boolean" for us to safely typedef a "boolean" of

   our own.  Using an enum for "bfd_boolean" has its own set of

   problems, with strange looking casts required to avoid warnings

   on some older compilers.  Thus we just use an int.

   General rule: Functions which are bfd_boolean return TRUE on

   success and FALSE on failure (unless they're a predicate).  */

typedef int bfd_boolean;

#undef FALSE

#undef TRUE

#define FALSE 0

#define TRUE 1

#ifdef BFD64

#ifndef BFD_HOST_64_BIT

 #error No 64 bit integer type available

#endif /* ! defined (BFD_HOST_64_BIT) */

typedef BFD_HOST_U_64_BIT bfd_vma;

typedef BFD_HOST_64_BIT bfd_signed_vma;

typedef BFD_HOST_U_64_BIT bfd_size_type;

typedef BFD_HOST_U_64_BIT symvalue;

#ifndef fprintf_vma

#if BFD_HOST_64BIT_LONG

#define sprintf_vma(s,x) sprintf (s, "%016lx", x)

#define fprintf_vma(f,x) fprintf (f, "%016lx", x)

#elif BFD_HOST_64BIT_LONG_LONG

#define sprintf_vma(s,x) sprintf (s, "%016llx", x)

#define fprintf_vma(f,x) fprintf (f, "%016llx", x)

#else

#define _bfd_int64_low(x) ((unsigned long) (((x) & 0xffffffff)))

#define _bfd_int64_high(x) ((unsigned long) (((x) >> 32) & 0xffffffff))

#define fprintf_vma(s,x) \

  fprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))

#define sprintf_vma(s,x) \

  sprintf ((s), "%08lx%08lx", _bfd_int64_high (x), _bfd_int64_low (x))

#endif

#endif

#else /* not BFD64  */

/* Represent a target address.  Also used as a generic unsigned type

   which is guaranteed to be big enough to hold any arithmetic types

   we need to deal with.  */

typedef unsigned long bfd_vma;

/* A generic signed type which is guaranteed to be big enough to hold any

   arithmetic types we need to deal with.  Can be assumed to be compatible

   with bfd_vma in the same way that signed and unsigned ints are compatible

   (as parameters, in assignment, etc).  */

typedef long bfd_signed_vma;

typedef unsigned long symvalue;

typedef unsigned long bfd_size_type;

/* Print a bfd_vma x on stream s.  */

#define fprintf_vma(s,x) fprintf (s, "%08lx", x)

#define sprintf_vma(s,x) sprintf (s, "%08lx", x)

#endif /* not BFD64  */

#define HALF_BFD_SIZE_TYPE \

  (((bfd_size_type) 1) << (8 * sizeof (bfd_size_type) / 2))

#ifndef BFD_HOST_64_BIT

/* Fall back on a 32 bit type.  The idea is to make these types always

   available for function return types, but in the case that

   BFD_HOST_64_BIT is undefined such a function should abort or

   otherwise signal an error.  */

typedef bfd_signed_vma bfd_int64_t;

typedef bfd_vma bfd_uint64_t;

#endif

/* An offset into a file.  BFD always uses the largest possible offset

   based on the build time availability of fseek, fseeko, or fseeko64.  */

typedef BFD_HOST_64_BIT file_ptr;

typedef unsigned BFD_HOST_64_BIT ufile_ptr;

extern void bfd_sprintf_vma (bfd *, char *, bfd_vma);

extern void bfd_fprintf_vma (bfd *, void *, bfd_vma);

#define printf_vma(x) fprintf_vma(stdout,x)

#define bfd_printf_vma(abfd,x) bfd_fprintf_vma (abfd,stdout,x)

typedef unsigned int flagword;	/* 32 bits of flags */

typedef unsigned char bfd_byte;

/* File formats.  */

typedef enum bfd_format

{

  bfd_unknown = 0,	/* File format is unknown.  */

  bfd_object,		/* Linker/assembler/compiler output.  */

  bfd_archive,		/* Object archive file.  */

  bfd_core,		/* Core dump.  */

  bfd_type_end		/* Marks the end; don't use it!  */

}

bfd_format;

/* Values that may appear in the flags field of a BFD.  These also

   appear in the object_flags field of the bfd_target structure, where

   they indicate the set of flags used by that backend (not all flags

   are meaningful for all object file formats) (FIXME: at the moment,

   the object_flags values have mostly just been copied from backend

   to another, and are not necessarily correct).  */

/* No flags.  */

#define BFD_NO_FLAGS   	0x00

/* BFD contains relocation entries.  */

#define HAS_RELOC   	0x01

/* BFD is directly executable.  */

#define EXEC_P      	0x02

/* BFD has line number information (basically used for F_LNNO in a

   COFF header).  */

#define HAS_LINENO  	0x04

/* BFD has debugging information.  */

#define HAS_DEBUG   	0x08

/* BFD has symbols.  */

#define HAS_SYMS    	0x10

/* BFD has local symbols (basically used for F_LSYMS in a COFF

   header).  */

#define HAS_LOCALS  	0x20

/* BFD is a dynamic object.  */

#define DYNAMIC     	0x40

/* Text section is write protected (if D_PAGED is not set, this is

   like an a.out NMAGIC file) (the linker sets this by default, but

   clears it for -r or -N).  */

#define WP_TEXT     	0x80

/* BFD is dynamically paged (this is like an a.out ZMAGIC file) (the

   linker sets this by default, but clears it for -r or -n or -N).  */

#define D_PAGED     	0x100

/* BFD is relaxable (this means that bfd_relax_section may be able to

   do something) (sometimes bfd_relax_section can do something even if

   this is not set).  */

#define BFD_IS_RELAXABLE 0x200

/* This may be set before writing out a BFD to request using a

   traditional format.  For example, this is used to request that when

   writing out an a.out object the symbols not be hashed to eliminate

   duplicates.  */

#define BFD_TRADITIONAL_FORMAT 0x400

/* This flag indicates that the BFD contents are actually cached in

   memory.  If this is set, iostream points to a bfd_in_memory struct.  */

#define BFD_IN_MEMORY 0x800

/* The sections in this BFD specify a memory page.  */

#define HAS_LOAD_PAGE 0x1000

/* This BFD has been created by the linker and doesn't correspond

   to any input file.  */

#define BFD_LINKER_CREATED 0x2000

/* Symbols and relocation.  */

/* A count of carsyms (canonical archive symbols).  */

typedef unsigned long symindex;

/* How to perform a relocation.  */

typedef const struct reloc_howto_struct reloc_howto_type;

#define BFD_NO_MORE_SYMBOLS ((symindex) ~0)

/* General purpose part of a symbol X;

   target specific parts are in libcoff.h, libaout.h, etc.  */

#define bfd_get_section(x) ((x)->section)

#define bfd_get_output_section(x) ((x)->section->output_section)

#define bfd_set_section(x,y) ((x)->section) = (y)

#define bfd_asymbol_base(x) ((x)->section->vma)

#define bfd_asymbol_value(x) (bfd_asymbol_base(x) + (x)->value)

#define bfd_asymbol_name(x) ((x)->name)

/*Perhaps future: #define bfd_asymbol_bfd(x) ((x)->section->owner)*/

#define bfd_asymbol_bfd(x) ((x)->the_bfd)

#define bfd_asymbol_flavour(x) (bfd_asymbol_bfd(x)->xvec->flavour)

/* A canonical archive symbol.  */

/* This is a type pun with struct ranlib on purpose!  */

typedef struct carsym

{

  char *name;

  file_ptr file_offset;	/* Look here to find the file.  */

}

carsym;			/* To make these you call a carsymogen.  */

/* Used in generating armaps (archive tables of contents).

   Perhaps just a forward definition would do?  */

struct orl 			/* Output ranlib.  */

{

  char **name;		/* Symbol name.  */

  union

  {

    file_ptr pos;

    bfd *abfd;

  } u;			/* bfd* or file position.  */

  int namidx;		/* Index into string table.  */

};

/* Linenumber stuff.  */

typedef struct lineno_cache_entry

{

  unsigned int line_number;	/* Linenumber from start of function.  */

  union

  {

    struct bfd_symbol *sym;	/* Function name.  */

    bfd_vma offset;	    		/* Offset into section.  */

  } u;

}

alent;

/* Object and core file sections.  */

#define	align_power(addr, align)	\

  (((addr) + ((bfd_vma) 1 << (align)) - 1) & ((bfd_vma) -1 << (align)))

typedef struct bfd_section *sec_ptr;

#define bfd_get_section_name(bfd, ptr) ((ptr)->name + 0)

#define bfd_get_section_vma(bfd, ptr) ((ptr)->vma + 0)

#define bfd_get_section_lma(bfd, ptr) ((ptr)->lma + 0)

#define bfd_get_section_alignment(bfd, ptr) ((ptr)->alignment_power + 0)

#define bfd_section_name(bfd, ptr) ((ptr)->name)

#define bfd_section_size(bfd, ptr) ((ptr)->size)

#define bfd_get_section_size(ptr) ((ptr)->size)

#define bfd_section_vma(bfd, ptr) ((ptr)->vma)

#define bfd_section_lma(bfd, ptr) ((ptr)->lma)

#define bfd_section_alignment(bfd, ptr) ((ptr)->alignment_power)

#define bfd_get_section_flags(bfd, ptr) ((ptr)->flags + 0)

#define bfd_get_section_userdata(bfd, ptr) ((ptr)->userdata)

#define bfd_is_com_section(ptr) (((ptr)->flags & SEC_IS_COMMON) != 0)

#define bfd_set_section_vma(bfd, ptr, val) (((ptr)->vma = (ptr)->lma = (val)), ((ptr)->user_set_vma = TRUE), TRUE)

#define bfd_set_section_alignment(bfd, ptr, val) (((ptr)->alignment_power = (val)),TRUE)

#define bfd_set_section_userdata(bfd, ptr, val) (((ptr)->userdata = (val)),TRUE)

/* Find the address one past the end of SEC.  */

#define bfd_get_section_limit(bfd, sec) \

  (((sec)->rawsize ? (sec)->rawsize : (sec)->size) \

   / bfd_octets_per_byte (bfd))

/* Return TRUE if section has been discarded.  */

#define elf_discarded_section(sec)				\

  (!bfd_is_abs_section (sec)					\

   && bfd_is_abs_section ((sec)->output_section)		\

   && (sec)->sec_info_type != ELF_INFO_TYPE_MERGE		\

   && (sec)->sec_info_type != ELF_INFO_TYPE_JUST_SYMS)

/* Forward define.  */

struct stat;

typedef enum bfd_print_symbol

{

  bfd_print_symbol_name,

  bfd_print_symbol_more,

  bfd_print_symbol_all

} bfd_print_symbol_type;

/* Information about a symbol that nm needs.  */

typedef struct _symbol_info

{

  symvalue value;

  char type;

  const char *name;            /* Symbol name.  */

  unsigned char stab_type;     /* Stab type.  */

  char stab_other;             /* Stab other.  */

  short stab_desc;             /* Stab desc.  */

  const char *stab_name;       /* String for stab type.  */

} symbol_info;

/* Get the name of a stabs type code.  */

extern const char *bfd_get_stab_name (int);

/* Hash table routines.  There is no way to free up a hash table.  */

/* An element in the hash table.  Most uses will actually use a larger

   structure, and an instance of this will be the first field.  */

struct bfd_hash_entry

{

  /* Next entry for this hash code.  */

  struct bfd_hash_entry *next;

  /* String being hashed.  */

  const char *string;

  /* Hash code.  This is the full hash code, not the index into the

     table.  */

  unsigned long hash;

};

/* A hash table.  */

struct bfd_hash_table

{

  /* The hash array.  */

  struct bfd_hash_entry **table;

  /* A function used to create new elements in the hash table.  The

     first entry is itself a pointer to an element.  When this

     function is first invoked, this pointer will be NULL.  However,

     having the pointer permits a hierarchy of method functions to be

     built each of which calls the function in the superclass.  Thus

     each function should be written to allocate a new block of memory

     only if the argument is NULL.  */

  struct bfd_hash_entry *(*newfunc)

    (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);

   /* An objalloc for this hash table.  This is a struct objalloc *,

     but we use void * to avoid requiring the inclusion of objalloc.h.  */

  void *memory;

  /* The number of slots in the hash table.  */

  unsigned int size;

  /* The number of entries in the hash table.  */

  unsigned int count;

  /* The size of elements.  */

  unsigned int entsize;

  /* If non-zero, don't grow the hash table.  */

  unsigned int frozen:1;

};

/* Initialize a hash table.  */

extern bfd_boolean bfd_hash_table_init

  (struct bfd_hash_table *,

   struct bfd_hash_entry *(*) (struct bfd_hash_entry *,

			       struct bfd_hash_table *,

			       const char *),

   unsigned int);

/* Initialize a hash table specifying a size.  */

extern bfd_boolean bfd_hash_table_init_n

  (struct bfd_hash_table *,

   struct bfd_hash_entry *(*) (struct bfd_hash_entry *,

			       struct bfd_hash_table *,

			       const char *),

   unsigned int, unsigned int);

/* Free up a hash table.  */

extern void bfd_hash_table_free

  (struct bfd_hash_table *);

/* Look up a string in a hash table.  If CREATE is TRUE, a new entry

   will be created for this string if one does not already exist.  The

   COPY argument must be TRUE if this routine should copy the string

   into newly allocated memory when adding an entry.  */

extern struct bfd_hash_entry *bfd_hash_lookup

  (struct bfd_hash_table *, const char *, bfd_boolean create,

   bfd_boolean copy);

/* Insert an entry in a hash table.  */

extern struct bfd_hash_entry *bfd_hash_insert

  (struct bfd_hash_table *, const char *, unsigned long);

/* Replace an entry in a hash table.  */

extern void bfd_hash_replace

  (struct bfd_hash_table *, struct bfd_hash_entry *old,

   struct bfd_hash_entry *nw);

/* Base method for creating a hash table entry.  */

extern struct bfd_hash_entry *bfd_hash_newfunc

  (struct bfd_hash_entry *, struct bfd_hash_table *, const char *);

/* Grab some space for a hash table entry.  */

extern void *bfd_hash_allocate

  (struct bfd_hash_table *, unsigned int);

/* Traverse a hash table in a random order, calling a function on each

   element.  If the function returns FALSE, the traversal stops.  The

   INFO argument is passed to the function.  */

extern void bfd_hash_traverse

  (struct bfd_hash_table *,

   bfd_boolean (*) (struct bfd_hash_entry *, void *),

   void *info);

/* Allows the default size of a hash table to be configured. New hash

   tables allocated using bfd_hash_table_init will be created with

   this size.  */

extern void bfd_hash_set_default_size (bfd_size_type);

/* This structure is used to keep track of stabs in sections

   information while linking.  */

struct stab_info

{

  /* A hash table used to hold stabs strings.  */

  struct bfd_strtab_hash *strings;

  /* The header file hash table.  */

  struct bfd_hash_table includes;

  /* The first .stabstr section.  */

  struct bfd_section *stabstr;

};

#define COFF_SWAP_TABLE (void *) &bfd_coff_std_swap_table

/* User program access to BFD facilities.  */

/* Direct I/O routines, for programs which know more about the object

   file than BFD does.  Use higher level routines if possible.  */

extern bfd_size_type bfd_bread (void *, bfd_size_type, bfd *);

extern bfd_size_type bfd_bwrite (const void *, bfd_size_type, bfd *);

extern int bfd_seek (bfd *, file_ptr, int);

extern file_ptr bfd_tell (bfd *);

extern int bfd_flush (bfd *);

extern int bfd_stat (bfd *, struct stat *);