gdb/gdb_bfd.h - gdb

Global variables defined

Macros defined

Source code

  1. /* Definitions for BFD wrappers used by GDB.

  3.    Copyright (C) 2011-2015 Free Software Foundation, Inc.

  5.    This file is part of GDB.

  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.

  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.

  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/>.  */

  20. #ifndef GDB_BFD_H
  21. ‌#define GDB_BFD_H

  23. #include "registry.h"

  25. ‌DECLARE_REGISTRY (bfd);

  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.  */

  33. struct bfd *gdb_bfd_open (const char *name, const char *target, int fd);

  35. /* Increment the reference count of ABFD.  It is fine for ABFD to be
  36.    NULL; in this case the function does nothing.  */

  38. void gdb_bfd_ref (struct bfd *abfd);

  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.  */

  44. void gdb_bfd_unref (struct bfd *abfd);

  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.  */

  53. void gdb_bfd_mark_parent (bfd *child, bfd *parent);

  55. /* Mark INCLUDEE as being included by INCLUDER.
  56.    This is used to associate the life time of INCLUDEE with INCLUDER.
  57.    For example, with Fission, one file can refer to debug info in another
  58.    file, and internal tables we build for the main file (INCLUDER) may refer
  59.    to data contained in INCLUDEE.  Therefore we want to keep INCLUDEE around
  60.    at least as long as INCLUDER exists.

  62.    Note that this is different than gdb_bfd_mark_parent because in our case
  63.    lifetime tracking is based on the "parent" whereas in gdb_bfd_mark_parent
  64.    lifetime tracking is based on the "child".  Plus in our case INCLUDEE could
  65.    have multiple different "parents".  */

  67. void gdb_bfd_record_inclusion (bfd *includer, bfd *includee);

  69. /* Try to read or map the contents of the section SECT.  If
  70.    successful, the section data is returned and *SIZE is set to the
  71.    size of the section data; this may not be the same as the size
  72.    according to bfd_get_section_size if the section was compressed.
  73.    The returned section data is associated with the BFD and will be
  74.    destroyed when the BFD is destroyed.  There is no other way to free
  75.    it; for temporary uses of section data, see
  76.    bfd_malloc_and_get_section.  SECT may not have relocations.  This
  77.    function will throw on error.  */

  79. const gdb_byte *gdb_bfd_map_section (asection *section, bfd_size_type *size);

  81. /* Compute the CRC for ABFD.  The CRC is used to find and verify
  82.    separate debug files.  When successful, this fills in *CRC_OUT and
  83.    returns 1.  Otherwise, this issues a warning and returns 0.  */

  85. int gdb_bfd_crc (struct bfd *abfd, unsigned long *crc_out);



  89. /* A wrapper for bfd_fopen that initializes the gdb-specific reference
  90.    count.  */

  92. bfd *gdb_bfd_fopen (const char *, const char *, const char *, int);

  94. /* A wrapper for bfd_openr that initializes the gdb-specific reference
  95.    count.  */

  97. bfd *gdb_bfd_openr (const char *, const char *);

  99. /* A wrapper for bfd_openw that initializes the gdb-specific reference
  100.    count.  */

  102. bfd *gdb_bfd_openw (const char *, const char *);

  104. /* A wrapper for bfd_openr_iovec that initializes the gdb-specific
  105.    reference count.  */

  107. bfd *gdb_bfd_openr_iovec (const char *filename, const char *target,
  108.                           void *(*open_func) (struct bfd *nbfd,
  109.                                               void *open_closure),
  110.                           void *open_closure,
  111.                           file_ptr (*pread_func) (struct bfd *nbfd,
  112.                                                   void *stream,
  113.                                                   void *buf,
  114.                                                   file_ptr nbytes,
  115.                                                   file_ptr offset),
  116.                           int (*close_func) (struct bfd *nbfd,
  117.                                              void *stream),
  118.                           int (*stat_func) (struct bfd *abfd,
  119.                                             void *stream,
  120.                                             struct stat *sb));

  122. /* A wrapper for bfd_openr_next_archived_file that initializes the
  123.    gdb-specific reference count.  */

  125. bfd *gdb_bfd_openr_next_archived_file (bfd *archive, bfd *previous);

  127. /* A wrapper for bfd_fdopenr that initializes the gdb-specific
  128.    reference count.  */

  130. bfd *gdb_bfd_fdopenr (const char *filename, const char *target, int fd);



  134. /* Return the index of the BFD section SECTION.  Ordinarily this is
  135.    just the section's index, but for some special sections, like
  136.    bfd_com_section_ptr, it will be a synthesized value.  */

  138. int gdb_bfd_section_index (bfd *abfd, asection *section);


  141. /* Like bfd_count_sections, but include any possible global sections,
  142.    like bfd_com_section_ptr.  */

  144. int gdb_bfd_count_sections (bfd *abfd);

  146. /* Return true if any section requires relocations, false
  147.    otherwise.  */

  149. int gdb_bfd_requires_relocations (bfd *abfd);

  151. #endif /* GDB_BFD_H */