Commit | Line | Data |
---|---|---|
c906108c | 1 | /* Interface between GDB and target environments, including files and processes |
0088c768 | 2 | |
197e01b6 | 3 | Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, |
f6519ebc MK |
4 | 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 |
5 | Free Software Foundation, Inc. | |
0088c768 | 6 | |
c906108c SS |
7 | Contributed by Cygnus Support. Written by John Gilmore. |
8 | ||
c5aa993b | 9 | This file is part of GDB. |
c906108c | 10 | |
c5aa993b JM |
11 | This program is free software; you can redistribute it and/or modify |
12 | it under the terms of the GNU General Public License as published by | |
13 | the Free Software Foundation; either version 2 of the License, or | |
14 | (at your option) any later version. | |
c906108c | 15 | |
c5aa993b JM |
16 | This program is distributed in the hope that it will be useful, |
17 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | GNU General Public License for more details. | |
c906108c | 20 | |
c5aa993b JM |
21 | You should have received a copy of the GNU General Public License |
22 | along with this program; if not, write to the Free Software | |
197e01b6 EZ |
23 | Foundation, Inc., 51 Franklin Street, Fifth Floor, |
24 | Boston, MA 02110-1301, USA. */ | |
c906108c SS |
25 | |
26 | #if !defined (TARGET_H) | |
27 | #define TARGET_H | |
28 | ||
da3331ec AC |
29 | struct objfile; |
30 | struct ui_file; | |
31 | struct mem_attrib; | |
1e3ff5ad | 32 | struct target_ops; |
8181d85f | 33 | struct bp_target_info; |
da3331ec | 34 | |
c906108c SS |
35 | /* This include file defines the interface between the main part |
36 | of the debugger, and the part which is target-specific, or | |
37 | specific to the communications interface between us and the | |
38 | target. | |
39 | ||
2146d243 RM |
40 | A TARGET is an interface between the debugger and a particular |
41 | kind of file or process. Targets can be STACKED in STRATA, | |
c906108c SS |
42 | so that more than one target can potentially respond to a request. |
43 | In particular, memory accesses will walk down the stack of targets | |
44 | until they find a target that is interested in handling that particular | |
45 | address. STRATA are artificial boundaries on the stack, within | |
46 | which particular kinds of targets live. Strata exist so that | |
47 | people don't get confused by pushing e.g. a process target and then | |
48 | a file target, and wondering why they can't see the current values | |
49 | of variables any more (the file target is handling them and they | |
50 | never get to the process target). So when you push a file target, | |
51 | it goes into the file stratum, which is always below the process | |
52 | stratum. */ | |
53 | ||
54 | #include "bfd.h" | |
55 | #include "symtab.h" | |
4930751a | 56 | #include "dcache.h" |
29e57380 | 57 | #include "memattr.h" |
fd79ecee | 58 | #include "vec.h" |
c906108c | 59 | |
c5aa993b JM |
60 | enum strata |
61 | { | |
62 | dummy_stratum, /* The lowest of the low */ | |
63 | file_stratum, /* Executable files, etc */ | |
64 | core_stratum, /* Core dump files */ | |
65 | download_stratum, /* Downloading of remote targets */ | |
d4f3574e SS |
66 | process_stratum, /* Executing processes */ |
67 | thread_stratum /* Executing threads */ | |
c5aa993b | 68 | }; |
c906108c | 69 | |
c5aa993b JM |
70 | enum thread_control_capabilities |
71 | { | |
0d06e24b JM |
72 | tc_none = 0, /* Default: can't control thread execution. */ |
73 | tc_schedlock = 1, /* Can lock the thread scheduler. */ | |
74 | tc_switch = 2 /* Can switch the running thread on demand. */ | |
c5aa993b | 75 | }; |
c906108c SS |
76 | |
77 | /* Stuff for target_wait. */ | |
78 | ||
79 | /* Generally, what has the program done? */ | |
c5aa993b JM |
80 | enum target_waitkind |
81 | { | |
82 | /* The program has exited. The exit status is in value.integer. */ | |
83 | TARGET_WAITKIND_EXITED, | |
c906108c | 84 | |
0d06e24b JM |
85 | /* The program has stopped with a signal. Which signal is in |
86 | value.sig. */ | |
c5aa993b | 87 | TARGET_WAITKIND_STOPPED, |
c906108c | 88 | |
c5aa993b JM |
89 | /* The program has terminated with a signal. Which signal is in |
90 | value.sig. */ | |
91 | TARGET_WAITKIND_SIGNALLED, | |
c906108c | 92 | |
c5aa993b JM |
93 | /* The program is letting us know that it dynamically loaded something |
94 | (e.g. it called load(2) on AIX). */ | |
95 | TARGET_WAITKIND_LOADED, | |
c906108c | 96 | |
0d06e24b JM |
97 | /* The program has forked. A "related" process' ID is in |
98 | value.related_pid. I.e., if the child forks, value.related_pid | |
99 | is the parent's ID. */ | |
100 | ||
c5aa993b | 101 | TARGET_WAITKIND_FORKED, |
c906108c | 102 | |
0d06e24b JM |
103 | /* The program has vforked. A "related" process's ID is in |
104 | value.related_pid. */ | |
105 | ||
c5aa993b | 106 | TARGET_WAITKIND_VFORKED, |
c906108c | 107 | |
0d06e24b JM |
108 | /* The program has exec'ed a new executable file. The new file's |
109 | pathname is pointed to by value.execd_pathname. */ | |
110 | ||
c5aa993b | 111 | TARGET_WAITKIND_EXECD, |
c906108c | 112 | |
0d06e24b JM |
113 | /* The program has entered or returned from a system call. On |
114 | HP-UX, this is used in the hardware watchpoint implementation. | |
115 | The syscall's unique integer ID number is in value.syscall_id */ | |
116 | ||
c5aa993b JM |
117 | TARGET_WAITKIND_SYSCALL_ENTRY, |
118 | TARGET_WAITKIND_SYSCALL_RETURN, | |
c906108c | 119 | |
c5aa993b JM |
120 | /* Nothing happened, but we stopped anyway. This perhaps should be handled |
121 | within target_wait, but I'm not sure target_wait should be resuming the | |
122 | inferior. */ | |
c4093a6a JM |
123 | TARGET_WAITKIND_SPURIOUS, |
124 | ||
8e7d2c16 DJ |
125 | /* An event has occured, but we should wait again. |
126 | Remote_async_wait() returns this when there is an event | |
c4093a6a JM |
127 | on the inferior, but the rest of the world is not interested in |
128 | it. The inferior has not stopped, but has just sent some output | |
129 | to the console, for instance. In this case, we want to go back | |
130 | to the event loop and wait there for another event from the | |
131 | inferior, rather than being stuck in the remote_async_wait() | |
132 | function. This way the event loop is responsive to other events, | |
0d06e24b | 133 | like for instance the user typing. */ |
c4093a6a | 134 | TARGET_WAITKIND_IGNORE |
c906108c SS |
135 | }; |
136 | ||
c5aa993b JM |
137 | struct target_waitstatus |
138 | { | |
139 | enum target_waitkind kind; | |
140 | ||
141 | /* Forked child pid, execd pathname, exit status or signal number. */ | |
142 | union | |
143 | { | |
144 | int integer; | |
145 | enum target_signal sig; | |
146 | int related_pid; | |
147 | char *execd_pathname; | |
148 | int syscall_id; | |
149 | } | |
150 | value; | |
151 | }; | |
c906108c | 152 | |
2acceee2 | 153 | /* Possible types of events that the inferior handler will have to |
0d06e24b | 154 | deal with. */ |
2acceee2 JM |
155 | enum inferior_event_type |
156 | { | |
0d06e24b | 157 | /* There is a request to quit the inferior, abandon it. */ |
2acceee2 JM |
158 | INF_QUIT_REQ, |
159 | /* Process a normal inferior event which will result in target_wait | |
0d06e24b | 160 | being called. */ |
2146d243 | 161 | INF_REG_EVENT, |
0d06e24b | 162 | /* Deal with an error on the inferior. */ |
2acceee2 | 163 | INF_ERROR, |
0d06e24b | 164 | /* We are called because a timer went off. */ |
2acceee2 | 165 | INF_TIMER, |
0d06e24b | 166 | /* We are called to do stuff after the inferior stops. */ |
c2d11a7d JM |
167 | INF_EXEC_COMPLETE, |
168 | /* We are called to do some stuff after the inferior stops, but we | |
169 | are expected to reenter the proceed() and | |
170 | handle_inferior_event() functions. This is used only in case of | |
0d06e24b | 171 | 'step n' like commands. */ |
c2d11a7d | 172 | INF_EXEC_CONTINUE |
2acceee2 JM |
173 | }; |
174 | ||
c906108c | 175 | /* Return the string for a signal. */ |
a14ed312 | 176 | extern char *target_signal_to_string (enum target_signal); |
c906108c SS |
177 | |
178 | /* Return the name (SIGHUP, etc.) for a signal. */ | |
a14ed312 | 179 | extern char *target_signal_to_name (enum target_signal); |
c906108c SS |
180 | |
181 | /* Given a name (SIGHUP, etc.), return its signal. */ | |
a14ed312 | 182 | enum target_signal target_signal_from_name (char *); |
c906108c | 183 | \f |
13547ab6 DJ |
184 | /* Target objects which can be transfered using target_read, |
185 | target_write, et cetera. */ | |
1e3ff5ad AC |
186 | |
187 | enum target_object | |
188 | { | |
1e3ff5ad AC |
189 | /* AVR target specific transfer. See "avr-tdep.c" and "remote.c". */ |
190 | TARGET_OBJECT_AVR, | |
191 | /* Transfer up-to LEN bytes of memory starting at OFFSET. */ | |
287a334e | 192 | TARGET_OBJECT_MEMORY, |
cf7a04e8 DJ |
193 | /* Memory, avoiding GDB's data cache and trusting the executable. |
194 | Target implementations of to_xfer_partial never need to handle | |
195 | this object, and most callers should not use it. */ | |
196 | TARGET_OBJECT_RAW_MEMORY, | |
287a334e JJ |
197 | /* Kernel Unwind Table. See "ia64-tdep.c". */ |
198 | TARGET_OBJECT_UNWIND_TABLE, | |
2146d243 RM |
199 | /* Transfer auxilliary vector. */ |
200 | TARGET_OBJECT_AUXV, | |
baf92889 | 201 | /* StackGhost cookie. See "sparc-tdep.c". */ |
fd79ecee DJ |
202 | TARGET_OBJECT_WCOOKIE, |
203 | /* Target memory map in XML format. */ | |
204 | TARGET_OBJECT_MEMORY_MAP, | |
a76d924d DJ |
205 | /* Flash memory. This object can be used to write contents to |
206 | a previously erased flash memory. Using it without erasing | |
207 | flash can have unexpected results. Addresses are physical | |
208 | address on target, and not relative to flash start. */ | |
209 | TARGET_OBJECT_FLASH | |
2146d243 RM |
210 | |
211 | /* Possible future objects: TARGET_OBJECT_FILE, TARGET_OBJECT_PROC, ... */ | |
1e3ff5ad AC |
212 | }; |
213 | ||
13547ab6 DJ |
214 | /* Request that OPS transfer up to LEN 8-bit bytes of the target's |
215 | OBJECT. The OFFSET, for a seekable object, specifies the | |
216 | starting point. The ANNEX can be used to provide additional | |
217 | data-specific information to the target. | |
1e3ff5ad | 218 | |
13547ab6 DJ |
219 | Return the number of bytes actually transfered, or -1 if the |
220 | transfer is not supported or otherwise fails. Return of a positive | |
221 | value less than LEN indicates that no further transfer is possible. | |
222 | Unlike the raw to_xfer_partial interface, callers of these | |
223 | functions do not need to retry partial transfers. */ | |
1e3ff5ad | 224 | |
1e3ff5ad AC |
225 | extern LONGEST target_read (struct target_ops *ops, |
226 | enum target_object object, | |
1b0ba102 | 227 | const char *annex, gdb_byte *buf, |
1e3ff5ad AC |
228 | ULONGEST offset, LONGEST len); |
229 | ||
230 | extern LONGEST target_write (struct target_ops *ops, | |
231 | enum target_object object, | |
1b0ba102 | 232 | const char *annex, const gdb_byte *buf, |
1e3ff5ad | 233 | ULONGEST offset, LONGEST len); |
b6591e8b | 234 | |
a76d924d DJ |
235 | /* Similar to target_write, except that it also calls PROGRESS with |
236 | the number of bytes written and the opaque BATON after every | |
237 | successful partial write (and before the first write). This is | |
238 | useful for progress reporting and user interaction while writing | |
239 | data. To abort the transfer, the progress callback can throw an | |
240 | exception. */ | |
241 | ||
cf7a04e8 DJ |
242 | LONGEST target_write_with_progress (struct target_ops *ops, |
243 | enum target_object object, | |
244 | const char *annex, const gdb_byte *buf, | |
245 | ULONGEST offset, LONGEST len, | |
246 | void (*progress) (ULONGEST, void *), | |
247 | void *baton); | |
248 | ||
13547ab6 DJ |
249 | /* Wrapper to perform a full read of unknown size. OBJECT/ANNEX will |
250 | be read using OPS. The return value will be -1 if the transfer | |
251 | fails or is not supported; 0 if the object is empty; or the length | |
252 | of the object otherwise. If a positive value is returned, a | |
253 | sufficiently large buffer will be allocated using xmalloc and | |
254 | returned in *BUF_P containing the contents of the object. | |
255 | ||
256 | This method should be used for objects sufficiently small to store | |
257 | in a single xmalloc'd buffer, when no fixed bound on the object's | |
258 | size is known in advance. Don't try to read TARGET_OBJECT_MEMORY | |
259 | through this function. */ | |
260 | ||
261 | extern LONGEST target_read_alloc (struct target_ops *ops, | |
262 | enum target_object object, | |
263 | const char *annex, gdb_byte **buf_p); | |
264 | ||
159f81f3 DJ |
265 | /* Read OBJECT/ANNEX using OPS. The result is NUL-terminated and |
266 | returned as a string, allocated using xmalloc. If an error occurs | |
267 | or the transfer is unsupported, NULL is returned. Empty objects | |
268 | are returned as allocated but empty strings. A warning is issued | |
269 | if the result contains any embedded NUL bytes. */ | |
270 | ||
271 | extern char *target_read_stralloc (struct target_ops *ops, | |
272 | enum target_object object, | |
273 | const char *annex); | |
274 | ||
b6591e8b AC |
275 | /* Wrappers to target read/write that perform memory transfers. They |
276 | throw an error if the memory transfer fails. | |
277 | ||
278 | NOTE: cagney/2003-10-23: The naming schema is lifted from | |
279 | "frame.h". The parameter order is lifted from get_frame_memory, | |
280 | which in turn lifted it from read_memory. */ | |
281 | ||
282 | extern void get_target_memory (struct target_ops *ops, CORE_ADDR addr, | |
1b0ba102 | 283 | gdb_byte *buf, LONGEST len); |
b6591e8b AC |
284 | extern ULONGEST get_target_memory_unsigned (struct target_ops *ops, |
285 | CORE_ADDR addr, int len); | |
1e3ff5ad | 286 | \f |
c5aa993b | 287 | |
c906108c SS |
288 | /* If certain kinds of activity happen, target_wait should perform |
289 | callbacks. */ | |
290 | /* Right now we just call (*TARGET_ACTIVITY_FUNCTION) if I/O is possible | |
0d06e24b | 291 | on TARGET_ACTIVITY_FD. */ |
c906108c SS |
292 | extern int target_activity_fd; |
293 | /* Returns zero to leave the inferior alone, one to interrupt it. */ | |
507f3c78 | 294 | extern int (*target_activity_function) (void); |
c906108c | 295 | \f |
0d06e24b JM |
296 | struct thread_info; /* fwd decl for parameter list below: */ |
297 | ||
c906108c | 298 | struct target_ops |
c5aa993b | 299 | { |
258b763a | 300 | struct target_ops *beneath; /* To the target under this one. */ |
c5aa993b JM |
301 | char *to_shortname; /* Name this target type */ |
302 | char *to_longname; /* Name for printing */ | |
303 | char *to_doc; /* Documentation. Does not include trailing | |
c906108c | 304 | newline, and starts with a one-line descrip- |
0d06e24b | 305 | tion (probably similar to to_longname). */ |
bba2d28d AC |
306 | /* Per-target scratch pad. */ |
307 | void *to_data; | |
f1c07ab0 AC |
308 | /* The open routine takes the rest of the parameters from the |
309 | command, and (if successful) pushes a new target onto the | |
310 | stack. Targets should supply this routine, if only to provide | |
311 | an error message. */ | |
507f3c78 | 312 | void (*to_open) (char *, int); |
f1c07ab0 AC |
313 | /* Old targets with a static target vector provide "to_close". |
314 | New re-entrant targets provide "to_xclose" and that is expected | |
315 | to xfree everything (including the "struct target_ops"). */ | |
316 | void (*to_xclose) (struct target_ops *targ, int quitting); | |
507f3c78 KB |
317 | void (*to_close) (int); |
318 | void (*to_attach) (char *, int); | |
319 | void (*to_post_attach) (int); | |
507f3c78 | 320 | void (*to_detach) (char *, int); |
597320e7 | 321 | void (*to_disconnect) (struct target_ops *, char *, int); |
39f77062 KB |
322 | void (*to_resume) (ptid_t, int, enum target_signal); |
323 | ptid_t (*to_wait) (ptid_t, struct target_waitstatus *); | |
507f3c78 KB |
324 | void (*to_fetch_registers) (int); |
325 | void (*to_store_registers) (int); | |
326 | void (*to_prepare_to_store) (void); | |
c5aa993b JM |
327 | |
328 | /* Transfer LEN bytes of memory between GDB address MYADDR and | |
329 | target address MEMADDR. If WRITE, transfer them to the target, else | |
330 | transfer them from the target. TARGET is the target from which we | |
331 | get this function. | |
332 | ||
333 | Return value, N, is one of the following: | |
334 | ||
335 | 0 means that we can't handle this. If errno has been set, it is the | |
336 | error which prevented us from doing it (FIXME: What about bfd_error?). | |
337 | ||
338 | positive (call it N) means that we have transferred N bytes | |
339 | starting at MEMADDR. We might be able to handle more bytes | |
340 | beyond this length, but no promises. | |
341 | ||
342 | negative (call its absolute value N) means that we cannot | |
343 | transfer right at MEMADDR, but we could transfer at least | |
c8e73a31 | 344 | something at MEMADDR + N. |
c5aa993b | 345 | |
c8e73a31 AC |
346 | NOTE: cagney/2004-10-01: This has been entirely superseeded by |
347 | to_xfer_partial and inferior inheritance. */ | |
348 | ||
1b0ba102 | 349 | int (*deprecated_xfer_memory) (CORE_ADDR memaddr, gdb_byte *myaddr, |
c8e73a31 AC |
350 | int len, int write, |
351 | struct mem_attrib *attrib, | |
352 | struct target_ops *target); | |
c906108c | 353 | |
507f3c78 | 354 | void (*to_files_info) (struct target_ops *); |
8181d85f DJ |
355 | int (*to_insert_breakpoint) (struct bp_target_info *); |
356 | int (*to_remove_breakpoint) (struct bp_target_info *); | |
ccaa32c7 | 357 | int (*to_can_use_hw_breakpoint) (int, int, int); |
8181d85f DJ |
358 | int (*to_insert_hw_breakpoint) (struct bp_target_info *); |
359 | int (*to_remove_hw_breakpoint) (struct bp_target_info *); | |
ccaa32c7 GS |
360 | int (*to_remove_watchpoint) (CORE_ADDR, int, int); |
361 | int (*to_insert_watchpoint) (CORE_ADDR, int, int); | |
362 | int (*to_stopped_by_watchpoint) (void); | |
7df1a324 | 363 | int to_have_continuable_watchpoint; |
4aa7a7f5 | 364 | int (*to_stopped_data_address) (struct target_ops *, CORE_ADDR *); |
e0d24f8d | 365 | int (*to_region_ok_for_hw_watchpoint) (CORE_ADDR, int); |
507f3c78 KB |
366 | void (*to_terminal_init) (void); |
367 | void (*to_terminal_inferior) (void); | |
368 | void (*to_terminal_ours_for_output) (void); | |
369 | void (*to_terminal_ours) (void); | |
a790ad35 | 370 | void (*to_terminal_save_ours) (void); |
507f3c78 KB |
371 | void (*to_terminal_info) (char *, int); |
372 | void (*to_kill) (void); | |
373 | void (*to_load) (char *, int); | |
374 | int (*to_lookup_symbol) (char *, CORE_ADDR *); | |
c27cda74 | 375 | void (*to_create_inferior) (char *, char *, char **, int); |
39f77062 | 376 | void (*to_post_startup_inferior) (ptid_t); |
507f3c78 | 377 | void (*to_acknowledge_created_inferior) (int); |
fa113d1a | 378 | void (*to_insert_fork_catchpoint) (int); |
507f3c78 | 379 | int (*to_remove_fork_catchpoint) (int); |
fa113d1a | 380 | void (*to_insert_vfork_catchpoint) (int); |
507f3c78 | 381 | int (*to_remove_vfork_catchpoint) (int); |
ee057212 | 382 | int (*to_follow_fork) (struct target_ops *, int); |
fa113d1a | 383 | void (*to_insert_exec_catchpoint) (int); |
507f3c78 | 384 | int (*to_remove_exec_catchpoint) (int); |
507f3c78 | 385 | int (*to_reported_exec_events_per_exec_call) (void); |
507f3c78 KB |
386 | int (*to_has_exited) (int, int, int *); |
387 | void (*to_mourn_inferior) (void); | |
388 | int (*to_can_run) (void); | |
39f77062 KB |
389 | void (*to_notice_signals) (ptid_t ptid); |
390 | int (*to_thread_alive) (ptid_t ptid); | |
507f3c78 | 391 | void (*to_find_new_threads) (void); |
39f77062 | 392 | char *(*to_pid_to_str) (ptid_t); |
507f3c78 KB |
393 | char *(*to_extra_thread_info) (struct thread_info *); |
394 | void (*to_stop) (void); | |
d9fcf2fb | 395 | void (*to_rcmd) (char *command, struct ui_file *output); |
507f3c78 KB |
396 | struct symtab_and_line *(*to_enable_exception_callback) (enum |
397 | exception_event_kind, | |
398 | int); | |
399 | struct exception_event_record *(*to_get_current_exception_event) (void); | |
400 | char *(*to_pid_to_exec_file) (int pid); | |
c5aa993b | 401 | enum strata to_stratum; |
c5aa993b JM |
402 | int to_has_all_memory; |
403 | int to_has_memory; | |
404 | int to_has_stack; | |
405 | int to_has_registers; | |
406 | int to_has_execution; | |
407 | int to_has_thread_control; /* control thread execution */ | |
c5aa993b JM |
408 | struct section_table |
409 | *to_sections; | |
410 | struct section_table | |
411 | *to_sections_end; | |
6426a772 JM |
412 | /* ASYNC target controls */ |
413 | int (*to_can_async_p) (void); | |
414 | int (*to_is_async_p) (void); | |
0d06e24b JM |
415 | void (*to_async) (void (*cb) (enum inferior_event_type, void *context), |
416 | void *context); | |
ed9a39eb | 417 | int to_async_mask_value; |
2146d243 RM |
418 | int (*to_find_memory_regions) (int (*) (CORE_ADDR, |
419 | unsigned long, | |
420 | int, int, int, | |
421 | void *), | |
be4d1333 MS |
422 | void *); |
423 | char * (*to_make_corefile_notes) (bfd *, int *); | |
3f47be5c EZ |
424 | |
425 | /* Return the thread-local address at OFFSET in the | |
426 | thread-local storage for the thread PTID and the shared library | |
427 | or executable file given by OBJFILE. If that block of | |
428 | thread-local storage hasn't been allocated yet, this function | |
429 | may return an error. */ | |
430 | CORE_ADDR (*to_get_thread_local_address) (ptid_t ptid, | |
b2756930 | 431 | CORE_ADDR load_module_addr, |
3f47be5c EZ |
432 | CORE_ADDR offset); |
433 | ||
13547ab6 DJ |
434 | /* Request that OPS transfer up to LEN 8-bit bytes of the target's |
435 | OBJECT. The OFFSET, for a seekable object, specifies the | |
436 | starting point. The ANNEX can be used to provide additional | |
437 | data-specific information to the target. | |
438 | ||
439 | Return the number of bytes actually transfered, zero when no | |
440 | further transfer is possible, and -1 when the transfer is not | |
441 | supported. Return of a positive value smaller than LEN does | |
442 | not indicate the end of the object, only the end of the | |
443 | transfer; higher level code should continue transferring if | |
444 | desired. This is handled in target.c. | |
445 | ||
446 | The interface does not support a "retry" mechanism. Instead it | |
447 | assumes that at least one byte will be transfered on each | |
448 | successful call. | |
449 | ||
450 | NOTE: cagney/2003-10-17: The current interface can lead to | |
451 | fragmented transfers. Lower target levels should not implement | |
452 | hacks, such as enlarging the transfer, in an attempt to | |
453 | compensate for this. Instead, the target stack should be | |
454 | extended so that it implements supply/collect methods and a | |
455 | look-aside object cache. With that available, the lowest | |
456 | target can safely and freely "push" data up the stack. | |
457 | ||
458 | See target_read and target_write for more information. One, | |
459 | and only one, of readbuf or writebuf must be non-NULL. */ | |
460 | ||
4b8a223f | 461 | LONGEST (*to_xfer_partial) (struct target_ops *ops, |
8aa91c1e | 462 | enum target_object object, const char *annex, |
1b0ba102 | 463 | gdb_byte *readbuf, const gdb_byte *writebuf, |
8aa91c1e | 464 | ULONGEST offset, LONGEST len); |
1e3ff5ad | 465 | |
fd79ecee DJ |
466 | /* Returns the memory map for the target. A return value of NULL |
467 | means that no memory map is available. If a memory address | |
468 | does not fall within any returned regions, it's assumed to be | |
469 | RAM. The returned memory regions should not overlap. | |
470 | ||
471 | The order of regions does not matter; target_memory_map will | |
472 | sort regions by starting address. For that reason, this | |
473 | function should not be called directly except via | |
474 | target_memory_map. | |
475 | ||
476 | This method should not cache data; if the memory map could | |
477 | change unexpectedly, it should be invalidated, and higher | |
478 | layers will re-fetch it. */ | |
479 | VEC(mem_region_s) *(*to_memory_map) (struct target_ops *); | |
480 | ||
a76d924d DJ |
481 | /* Erases the region of flash memory starting at ADDRESS, of |
482 | length LENGTH. | |
483 | ||
484 | Precondition: both ADDRESS and ADDRESS+LENGTH should be aligned | |
485 | on flash block boundaries, as reported by 'to_memory_map'. */ | |
486 | void (*to_flash_erase) (struct target_ops *, | |
487 | ULONGEST address, LONGEST length); | |
488 | ||
489 | /* Finishes a flash memory write sequence. After this operation | |
490 | all flash memory should be available for writing and the result | |
491 | of reading from areas written by 'to_flash_write' should be | |
492 | equal to what was written. */ | |
493 | void (*to_flash_done) (struct target_ops *); | |
494 | ||
c5aa993b | 495 | int to_magic; |
0d06e24b JM |
496 | /* Need sub-structure for target machine related rather than comm related? |
497 | */ | |
c5aa993b | 498 | }; |
c906108c SS |
499 | |
500 | /* Magic number for checking ops size. If a struct doesn't end with this | |
501 | number, somebody changed the declaration but didn't change all the | |
502 | places that initialize one. */ | |
503 | ||
504 | #define OPS_MAGIC 3840 | |
505 | ||
506 | /* The ops structure for our "current" target process. This should | |
507 | never be NULL. If there is no target, it points to the dummy_target. */ | |
508 | ||
c5aa993b | 509 | extern struct target_ops current_target; |
c906108c | 510 | |
c906108c SS |
511 | /* Define easy words for doing these operations on our current target. */ |
512 | ||
513 | #define target_shortname (current_target.to_shortname) | |
514 | #define target_longname (current_target.to_longname) | |
515 | ||
f1c07ab0 AC |
516 | /* Does whatever cleanup is required for a target that we are no |
517 | longer going to be calling. QUITTING indicates that GDB is exiting | |
518 | and should not get hung on an error (otherwise it is important to | |
519 | perform clean termination, even if it takes a while). This routine | |
520 | is automatically always called when popping the target off the | |
521 | target stack (to_beneath is undefined). Closing file descriptors | |
522 | and freeing all memory allocated memory are typical things it | |
523 | should do. */ | |
524 | ||
525 | void target_close (struct target_ops *targ, int quitting); | |
c906108c SS |
526 | |
527 | /* Attaches to a process on the target side. Arguments are as passed | |
528 | to the `attach' command by the user. This routine can be called | |
529 | when the target is not on the target-stack, if the target_can_run | |
2146d243 | 530 | routine returns 1; in that case, it must push itself onto the stack. |
c906108c | 531 | Upon exit, the target should be ready for normal operations, and |
2146d243 | 532 | should be ready to deliver the status of the process immediately |
c906108c SS |
533 | (without waiting) to an upcoming target_wait call. */ |
534 | ||
535 | #define target_attach(args, from_tty) \ | |
0d06e24b | 536 | (*current_target.to_attach) (args, from_tty) |
c906108c SS |
537 | |
538 | /* The target_attach operation places a process under debugger control, | |
539 | and stops the process. | |
540 | ||
541 | This operation provides a target-specific hook that allows the | |
0d06e24b | 542 | necessary bookkeeping to be performed after an attach completes. */ |
c906108c | 543 | #define target_post_attach(pid) \ |
0d06e24b | 544 | (*current_target.to_post_attach) (pid) |
c906108c | 545 | |
c906108c SS |
546 | /* Takes a program previously attached to and detaches it. |
547 | The program may resume execution (some targets do, some don't) and will | |
548 | no longer stop on signals, etc. We better not have left any breakpoints | |
549 | in the program or it'll die when it hits one. ARGS is arguments | |
550 | typed by the user (e.g. a signal to send the process). FROM_TTY | |
551 | says whether to be verbose or not. */ | |
552 | ||
a14ed312 | 553 | extern void target_detach (char *, int); |
c906108c | 554 | |
6ad8ae5c DJ |
555 | /* Disconnect from the current target without resuming it (leaving it |
556 | waiting for a debugger). */ | |
557 | ||
558 | extern void target_disconnect (char *, int); | |
559 | ||
39f77062 | 560 | /* Resume execution of the target process PTID. STEP says whether to |
c906108c SS |
561 | single-step or to run free; SIGGNAL is the signal to be given to |
562 | the target, or TARGET_SIGNAL_0 for no signal. The caller may not | |
563 | pass TARGET_SIGNAL_DEFAULT. */ | |
564 | ||
39f77062 | 565 | #define target_resume(ptid, step, siggnal) \ |
4930751a C |
566 | do { \ |
567 | dcache_invalidate(target_dcache); \ | |
39f77062 | 568 | (*current_target.to_resume) (ptid, step, siggnal); \ |
4930751a | 569 | } while (0) |
c906108c | 570 | |
b5a2688f AC |
571 | /* Wait for process pid to do something. PTID = -1 to wait for any |
572 | pid to do something. Return pid of child, or -1 in case of error; | |
c906108c | 573 | store status through argument pointer STATUS. Note that it is |
b5a2688f | 574 | _NOT_ OK to throw_exception() out of target_wait() without popping |
c906108c SS |
575 | the debugging target from the stack; GDB isn't prepared to get back |
576 | to the prompt with a debugging target but without the frame cache, | |
577 | stop_pc, etc., set up. */ | |
578 | ||
39f77062 KB |
579 | #define target_wait(ptid, status) \ |
580 | (*current_target.to_wait) (ptid, status) | |
c906108c | 581 | |
17dee195 | 582 | /* Fetch at least register REGNO, or all regs if regno == -1. No result. */ |
c906108c SS |
583 | |
584 | #define target_fetch_registers(regno) \ | |
0d06e24b | 585 | (*current_target.to_fetch_registers) (regno) |
c906108c SS |
586 | |
587 | /* Store at least register REGNO, or all regs if REGNO == -1. | |
588 | It can store as many registers as it wants to, so target_prepare_to_store | |
589 | must have been previously called. Calls error() if there are problems. */ | |
590 | ||
591 | #define target_store_registers(regs) \ | |
0d06e24b | 592 | (*current_target.to_store_registers) (regs) |
c906108c SS |
593 | |
594 | /* Get ready to modify the registers array. On machines which store | |
595 | individual registers, this doesn't need to do anything. On machines | |
596 | which store all the registers in one fell swoop, this makes sure | |
597 | that REGISTERS contains all the registers from the program being | |
598 | debugged. */ | |
599 | ||
600 | #define target_prepare_to_store() \ | |
0d06e24b | 601 | (*current_target.to_prepare_to_store) () |
c906108c | 602 | |
4930751a C |
603 | extern DCACHE *target_dcache; |
604 | ||
a14ed312 | 605 | extern int target_read_string (CORE_ADDR, char **, int, int *); |
c906108c | 606 | |
fc1a4b47 | 607 | extern int target_read_memory (CORE_ADDR memaddr, gdb_byte *myaddr, int len); |
c906108c | 608 | |
fc1a4b47 | 609 | extern int target_write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr, |
10e2d419 | 610 | int len); |
c906108c | 611 | |
1b0ba102 | 612 | extern int xfer_memory (CORE_ADDR, gdb_byte *, int, int, |
29e57380 | 613 | struct mem_attrib *, struct target_ops *); |
c906108c | 614 | |
6c932e54 | 615 | extern int child_xfer_memory (CORE_ADDR, gdb_byte *, int, int, |
29e57380 | 616 | struct mem_attrib *, struct target_ops *); |
c906108c | 617 | |
fd79ecee DJ |
618 | /* Fetches the target's memory map. If one is found it is sorted |
619 | and returned, after some consistency checking. Otherwise, NULL | |
620 | is returned. */ | |
621 | VEC(mem_region_s) *target_memory_map (void); | |
622 | ||
a76d924d DJ |
623 | /* Erase the specified flash region. */ |
624 | void target_flash_erase (ULONGEST address, LONGEST length); | |
625 | ||
626 | /* Finish a sequence of flash operations. */ | |
627 | void target_flash_done (void); | |
628 | ||
629 | /* Describes a request for a memory write operation. */ | |
630 | struct memory_write_request | |
631 | { | |
632 | /* Begining address that must be written. */ | |
633 | ULONGEST begin; | |
634 | /* Past-the-end address. */ | |
635 | ULONGEST end; | |
636 | /* The data to write. */ | |
637 | gdb_byte *data; | |
638 | /* A callback baton for progress reporting for this request. */ | |
639 | void *baton; | |
640 | }; | |
641 | typedef struct memory_write_request memory_write_request_s; | |
642 | DEF_VEC_O(memory_write_request_s); | |
643 | ||
644 | /* Enumeration specifying different flash preservation behaviour. */ | |
645 | enum flash_preserve_mode | |
646 | { | |
647 | flash_preserve, | |
648 | flash_discard | |
649 | }; | |
650 | ||
651 | /* Write several memory blocks at once. This version can be more | |
652 | efficient than making several calls to target_write_memory, in | |
653 | particular because it can optimize accesses to flash memory. | |
654 | ||
655 | Moreover, this is currently the only memory access function in gdb | |
656 | that supports writing to flash memory, and it should be used for | |
657 | all cases where access to flash memory is desirable. | |
658 | ||
659 | REQUESTS is the vector (see vec.h) of memory_write_request. | |
660 | PRESERVE_FLASH_P indicates what to do with blocks which must be | |
661 | erased, but not completely rewritten. | |
662 | PROGRESS_CB is a function that will be periodically called to provide | |
663 | feedback to user. It will be called with the baton corresponding | |
664 | to the request currently being written. It may also be called | |
665 | with a NULL baton, when preserved flash sectors are being rewritten. | |
666 | ||
667 | The function returns 0 on success, and error otherwise. */ | |
668 | int target_write_memory_blocks (VEC(memory_write_request_s) *requests, | |
669 | enum flash_preserve_mode preserve_flash_p, | |
670 | void (*progress_cb) (ULONGEST, void *)); | |
671 | ||
672 | ||
a14ed312 | 673 | extern char *child_pid_to_exec_file (int); |
c906108c | 674 | |
a14ed312 | 675 | extern char *child_core_file_to_sym_file (char *); |
c906108c SS |
676 | |
677 | #if defined(CHILD_POST_ATTACH) | |
a14ed312 | 678 | extern void child_post_attach (int); |
c906108c SS |
679 | #endif |
680 | ||
39f77062 | 681 | extern void child_post_startup_inferior (ptid_t); |
c906108c | 682 | |
a14ed312 | 683 | extern void child_acknowledge_created_inferior (int); |
c906108c | 684 | |
fa113d1a | 685 | extern void child_insert_fork_catchpoint (int); |
c906108c | 686 | |
a14ed312 | 687 | extern int child_remove_fork_catchpoint (int); |
c906108c | 688 | |
fa113d1a | 689 | extern void child_insert_vfork_catchpoint (int); |
c906108c | 690 | |
a14ed312 | 691 | extern int child_remove_vfork_catchpoint (int); |
c906108c | 692 | |
a14ed312 | 693 | extern void child_acknowledge_created_inferior (int); |
c906108c | 694 | |
ee057212 | 695 | extern int child_follow_fork (struct target_ops *, int); |
c906108c | 696 | |
fa113d1a | 697 | extern void child_insert_exec_catchpoint (int); |
c906108c | 698 | |
a14ed312 | 699 | extern int child_remove_exec_catchpoint (int); |
c906108c | 700 | |
a14ed312 | 701 | extern int child_reported_exec_events_per_exec_call (void); |
c906108c | 702 | |
a14ed312 | 703 | extern int child_has_exited (int, int, int *); |
c906108c | 704 | |
39f77062 | 705 | extern int child_thread_alive (ptid_t); |
c906108c | 706 | |
47932f85 DJ |
707 | /* From infrun.c. */ |
708 | ||
709 | extern int inferior_has_forked (int pid, int *child_pid); | |
710 | ||
711 | extern int inferior_has_vforked (int pid, int *child_pid); | |
712 | ||
713 | extern int inferior_has_execd (int pid, char **execd_pathname); | |
714 | ||
c906108c SS |
715 | /* From exec.c */ |
716 | ||
a14ed312 | 717 | extern void print_section_info (struct target_ops *, bfd *); |
c906108c SS |
718 | |
719 | /* Print a line about the current target. */ | |
720 | ||
721 | #define target_files_info() \ | |
0d06e24b | 722 | (*current_target.to_files_info) (¤t_target) |
c906108c | 723 | |
8181d85f DJ |
724 | /* Insert a breakpoint at address BP_TGT->placed_address in the target |
725 | machine. Result is 0 for success, or an errno value. */ | |
c906108c | 726 | |
8181d85f DJ |
727 | #define target_insert_breakpoint(bp_tgt) \ |
728 | (*current_target.to_insert_breakpoint) (bp_tgt) | |
c906108c | 729 | |
8181d85f DJ |
730 | /* Remove a breakpoint at address BP_TGT->placed_address in the target |
731 | machine. Result is 0 for success, or an errno value. */ | |
c906108c | 732 | |
8181d85f DJ |
733 | #define target_remove_breakpoint(bp_tgt) \ |
734 | (*current_target.to_remove_breakpoint) (bp_tgt) | |
c906108c SS |
735 | |
736 | /* Initialize the terminal settings we record for the inferior, | |
737 | before we actually run the inferior. */ | |
738 | ||
739 | #define target_terminal_init() \ | |
0d06e24b | 740 | (*current_target.to_terminal_init) () |
c906108c SS |
741 | |
742 | /* Put the inferior's terminal settings into effect. | |
743 | This is preparation for starting or resuming the inferior. */ | |
744 | ||
745 | #define target_terminal_inferior() \ | |
0d06e24b | 746 | (*current_target.to_terminal_inferior) () |
c906108c SS |
747 | |
748 | /* Put some of our terminal settings into effect, | |
749 | enough to get proper results from our output, | |
750 | but do not change into or out of RAW mode | |
751 | so that no input is discarded. | |
752 | ||
753 | After doing this, either terminal_ours or terminal_inferior | |
754 | should be called to get back to a normal state of affairs. */ | |
755 | ||
756 | #define target_terminal_ours_for_output() \ | |
0d06e24b | 757 | (*current_target.to_terminal_ours_for_output) () |
c906108c SS |
758 | |
759 | /* Put our terminal settings into effect. | |
760 | First record the inferior's terminal settings | |
761 | so they can be restored properly later. */ | |
762 | ||
763 | #define target_terminal_ours() \ | |
0d06e24b | 764 | (*current_target.to_terminal_ours) () |
c906108c | 765 | |
a790ad35 SC |
766 | /* Save our terminal settings. |
767 | This is called from TUI after entering or leaving the curses | |
768 | mode. Since curses modifies our terminal this call is here | |
769 | to take this change into account. */ | |
770 | ||
771 | #define target_terminal_save_ours() \ | |
772 | (*current_target.to_terminal_save_ours) () | |
773 | ||
c906108c SS |
774 | /* Print useful information about our terminal status, if such a thing |
775 | exists. */ | |
776 | ||
777 | #define target_terminal_info(arg, from_tty) \ | |
0d06e24b | 778 | (*current_target.to_terminal_info) (arg, from_tty) |
c906108c SS |
779 | |
780 | /* Kill the inferior process. Make it go away. */ | |
781 | ||
782 | #define target_kill() \ | |
0d06e24b | 783 | (*current_target.to_kill) () |
c906108c | 784 | |
0d06e24b JM |
785 | /* Load an executable file into the target process. This is expected |
786 | to not only bring new code into the target process, but also to | |
1986bccd AS |
787 | update GDB's symbol tables to match. |
788 | ||
789 | ARG contains command-line arguments, to be broken down with | |
790 | buildargv (). The first non-switch argument is the filename to | |
791 | load, FILE; the second is a number (as parsed by strtoul (..., ..., | |
792 | 0)), which is an offset to apply to the load addresses of FILE's | |
793 | sections. The target may define switches, or other non-switch | |
794 | arguments, as it pleases. */ | |
c906108c | 795 | |
11cf8741 | 796 | extern void target_load (char *arg, int from_tty); |
c906108c SS |
797 | |
798 | /* Look up a symbol in the target's symbol table. NAME is the symbol | |
0d06e24b JM |
799 | name. ADDRP is a CORE_ADDR * pointing to where the value of the |
800 | symbol should be returned. The result is 0 if successful, nonzero | |
801 | if the symbol does not exist in the target environment. This | |
802 | function should not call error() if communication with the target | |
803 | is interrupted, since it is called from symbol reading, but should | |
804 | return nonzero, possibly doing a complain(). */ | |
c906108c | 805 | |
0d06e24b JM |
806 | #define target_lookup_symbol(name, addrp) \ |
807 | (*current_target.to_lookup_symbol) (name, addrp) | |
c906108c | 808 | |
39f77062 | 809 | /* Start an inferior process and set inferior_ptid to its pid. |
c906108c SS |
810 | EXEC_FILE is the file to run. |
811 | ALLARGS is a string containing the arguments to the program. | |
812 | ENV is the environment vector to pass. Errors reported with error(). | |
813 | On VxWorks and various standalone systems, we ignore exec_file. */ | |
c5aa993b | 814 | |
c27cda74 AC |
815 | #define target_create_inferior(exec_file, args, env, FROM_TTY) \ |
816 | (*current_target.to_create_inferior) (exec_file, args, env, (FROM_TTY)) | |
c906108c SS |
817 | |
818 | ||
819 | /* Some targets (such as ttrace-based HPUX) don't allow us to request | |
820 | notification of inferior events such as fork and vork immediately | |
821 | after the inferior is created. (This because of how gdb gets an | |
822 | inferior created via invoking a shell to do it. In such a scenario, | |
823 | if the shell init file has commands in it, the shell will fork and | |
824 | exec for each of those commands, and we will see each such fork | |
825 | event. Very bad.) | |
c5aa993b | 826 | |
0d06e24b JM |
827 | Such targets will supply an appropriate definition for this function. */ |
828 | ||
39f77062 KB |
829 | #define target_post_startup_inferior(ptid) \ |
830 | (*current_target.to_post_startup_inferior) (ptid) | |
c906108c SS |
831 | |
832 | /* On some targets, the sequence of starting up an inferior requires | |
0d06e24b JM |
833 | some synchronization between gdb and the new inferior process, PID. */ |
834 | ||
c906108c | 835 | #define target_acknowledge_created_inferior(pid) \ |
0d06e24b | 836 | (*current_target.to_acknowledge_created_inferior) (pid) |
c906108c | 837 | |
0d06e24b JM |
838 | /* On some targets, we can catch an inferior fork or vfork event when |
839 | it occurs. These functions insert/remove an already-created | |
840 | catchpoint for such events. */ | |
c906108c | 841 | |
c906108c | 842 | #define target_insert_fork_catchpoint(pid) \ |
0d06e24b | 843 | (*current_target.to_insert_fork_catchpoint) (pid) |
c906108c SS |
844 | |
845 | #define target_remove_fork_catchpoint(pid) \ | |
0d06e24b | 846 | (*current_target.to_remove_fork_catchpoint) (pid) |
c906108c SS |
847 | |
848 | #define target_insert_vfork_catchpoint(pid) \ | |
0d06e24b | 849 | (*current_target.to_insert_vfork_catchpoint) (pid) |
c906108c SS |
850 | |
851 | #define target_remove_vfork_catchpoint(pid) \ | |
0d06e24b | 852 | (*current_target.to_remove_vfork_catchpoint) (pid) |
c906108c | 853 | |
6604731b DJ |
854 | /* If the inferior forks or vforks, this function will be called at |
855 | the next resume in order to perform any bookkeeping and fiddling | |
856 | necessary to continue debugging either the parent or child, as | |
857 | requested, and releasing the other. Information about the fork | |
858 | or vfork event is available via get_last_target_status (). | |
859 | This function returns 1 if the inferior should not be resumed | |
860 | (i.e. there is another event pending). */ | |
0d06e24b | 861 | |
ee057212 | 862 | int target_follow_fork (int follow_child); |
c906108c SS |
863 | |
864 | /* On some targets, we can catch an inferior exec event when it | |
0d06e24b JM |
865 | occurs. These functions insert/remove an already-created |
866 | catchpoint for such events. */ | |
867 | ||
c906108c | 868 | #define target_insert_exec_catchpoint(pid) \ |
0d06e24b | 869 | (*current_target.to_insert_exec_catchpoint) (pid) |
c5aa993b | 870 | |
c906108c | 871 | #define target_remove_exec_catchpoint(pid) \ |
0d06e24b | 872 | (*current_target.to_remove_exec_catchpoint) (pid) |
c906108c | 873 | |
c906108c SS |
874 | /* Returns the number of exec events that are reported when a process |
875 | invokes a flavor of the exec() system call on this target, if exec | |
0d06e24b JM |
876 | events are being reported. */ |
877 | ||
c906108c | 878 | #define target_reported_exec_events_per_exec_call() \ |
0d06e24b | 879 | (*current_target.to_reported_exec_events_per_exec_call) () |
c906108c | 880 | |
c906108c | 881 | /* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the |
0d06e24b JM |
882 | exit code of PID, if any. */ |
883 | ||
c906108c | 884 | #define target_has_exited(pid,wait_status,exit_status) \ |
0d06e24b | 885 | (*current_target.to_has_exited) (pid,wait_status,exit_status) |
c906108c SS |
886 | |
887 | /* The debugger has completed a blocking wait() call. There is now | |
2146d243 | 888 | some process event that must be processed. This function should |
c906108c | 889 | be defined by those targets that require the debugger to perform |
0d06e24b | 890 | cleanup or internal state changes in response to the process event. */ |
c906108c SS |
891 | |
892 | /* The inferior process has died. Do what is right. */ | |
893 | ||
894 | #define target_mourn_inferior() \ | |
0d06e24b | 895 | (*current_target.to_mourn_inferior) () |
c906108c SS |
896 | |
897 | /* Does target have enough data to do a run or attach command? */ | |
898 | ||
899 | #define target_can_run(t) \ | |
0d06e24b | 900 | ((t)->to_can_run) () |
c906108c SS |
901 | |
902 | /* post process changes to signal handling in the inferior. */ | |
903 | ||
39f77062 KB |
904 | #define target_notice_signals(ptid) \ |
905 | (*current_target.to_notice_signals) (ptid) | |
c906108c SS |
906 | |
907 | /* Check to see if a thread is still alive. */ | |
908 | ||
39f77062 KB |
909 | #define target_thread_alive(ptid) \ |
910 | (*current_target.to_thread_alive) (ptid) | |
c906108c | 911 | |
b83266a0 SS |
912 | /* Query for new threads and add them to the thread list. */ |
913 | ||
914 | #define target_find_new_threads() \ | |
0d06e24b | 915 | (*current_target.to_find_new_threads) (); \ |
b83266a0 | 916 | |
0d06e24b JM |
917 | /* Make target stop in a continuable fashion. (For instance, under |
918 | Unix, this should act like SIGSTOP). This function is normally | |
919 | used by GUIs to implement a stop button. */ | |
c906108c SS |
920 | |
921 | #define target_stop current_target.to_stop | |
922 | ||
96baa820 JM |
923 | /* Send the specified COMMAND to the target's monitor |
924 | (shell,interpreter) for execution. The result of the query is | |
0d06e24b | 925 | placed in OUTBUF. */ |
96baa820 JM |
926 | |
927 | #define target_rcmd(command, outbuf) \ | |
928 | (*current_target.to_rcmd) (command, outbuf) | |
929 | ||
930 | ||
c906108c | 931 | /* Get the symbol information for a breakpointable routine called when |
2146d243 | 932 | an exception event occurs. |
c906108c SS |
933 | Intended mainly for C++, and for those |
934 | platforms/implementations where such a callback mechanism is available, | |
935 | e.g. HP-UX with ANSI C++ (aCC). Some compilers (e.g. g++) support | |
0d06e24b | 936 | different mechanisms for debugging exceptions. */ |
c906108c SS |
937 | |
938 | #define target_enable_exception_callback(kind, enable) \ | |
0d06e24b | 939 | (*current_target.to_enable_exception_callback) (kind, enable) |
c906108c | 940 | |
0d06e24b | 941 | /* Get the current exception event kind -- throw or catch, etc. */ |
c5aa993b | 942 | |
c906108c | 943 | #define target_get_current_exception_event() \ |
0d06e24b | 944 | (*current_target.to_get_current_exception_event) () |
c906108c | 945 | |
c906108c SS |
946 | /* Does the target include all of memory, or only part of it? This |
947 | determines whether we look up the target chain for other parts of | |
948 | memory if this target can't satisfy a request. */ | |
949 | ||
950 | #define target_has_all_memory \ | |
0d06e24b | 951 | (current_target.to_has_all_memory) |
c906108c SS |
952 | |
953 | /* Does the target include memory? (Dummy targets don't.) */ | |
954 | ||
955 | #define target_has_memory \ | |
0d06e24b | 956 | (current_target.to_has_memory) |
c906108c SS |
957 | |
958 | /* Does the target have a stack? (Exec files don't, VxWorks doesn't, until | |
959 | we start a process.) */ | |
c5aa993b | 960 | |
c906108c | 961 | #define target_has_stack \ |
0d06e24b | 962 | (current_target.to_has_stack) |
c906108c SS |
963 | |
964 | /* Does the target have registers? (Exec files don't.) */ | |
965 | ||
966 | #define target_has_registers \ | |
0d06e24b | 967 | (current_target.to_has_registers) |
c906108c SS |
968 | |
969 | /* Does the target have execution? Can we make it jump (through | |
52bb452f DJ |
970 | hoops), or pop its stack a few times? This means that the current |
971 | target is currently executing; for some targets, that's the same as | |
972 | whether or not the target is capable of execution, but there are | |
973 | also targets which can be current while not executing. In that | |
974 | case this will become true after target_create_inferior or | |
975 | target_attach. */ | |
c906108c SS |
976 | |
977 | #define target_has_execution \ | |
0d06e24b | 978 | (current_target.to_has_execution) |
c906108c SS |
979 | |
980 | /* Can the target support the debugger control of thread execution? | |
981 | a) Can it lock the thread scheduler? | |
982 | b) Can it switch the currently running thread? */ | |
983 | ||
984 | #define target_can_lock_scheduler \ | |
0d06e24b | 985 | (current_target.to_has_thread_control & tc_schedlock) |
c906108c SS |
986 | |
987 | #define target_can_switch_threads \ | |
0d06e24b | 988 | (current_target.to_has_thread_control & tc_switch) |
c906108c | 989 | |
6426a772 JM |
990 | /* Can the target support asynchronous execution? */ |
991 | #define target_can_async_p() (current_target.to_can_async_p ()) | |
992 | ||
993 | /* Is the target in asynchronous execution mode? */ | |
994 | #define target_is_async_p() (current_target.to_is_async_p()) | |
995 | ||
996 | /* Put the target in async mode with the specified callback function. */ | |
0d06e24b JM |
997 | #define target_async(CALLBACK,CONTEXT) \ |
998 | (current_target.to_async((CALLBACK), (CONTEXT))) | |
43ff13b4 | 999 | |
04714b91 AC |
1000 | /* This is to be used ONLY within call_function_by_hand(). It provides |
1001 | a workaround, to have inferior function calls done in sychronous | |
1002 | mode, even though the target is asynchronous. After | |
ed9a39eb JM |
1003 | target_async_mask(0) is called, calls to target_can_async_p() will |
1004 | return FALSE , so that target_resume() will not try to start the | |
1005 | target asynchronously. After the inferior stops, we IMMEDIATELY | |
1006 | restore the previous nature of the target, by calling | |
1007 | target_async_mask(1). After that, target_can_async_p() will return | |
04714b91 | 1008 | TRUE. ANY OTHER USE OF THIS FEATURE IS DEPRECATED. |
ed9a39eb JM |
1009 | |
1010 | FIXME ezannoni 1999-12-13: we won't need this once we move | |
1011 | the turning async on and off to the single execution commands, | |
0d06e24b | 1012 | from where it is done currently, in remote_resume(). */ |
ed9a39eb JM |
1013 | |
1014 | #define target_async_mask_value \ | |
0d06e24b | 1015 | (current_target.to_async_mask_value) |
ed9a39eb | 1016 | |
2146d243 | 1017 | extern int target_async_mask (int mask); |
ed9a39eb | 1018 | |
c906108c SS |
1019 | /* Converts a process id to a string. Usually, the string just contains |
1020 | `process xyz', but on some systems it may contain | |
1021 | `process xyz thread abc'. */ | |
1022 | ||
ed9a39eb JM |
1023 | #undef target_pid_to_str |
1024 | #define target_pid_to_str(PID) current_target.to_pid_to_str (PID) | |
c906108c SS |
1025 | |
1026 | #ifndef target_tid_to_str | |
1027 | #define target_tid_to_str(PID) \ | |
0d06e24b | 1028 | target_pid_to_str (PID) |
39f77062 | 1029 | extern char *normal_pid_to_str (ptid_t ptid); |
c906108c | 1030 | #endif |
c5aa993b | 1031 | |
0d06e24b JM |
1032 | /* Return a short string describing extra information about PID, |
1033 | e.g. "sleeping", "runnable", "running on LWP 3". Null return value | |
1034 | is okay. */ | |
1035 | ||
1036 | #define target_extra_thread_info(TP) \ | |
1037 | (current_target.to_extra_thread_info (TP)) | |
ed9a39eb | 1038 | |
11cf8741 JM |
1039 | /* |
1040 | * New Objfile Event Hook: | |
1041 | * | |
1042 | * Sometimes a GDB component wants to get notified whenever a new | |
2146d243 | 1043 | * objfile is loaded. Mainly this is used by thread-debugging |
11cf8741 JM |
1044 | * implementations that need to know when symbols for the target |
1045 | * thread implemenation are available. | |
1046 | * | |
1047 | * The old way of doing this is to define a macro 'target_new_objfile' | |
1048 | * that points to the function that you want to be called on every | |
1049 | * objfile/shlib load. | |
9a4105ab AC |
1050 | |
1051 | The new way is to grab the function pointer, | |
1052 | 'deprecated_target_new_objfile_hook', and point it to the function | |
1053 | that you want to be called on every objfile/shlib load. | |
1054 | ||
1055 | If multiple clients are willing to be cooperative, they can each | |
1056 | save a pointer to the previous value of | |
1057 | deprecated_target_new_objfile_hook before modifying it, and arrange | |
1058 | for their function to call the previous function in the chain. In | |
1059 | that way, multiple clients can receive this notification (something | |
1060 | like with signal handlers). */ | |
1061 | ||
1062 | extern void (*deprecated_target_new_objfile_hook) (struct objfile *); | |
c906108c SS |
1063 | |
1064 | #ifndef target_pid_or_tid_to_str | |
1065 | #define target_pid_or_tid_to_str(ID) \ | |
0d06e24b | 1066 | target_pid_to_str (ID) |
c906108c SS |
1067 | #endif |
1068 | ||
1069 | /* Attempts to find the pathname of the executable file | |
1070 | that was run to create a specified process. | |
1071 | ||
1072 | The process PID must be stopped when this operation is used. | |
c5aa993b | 1073 | |
c906108c SS |
1074 | If the executable file cannot be determined, NULL is returned. |
1075 | ||
1076 | Else, a pointer to a character string containing the pathname | |
1077 | is returned. This string should be copied into a buffer by | |
1078 | the client if the string will not be immediately used, or if | |
0d06e24b | 1079 | it must persist. */ |
c906108c SS |
1080 | |
1081 | #define target_pid_to_exec_file(pid) \ | |
0d06e24b | 1082 | (current_target.to_pid_to_exec_file) (pid) |
c906108c | 1083 | |
be4d1333 MS |
1084 | /* |
1085 | * Iterator function for target memory regions. | |
1086 | * Calls a callback function once for each memory region 'mapped' | |
1087 | * in the child process. Defined as a simple macro rather than | |
2146d243 | 1088 | * as a function macro so that it can be tested for nullity. |
be4d1333 MS |
1089 | */ |
1090 | ||
1091 | #define target_find_memory_regions(FUNC, DATA) \ | |
1092 | (current_target.to_find_memory_regions) (FUNC, DATA) | |
1093 | ||
1094 | /* | |
1095 | * Compose corefile .note section. | |
1096 | */ | |
1097 | ||
1098 | #define target_make_corefile_notes(BFD, SIZE_P) \ | |
1099 | (current_target.to_make_corefile_notes) (BFD, SIZE_P) | |
1100 | ||
3f47be5c EZ |
1101 | /* Thread-local values. */ |
1102 | #define target_get_thread_local_address \ | |
1103 | (current_target.to_get_thread_local_address) | |
1104 | #define target_get_thread_local_address_p() \ | |
1105 | (target_get_thread_local_address != NULL) | |
1106 | ||
9d8a64cb | 1107 | /* Hook to call target dependent code just after inferior target process has |
c906108c SS |
1108 | started. */ |
1109 | ||
1110 | #ifndef TARGET_CREATE_INFERIOR_HOOK | |
1111 | #define TARGET_CREATE_INFERIOR_HOOK(PID) | |
1112 | #endif | |
1113 | ||
1114 | /* Hardware watchpoint interfaces. */ | |
1115 | ||
1116 | /* Returns non-zero if we were stopped by a hardware watchpoint (memory read or | |
1117 | write). */ | |
1118 | ||
1119 | #ifndef STOPPED_BY_WATCHPOINT | |
ccaa32c7 GS |
1120 | #define STOPPED_BY_WATCHPOINT(w) \ |
1121 | (*current_target.to_stopped_by_watchpoint) () | |
c906108c | 1122 | #endif |
7df1a324 KW |
1123 | |
1124 | /* Non-zero if we have continuable watchpoints */ | |
1125 | ||
1126 | #ifndef HAVE_CONTINUABLE_WATCHPOINT | |
1127 | #define HAVE_CONTINUABLE_WATCHPOINT \ | |
1128 | (current_target.to_have_continuable_watchpoint) | |
1129 | #endif | |
c906108c | 1130 | |
ccaa32c7 | 1131 | /* Provide defaults for hardware watchpoint functions. */ |
c906108c | 1132 | |
2146d243 | 1133 | /* If the *_hw_beakpoint functions have not been defined |
ccaa32c7 | 1134 | elsewhere use the definitions in the target vector. */ |
c906108c SS |
1135 | |
1136 | /* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is | |
1137 | one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or | |
1138 | bp_hardware_breakpoint. CNT is the number of such watchpoints used so far | |
1139 | (including this one?). OTHERTYPE is who knows what... */ | |
1140 | ||
ccaa32c7 GS |
1141 | #ifndef TARGET_CAN_USE_HARDWARE_WATCHPOINT |
1142 | #define TARGET_CAN_USE_HARDWARE_WATCHPOINT(TYPE,CNT,OTHERTYPE) \ | |
1143 | (*current_target.to_can_use_hw_breakpoint) (TYPE, CNT, OTHERTYPE); | |
1144 | #endif | |
c906108c | 1145 | |
e0d24f8d WZ |
1146 | #ifndef TARGET_REGION_OK_FOR_HW_WATCHPOINT |
1147 | #define TARGET_REGION_OK_FOR_HW_WATCHPOINT(addr, len) \ | |
1148 | (*current_target.to_region_ok_for_hw_watchpoint) (addr, len) | |
1149 | #endif | |
1150 | ||
c906108c SS |
1151 | |
1152 | /* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes. TYPE is 0 | |
1153 | for write, 1 for read, and 2 for read/write accesses. Returns 0 for | |
1154 | success, non-zero for failure. */ | |
1155 | ||
ccaa32c7 GS |
1156 | #ifndef target_insert_watchpoint |
1157 | #define target_insert_watchpoint(addr, len, type) \ | |
1158 | (*current_target.to_insert_watchpoint) (addr, len, type) | |
c906108c | 1159 | |
ccaa32c7 GS |
1160 | #define target_remove_watchpoint(addr, len, type) \ |
1161 | (*current_target.to_remove_watchpoint) (addr, len, type) | |
1162 | #endif | |
c906108c SS |
1163 | |
1164 | #ifndef target_insert_hw_breakpoint | |
8181d85f DJ |
1165 | #define target_insert_hw_breakpoint(bp_tgt) \ |
1166 | (*current_target.to_insert_hw_breakpoint) (bp_tgt) | |
ccaa32c7 | 1167 | |
8181d85f DJ |
1168 | #define target_remove_hw_breakpoint(bp_tgt) \ |
1169 | (*current_target.to_remove_hw_breakpoint) (bp_tgt) | |
c906108c SS |
1170 | #endif |
1171 | ||
4aa7a7f5 JJ |
1172 | extern int target_stopped_data_address_p (struct target_ops *); |
1173 | ||
c906108c | 1174 | #ifndef target_stopped_data_address |
4aa7a7f5 JJ |
1175 | #define target_stopped_data_address(target, x) \ |
1176 | (*target.to_stopped_data_address) (target, x) | |
1177 | #else | |
1178 | /* Horrible hack to get around existing macros :-(. */ | |
1179 | #define target_stopped_data_address_p(CURRENT_TARGET) (1) | |
c906108c SS |
1180 | #endif |
1181 | ||
c906108c SS |
1182 | /* This will only be defined by a target that supports catching vfork events, |
1183 | such as HP-UX. | |
1184 | ||
1185 | On some targets (such as HP-UX 10.20 and earlier), resuming a newly vforked | |
1186 | child process after it has exec'd, causes the parent process to resume as | |
1187 | well. To prevent the parent from running spontaneously, such targets should | |
0d06e24b | 1188 | define this to a function that prevents that from happening. */ |
c906108c SS |
1189 | #if !defined(ENSURE_VFORKING_PARENT_REMAINS_STOPPED) |
1190 | #define ENSURE_VFORKING_PARENT_REMAINS_STOPPED(PID) (0) | |
1191 | #endif | |
1192 | ||
1193 | /* This will only be defined by a target that supports catching vfork events, | |
1194 | such as HP-UX. | |
1195 | ||
1196 | On some targets (such as HP-UX 10.20 and earlier), a newly vforked child | |
1197 | process must be resumed when it delivers its exec event, before the parent | |
0d06e24b JM |
1198 | vfork event will be delivered to us. */ |
1199 | ||
c906108c SS |
1200 | #if !defined(RESUME_EXECD_VFORKING_CHILD_TO_GET_PARENT_VFORK) |
1201 | #define RESUME_EXECD_VFORKING_CHILD_TO_GET_PARENT_VFORK() (0) | |
1202 | #endif | |
1203 | ||
1204 | /* Routines for maintenance of the target structures... | |
1205 | ||
1206 | add_target: Add a target to the list of all possible targets. | |
1207 | ||
1208 | push_target: Make this target the top of the stack of currently used | |
c5aa993b JM |
1209 | targets, within its particular stratum of the stack. Result |
1210 | is 0 if now atop the stack, nonzero if not on top (maybe | |
1211 | should warn user). | |
c906108c SS |
1212 | |
1213 | unpush_target: Remove this from the stack of currently used targets, | |
c5aa993b JM |
1214 | no matter where it is on the list. Returns 0 if no |
1215 | change, 1 if removed from stack. | |
c906108c | 1216 | |
c5aa993b | 1217 | pop_target: Remove the top thing on the stack of current targets. */ |
c906108c | 1218 | |
a14ed312 | 1219 | extern void add_target (struct target_ops *); |
c906108c | 1220 | |
a14ed312 | 1221 | extern int push_target (struct target_ops *); |
c906108c | 1222 | |
a14ed312 | 1223 | extern int unpush_target (struct target_ops *); |
c906108c | 1224 | |
fd79ecee DJ |
1225 | extern void target_pre_inferior (int); |
1226 | ||
a14ed312 | 1227 | extern void target_preopen (int); |
c906108c | 1228 | |
a14ed312 | 1229 | extern void pop_target (void); |
c906108c | 1230 | |
9e35dae4 DJ |
1231 | extern CORE_ADDR target_translate_tls_address (struct objfile *objfile, |
1232 | CORE_ADDR offset); | |
1233 | ||
52bb452f DJ |
1234 | /* Mark a pushed target as running or exited, for targets which do not |
1235 | automatically pop when not active. */ | |
1236 | ||
1237 | void target_mark_running (struct target_ops *); | |
1238 | ||
1239 | void target_mark_exited (struct target_ops *); | |
1240 | ||
c906108c SS |
1241 | /* Struct section_table maps address ranges to file sections. It is |
1242 | mostly used with BFD files, but can be used without (e.g. for handling | |
1243 | raw disks, or files not in formats handled by BFD). */ | |
1244 | ||
c5aa993b JM |
1245 | struct section_table |
1246 | { | |
1247 | CORE_ADDR addr; /* Lowest address in section */ | |
1248 | CORE_ADDR endaddr; /* 1+highest address in section */ | |
c906108c | 1249 | |
7be0c536 | 1250 | struct bfd_section *the_bfd_section; |
c906108c | 1251 | |
c5aa993b JM |
1252 | bfd *bfd; /* BFD file pointer */ |
1253 | }; | |
c906108c | 1254 | |
8db32d44 AC |
1255 | /* Return the "section" containing the specified address. */ |
1256 | struct section_table *target_section_by_addr (struct target_ops *target, | |
1257 | CORE_ADDR addr); | |
1258 | ||
1259 | ||
c906108c SS |
1260 | /* From mem-break.c */ |
1261 | ||
8181d85f | 1262 | extern int memory_remove_breakpoint (struct bp_target_info *); |
c906108c | 1263 | |
8181d85f | 1264 | extern int memory_insert_breakpoint (struct bp_target_info *); |
c906108c | 1265 | |
8181d85f | 1266 | extern int default_memory_remove_breakpoint (struct bp_target_info *); |
917317f4 | 1267 | |
8181d85f | 1268 | extern int default_memory_insert_breakpoint (struct bp_target_info *); |
917317f4 | 1269 | |
c906108c SS |
1270 | |
1271 | /* From target.c */ | |
1272 | ||
a14ed312 | 1273 | extern void initialize_targets (void); |
c906108c | 1274 | |
a14ed312 | 1275 | extern void noprocess (void); |
c906108c | 1276 | |
a14ed312 | 1277 | extern void find_default_attach (char *, int); |
c906108c | 1278 | |
c27cda74 | 1279 | extern void find_default_create_inferior (char *, char *, char **, int); |
c906108c | 1280 | |
a14ed312 | 1281 | extern struct target_ops *find_run_target (void); |
7a292a7a | 1282 | |
a14ed312 | 1283 | extern struct target_ops *find_core_target (void); |
6426a772 | 1284 | |
a14ed312 | 1285 | extern struct target_ops *find_target_beneath (struct target_ops *); |
ed9a39eb | 1286 | |
570b8f7c AC |
1287 | extern int target_resize_to_sections (struct target_ops *target, |
1288 | int num_added); | |
07cd4b97 JB |
1289 | |
1290 | extern void remove_target_sections (bfd *abfd); | |
1291 | ||
c906108c SS |
1292 | \f |
1293 | /* Stuff that should be shared among the various remote targets. */ | |
1294 | ||
1295 | /* Debugging level. 0 is off, and non-zero values mean to print some debug | |
1296 | information (higher values, more information). */ | |
1297 | extern int remote_debug; | |
1298 | ||
1299 | /* Speed in bits per second, or -1 which means don't mess with the speed. */ | |
1300 | extern int baud_rate; | |
1301 | /* Timeout limit for response from target. */ | |
1302 | extern int remote_timeout; | |
1303 | ||
c906108c SS |
1304 | \f |
1305 | /* Functions for helping to write a native target. */ | |
1306 | ||
1307 | /* This is for native targets which use a unix/POSIX-style waitstatus. */ | |
a14ed312 | 1308 | extern void store_waitstatus (struct target_waitstatus *, int); |
c906108c | 1309 | |
c2d11a7d | 1310 | /* Predicate to target_signal_to_host(). Return non-zero if the enum |
0d06e24b | 1311 | targ_signal SIGNO has an equivalent ``host'' representation. */ |
c2d11a7d JM |
1312 | /* FIXME: cagney/1999-11-22: The name below was chosen in preference |
1313 | to the shorter target_signal_p() because it is far less ambigious. | |
1314 | In this context ``target_signal'' refers to GDB's internal | |
1315 | representation of the target's set of signals while ``host signal'' | |
0d06e24b JM |
1316 | refers to the target operating system's signal. Confused? */ |
1317 | ||
c2d11a7d JM |
1318 | extern int target_signal_to_host_p (enum target_signal signo); |
1319 | ||
1320 | /* Convert between host signal numbers and enum target_signal's. | |
1321 | target_signal_to_host() returns 0 and prints a warning() on GDB's | |
0d06e24b | 1322 | console if SIGNO has no equivalent host representation. */ |
c2d11a7d JM |
1323 | /* FIXME: cagney/1999-11-22: Here ``host'' is used incorrectly, it is |
1324 | refering to the target operating system's signal numbering. | |
1325 | Similarly, ``enum target_signal'' is named incorrectly, ``enum | |
1326 | gdb_signal'' would probably be better as it is refering to GDB's | |
0d06e24b JM |
1327 | internal representation of a target operating system's signal. */ |
1328 | ||
a14ed312 KB |
1329 | extern enum target_signal target_signal_from_host (int); |
1330 | extern int target_signal_to_host (enum target_signal); | |
c906108c SS |
1331 | |
1332 | /* Convert from a number used in a GDB command to an enum target_signal. */ | |
a14ed312 | 1333 | extern enum target_signal target_signal_from_command (int); |
c906108c SS |
1334 | |
1335 | /* Any target can call this to switch to remote protocol (in remote.c). */ | |
a14ed312 | 1336 | extern void push_remote_target (char *name, int from_tty); |
c906108c SS |
1337 | \f |
1338 | /* Imported from machine dependent code */ | |
1339 | ||
c906108c | 1340 | /* Blank target vector entries are initialized to target_ignore. */ |
a14ed312 | 1341 | void target_ignore (void); |
c906108c | 1342 | |
1df84f13 | 1343 | extern struct target_ops deprecated_child_ops; |
5ac10fd1 | 1344 | |
c5aa993b | 1345 | #endif /* !defined (TARGET_H) */ |