* TODO: List known problems with TUI.
[deliverable/binutils-gdb.git] / gdb / target.h
CommitLineData
c906108c 1/* Interface between GDB and target environments, including files and processes
b6ba6518
KB
2 Copyright 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
3 2000, 2001 Free Software Foundation, Inc.
c906108c
SS
4 Contributed by Cygnus Support. Written by John Gilmore.
5
c5aa993b 6 This file is part of GDB.
c906108c 7
c5aa993b
JM
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
c906108c 12
c5aa993b
JM
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
c906108c 17
c5aa993b
JM
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
c906108c
SS
22
23#if !defined (TARGET_H)
24#define TARGET_H
25
26/* This include file defines the interface between the main part
27 of the debugger, and the part which is target-specific, or
28 specific to the communications interface between us and the
29 target.
30
31 A TARGET is an interface between the debugger and a particular
32 kind of file or process. Targets can be STACKED in STRATA,
33 so that more than one target can potentially respond to a request.
34 In particular, memory accesses will walk down the stack of targets
35 until they find a target that is interested in handling that particular
36 address. STRATA are artificial boundaries on the stack, within
37 which particular kinds of targets live. Strata exist so that
38 people don't get confused by pushing e.g. a process target and then
39 a file target, and wondering why they can't see the current values
40 of variables any more (the file target is handling them and they
41 never get to the process target). So when you push a file target,
42 it goes into the file stratum, which is always below the process
43 stratum. */
44
45#include "bfd.h"
46#include "symtab.h"
4930751a 47#include "dcache.h"
29e57380 48#include "memattr.h"
c906108c 49
c5aa993b
JM
50enum strata
51 {
52 dummy_stratum, /* The lowest of the low */
53 file_stratum, /* Executable files, etc */
54 core_stratum, /* Core dump files */
55 download_stratum, /* Downloading of remote targets */
d4f3574e
SS
56 process_stratum, /* Executing processes */
57 thread_stratum /* Executing threads */
c5aa993b 58 };
c906108c 59
c5aa993b
JM
60enum thread_control_capabilities
61 {
0d06e24b
JM
62 tc_none = 0, /* Default: can't control thread execution. */
63 tc_schedlock = 1, /* Can lock the thread scheduler. */
64 tc_switch = 2 /* Can switch the running thread on demand. */
c5aa993b 65 };
c906108c
SS
66
67/* Stuff for target_wait. */
68
69/* Generally, what has the program done? */
c5aa993b
JM
70enum target_waitkind
71 {
72 /* The program has exited. The exit status is in value.integer. */
73 TARGET_WAITKIND_EXITED,
c906108c 74
0d06e24b
JM
75 /* The program has stopped with a signal. Which signal is in
76 value.sig. */
c5aa993b 77 TARGET_WAITKIND_STOPPED,
c906108c 78
c5aa993b
JM
79 /* The program has terminated with a signal. Which signal is in
80 value.sig. */
81 TARGET_WAITKIND_SIGNALLED,
c906108c 82
c5aa993b
JM
83 /* The program is letting us know that it dynamically loaded something
84 (e.g. it called load(2) on AIX). */
85 TARGET_WAITKIND_LOADED,
c906108c 86
0d06e24b
JM
87 /* The program has forked. A "related" process' ID is in
88 value.related_pid. I.e., if the child forks, value.related_pid
89 is the parent's ID. */
90
c5aa993b 91 TARGET_WAITKIND_FORKED,
c906108c 92
0d06e24b
JM
93 /* The program has vforked. A "related" process's ID is in
94 value.related_pid. */
95
c5aa993b 96 TARGET_WAITKIND_VFORKED,
c906108c 97
0d06e24b
JM
98 /* The program has exec'ed a new executable file. The new file's
99 pathname is pointed to by value.execd_pathname. */
100
c5aa993b 101 TARGET_WAITKIND_EXECD,
c906108c 102
0d06e24b
JM
103 /* The program has entered or returned from a system call. On
104 HP-UX, this is used in the hardware watchpoint implementation.
105 The syscall's unique integer ID number is in value.syscall_id */
106
c5aa993b
JM
107 TARGET_WAITKIND_SYSCALL_ENTRY,
108 TARGET_WAITKIND_SYSCALL_RETURN,
c906108c 109
c5aa993b
JM
110 /* Nothing happened, but we stopped anyway. This perhaps should be handled
111 within target_wait, but I'm not sure target_wait should be resuming the
112 inferior. */
c4093a6a
JM
113 TARGET_WAITKIND_SPURIOUS,
114
115 /* This is used for target async and extended-async
116 only. Remote_async_wait() returns this when there is an event
117 on the inferior, but the rest of the world is not interested in
118 it. The inferior has not stopped, but has just sent some output
119 to the console, for instance. In this case, we want to go back
120 to the event loop and wait there for another event from the
121 inferior, rather than being stuck in the remote_async_wait()
122 function. This way the event loop is responsive to other events,
0d06e24b 123 like for instance the user typing. */
c4093a6a 124 TARGET_WAITKIND_IGNORE
c906108c
SS
125 };
126
127/* The numbering of these signals is chosen to match traditional unix
128 signals (insofar as various unices use the same numbers, anyway).
129 It is also the numbering of the GDB remote protocol. Other remote
130 protocols, if they use a different numbering, should make sure to
cd0fc7c3 131 translate appropriately.
c906108c 132
cd0fc7c3
SS
133 Since these numbers have actually made it out into other software
134 (stubs, etc.), you mustn't disturb the assigned numbering. If you
135 need to add new signals here, add them to the end of the explicitly
136 numbered signals.
137
138 This is based strongly on Unix/POSIX signals for several reasons:
c906108c
SS
139 (1) This set of signals represents a widely-accepted attempt to
140 represent events of this sort in a portable fashion, (2) we want a
141 signal to make it from wait to child_wait to the user intact, (3) many
142 remote protocols use a similar encoding. However, it is
143 recognized that this set of signals has limitations (such as not
144 distinguishing between various kinds of SIGSEGV, or not
145 distinguishing hitting a breakpoint from finishing a single step).
146 So in the future we may get around this either by adding additional
147 signals for breakpoint, single-step, etc., or by adding signal
148 codes; the latter seems more in the spirit of what BSD, System V,
149 etc. are doing to address these issues. */
150
151/* For an explanation of what each signal means, see
152 target_signal_to_string. */
153
c5aa993b
JM
154enum target_signal
155 {
156 /* Used some places (e.g. stop_signal) to record the concept that
157 there is no signal. */
158 TARGET_SIGNAL_0 = 0,
159 TARGET_SIGNAL_FIRST = 0,
160 TARGET_SIGNAL_HUP = 1,
161 TARGET_SIGNAL_INT = 2,
162 TARGET_SIGNAL_QUIT = 3,
163 TARGET_SIGNAL_ILL = 4,
164 TARGET_SIGNAL_TRAP = 5,
165 TARGET_SIGNAL_ABRT = 6,
166 TARGET_SIGNAL_EMT = 7,
167 TARGET_SIGNAL_FPE = 8,
168 TARGET_SIGNAL_KILL = 9,
169 TARGET_SIGNAL_BUS = 10,
170 TARGET_SIGNAL_SEGV = 11,
171 TARGET_SIGNAL_SYS = 12,
172 TARGET_SIGNAL_PIPE = 13,
173 TARGET_SIGNAL_ALRM = 14,
174 TARGET_SIGNAL_TERM = 15,
175 TARGET_SIGNAL_URG = 16,
176 TARGET_SIGNAL_STOP = 17,
177 TARGET_SIGNAL_TSTP = 18,
178 TARGET_SIGNAL_CONT = 19,
179 TARGET_SIGNAL_CHLD = 20,
180 TARGET_SIGNAL_TTIN = 21,
181 TARGET_SIGNAL_TTOU = 22,
182 TARGET_SIGNAL_IO = 23,
183 TARGET_SIGNAL_XCPU = 24,
184 TARGET_SIGNAL_XFSZ = 25,
185 TARGET_SIGNAL_VTALRM = 26,
186 TARGET_SIGNAL_PROF = 27,
187 TARGET_SIGNAL_WINCH = 28,
188 TARGET_SIGNAL_LOST = 29,
189 TARGET_SIGNAL_USR1 = 30,
190 TARGET_SIGNAL_USR2 = 31,
191 TARGET_SIGNAL_PWR = 32,
192 /* Similar to SIGIO. Perhaps they should have the same number. */
193 TARGET_SIGNAL_POLL = 33,
194 TARGET_SIGNAL_WIND = 34,
195 TARGET_SIGNAL_PHONE = 35,
196 TARGET_SIGNAL_WAITING = 36,
197 TARGET_SIGNAL_LWP = 37,
198 TARGET_SIGNAL_DANGER = 38,
199 TARGET_SIGNAL_GRANT = 39,
200 TARGET_SIGNAL_RETRACT = 40,
201 TARGET_SIGNAL_MSG = 41,
202 TARGET_SIGNAL_SOUND = 42,
203 TARGET_SIGNAL_SAK = 43,
204 TARGET_SIGNAL_PRIO = 44,
205 TARGET_SIGNAL_REALTIME_33 = 45,
206 TARGET_SIGNAL_REALTIME_34 = 46,
207 TARGET_SIGNAL_REALTIME_35 = 47,
208 TARGET_SIGNAL_REALTIME_36 = 48,
209 TARGET_SIGNAL_REALTIME_37 = 49,
210 TARGET_SIGNAL_REALTIME_38 = 50,
211 TARGET_SIGNAL_REALTIME_39 = 51,
212 TARGET_SIGNAL_REALTIME_40 = 52,
213 TARGET_SIGNAL_REALTIME_41 = 53,
214 TARGET_SIGNAL_REALTIME_42 = 54,
215 TARGET_SIGNAL_REALTIME_43 = 55,
216 TARGET_SIGNAL_REALTIME_44 = 56,
217 TARGET_SIGNAL_REALTIME_45 = 57,
218 TARGET_SIGNAL_REALTIME_46 = 58,
219 TARGET_SIGNAL_REALTIME_47 = 59,
220 TARGET_SIGNAL_REALTIME_48 = 60,
221 TARGET_SIGNAL_REALTIME_49 = 61,
222 TARGET_SIGNAL_REALTIME_50 = 62,
223 TARGET_SIGNAL_REALTIME_51 = 63,
224 TARGET_SIGNAL_REALTIME_52 = 64,
225 TARGET_SIGNAL_REALTIME_53 = 65,
226 TARGET_SIGNAL_REALTIME_54 = 66,
227 TARGET_SIGNAL_REALTIME_55 = 67,
228 TARGET_SIGNAL_REALTIME_56 = 68,
229 TARGET_SIGNAL_REALTIME_57 = 69,
230 TARGET_SIGNAL_REALTIME_58 = 70,
231 TARGET_SIGNAL_REALTIME_59 = 71,
232 TARGET_SIGNAL_REALTIME_60 = 72,
233 TARGET_SIGNAL_REALTIME_61 = 73,
234 TARGET_SIGNAL_REALTIME_62 = 74,
235 TARGET_SIGNAL_REALTIME_63 = 75,
236
237 /* Used internally by Solaris threads. See signal(5) on Solaris. */
238 TARGET_SIGNAL_CANCEL = 76,
cd0fc7c3 239
d4f3574e
SS
240 /* Yes, this pains me, too. But LynxOS didn't have SIG32, and now
241 Linux does, and we can't disturb the numbering, since it's part
242 of the protocol. Note that in some GDB's TARGET_SIGNAL_REALTIME_32
243 is number 76. */
244 TARGET_SIGNAL_REALTIME_32,
d57fc352
PS
245 /* Yet another pain, IRIX 6 has SIG64. */
246 TARGET_SIGNAL_REALTIME_64,
d4f3574e 247
c906108c 248#if defined(MACH) || defined(__MACH__)
c5aa993b
JM
249 /* Mach exceptions */
250 TARGET_EXC_BAD_ACCESS,
251 TARGET_EXC_BAD_INSTRUCTION,
252 TARGET_EXC_ARITHMETIC,
253 TARGET_EXC_EMULATION,
254 TARGET_EXC_SOFTWARE,
255 TARGET_EXC_BREAKPOINT,
c906108c 256#endif
c5aa993b 257 TARGET_SIGNAL_INFO,
c906108c 258
c5aa993b
JM
259 /* Some signal we don't know about. */
260 TARGET_SIGNAL_UNKNOWN,
c906108c 261
c5aa993b
JM
262 /* Use whatever signal we use when one is not specifically specified
263 (for passing to proceed and so on). */
264 TARGET_SIGNAL_DEFAULT,
c906108c 265
c5aa993b
JM
266 /* Last and unused enum value, for sizing arrays, etc. */
267 TARGET_SIGNAL_LAST
268 };
c906108c 269
c5aa993b
JM
270struct target_waitstatus
271 {
272 enum target_waitkind kind;
273
274 /* Forked child pid, execd pathname, exit status or signal number. */
275 union
276 {
277 int integer;
278 enum target_signal sig;
279 int related_pid;
280 char *execd_pathname;
281 int syscall_id;
282 }
283 value;
284 };
c906108c 285
2acceee2 286/* Possible types of events that the inferior handler will have to
0d06e24b 287 deal with. */
2acceee2
JM
288enum inferior_event_type
289 {
0d06e24b 290 /* There is a request to quit the inferior, abandon it. */
2acceee2
JM
291 INF_QUIT_REQ,
292 /* Process a normal inferior event which will result in target_wait
0d06e24b 293 being called. */
2acceee2 294 INF_REG_EVENT,
0d06e24b 295 /* Deal with an error on the inferior. */
2acceee2 296 INF_ERROR,
0d06e24b 297 /* We are called because a timer went off. */
2acceee2 298 INF_TIMER,
0d06e24b 299 /* We are called to do stuff after the inferior stops. */
c2d11a7d
JM
300 INF_EXEC_COMPLETE,
301 /* We are called to do some stuff after the inferior stops, but we
302 are expected to reenter the proceed() and
303 handle_inferior_event() functions. This is used only in case of
0d06e24b 304 'step n' like commands. */
c2d11a7d 305 INF_EXEC_CONTINUE
2acceee2
JM
306 };
307
c906108c 308/* Return the string for a signal. */
a14ed312 309extern char *target_signal_to_string (enum target_signal);
c906108c
SS
310
311/* Return the name (SIGHUP, etc.) for a signal. */
a14ed312 312extern char *target_signal_to_name (enum target_signal);
c906108c
SS
313
314/* Given a name (SIGHUP, etc.), return its signal. */
a14ed312 315enum target_signal target_signal_from_name (char *);
c906108c 316\f
c5aa993b 317
c906108c
SS
318/* If certain kinds of activity happen, target_wait should perform
319 callbacks. */
320/* Right now we just call (*TARGET_ACTIVITY_FUNCTION) if I/O is possible
0d06e24b 321 on TARGET_ACTIVITY_FD. */
c906108c
SS
322extern int target_activity_fd;
323/* Returns zero to leave the inferior alone, one to interrupt it. */
507f3c78 324extern int (*target_activity_function) (void);
c906108c 325\f
0d06e24b
JM
326struct thread_info; /* fwd decl for parameter list below: */
327
c906108c 328struct target_ops
c5aa993b
JM
329 {
330 char *to_shortname; /* Name this target type */
331 char *to_longname; /* Name for printing */
332 char *to_doc; /* Documentation. Does not include trailing
c906108c 333 newline, and starts with a one-line descrip-
0d06e24b 334 tion (probably similar to to_longname). */
507f3c78
KB
335 void (*to_open) (char *, int);
336 void (*to_close) (int);
337 void (*to_attach) (char *, int);
338 void (*to_post_attach) (int);
339 void (*to_require_attach) (char *, int);
340 void (*to_detach) (char *, int);
341 void (*to_require_detach) (int, char *, int);
342 void (*to_resume) (int, int, enum target_signal);
343 int (*to_wait) (int, struct target_waitstatus *);
344 void (*to_post_wait) (int, int);
345 void (*to_fetch_registers) (int);
346 void (*to_store_registers) (int);
347 void (*to_prepare_to_store) (void);
c5aa993b
JM
348
349 /* Transfer LEN bytes of memory between GDB address MYADDR and
350 target address MEMADDR. If WRITE, transfer them to the target, else
351 transfer them from the target. TARGET is the target from which we
352 get this function.
353
354 Return value, N, is one of the following:
355
356 0 means that we can't handle this. If errno has been set, it is the
357 error which prevented us from doing it (FIXME: What about bfd_error?).
358
359 positive (call it N) means that we have transferred N bytes
360 starting at MEMADDR. We might be able to handle more bytes
361 beyond this length, but no promises.
362
363 negative (call its absolute value N) means that we cannot
364 transfer right at MEMADDR, but we could transfer at least
365 something at MEMADDR + N. */
366
507f3c78 367 int (*to_xfer_memory) (CORE_ADDR memaddr, char *myaddr,
29e57380
C
368 int len, int write,
369 struct mem_attrib *attrib,
370 struct target_ops *target);
c906108c
SS
371
372#if 0
c5aa993b 373 /* Enable this after 4.12. */
c906108c 374
c5aa993b
JM
375 /* Search target memory. Start at STARTADDR and take LEN bytes of
376 target memory, and them with MASK, and compare to DATA. If they
377 match, set *ADDR_FOUND to the address we found it at, store the data
378 we found at LEN bytes starting at DATA_FOUND, and return. If
379 not, add INCREMENT to the search address and keep trying until
380 the search address is outside of the range [LORANGE,HIRANGE).
c906108c 381
0d06e24b
JM
382 If we don't find anything, set *ADDR_FOUND to (CORE_ADDR)0 and
383 return. */
384
507f3c78
KB
385 void (*to_search) (int len, char *data, char *mask,
386 CORE_ADDR startaddr, int increment,
387 CORE_ADDR lorange, CORE_ADDR hirange,
388 CORE_ADDR * addr_found, char *data_found);
c906108c
SS
389
390#define target_search(len, data, mask, startaddr, increment, lorange, hirange, addr_found, data_found) \
0d06e24b
JM
391 (*current_target.to_search) (len, data, mask, startaddr, increment, \
392 lorange, hirange, addr_found, data_found)
c5aa993b
JM
393#endif /* 0 */
394
507f3c78
KB
395 void (*to_files_info) (struct target_ops *);
396 int (*to_insert_breakpoint) (CORE_ADDR, char *);
397 int (*to_remove_breakpoint) (CORE_ADDR, char *);
398 void (*to_terminal_init) (void);
399 void (*to_terminal_inferior) (void);
400 void (*to_terminal_ours_for_output) (void);
401 void (*to_terminal_ours) (void);
402 void (*to_terminal_info) (char *, int);
403 void (*to_kill) (void);
404 void (*to_load) (char *, int);
405 int (*to_lookup_symbol) (char *, CORE_ADDR *);
406 void (*to_create_inferior) (char *, char *, char **);
407 void (*to_post_startup_inferior) (int);
408 void (*to_acknowledge_created_inferior) (int);
409 void (*to_clone_and_follow_inferior) (int, int *);
410 void (*to_post_follow_inferior_by_clone) (void);
411 int (*to_insert_fork_catchpoint) (int);
412 int (*to_remove_fork_catchpoint) (int);
413 int (*to_insert_vfork_catchpoint) (int);
414 int (*to_remove_vfork_catchpoint) (int);
415 int (*to_has_forked) (int, int *);
416 int (*to_has_vforked) (int, int *);
417 int (*to_can_follow_vfork_prior_to_exec) (void);
418 void (*to_post_follow_vfork) (int, int, int, int);
419 int (*to_insert_exec_catchpoint) (int);
420 int (*to_remove_exec_catchpoint) (int);
421 int (*to_has_execd) (int, char **);
422 int (*to_reported_exec_events_per_exec_call) (void);
423 int (*to_has_syscall_event) (int, enum target_waitkind *, int *);
424 int (*to_has_exited) (int, int, int *);
425 void (*to_mourn_inferior) (void);
426 int (*to_can_run) (void);
427 void (*to_notice_signals) (int pid);
428 int (*to_thread_alive) (int pid);
429 void (*to_find_new_threads) (void);
430 char *(*to_pid_to_str) (int);
431 char *(*to_extra_thread_info) (struct thread_info *);
432 void (*to_stop) (void);
433 int (*to_query) (int /*char */ , char *, char *, int *);
d9fcf2fb 434 void (*to_rcmd) (char *command, struct ui_file *output);
507f3c78
KB
435 struct symtab_and_line *(*to_enable_exception_callback) (enum
436 exception_event_kind,
437 int);
438 struct exception_event_record *(*to_get_current_exception_event) (void);
439 char *(*to_pid_to_exec_file) (int pid);
440 char *(*to_core_file_to_sym_file) (char *);
c5aa993b
JM
441 enum strata to_stratum;
442 struct target_ops
443 *DONT_USE; /* formerly to_next */
444 int to_has_all_memory;
445 int to_has_memory;
446 int to_has_stack;
447 int to_has_registers;
448 int to_has_execution;
449 int to_has_thread_control; /* control thread execution */
c5aa993b
JM
450 struct section_table
451 *to_sections;
452 struct section_table
453 *to_sections_end;
6426a772
JM
454 /* ASYNC target controls */
455 int (*to_can_async_p) (void);
456 int (*to_is_async_p) (void);
0d06e24b
JM
457 void (*to_async) (void (*cb) (enum inferior_event_type, void *context),
458 void *context);
ed9a39eb 459 int to_async_mask_value;
c5aa993b 460 int to_magic;
0d06e24b
JM
461 /* Need sub-structure for target machine related rather than comm related?
462 */
c5aa993b 463 };
c906108c
SS
464
465/* Magic number for checking ops size. If a struct doesn't end with this
466 number, somebody changed the declaration but didn't change all the
467 places that initialize one. */
468
469#define OPS_MAGIC 3840
470
471/* The ops structure for our "current" target process. This should
472 never be NULL. If there is no target, it points to the dummy_target. */
473
c5aa993b 474extern struct target_ops current_target;
c906108c
SS
475
476/* An item on the target stack. */
477
478struct target_stack_item
c5aa993b
JM
479 {
480 struct target_stack_item *next;
481 struct target_ops *target_ops;
482 };
c906108c
SS
483
484/* The target stack. */
485
486extern struct target_stack_item *target_stack;
487
488/* Define easy words for doing these operations on our current target. */
489
490#define target_shortname (current_target.to_shortname)
491#define target_longname (current_target.to_longname)
492
493/* The open routine takes the rest of the parameters from the command,
494 and (if successful) pushes a new target onto the stack.
495 Targets should supply this routine, if only to provide an error message. */
0d06e24b 496
4930751a
C
497#define target_open(name, from_tty) \
498 do { \
499 dcache_invalidate (target_dcache); \
500 (*current_target.to_open) (name, from_tty); \
501 } while (0)
c906108c
SS
502
503/* Does whatever cleanup is required for a target that we are no longer
504 going to be calling. Argument says whether we are quitting gdb and
505 should not get hung in case of errors, or whether we want a clean
506 termination even if it takes a while. This routine is automatically
507 always called just before a routine is popped off the target stack.
508 Closing file descriptors and freeing memory are typical things it should
509 do. */
510
511#define target_close(quitting) \
0d06e24b 512 (*current_target.to_close) (quitting)
c906108c
SS
513
514/* Attaches to a process on the target side. Arguments are as passed
515 to the `attach' command by the user. This routine can be called
516 when the target is not on the target-stack, if the target_can_run
517 routine returns 1; in that case, it must push itself onto the stack.
518 Upon exit, the target should be ready for normal operations, and
519 should be ready to deliver the status of the process immediately
520 (without waiting) to an upcoming target_wait call. */
521
522#define target_attach(args, from_tty) \
0d06e24b 523 (*current_target.to_attach) (args, from_tty)
c906108c
SS
524
525/* The target_attach operation places a process under debugger control,
526 and stops the process.
527
528 This operation provides a target-specific hook that allows the
0d06e24b 529 necessary bookkeeping to be performed after an attach completes. */
c906108c 530#define target_post_attach(pid) \
0d06e24b 531 (*current_target.to_post_attach) (pid)
c906108c
SS
532
533/* Attaches to a process on the target side, if not already attached.
534 (If already attached, takes no action.)
535
536 This operation can be used to follow the child process of a fork.
537 On some targets, such child processes of an original inferior process
538 are automatically under debugger control, and thus do not require an
539 actual attach operation. */
540
541#define target_require_attach(args, from_tty) \
0d06e24b 542 (*current_target.to_require_attach) (args, from_tty)
c906108c
SS
543
544/* Takes a program previously attached to and detaches it.
545 The program may resume execution (some targets do, some don't) and will
546 no longer stop on signals, etc. We better not have left any breakpoints
547 in the program or it'll die when it hits one. ARGS is arguments
548 typed by the user (e.g. a signal to send the process). FROM_TTY
549 says whether to be verbose or not. */
550
a14ed312 551extern void target_detach (char *, int);
c906108c
SS
552
553/* Detaches from a process on the target side, if not already dettached.
554 (If already detached, takes no action.)
555
556 This operation can be used to follow the parent process of a fork.
557 On some targets, such child processes of an original inferior process
558 are automatically under debugger control, and thus do require an actual
559 detach operation.
560
561 PID is the process id of the child to detach from.
562 ARGS is arguments typed by the user (e.g. a signal to send the process).
563 FROM_TTY says whether to be verbose or not. */
564
0d06e24b
JM
565#define target_require_detach(pid, args, from_tty) \
566 (*current_target.to_require_detach) (pid, args, from_tty)
c906108c
SS
567
568/* Resume execution of the target process PID. STEP says whether to
569 single-step or to run free; SIGGNAL is the signal to be given to
570 the target, or TARGET_SIGNAL_0 for no signal. The caller may not
571 pass TARGET_SIGNAL_DEFAULT. */
572
4930751a
C
573#define target_resume(pid, step, siggnal) \
574 do { \
575 dcache_invalidate(target_dcache); \
576 (*current_target.to_resume) (pid, step, siggnal); \
577 } while (0)
c906108c
SS
578
579/* Wait for process pid to do something. Pid = -1 to wait for any pid
580 to do something. Return pid of child, or -1 in case of error;
581 store status through argument pointer STATUS. Note that it is
582 *not* OK to return_to_top_level out of target_wait without popping
583 the debugging target from the stack; GDB isn't prepared to get back
584 to the prompt with a debugging target but without the frame cache,
585 stop_pc, etc., set up. */
586
587#define target_wait(pid, status) \
0d06e24b 588 (*current_target.to_wait) (pid, status)
c906108c
SS
589
590/* The target_wait operation waits for a process event to occur, and
591 thereby stop the process.
592
593 On some targets, certain events may happen in sequences. gdb's
594 correct response to any single event of such a sequence may require
595 knowledge of what earlier events in the sequence have been seen.
596
597 This operation provides a target-specific hook that allows the
0d06e24b 598 necessary bookkeeping to be performed to track such sequences. */
c906108c
SS
599
600#define target_post_wait(pid, status) \
0d06e24b 601 (*current_target.to_post_wait) (pid, status)
c906108c 602
17dee195 603/* Fetch at least register REGNO, or all regs if regno == -1. No result. */
c906108c
SS
604
605#define target_fetch_registers(regno) \
0d06e24b 606 (*current_target.to_fetch_registers) (regno)
c906108c
SS
607
608/* Store at least register REGNO, or all regs if REGNO == -1.
609 It can store as many registers as it wants to, so target_prepare_to_store
610 must have been previously called. Calls error() if there are problems. */
611
612#define target_store_registers(regs) \
0d06e24b 613 (*current_target.to_store_registers) (regs)
c906108c
SS
614
615/* Get ready to modify the registers array. On machines which store
616 individual registers, this doesn't need to do anything. On machines
617 which store all the registers in one fell swoop, this makes sure
618 that REGISTERS contains all the registers from the program being
619 debugged. */
620
621#define target_prepare_to_store() \
0d06e24b 622 (*current_target.to_prepare_to_store) ()
c906108c 623
4930751a
C
624extern DCACHE *target_dcache;
625
29e57380
C
626extern int do_xfer_memory (CORE_ADDR memaddr, char *myaddr, int len, int write,
627 struct mem_attrib *attrib);
4930751a 628
a14ed312 629extern int target_read_string (CORE_ADDR, char **, int, int *);
c906108c 630
a14ed312 631extern int target_read_memory (CORE_ADDR memaddr, char *myaddr, int len);
c906108c 632
4930751a 633extern int target_write_memory (CORE_ADDR memaddr, char *myaddr, int len);
c906108c 634
29e57380
C
635extern int xfer_memory (CORE_ADDR, char *, int, int,
636 struct mem_attrib *, struct target_ops *);
c906108c 637
29e57380
C
638extern int child_xfer_memory (CORE_ADDR, char *, int, int,
639 struct mem_attrib *, struct target_ops *);
c906108c 640
917317f4
JM
641/* Make a single attempt at transfering LEN bytes. On a successful
642 transfer, the number of bytes actually transfered is returned and
643 ERR is set to 0. When a transfer fails, -1 is returned (the number
644 of bytes actually transfered is not defined) and ERR is set to a
0d06e24b 645 non-zero error indication. */
917317f4 646
ed9a39eb
JM
647extern int
648target_read_memory_partial (CORE_ADDR addr, char *buf, int len, int *err);
917317f4 649
ed9a39eb
JM
650extern int
651target_write_memory_partial (CORE_ADDR addr, char *buf, int len, int *err);
917317f4 652
a14ed312 653extern char *child_pid_to_exec_file (int);
c906108c 654
a14ed312 655extern char *child_core_file_to_sym_file (char *);
c906108c
SS
656
657#if defined(CHILD_POST_ATTACH)
a14ed312 658extern void child_post_attach (int);
c906108c
SS
659#endif
660
a14ed312 661extern void child_post_wait (int, int);
c906108c 662
a14ed312 663extern void child_post_startup_inferior (int);
c906108c 664
a14ed312 665extern void child_acknowledge_created_inferior (int);
c906108c 666
a14ed312 667extern void child_clone_and_follow_inferior (int, int *);
c906108c 668
a14ed312 669extern void child_post_follow_inferior_by_clone (void);
c906108c 670
a14ed312 671extern int child_insert_fork_catchpoint (int);
c906108c 672
a14ed312 673extern int child_remove_fork_catchpoint (int);
c906108c 674
a14ed312 675extern int child_insert_vfork_catchpoint (int);
c906108c 676
a14ed312 677extern int child_remove_vfork_catchpoint (int);
c906108c 678
a14ed312 679extern int child_has_forked (int, int *);
c906108c 680
a14ed312 681extern int child_has_vforked (int, int *);
c906108c 682
a14ed312 683extern void child_acknowledge_created_inferior (int);
c906108c 684
a14ed312 685extern int child_can_follow_vfork_prior_to_exec (void);
c906108c 686
a14ed312 687extern void child_post_follow_vfork (int, int, int, int);
c906108c 688
a14ed312 689extern int child_insert_exec_catchpoint (int);
c906108c 690
a14ed312 691extern int child_remove_exec_catchpoint (int);
c906108c 692
a14ed312 693extern int child_has_execd (int, char **);
c906108c 694
a14ed312 695extern int child_reported_exec_events_per_exec_call (void);
c906108c 696
a14ed312 697extern int child_has_syscall_event (int, enum target_waitkind *, int *);
c906108c 698
a14ed312 699extern int child_has_exited (int, int, int *);
c906108c 700
a14ed312 701extern int child_thread_alive (int);
c906108c
SS
702
703/* From exec.c */
704
a14ed312 705extern void print_section_info (struct target_ops *, bfd *);
c906108c
SS
706
707/* Print a line about the current target. */
708
709#define target_files_info() \
0d06e24b 710 (*current_target.to_files_info) (&current_target)
c906108c
SS
711
712/* Insert a breakpoint at address ADDR in the target machine.
713 SAVE is a pointer to memory allocated for saving the
714 target contents. It is guaranteed by the caller to be long enough
715 to save "sizeof BREAKPOINT" bytes. Result is 0 for success, or
716 an errno value. */
717
718#define target_insert_breakpoint(addr, save) \
0d06e24b 719 (*current_target.to_insert_breakpoint) (addr, save)
c906108c
SS
720
721/* Remove a breakpoint at address ADDR in the target machine.
722 SAVE is a pointer to the same save area
723 that was previously passed to target_insert_breakpoint.
724 Result is 0 for success, or an errno value. */
725
726#define target_remove_breakpoint(addr, save) \
0d06e24b 727 (*current_target.to_remove_breakpoint) (addr, save)
c906108c
SS
728
729/* Initialize the terminal settings we record for the inferior,
730 before we actually run the inferior. */
731
732#define target_terminal_init() \
0d06e24b 733 (*current_target.to_terminal_init) ()
c906108c
SS
734
735/* Put the inferior's terminal settings into effect.
736 This is preparation for starting or resuming the inferior. */
737
738#define target_terminal_inferior() \
0d06e24b 739 (*current_target.to_terminal_inferior) ()
c906108c
SS
740
741/* Put some of our terminal settings into effect,
742 enough to get proper results from our output,
743 but do not change into or out of RAW mode
744 so that no input is discarded.
745
746 After doing this, either terminal_ours or terminal_inferior
747 should be called to get back to a normal state of affairs. */
748
749#define target_terminal_ours_for_output() \
0d06e24b 750 (*current_target.to_terminal_ours_for_output) ()
c906108c
SS
751
752/* Put our terminal settings into effect.
753 First record the inferior's terminal settings
754 so they can be restored properly later. */
755
756#define target_terminal_ours() \
0d06e24b 757 (*current_target.to_terminal_ours) ()
c906108c
SS
758
759/* Print useful information about our terminal status, if such a thing
760 exists. */
761
762#define target_terminal_info(arg, from_tty) \
0d06e24b 763 (*current_target.to_terminal_info) (arg, from_tty)
c906108c
SS
764
765/* Kill the inferior process. Make it go away. */
766
767#define target_kill() \
0d06e24b 768 (*current_target.to_kill) ()
c906108c 769
0d06e24b
JM
770/* Load an executable file into the target process. This is expected
771 to not only bring new code into the target process, but also to
772 update GDB's symbol tables to match. */
c906108c 773
11cf8741 774extern void target_load (char *arg, int from_tty);
c906108c
SS
775
776/* Look up a symbol in the target's symbol table. NAME is the symbol
0d06e24b
JM
777 name. ADDRP is a CORE_ADDR * pointing to where the value of the
778 symbol should be returned. The result is 0 if successful, nonzero
779 if the symbol does not exist in the target environment. This
780 function should not call error() if communication with the target
781 is interrupted, since it is called from symbol reading, but should
782 return nonzero, possibly doing a complain(). */
c906108c 783
0d06e24b
JM
784#define target_lookup_symbol(name, addrp) \
785 (*current_target.to_lookup_symbol) (name, addrp)
c906108c
SS
786
787/* Start an inferior process and set inferior_pid to its pid.
788 EXEC_FILE is the file to run.
789 ALLARGS is a string containing the arguments to the program.
790 ENV is the environment vector to pass. Errors reported with error().
791 On VxWorks and various standalone systems, we ignore exec_file. */
c5aa993b 792
c906108c 793#define target_create_inferior(exec_file, args, env) \
0d06e24b 794 (*current_target.to_create_inferior) (exec_file, args, env)
c906108c
SS
795
796
797/* Some targets (such as ttrace-based HPUX) don't allow us to request
798 notification of inferior events such as fork and vork immediately
799 after the inferior is created. (This because of how gdb gets an
800 inferior created via invoking a shell to do it. In such a scenario,
801 if the shell init file has commands in it, the shell will fork and
802 exec for each of those commands, and we will see each such fork
803 event. Very bad.)
c5aa993b 804
0d06e24b
JM
805 Such targets will supply an appropriate definition for this function. */
806
c906108c 807#define target_post_startup_inferior(pid) \
0d06e24b 808 (*current_target.to_post_startup_inferior) (pid)
c906108c
SS
809
810/* On some targets, the sequence of starting up an inferior requires
0d06e24b
JM
811 some synchronization between gdb and the new inferior process, PID. */
812
c906108c 813#define target_acknowledge_created_inferior(pid) \
0d06e24b 814 (*current_target.to_acknowledge_created_inferior) (pid)
c906108c
SS
815
816/* An inferior process has been created via a fork() or similar
817 system call. This function will clone the debugger, then ensure
818 that CHILD_PID is attached to by that debugger.
819
820 FOLLOWED_CHILD is set TRUE on return *for the clone debugger only*,
821 and FALSE otherwise. (The original and clone debuggers can use this
822 to determine which they are, if need be.)
823
824 (This is not a terribly useful feature without a GUI to prevent
0d06e24b
JM
825 the two debuggers from competing for shell input.) */
826
c906108c 827#define target_clone_and_follow_inferior(child_pid,followed_child) \
0d06e24b 828 (*current_target.to_clone_and_follow_inferior) (child_pid, followed_child)
c906108c
SS
829
830/* This operation is intended to be used as the last in a sequence of
831 steps taken when following both parent and child of a fork. This
832 is used by a clone of the debugger, which will follow the child.
833
834 The original debugger has detached from this process, and the
835 clone has attached to it.
836
837 On some targets, this requires a bit of cleanup to make it work
0d06e24b
JM
838 correctly. */
839
c906108c 840#define target_post_follow_inferior_by_clone() \
0d06e24b
JM
841 (*current_target.to_post_follow_inferior_by_clone) ()
842
843/* On some targets, we can catch an inferior fork or vfork event when
844 it occurs. These functions insert/remove an already-created
845 catchpoint for such events. */
c906108c 846
c906108c 847#define target_insert_fork_catchpoint(pid) \
0d06e24b 848 (*current_target.to_insert_fork_catchpoint) (pid)
c906108c
SS
849
850#define target_remove_fork_catchpoint(pid) \
0d06e24b 851 (*current_target.to_remove_fork_catchpoint) (pid)
c906108c
SS
852
853#define target_insert_vfork_catchpoint(pid) \
0d06e24b 854 (*current_target.to_insert_vfork_catchpoint) (pid)
c906108c
SS
855
856#define target_remove_vfork_catchpoint(pid) \
0d06e24b 857 (*current_target.to_remove_vfork_catchpoint) (pid)
c906108c
SS
858
859/* Returns TRUE if PID has invoked the fork() system call. And,
860 also sets CHILD_PID to the process id of the other ("child")
0d06e24b
JM
861 inferior process that was created by that call. */
862
c906108c 863#define target_has_forked(pid,child_pid) \
0d06e24b
JM
864 (*current_target.to_has_forked) (pid,child_pid)
865
866/* Returns TRUE if PID has invoked the vfork() system call. And,
867 also sets CHILD_PID to the process id of the other ("child")
868 inferior process that was created by that call. */
c906108c 869
c906108c 870#define target_has_vforked(pid,child_pid) \
0d06e24b 871 (*current_target.to_has_vforked) (pid,child_pid)
c906108c
SS
872
873/* Some platforms (such as pre-10.20 HP-UX) don't allow us to do
874 anything to a vforked child before it subsequently calls exec().
875 On such platforms, we say that the debugger cannot "follow" the
876 child until it has vforked.
877
878 This function should be defined to return 1 by those targets
879 which can allow the debugger to immediately follow a vforked
0d06e24b
JM
880 child, and 0 if they cannot. */
881
c906108c 882#define target_can_follow_vfork_prior_to_exec() \
0d06e24b 883 (*current_target.to_can_follow_vfork_prior_to_exec) ()
c906108c
SS
884
885/* An inferior process has been created via a vfork() system call.
886 The debugger has followed the parent, the child, or both. The
887 process of setting up for that follow may have required some
888 target-specific trickery to track the sequence of reported events.
889 If so, this function should be defined by those targets that
890 require the debugger to perform cleanup or initialization after
0d06e24b
JM
891 the vfork follow. */
892
c906108c 893#define target_post_follow_vfork(parent_pid,followed_parent,child_pid,followed_child) \
0d06e24b 894 (*current_target.to_post_follow_vfork) (parent_pid,followed_parent,child_pid,followed_child)
c906108c
SS
895
896/* On some targets, we can catch an inferior exec event when it
0d06e24b
JM
897 occurs. These functions insert/remove an already-created
898 catchpoint for such events. */
899
c906108c 900#define target_insert_exec_catchpoint(pid) \
0d06e24b 901 (*current_target.to_insert_exec_catchpoint) (pid)
c5aa993b 902
c906108c 903#define target_remove_exec_catchpoint(pid) \
0d06e24b 904 (*current_target.to_remove_exec_catchpoint) (pid)
c906108c
SS
905
906/* Returns TRUE if PID has invoked a flavor of the exec() system call.
0d06e24b
JM
907 And, also sets EXECD_PATHNAME to the pathname of the executable
908 file that was passed to exec(), and is now being executed. */
909
c906108c 910#define target_has_execd(pid,execd_pathname) \
0d06e24b 911 (*current_target.to_has_execd) (pid,execd_pathname)
c906108c
SS
912
913/* Returns the number of exec events that are reported when a process
914 invokes a flavor of the exec() system call on this target, if exec
0d06e24b
JM
915 events are being reported. */
916
c906108c 917#define target_reported_exec_events_per_exec_call() \
0d06e24b 918 (*current_target.to_reported_exec_events_per_exec_call) ()
c906108c
SS
919
920/* Returns TRUE if PID has reported a syscall event. And, also sets
921 KIND to the appropriate TARGET_WAITKIND_, and sets SYSCALL_ID to
0d06e24b
JM
922 the unique integer ID of the syscall. */
923
c906108c 924#define target_has_syscall_event(pid,kind,syscall_id) \
0d06e24b 925 (*current_target.to_has_syscall_event) (pid,kind,syscall_id)
c906108c
SS
926
927/* Returns TRUE if PID has exited. And, also sets EXIT_STATUS to the
0d06e24b
JM
928 exit code of PID, if any. */
929
c906108c 930#define target_has_exited(pid,wait_status,exit_status) \
0d06e24b 931 (*current_target.to_has_exited) (pid,wait_status,exit_status)
c906108c
SS
932
933/* The debugger has completed a blocking wait() call. There is now
0d06e24b 934 some process event that must be processed. This function should
c906108c 935 be defined by those targets that require the debugger to perform
0d06e24b 936 cleanup or internal state changes in response to the process event. */
c906108c
SS
937
938/* The inferior process has died. Do what is right. */
939
940#define target_mourn_inferior() \
0d06e24b 941 (*current_target.to_mourn_inferior) ()
c906108c
SS
942
943/* Does target have enough data to do a run or attach command? */
944
945#define target_can_run(t) \
0d06e24b 946 ((t)->to_can_run) ()
c906108c
SS
947
948/* post process changes to signal handling in the inferior. */
949
950#define target_notice_signals(pid) \
0d06e24b 951 (*current_target.to_notice_signals) (pid)
c906108c
SS
952
953/* Check to see if a thread is still alive. */
954
955#define target_thread_alive(pid) \
0d06e24b 956 (*current_target.to_thread_alive) (pid)
c906108c 957
b83266a0
SS
958/* Query for new threads and add them to the thread list. */
959
960#define target_find_new_threads() \
0d06e24b 961 (*current_target.to_find_new_threads) (); \
b83266a0 962
0d06e24b
JM
963/* Make target stop in a continuable fashion. (For instance, under
964 Unix, this should act like SIGSTOP). This function is normally
965 used by GUIs to implement a stop button. */
c906108c
SS
966
967#define target_stop current_target.to_stop
968
969/* Queries the target side for some information. The first argument is a
970 letter specifying the type of the query, which is used to determine who
971 should process it. The second argument is a string that specifies which
972 information is desired and the third is a buffer that carries back the
973 response from the target side. The fourth parameter is the size of the
0d06e24b 974 output buffer supplied. */
c5aa993b 975
c906108c 976#define target_query(query_type, query, resp_buffer, bufffer_size) \
0d06e24b 977 (*current_target.to_query) (query_type, query, resp_buffer, bufffer_size)
c906108c 978
96baa820
JM
979/* Send the specified COMMAND to the target's monitor
980 (shell,interpreter) for execution. The result of the query is
0d06e24b 981 placed in OUTBUF. */
96baa820
JM
982
983#define target_rcmd(command, outbuf) \
984 (*current_target.to_rcmd) (command, outbuf)
985
986
c906108c
SS
987/* Get the symbol information for a breakpointable routine called when
988 an exception event occurs.
989 Intended mainly for C++, and for those
990 platforms/implementations where such a callback mechanism is available,
991 e.g. HP-UX with ANSI C++ (aCC). Some compilers (e.g. g++) support
0d06e24b 992 different mechanisms for debugging exceptions. */
c906108c
SS
993
994#define target_enable_exception_callback(kind, enable) \
0d06e24b 995 (*current_target.to_enable_exception_callback) (kind, enable)
c906108c 996
0d06e24b 997/* Get the current exception event kind -- throw or catch, etc. */
c5aa993b 998
c906108c 999#define target_get_current_exception_event() \
0d06e24b 1000 (*current_target.to_get_current_exception_event) ()
c906108c
SS
1001
1002/* Pointer to next target in the chain, e.g. a core file and an exec file. */
1003
1004#define target_next \
0d06e24b 1005 (current_target.to_next)
c906108c
SS
1006
1007/* Does the target include all of memory, or only part of it? This
1008 determines whether we look up the target chain for other parts of
1009 memory if this target can't satisfy a request. */
1010
1011#define target_has_all_memory \
0d06e24b 1012 (current_target.to_has_all_memory)
c906108c
SS
1013
1014/* Does the target include memory? (Dummy targets don't.) */
1015
1016#define target_has_memory \
0d06e24b 1017 (current_target.to_has_memory)
c906108c
SS
1018
1019/* Does the target have a stack? (Exec files don't, VxWorks doesn't, until
1020 we start a process.) */
c5aa993b 1021
c906108c 1022#define target_has_stack \
0d06e24b 1023 (current_target.to_has_stack)
c906108c
SS
1024
1025/* Does the target have registers? (Exec files don't.) */
1026
1027#define target_has_registers \
0d06e24b 1028 (current_target.to_has_registers)
c906108c
SS
1029
1030/* Does the target have execution? Can we make it jump (through
1031 hoops), or pop its stack a few times? FIXME: If this is to work that
1032 way, it needs to check whether an inferior actually exists.
1033 remote-udi.c and probably other targets can be the current target
1034 when the inferior doesn't actually exist at the moment. Right now
1035 this just tells us whether this target is *capable* of execution. */
1036
1037#define target_has_execution \
0d06e24b 1038 (current_target.to_has_execution)
c906108c
SS
1039
1040/* Can the target support the debugger control of thread execution?
1041 a) Can it lock the thread scheduler?
1042 b) Can it switch the currently running thread? */
1043
1044#define target_can_lock_scheduler \
0d06e24b 1045 (current_target.to_has_thread_control & tc_schedlock)
c906108c
SS
1046
1047#define target_can_switch_threads \
0d06e24b 1048 (current_target.to_has_thread_control & tc_switch)
c906108c 1049
6426a772
JM
1050/* Can the target support asynchronous execution? */
1051#define target_can_async_p() (current_target.to_can_async_p ())
1052
1053/* Is the target in asynchronous execution mode? */
1054#define target_is_async_p() (current_target.to_is_async_p())
1055
1056/* Put the target in async mode with the specified callback function. */
0d06e24b
JM
1057#define target_async(CALLBACK,CONTEXT) \
1058 (current_target.to_async((CALLBACK), (CONTEXT)))
43ff13b4 1059
ed9a39eb
JM
1060/* This is to be used ONLY within run_stack_dummy(). It
1061 provides a workaround, to have inferior function calls done in
1062 sychronous mode, even though the target is asynchronous. After
1063 target_async_mask(0) is called, calls to target_can_async_p() will
1064 return FALSE , so that target_resume() will not try to start the
1065 target asynchronously. After the inferior stops, we IMMEDIATELY
1066 restore the previous nature of the target, by calling
1067 target_async_mask(1). After that, target_can_async_p() will return
1068 TRUE. ANY OTHER USE OF THIS FEATURE IS DEPRECATED.
1069
1070 FIXME ezannoni 1999-12-13: we won't need this once we move
1071 the turning async on and off to the single execution commands,
0d06e24b 1072 from where it is done currently, in remote_resume(). */
ed9a39eb
JM
1073
1074#define target_async_mask_value \
0d06e24b 1075 (current_target.to_async_mask_value)
ed9a39eb
JM
1076
1077extern int target_async_mask (int mask);
1078
a14ed312 1079extern void target_link (char *, CORE_ADDR *);
c906108c
SS
1080
1081/* Converts a process id to a string. Usually, the string just contains
1082 `process xyz', but on some systems it may contain
1083 `process xyz thread abc'. */
1084
ed9a39eb
JM
1085#undef target_pid_to_str
1086#define target_pid_to_str(PID) current_target.to_pid_to_str (PID)
c906108c
SS
1087
1088#ifndef target_tid_to_str
1089#define target_tid_to_str(PID) \
0d06e24b 1090 target_pid_to_str (PID)
a14ed312 1091extern char *normal_pid_to_str (int pid);
c906108c 1092#endif
c5aa993b 1093
0d06e24b
JM
1094/* Return a short string describing extra information about PID,
1095 e.g. "sleeping", "runnable", "running on LWP 3". Null return value
1096 is okay. */
1097
1098#define target_extra_thread_info(TP) \
1099 (current_target.to_extra_thread_info (TP))
ed9a39eb 1100
11cf8741
JM
1101/*
1102 * New Objfile Event Hook:
1103 *
1104 * Sometimes a GDB component wants to get notified whenever a new
1105 * objfile is loaded. Mainly this is used by thread-debugging
1106 * implementations that need to know when symbols for the target
1107 * thread implemenation are available.
1108 *
1109 * The old way of doing this is to define a macro 'target_new_objfile'
1110 * that points to the function that you want to be called on every
1111 * objfile/shlib load.
1112 *
1113 * The new way is to grab the function pointer, 'target_new_objfile_hook',
1114 * and point it to the function that you want to be called on every
1115 * objfile/shlib load.
1116 *
1117 * If multiple clients are willing to be cooperative, they can each
1118 * save a pointer to the previous value of target_new_objfile_hook
1119 * before modifying it, and arrange for their function to call the
1120 * previous function in the chain. In that way, multiple clients
1121 * can receive this notification (something like with signal handlers).
1122 */
c906108c 1123
507f3c78 1124extern void (*target_new_objfile_hook) (struct objfile *);
c906108c
SS
1125
1126#ifndef target_pid_or_tid_to_str
1127#define target_pid_or_tid_to_str(ID) \
0d06e24b 1128 target_pid_to_str (ID)
c906108c
SS
1129#endif
1130
1131/* Attempts to find the pathname of the executable file
1132 that was run to create a specified process.
1133
1134 The process PID must be stopped when this operation is used.
c5aa993b 1135
c906108c
SS
1136 If the executable file cannot be determined, NULL is returned.
1137
1138 Else, a pointer to a character string containing the pathname
1139 is returned. This string should be copied into a buffer by
1140 the client if the string will not be immediately used, or if
0d06e24b 1141 it must persist. */
c906108c
SS
1142
1143#define target_pid_to_exec_file(pid) \
0d06e24b 1144 (current_target.to_pid_to_exec_file) (pid)
c906108c 1145
9d8a64cb 1146/* Hook to call target-dependent code after reading in a new symbol table. */
c906108c
SS
1147
1148#ifndef TARGET_SYMFILE_POSTREAD
1149#define TARGET_SYMFILE_POSTREAD(OBJFILE)
1150#endif
1151
9d8a64cb 1152/* Hook to call target dependent code just after inferior target process has
c906108c
SS
1153 started. */
1154
1155#ifndef TARGET_CREATE_INFERIOR_HOOK
1156#define TARGET_CREATE_INFERIOR_HOOK(PID)
1157#endif
1158
1159/* Hardware watchpoint interfaces. */
1160
1161/* Returns non-zero if we were stopped by a hardware watchpoint (memory read or
1162 write). */
1163
1164#ifndef STOPPED_BY_WATCHPOINT
1165#define STOPPED_BY_WATCHPOINT(w) 0
1166#endif
1167
1168/* HP-UX supplies these operations, which respectively disable and enable
1169 the memory page-protections that are used to implement hardware watchpoints
0d06e24b
JM
1170 on that platform. See wait_for_inferior's use of these. */
1171
c906108c
SS
1172#if !defined(TARGET_DISABLE_HW_WATCHPOINTS)
1173#define TARGET_DISABLE_HW_WATCHPOINTS(pid)
1174#endif
1175
1176#if !defined(TARGET_ENABLE_HW_WATCHPOINTS)
1177#define TARGET_ENABLE_HW_WATCHPOINTS(pid)
1178#endif
1179
0d06e24b 1180/* Provide defaults for systems that don't support hardware watchpoints. */
c906108c
SS
1181
1182#ifndef TARGET_HAS_HARDWARE_WATCHPOINTS
1183
1184/* Returns non-zero if we can set a hardware watchpoint of type TYPE. TYPE is
1185 one of bp_hardware_watchpoint, bp_read_watchpoint, bp_write_watchpoint, or
1186 bp_hardware_breakpoint. CNT is the number of such watchpoints used so far
1187 (including this one?). OTHERTYPE is who knows what... */
1188
1189#define TARGET_CAN_USE_HARDWARE_WATCHPOINT(TYPE,CNT,OTHERTYPE) 0
1190
1191#if !defined(TARGET_REGION_SIZE_OK_FOR_HW_WATCHPOINT)
1192#define TARGET_REGION_SIZE_OK_FOR_HW_WATCHPOINT(byte_count) \
6ab3a9c9 1193 ((LONGEST)(byte_count) <= REGISTER_SIZE)
c906108c
SS
1194#endif
1195
1196/* However, some addresses may not be profitable to use hardware to watch,
1197 or may be difficult to understand when the addressed object is out of
1198 scope, and hence should be unwatched. On some targets, this may have
1199 severe performance penalties, such that we might as well use regular
1200 watchpoints, and save (possibly precious) hardware watchpoints for other
0d06e24b
JM
1201 locations. */
1202
c906108c
SS
1203#if !defined(TARGET_RANGE_PROFITABLE_FOR_HW_WATCHPOINT)
1204#define TARGET_RANGE_PROFITABLE_FOR_HW_WATCHPOINT(pid,start,len) 0
1205#endif
1206
1207
1208/* Set/clear a hardware watchpoint starting at ADDR, for LEN bytes. TYPE is 0
1209 for write, 1 for read, and 2 for read/write accesses. Returns 0 for
1210 success, non-zero for failure. */
1211
1212#define target_remove_watchpoint(ADDR,LEN,TYPE) -1
1213#define target_insert_watchpoint(ADDR,LEN,TYPE) -1
1214
1215#endif /* TARGET_HAS_HARDWARE_WATCHPOINTS */
1216
1217#ifndef target_insert_hw_breakpoint
1218#define target_remove_hw_breakpoint(ADDR,SHADOW) -1
1219#define target_insert_hw_breakpoint(ADDR,SHADOW) -1
1220#endif
1221
1222#ifndef target_stopped_data_address
1223#define target_stopped_data_address() 0
1224#endif
1225
1226/* If defined, then we need to decr pc by this much after a hardware break-
1227 point. Presumably this overrides DECR_PC_AFTER_BREAK... */
1228
1229#ifndef DECR_PC_AFTER_HW_BREAK
1230#define DECR_PC_AFTER_HW_BREAK 0
1231#endif
1232
1233/* Sometimes gdb may pick up what appears to be a valid target address
1234 from a minimal symbol, but the value really means, essentially,
1235 "This is an index into a table which is populated when the inferior
0d06e24b
JM
1236 is run. Therefore, do not attempt to use this as a PC." */
1237
c906108c
SS
1238#if !defined(PC_REQUIRES_RUN_BEFORE_USE)
1239#define PC_REQUIRES_RUN_BEFORE_USE(pc) (0)
1240#endif
1241
1242/* This will only be defined by a target that supports catching vfork events,
1243 such as HP-UX.
1244
1245 On some targets (such as HP-UX 10.20 and earlier), resuming a newly vforked
1246 child process after it has exec'd, causes the parent process to resume as
1247 well. To prevent the parent from running spontaneously, such targets should
0d06e24b 1248 define this to a function that prevents that from happening. */
c906108c
SS
1249#if !defined(ENSURE_VFORKING_PARENT_REMAINS_STOPPED)
1250#define ENSURE_VFORKING_PARENT_REMAINS_STOPPED(PID) (0)
1251#endif
1252
1253/* This will only be defined by a target that supports catching vfork events,
1254 such as HP-UX.
1255
1256 On some targets (such as HP-UX 10.20 and earlier), a newly vforked child
1257 process must be resumed when it delivers its exec event, before the parent
0d06e24b
JM
1258 vfork event will be delivered to us. */
1259
c906108c
SS
1260#if !defined(RESUME_EXECD_VFORKING_CHILD_TO_GET_PARENT_VFORK)
1261#define RESUME_EXECD_VFORKING_CHILD_TO_GET_PARENT_VFORK() (0)
1262#endif
1263
1264/* Routines for maintenance of the target structures...
1265
1266 add_target: Add a target to the list of all possible targets.
1267
1268 push_target: Make this target the top of the stack of currently used
c5aa993b
JM
1269 targets, within its particular stratum of the stack. Result
1270 is 0 if now atop the stack, nonzero if not on top (maybe
1271 should warn user).
c906108c
SS
1272
1273 unpush_target: Remove this from the stack of currently used targets,
c5aa993b
JM
1274 no matter where it is on the list. Returns 0 if no
1275 change, 1 if removed from stack.
c906108c 1276
c5aa993b 1277 pop_target: Remove the top thing on the stack of current targets. */
c906108c 1278
a14ed312 1279extern void add_target (struct target_ops *);
c906108c 1280
a14ed312 1281extern int push_target (struct target_ops *);
c906108c 1282
a14ed312 1283extern int unpush_target (struct target_ops *);
c906108c 1284
a14ed312 1285extern void target_preopen (int);
c906108c 1286
a14ed312 1287extern void pop_target (void);
c906108c
SS
1288
1289/* Struct section_table maps address ranges to file sections. It is
1290 mostly used with BFD files, but can be used without (e.g. for handling
1291 raw disks, or files not in formats handled by BFD). */
1292
c5aa993b
JM
1293struct section_table
1294 {
1295 CORE_ADDR addr; /* Lowest address in section */
1296 CORE_ADDR endaddr; /* 1+highest address in section */
c906108c 1297
c5aa993b 1298 sec_ptr the_bfd_section;
c906108c 1299
c5aa993b
JM
1300 bfd *bfd; /* BFD file pointer */
1301 };
c906108c
SS
1302
1303/* Builds a section table, given args BFD, SECTABLE_PTR, SECEND_PTR.
1304 Returns 0 if OK, 1 on error. */
1305
1306extern int
a14ed312 1307build_section_table (bfd *, struct section_table **, struct section_table **);
c906108c
SS
1308
1309/* From mem-break.c */
1310
a14ed312 1311extern int memory_remove_breakpoint (CORE_ADDR, char *);
c906108c 1312
a14ed312 1313extern int memory_insert_breakpoint (CORE_ADDR, char *);
c906108c 1314
a14ed312 1315extern int default_memory_remove_breakpoint (CORE_ADDR, char *);
917317f4 1316
a14ed312 1317extern int default_memory_insert_breakpoint (CORE_ADDR, char *);
917317f4 1318
c906108c 1319extern breakpoint_from_pc_fn memory_breakpoint_from_pc;
c906108c
SS
1320
1321
1322/* From target.c */
1323
a14ed312 1324extern void initialize_targets (void);
c906108c 1325
a14ed312 1326extern void noprocess (void);
c906108c 1327
a14ed312 1328extern void find_default_attach (char *, int);
c906108c 1329
a14ed312 1330extern void find_default_require_attach (char *, int);
c906108c 1331
a14ed312 1332extern void find_default_require_detach (int, char *, int);
c906108c 1333
a14ed312 1334extern void find_default_create_inferior (char *, char *, char **);
c906108c 1335
a14ed312 1336extern void find_default_clone_and_follow_inferior (int, int *);
c906108c 1337
a14ed312 1338extern struct target_ops *find_run_target (void);
7a292a7a 1339
a14ed312 1340extern struct target_ops *find_core_target (void);
6426a772 1341
a14ed312 1342extern struct target_ops *find_target_beneath (struct target_ops *);
ed9a39eb
JM
1343
1344extern int
a14ed312 1345target_resize_to_sections (struct target_ops *target, int num_added);
07cd4b97
JB
1346
1347extern void remove_target_sections (bfd *abfd);
1348
c906108c
SS
1349\f
1350/* Stuff that should be shared among the various remote targets. */
1351
1352/* Debugging level. 0 is off, and non-zero values mean to print some debug
1353 information (higher values, more information). */
1354extern int remote_debug;
1355
1356/* Speed in bits per second, or -1 which means don't mess with the speed. */
1357extern int baud_rate;
1358/* Timeout limit for response from target. */
1359extern int remote_timeout;
1360
c906108c
SS
1361\f
1362/* Functions for helping to write a native target. */
1363
1364/* This is for native targets which use a unix/POSIX-style waitstatus. */
a14ed312 1365extern void store_waitstatus (struct target_waitstatus *, int);
c906108c 1366
c2d11a7d 1367/* Predicate to target_signal_to_host(). Return non-zero if the enum
0d06e24b 1368 targ_signal SIGNO has an equivalent ``host'' representation. */
c2d11a7d
JM
1369/* FIXME: cagney/1999-11-22: The name below was chosen in preference
1370 to the shorter target_signal_p() because it is far less ambigious.
1371 In this context ``target_signal'' refers to GDB's internal
1372 representation of the target's set of signals while ``host signal''
0d06e24b
JM
1373 refers to the target operating system's signal. Confused? */
1374
c2d11a7d
JM
1375extern int target_signal_to_host_p (enum target_signal signo);
1376
1377/* Convert between host signal numbers and enum target_signal's.
1378 target_signal_to_host() returns 0 and prints a warning() on GDB's
0d06e24b 1379 console if SIGNO has no equivalent host representation. */
c2d11a7d
JM
1380/* FIXME: cagney/1999-11-22: Here ``host'' is used incorrectly, it is
1381 refering to the target operating system's signal numbering.
1382 Similarly, ``enum target_signal'' is named incorrectly, ``enum
1383 gdb_signal'' would probably be better as it is refering to GDB's
0d06e24b
JM
1384 internal representation of a target operating system's signal. */
1385
a14ed312
KB
1386extern enum target_signal target_signal_from_host (int);
1387extern int target_signal_to_host (enum target_signal);
c906108c
SS
1388
1389/* Convert from a number used in a GDB command to an enum target_signal. */
a14ed312 1390extern enum target_signal target_signal_from_command (int);
c906108c
SS
1391
1392/* Any target can call this to switch to remote protocol (in remote.c). */
a14ed312 1393extern void push_remote_target (char *name, int from_tty);
c906108c
SS
1394\f
1395/* Imported from machine dependent code */
1396
1397#ifndef SOFTWARE_SINGLE_STEP_P
1398#define SOFTWARE_SINGLE_STEP_P 0
0d06e24b 1399#define SOFTWARE_SINGLE_STEP(sig,bp_p) \
8e65ff28 1400 (internal_error (__FILE__, __LINE__, "SOFTWARE_SINGLE_STEP"), 0)
c906108c
SS
1401#endif /* SOFTWARE_SINGLE_STEP_P */
1402
1403/* Blank target vector entries are initialized to target_ignore. */
a14ed312 1404void target_ignore (void);
c906108c
SS
1405
1406/* Macro for getting target's idea of a frame pointer.
1407 FIXME: GDB's whole scheme for dealing with "frames" and
1408 "frame pointers" needs a serious shakedown. */
1409#ifndef TARGET_VIRTUAL_FRAME_POINTER
1410#define TARGET_VIRTUAL_FRAME_POINTER(ADDR, REGP, OFFP) \
1411 do { *(REGP) = FP_REGNUM; *(OFFP) = 0; } while (0)
1412#endif /* TARGET_VIRTUAL_FRAME_POINTER */
1413
c5aa993b 1414#endif /* !defined (TARGET_H) */
This page took 0.164905 seconds and 4 git commands to generate.