2002-12-05 Andrew Cagney <ac131313@redhat.com>
[deliverable/binutils-gdb.git] / gdb / inferior.h
CommitLineData
c906108c
SS
1/* Variables that describe the inferior process running under GDB:
2 Where it is, why it stopped, and how to step it.
b6ba6518
KB
3 Copyright 1986, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
4 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
c906108c 5
c5aa993b 6 This file is part of GDB.
c906108c 7
c5aa993b
JM
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
c906108c 12
c5aa993b
JM
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
c906108c 17
c5aa993b
JM
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
c906108c
SS
22
23#if !defined (INFERIOR_H)
24#define INFERIOR_H 1
25
67a2b77e 26struct gdbarch;
72cec141 27struct regcache;
67a2b77e 28
c906108c
SS
29/* For bpstat. */
30#include "breakpoint.h"
31
32/* For enum target_signal. */
33#include "target.h"
34
aa0cd9c1
AC
35/* For struct frame_id. */
36#include "frame.h"
37
7a292a7a 38/* Structure in which to save the status of the inferior. Create/Save
c906108c
SS
39 through "save_inferior_status", restore through
40 "restore_inferior_status".
7a292a7a 41
c906108c
SS
42 This pair of routines should be called around any transfer of
43 control to the inferior which you don't want showing up in your
44 control variables. */
45
7a292a7a 46struct inferior_status;
7a292a7a 47
a14ed312 48extern struct inferior_status *save_inferior_status (int);
7a292a7a 49
a14ed312 50extern void restore_inferior_status (struct inferior_status *);
7a292a7a 51
74b7792f
AC
52extern struct cleanup *make_cleanup_restore_inferior_status (struct inferior_status *);
53
a14ed312 54extern void discard_inferior_status (struct inferior_status *);
7a292a7a 55
a14ed312
KB
56extern void write_inferior_status_register (struct inferior_status
57 *inf_status, int regno,
58 LONGEST val);
c906108c 59
ca6724c1
KB
60/* The -1 ptid, often used to indicate either an error condition
61 or a "don't care" condition, i.e, "run all threads." */
62extern ptid_t minus_one_ptid;
63
64/* The null or zero ptid, often used to indicate no process. */
65extern ptid_t null_ptid;
66
67/* Attempt to find and return an existing ptid with the given PID, LWP,
68 and TID components. If none exists, create a new one and return
69 that. */
70ptid_t ptid_build (int pid, long lwp, long tid);
71
72/* Find/Create a ptid from just a pid. */
73ptid_t pid_to_ptid (int pid);
74
75/* Fetch the pid (process id) component from a ptid. */
76int ptid_get_pid (ptid_t ptid);
77
78/* Fetch the lwp (lightweight process) component from a ptid. */
79long ptid_get_lwp (ptid_t ptid);
80
81/* Fetch the tid (thread id) component from a ptid. */
82long ptid_get_tid (ptid_t ptid);
83
84/* Compare two ptids to see if they are equal */
85extern int ptid_equal (ptid_t p1, ptid_t p2);
86
ce696e05
KB
87/* Save value of inferior_ptid so that it may be restored by
88 a later call to do_cleanups(). Returns the struct cleanup
89 pointer needed for later doing the cleanup. */
90extern struct cleanup * save_inferior_ptid (void);
91
a14ed312 92extern void set_sigint_trap (void);
c906108c 93
a14ed312 94extern void clear_sigint_trap (void);
c906108c 95
a14ed312 96extern void set_sigio_trap (void);
c906108c 97
a14ed312 98extern void clear_sigio_trap (void);
c906108c
SS
99
100/* File name for default use for standard in/out in the inferior. */
101
102extern char *inferior_io_terminal;
103
39f77062
KB
104/* Collected pid, tid, etc. of the debugged inferior. When there's
105 no inferior, PIDGET (inferior_ptid) will be 0. */
c906108c 106
39f77062 107extern ptid_t inferior_ptid;
c906108c 108
43ff13b4
JM
109/* Is the inferior running right now, as a result of a 'run&',
110 'continue&' etc command? This is used in asycn gdb to determine
111 whether a command that the user enters while the target is running
112 is allowed or not. */
113extern int target_executing;
114
115/* Are we simulating synchronous execution? This is used in async gdb
116 to implement the 'run', 'continue' etc commands, which will not
117 redisplay the prompt until the execution is actually over. */
118extern int sync_execution;
119
39f77062 120/* This is only valid when inferior_ptid is non-zero.
c906108c
SS
121
122 If this is 0, then exec events should be noticed and responded to
123 by the debugger (i.e., be reported to the user).
124
125 If this is > 0, then that many subsequent exec events should be
126 ignored (i.e., not be reported to the user).
c5aa993b 127 */
c906108c
SS
128extern int inferior_ignoring_startup_exec_events;
129
130/* This is only valid when inferior_ignoring_startup_exec_events is
131 zero.
132
133 Some targets (stupidly) report more than one exec event per actual
134 call to an event() system call. If only the last such exec event
135 need actually be noticed and responded to by the debugger (i.e.,
136 be reported to the user), then this is the number of "leading"
137 exec events which should be ignored.
c5aa993b 138 */
c906108c
SS
139extern int inferior_ignoring_leading_exec_events;
140
141/* Inferior environment. */
142
143extern struct environ *inferior_environ;
144
a14ed312 145extern void clear_proceed_status (void);
c906108c 146
a14ed312 147extern void proceed (CORE_ADDR, enum target_signal, int);
c906108c 148
5fbbeb29
CF
149/* When set, stop the 'step' command if we enter a function which has
150 no line number information. The normal behavior is that we step
151 over such function. */
152extern int step_stop_if_no_debug;
153
a14ed312 154extern void kill_inferior (void);
c906108c 155
a14ed312 156extern void generic_mourn_inferior (void);
c906108c 157
a790ad35
SC
158extern void terminal_save_ours (void);
159
a14ed312 160extern void terminal_ours (void);
c906108c 161
36160dc4 162extern int run_stack_dummy (CORE_ADDR , struct regcache *);
c906108c 163
a14ed312 164extern CORE_ADDR read_pc (void);
c906108c 165
39f77062 166extern CORE_ADDR read_pc_pid (ptid_t);
c906108c 167
39f77062 168extern CORE_ADDR generic_target_read_pc (ptid_t);
0f71a2f6 169
a14ed312 170extern void write_pc (CORE_ADDR);
c906108c 171
39f77062 172extern void write_pc_pid (CORE_ADDR, ptid_t);
c906108c 173
39f77062 174extern void generic_target_write_pc (CORE_ADDR, ptid_t);
0f71a2f6 175
a14ed312 176extern CORE_ADDR read_sp (void);
c906108c 177
a14ed312 178extern CORE_ADDR generic_target_read_sp (void);
0f71a2f6 179
a14ed312 180extern void write_sp (CORE_ADDR);
c906108c 181
a14ed312 182extern void generic_target_write_sp (CORE_ADDR);
0f71a2f6 183
a14ed312 184extern CORE_ADDR read_fp (void);
c906108c 185
a14ed312 186extern CORE_ADDR generic_target_read_fp (void);
0f71a2f6 187
ac2e2ef7 188extern CORE_ADDR unsigned_pointer_to_address (struct type *type, void *buf);
4478b372 189
ac2e2ef7
AC
190extern void unsigned_address_to_pointer (struct type *type, void *buf,
191 CORE_ADDR addr);
192extern CORE_ADDR signed_pointer_to_address (struct type *type, void *buf);
193extern void address_to_signed_pointer (struct type *type, void *buf,
194 CORE_ADDR addr);
4478b372 195
a14ed312 196extern void wait_for_inferior (void);
c906108c 197
a14ed312 198extern void fetch_inferior_event (void *);
43ff13b4 199
a14ed312 200extern void init_wait_for_inferior (void);
c906108c 201
a14ed312 202extern void close_exec_file (void);
c906108c 203
a14ed312 204extern void reopen_exec_file (void);
c906108c
SS
205
206/* The `resume' routine should only be called in special circumstances.
207 Normally, use `proceed', which handles a lot of bookkeeping. */
208
a14ed312 209extern void resume (int, enum target_signal);
c906108c
SS
210
211/* From misc files */
212
0ab7a791
AC
213extern void default_print_registers_info (struct gdbarch *gdbarch,
214 struct ui_file *file,
215 struct frame_info *frame,
216 int regnum, int all);
666e11c5 217
a14ed312 218extern void store_inferior_registers (int);
c906108c 219
a14ed312 220extern void fetch_inferior_registers (int);
c906108c 221
a14ed312 222extern void solib_create_inferior_hook (void);
c906108c 223
a14ed312 224extern void child_terminal_info (char *, int);
c906108c 225
a14ed312 226extern void term_info (char *, int);
c906108c 227
a14ed312 228extern void terminal_ours_for_output (void);
c906108c 229
a14ed312 230extern void terminal_inferior (void);
c906108c 231
a14ed312 232extern void terminal_init_inferior (void);
c906108c 233
a14ed312 234extern void terminal_init_inferior_with_pgrp (int pgrp);
c906108c
SS
235
236/* From infptrace.c or infttrace.c */
237
a14ed312 238extern int attach (int);
c906108c
SS
239
240#if !defined(REQUIRE_ATTACH)
241#define REQUIRE_ATTACH attach
242#endif
243
244#if !defined(REQUIRE_DETACH)
245#define REQUIRE_DETACH(pid,siggnal) detach (siggnal)
246#endif
247
a14ed312 248extern void detach (int);
c906108c 249
7a292a7a 250/* PTRACE method of waiting for inferior process. */
39f77062 251int ptrace_wait (ptid_t, int *);
c906108c 252
39f77062 253extern void child_resume (ptid_t, int, enum target_signal);
c906108c
SS
254
255#ifndef PTRACE_ARG3_TYPE
256#define PTRACE_ARG3_TYPE int /* Correct definition for most systems. */
257#endif
258
a14ed312 259extern int call_ptrace (int, int, PTRACE_ARG3_TYPE, int);
c906108c 260
a14ed312 261extern void pre_fork_inferior (void);
c906108c
SS
262
263/* From procfs.c */
264
a14ed312 265extern int proc_iterate_over_mappings (int (*)(int, CORE_ADDR));
c906108c 266
39f77062 267extern ptid_t procfs_first_available (void);
c906108c 268
c906108c
SS
269/* From fork-child.c */
270
a14ed312
KB
271extern void fork_inferior (char *, char *, char **,
272 void (*)(void),
273 void (*)(int), void (*)(void), char *);
c906108c
SS
274
275
a14ed312 276extern void startup_inferior (int);
c906108c 277
552c04a7
TT
278extern char *construct_inferior_arguments (struct gdbarch *, int, char **);
279
c906108c
SS
280/* From inflow.c */
281
a14ed312 282extern void new_tty_prefork (char *);
c906108c 283
a14ed312 284extern int gdb_has_a_terminal (void);
c906108c
SS
285
286/* From infrun.c */
287
a14ed312 288extern void start_remote (void);
c906108c 289
a14ed312 290extern void normal_stop (void);
c906108c 291
a14ed312 292extern int signal_stop_state (int);
c906108c 293
a14ed312 294extern int signal_print_state (int);
c906108c 295
a14ed312 296extern int signal_pass_state (int);
c906108c 297
a14ed312 298extern int signal_stop_update (int, int);
d4f3574e 299
a14ed312 300extern int signal_print_update (int, int);
d4f3574e 301
a14ed312 302extern int signal_pass_update (int, int);
d4f3574e 303
39f77062
KB
304extern void get_last_target_status(ptid_t *ptid,
305 struct target_waitstatus *status);
e02bc4cc 306
c906108c
SS
307/* From infcmd.c */
308
a14ed312 309extern void tty_command (char *, int);
c906108c 310
a14ed312 311extern void attach_command (char *, int);
c906108c 312
a250df2e 313extern char *get_inferior_args (void);
07091751 314
a250df2e 315extern char *set_inferior_args (char *);
07091751 316
552c04a7
TT
317extern void set_inferior_args_vector (int, char **);
318
36dc181b
EZ
319extern void registers_info (char *, int);
320
321extern void nexti_command (char *, int);
322
323extern void stepi_command (char *, int);
324
325extern void continue_command (char *, int);
326
327extern void interrupt_target_command (char *args, int from_tty);
328
c906108c
SS
329/* Last signal that the inferior received (why it stopped). */
330
331extern enum target_signal stop_signal;
332
333/* Address at which inferior stopped. */
334
335extern CORE_ADDR stop_pc;
336
337/* Chain containing status of breakpoint(s) that we have stopped at. */
338
339extern bpstat stop_bpstat;
340
341/* Flag indicating that a command has proceeded the inferior past the
342 current breakpoint. */
343
344extern int breakpoint_proceeded;
345
346/* Nonzero if stopped due to a step command. */
347
348extern int stop_step;
349
350/* Nonzero if stopped due to completion of a stack dummy routine. */
351
352extern int stop_stack_dummy;
353
354/* Nonzero if program stopped due to a random (unexpected) signal in
355 inferior process. */
356
357extern int stopped_by_random_signal;
358
359/* Range to single step within.
360 If this is nonzero, respond to a single-step signal
361 by continuing to step if the pc is in this range.
362
363 If step_range_start and step_range_end are both 1, it means to step for
364 a single instruction (FIXME: it might clean up wait_for_inferior in a
365 minor way if this were changed to the address of the instruction and
366 that address plus one. But maybe not.). */
367
368extern CORE_ADDR step_range_start; /* Inclusive */
c5aa993b 369extern CORE_ADDR step_range_end; /* Exclusive */
c906108c
SS
370
371/* Stack frame address as of when stepping command was issued.
372 This is how we know when we step into a subroutine call,
373 and how to set the frame for the breakpoint used to step out. */
374
aa0cd9c1 375extern struct frame_id step_frame_id;
c906108c
SS
376
377/* Our notion of the current stack pointer. */
378
379extern CORE_ADDR step_sp;
380
381/* 1 means step over all subroutine calls.
382 -1 means step over calls to undebuggable functions. */
383
5fbbeb29
CF
384enum step_over_calls_kind
385 {
386 STEP_OVER_NONE,
387 STEP_OVER_ALL,
a4acd088
CF
388 STEP_OVER_UNDEBUGGABLE
389 };
390
391extern enum step_over_calls_kind step_over_calls;
c906108c
SS
392
393/* If stepping, nonzero means step count is > 1
394 so don't print frame next time inferior stops
395 if it stops due to stepping. */
396
397extern int step_multi;
398
399/* Nonzero means expecting a trap and caller will handle it themselves.
400 It is used after attach, due to attaching to a process;
401 when running in the shell before the child program has been exec'd;
402 and when running some kinds of remote stuff (FIXME?). */
403
404extern int stop_soon_quietly;
405
406/* Nonzero if proceed is being used for a "finish" command or a similar
407 situation when stop_registers should be saved. */
408
409extern int proceed_to_finish;
410
411/* Save register contents here when about to pop a stack dummy frame,
412 if-and-only-if proceed_to_finish is set.
413 Thus this contains the return value from the called function (assuming
414 values are returned in a register). */
415
72cec141 416extern struct regcache *stop_registers;
c906108c 417
39f77062 418/* Nonzero if the child process in inferior_ptid was attached rather
c906108c
SS
419 than forked. */
420
421extern int attach_flag;
422\f
c906108c
SS
423/* Possible values for CALL_DUMMY_LOCATION. */
424#define ON_STACK 1
425#define BEFORE_TEXT_END 2
426#define AFTER_TEXT_END 3
427#define AT_ENTRY_POINT 4
428
7a292a7a 429#if !defined (CALL_DUMMY_ADDRESS)
8e65ff28 430#define CALL_DUMMY_ADDRESS() (internal_error (__FILE__, __LINE__, "CALL_DUMMY_ADDRESS"), 0)
7a292a7a
SS
431#endif
432#if !defined (CALL_DUMMY_START_OFFSET)
8e65ff28 433#define CALL_DUMMY_START_OFFSET (internal_error (__FILE__, __LINE__, "CALL_DUMMY_START_OFFSET"), 0)
7a292a7a
SS
434#endif
435#if !defined (CALL_DUMMY_BREAKPOINT_OFFSET)
436#define CALL_DUMMY_BREAKPOINT_OFFSET_P (0)
8e65ff28 437#define CALL_DUMMY_BREAKPOINT_OFFSET (internal_error (__FILE__, __LINE__, "CALL_DUMMY_BREAKPOINT_OFFSET"), 0)
7a292a7a
SS
438#endif
439#if !defined CALL_DUMMY_BREAKPOINT_OFFSET_P
440#define CALL_DUMMY_BREAKPOINT_OFFSET_P (1)
441#endif
442#if !defined (CALL_DUMMY_LENGTH)
8e65ff28 443#define CALL_DUMMY_LENGTH (internal_error (__FILE__, __LINE__, "CALL_DUMMY_LENGTH"), 0)
7a292a7a
SS
444#endif
445
446#if defined (CALL_DUMMY_STACK_ADJUST)
447#if !defined (CALL_DUMMY_STACK_ADJUST_P)
448#define CALL_DUMMY_STACK_ADJUST_P (1)
449#endif
450#endif
451#if !defined (CALL_DUMMY_STACK_ADJUST)
8e65ff28 452#define CALL_DUMMY_STACK_ADJUST (internal_error (__FILE__, __LINE__, "CALL_DUMMY_STACK_ADJUST"), 0)
7a292a7a
SS
453#endif
454#if !defined (CALL_DUMMY_STACK_ADJUST_P)
455#define CALL_DUMMY_STACK_ADJUST_P (0)
456#endif
457
ba886e9d
AC
458/* FIXME: cagney/2000-04-17: gdbarch should manage this. The default
459 shouldn't be necessary. */
460
7a292a7a
SS
461#if !defined (CALL_DUMMY_P)
462#if defined (CALL_DUMMY)
463#define CALL_DUMMY_P 1
464#else
465#define CALL_DUMMY_P 0
466#endif
467#endif
468
7a292a7a 469#if !defined PUSH_DUMMY_FRAME
8e65ff28 470#define PUSH_DUMMY_FRAME (internal_error (__FILE__, __LINE__, "PUSH_DUMMY_FRAME"), 0)
7a292a7a
SS
471#endif
472
473#if !defined FIX_CALL_DUMMY
8e65ff28 474#define FIX_CALL_DUMMY(a1,a2,a3,a4,a5,a6,a7) (internal_error (__FILE__, __LINE__, "FIX_CALL_DUMMY"), 0)
7a292a7a
SS
475#endif
476
477#if !defined STORE_STRUCT_RETURN
8e65ff28 478#define STORE_STRUCT_RETURN(a1,a2) (internal_error (__FILE__, __LINE__, "STORE_STRUCT_RETURN"), 0)
7a292a7a
SS
479#endif
480
481
482/* Are we in a call dummy? */
483
b4b88177
AC
484/* NOTE: cagney/2002-11-24: Targets need to both switch to generic
485 dummy frames, and use generic_pc_in_call_dummy(). The generic
486 version should be able to handle all cases since that code works by
487 saving the address of the dummy's breakpoint (where ever it is). */
488
489extern int deprecated_pc_in_call_dummy_before_text_end (CORE_ADDR pc,
490 CORE_ADDR sp,
491 CORE_ADDR frame_address);
c906108c 492
b4b88177
AC
493/* NOTE: cagney/2002-11-24: Targets need to both switch to generic
494 dummy frames, and use generic_pc_in_call_dummy(). The generic
495 version should be able to handle all cases since that code works by
496 saving the address of the dummy's breakpoint (where ever it is). */
497
498extern int deprecated_pc_in_call_dummy_after_text_end (CORE_ADDR pc,
499 CORE_ADDR sp,
500 CORE_ADDR frame_address);
7a292a7a 501
b4b88177
AC
502/* NOTE: cagney/2002-11-24: Targets need to both switch to generic
503 dummy frames, and use generic_pc_in_call_dummy(). The generic
504 version should be able to handle all cases since that code works by
505 saving the address of the dummy's breakpoint (where ever it is). */
506
507extern int deprecated_pc_in_call_dummy_on_stack (CORE_ADDR pc,
508 CORE_ADDR sp,
509 CORE_ADDR frame_address);
7a292a7a 510
b4b88177
AC
511/* NOTE: cagney/2002-11-24: Targets need to both switch to generic
512 dummy frames, and use generic_pc_in_call_dummy(). The generic
513 version should be able to handle all cases since that code works by
514 saving the address of the dummy's breakpoint (where ever it is). */
515
516extern int deprecated_pc_in_call_dummy_at_entry_point (CORE_ADDR pc,
517 CORE_ADDR sp,
518 CORE_ADDR frame_address);
c906108c
SS
519
520/* It's often not enough for our clients to know whether the PC is merely
521 somewhere within the call dummy. They may need to know whether the
522 call dummy has actually completed. (For example, wait_for_inferior
523 wants to know when it should truly stop because the call dummy has
524 completed. If we're single-stepping because of slow watchpoints,
525 then we may find ourselves stopped at the entry of the call dummy,
526 and want to continue stepping until we reach the end.)
527
528 Note that this macro is intended for targets (like HP-UX) which
529 require more than a single breakpoint in their call dummies, and
530 therefore cannot use the CALL_DUMMY_BREAKPOINT_OFFSET mechanism.
531
532 If a target does define CALL_DUMMY_BREAKPOINT_OFFSET, then this
533 default implementation of CALL_DUMMY_HAS_COMPLETED is sufficient.
534 Else, a target may wish to supply an implementation that works in
535 the presense of multiple breakpoints in its call dummy.
c5aa993b 536 */
c906108c
SS
537#if !defined(CALL_DUMMY_HAS_COMPLETED)
538#define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
ae45cd16 539 DEPRECATED_PC_IN_CALL_DUMMY((pc), (sp), (frame_address))
c906108c
SS
540#endif
541
542/* If STARTUP_WITH_SHELL is set, GDB's "run"
543 will attempts to start up the debugee under a shell.
544 This is in order for argument-expansion to occur. E.g.,
545 (gdb) run *
546 The "*" gets expanded by the shell into a list of files.
547 While this is a nice feature, it turns out to interact badly
548 with some of the catch-fork/catch-exec features we have added.
549 In particular, if the shell does any fork/exec's before
550 the exec of the target program, that can confuse GDB.
551 To disable this feature, set STARTUP_WITH_SHELL to 0.
552 To enable this feature, set STARTUP_WITH_SHELL to 1.
553 The catch-exec traps expected during start-up will
554 be 1 if target is not started up with a shell, 2 if it is.
555 - RT
556 If you disable this, you need to decrement
557 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
558#define STARTUP_WITH_SHELL 1
559#if !defined(START_INFERIOR_TRAPS_EXPECTED)
560#define START_INFERIOR_TRAPS_EXPECTED 2
561#endif
562#endif /* !defined (INFERIOR_H) */
This page took 0.25197 seconds and 4 git commands to generate.