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