gdb/gdb_bfd.h

   1 /* Definitions for BFD wrappers used by GDB.
   2
   3    Copyright (C) 2011-2014 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef GDB_BFD_H
  21 #define GDB_BFD_H
  22
  23 #include "registry.h"
  24
  25 DECLARE_REGISTRY (bfd);
  26
  27 /* Open a read-only (FOPEN_RB) BFD given arguments like bfd_fopen.
  28    Returns NULL on error.  On success, returns a new reference to the
  29    BFD, which must be freed with gdb_bfd_unref.  BFDs returned by this
  30    call are shared among all callers opening the same file.  If FD is
  31    not -1, then after this call it is owned by BFD.  */
  32
  33 struct bfd *gdb_bfd_open (const char *name, const char *target, int fd);
  34
  35 /* Increment the reference count of ABFD.  It is fine for ABFD to be
  36    NULL; in this case the function does nothing.  */
  37
  38 void gdb_bfd_ref (struct bfd *abfd);
  39
  40 /* Decrement the reference count of ABFD.  If this is the last
  41    reference, ABFD will be freed.  If ABFD is NULL, this function does
  42    nothing.  */
  43
  44 void gdb_bfd_unref (struct bfd *abfd);
  45
  46 /* Mark the CHILD BFD as being a member of PARENT.  Also, increment
  47    the reference count of CHILD.  Calling this function ensures that
  48    as along as CHILD remains alive, PARENT will as well.  Both CHILD
  49    and PARENT must be non-NULL.  This can be called more than once
  50    with the same arguments; but it is not allowed to call it for a
  51    single CHILD with different values for PARENT.  */
  52
  53 void gdb_bfd_mark_parent (bfd *child, bfd *parent);
  54
  55 /* Try to read or map the contents of the section SECT.  If
  56    successful, the section data is returned and *SIZE is set to the
  57    size of the section data; this may not be the same as the size
  58    according to bfd_get_section_size if the section was compressed.
  59    The returned section data is associated with the BFD and will be
  60    destroyed when the BFD is destroyed.  There is no other way to free
  61    it; for temporary uses of section data, see
  62    bfd_malloc_and_get_section.  SECT may not have relocations.  This
  63    function will throw on error.  */
  64
  65 const gdb_byte *gdb_bfd_map_section (asection *section, bfd_size_type *size);
  66
  67 /* Compute the CRC for ABFD.  The CRC is used to find and verify
  68    separate debug files.  When successful, this fills in *CRC_OUT and
  69    returns 1.  Otherwise, this issues a warning and returns 0.  */
  70
  71 int gdb_bfd_crc (struct bfd *abfd, unsigned long *crc_out);
  72
  73 \f
  74
  75 /* A wrapper for bfd_fopen that initializes the gdb-specific reference
  76    count.  */
  77
  78 bfd *gdb_bfd_fopen (const char *, const char *, const char *, int);
  79
  80 /* A wrapper for bfd_openr that initializes the gdb-specific reference
  81    count.  */
  82
  83 bfd *gdb_bfd_openr (const char *, const char *);
  84
  85 /* A wrapper for bfd_openw that initializes the gdb-specific reference
  86    count.  */
  87
  88 bfd *gdb_bfd_openw (const char *, const char *);
  89
  90 /* A wrapper for bfd_openr_iovec that initializes the gdb-specific
  91    reference count.  */
  92
  93 bfd *gdb_bfd_openr_iovec (const char *filename, const char *target,
  94                           void *(*open_func) (struct bfd *nbfd,
  95                                               void *open_closure),
  96                           void *open_closure,
  97                           file_ptr (*pread_func) (struct bfd *nbfd,
  98                                                   void *stream,
  99                                                   void *buf,
 100                                                   file_ptr nbytes,
 101                                                   file_ptr offset),
 102                           int (*close_func) (struct bfd *nbfd,
 103                                              void *stream),
 104                           int (*stat_func) (struct bfd *abfd,
 105                                             void *stream,
 106                                             struct stat *sb));
 107
 108 /* A wrapper for bfd_openr_next_archived_file that initializes the
 109    gdb-specific reference count.  */
 110
 111 bfd *gdb_bfd_openr_next_archived_file (bfd *archive, bfd *previous);
 112
 113 /* A wrapper for bfd_fdopenr that initializes the gdb-specific
 114    reference count.  */
 115
 116 bfd *gdb_bfd_fdopenr (const char *filename, const char *target, int fd);
 117
 118 \f
 119
 120 /* Return the index of the BFD section SECTION.  Ordinarily this is
 121    just the section's index, but for some special sections, like
 122    bfd_com_section_ptr, it will be a synthesized value.  */
 123
 124 int gdb_bfd_section_index (bfd *abfd, asection *section);
 125
 126
 127 /* Like bfd_count_sections, but include any possible global sections,
 128    like bfd_com_section_ptr.  */
 129
 130 int gdb_bfd_count_sections (bfd *abfd);
 131
 132 /* Return true if any section requires relocations, false
 133    otherwise.  */
 134
 135 int gdb_bfd_requires_relocations (bfd *abfd);
 136
 137 #endif /* GDB_BFD_H */