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 /* Make a copy ABFD's filename using bfd_alloc, and reassign it to the
  25    BFD.  This ensures that the BFD's filename has the same lifetime as
  26    the BFD itself.  */
  27
  28 void gdb_bfd_stash_filename (struct bfd *abfd);
  29
  30 /* Open a read-only (FOPEN_RB) BFD given arguments like bfd_fopen.
  31    Returns NULL on error.  On success, returns a new reference to the
  32    BFD, which must be freed with gdb_bfd_unref.  BFDs returned by this
  33    call are shared among all callers opening the same file.  If FD is
  34    not -1, then after this call it is owned by BFD.  */
  35
  36 struct bfd *gdb_bfd_open (const char *name, const char *target, int fd);
  37
  38 /* Increment the reference count of ABFD.  It is fine for ABFD to be
  39    NULL; in this case the function does nothing.  */
  40
  41 void gdb_bfd_ref (struct bfd *abfd);
  42
  43 /* Decrement the reference count of ABFD.  If this is the last
  44    reference, ABFD will be freed.  If ABFD is NULL, this function does
  45    nothing.  */
  46
  47 void gdb_bfd_unref (struct bfd *abfd);
  48
  49 /* Try to read or map the contents of the section SECT.  If
  50    successful, the section data is returned and *SIZE is set to the
  51    size of the section data; this may not be the same as the size
  52    according to bfd_get_section_size if the section was compressed.
  53    The returned section data is associated with the BFD and will be
  54    destroyed when the BFD is destroyed.  There is no other way to free
  55    it; for temporary uses of section data, see
  56    bfd_malloc_and_get_section.  SECT may not have relocations.  This
  57    function will throw on error.  */
  58
  59 const gdb_byte *gdb_bfd_map_section (asection *section, bfd_size_type *size);
  60
  61 \f
  62
  63 /* A wrapper for bfd_fopen that initializes the gdb-specific reference
  64    count and calls gdb_bfd_stash_filename.  */
  65
  66 bfd *gdb_bfd_fopen (const char *, const char *, const char *, int);
  67
  68 /* A wrapper for bfd_openr that initializes the gdb-specific reference
  69    count and calls gdb_bfd_stash_filename.  */
  70
  71 bfd *gdb_bfd_openr (const char *, const char *);
  72
  73 /* A wrapper for bfd_openw that initializes the gdb-specific reference
  74    count and calls gdb_bfd_stash_filename.  */
  75
  76 bfd *gdb_bfd_openw (const char *, const char *);
  77
  78 /* A wrapper for bfd_openr_iovec that initializes the gdb-specific
  79    reference count and calls gdb_bfd_stash_filename.  */
  80
  81 bfd *gdb_bfd_openr_iovec (const char *filename, const char *target,
  82                           void *(*open_func) (struct bfd *nbfd,
  83                                               void *open_closure),
  84                           void *open_closure,
  85                           file_ptr (*pread_func) (struct bfd *nbfd,
  86                                                   void *stream,
  87                                                   void *buf,
  88                                                   file_ptr nbytes,
  89                                                   file_ptr offset),
  90                           int (*close_func) (struct bfd *nbfd,
  91                                              void *stream),
  92                           int (*stat_func) (struct bfd *abfd,
  93                                             void *stream,
  94                                             struct stat *sb));
  95
  96 /* A wrapper for bfd_openr_next_archived_file that initializes the
  97    gdb-specific reference count and calls gdb_bfd_stash_filename.  */
  98
  99 bfd *gdb_bfd_openr_next_archived_file (bfd *archive, bfd *previous);
 100
 101 /* A wrapper for bfd_fdopenr that initializes the gdb-specific
 102    reference count and calls gdb_bfd_stash_filename.  */
 103
 104 bfd *gdb_bfd_fdopenr (const char *filename, const char *target, int fd);
 105
 106 #endif /* GDB_BFD_H */