This commit was generated by cvs2svn to track changes on a CVS vendor
[external/binutils.git] / gdb / gdbcore.h
1 /* Machine independent variables that describe the core file under GDB.
2    Copyright 1986, 1987, 1989, 1990, 1992, 1995 Free Software Foundation, Inc.
3
4    This file is part of GDB.
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 2 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, Inc., 59 Temple Place - Suite 330,
19    Boston, MA 02111-1307, USA.  */
20
21 /* Interface routines for core, executable, etc.  */
22
23 #if !defined (GDBCORE_H)
24 #define GDBCORE_H 1
25
26 #include "bfd.h"
27
28 /* Return the name of the executable file as a string.
29    ERR nonzero means get error if there is none specified;
30    otherwise return 0 in that case.  */
31
32 extern char *get_exec_file (int err);
33
34 /* Nonzero if there is a core file.  */
35
36 extern int have_core_file_p (void);
37
38 /* Read "memory data" from whatever target or inferior we have.
39    Returns zero if successful, errno value if not.  EIO is used for
40    address out of bounds.  If breakpoints are inserted, returns shadow
41    contents, not the breakpoints themselves.  From breakpoint.c.  */
42
43 extern int read_memory_nobpt (CORE_ADDR memaddr, char *myaddr, unsigned len);
44
45 /* Report a memory error with error().  */
46
47 extern void memory_error (int status, CORE_ADDR memaddr);
48
49 /* Like target_read_memory, but report an error if can't read.  */
50
51 extern void read_memory (CORE_ADDR memaddr, char *myaddr, int len);
52
53 /* Read an integer from debugged memory, given address and number of
54    bytes.  */
55
56 extern LONGEST read_memory_integer (CORE_ADDR memaddr, int len);
57
58 /* Read an unsigned integer from debugged memory, given address and
59    number of bytes.  */
60
61 extern ULONGEST read_memory_unsigned_integer (CORE_ADDR memaddr, int len);
62
63 /* Read a null-terminated string from the debuggee's memory, given address,
64  * a buffer into which to place the string, and the maximum available space */
65 extern void read_memory_string (CORE_ADDR, char *, int);
66
67 /* This takes a char *, not void *.  This is probably right, because
68    passing in an int * or whatever is wrong with respect to
69    byteswapping, alignment, different sizes for host vs. target types,
70    etc.  */
71
72 extern void write_memory (CORE_ADDR memaddr, char *myaddr, int len);
73
74 extern void generic_search (int len, char *data, char *mask,
75                             CORE_ADDR startaddr, int increment,
76                             CORE_ADDR lorange, CORE_ADDR hirange,
77                             CORE_ADDR * addr_found, char *data_found);
78 \f
79 /* Hook for `exec_file_command' command to call.  */
80
81 extern void (*exec_file_display_hook) (char *filename);
82
83 /* Hook for "file_command", which is more useful than above
84    (because it is invoked AFTER symbols are read, not before) */
85
86 extern void (*file_changed_hook) (char *filename);
87
88 extern void specify_exec_file_hook (void (*hook) (char *filename));
89
90 /* Binary File Diddlers for the exec and core files */
91
92 extern bfd *core_bfd;
93 extern bfd *exec_bfd;
94
95 /* Whether to open exec and core files read-only or read-write.  */
96
97 extern int write_files;
98
99 extern void core_file_command (char *filename, int from_tty);
100
101 extern void exec_file_attach (char *filename, int from_tty);
102
103 extern void exec_file_command (char *filename, int from_tty);
104
105 extern void validate_files (void);
106
107 extern CORE_ADDR register_addr (int regno, CORE_ADDR blockend);
108
109 extern void registers_fetched (void);
110
111 #if !defined (KERNEL_U_ADDR)
112 extern CORE_ADDR kernel_u_addr;
113 #define KERNEL_U_ADDR kernel_u_addr
114 #endif
115
116 /* The target vector for core files. */
117
118 extern struct target_ops core_ops;
119
120 /* The current default bfd target.  */
121
122 extern char *gnutarget;
123
124 extern void set_gnutarget (char *);
125
126 /* Structure to keep track of core register reading functions for
127    various core file types.  */
128
129 struct core_fns
130   {
131
132     /* BFD flavour that a core file handler is prepared to read.  This
133        can be used by the handler's core tasting function as a first
134        level filter to reject BFD's that don't have the right
135        flavour. */
136
137     enum bfd_flavour core_flavour;
138
139     /* Core file handler function to call to recognize corefile
140        formats that BFD rejects.  Some core file format just don't fit
141        into the BFD model, or may require other resources to identify
142        them, that simply aren't available to BFD (such as symbols from
143        another file).  Returns nonzero if the handler recognizes the
144        format, zero otherwise. */
145
146     int (*check_format) (bfd *);
147
148     /* Core file handler function to call to ask if it can handle a
149        given core file format or not.  Returns zero if it can't,
150        nonzero otherwise. */
151
152     int (*core_sniffer) (struct core_fns *, bfd *);
153
154     /* Extract the register values out of the core file and store them where
155        `read_register' will find them.
156
157        CORE_REG_SECT points to the register values themselves, read into
158        memory.
159
160        CORE_REG_SIZE is the size of that area.
161
162        WHICH says which set of registers we are handling:
163          0 --- integer registers
164          2 --- floating-point registers, on machines where they are
165                discontiguous
166          3 --- extended floating-point registers, on machines where
167                these are present in yet a third area.  (GNU/Linux uses
168                this to get at the SSE registers.)
169
170        REG_ADDR is the offset from u.u_ar0 to the register values relative to
171        core_reg_sect.  This is used with old-fashioned core files to locate the
172        registers in a large upage-plus-stack ".reg" section.  Original upage
173        address X is at location core_reg_sect+x+reg_addr. */
174
175     void (*core_read_registers) (char *core_reg_sect,
176                                  unsigned core_reg_size,
177                                  int which, CORE_ADDR reg_addr);
178
179     /* Finds the next struct core_fns.  They are allocated and initialized
180        in whatever module implements the functions pointed to; an 
181        initializer calls add_core_fns to add them to the global chain.  */
182
183     struct core_fns *next;
184
185   };
186
187 extern void add_core_fns (struct core_fns *cf);
188 extern int default_core_sniffer (struct core_fns *cf, bfd * abfd);
189 extern int default_check_format (bfd * abfd);
190
191 #endif /* !defined (GDBCORE_H) */