Lint (saber actually).
[binutils-gdb.git] / bfd / libbfd.h
index 19589c8ef551870af21f15f38c9a2c3215e59aec..f7b29121b92edbe36ae435aa0887f3e66c472849 100644 (file)
@@ -1,23 +1,23 @@
-/* libbfd.h -- Declarations used by bfd library implementation.
-   This include file is not for users of the library */
+/* libbfd.h -- Declarations used by bfd library *implementation*.
+   (This include file is not for users of the library.)
+   Copyright (C) 1990-1991 Free Software Foundation, Inc.
+   Written by Cygnus Support.
 
-/* Copyright (C) 1990, 1991 Free Software Foundation, Inc.
+This file is part of BFD, the Binary File Descriptor library.
 
-This file is part of BFD, the Binary File Diddler.
-
-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.  */
 
 /* $Id$ */
 
@@ -65,14 +65,17 @@ PROTO (char *, zalloc, (bfd_size_type size));
 PROTO(PTR, bfd_alloc, (bfd *abfd, bfd_size_type size));
 PROTO(PTR, bfd_zalloc,(bfd *abfd, bfd_size_type size));
 PROTO(PTR, bfd_realloc,(bfd *abfd, PTR orig, bfd_size_type new));
+PROTO(void, bfd_alloc_grow,(bfd *abfd, PTR thing, bfd_size_type size));
+PROTO(PTR, bfd_alloc_finish,(bfd *abfd));
+
 #define bfd_release(x,y) (void) obstack_free(&(x->memory),y)
 
