Import gdb-7.0
[dragonfly.git] / contrib / gdb-6.2.1 / gdb / gdbcore.h
1 /* Machine independent variables that describe the core file under GDB.
2
3    Copyright 1986, 1987, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
4    1996, 1997, 1998, 1999, 2000, 2001, 2004 Free Software Foundation,
5    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 2 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, write to the Free Software
21    Foundation, Inc., 59 Temple Place - Suite 330,
22    Boston, MA 02111-1307, USA.  */
23
24 /* Interface routines for core, executable, etc.  */
25
26 #if !defined (GDBCORE_H)
27 #define GDBCORE_H 1
28
29 struct type;
30
31 #include "bfd.h"
32
33 /* Return the name of the executable file as a string.
34    ERR nonzero means get error if there is none specified;
35    otherwise return 0 in that case.  */
36
37 extern char *get_exec_file (int err);
38
39 /* Nonzero if there is a core file.  */
40
41 extern int have_core_file_p (void);
42
43 /* Read "memory data" from whatever target or inferior we have.
44    Returns zero if successful, errno value if not.  EIO is used for
45    address out of bounds.  If breakpoints are inserted, returns shadow
46    contents, not the breakpoints themselves.  From breakpoint.c.  */
47
48 extern int read_memory_nobpt (CORE_ADDR memaddr, char *myaddr, unsigned len);
49
50 /* Report a memory error with error().  */
51
52 extern void memory_error (int status, CORE_ADDR memaddr);
53
54 /* Like target_read_memory, but report an error if can't read.  */
55
56 extern void read_memory (CORE_ADDR memaddr, char *myaddr, int len);
57
58 /* Read an integer from debugged memory, given address and number of
59    bytes.  */
60
61 extern LONGEST read_memory_integer (CORE_ADDR memaddr, int len);
62 extern int safe_read_memory_integer (CORE_ADDR memaddr, int len, LONGEST *return_value);
63
64 /* Read an unsigned integer from debugged memory, given address and
65    number of bytes.  */
66
67 extern ULONGEST read_memory_unsigned_integer (CORE_ADDR memaddr, int len);
68
69 /* Read a null-terminated string from the debuggee's memory, given address,
70  * a buffer into which to place the string, and the maximum available space */
71
72 extern void read_memory_string (CORE_ADDR, char *, int);
73
74 /* Read the pointer of type TYPE at ADDR, and return the address it
75    represents. */
76
77 CORE_ADDR read_memory_typed_address (CORE_ADDR addr, struct type *type);
78
79 /* This takes a char *, not void *.  This is probably right, because
80    passing in an int * or whatever is wrong with respect to
81    byteswapping, alignment, different sizes for host vs. target types,
82    etc.  */
83
84 extern void write_memory (CORE_ADDR memaddr, char *myaddr, int len);
85
86 /* Store VALUE at ADDR in the inferior as a LEN-byte unsigned integer.  */
87 extern void write_memory_unsigned_integer (CORE_ADDR addr, int len,
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                                          LONGEST value);
93
94 extern void generic_search (int len, char *data, char *mask,
95                             CORE_ADDR startaddr, int increment,
96                             CORE_ADDR lorange, CORE_ADDR hirange,
97                             CORE_ADDR * addr_found, char *data_found);
98 \f
99 /* Hook for `exec_file_command' command to call.  */
100
101 extern void (*deprecated_exec_file_display_hook) (char *filename);
102
103 /* Hook for "file_command", which is more useful than above
104    (because it is invoked AFTER symbols are read, not before) */
105
106 extern void (*deprecated_file_changed_hook) (char *filename);
107
108 extern void specify_exec_file_hook (void (*hook) (char *filename));
109
110 /* Binary File Diddlers for the exec and core files */
111
112 extern bfd *core_bfd;
113 extern bfd *exec_bfd;
114
115 /* Whether to open exec and core files read-only or read-write.  */
116
117 extern int write_files;
118
119 extern void core_file_command (char *filename, int from_tty);
120
121 extern void exec_open (char *filename, int from_tty);
122
123 extern void exec_file_attach (char *filename, int from_tty);
124
125 extern void exec_file_clear (int from_tty);
126
127 extern void validate_files (void);
128
129 extern CORE_ADDR register_addr (int regno, CORE_ADDR blockend);
130
131 #if !defined (KERNEL_U_ADDR)
132 extern CORE_ADDR kernel_u_addr;
133 #define KERNEL_U_ADDR kernel_u_addr
134 #endif
135
136 /* The target vector for core files. */
137
138 extern struct target_ops core_ops;
139
140 /* The current default bfd target.  */
141
142 extern char *gnutarget;
143
144 extern void set_gnutarget (char *);
145
146 /* Structure to keep track of core register reading functions for
147    various core file types.  */
148
149 struct core_fns
150   {
151
152     /* BFD flavour that a core file handler is prepared to read.  This
153        can be used by the handler's core tasting function as a first
154        level filter to reject BFD's that don't have the right
155        flavour. */
156
157     enum bfd_flavour core_flavour;
158
159     /* Core file handler function to call to recognize corefile
160        formats that BFD rejects.  Some core file format just don't fit
161        into the BFD model, or may require other resources to identify
162        them, that simply aren't available to BFD (such as symbols from
163        another file).  Returns nonzero if the handler recognizes the
164        format, zero otherwise. */
165
166     int (*check_format) (bfd *);
167
168     /* Core file handler function to call to ask if it can handle a
169        given core file format or not.  Returns zero if it can't,
170        nonzero otherwise. */
171
172     int (*core_sniffer) (struct core_fns *, bfd *);
173
174     /* Extract the register values out of the core file and store them where
175        `read_register' will find them.
176
177        CORE_REG_SECT points to the register values themselves, read into
178        memory.
179
180        CORE_REG_SIZE is the size of that area.
181
182        WHICH says which set of registers we are handling:
183          0 --- integer registers
184          2 --- floating-point registers, on machines where they are
185                discontiguous
186          3 --- extended floating-point registers, on machines where
187                these are present in yet a third area.  (GNU/Linux uses
188                this to get at the SSE registers.)
189
190        REG_ADDR is the offset from u.u_ar0 to the register values relative to
191        core_reg_sect.  This is used with old-fashioned core files to locate the
192        registers in a large upage-plus-stack ".reg" section.  Original upage
193        address X is at location core_reg_sect+x+reg_addr. */
194
195     void (*core_read_registers) (char *core_reg_sect,
196                                  unsigned core_reg_size,
197                                  int which, CORE_ADDR reg_addr);
198
199     /* Finds the next struct core_fns.  They are allocated and
200        initialized in whatever module implements the functions pointed
201        to; an initializer calls deprecated_add_core_fns to add them to
202        the global chain.  */
203
204     struct core_fns *next;
205
206   };
207
208 /* NOTE: cagney/2004-04-05: Replaced by "regset.h" and
209    regset_from_core_section().  */
210 extern void deprecated_add_core_fns (struct core_fns *cf);
211 extern int default_core_sniffer (struct core_fns *cf, bfd * abfd);
212 extern int default_check_format (bfd * abfd);
213
214 #endif /* !defined (GDBCORE_H) */