gdb/gdb_bfd.h

   1 /* Definitions for BFD wrappers used by GDB.
   2
   3    Copyright (C) 2011, 2012
   4    Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #ifndef GDB_BFD_H
  22 #define GDB_BFD_H
  23
  24 #include "registry.h"
  25
  26 DECLARE_REGISTRY (bfd);
  27
  28 /* Make a copy ABFD's filename using bfd_alloc, and reassign it to the
  29    BFD.  This ensures that the BFD's filename has the same lifetime as
  30    the BFD itself.  */
  31
  32 void gdb_bfd_stash_filename (struct bfd *abfd);
  33
  34 /* Open a read-only (FOPEN_RB) BFD given arguments like bfd_fopen.
  35    Returns NULL on error.  On success, returns a new reference to the
  36    BFD, which must be freed with gdb_bfd_unref.  BFDs returned by this
  37    call are shared among all callers opening the same file.  If FD is
  38    not -1, then after this call it is owned by BFD.  */
  39
  40 struct bfd *gdb_bfd_open (const char *name, const char *target, int fd);
  41
  42 /* Increment the reference count of ABFD.  It is fine for ABFD to be
  43    NULL; in this case the function does nothing.  */
  44
  45 void gdb_bfd_ref (struct bfd *abfd);
  46
  47 /* Decrement the reference count of ABFD.  If this is the last
  48    reference, ABFD will be freed.  If ABFD is NULL, this function does
  49    nothing.  */
  50
  51 void gdb_bfd_unref (struct bfd *abfd);
  52
  53 /* Try to read or map the contents of the section SECT.  If
  54    successful, the section data is returned and *SIZE is set to the
  55    size of the section data; this may not be the same as the size
  56    according to bfd_get_section_size if the section was compressed.
  57    The returned section data is associated with the BFD and will be
  58    destroyed when the BFD is destroyed.  There is no other way to free
  59    it; for temporary uses of section data, see
  60    bfd_malloc_and_get_section.  SECT may not have relocations.  This
  61    function will throw on error.  */
  62
  63 const gdb_byte *gdb_bfd_map_section (asection *section, bfd_size_type *size);
  64
  65 \f
  66
  67 /* A wrapper for bfd_fopen that initializes the gdb-specific reference
  68    count and calls gdb_bfd_stash_filename.  */
  69
  70 bfd *gdb_bfd_fopen (const char *, const char *, const char *, int);
  71
  72 /* A wrapper for bfd_openr that initializes the gdb-specific reference
  73    count and calls gdb_bfd_stash_filename.  */
  74
  75 bfd *gdb_bfd_openr (const char *, const char *);
  76
  77 /* A wrapper for bfd_openw that initializes the gdb-specific reference
  78    count and calls gdb_bfd_stash_filename.  */
  79
  80 bfd *gdb_bfd_openw (const char *, const char *);
  81
  82 /* A wrapper for bfd_openr_iovec that initializes the gdb-specific
  83    reference count and calls gdb_bfd_stash_filename.  */
  84
  85 bfd *gdb_bfd_openr_iovec (const char *filename, const char *target,
  86                           void *(*open_func) (struct bfd *nbfd,
  87                                               void *open_closure),
  88                           void *open_closure,
  89                           file_ptr (*pread_func) (struct bfd *nbfd,
  90                                                   void *stream,
  91                                                   void *buf,
  92                                                   file_ptr nbytes,
  93                                                   file_ptr offset),
  94                           int (*close_func) (struct bfd *nbfd,
  95                                              void *stream),
  96                           int (*stat_func) (struct bfd *abfd,
  97                                             void *stream,
  98                                             struct stat *sb));
  99
 100 /* A wrapper for bfd_openr_next_archived_file that initializes the
 101    gdb-specific reference count and calls gdb_bfd_stash_filename.  */
 102
 103 bfd *gdb_bfd_openr_next_archived_file (bfd *archive, bfd *previous);
 104
 105 /* A wrapper for bfd_fdopenr that initializes the gdb-specific
 106    reference count and calls gdb_bfd_stash_filename.  */
 107
 108 bfd *gdb_bfd_fdopenr (const char *filename, const char *target, int fd);
 109
 110 #endif /* GDB_BFD_H */