doc cleanup
[deliverable/binutils-gdb.git] / bfd / bfd.c
index b661d7157f7014a3d7cf1729bc7288d5fe61dd86..c28b1409e7253f2f856892a1a1ccdc353333b3c0 100644 (file)
--- a/bfd/bfd.c
+++ b/bfd/bfd.c
-                          /* -*- C -*- */
+/* Generic BFD library interface and support routines.
+   Copyright (C) 1990, 1991, 1992, 1993 Free Software Foundation, Inc.
+   Written by Cygnus Support.
 
-/*** bfd -- binary file diddling routines by Gumby Wallace of Cygnus Support.
-           Every definition in this file should be exported and declared
-           in bfd.c.  If you don't want it to be user-visible, put it in
-           libbfd.c!
-*/
-
-/* Copyright (C) 1990, 1991 Free Software Foundation, Inc.
-
-This file is part of BFD, the Binary File Diddler.
+This file is part of BFD, the Binary File Descriptor library.
 
-BFD is free software; you can redistribute it and/or modify
+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 1, or (at your option)
-any later version.
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
 
-BFD is distributed in the hope that it will be useful,
+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 BFD; see the file COPYING.  If not, write to
-the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
+along with this program; if not, write to the Free Software
+Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
+
+/*
+SECTION
+       <<typedef bfd>>
+
+       A BFD has type <<bfd>>; objects of this type are the
+       cornerstone of any application using <<libbfd>>. Using BFD
+       consists of making references though the BFD and to data in the BFD.
+
+       Here is the structure that defines the type <<bfd>>.  It
+       contains the major data about the file and pointers
+       to the rest of the data.
+
+CODE_FRAGMENT
+.
+.struct _bfd 
+.{
+.    {* The filename the application opened the BFD with.  *}
+.    CONST char *filename;                
+.
+.    {* A pointer to the target jump table.             *}
+.    struct bfd_target *xvec;
+.
+.    {* To avoid dragging too many header files into every file that
+.       includes `<<bfd.h>>', IOSTREAM has been declared as a "char
+.       *", and MTIME as a "long".  Their correct types, to which they
+.       are cast when used, are "FILE *" and "time_t".    The iostream
+.       is the result of an fopen on the filename. *}
+.    char *iostream;
+.
+.    {* Is the file descriptor being cached?  That is, can it be closed as
+.       needed, and re-opened when accessed later?  *}
+.
+.    boolean cacheable;
+.
+.    {* Marks whether there was a default target specified when the
+.       BFD was opened. This is used to select which matching algorithm
+.       to use to choose the back end. *}
+.
+.    boolean target_defaulted;
+.
+.    {* The caching routines use these to maintain a
+.       least-recently-used list of BFDs *}
+.
+.    struct _bfd *lru_prev, *lru_next;
+.
+.    {* When a file is closed by the caching routines, BFD retains
+.       state information on the file here: *}
+.
+.    file_ptr where;              
+.
+.    {* and here: (``once'' means at least once) *}
+.
+.    boolean opened_once;
+.
+.    {* Set if we have a locally maintained mtime value, rather than
+.       getting it from the file each time: *}
+.
+.    boolean mtime_set;
+.
+.    {* File modified time, if mtime_set is true: *}
+.
+.    long mtime;          
+.
+.    {* Reserved for an unimplemented file locking extension.*}
+.
+.    int ifd;
+.
+.    {* The format which belongs to the BFD. (object, core, etc.) *}
+.
+.    bfd_format format;
+.
+.    {* The direction the BFD was opened with*}
+.
+.    enum bfd_direction {no_direction = 0,
+.                        read_direction = 1,
+.                        write_direction = 2,
+.                        both_direction = 3} direction;
+.
+.    {* Format_specific flags*}
+.
+.    flagword flags;              
+.
+.    {* Currently my_archive is tested before adding origin to
+.       anything. I believe that this can become always an add of
+.       origin, with origin set to 0 for non archive files.   *}
+.
+.    file_ptr origin;             
+.
+.    {* Remember when output has begun, to stop strange things
+.       from happening. *}
+.    boolean output_has_begun;
+.
+.    {* Pointer to linked list of sections*}
+.    struct sec  *sections;
+.
+.    {* The number of sections *}
+.    unsigned int section_count;
+.
+.    {* Stuff only useful for object files: 
+.       The start address. *}
+.    bfd_vma start_address;
+.
+.    {* Used for input and output*}
+.    unsigned int symcount;
+.
+.    {* Symbol table for output BFD (with symcount entries) *}
+.    struct symbol_cache_entry  **outsymbols;             
+.
+.    {* Pointer to structure which contains architecture information*}
+.    struct bfd_arch_info *arch_info;
+.
+.    {* Stuff only useful for archives:*}
+.    PTR arelt_data;              
+.    struct _bfd *my_archive;     {* The containing archive BFD.  *}
+.    struct _bfd *next;           {* The next BFD in the archive.  *}
+.    struct _bfd *archive_head;   {* The first BFD in the archive.  *}
+.    boolean has_armap;           
+.
+.    {* Used by the back end to hold private data. *}
+.
+.    union 
+.      {
+.      struct aout_data_struct *aout_data;
+.      struct artdata *aout_ar_data;
+.      struct _oasys_data *oasys_obj_data;
+.      struct _oasys_ar_data *oasys_ar_data;
+.      struct coff_tdata *coff_obj_data;
+.      struct ecoff_tdata *ecoff_obj_data;
+.      struct ieee_data_struct *ieee_data;
+.      struct ieee_ar_data_struct *ieee_ar_data;
+.      struct srec_data_struct *srec_data;
+.      struct tekhex_data_struct *tekhex_data;
+.      struct elf_obj_tdata *elf_obj_data;
+.      struct nlm_obj_tdata *nlm_obj_data;
+.      struct bout_data_struct *bout_data;
+.      struct sun_core_struct *sun_core_data;
+.      struct trad_core_struct *trad_core_data;
+.      struct som_data_struct *som_data;
+.      struct hpux_core_struct *hpux_core_data;
+.      struct sgi_core_struct *sgi_core_data;
+.      struct lynx_core_struct *lynx_core_data;
+.      struct osf_core_struct *osf_core_data;
+.      PTR any;
+.      } tdata;
+.  
+.    {* Used by the application to hold private data*}
+.    PTR usrdata;
+.
+.    {* Where all the allocated stuff under this BFD goes *}
+.    struct obstack memory;
+.
+.    {* Is this really needed in addition to usrdata?  *}
+.    asymbol **ld_symbols;
+.};
+.
+*/
 
