xref: /dragonfly/contrib/gdb-7/gdb/gdbcore.h (revision 73e0051e)
1 /* Machine independent variables that describe the core file under GDB.
2 
3    Copyright (C) 1986, 1987, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4    1997, 1998, 1999, 2000, 2001, 2004, 2007, 2008, 2009
5    Free Software Foundation, Inc.
6 
7    This file is part of GDB.
8 
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13 
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18 
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
21 
22 /* Interface routines for core, executable, etc.  */
23 
24 #if !defined (GDBCORE_H)
25 #define GDBCORE_H 1
26 
27 struct type;
28 struct regcache;
29 
30 #include "bfd.h"
31 
32 /* Return the name of the executable file as a string.
33    ERR nonzero means get error if there is none specified;
34    otherwise return 0 in that case.  */
35 
36 extern char *get_exec_file (int err);
37 
38 /* Nonzero if there is a core file.  */
39 
40 extern int have_core_file_p (void);
41 
42 /* Report a memory error with error().  */
43 
44 extern void memory_error (int status, CORE_ADDR memaddr);
45 
46 /* Like target_read_memory, but report an error if can't read.  */
47 
48 extern void read_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
49 
50 /* Like target_read_stack, but report an error if can't read.  */
51 
52 extern void read_stack (CORE_ADDR memaddr, gdb_byte *myaddr, int len);
53 
54 /* Read an integer from debugged memory, given address and number of
55    bytes.  */
56 
57 extern LONGEST read_memory_integer (CORE_ADDR memaddr,
58 				    int len, enum bfd_endian byte_order);
59 extern int safe_read_memory_integer (CORE_ADDR memaddr, int len,
60 				     enum bfd_endian byte_order, LONGEST *return_value);
61 
62 /* Read an unsigned integer from debugged memory, given address and
63    number of bytes.  */
64 
65 extern ULONGEST read_memory_unsigned_integer (CORE_ADDR memaddr,
66 					      int len, enum bfd_endian byte_order);
67 
68 /* Read a null-terminated string from the debuggee's memory, given address,
69  * a buffer into which to place the string, and the maximum available space */
70 
71 extern void read_memory_string (CORE_ADDR, char *, int);
72 
73 /* Read the pointer of type TYPE at ADDR, and return the address it
74    represents. */
75 
76 CORE_ADDR read_memory_typed_address (CORE_ADDR addr, struct type *type);
77 
78 /* This takes a char *, not void *.  This is probably right, because
79    passing in an int * or whatever is wrong with respect to
80    byteswapping, alignment, different sizes for host vs. target types,
81    etc.  */
82 
83 extern void write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr, int len);
84 
85 /* Store VALUE at ADDR in the inferior as a LEN-byte unsigned integer.  */
86 extern void write_memory_unsigned_integer (CORE_ADDR addr, int len,
87                                            enum bfd_endian byte_order,
88 					   ULONGEST value);
89 
90 /* Store VALUE at ADDR in the inferior as a LEN-byte unsigned integer.  */
91 extern void write_memory_signed_integer (CORE_ADDR addr, int len,
92                                          enum bfd_endian byte_order,
93                                          LONGEST value);
94 
95 /* Hook for `exec_file_command' command to call.  */
96 
97 extern void (*deprecated_exec_file_display_hook) (char *filename);
98 
99 /* Hook for "file_command", which is more useful than above
100    (because it is invoked AFTER symbols are read, not before).  */
101 
102 extern void (*deprecated_file_changed_hook) (char *filename);
103 
104 extern void specify_exec_file_hook (void (*hook) (char *filename));
105 
106 /* Binary File Diddlers for the exec and core files.  */
107 
108 extern bfd *core_bfd;
109 extern bfd *exec_bfd;
110 
111 /* The mtime when we last opened exec_bfd.  */
112 extern long exec_bfd_mtime;
113 
114 /* Whether to open exec and core files read-only or read-write.  */
115 
116 extern int write_files;
117 
118 extern void core_file_command (char *filename, int from_tty);
119 
120 extern void exec_file_attach (char *filename, int from_tty);
121 
122 extern void exec_file_clear (int from_tty);
123 
124 extern void validate_files (void);
125 
126 /* The current default bfd target.  */
127 
128 extern char *gnutarget;
129 
130 extern void set_gnutarget (char *);
131 
132 /* Structure to keep track of core register reading functions for
133    various core file types.  */
134 
135 struct core_fns
136   {
137 
138     /* BFD flavour that a core file handler is prepared to read.  This
139        can be used by the handler's core tasting function as a first
140        level filter to reject BFD's that don't have the right
141        flavour. */
142 
143     enum bfd_flavour core_flavour;
144 
145     /* Core file handler function to call to recognize corefile
146        formats that BFD rejects.  Some core file format just don't fit
147        into the BFD model, or may require other resources to identify
148        them, that simply aren't available to BFD (such as symbols from
149        another file).  Returns nonzero if the handler recognizes the
150        format, zero otherwise. */
151 
152     int (*check_format) (bfd *);
153 
154     /* Core file handler function to call to ask if it can handle a
155        given core file format or not.  Returns zero if it can't,
156        nonzero otherwise. */
157 
158     int (*core_sniffer) (struct core_fns *, bfd *);
159 
160     /* Extract the register values out of the core file and supply them
161        into REGCACHE.
162 
163        CORE_REG_SECT points to the register values themselves, read into
164        memory.
165 
166        CORE_REG_SIZE is the size of that area.
167 
168        WHICH says which set of registers we are handling:
169          0 --- integer registers
170          2 --- floating-point registers, on machines where they are
171                discontiguous
172          3 --- extended floating-point registers, on machines where
173                these are present in yet a third area.  (GNU/Linux uses
174                this to get at the SSE registers.)
175 
176        REG_ADDR is the offset from u.u_ar0 to the register values relative to
177        core_reg_sect.  This is used with old-fashioned core files to locate the
178        registers in a large upage-plus-stack ".reg" section.  Original upage
179        address X is at location core_reg_sect+x+reg_addr. */
180 
181     void (*core_read_registers) (struct regcache *regcache,
182 				 char *core_reg_sect,
183 				 unsigned core_reg_size,
184 				 int which, CORE_ADDR reg_addr);
185 
186     /* Finds the next struct core_fns.  They are allocated and
187        initialized in whatever module implements the functions pointed
188        to; an initializer calls deprecated_add_core_fns to add them to
189        the global chain.  */
190 
191     struct core_fns *next;
192 
193   };
194 
195 /* NOTE: cagney/2004-04-05: Replaced by "regset.h" and
196    regset_from_core_section().  */
197 extern void deprecated_add_core_fns (struct core_fns *cf);
198 extern int default_core_sniffer (struct core_fns *cf, bfd * abfd);
199 extern int default_check_format (bfd * abfd);
200 
201 struct target_section *deprecated_core_resize_section_table (int num_added);
202 
203 #endif /* !defined (GDBCORE_H) */
204