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