-/* $Id$ */
-#include "sysdep.h"
 #include "bfd.h"
+#include "sysdep.h"
 #include "libbfd.h"
+#include "coff/internal.h"
+#include "coff/sym.h"
+#include "libcoff.h"
+#include "libecoff.h"
+#undef obj_symbols
+#include "libelf.h"
 
-short _bfd_host_big_endian = 0x0100;
-       /* Accessing the above as (*(char*)&_bfd_host_big_endian), will
-        * return 1 if the host is big-endian, 0 otherwise.
-        * (See HOST_IS_BIG_ENDIAN_P in bfd.h.)
-        */
-
-
-
-\f
+#undef strerror
+extern char *strerror();
 
 /** Error handling
     o - Most functions return nonzero on success (check doc for
-       precise semantics); 0 or NULL on error.
+        precise semantics); 0 or NULL on error.
     o - Internal errors are documented by the value of bfd_error.
-       If that is system_call_error then check errno.
+        If that is system_call_error then check errno.
     o - The easiest way to report this to the user is to use bfd_perror.
 */
 
 bfd_ec bfd_error = no_error;
 
-char *bfd_errmsgs[] = {"No error",
-                      "System call error",
-                      "Invalid target",
-                      "File in wrong format",
-                      "Invalid operation",
-                      "Memory exhausted",
-                      "No symbols",
-                      "No relocation info",
-                      "No more archived files",
-                      "Malformed archive",
-                      "Symbol not found",
-                      "File format not recognized",
-                      "File format is ambiguous",
-                          "Section has no contents",
-                "Nonrepresentable section on output",
-                      "#<Invalid error code>"
-                      };
-
+CONST char *CONST bfd_errmsgs[] = {
+                        "No error",
+                        "System call error",
+                        "Invalid target",
+                        "File in wrong format",
+                        "Invalid operation",
+                        "Memory exhausted",
+                        "No symbols",
+                        "No relocation info",
+                        "No more archived files",
+                        "Malformed archive",
+                        "Symbol not found",
+                        "File format not recognized",
+                        "File format is ambiguous",
+                        "Section has no contents",
+                        "Nonrepresentable section on output",
+                       "Symbol needs debug section which does not exist",
+                       "Bad value",
+                       "File truncated",
+                        "#<Invalid error code>"
+                       };
 
 static 
 void 
 DEFUN(bfd_nonrepresentable_section,(abfd, name),
-        CONST  bfd * CONST abfd AND
-        CONST  char * CONST name)
+         CONST  bfd * CONST abfd AND
+         CONST  char * CONST name)
 {
-  printf("bfd error writing file %s, format %s can't represent section %s\n",
-        abfd->filename, 
-        abfd->xvec->name,
-        name);
+  fprintf(stderr,
+         "bfd error writing file %s, format %s can't represent section %s\n",
+         abfd->filename, 
+         abfd->xvec->name,
+         name);
   exit(1);
 }
-bfd_error_vector_type bfd_error_vector = 
-  {
-  bfd_nonrepresentable_section 
-  };
 
-#if !defined(ANSI_LIBRARIES)
-char *
-strerror (code)
-     int code;
+/*ARGSUSED*/
+static 
+void 
+DEFUN(bfd_undefined_symbol,(relent, seclet),
+      CONST  arelent *relent AND
+      CONST  struct bfd_seclet *seclet)
 {
-  extern int sys_nerr;
-  extern char *sys_errlist[];
-
-  return (((code < 0) || (code >= sys_nerr)) ? "(unknown error)" :
-         sys_errlist [code]);
+  asymbol *symbol = *(relent->sym_ptr_ptr);
+  fprintf(stderr, "bfd error relocating, symbol %s is undefined\n",
+         symbol->name);
+  exit(1);
+}
+/*ARGSUSED*/
+static 
+void 
+DEFUN(bfd_reloc_value_truncated,(relent, seclet),
+         CONST  arelent *relent AND
+      struct bfd_seclet *seclet)
+{
+  fprintf(stderr, "bfd error relocating, value truncated\n");
+  exit(1);
+}
+/*ARGSUSED*/
+static 
+void 
+DEFUN(bfd_reloc_is_dangerous,(relent, seclet),
+      CONST  arelent *relent AND
+     CONST  struct bfd_seclet *seclet)
+{
+  fprintf(stderr, "bfd error relocating, dangerous\n");
+  exit(1);
 }
-#endif /* not ANSI_LIBRARIES */
 
+bfd_error_vector_type bfd_error_vector = 
+  {
+  bfd_nonrepresentable_section ,
+  bfd_undefined_symbol,
+  bfd_reloc_value_truncated,
+  bfd_reloc_is_dangerous,
+  };
 
 
-char *
+CONST char *
 bfd_errmsg (error_tag)
      bfd_ec error_tag;
 {
-       extern int errno;
-
+#ifndef errno
+  extern int errno;
+#endif
   if (error_tag == system_call_error)
     return strerror (errno);
 
@@ -116,21 +293,22 @@ bfd_errmsg (error_tag)
   return bfd_errmsgs [(int)error_tag];
 }
 