-PROTO (bfd_target *, bfd_find_target, (CONST char *target_name));
+
 PROTO (bfd_size_type, bfd_read, (PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
 PROTO (bfd_size_type, bfd_write, (PTR ptr, bfd_size_type size, bfd_size_type nitems, bfd *abfd));
 
-PROTO (FILE *, bfd_cache_lookup, (bfd *));
-PROTO (void, bfd_cache_close, (bfd *));
+
+
 PROTO (int, bfd_seek,(bfd* abfd, file_ptr fp , int direction));
 PROTO (long, bfd_tell, (bfd *abfd));
 PROTO (bfd *, _bfd_create_empty_archive_element_shell, (bfd *obfd));
@@ -90,15 +93,18 @@ PROTO (bfd *, new_bfd, ());
 PROTO (boolean, bfd_add_to_string_table, (char **table, char *new_string,
                                          unsigned int *table_length,
                                          char **free_ptr));
-     
-PROTO (long, _do_getblong, (unsigned char *addr));
-PROTO (long, _do_getllong, (unsigned char *addr));
-PROTO (short, _do_getbshort, (unsigned char *addr));
-PROTO (short, _do_getlshort, (unsigned char *addr));
-PROTO (void, _do_putblong, (unsigned long data, unsigned char *addr));
-PROTO (void, _do_putllong, (unsigned long data, unsigned char *addr));
-PROTO (void, _do_putbshort, (int data, unsigned char *addr));
-PROTO (void, _do_putlshort, (int data, unsigned char *addr));
+PROTO (bfd_vma, _do_getb64, (unsigned char *addr));     
+PROTO (bfd_vma, _do_getl64, (unsigned char *addr));     
+PROTO (bfd_vma, _do_getb32, (unsigned char *addr));
+PROTO (bfd_vma, _do_getl32, (unsigned char *addr));
+PROTO (bfd_vma, _do_getb16, (unsigned char *addr));
+PROTO (bfd_vma, _do_getl16, (unsigned char *addr));
+PROTO (void, _do_putb64, (bfd_vma data, unsigned char *addr));
+PROTO (void, _do_putl64, (bfd_vma data, unsigned char *addr));
+PROTO (void, _do_putb32, (bfd_vma data, unsigned char *addr));
+PROTO (void, _do_putl32, (bfd_vma data, unsigned char *addr));
+PROTO (void, _do_putb16, (bfd_vma data, unsigned char *addr));
+PROTO (void, _do_putl16, (bfd_vma data, unsigned char *addr));
 
 PROTO (boolean, bfd_false, (bfd *ignore));
 PROTO (boolean, bfd_true, (bfd *ignore));
@@ -115,9 +121,12 @@ PROTO (boolean, _bfd_dummy_core_file_matches_executable_p, (bfd *core_bfd,
                                                            bfd *exec_bfd));
 PROTO (bfd_target *, _bfd_dummy_target, (bfd *abfd));
 
-PROTO (void, bfd_dont_truncate_arname, (bfd *abfd, char *filename, char *hdr));
-PROTO (void, bfd_bsd_truncate_arname, (bfd *abfd, char *filename, char *hdr));
-PROTO (void, bfd_gnu_truncate_arname, (bfd *abfd, char *filename, char *hdr));
+PROTO (void, bfd_dont_truncate_arname, (bfd *abfd, CONST char *filename,
+                                       char *hdr));
+PROTO (void, bfd_bsd_truncate_arname, (bfd *abfd, CONST char *filename,
+                                       char *hdr));
+PROTO (void, bfd_gnu_truncate_arname, (bfd *abfd, CONST char *filename,
+                                       char *hdr));
 
 PROTO (boolean, bsd_write_armap, (bfd *arch, unsigned int elength,
                                  struct orl *map, int orl_count, int stridx));
@@ -131,7 +140,7 @@ PROTO (bfd *, bfd_generic_openr_next_archived_file, (bfd *archive,
 PROTO(int, bfd_generic_stat_arch_elt, (bfd *, struct stat *));
 
 PROTO(boolean, bfd_generic_get_section_contents,
-      (bfd *abfd, sec_ptr section, PTR location, file_ptr offset, int count));
+      (bfd *abfd, sec_ptr section, PTR location, file_ptr offset, bfd_size_type count));
 
 /* Macros to tell if bfds are read or write enabled.
 
@@ -155,8 +164,6 @@ PROTO (void, bfd_assert,(char*,int));
 PROTO (FILE *, bfd_cache_lookup_worker, (bfd *));
 
 extern bfd *bfd_last_cache;
-#define bfd_cache_lookup(x) \
-     (x==bfd_last_cache?(FILE*)(bfd_last_cache->iostream):bfd_cache_lookup_worker(x))
     
 /* Now Steve, what's the story here? */
 #ifdef lint
@@ -166,3 +173,93 @@ extern bfd *bfd_last_cache;
 #define itos(x) ((char*)(x))
 #define stoi(x) ((int)(x))
 #endif
+
+/* Generic routine for close_and_cleanup is really just bfd_true.  */
+#define        bfd_generic_close_and_cleanup   bfd_true
+
+/* THE FOLLOWING IS EXTRACTED FROM THE SOURCE*/
+
+/* FROM libbfd.c*/
+/* ------------------------------START FROM libbfd.c
+
+*i bfd_log2
+Return the log base 2 of the value supplied, rounded up. eg an arg
+of 1025 would return 11.
+*/
+ PROTO(bfd_vma, bfd_log2,(bfd_vma x));
+
+/*
+
+ --------------------------------END FROM libbfd.c*/
+
+/* FROM cache.c*/
+/* ------------------------------START FROM cache.c
+ BFD_CACHE_MAX_OPEN
+The maxiumum number of files which the cache will keep open at one
+time.
+*/
+#define BFD_CACHE_MAX_OPEN 10
+
+/*
+
+  bfd_last_cache
+Zero, or a pointer to the topmost BFD on the chain.  This is used by
+the @code{bfd_cache_lookup} macro in @file{libbfd.h} to determine when
+it can avoid a function call.
+*/
+extern bfd *bfd_last_cache;
+
+/*
+
+  bfd_cache_lookup
+Checks to see if the required BFD is the same as the last one looked
+up. If so then it can use the iostream in the BFD with impunity, since
+it can't have changed since the last lookup, otherwise it has to
+perform the complicated lookup function
+*/
+#define bfd_cache_lookup(x) \
+     ((x)==bfd_last_cache? \
+        (FILE*)(bfd_last_cache->iostream): \
+         bfd_cache_lookup_worker(x))
+
+/*
+
+*i bfd_cache_init
+Initialize a BFD by putting it on the cache LRU.
+*/
+ PROTO(void, bfd_cache_init, (bfd *));
+
+/*
+
+*i bfd_cache_close
+Remove the BFD from the cache. If the attached file is open, then close it too.
+*/
+ PROTO(void, bfd_cache_close, (bfd *));
+
+/*
+
+*i bfd_open_file
+Call the OS to open a file for this BFD.  Returns the FILE *
+(possibly null) that results from this operation.  Sets up the
+BFD so that future accesses know the file is open. If the FILE *
+returned is null, then there is won't have been put in the cache, so
+it won't have to be removed from it.
+*/
+ PROTO(FILE *, bfd_open_file, (bfd *));
+
+/*
+
+*i bfd_cache_lookup_worker
+Called when the macro @code{bfd_cache_lookup} fails to find a quick
+answer. Finds a file descriptor for this BFD.  If necessary, it open it.
+If there are already more than BFD_CACHE_MAX_OPEN files open, it trys to close
+one first, to avoid running out of file descriptors. 
+*/
+ PROTO(FILE *, bfd_cache_lookup_worker, (bfd *));
+
+/*
+
+ --------------------------------END FROM cache.c*/
+
+/* FROM reloc.c*/
+