xref: /openbsd/gnu/usr.bin/binutils/gdb/gdbcore.h (revision 09467b48)
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 /* NOTE: cagney/2004-06-10: Code reading from a live inferior can use
49    the get_frame_memory methods, code reading from an exec can use the
50    target methods.  */
51 
52 extern int deprecated_read_memory_nobpt (CORE_ADDR memaddr, char *myaddr,
53 					 unsigned len);
54 
55 /* Report a memory error with error().  */
56 
57 extern void memory_error (int status, CORE_ADDR memaddr);
58 
59 /* Like target_read_memory, but report an error if can't read.  */
60 
61 extern void read_memory (CORE_ADDR memaddr, char *myaddr, int len);
62 
63 /* Read an integer from debugged memory, given address and number of
64    bytes.  */
65 
66 extern LONGEST read_memory_integer (CORE_ADDR memaddr, int len);
67 extern int safe_read_memory_integer (CORE_ADDR memaddr, int len, LONGEST *return_value);
68 
69 /* Read an unsigned integer from debugged memory, given address and
70    number of bytes.  */
71 
72 extern ULONGEST read_memory_unsigned_integer (CORE_ADDR memaddr, int len);
73 
74 /* Read a null-terminated string from the debuggee's memory, given address,
75  * a buffer into which to place the string, and the maximum available space */
76 
77 extern void read_memory_string (CORE_ADDR, char *, int);
78 
79 /* Read the pointer of type TYPE at ADDR, and return the address it
80    represents. */
81 
82 CORE_ADDR read_memory_typed_address (CORE_ADDR addr, struct type *type);
83 
84 /* This takes a char *, not void *.  This is probably right, because
85    passing in an int * or whatever is wrong with respect to
86    byteswapping, alignment, different sizes for host vs. target types,
87    etc.  */
88 
89 extern void write_memory (CORE_ADDR memaddr, char *myaddr, int len);
90 
91 /* Store VALUE at ADDR in the inferior as a LEN-byte unsigned integer.  */
92 extern void write_memory_unsigned_integer (CORE_ADDR addr, int len,
93                                            ULONGEST value);
94 
95 /* Store VALUE at ADDR in the inferior as a LEN-byte unsigned integer.  */
96 extern void write_memory_signed_integer (CORE_ADDR addr, int len,
97                                          LONGEST value);
98 
99 extern void generic_search (int len, char *data, char *mask,
100 			    CORE_ADDR startaddr, int increment,
101 			    CORE_ADDR lorange, CORE_ADDR hirange,
102 			    CORE_ADDR * addr_found, char *data_found);
103 
104 /* Hook for `exec_file_command' command to call.  */
105 
106 extern void (*deprecated_exec_file_display_hook) (char *filename);
107 
108 /* Hook for "file_command", which is more useful than above
109    (because it is invoked AFTER symbols are read, not before) */
110 
111 extern void (*deprecated_file_changed_hook) (char *filename);
112 
113 extern void specify_exec_file_hook (void (*hook) (char *filename));
114 
115 /* Binary File Diddlers for the exec and core files */
116 
117 extern bfd *core_bfd;
118 extern bfd *exec_bfd;
119 
120 /* Whether to open exec and core files read-only or read-write.  */
121 
122 extern int write_files;
123 
124 extern void core_file_command (char *filename, int from_tty);
125 
126 extern void exec_open (char *filename, int from_tty);
127 
128 extern void exec_file_attach (char *filename, int from_tty);
129 
130 extern void exec_file_clear (int from_tty);
131 
132 extern void validate_files (void);
133 
134 extern CORE_ADDR register_addr (int regno, CORE_ADDR blockend);
135 
136 #if !defined (KERNEL_U_ADDR)
137 extern CORE_ADDR kernel_u_addr;
138 #define KERNEL_U_ADDR kernel_u_addr
139 #endif
140 
141 /* The target vector for core files. */
142 
143 extern struct target_ops core_ops;
144 
145 /* The current default bfd target.  */
146 
147 extern char *gnutarget;
148 
149 extern void set_gnutarget (char *);
150 
151 /* Structure to keep track of core register reading functions for
152    various core file types.  */
153 
154 struct core_fns
155   {
156 
157     /* BFD flavour that a core file handler is prepared to read.  This
158        can be used by the handler's core tasting function as a first
159        level filter to reject BFD's that don't have the right
160        flavour. */
161 
162     enum bfd_flavour core_flavour;
163 
164     /* Core file handler function to call to recognize corefile
165        formats that BFD rejects.  Some core file format just don't fit
166        into the BFD model, or may require other resources to identify
167        them, that simply aren't available to BFD (such as symbols from
168        another file).  Returns nonzero if the handler recognizes the
169        format, zero otherwise. */
170 
171     int (*check_format) (bfd *);
172 
173     /* Core file handler function to call to ask if it can handle a
174        given core file format or not.  Returns zero if it can't,
175        nonzero otherwise. */
176 
177     int (*core_sniffer) (struct core_fns *, bfd *);
178 
179     /* Extract the register values out of the core file and store them where
180        `read_register' will find them.
181 
182        CORE_REG_SECT points to the register values themselves, read into
183        memory.
184 
185        CORE_REG_SIZE is the size of that area.
186 
187        WHICH says which set of registers we are handling:
188          0 --- integer registers
189          2 --- floating-point registers, on machines where they are
190                discontiguous
191          3 --- extended floating-point registers, on machines where
192                these are present in yet a third area.  (GNU/Linux uses
193                this to get at the SSE registers.)
194 
195        REG_ADDR is the offset from u.u_ar0 to the register values relative to
196        core_reg_sect.  This is used with old-fashioned core files to locate the
197        registers in a large upage-plus-stack ".reg" section.  Original upage
198        address X is at location core_reg_sect+x+reg_addr. */
199 
200     void (*core_read_registers) (char *core_reg_sect,
201 				 unsigned core_reg_size,
202 				 int which, CORE_ADDR reg_addr);
203 
204     /* Finds the next struct core_fns.  They are allocated and
205        initialized in whatever module implements the functions pointed
206        to; an initializer calls deprecated_add_core_fns to add them to
207        the global chain.  */
208 
209     struct core_fns *next;
210 
211   };
212 
213 /* NOTE: cagney/2004-04-05: Replaced by "regset.h" and
214    regset_from_core_section().  */
215 extern void deprecated_add_core_fns (struct core_fns *cf);
216 extern int default_core_sniffer (struct core_fns *cf, bfd * abfd);
217 extern int default_check_format (bfd * abfd);
218 
219 #endif /* !defined (GDBCORE_H) */
220