-
-void bfd_default_error_trap(error_tag)
-bfd_ec error_tag;
+void
+DEFUN (bfd_default_error_trap, (error_tag),
+       bfd_ec error_tag)
 {
-  printf("bfd assert fail (%s)\n", bfd_errmsg(error_tag));
+  fprintf(stderr, "bfd assert fail (%s)\n", bfd_errmsg(error_tag));
 }
 
-void (*bfd_error_trap)() = bfd_default_error_trap;
-void (*bfd_error_nonrepresentabltrap)() = bfd_default_error_trap;
+void (*bfd_error_trap) PARAMS ((bfd_ec)) = bfd_default_error_trap;
+void (*bfd_error_nonrepresentabltrap) PARAMS ((bfd_ec)) = bfd_default_error_trap;
+
 void
 DEFUN(bfd_perror,(message),
       CONST char *message)
 {
   if (bfd_error == system_call_error)
-    perror(message);           /* must be system error then... */
+    perror((char *)message);            /* must be system error then... */
   else {
     if (message == NULL || *message == '\0')
       fprintf (stderr, "%s\n", bfd_errmsg (bfd_error));
@@ -139,810 +317,319 @@ DEFUN(bfd_perror,(message),
   }
 }
 
-/* for error messages */
-char *
-bfd_format_string (format)
-     bfd_format format;
-{
-  if (((int)format <(int) bfd_unknown) || ((int)format >=(int) bfd_type_end)) return "invalid";
-  
-  switch (format) {
-  case bfd_object: return "object"; /* linker/assember/compiler output */
-  case bfd_archive: return "archive"; /* object archive file */
-  case bfd_core: return "core";        /* core dump */
-  default: return "unknown";
-  }
-}
-\f
-/** Target configurations */
-
-extern bfd_target *target_vector[];
-
-/* Returns a pointer to the transfer vector for the object target
-   named target_name.  If target_name is NULL, chooses the one in the
-   environment variable GNUTARGET; if that is null or not defined then
-   the first entry in the target list is chosen.  Passing in the
-   string "default" or setting the environment variable to "default"
-   will cause the first entry in the target list to be returned. */
-
-bfd_target *
-DEFUN(bfd_find_target,(target_name),
-      CONST char *target_name)
-{
-  bfd_target **target;
-  extern char *getenv ();
-  CONST char *targname = (target_name ? target_name : getenv ("GNUTARGET"));
-
-  /* This is safe; the vector cannot be null */
-  if (targname == NULL || !strcmp (targname, "default"))
-    return target_vector[0];
-
-  for (target = &target_vector[0]; *target != NULL; target++) {
-    if (!strcmp (targname, (*target)->name))
-      return *target;
-  }
-
-  bfd_error = invalid_target;
-  return NULL;
-}
-
-/* Returns a freshly-consed, NULL-terminated vector of the names of all the
-   valid bfd targets.  Do not modify the names */
 
-char **
-bfd_target_list ()
-{
-  int vec_length= 0;
-  bfd_target **target;
-  char **name_list, **name_ptr;
-
-  for (target = &target_vector[0]; *target != NULL; target++)
-    vec_length++;
-
-  name_ptr = name_list = (char **) zalloc ((vec_length + 1) * sizeof (char **));
-
-  if (name_list == NULL) {
-    bfd_error = no_memory;
-    return NULL;
-  }
+/*
+FUNCTION
+       bfd_set_file_flags
 
-  for (target = &target_vector[0]; *target != NULL; target++)
-    *(name_ptr++) = (*target)->name;
+SYNOPSIS
+       boolean bfd_set_file_flags(bfd *abfd, flagword flags);
 
-  return name_list;
-}
-\f
-/** Init a bfd for read of the proper format.
- */
+DESCRIPTION
+       Set the flag word in the BFD @var{abfd} to the value @var{flags}.
 
-/* We should be able to find out if the target was defaulted or user-specified.
-   If the user specified the target explicitly then we should do no search.
-   I guess the best way to do this is to pass an extra argument which specifies
-   the DWIM. */
+       Possible errors are:
+       o wrong_format - The target bfd was not of object format.
+       o invalid_operation - The target bfd was open for reading.
+       o invalid_operation -
+       The flag word contained a bit which was not applicable to the
+       type of file.  E.g., an attempt was made to set the D_PAGED bit
+       on a bfd format which does not support demand paging.
 
-/* I have chanegd this always to set the filepos to the origin before
-   guessing.  -- Gumby, 14 Februar 1991*/
+*/
 
 boolean
-bfd_check_format (abfd, format)
+bfd_set_file_flags (abfd, flags)
      bfd *abfd;
-     bfd_format format;
+     flagword flags;
 {
-#if obsolete
-  file_ptr filepos;
-#endif
-  bfd_target **target, *save_targ, *right_targ;
-  int match_count;
-
-  if (!bfd_read_p (abfd) ||
-      ((int)(abfd->format) < (int)bfd_unknown) ||
-      ((int)(abfd->format) >= (int)bfd_type_end)) {
-    bfd_error = invalid_operation;
+  if (abfd->format != bfd_object) {
+    bfd_error = wrong_format;
     return false;
   }
 
-  if (abfd->format != bfd_unknown) return (abfd->format == format) ? true:false;
-
-  /* presume the answer is yes */
-  abfd->format = format;
-
-#if obsolete
-  filepos = bfd_tell (abfd);
-#endif
-  bfd_seek (abfd, (file_ptr)0, SEEK_SET);      /* instead, rewind! */
-
-
-  right_targ = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd));
-  if (right_targ) {
-    abfd->xvec = right_targ;           /* Set the target as returned */
-    return true;                       /* File position has moved, BTW */
-  }
-
-  /* This isn't a <format> file in the specified or defaulted target type.
-     See if we recognize it for any other target type.  (We check them
-     all to make sure it's uniquely recognized.)  */
-
-  save_targ = abfd->xvec;
-  match_count = 0;
-  right_targ = 0;
-
-  for (target = target_vector; *target != NULL; target++) {
-    bfd_target *temp;
-
-    abfd->xvec = *target;      /* Change BFD's target temporarily */
-#if obsolete
-    bfd_seek (abfd, filepos, SEEK_SET);        /* Restore original file position */
-#endif
-    bfd_seek (abfd, (file_ptr)0, SEEK_SET);
-    temp = BFD_SEND_FMT (abfd, _bfd_check_format, (abfd));
-    if (temp) {                                /* This format checks out as ok! */
-      right_targ = temp;
-      match_count++;
-#ifdef GNU960
-      /* Big- and little-endian b.out archives look the same, but it doesn't
-       * matter: there is no difference in their headers, and member file byte
-       * orders will (I hope) be handled appropriately by bfd.  Ditto for big
-       * and little coff archives.  And the 4 coff/b.out object formats are
-       * unambiguous.  So accept the first match we find.
-       */
-      break;
-#endif
-    }
-  }
-
-  if (match_count == 1) {
-    abfd->xvec = right_targ;           /* Change BFD's target permanently */
-    return true;                       /* File position has moved, BTW */
-  }
-
-  abfd->xvec = save_targ;              /* Restore original target type */
-  abfd->format = bfd_unknown;          /* Restore original format */
-  bfd_error = ((match_count == 0) ? file_not_recognized :
-              file_ambiguously_recognized);
-#if  obsolete
-  bfd_seek (abfd, filepos, SEEK_SET);  /* Restore original file position */
-#endif
-  return false;
-}
-
-boolean
-bfd_set_format (abfd, format)
-     bfd *abfd;
-     bfd_format format;
-{
-
-
-  if (bfd_read_p (abfd) ||
-      ((int)abfd->format < (int)bfd_unknown) ||
-      ((int)abfd->format >= (int)bfd_type_end)) {
+  if (bfd_read_p (abfd)) {
     bfd_error = invalid_operation;
     return false;
   }
 
-  if (abfd->format != bfd_unknown) return (abfd->format == format) ? true:false;
-
-  /* presume the answer is yes */
-  abfd->format = format;
-
-/*  filepos = bfd_tell (abfd);*/
-
-  if (!BFD_SEND_FMT (abfd, _bfd_set_format, (abfd))) {
-    abfd->format = bfd_unknown;
-/*    bfd_seek (abfd, filepos, SEEK_SET);*/
+  bfd_get_file_flags (abfd) = flags;
+  if ((flags & bfd_applicable_file_flags (abfd)) != flags) {
+    bfd_error = invalid_operation;
     return false;
   }
 
-  return true;
-}
-\f
-/* Hack object and core file sections */
-
-sec_ptr
-DEFUN(bfd_get_section_by_name,(abfd, name),
-      bfd *abfd AND
-      CONST char *name)
-{
-  asection *sect;
-  
-  for (sect = abfd->sections; sect != NULL; sect = sect->next)
-    if (!strcmp (sect->name, name)) return sect;
-  return NULL;
+return true;
 }
 
-/* If you try to create a section with a name which is already in use,
-   returns the old section by that name instead. */
-sec_ptr
-DEFUN(bfd_make_section,(abfd, name),
-      bfd *abfd AND
-      CONST char *name)
+void
+bfd_assert(file, line)
+char *file;
+int line;
 {
-  asection *newsect;  
-  asection **  prev = &abfd->sections;
-  asection * sect = abfd->sections;
-  
-  if (abfd->output_has_begun) {
-    bfd_error = invalid_operation;
-    return NULL;
-  }
-
-  while (sect) {
-    if (!strcmp(sect->name, name)) return sect;
-    prev = &sect->next;
-    sect = sect->next;
-  }
-
-  newsect = (asection *) bfd_zalloc(abfd, sizeof (asection));
-  if (newsect == NULL) {
-    bfd_error = no_memory;
-    return NULL;
-  }
-
-  newsect->name = name;
-  newsect->index = abfd->section_count++;
-  newsect->flags = SEC_NO_FLAGS;
-
-
-  newsect->userdata = 0;
-  newsect->next = (asection *)NULL;
-  newsect->relocation = (arelent *)NULL;
-  newsect->reloc_count = 0;
-  newsect->line_filepos =0;
-
-  if (BFD_SEND (abfd, _new_section_hook, (abfd, newsect)) != true) {
-    free (newsect);
-    return NULL;
-  }
-
-  *prev = newsect;
-  return newsect;
+  fprintf(stderr, "bfd assertion fail %s:%d\n",file,line);
 }
 
-/* Call operation on each section.  Operation gets three args: the bfd,
-   the section, and a void * pointer (whatever the user supplied). */
 
-/* This is attractive except that without lexical closures its use is hard
-   to make reentrant. */
-/*VARARGS2*/
-void
-bfd_map_over_sections (abfd, operation, user_storage)
-     bfd *abfd;
-     void (*operation)();
-     PTR user_storage;
-{
-  asection *sect;
-  int i = 0;
-  
-  for (sect = abfd->sections; sect != NULL; i++, sect = sect->next)
-    (*operation) (abfd, sect, user_storage);
-
-  if (i != abfd->section_count)                /* Debugging */
-    abort();
-}
+/*
+FUNCTION
+       bfd_set_start_address
 
-boolean
-bfd_set_section_flags (abfd, section, flags)
-     bfd *abfd;
-     sec_ptr section;
-     flagword flags;
-{
-  if ((flags & bfd_applicable_section_flags (abfd)) != flags) {
-    bfd_error = invalid_operation;
-    return false;
-  }
+SYNOPSIS
+       boolean bfd_set_start_address(bfd *abfd, bfd_vma vma);
 
-   section->flags = flags;
-return true;
-}
+DESCRIPTION
+       Make @var{vma} the entry point of output BFD @var{abfd}.
 
+RETURNS
+       Returns <<true>> on success, <<false>> otherwise.
+*/
 
 boolean
-bfd_set_section_size (abfd, ptr, val)
-     bfd *abfd;
-     sec_ptr ptr;
-     unsigned long val;
+bfd_set_start_address(abfd, vma)
+bfd *abfd;
+bfd_vma vma;
 {
-  /* Once you've started writing to any section you cannot create or change
-     the size of any others. */
-
-  if (abfd->output_has_begun) {
-    bfd_error = invalid_operation;
-    return false;
-  }
-
-  ptr->size = val;
-  
+  abfd->start_address = vma;
   return true;
 }
 
-boolean
-bfd_set_section_contents (abfd, section, location, offset, count)
-     bfd *abfd;
-     sec_ptr section;
-     PTR location;
-     file_ptr offset;
-     int count;
-{
-       if (!(bfd_get_section_flags(abfd, section) &
-             SEC_HAS_CONTENTS)) {
-               bfd_error = no_contents;
-               return(false);
-       } /* if section has no contents */
-
-  if (BFD_SEND (abfd, _bfd_set_section_contents,
-           (abfd, section, location, offset, count))) {
-    abfd->output_has_begun = true;
-    return true;
-  }
 
-  return false;
-}
+/*
+FUNCTION
+       bfd_get_mtime
 
-boolean
-bfd_get_section_contents (abfd, section, location, offset, count)
-     bfd *abfd;
-     sec_ptr section;
-     PTR location;
-     file_ptr offset;
-     int count;
-{
-  if (section->flags & SEC_CONSTRUCTOR) {
-    memset(location, 0, count);
-    return true;
-  }
-  else {
-    return  (BFD_SEND (abfd, _bfd_get_section_contents,
-                      (abfd, section, location, offset, count)));
-  }
-}
+SYNOPSIS
+       long bfd_get_mtime(bfd *abfd);
 
-\f
-/** Some core file info commands */
+DESCRIPTION
+       Return the file modification time (as read from the file system, or
+       from the archive header for archive members).
 
-/* Returns a read-only string explaining what program was running when
-   it failed. */
+*/
 
-char *
-bfd_core_file_failing_command (abfd)
+long
+bfd_get_mtime (abfd)
      bfd *abfd;
 {
-  if (abfd->format != bfd_core) {
-    bfd_error = invalid_operation;
-    return NULL;
-  }
-  return BFD_SEND (abfd, _core_file_failing_command, (abfd));
-}
+  FILE *fp;
+  struct stat buf;
 
-int
-bfd_core_file_failing_signal (abfd)
-     bfd *abfd;
-{
-  if (abfd->format != bfd_core) {
-    bfd_error = invalid_operation;
-    return NULL;
-  }
-  return BFD_SEND (abfd, _core_file_failing_signal, (abfd));
-}
+  if (abfd->mtime_set)
+    return abfd->mtime;
 
-boolean
-core_file_matches_executable_p (core_bfd, exec_bfd)
-     bfd *core_bfd, *exec_bfd;
-{
-  if ((core_bfd->format != bfd_core) || (exec_bfd->format != bfd_object)) {
-    bfd_error = wrong_format;
-    return false;
-  }
+  fp = bfd_cache_lookup (abfd);
+  if (0 != fstat (fileno (fp), &buf))
+    return 0;
 
-  return BFD_SEND (core_bfd, _core_file_matches_executable_p, (core_bfd, exec_bfd));
+  abfd->mtime = buf.st_mtime;          /* Save value in case anyone wants it */
+  return buf.st_mtime;
 }
-\f
-/** Symbols */
-
-boolean
-bfd_set_symtab (abfd, location, symcount)
-     bfd *abfd;
-     asymbol **location;
-     unsigned int symcount;
-{
-  if ((abfd->format != bfd_object) || (bfd_read_p (abfd))) {
-    bfd_error = invalid_operation;
-    return false;
-  }
 
-  bfd_get_outsymbols (abfd) = location;
-  bfd_get_symcount (abfd) = symcount;
-  return true;
-}
+/*
+FUNCTION
+       bfd_get_size
+
+SYNOPSIS
+       long bfd_get_size(bfd *abfd);
+
+DESCRIPTION
+       Return the file size (as read from file system) for the file
+       associated with BFD @var{abfd}.
+
+       The initial motivation for, and use of, this routine is not
+       so we can get the exact size of the object the BFD applies to, since
+       that might not be generally possible (archive members for example).
+       It would be ideal if someone could eventually modify
+       it so that such results were guaranteed.
+
+       Instead, we want to ask questions like "is this NNN byte sized
+       object I'm about to try read from file offset YYY reasonable?"
+       As as example of where we might do this, some object formats
+       use string tables for which the first <<sizeof(long)>> bytes of the
+       table contain the size of the table itself, including the size bytes.
+       If an application tries to read what it thinks is one of these
+       string tables, without some way to validate the size, and for
+       some reason the size is wrong (byte swapping error, wrong location
+       for the string table, etc.), the only clue is likely to be a read
+       error when it tries to read the table, or a "virtual memory
+       exhausted" error when it tries to allocate 15 bazillon bytes
+       of space for the 15 bazillon byte table it is about to read.
+       This function at least allows us to answer the quesion, "is the
+       size reasonable?".
+*/
 
-/* returns the number of octets of storage required */
-unsigned int
-get_reloc_upper_bound (abfd, asect)
+long
+bfd_get_size (abfd)
      bfd *abfd;
-     sec_ptr asect;
 {
-  if (abfd->format != bfd_object) {
-    bfd_error = invalid_operation;
-    return 0;
-  }
-
-  return BFD_SEND (abfd, _get_reloc_upper_bound, (abfd, asect));
-}
+  FILE *fp;
+  struct stat buf;
 
-unsigned int
-bfd_canonicalize_reloc (abfd, asect, location, symbols)
-     bfd *abfd;
-     sec_ptr asect;
-     arelent **location;
-     asymbol **symbols;
-{
-  if (abfd->format != bfd_object) {
-    bfd_error = invalid_operation;
+  fp = bfd_cache_lookup (abfd);
+  if (0 != fstat (fileno (fp), &buf))
     return 0;
-  }
 
-  return BFD_SEND (abfd, _bfd_canonicalize_reloc, (abfd, asect, location, symbols));
+  return buf.st_size;
 }
 
-void
-bfd_print_symbol_vandf(file, symbol)
-PTR file;
-asymbol *symbol;
-{
-  flagword type = symbol->flags;
-  if (symbol->section != (asection *)NULL)
-    {
-      fprintf(file,"%08lx ", symbol->value+symbol->section->vma);
-    }
-  else 
-    {
-      fprintf(file,"%08lx ", symbol->value);
-    }
-  fprintf(file,"%c%c%c%c%c%c%c",
-         (type & BSF_LOCAL)  ? 'l':' ',
-         (type & BSF_GLOBAL) ? 'g' : ' ',
-         (type & BSF_IMPORT) ? 'i' : ' ',
-         (type & BSF_EXPORT) ? 'e' : ' ',
-         (type & BSF_UNDEFINED) ? 'u' : ' ',
-         (type & BSF_FORT_COMM) ? 'c' : ' ',
-         (type & BSF_DEBUGGING) ? 'd' :' ');
+/*
+FUNCTION
+       bfd_get_gp_size
 
-}
+SYNOPSIS
+       int bfd_get_gp_size(bfd *abfd);
 
+DESCRIPTION
+       Return the maximum size of objects to be optimized using the GP
+       register under MIPS ECOFF.  This is typically set by the -G
+       argument to the compiler, assembler or linker.
+*/
 
-boolean
-bfd_set_file_flags (abfd, flags)
+int
+bfd_get_gp_size (abfd)
      bfd *abfd;
-     flagword flags;
 {
-  if (abfd->format != bfd_object) {
-    bfd_error = wrong_format;
-    return false;
-  }
-
-  if (bfd_read_p (abfd)) {
-    bfd_error = invalid_operation;
-    return false;
-  }
+  if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
+    return ecoff_data (abfd)->gp_size;
+  return 0;
+}
 
-  if ((flags & bfd_applicable_file_flags (abfd)) != flags) {
-    bfd_error = invalid_operation;
-    return false;
-  }
+/*
+FUNCTION
+       bfd_set_gp_size
 
-  bfd_get_file_flags (abfd) = flags;
-return true;
-}
+SYNOPSIS
+       void bfd_set_gp_size(bfd *abfd, int i);
 
+DESCRIPTION
+       Set the maximum size of objects to be optimized using the GP
+       register under ECOFF or MIPS ELF.  This is typically set by
+       the -G argument to the compiler, assembler or linker.
+*/
 
 void
-bfd_set_reloc (ignore_abfd, asect, location, count)
-     bfd *ignore_abfd;
-     sec_ptr asect;
-     arelent **location;
-     unsigned int count;
+bfd_set_gp_size (abfd, i)
+     bfd *abfd;
+     int i;
 {
-  asect->orelocation  = location;
-  asect->reloc_count = count;
+  if (abfd->xvec->flavour == bfd_target_ecoff_flavour)
+    ecoff_data (abfd)->gp_size = i;
+  else if (abfd->xvec->flavour == bfd_target_elf_flavour)
+    elf_gp_size (abfd) = i;
 }
+
 /*
-If an output_bfd is supplied to this function the generated image
-will be relocatable, the relocations are copied to the output file
-after they have been changed to reflect the new state of the world.
-There are two ways of reflecting the results of partial linkage in an
-output file; by modifying the output data in place, and by modifying
-the relocation record. Some native formats (eg basic a.out and basic
-coff) have no way of specifying an addend in the relocation type, so
-the addend has to go in the output data.  This is no big deal since in
-these formats the output data slot will always be big enough for the
-addend. Complex reloc types with addends were invented to solve just
-this problem.
+FUNCTION
+       bfd_scan_vma
+
+SYNOPSIS
+       bfd_vma bfd_scan_vma(CONST char *string, CONST char **end, int base);
+
+DESCRIPTION
+       Convert, like <<strtoul>>, a numerical expression
+       @var{string} into a bfd_vma integer, and returns that integer.
+       (Though without as many bells and whistles as <<strtoul>>.)
+       The expression is assumed to be unsigned (i.e. positive).
+       If given a @var{base}, it is used as the base for conversion.
+       A base of 0 causes the function to interpret the string
+       in hex if a leading "0x" or "0X" is found, otherwise
+       in octal if a leading zero is found, otherwise in decimal.
+
+       Overflow is not detected.
 */
 
-bfd_reloc_status_enum_type
-bfd_perform_relocation(abfd,
-                      reloc_entry,
-                      data,
-                      input_section,
-                      output_bfd)
-bfd *abfd;
-arelent *reloc_entry;
-PTR data;
-asection *input_section;
-bfd *output_bfd;
+bfd_vma
+DEFUN(bfd_scan_vma,(string, end, base),
+      CONST char *string AND
+      CONST char **end AND
+      int base)
 {
-  bfd_vma relocation;
-  bfd_reloc_status_enum_type flag = bfd_reloc_ok;
-  bfd_vma relocation_before;
-  bfd_vma addr = reloc_entry->address ;
-  bfd_vma output_base = 0;
-  CONST struct rint_struct *howto = reloc_entry->howto;
-  asection *reloc_target_output_section;
-  asection *reloc_target_input_section;
-  asymbol *symbol;
-
-  if (reloc_entry->sym_ptr_ptr) {
-    symbol = *( reloc_entry->sym_ptr_ptr);
-    if ((symbol->flags & BSF_UNDEFINED) && output_bfd == (bfd *)NULL) {
-      flag = bfd_reloc_undefined;
-    }
-  }
-  else {
-    symbol = (asymbol*)NULL;
-  }
-
-  if (howto->special_function){
-    bfd_reloc_status_enum_type cont;
-    cont = howto->special_function(abfd,
-                                  reloc_entry,
-                                  symbol,
-                                  data,
-                                  input_section);
-    if (cont != bfd_reloc_continue) return cont;
-  }
+  bfd_vma value;
+  int digit;
 
-  /* 
-    Work out which section the relocation is targetted at and the
-    initial relocation command value.
-    */
+  /* Let the host do it if possible.  */
+  if (sizeof(bfd_vma) <= sizeof(unsigned long))
+    return (bfd_vma) strtoul (string, 0, base);
 
+  /* A negative base makes no sense, and we only need to go as high as hex.  */
+  if ((base < 0) || (base > 16))
+    return (bfd_vma) 0;
 
-  if (symbol != (asymbol *)NULL){
-    if (symbol->flags & BSF_FORT_COMM) {
-      relocation = 0;
-    }
-    else {
-      relocation = symbol->value;
-    }
-    if (symbol->section != (asection *)NULL)
+  if (base == 0)
+    {
+      if (string[0] == '0')
        {
-         reloc_target_input_section = symbol->section;
+         if ((string[1] == 'x') || (string[1] == 'X'))
+           base = 16;
+         /* XXX should we also allow "0b" or "0B" to set base to 2? */
+         else
+           base = 8;
        }
-    else {
-      reloc_target_input_section = (asection *)NULL;
-    }
-  }
-  else if (reloc_entry->section != (asection *)NULL)
-      {
-       relocation = 0;
-       reloc_target_input_section = reloc_entry->section;
-      }
-  else {
-    relocation = 0;
-    reloc_target_input_section = (asection *)NULL;
-  }
-
-
-  if (reloc_target_input_section != (asection *)NULL) {
-
-    reloc_target_output_section =
-      reloc_target_input_section->output_section;
-
-    if (output_bfd && howto->partial_inplace==false) {
-      output_base = 0;
-    }
-    else {
-      output_base = reloc_target_output_section->vma;
-
+      else
+       base = 10;
     }
-
-    relocation += output_base +   reloc_target_input_section->output_offset;
-  }
-
-  relocation += reloc_entry->addend ;
-
-
-  if(reloc_entry->address > (bfd_vma)(input_section->size)) 
-      {
-       return bfd_reloc_outofrange;
-      }
-         
-
-  if (howto->pc_relative == true)
-      {
-       /*
-         Anything which started out as pc relative should end up that
-         way too. 
-
-         There are two ways we can see a pcrel instruction. Sometimes
-         the pcrel displacement has been partially calculated, it
-         includes the distance from the start of the section to the
-         instruction in it (eg sun3), and sometimes the field is
-         totally blank - eg m88kbcs.
-         */
-
-       
-       relocation -= 
-         output_base +   input_section->output_offset;
-
-       if (howto->pcrel_offset == true) {
-         relocation -= reloc_entry->address;
-       }
-
-      }
-
-  if (output_bfd!= (bfd *)NULL) {
-    if ( howto->partial_inplace == false)  {
-      /*
-       This is a partial relocation, and we want to apply the relocation
-       to the reloc entry rather than the raw data. Modify the reloc
-       inplace to reflect what we now know.
-       */
-      reloc_entry->addend = relocation  ;
-      reloc_entry->section = reloc_target_input_section;
-      if (reloc_target_input_section != (asection *)NULL) {
-       /* If we know the output section we can forget the symbol */
-       reloc_entry->sym_ptr_ptr = (asymbol**)NULL;
-      }
-      reloc_entry->address += 
-       input_section->output_offset;
-      return flag;
+  if ((base == 16) &&
+      (string[0] == '0') && ((string[1] == 'x') || (string[1] == 'X')))
+    string += 2;
+  /* XXX should we also skip over "0b" or "0B" if base is 2? */
+    
+/* Speed could be improved with a table like hex_value[] in gas.  */
+#define HEX_VALUE(c) \
+  (isxdigit(c) ?                               \
+    (isdigit(c) ?                              \
+      (c - '0') :                              \
+      (10 + c - (islower(c) ? 'a' : 'A'))) :   \
+    42)
+
+  for (value = 0; (digit = HEX_VALUE(*string)) < base; string++)
+    {
+      value = value * base + digit;
     }
-    else 
-       {
-         /* This is a partial relocation, but inplace, so modify the
-            reloc record a bit
-            */
 
-       }
-  }
+  if (end)
+    *end = string;
 
-  reloc_entry->addend = 0;
-
-
-  /* 
-    Either we are relocating all the way, or we don't want to apply
-    the relocation to the reloc entry (probably because there isn't
-    any room in the output format to describe addends to relocs)
-    */
-  relocation >>= howto->rightshift;
-
-  /* Shift everything up to where it's going to be used */
-   
-  relocation <<= howto->bitpos;
-
-
-  /* Wait for the day when all have the mask in them */
-
-
-
-  relocation_before = relocation;
-
-
-  /* What we do:
-     i instruction to be left alone
-     o offset within instruction
-     r relocation offset to apply
-     S src mask
-     D dst mask
-     N ~dst mask
-     A part 1
-     B part 2
-     R result
-     
-     Do this:
-     i i i i i o o o o o       from bfd_get<size>
-     and           S S S S S   to get the size offset we want
-     +   r r r r r r r r r r  to get the final value to place
-     and           D D D D D  to chop to right size
-     -----------------------
-     A A A A A 
-     And this:
-     ...   i i i i i o o o o o from bfd_get<size>
-     and   N N N N N           get instruction
-     -----------------------
-     ...   B B B B B
-     
-     And then:      
-     B B B B B       
-     or             A A A A A     
-     -----------------------
-     R R R R R R R R R R       put into bfd_put<size>
-     */
-
-#define DOIT(x) \
-  x = ( (x & ~howto->dst_mask) | (((x & howto->src_mask) +  relocation) & howto->dst_mask))
-
-    switch (howto->size)
-       {
-       case 0:
-           {
-             char x = bfd_getchar(abfd, (char *)data + addr);
-             DOIT(x);
-             bfd_putchar(abfd,x, (unsigned char *) data + addr);
-           }
-         break;
-
-       case 1:
-           { 
-             short x = bfd_getshort(abfd, (bfd_byte *)data + addr);
-             DOIT(x);
-             bfd_putshort(abfd, x,   (unsigned char *)data + addr);
-           }
-         break;
-       case 2:
-           {
-             long  x = bfd_getlong(abfd, (bfd_byte *) data + addr);
-             DOIT(x);
-             bfd_putlong(abfd,x,    (bfd_byte *)data + addr);
-           }      
-         break;
-       case 3:
-         /* Do nothing */
-         break;
-       default:
-         return bfd_reloc_other;
-       }
-
-  return flag;
-}
-
-void
-bfd_assert(file, line)
-char *file;
-int line;
-{
-  printf("bfd assertion fail %s:%d\n",file,line);
-}
-
-
-boolean
-bfd_set_start_address(abfd, vma)
-bfd *abfd;
-bfd_vma vma;
-{
-  abfd->start_address = vma;
-  return true;
+  return value;
 }
 
+/*
+FUNCTION
+       stuff
+
+DESCRIPTION
+       Stuff which should be documented:
+
+.#define bfd_sizeof_headers(abfd, reloc) \
+.     BFD_SEND (abfd, _bfd_sizeof_headers, (abfd, reloc))
+.
+.#define bfd_find_nearest_line(abfd, sec, syms, off, file, func, line) \
+.     BFD_SEND (abfd, _bfd_find_nearest_line,  (abfd, sec, syms, off, file, func, line))
+.
+.       {* Do these three do anything useful at all, for any back end?  *}
+.#define bfd_debug_info_start(abfd) \
+.        BFD_SEND (abfd, _bfd_debug_info_start, (abfd))
+.
+.#define bfd_debug_info_end(abfd) \
+.        BFD_SEND (abfd, _bfd_debug_info_end, (abfd))
+.
+.#define bfd_debug_info_accumulate(abfd, section) \
+.        BFD_SEND (abfd, _bfd_debug_info_accumulate, (abfd, section))
+.
+.
+.#define bfd_stat_arch_elt(abfd, stat) \
+.        BFD_SEND (abfd, _bfd_stat_arch_elt,(abfd, stat))
+.
+.#define bfd_set_arch_mach(abfd, arch, mach)\
+.        BFD_SEND ( abfd, _bfd_set_arch_mach, (abfd, arch, mach))
+.
+.#define bfd_get_relocated_section_contents(abfd, seclet, data, relocateable) \
+.      BFD_SEND (abfd, _bfd_get_relocated_section_contents, (abfd, seclet, data, relocateable))
+. 
+.#define bfd_relax_section(abfd, section, symbols) \
+.       BFD_SEND (abfd, _bfd_relax_section, (abfd, section, symbols))
+.
+.#define bfd_seclet_link(abfd, data, relocateable) \
+.       BFD_SEND (abfd, _bfd_seclet_link, (abfd, data, relocateable))
 
-bfd_vma bfd_log2(x)
-bfd_vma x;
-{
-  bfd_vma  result = 0;
-  while ( (bfd_vma)(1<< result) < x)
-    result++;
-  return result;
-}
-
-/* bfd_get_mtime:  Return cached file modification time (e.g. as read
-   from archive header for archive members, or from file system if we have
-   been called before); else determine modify time, cache it, and
-   return it.  */
-
-long
-bfd_get_mtime (abfd)
-     bfd *abfd;
-{
-  FILE *fp;
-  struct stat buf;
-
-  if (abfd->mtime_set)
-    return abfd->mtime;
-
-  fp = bfd_cache_lookup (abfd);
-  if (0 != fstat (fileno (fp), &buf))
-    return 0;
-
-  abfd->mtime_set = true;
-  abfd->mtime = buf.st_mtime;
-  return abfd->mtime;
-}
+*/
This page took 0.037219 seconds and 4 git commands to generate.