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