gdb/exec.h

   1 /* Work with executable files, for GDB, the GNU debugger.
   2
   3    Copyright (C) 2003-2020 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 EXEC_H
  21 #define EXEC_H
  22
  23 #include "target.h"
  24 #include "progspace.h"
  25 #include "memrange.h"
  26 #include "symfile-add-flags.h"
  27
  28 struct target_section;
  29 struct target_ops;
  30 struct bfd;
  31 struct objfile;
  32
  33 #define exec_bfd current_program_space->ebfd
  34 #define exec_bfd_mtime current_program_space->ebfd_mtime
  35 #define exec_filename current_program_space->pspace_exec_filename
  36
  37 /* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
  38    Returns 0 if OK, 1 on error.  */
  39
  40 extern int build_section_table (struct bfd *, struct target_section **,
  41                                 struct target_section **);
  42
  43 /* Remove all entries from TABLE.  */
  44
  45 extern void clear_section_table (struct target_section_table *table);
  46
  47 /* The current inferior is a child vforked and its program space is
  48    shared with its parent.  This pushes the exec target on the
  49    current/child inferior's target stack if there are sections in the
  50    program space's section table.  */
  51
  52 extern void exec_on_vfork ();
  53
  54 /* Read from mappable read-only sections of BFD executable files.
  55    Return TARGET_XFER_OK, if read is successful.  Return
  56    TARGET_XFER_EOF if read is done.  Return TARGET_XFER_E_IO
  57    otherwise.  */
  58
  59 extern enum target_xfer_status
  60   exec_read_partial_read_only (gdb_byte *readbuf, ULONGEST offset,
  61                                ULONGEST len, ULONGEST *xfered_len);
  62
  63 /* Read or write from mappable sections of BFD executable files.
  64
  65    Request to transfer up to LEN 8-bit bytes of the target sections
  66    defined by SECTIONS and SECTIONS_END.  The OFFSET specifies the
  67    starting address.
  68    If SECTION_NAME is not NULL, only access sections with that same
  69    name.
  70
  71    Return the number of bytes actually transfered, or zero when no
  72    data is available for the requested range.
  73
  74    This function is intended to be used from target_xfer_partial
  75    implementations.  See target_read and target_write for more
  76    information.
  77
  78    One, and only one, of readbuf or writebuf must be non-NULL.  */
  79
  80 extern enum target_xfer_status
  81   section_table_xfer_memory_partial (gdb_byte *,
  82                                      const gdb_byte *,
  83                                      ULONGEST, ULONGEST, ULONGEST *,
  84                                      struct target_section *,
  85                                      struct target_section *,
  86                                      const char *);
  87
  88 /* Read from mappable read-only sections of BFD executable files.
  89    Similar to exec_read_partial_read_only, but return
  90    TARGET_XFER_UNAVAILABLE if data is unavailable.  */
  91
  92 extern enum target_xfer_status
  93   section_table_read_available_memory (gdb_byte *readbuf, ULONGEST offset,
  94                                        ULONGEST len, ULONGEST *xfered_len);
  95
  96 /* Set the loaded address of a section.  */
  97 extern void exec_set_section_address (const char *, int, CORE_ADDR);
  98
  99 /* Remove all target sections owned by OWNER.  */
 100
 101 extern void remove_target_sections (void *owner);
 102
 103 /* Add the sections array defined by [SECTIONS..SECTIONS_END[ to the
 104    current set of target sections.  */
 105
 106 extern void add_target_sections (void *owner,
 107                                  struct target_section *sections,
 108                                  struct target_section *sections_end);
 109
 110 /* Add the sections of OBJFILE to the current set of target sections.
 111  * OBJFILE owns the new target sections.  */
 112
 113 extern void add_target_sections_of_objfile (struct objfile *objfile);
 114
 115 /* Prints info about all sections defined in the TABLE.  ABFD is
 116    special cased --- it's filename is omitted; if it is the executable
 117    file, its entry point is printed.  */
 118
 119 extern void print_section_info (struct target_section_table *table,
 120                                 bfd *abfd);
 121
 122 extern void exec_close (void);
 123
 124 /* Helper function that attempts to open the symbol file at EXEC_FILE_HOST.
 125    If successful, it proceeds to add the symbol file as the main symbol file.
 126
 127    ADD_FLAGS is passed on to the function adding the symbol file.  */
 128 extern void try_open_exec_file (const char *exec_file_host,
 129                                 struct inferior *inf,
 130                                 symfile_add_flags add_flags);
 131 #endif