1 /* Low level interface to ptrace, for GDB when running under Unix.
2 Copyright (C) 1986, 1987, 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995,
3 1996, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
4 2009 Free Software Foundation, Inc.
6 This file is part of GDB.
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 3 of the License, or
11 (at your option) any later version.
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.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
28 #include "gdbthread.h"
30 #include "gdb_string.h"
33 #include "gdb_select.h"
37 #ifdef HAVE_SYS_IOCTL_H
38 #include <sys/ioctl.h>
45 #if defined (SIGIO) && defined (FASYNC) && defined (FD_SET) && defined (F_SETOWN)
46 static void handle_sigio (int);
49 extern void _initialize_inflow (void);
51 static void pass_signal (int);
53 static void kill_command (char *, int);
55 static void terminal_ours_1 (int);
57 /* Record terminal status separately for debugger and inferior. */
59 static struct serial
*stdin_serial
;
61 /* TTY state for the inferior. We save it whenever the inferior stops, and
62 restore it when it resumes. */
63 static serial_ttystate inferior_ttystate
;
65 /* Our own tty state, which we restore every time we need to deal with the
66 terminal. We only set it once, when GDB first starts. The settings of
67 flags which readline saves and restores and unimportant. */
68 static serial_ttystate our_ttystate
;
70 /* fcntl flags for us and the inferior. Saved and restored just like
71 {our,inferior}_ttystate. */
72 static int tflags_inferior
;
73 static int tflags_ours
;
75 #ifdef PROCESS_GROUP_TYPE
76 /* Process group for us and the inferior. Saved and restored just like
77 {our,inferior}_ttystate. */
78 PROCESS_GROUP_TYPE our_process_group
;
79 PROCESS_GROUP_TYPE inferior_process_group
;
82 /* While the inferior is running, we want SIGINT and SIGQUIT to go to the
83 inferior only. If we have job control, that takes care of it. If not,
84 we save our handlers in these two variables and set SIGINT and SIGQUIT
87 static void (*sigint_ours
) ();
88 static void (*sigquit_ours
) ();
90 /* The name of the tty (from the `tty' command) that we gave to the inferior
91 when it was last started. */
93 static const char *inferior_thisrun_terminal
;
95 /* Nonzero if our terminal settings are in effect. Zero if the
96 inferior's settings are in effect. Ignored if !gdb_has_a_terminal
101 #ifdef PROCESS_GROUP_TYPE
102 static PROCESS_GROUP_TYPE
105 int process_group
= -1;
107 process_group
= tcgetpgrp (0);
110 process_group
= getpgrp ();
113 ioctl (0, TIOCGPGRP
, &process_group
);
115 return process_group
;
121 yes
, no
, have_not_checked
123 gdb_has_a_terminal_flag
= have_not_checked
;
125 /* Does GDB have a terminal (on stdin)? */
127 gdb_has_a_terminal (void)
129 switch (gdb_has_a_terminal_flag
)
135 case have_not_checked
:
136 /* Get all the current tty settings (including whether we have a
137 tty at all!). Can't do this in _initialize_inflow because
138 serial_fdopen() won't work until the serial_ops_list is
142 tflags_ours
= fcntl (0, F_GETFL
, 0);
145 gdb_has_a_terminal_flag
= no
;
146 if (stdin_serial
!= NULL
)
148 our_ttystate
= serial_get_tty_state (stdin_serial
);
150 if (our_ttystate
!= NULL
)
152 gdb_has_a_terminal_flag
= yes
;
153 #ifdef PROCESS_GROUP_TYPE
154 our_process_group
= gdb_getpgrp ();
159 return gdb_has_a_terminal_flag
== yes
;
161 /* "Can't happen". */
166 /* Macro for printing errors from ioctl operations */
168 #define OOPSY(what) \
170 fprintf_unfiltered(gdb_stderr, "[%s failed in terminal_inferior: %s]\n", \
171 what, safe_strerror (errno))
173 static void terminal_ours_1 (int);
175 /* Initialize the terminal settings we record for the inferior,
176 before we actually run the inferior. */
179 terminal_init_inferior_with_pgrp (int pgrp
)
181 if (gdb_has_a_terminal ())
183 /* We could just as well copy our_ttystate (if we felt like
184 adding a new function serial_copy_tty_state()). */
185 if (inferior_ttystate
)
186 xfree (inferior_ttystate
);
187 inferior_ttystate
= serial_get_tty_state (stdin_serial
);
189 #ifdef PROCESS_GROUP_TYPE
190 inferior_process_group
= pgrp
;
193 /* Make sure that next time we call terminal_inferior (which will be
194 before the program runs, as it needs to be), we install the new
196 terminal_is_ours
= 1;
200 /* Save the terminal settings again. This is necessary for the TUI
201 when it switches to TUI or non-TUI mode; curses changes the terminal
202 and gdb must be able to restore it correctly. */
205 terminal_save_ours (void)
207 if (gdb_has_a_terminal ())
209 /* We could just as well copy our_ttystate (if we felt like adding
210 a new function serial_copy_tty_state). */
212 xfree (our_ttystate
);
213 our_ttystate
= serial_get_tty_state (stdin_serial
);
218 terminal_init_inferior (void)
220 #ifdef PROCESS_GROUP_TYPE
221 /* This is for Lynx, and should be cleaned up by having Lynx be a separate
222 debugging target with a version of target_terminal_init_inferior which
223 passes in the process group to a generic routine which does all the work
224 (and the non-threaded child_terminal_init_inferior can just pass in
225 inferior_ptid to the same routine). */
226 /* We assume INFERIOR_PID is also the child's process group. */
227 terminal_init_inferior_with_pgrp (PIDGET (inferior_ptid
));
228 #endif /* PROCESS_GROUP_TYPE */
231 /* Put the inferior's terminal settings into effect.
232 This is preparation for starting or resuming the inferior. */
235 terminal_inferior (void)
237 if (gdb_has_a_terminal () && terminal_is_ours
238 && inferior_ttystate
!= NULL
239 && inferior_thisrun_terminal
== 0)
244 /* Is there a reason this is being done twice? It happens both
245 places we use F_SETFL, so I'm inclined to think perhaps there
246 is some reason, however perverse. Perhaps not though... */
247 result
= fcntl (0, F_SETFL
, tflags_inferior
);
248 result
= fcntl (0, F_SETFL
, tflags_inferior
);
249 OOPSY ("fcntl F_SETFL");
252 /* Because we were careful to not change in or out of raw mode in
253 terminal_ours, we will not change in our out of raw mode with
254 this call, so we don't flush any input. */
255 result
= serial_set_tty_state (stdin_serial
, inferior_ttystate
);
256 OOPSY ("setting tty state");
260 sigint_ours
= (void (*)()) signal (SIGINT
, SIG_IGN
);
262 sigquit_ours
= (void (*)()) signal (SIGQUIT
, SIG_IGN
);
266 /* If attach_flag is set, we don't know whether we are sharing a
267 terminal with the inferior or not. (attaching a process
268 without a terminal is one case where we do not; attaching a
269 process which we ran from the same shell as GDB via `&' is
270 one case where we do, I think (but perhaps this is not
271 `sharing' in the sense that we need to save and restore tty
272 state)). I don't know if there is any way to tell whether we
273 are sharing a terminal. So what we do is to go through all
274 the saving and restoring of the tty state, but ignore errors
275 setting the process group, which will happen if we are not
276 sharing a terminal). */
280 struct inferior
*inf
= current_inferior ();
282 result
= tcsetpgrp (0, inferior_process_group
);
283 if (!inf
->attach_flag
)
288 result
= ioctl (0, TIOCSPGRP
, &inferior_process_group
);
289 if (!inf
->attach_flag
)
295 terminal_is_ours
= 0;
298 /* Put some of our terminal settings into effect,
299 enough to get proper results from our output,
300 but do not change into or out of RAW mode
301 so that no input is discarded.
303 After doing this, either terminal_ours or terminal_inferior
304 should be called to get back to a normal state of affairs. */
307 terminal_ours_for_output (void)
312 /* Put our terminal settings into effect.
313 First record the inferior's terminal settings
314 so they can be restored properly later. */
322 /* output_only is not used, and should not be used unless we introduce
323 separate terminal_is_ours and terminal_is_ours_for_output
327 terminal_ours_1 (int output_only
)
329 /* Checking inferior_thisrun_terminal is necessary so that
330 if GDB is running in the background, it won't block trying
331 to do the ioctl()'s below. Checking gdb_has_a_terminal
332 avoids attempting all the ioctl's when running in batch. */
333 if (inferior_thisrun_terminal
!= 0 || gdb_has_a_terminal () == 0)
336 if (!terminal_is_ours
)
338 struct inferior
*inf
= current_inferior ();
341 /* Ignore this signal since it will happen when we try to set the
343 void (*osigttou
) () = NULL
;
347 terminal_is_ours
= 1;
351 osigttou
= (void (*)()) signal (SIGTTOU
, SIG_IGN
);
354 if (inferior_ttystate
)
355 xfree (inferior_ttystate
);
356 inferior_ttystate
= serial_get_tty_state (stdin_serial
);
358 #ifdef PROCESS_GROUP_TYPE
359 if (!inf
->attach_flag
)
360 /* If setpgrp failed in terminal_inferior, this would give us
361 our process group instead of the inferior's. See
362 terminal_inferior for details. */
363 inferior_process_group
= gdb_getpgrp ();
366 /* Here we used to set ICANON in our ttystate, but I believe this
367 was an artifact from before when we used readline. Readline sets
368 the tty state when it needs to.
369 FIXME-maybe: However, query() expects non-raw mode and doesn't
370 use readline. Maybe query should use readline (on the other hand,
371 this only matters for HAVE_SGTTY, not termio or termios, I think). */
373 /* Set tty state to our_ttystate. We don't change in our out of raw
374 mode, to avoid flushing input. We need to do the same thing
375 regardless of output_only, because we don't have separate
376 terminal_is_ours and terminal_is_ours_for_output flags. It's OK,
377 though, since readline will deal with raw mode when/if it needs to.
380 serial_noflush_set_tty_state (stdin_serial
, our_ttystate
,
386 result
= tcsetpgrp (0, our_process_group
);
388 /* This fails on Ultrix with EINVAL if you run the testsuite
389 in the background with nohup, and then log out. GDB never
390 used to check for an error here, so perhaps there are other
391 such situations as well. */
393 fprintf_unfiltered (gdb_stderr
, "[tcsetpgrp failed in terminal_ours: %s]\n",
394 safe_strerror (errno
));
399 result
= ioctl (0, TIOCSPGRP
, &our_process_group
);
405 signal (SIGTTOU
, osigttou
);
410 signal (SIGINT
, sigint_ours
);
412 signal (SIGQUIT
, sigquit_ours
);
417 tflags_inferior
= fcntl (0, F_GETFL
, 0);
419 /* Is there a reason this is being done twice? It happens both
420 places we use F_SETFL, so I'm inclined to think perhaps there
421 is some reason, however perverse. Perhaps not though... */
422 result
= fcntl (0, F_SETFL
, tflags_ours
);
423 result
= fcntl (0, F_SETFL
, tflags_ours
);
429 term_info (char *arg
, int from_tty
)
431 target_terminal_info (arg
, from_tty
);
435 child_terminal_info (char *args
, int from_tty
)
437 if (!gdb_has_a_terminal ())
439 printf_filtered (_("This GDB does not control a terminal.\n"));
443 printf_filtered (_("Inferior's terminal status (currently saved by GDB):\n"));
445 /* First the fcntl flags. */
449 flags
= tflags_inferior
;
451 printf_filtered ("File descriptor flags = ");
454 #define O_ACCMODE (O_RDONLY | O_WRONLY | O_RDWR)
456 /* (O_ACCMODE) parens are to avoid Ultrix header file bug */
457 switch (flags
& (O_ACCMODE
))
460 printf_filtered ("O_RDONLY");
463 printf_filtered ("O_WRONLY");
466 printf_filtered ("O_RDWR");
469 flags
&= ~(O_ACCMODE
);
472 if (flags
& O_NONBLOCK
)
473 printf_filtered (" | O_NONBLOCK");
474 flags
&= ~O_NONBLOCK
;
477 #if defined (O_NDELAY)
478 /* If O_NDELAY and O_NONBLOCK are defined to the same thing, we will
479 print it as O_NONBLOCK, which is good cause that is what POSIX
480 has, and the flag will already be cleared by the time we get here. */
481 if (flags
& O_NDELAY
)
482 printf_filtered (" | O_NDELAY");
486 if (flags
& O_APPEND
)
487 printf_filtered (" | O_APPEND");
490 #if defined (O_BINARY)
491 if (flags
& O_BINARY
)
492 printf_filtered (" | O_BINARY");
497 printf_filtered (" | 0x%x", flags
);
498 printf_filtered ("\n");
501 #ifdef PROCESS_GROUP_TYPE
502 printf_filtered ("Process group = %d\n",
503 (int) inferior_process_group
);
506 serial_print_tty_state (stdin_serial
, inferior_ttystate
, gdb_stdout
);
509 /* NEW_TTY_PREFORK is called before forking a new child process,
510 so we can record the state of ttys in the child to be formed.
511 TTYNAME is null if we are to share the terminal with gdb;
512 or points to a string containing the name of the desired tty.
514 NEW_TTY is called in new child processes under Unix, which will
515 become debugger target processes. This actually switches to
516 the terminal specified in the NEW_TTY_PREFORK call. */
519 new_tty_prefork (const char *ttyname
)
521 /* Save the name for later, for determining whether we and the child
522 are sharing a tty. */
523 inferior_thisrun_terminal
= ttyname
;
527 /* If RESULT, assumed to be the return value from a system call, is
528 negative, print the error message indicated by errno and exit.
529 MSG should identify the operation that failed. */
531 check_syscall (const char *msg
, int result
)
535 print_sys_errmsg (msg
, errno
);
545 if (inferior_thisrun_terminal
== 0)
547 #if !defined(__GO32__) && !defined(_WIN32)
549 /* Disconnect the child process from our controlling terminal. On some
550 systems (SVR4 for example), this may cause a SIGTTOU, so temporarily
552 tty
= open ("/dev/tty", O_RDWR
);
557 osigttou
= (void (*)()) signal (SIGTTOU
, SIG_IGN
);
558 ioctl (tty
, TIOCNOTTY
, 0);
560 signal (SIGTTOU
, osigttou
);
564 /* Now open the specified new terminal. */
565 tty
= open (inferior_thisrun_terminal
, O_RDWR
| O_NOCTTY
);
566 check_syscall (inferior_thisrun_terminal
, tty
);
568 /* Avoid use of dup2; doesn't exist on all systems. */
572 check_syscall ("dup'ing tty into fd 0", dup (tty
));
577 check_syscall ("dup'ing tty into fd 1", dup (tty
));
582 check_syscall ("dup'ing tty into fd 2", dup (tty
));
586 /* Make tty our new controlling terminal. */
587 if (ioctl (tty
, TIOCSCTTY
, 0) == -1)
588 /* Mention GDB in warning because it will appear in the inferior's
589 terminal instead of GDB's. */
590 warning ("GDB: Failed to set controlling terminal: %s",
591 safe_strerror (errno
));
596 #endif /* !go32 && !win32 */
599 /* Kill the inferior process. Make us have no inferior. */
602 kill_command (char *arg
, int from_tty
)
604 /* FIXME: This should not really be inferior_ptid (or target_has_execution).
605 It should be a distinct flag that indicates that a target is active, cuz
606 some targets don't have processes! */
608 if (ptid_equal (inferior_ptid
, null_ptid
))
609 error (_("The program is not being run."));
610 if (!query ("Kill the program being debugged? "))
611 error (_("Not confirmed."));
614 /* If the current target interface claims there's still execution,
615 then don't mess with threads of other processes. */
616 if (!target_has_execution
)
618 init_thread_list (); /* Destroy thread info */
620 /* Killing off the inferior can leave us with a core file. If
621 so, print the state we are left in. */
622 if (target_has_stack
)
624 printf_filtered (_("In %s,\n"), target_longname
);
625 print_stack_frame (get_selected_frame (NULL
), 1, SRC_AND_LOC
);
628 bfd_cache_close_all ();
631 /* Call set_sigint_trap when you need to pass a signal on to an attached
632 process when handling SIGINT */
635 pass_signal (int signo
)
638 kill (PIDGET (inferior_ptid
), SIGINT
);
642 static void (*osig
) ();
645 set_sigint_trap (void)
647 struct inferior
*inf
= current_inferior ();
648 if (inf
->attach_flag
|| inferior_thisrun_terminal
)
650 osig
= (void (*)()) signal (SIGINT
, pass_signal
);
655 clear_sigint_trap (void)
657 struct inferior
*inf
= current_inferior ();
658 if (inf
->attach_flag
|| inferior_thisrun_terminal
)
660 signal (SIGINT
, osig
);
665 /* Create a new session if the inferior will run in a different tty.
666 A session is UNIX's way of grouping processes that share a controlling
667 terminal, so a new one is needed if the inferior terminal will be
668 different from GDB's.
670 Returns the session id of the new session, 0 if no session was created
671 or -1 if an error occurred. */
673 create_tty_session (void)
678 if (!job_control
|| inferior_thisrun_terminal
== 0)
683 warning ("Failed to create new terminal session: setsid: %s",
684 safe_strerror (errno
));
689 #endif /* HAVE_SETSID */
692 /* This is here because this is where we figure out whether we (probably)
693 have job control. Just using job_control only does part of it because
694 setpgid or setpgrp might not exist on a system without job control.
695 It might be considered misplaced (on the other hand, process groups and
696 job control are closely related to ttys).
698 For a more clean implementation, in libiberty, put a setpgid which merely
699 calls setpgrp and a setpgrp which does nothing (any system with job control
700 will have one or the other). */
708 #if defined (HAVE_TERMIOS) || defined (TIOCGPGRP)
710 /* The call setpgid (0, 0) is supposed to work and mean the same
711 thing as this, but on Ultrix 4.2A it fails with EPERM (and
712 setpgid (getpid (), getpid ()) succeeds). */
713 retval
= setpgid (getpid (), getpid ());
719 retval
= setpgrp (getpid (), getpid ());
721 #endif /* HAVE_SETPGRP */
722 #endif /* HAVE_SETPGID */
723 #endif /* defined (HAVE_TERMIOS) || defined (TIOCGPGRP) */
729 /* Get all the current tty settings (including whether we have a
730 tty at all!). We can't do this in _initialize_inflow because
731 serial_fdopen() won't work until the serial_ops_list is
732 initialized, but we don't want to do it lazily either, so
733 that we can guarantee stdin_serial is opened if there is
736 initialize_stdin_serial (void)
738 stdin_serial
= serial_fdopen (0);
742 _initialize_inflow (void)
744 add_info ("terminal", term_info
,
745 _("Print inferior's saved terminal status."));
747 add_com ("kill", class_run
, kill_command
,
748 _("Kill execution of program being debugged."));
750 inferior_ptid
= null_ptid
;
752 terminal_is_ours
= 1;
754 /* OK, figure out whether we have job control. If neither termios nor
755 sgtty (i.e. termio or go32), leave job_control 0. */
757 #if defined (HAVE_TERMIOS)
758 /* Do all systems with termios have the POSIX way of identifying job
759 control? I hope so. */
760 #ifdef _POSIX_JOB_CONTROL
763 #ifdef _SC_JOB_CONTROL
764 job_control
= sysconf (_SC_JOB_CONTROL
);
766 job_control
= 0; /* have to assume the worst */
767 #endif /* _SC_JOB_CONTROL */
768 #endif /* _POSIX_JOB_CONTROL */
769 #endif /* HAVE_TERMIOS */
776 #endif /* TIOCGPGRP */