gdb/exec.h

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