2000-04-13 Mark Kettenis <kettenis@gnu.org>
[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.
3 Copyright 1986, 1989, 1992, 1996, 1998 Free Software Foundation, Inc.
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 (INFERIOR_H)
23#define INFERIOR_H 1
24
25/* For bpstat. */
26#include "breakpoint.h"
27
28/* For enum target_signal. */
29#include "target.h"
30
7a292a7a 31/* Structure in which to save the status of the inferior. Create/Save
c906108c
SS
32 through "save_inferior_status", restore through
33 "restore_inferior_status".
7a292a7a 34
c906108c
SS
35 This pair of routines should be called around any transfer of
36 control to the inferior which you don't want showing up in your
37 control variables. */
38
7a292a7a 39struct inferior_status;
7a292a7a
SS
40
41extern struct inferior_status *save_inferior_status PARAMS ((int));
42
43extern void restore_inferior_status PARAMS ((struct inferior_status *));
44
45extern void discard_inferior_status PARAMS ((struct inferior_status *));
46
c5aa993b 47extern void write_inferior_status_register PARAMS ((struct inferior_status * inf_status, int regno, LONGEST val));
c906108c
SS
48
49/* This macro gives the number of registers actually in use by the
50 inferior. This may be less than the total number of registers,
51 perhaps depending on the actual CPU in use or program being run. */
52
53#ifndef ARCH_NUM_REGS
54#define ARCH_NUM_REGS NUM_REGS
55#endif
56
c906108c
SS
57extern void set_sigint_trap PARAMS ((void));
58
59extern void clear_sigint_trap PARAMS ((void));
60
61extern void set_sigio_trap PARAMS ((void));
62
63extern void clear_sigio_trap PARAMS ((void));
64
65/* File name for default use for standard in/out in the inferior. */
66
67extern char *inferior_io_terminal;
68
69/* Pid of our debugged inferior, or 0 if no inferior now. */
70
71extern int inferior_pid;
72
43ff13b4
JM
73/* Is the inferior running right now, as a result of a 'run&',
74 'continue&' etc command? This is used in asycn gdb to determine
75 whether a command that the user enters while the target is running
76 is allowed or not. */
77extern int target_executing;
78
79/* Are we simulating synchronous execution? This is used in async gdb
80 to implement the 'run', 'continue' etc commands, which will not
81 redisplay the prompt until the execution is actually over. */
82extern int sync_execution;
83
c906108c
SS
84/* This is only valid when inferior_pid is non-zero.
85
86 If this is 0, then exec events should be noticed and responded to
87 by the debugger (i.e., be reported to the user).
88
89 If this is > 0, then that many subsequent exec events should be
90 ignored (i.e., not be reported to the user).
c5aa993b 91 */
c906108c
SS
92extern int inferior_ignoring_startup_exec_events;
93
94/* This is only valid when inferior_ignoring_startup_exec_events is
95 zero.
96
97 Some targets (stupidly) report more than one exec event per actual
98 call to an event() system call. If only the last such exec event
99 need actually be noticed and responded to by the debugger (i.e.,
100 be reported to the user), then this is the number of "leading"
101 exec events which should be ignored.
c5aa993b 102 */
c906108c
SS
103extern int inferior_ignoring_leading_exec_events;
104
105/* Inferior environment. */
106
107extern struct environ *inferior_environ;
108
7a292a7a
SS
109/* Character array containing an image of the inferior programs'
110 registers. */
c906108c 111
7a292a7a 112extern char *registers;
c906108c 113
7a292a7a
SS
114/* Character array containing the current state of each register
115 (unavailable<0, valid=0, invalid>0). */
c906108c 116
7a292a7a 117extern signed char *register_valid;
c906108c
SS
118
119extern void clear_proceed_status PARAMS ((void));
120
121extern void proceed PARAMS ((CORE_ADDR, enum target_signal, int));
122
123extern void kill_inferior PARAMS ((void));
124
125extern void generic_mourn_inferior PARAMS ((void));
126
127extern void terminal_ours PARAMS ((void));
128
c5aa993b 129extern int run_stack_dummy PARAMS ((CORE_ADDR, char *));
c906108c
SS
130
131extern CORE_ADDR read_pc PARAMS ((void));
132
133extern CORE_ADDR read_pc_pid PARAMS ((int));
134
0f71a2f6
JM
135extern CORE_ADDR generic_target_read_pc PARAMS ((int));
136
c906108c
SS
137extern void write_pc PARAMS ((CORE_ADDR));
138
139extern void write_pc_pid PARAMS ((CORE_ADDR, int));
140
0f71a2f6
JM
141extern void generic_target_write_pc PARAMS ((CORE_ADDR, int));
142
c906108c
SS
143extern CORE_ADDR read_sp PARAMS ((void));
144
0f71a2f6
JM
145extern CORE_ADDR generic_target_read_sp PARAMS ((void));
146
c906108c
SS
147extern void write_sp PARAMS ((CORE_ADDR));
148
0f71a2f6
JM
149extern void generic_target_write_sp PARAMS ((CORE_ADDR));
150
c906108c
SS
151extern CORE_ADDR read_fp PARAMS ((void));
152
0f71a2f6
JM
153extern CORE_ADDR generic_target_read_fp PARAMS ((void));
154
c906108c
SS
155extern void write_fp PARAMS ((CORE_ADDR));
156
0f71a2f6
JM
157extern void generic_target_write_fp PARAMS ((CORE_ADDR));
158
c906108c
SS
159extern void wait_for_inferior PARAMS ((void));
160
c2c6d25f 161extern void fetch_inferior_event PARAMS ((void *));
43ff13b4 162
c906108c
SS
163extern void init_wait_for_inferior PARAMS ((void));
164
165extern void close_exec_file PARAMS ((void));
166
167extern void reopen_exec_file PARAMS ((void));
168
169/* The `resume' routine should only be called in special circumstances.
170 Normally, use `proceed', which handles a lot of bookkeeping. */
171
172extern void resume PARAMS ((int, enum target_signal));
173
174/* From misc files */
175
176extern void store_inferior_registers PARAMS ((int));
177
178extern void fetch_inferior_registers PARAMS ((int));
179
180extern void solib_create_inferior_hook PARAMS ((void));
181
182extern void child_terminal_info PARAMS ((char *, int));
183
184extern void term_info PARAMS ((char *, int));
185
186extern void terminal_ours_for_output PARAMS ((void));
187
188extern void terminal_inferior PARAMS ((void));
189
190extern void terminal_init_inferior PARAMS ((void));
191
192extern void terminal_init_inferior_with_pgrp PARAMS ((int pgrp));
193
194/* From infptrace.c or infttrace.c */
195
196extern int attach PARAMS ((int));
197
198#if !defined(REQUIRE_ATTACH)
199#define REQUIRE_ATTACH attach
200#endif
201
202#if !defined(REQUIRE_DETACH)
203#define REQUIRE_DETACH(pid,siggnal) detach (siggnal)
204#endif
205
206extern void detach PARAMS ((int));
207
7a292a7a 208/* PTRACE method of waiting for inferior process. */
c906108c
SS
209int ptrace_wait PARAMS ((int, int *));
210
211extern void child_resume PARAMS ((int, int, enum target_signal));
212
213#ifndef PTRACE_ARG3_TYPE
214#define PTRACE_ARG3_TYPE int /* Correct definition for most systems. */
215#endif
216
217extern int call_ptrace PARAMS ((int, int, PTRACE_ARG3_TYPE, int));
218
219extern void pre_fork_inferior PARAMS ((void));
220
221/* From procfs.c */
222
223extern int proc_iterate_over_mappings PARAMS ((int (*)(int, CORE_ADDR)));
224
225extern int procfs_first_available PARAMS ((void));
226
c906108c
SS
227/* From fork-child.c */
228
229extern void fork_inferior PARAMS ((char *, char *, char **,
230 void (*)(void),
231 void (*)(int),
232 void (*)(void),
233 char *));
234
235
236extern void
237clone_and_follow_inferior PARAMS ((int, int *));
238
239extern void startup_inferior PARAMS ((int));
240
241/* From inflow.c */
242
243extern void new_tty_prefork PARAMS ((char *));
244
245extern int gdb_has_a_terminal PARAMS ((void));
246
247/* From infrun.c */
248
249extern void start_remote PARAMS ((void));
250
251extern void normal_stop PARAMS ((void));
252
253extern int signal_stop_state PARAMS ((int));
254
255extern int signal_print_state PARAMS ((int));
256
257extern int signal_pass_state PARAMS ((int));
258
d4f3574e
SS
259extern int signal_stop_update PARAMS ((int, int));
260
261extern int signal_print_update PARAMS ((int, int));
262
263extern int signal_pass_update PARAMS ((int, int));
264
c906108c
SS
265/* From infcmd.c */
266
267extern void tty_command PARAMS ((char *, int));
268
269extern void attach_command PARAMS ((char *, int));
270
271/* Last signal that the inferior received (why it stopped). */
272
273extern enum target_signal stop_signal;
274
275/* Address at which inferior stopped. */
276
277extern CORE_ADDR stop_pc;
278
279/* Chain containing status of breakpoint(s) that we have stopped at. */
280
281extern bpstat stop_bpstat;
282
283/* Flag indicating that a command has proceeded the inferior past the
284 current breakpoint. */
285
286extern int breakpoint_proceeded;
287
288/* Nonzero if stopped due to a step command. */
289
290extern int stop_step;
291
292/* Nonzero if stopped due to completion of a stack dummy routine. */
293
294extern int stop_stack_dummy;
295
296/* Nonzero if program stopped due to a random (unexpected) signal in
297 inferior process. */
298
299extern int stopped_by_random_signal;
300
301/* Range to single step within.
302 If this is nonzero, respond to a single-step signal
303 by continuing to step if the pc is in this range.
304
305 If step_range_start and step_range_end are both 1, it means to step for
306 a single instruction (FIXME: it might clean up wait_for_inferior in a
307 minor way if this were changed to the address of the instruction and
308 that address plus one. But maybe not.). */
309
310extern CORE_ADDR step_range_start; /* Inclusive */
c5aa993b 311extern CORE_ADDR step_range_end; /* Exclusive */
c906108c
SS
312
313/* Stack frame address as of when stepping command was issued.
314 This is how we know when we step into a subroutine call,
315 and how to set the frame for the breakpoint used to step out. */
316
317extern CORE_ADDR step_frame_address;
318
319/* Our notion of the current stack pointer. */
320
321extern CORE_ADDR step_sp;
322
323/* 1 means step over all subroutine calls.
324 -1 means step over calls to undebuggable functions. */
325
326extern int step_over_calls;
327
328/* If stepping, nonzero means step count is > 1
329 so don't print frame next time inferior stops
330 if it stops due to stepping. */
331
332extern int step_multi;
333
334/* Nonzero means expecting a trap and caller will handle it themselves.
335 It is used after attach, due to attaching to a process;
336 when running in the shell before the child program has been exec'd;
337 and when running some kinds of remote stuff (FIXME?). */
338
339extern int stop_soon_quietly;
340
341/* Nonzero if proceed is being used for a "finish" command or a similar
342 situation when stop_registers should be saved. */
343
344extern int proceed_to_finish;
345
346/* Save register contents here when about to pop a stack dummy frame,
347 if-and-only-if proceed_to_finish is set.
348 Thus this contains the return value from the called function (assuming
349 values are returned in a register). */
350
7a292a7a 351extern char *stop_registers;
c906108c
SS
352
353/* Nonzero if the child process in inferior_pid was attached rather
354 than forked. */
355
356extern int attach_flag;
357\f
358/* Sigtramp is a routine that the kernel calls (which then calls the
359 signal handler). On most machines it is a library routine that
360 is linked into the executable.
361
362 This macro, given a program counter value and the name of the
363 function in which that PC resides (which can be null if the
364 name is not known), returns nonzero if the PC and name show
365 that we are in sigtramp.
366
367 On most machines just see if the name is sigtramp (and if we have
368 no name, assume we are not in sigtramp). */
369#if !defined (IN_SIGTRAMP)
370#if defined (SIGTRAMP_START)
371#define IN_SIGTRAMP(pc, name) \
372 ((pc) >= SIGTRAMP_START(pc) \
373 && (pc) < SIGTRAMP_END(pc) \
374 )
375#else
376#define IN_SIGTRAMP(pc, name) \
377 (name && STREQ ("_sigtramp", name))
378#endif
379#endif
380\f
381/* Possible values for CALL_DUMMY_LOCATION. */
382#define ON_STACK 1
383#define BEFORE_TEXT_END 2
384#define AFTER_TEXT_END 3
385#define AT_ENTRY_POINT 4
386
7a292a7a
SS
387#if !defined (USE_GENERIC_DUMMY_FRAMES)
388#define USE_GENERIC_DUMMY_FRAMES 0
389#endif
390
c906108c
SS
391#if !defined (CALL_DUMMY_LOCATION)
392#define CALL_DUMMY_LOCATION ON_STACK
393#endif /* No CALL_DUMMY_LOCATION. */
394
7a292a7a 395#if !defined (CALL_DUMMY_ADDRESS)
11cf8741 396#define CALL_DUMMY_ADDRESS() (internal_error ("CALL_DUMMY_ADDRESS"), 0)
7a292a7a
SS
397#endif
398#if !defined (CALL_DUMMY_START_OFFSET)
11cf8741 399#define CALL_DUMMY_START_OFFSET (internal_error ("CALL_DUMMY_START_OFFSET"), 0)
7a292a7a
SS
400#endif
401#if !defined (CALL_DUMMY_BREAKPOINT_OFFSET)
402#define CALL_DUMMY_BREAKPOINT_OFFSET_P (0)
11cf8741 403#define CALL_DUMMY_BREAKPOINT_OFFSET (internal_error ("CALL_DUMMY_BREAKPOINT_OFFSET"), 0)
7a292a7a
SS
404#endif
405#if !defined CALL_DUMMY_BREAKPOINT_OFFSET_P
406#define CALL_DUMMY_BREAKPOINT_OFFSET_P (1)
407#endif
408#if !defined (CALL_DUMMY_LENGTH)
11cf8741 409#define CALL_DUMMY_LENGTH (internal_error ("CALL_DUMMY_LENGTH"), 0)
7a292a7a
SS
410#endif
411
412#if defined (CALL_DUMMY_STACK_ADJUST)
413#if !defined (CALL_DUMMY_STACK_ADJUST_P)
414#define CALL_DUMMY_STACK_ADJUST_P (1)
415#endif
416#endif
417#if !defined (CALL_DUMMY_STACK_ADJUST)
11cf8741 418#define CALL_DUMMY_STACK_ADJUST (internal_error ("CALL_DUMMY_STACK_ADJUST"), 0)
7a292a7a
SS
419#endif
420#if !defined (CALL_DUMMY_STACK_ADJUST_P)
421#define CALL_DUMMY_STACK_ADJUST_P (0)
422#endif
423
424#if !defined (CALL_DUMMY_P)
425#if defined (CALL_DUMMY)
426#define CALL_DUMMY_P 1
427#else
428#define CALL_DUMMY_P 0
429#endif
430#endif
431
432#if !defined (CALL_DUMMY_WORDS)
433#if defined (CALL_DUMMY)
434extern LONGEST call_dummy_words[];
435#define CALL_DUMMY_WORDS (call_dummy_words)
436#else
11cf8741 437#define CALL_DUMMY_WORDS (internal_error ("CALL_DUMMY_WORDS"), (void*) 0)
7a292a7a
SS
438#endif
439#endif
440
441#if !defined (SIZEOF_CALL_DUMMY_WORDS)
442#if defined (CALL_DUMMY)
443extern int sizeof_call_dummy_words;
444#define SIZEOF_CALL_DUMMY_WORDS (sizeof_call_dummy_words)
445#else
11cf8741 446#define SIZEOF_CALL_DUMMY_WORDS (internal_error ("SIZEOF_CALL_DUMMY_WORDS"), 0)
7a292a7a
SS
447#endif
448#endif
449
450#if !defined PUSH_DUMMY_FRAME
11cf8741 451#define PUSH_DUMMY_FRAME (internal_error ("PUSH_DUMMY_FRAME"), 0)
7a292a7a
SS
452#endif
453
454#if !defined FIX_CALL_DUMMY
11cf8741 455#define FIX_CALL_DUMMY(a1,a2,a3,a4,a5,a6,a7) (internal_error ("FIX_CALL_DUMMY"), 0)
7a292a7a
SS
456#endif
457
458#if !defined STORE_STRUCT_RETURN
11cf8741 459#define STORE_STRUCT_RETURN(a1,a2) (internal_error ("STORE_STRUCT_RETURN"), 0)
7a292a7a
SS
460#endif
461
462
463/* Are we in a call dummy? */
464
465extern int pc_in_call_dummy_before_text_end PARAMS ((CORE_ADDR pc, CORE_ADDR sp, CORE_ADDR frame_address));
0f71a2f6 466#if !GDB_MULTI_ARCH
7a292a7a
SS
467#if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == BEFORE_TEXT_END
468#define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_before_text_end (pc, sp, frame_address)
c906108c 469#endif /* Before text_end. */
0f71a2f6 470#endif
c906108c 471
7a292a7a 472extern int pc_in_call_dummy_after_text_end PARAMS ((CORE_ADDR pc, CORE_ADDR sp, CORE_ADDR frame_address));
0f71a2f6 473#if !GDB_MULTI_ARCH
7a292a7a 474#if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AFTER_TEXT_END
c5aa993b 475#define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_after_text_end (pc, sp, frame_address)
7a292a7a 476#endif
0f71a2f6 477#endif
7a292a7a
SS
478
479extern int pc_in_call_dummy_on_stack PARAMS ((CORE_ADDR pc, CORE_ADDR sp, CORE_ADDR frame_address));
0f71a2f6 480#if !GDB_MULTI_ARCH
7a292a7a
SS
481#if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == ON_STACK
482#define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_on_stack (pc, sp, frame_address)
483#endif
0f71a2f6 484#endif
7a292a7a
SS
485
486extern int pc_in_call_dummy_at_entry_point PARAMS ((CORE_ADDR pc, CORE_ADDR sp, CORE_ADDR frame_address));
0f71a2f6 487#if !GDB_MULTI_ARCH
7a292a7a
SS
488#if !defined (PC_IN_CALL_DUMMY) && CALL_DUMMY_LOCATION == AT_ENTRY_POINT
489#define PC_IN_CALL_DUMMY(pc, sp, frame_address) pc_in_call_dummy_at_entry_point (pc, sp, frame_address)
490#endif
0f71a2f6 491#endif
c906108c
SS
492
493/* It's often not enough for our clients to know whether the PC is merely
494 somewhere within the call dummy. They may need to know whether the
495 call dummy has actually completed. (For example, wait_for_inferior
496 wants to know when it should truly stop because the call dummy has
497 completed. If we're single-stepping because of slow watchpoints,
498 then we may find ourselves stopped at the entry of the call dummy,
499 and want to continue stepping until we reach the end.)
500
501 Note that this macro is intended for targets (like HP-UX) which
502 require more than a single breakpoint in their call dummies, and
503 therefore cannot use the CALL_DUMMY_BREAKPOINT_OFFSET mechanism.
504
505 If a target does define CALL_DUMMY_BREAKPOINT_OFFSET, then this
506 default implementation of CALL_DUMMY_HAS_COMPLETED is sufficient.
507 Else, a target may wish to supply an implementation that works in
508 the presense of multiple breakpoints in its call dummy.
c5aa993b 509 */
c906108c
SS
510#if !defined(CALL_DUMMY_HAS_COMPLETED)
511#define CALL_DUMMY_HAS_COMPLETED(pc, sp, frame_address) \
512 PC_IN_CALL_DUMMY((pc), (sp), (frame_address))
513#endif
514
515/* If STARTUP_WITH_SHELL is set, GDB's "run"
516 will attempts to start up the debugee under a shell.
517 This is in order for argument-expansion to occur. E.g.,
518 (gdb) run *
519 The "*" gets expanded by the shell into a list of files.
520 While this is a nice feature, it turns out to interact badly
521 with some of the catch-fork/catch-exec features we have added.
522 In particular, if the shell does any fork/exec's before
523 the exec of the target program, that can confuse GDB.
524 To disable this feature, set STARTUP_WITH_SHELL to 0.
525 To enable this feature, set STARTUP_WITH_SHELL to 1.
526 The catch-exec traps expected during start-up will
527 be 1 if target is not started up with a shell, 2 if it is.
528 - RT
529 If you disable this, you need to decrement
530 START_INFERIOR_TRAPS_EXPECTED in tm.h. */
531#define STARTUP_WITH_SHELL 1
532#if !defined(START_INFERIOR_TRAPS_EXPECTED)
533#define START_INFERIOR_TRAPS_EXPECTED 2
534#endif
535#endif /* !defined (INFERIOR_H) */
This page took 0.071877 seconds and 4 git commands to generate.