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