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, 2010, 2011 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"
31 #include "gdb_string.h"
34 #include "gdb_select.h"
39 #ifdef HAVE_SYS_IOCTL_H
40 #include <sys/ioctl.h>
47 extern void _initialize_inflow (void);
49 static void pass_signal (int);
51 static void terminal_ours_1 (int);
53 /* Record terminal status separately for debugger and inferior. */
55 static struct serial *stdin_serial;
57 /* Terminal related info we need to keep track of. Each inferior
58 holds an instance of this structure --- we save it whenever the
59 corresponding inferior stops, and restore it to the foreground
60 inferior when it resumes. */
63 /* The name of the tty (from the `tty' command) that we gave to the
64 inferior when it was started. */
67 /* TTY state. We save it whenever the inferior stops, and restore
68 it when it resumes. */
69 serial_ttystate ttystate;
71 #ifdef PROCESS_GROUP_TYPE
72 /* Process group. Saved and restored just like ttystate. */
73 PROCESS_GROUP_TYPE process_group;
76 /* fcntl flags. Saved and restored just like ttystate. */
80 /* Our own tty state, which we restore every time we need to deal with
81 the terminal. This is only set once, when GDB first starts. The
82 settings of flags which readline saves and restores and
84 static struct terminal_info our_terminal_info;
86 static struct terminal_info *get_inflow_inferior_data (struct inferior *);
88 #ifdef PROCESS_GROUP_TYPE
90 /* Return the process group of the current inferior. */
93 inferior_process_group (void)
95 return get_inflow_inferior_data (current_inferior ())->process_group;
99 /* While the inferior is running, we want SIGINT and SIGQUIT to go to the
100 inferior only. If we have job control, that takes care of it. If not,
101 we save our handlers in these two variables and set SIGINT and SIGQUIT
104 static void (*sigint_ours) ();
105 static void (*sigquit_ours) ();
107 /* The name of the tty (from the `tty' command) that we're giving to
108 the inferior when starting it up. This is only (and should only
109 be) used as a transient global by new_tty_prefork,
110 create_tty_session, new_tty and new_tty_postfork, all called from
111 fork_inferior, while forking a new child. */
112 static const char *inferior_thisrun_terminal;
114 /* Nonzero if our terminal settings are in effect. Zero if the
115 inferior's settings are in effect. Ignored if !gdb_has_a_terminal
118 int terminal_is_ours;
120 #ifdef PROCESS_GROUP_TYPE
121 static PROCESS_GROUP_TYPE
124 int process_group = -1;
127 process_group = tcgetpgrp (0);
130 process_group = getpgrp ();
133 ioctl (0, TIOCGPGRP, &process_group);
135 return process_group;
141 yes, no, have_not_checked
143 gdb_has_a_terminal_flag = have_not_checked;
145 /* The value of the "interactive-mode" setting. */
146 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
148 /* Implement the "show interactive-mode" option. */
151 show_interactive_mode (struct ui_file *file, int from_tty,
152 struct cmd_list_element *c,
155 if (interactive_mode == AUTO_BOOLEAN_AUTO)
156 fprintf_filtered (file, "Debugger's interactive mode "
157 "is %s (currently %s).\n",
158 value, gdb_has_a_terminal () ? "on" : "off");
160 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
163 /* Does GDB have a terminal (on stdin)? */
165 gdb_has_a_terminal (void)
167 if (interactive_mode != AUTO_BOOLEAN_AUTO)
168 return interactive_mode == AUTO_BOOLEAN_TRUE;
170 switch (gdb_has_a_terminal_flag)
176 case have_not_checked:
177 /* Get all the current tty settings (including whether we have a
178 tty at all!). Can't do this in _initialize_inflow because
179 serial_fdopen() won't work until the serial_ops_list is
183 our_terminal_info.tflags = fcntl (0, F_GETFL, 0);
186 gdb_has_a_terminal_flag = no;
187 if (stdin_serial != NULL)
189 our_terminal_info.ttystate = serial_get_tty_state (stdin_serial);
191 if (our_terminal_info.ttystate != NULL)
193 gdb_has_a_terminal_flag = yes;
194 #ifdef PROCESS_GROUP_TYPE
195 our_terminal_info.process_group = gdb_getpgrp ();
200 return gdb_has_a_terminal_flag == yes;
202 /* "Can't happen". */
207 /* Macro for printing errors from ioctl operations */
209 #define OOPSY(what) \
211 fprintf_unfiltered(gdb_stderr, "[%s failed in terminal_inferior: %s]\n", \
212 what, safe_strerror (errno))
214 static void terminal_ours_1 (int);
216 /* Initialize the terminal settings we record for the inferior,
217 before we actually run the inferior. */
220 terminal_init_inferior_with_pgrp (int pgrp)
222 if (gdb_has_a_terminal ())
224 struct inferior *inf = current_inferior ();
225 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
227 /* We could just as well copy our_ttystate (if we felt like
228 adding a new function serial_copy_tty_state()). */
229 xfree (tinfo->ttystate);
230 tinfo->ttystate = serial_get_tty_state (stdin_serial);
232 #ifdef PROCESS_GROUP_TYPE
233 tinfo->process_group = pgrp;
236 /* Make sure that next time we call terminal_inferior (which will be
237 before the program runs, as it needs to be), we install the new
239 terminal_is_ours = 1;
243 /* Save the terminal settings again. This is necessary for the TUI
244 when it switches to TUI or non-TUI mode; curses changes the terminal
245 and gdb must be able to restore it correctly. */
248 terminal_save_ours (void)
250 if (gdb_has_a_terminal ())
252 /* We could just as well copy our_ttystate (if we felt like adding
253 a new function serial_copy_tty_state). */
254 xfree (our_terminal_info.ttystate);
255 our_terminal_info.ttystate = serial_get_tty_state (stdin_serial);
260 terminal_init_inferior (void)
262 #ifdef PROCESS_GROUP_TYPE
263 /* This is for Lynx, and should be cleaned up by having Lynx be a separate
264 debugging target with a version of target_terminal_init_inferior which
265 passes in the process group to a generic routine which does all the work
266 (and the non-threaded child_terminal_init_inferior can just pass in
267 inferior_ptid to the same routine). */
268 /* We assume INFERIOR_PID is also the child's process group. */
269 terminal_init_inferior_with_pgrp (PIDGET (inferior_ptid));
270 #endif /* PROCESS_GROUP_TYPE */
273 /* Put the inferior's terminal settings into effect.
274 This is preparation for starting or resuming the inferior. */
277 terminal_inferior (void)
279 struct inferior *inf;
280 struct terminal_info *tinfo;
282 if (!terminal_is_ours)
285 inf = current_inferior ();
286 tinfo = get_inflow_inferior_data (inf);
288 if (gdb_has_a_terminal ()
289 && tinfo->ttystate != NULL
290 && tinfo->run_terminal == NULL)
295 /* Is there a reason this is being done twice? It happens both
296 places we use F_SETFL, so I'm inclined to think perhaps there
297 is some reason, however perverse. Perhaps not though... */
298 result = fcntl (0, F_SETFL, tinfo->tflags);
299 result = fcntl (0, F_SETFL, tinfo->tflags);
300 OOPSY ("fcntl F_SETFL");
303 /* Because we were careful to not change in or out of raw mode in
304 terminal_ours, we will not change in our out of raw mode with
305 this call, so we don't flush any input. */
306 result = serial_set_tty_state (stdin_serial,
308 OOPSY ("setting tty state");
312 sigint_ours = (void (*)()) signal (SIGINT, SIG_IGN);
314 sigquit_ours = (void (*)()) signal (SIGQUIT, SIG_IGN);
318 /* If attach_flag is set, we don't know whether we are sharing a
319 terminal with the inferior or not. (attaching a process
320 without a terminal is one case where we do not; attaching a
321 process which we ran from the same shell as GDB via `&' is
322 one case where we do, I think (but perhaps this is not
323 `sharing' in the sense that we need to save and restore tty
324 state)). I don't know if there is any way to tell whether we
325 are sharing a terminal. So what we do is to go through all
326 the saving and restoring of the tty state, but ignore errors
327 setting the process group, which will happen if we are not
328 sharing a terminal). */
333 result = tcsetpgrp (0, tinfo->process_group);
334 if (!inf->attach_flag)
339 result = ioctl (0, TIOCSPGRP, &tinfo->process_group);
340 if (!inf->attach_flag)
346 terminal_is_ours = 0;
349 /* Put some of our terminal settings into effect,
350 enough to get proper results from our output,
351 but do not change into or out of RAW mode
352 so that no input is discarded.
354 After doing this, either terminal_ours or terminal_inferior
355 should be called to get back to a normal state of affairs. */
358 terminal_ours_for_output (void)
363 /* Put our terminal settings into effect.
364 First record the inferior's terminal settings
365 so they can be restored properly later. */
373 /* output_only is not used, and should not be used unless we introduce
374 separate terminal_is_ours and terminal_is_ours_for_output
378 terminal_ours_1 (int output_only)
380 struct inferior *inf;
381 struct terminal_info *tinfo;
383 if (terminal_is_ours)
386 terminal_is_ours = 1;
388 /* Checking inferior->run_terminal is necessary so that
389 if GDB is running in the background, it won't block trying
390 to do the ioctl()'s below. Checking gdb_has_a_terminal
391 avoids attempting all the ioctl's when running in batch. */
393 inf = current_inferior ();
394 tinfo = get_inflow_inferior_data (inf);
396 if (tinfo->run_terminal != NULL || gdb_has_a_terminal () == 0)
401 /* Ignore this signal since it will happen when we try to set the
403 void (*osigttou) () = NULL;
409 osigttou = (void (*)()) signal (SIGTTOU, SIG_IGN);
412 xfree (tinfo->ttystate);
413 tinfo->ttystate = serial_get_tty_state (stdin_serial);
415 #ifdef PROCESS_GROUP_TYPE
416 if (!inf->attach_flag)
417 /* If setpgrp failed in terminal_inferior, this would give us
418 our process group instead of the inferior's. See
419 terminal_inferior for details. */
420 tinfo->process_group = gdb_getpgrp ();
423 /* Here we used to set ICANON in our ttystate, but I believe this
424 was an artifact from before when we used readline. Readline sets
425 the tty state when it needs to.
426 FIXME-maybe: However, query() expects non-raw mode and doesn't
427 use readline. Maybe query should use readline (on the other hand,
428 this only matters for HAVE_SGTTY, not termio or termios, I think). */
430 /* Set tty state to our_ttystate. We don't change in our out of raw
431 mode, to avoid flushing input. We need to do the same thing
432 regardless of output_only, because we don't have separate
433 terminal_is_ours and terminal_is_ours_for_output flags. It's OK,
434 though, since readline will deal with raw mode when/if it needs
437 serial_noflush_set_tty_state (stdin_serial, our_terminal_info.ttystate,
443 result = tcsetpgrp (0, our_terminal_info.process_group);
445 /* This fails on Ultrix with EINVAL if you run the testsuite
446 in the background with nohup, and then log out. GDB never
447 used to check for an error here, so perhaps there are other
448 such situations as well. */
450 fprintf_unfiltered (gdb_stderr,
451 "[tcsetpgrp failed in terminal_ours: %s]\n",
452 safe_strerror (errno));
457 result = ioctl (0, TIOCSPGRP, &our_terminal_info.process_group);
463 signal (SIGTTOU, osigttou);
468 signal (SIGINT, sigint_ours);
470 signal (SIGQUIT, sigquit_ours);
475 tinfo->tflags = fcntl (0, F_GETFL, 0);
477 /* Is there a reason this is being done twice? It happens both
478 places we use F_SETFL, so I'm inclined to think perhaps there
479 is some reason, however perverse. Perhaps not though... */
480 result = fcntl (0, F_SETFL, our_terminal_info.tflags);
481 result = fcntl (0, F_SETFL, our_terminal_info.tflags);
486 /* Per-inferior data key. */
487 static const struct inferior_data *inflow_inferior_data;
490 inflow_inferior_data_cleanup (struct inferior *inf, void *arg)
492 struct terminal_info *info;
494 info = inferior_data (inf, inflow_inferior_data);
497 xfree (info->run_terminal);
502 /* Get the current svr4 data. If none is found yet, add it now. This
503 function always returns a valid object. */
505 static struct terminal_info *
506 get_inflow_inferior_data (struct inferior *inf)
508 struct terminal_info *info;
510 info = inferior_data (inf, inflow_inferior_data);
513 info = XZALLOC (struct terminal_info);
514 set_inferior_data (inf, inflow_inferior_data, info);
520 /* This is a "inferior_exit" observer. Releases the TERMINAL_INFO member
521 of the inferior structure. This field is private to inflow.c, and
522 its type is opaque to the rest of GDB. PID is the target pid of
523 the inferior that is about to be removed from the inferior
527 inflow_inferior_exit (struct inferior *inf)
529 struct terminal_info *info;
531 info = inferior_data (inf, inflow_inferior_data);
534 xfree (info->run_terminal);
536 set_inferior_data (inf, inflow_inferior_data, NULL);
541 copy_terminal_info (struct inferior *to, struct inferior *from)
543 struct terminal_info *tinfo_to, *tinfo_from;
545 tinfo_to = get_inflow_inferior_data (to);
546 tinfo_from = get_inflow_inferior_data (from);
547 *tinfo_to = *tinfo_from;
548 if (tinfo_from->run_terminal)
549 tinfo_to->run_terminal
550 = xstrdup (tinfo_from->run_terminal);
554 term_info (char *arg, int from_tty)
556 target_terminal_info (arg, from_tty);
560 child_terminal_info (char *args, int from_tty)
562 struct inferior *inf;
563 struct terminal_info *tinfo;
565 if (!gdb_has_a_terminal ())
567 printf_filtered (_("This GDB does not control a terminal.\n"));
571 if (ptid_equal (inferior_ptid, null_ptid))
574 inf = current_inferior ();
575 tinfo = get_inflow_inferior_data (inf);
577 printf_filtered (_("Inferior's terminal status "
578 "(currently saved by GDB):\n"));
580 /* First the fcntl flags. */
584 flags = tinfo->tflags;
586 printf_filtered ("File descriptor flags = ");
589 #define O_ACCMODE (O_RDONLY | O_WRONLY | O_RDWR)
591 /* (O_ACCMODE) parens are to avoid Ultrix header file bug. */
592 switch (flags & (O_ACCMODE))
595 printf_filtered ("O_RDONLY");
598 printf_filtered ("O_WRONLY");
601 printf_filtered ("O_RDWR");
604 flags &= ~(O_ACCMODE);
607 if (flags & O_NONBLOCK)
608 printf_filtered (" | O_NONBLOCK");
609 flags &= ~O_NONBLOCK;
612 #if defined (O_NDELAY)
613 /* If O_NDELAY and O_NONBLOCK are defined to the same thing, we will
614 print it as O_NONBLOCK, which is good cause that is what POSIX
615 has, and the flag will already be cleared by the time we get here. */
616 if (flags & O_NDELAY)
617 printf_filtered (" | O_NDELAY");
621 if (flags & O_APPEND)
622 printf_filtered (" | O_APPEND");
625 #if defined (O_BINARY)
626 if (flags & O_BINARY)
627 printf_filtered (" | O_BINARY");
632 printf_filtered (" | 0x%x", flags);
633 printf_filtered ("\n");
636 #ifdef PROCESS_GROUP_TYPE
637 printf_filtered ("Process group = %d\n", (int) tinfo->process_group);
640 serial_print_tty_state (stdin_serial, tinfo->ttystate, gdb_stdout);
643 /* NEW_TTY_PREFORK is called before forking a new child process,
644 so we can record the state of ttys in the child to be formed.
645 TTYNAME is null if we are to share the terminal with gdb;
646 or points to a string containing the name of the desired tty.
648 NEW_TTY is called in new child processes under Unix, which will
649 become debugger target processes. This actually switches to
650 the terminal specified in the NEW_TTY_PREFORK call. */
653 new_tty_prefork (const char *ttyname)
655 /* Save the name for later, for determining whether we and the child
656 are sharing a tty. */
657 inferior_thisrun_terminal = ttyname;
660 #if !defined(__GO32__) && !defined(_WIN32)
661 /* If RESULT, assumed to be the return value from a system call, is
662 negative, print the error message indicated by errno and exit.
663 MSG should identify the operation that failed. */
665 check_syscall (const char *msg, int result)
669 print_sys_errmsg (msg, errno);
680 if (inferior_thisrun_terminal == 0)
682 #if !defined(__GO32__) && !defined(_WIN32)
684 /* Disconnect the child process from our controlling terminal. On some
685 systems (SVR4 for example), this may cause a SIGTTOU, so temporarily
687 tty = open ("/dev/tty", O_RDWR);
692 osigttou = (void (*)()) signal (SIGTTOU, SIG_IGN);
693 ioctl (tty, TIOCNOTTY, 0);
695 signal (SIGTTOU, osigttou);
699 /* Now open the specified new terminal. */
700 tty = open (inferior_thisrun_terminal, O_RDWR | O_NOCTTY);
701 check_syscall (inferior_thisrun_terminal, tty);
703 /* Avoid use of dup2; doesn't exist on all systems. */
707 check_syscall ("dup'ing tty into fd 0", dup (tty));
712 check_syscall ("dup'ing tty into fd 1", dup (tty));
717 check_syscall ("dup'ing tty into fd 2", dup (tty));
721 /* Make tty our new controlling terminal. */
722 if (ioctl (tty, TIOCSCTTY, 0) == -1)
723 /* Mention GDB in warning because it will appear in the inferior's
724 terminal instead of GDB's. */
725 warning (_("GDB: Failed to set controlling terminal: %s"),
726 safe_strerror (errno));
731 #endif /* !go32 && !win32 */
734 /* NEW_TTY_POSTFORK is called after forking a new child process, and
735 adding it to the inferior table, to store the TTYNAME being used by
736 the child, or null if it sharing the terminal with gdb. */
739 new_tty_postfork (void)
741 /* Save the name for later, for determining whether we and the child
742 are sharing a tty. */
744 if (inferior_thisrun_terminal)
746 struct inferior *inf = current_inferior ();
747 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
749 tinfo->run_terminal = xstrdup (inferior_thisrun_terminal);
752 inferior_thisrun_terminal = NULL;
756 /* Call set_sigint_trap when you need to pass a signal on to an attached
757 process when handling SIGINT. */
760 pass_signal (int signo)
763 kill (PIDGET (inferior_ptid), SIGINT);
767 static void (*osig) ();
771 set_sigint_trap (void)
773 struct inferior *inf = current_inferior ();
774 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
776 if (inf->attach_flag || tinfo->run_terminal)
778 osig = (void (*)()) signal (SIGINT, pass_signal);
786 clear_sigint_trap (void)
790 signal (SIGINT, osig);
796 /* Create a new session if the inferior will run in a different tty.
797 A session is UNIX's way of grouping processes that share a controlling
798 terminal, so a new one is needed if the inferior terminal will be
799 different from GDB's.
801 Returns the session id of the new session, 0 if no session was created
802 or -1 if an error occurred. */
804 create_tty_session (void)
809 if (!job_control || inferior_thisrun_terminal == 0)
814 warning (_("Failed to create new terminal session: setsid: %s"),
815 safe_strerror (errno));
820 #endif /* HAVE_SETSID */
823 /* This is here because this is where we figure out whether we (probably)
824 have job control. Just using job_control only does part of it because
825 setpgid or setpgrp might not exist on a system without job control.
826 It might be considered misplaced (on the other hand, process groups and
827 job control are closely related to ttys).
829 For a more clean implementation, in libiberty, put a setpgid which merely
830 calls setpgrp and a setpgrp which does nothing (any system with job control
831 will have one or the other). */
839 #if defined (HAVE_TERMIOS) || defined (TIOCGPGRP)
841 /* The call setpgid (0, 0) is supposed to work and mean the same
842 thing as this, but on Ultrix 4.2A it fails with EPERM (and
843 setpgid (getpid (), getpid ()) succeeds). */
844 retval = setpgid (getpid (), getpid ());
850 retval = setpgrp (getpid (), getpid ());
852 #endif /* HAVE_SETPGRP */
853 #endif /* HAVE_SETPGID */
854 #endif /* defined (HAVE_TERMIOS) || defined (TIOCGPGRP) */
860 /* Get all the current tty settings (including whether we have a
861 tty at all!). We can't do this in _initialize_inflow because
862 serial_fdopen() won't work until the serial_ops_list is
863 initialized, but we don't want to do it lazily either, so
864 that we can guarantee stdin_serial is opened if there is
867 initialize_stdin_serial (void)
869 stdin_serial = serial_fdopen (0);
873 _initialize_inflow (void)
875 add_info ("terminal", term_info,
876 _("Print inferior's saved terminal status."));
878 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
879 &interactive_mode, _("\
880 Set whether GDB's standard input is a terminal."), _("\
881 Show whether GDB's standard input is a terminal."), _("\
882 If on, GDB assumes that standard input is a terminal. In practice, it\n\
883 means that GDB should wait for the user to answer queries associated to\n\
884 commands entered at the command prompt. If off, GDB assumes that standard\n\
885 input is not a terminal, and uses the default answer to all queries.\n\
886 If auto (the default), determine which mode to use based on the standard\n\
889 show_interactive_mode,
890 &setlist, &showlist);
892 terminal_is_ours = 1;
894 /* OK, figure out whether we have job control. If neither termios nor
895 sgtty (i.e. termio or go32), leave job_control 0. */
897 #if defined (HAVE_TERMIOS)
898 /* Do all systems with termios have the POSIX way of identifying job
899 control? I hope so. */
900 #ifdef _POSIX_JOB_CONTROL
903 #ifdef _SC_JOB_CONTROL
904 job_control = sysconf (_SC_JOB_CONTROL);
906 job_control = 0; /* Have to assume the worst. */
907 #endif /* _SC_JOB_CONTROL */
908 #endif /* _POSIX_JOB_CONTROL */
909 #endif /* HAVE_TERMIOS */
916 #endif /* TIOCGPGRP */
919 observer_attach_inferior_exit (inflow_inferior_exit);
922 = register_inferior_data_with_cleanup (inflow_inferior_data_cleanup);