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 xfree (tinfo->ttystate);
228 tinfo->ttystate = serial_copy_tty_state (stdin_serial,
229 our_terminal_info.ttystate);
231 #ifdef PROCESS_GROUP_TYPE
232 tinfo->process_group = pgrp;
235 /* Make sure that next time we call terminal_inferior (which will be
236 before the program runs, as it needs to be), we install the new
238 terminal_is_ours = 1;
242 /* Save the terminal settings again. This is necessary for the TUI
243 when it switches to TUI or non-TUI mode; curses changes the terminal
244 and gdb must be able to restore it correctly. */
247 terminal_save_ours (void)
249 if (gdb_has_a_terminal ())
251 xfree (our_terminal_info.ttystate);
252 our_terminal_info.ttystate = serial_get_tty_state (stdin_serial);
257 terminal_init_inferior (void)
259 #ifdef PROCESS_GROUP_TYPE
260 /* This is for Lynx, and should be cleaned up by having Lynx be a separate
261 debugging target with a version of target_terminal_init_inferior which
262 passes in the process group to a generic routine which does all the work
263 (and the non-threaded child_terminal_init_inferior can just pass in
264 inferior_ptid to the same routine). */
265 /* We assume INFERIOR_PID is also the child's process group. */
266 terminal_init_inferior_with_pgrp (PIDGET (inferior_ptid));
267 #endif /* PROCESS_GROUP_TYPE */
270 /* Put the inferior's terminal settings into effect.
271 This is preparation for starting or resuming the inferior. */
274 terminal_inferior (void)
276 struct inferior *inf;
277 struct terminal_info *tinfo;
279 if (!terminal_is_ours)
282 inf = current_inferior ();
283 tinfo = get_inflow_inferior_data (inf);
285 if (gdb_has_a_terminal ()
286 && tinfo->ttystate != NULL
287 && tinfo->run_terminal == NULL)
292 /* Is there a reason this is being done twice? It happens both
293 places we use F_SETFL, so I'm inclined to think perhaps there
294 is some reason, however perverse. Perhaps not though... */
295 result = fcntl (0, F_SETFL, tinfo->tflags);
296 result = fcntl (0, F_SETFL, tinfo->tflags);
297 OOPSY ("fcntl F_SETFL");
300 /* Because we were careful to not change in or out of raw mode in
301 terminal_ours, we will not change in our out of raw mode with
302 this call, so we don't flush any input. */
303 result = serial_set_tty_state (stdin_serial,
305 OOPSY ("setting tty state");
309 sigint_ours = (void (*)()) signal (SIGINT, SIG_IGN);
311 sigquit_ours = (void (*)()) signal (SIGQUIT, SIG_IGN);
315 /* If attach_flag is set, we don't know whether we are sharing a
316 terminal with the inferior or not. (attaching a process
317 without a terminal is one case where we do not; attaching a
318 process which we ran from the same shell as GDB via `&' is
319 one case where we do, I think (but perhaps this is not
320 `sharing' in the sense that we need to save and restore tty
321 state)). I don't know if there is any way to tell whether we
322 are sharing a terminal. So what we do is to go through all
323 the saving and restoring of the tty state, but ignore errors
324 setting the process group, which will happen if we are not
325 sharing a terminal). */
330 result = tcsetpgrp (0, tinfo->process_group);
331 if (!inf->attach_flag)
336 result = ioctl (0, TIOCSPGRP, &tinfo->process_group);
337 if (!inf->attach_flag)
343 terminal_is_ours = 0;
346 /* Put some of our terminal settings into effect,
347 enough to get proper results from our output,
348 but do not change into or out of RAW mode
349 so that no input is discarded.
351 After doing this, either terminal_ours or terminal_inferior
352 should be called to get back to a normal state of affairs. */
355 terminal_ours_for_output (void)
360 /* Put our terminal settings into effect.
361 First record the inferior's terminal settings
362 so they can be restored properly later. */
370 /* output_only is not used, and should not be used unless we introduce
371 separate terminal_is_ours and terminal_is_ours_for_output
375 terminal_ours_1 (int output_only)
377 struct inferior *inf;
378 struct terminal_info *tinfo;
380 if (terminal_is_ours)
383 terminal_is_ours = 1;
385 /* Checking inferior->run_terminal is necessary so that
386 if GDB is running in the background, it won't block trying
387 to do the ioctl()'s below. Checking gdb_has_a_terminal
388 avoids attempting all the ioctl's when running in batch. */
390 inf = current_inferior ();
391 tinfo = get_inflow_inferior_data (inf);
393 if (tinfo->run_terminal != NULL || gdb_has_a_terminal () == 0)
398 /* Ignore this signal since it will happen when we try to set the
400 void (*osigttou) () = NULL;
406 osigttou = (void (*)()) signal (SIGTTOU, SIG_IGN);
409 xfree (tinfo->ttystate);
410 tinfo->ttystate = serial_get_tty_state (stdin_serial);
412 #ifdef PROCESS_GROUP_TYPE
413 if (!inf->attach_flag)
414 /* If setpgrp failed in terminal_inferior, this would give us
415 our process group instead of the inferior's. See
416 terminal_inferior for details. */
417 tinfo->process_group = gdb_getpgrp ();
420 /* Here we used to set ICANON in our ttystate, but I believe this
421 was an artifact from before when we used readline. Readline sets
422 the tty state when it needs to.
423 FIXME-maybe: However, query() expects non-raw mode and doesn't
424 use readline. Maybe query should use readline (on the other hand,
425 this only matters for HAVE_SGTTY, not termio or termios, I think). */
427 /* Set tty state to our_ttystate. We don't change in our out of raw
428 mode, to avoid flushing input. We need to do the same thing
429 regardless of output_only, because we don't have separate
430 terminal_is_ours and terminal_is_ours_for_output flags. It's OK,
431 though, since readline will deal with raw mode when/if it needs
434 serial_noflush_set_tty_state (stdin_serial, our_terminal_info.ttystate,
440 result = tcsetpgrp (0, our_terminal_info.process_group);
442 /* This fails on Ultrix with EINVAL if you run the testsuite
443 in the background with nohup, and then log out. GDB never
444 used to check for an error here, so perhaps there are other
445 such situations as well. */
447 fprintf_unfiltered (gdb_stderr,
448 "[tcsetpgrp failed in terminal_ours: %s]\n",
449 safe_strerror (errno));
454 result = ioctl (0, TIOCSPGRP, &our_terminal_info.process_group);
460 signal (SIGTTOU, osigttou);
465 signal (SIGINT, sigint_ours);
467 signal (SIGQUIT, sigquit_ours);
472 tinfo->tflags = fcntl (0, F_GETFL, 0);
474 /* Is there a reason this is being done twice? It happens both
475 places we use F_SETFL, so I'm inclined to think perhaps there
476 is some reason, however perverse. Perhaps not though... */
477 result = fcntl (0, F_SETFL, our_terminal_info.tflags);
478 result = fcntl (0, F_SETFL, our_terminal_info.tflags);
483 /* Per-inferior data key. */
484 static const struct inferior_data *inflow_inferior_data;
487 inflow_inferior_data_cleanup (struct inferior *inf, void *arg)
489 struct terminal_info *info;
491 info = inferior_data (inf, inflow_inferior_data);
494 xfree (info->run_terminal);
495 xfree (info->ttystate);
500 /* Get the current svr4 data. If none is found yet, add it now. This
501 function always returns a valid object. */
503 static struct terminal_info *
504 get_inflow_inferior_data (struct inferior *inf)
506 struct terminal_info *info;
508 info = inferior_data (inf, inflow_inferior_data);
511 info = XZALLOC (struct terminal_info);
512 set_inferior_data (inf, inflow_inferior_data, info);
518 /* This is a "inferior_exit" observer. Releases the TERMINAL_INFO member
519 of the inferior structure. This field is private to inflow.c, and
520 its type is opaque to the rest of GDB. PID is the target pid of
521 the inferior that is about to be removed from the inferior
525 inflow_inferior_exit (struct inferior *inf)
527 struct terminal_info *info;
529 info = inferior_data (inf, inflow_inferior_data);
532 xfree (info->run_terminal);
533 xfree (info->ttystate);
535 set_inferior_data (inf, inflow_inferior_data, NULL);
540 copy_terminal_info (struct inferior *to, struct inferior *from)
542 struct terminal_info *tinfo_to, *tinfo_from;
544 tinfo_to = get_inflow_inferior_data (to);
545 tinfo_from = get_inflow_inferior_data (from);
547 xfree (tinfo_to->run_terminal);
548 xfree (tinfo_to->ttystate);
550 *tinfo_to = *tinfo_from;
552 if (tinfo_from->run_terminal)
553 tinfo_to->run_terminal
554 = xstrdup (tinfo_from->run_terminal);
556 if (tinfo_from->ttystate)
558 = serial_copy_tty_state (stdin_serial, tinfo_from->ttystate);
562 term_info (char *arg, int from_tty)
564 target_terminal_info (arg, from_tty);
568 child_terminal_info (char *args, int from_tty)
570 struct inferior *inf;
571 struct terminal_info *tinfo;
573 if (!gdb_has_a_terminal ())
575 printf_filtered (_("This GDB does not control a terminal.\n"));
579 if (ptid_equal (inferior_ptid, null_ptid))
582 inf = current_inferior ();
583 tinfo = get_inflow_inferior_data (inf);
585 printf_filtered (_("Inferior's terminal status "
586 "(currently saved by GDB):\n"));
588 /* First the fcntl flags. */
592 flags = tinfo->tflags;
594 printf_filtered ("File descriptor flags = ");
597 #define O_ACCMODE (O_RDONLY | O_WRONLY | O_RDWR)
599 /* (O_ACCMODE) parens are to avoid Ultrix header file bug. */
600 switch (flags & (O_ACCMODE))
603 printf_filtered ("O_RDONLY");
606 printf_filtered ("O_WRONLY");
609 printf_filtered ("O_RDWR");
612 flags &= ~(O_ACCMODE);
615 if (flags & O_NONBLOCK)
616 printf_filtered (" | O_NONBLOCK");
617 flags &= ~O_NONBLOCK;
620 #if defined (O_NDELAY)
621 /* If O_NDELAY and O_NONBLOCK are defined to the same thing, we will
622 print it as O_NONBLOCK, which is good cause that is what POSIX
623 has, and the flag will already be cleared by the time we get here. */
624 if (flags & O_NDELAY)
625 printf_filtered (" | O_NDELAY");
629 if (flags & O_APPEND)
630 printf_filtered (" | O_APPEND");
633 #if defined (O_BINARY)
634 if (flags & O_BINARY)
635 printf_filtered (" | O_BINARY");
640 printf_filtered (" | 0x%x", flags);
641 printf_filtered ("\n");
644 #ifdef PROCESS_GROUP_TYPE
645 printf_filtered ("Process group = %d\n", (int) tinfo->process_group);
648 serial_print_tty_state (stdin_serial, tinfo->ttystate, gdb_stdout);
651 /* NEW_TTY_PREFORK is called before forking a new child process,
652 so we can record the state of ttys in the child to be formed.
653 TTYNAME is null if we are to share the terminal with gdb;
654 or points to a string containing the name of the desired tty.
656 NEW_TTY is called in new child processes under Unix, which will
657 become debugger target processes. This actually switches to
658 the terminal specified in the NEW_TTY_PREFORK call. */
661 new_tty_prefork (const char *ttyname)
663 /* Save the name for later, for determining whether we and the child
664 are sharing a tty. */
665 inferior_thisrun_terminal = ttyname;
668 #if !defined(__GO32__) && !defined(_WIN32)
669 /* If RESULT, assumed to be the return value from a system call, is
670 negative, print the error message indicated by errno and exit.
671 MSG should identify the operation that failed. */
673 check_syscall (const char *msg, int result)
677 print_sys_errmsg (msg, errno);
688 if (inferior_thisrun_terminal == 0)
690 #if !defined(__GO32__) && !defined(_WIN32)
692 /* Disconnect the child process from our controlling terminal. On some
693 systems (SVR4 for example), this may cause a SIGTTOU, so temporarily
695 tty = open ("/dev/tty", O_RDWR);
700 osigttou = (void (*)()) signal (SIGTTOU, SIG_IGN);
701 ioctl (tty, TIOCNOTTY, 0);
703 signal (SIGTTOU, osigttou);
707 /* Now open the specified new terminal. */
708 tty = open (inferior_thisrun_terminal, O_RDWR | O_NOCTTY);
709 check_syscall (inferior_thisrun_terminal, tty);
711 /* Avoid use of dup2; doesn't exist on all systems. */
715 check_syscall ("dup'ing tty into fd 0", dup (tty));
720 check_syscall ("dup'ing tty into fd 1", dup (tty));
725 check_syscall ("dup'ing tty into fd 2", dup (tty));
729 /* Make tty our new controlling terminal. */
730 if (ioctl (tty, TIOCSCTTY, 0) == -1)
731 /* Mention GDB in warning because it will appear in the inferior's
732 terminal instead of GDB's. */
733 warning (_("GDB: Failed to set controlling terminal: %s"),
734 safe_strerror (errno));
739 #endif /* !go32 && !win32 */
742 /* NEW_TTY_POSTFORK is called after forking a new child process, and
743 adding it to the inferior table, to store the TTYNAME being used by
744 the child, or null if it sharing the terminal with gdb. */
747 new_tty_postfork (void)
749 /* Save the name for later, for determining whether we and the child
750 are sharing a tty. */
752 if (inferior_thisrun_terminal)
754 struct inferior *inf = current_inferior ();
755 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
757 tinfo->run_terminal = xstrdup (inferior_thisrun_terminal);
760 inferior_thisrun_terminal = NULL;
764 /* Call set_sigint_trap when you need to pass a signal on to an attached
765 process when handling SIGINT. */
768 pass_signal (int signo)
771 kill (PIDGET (inferior_ptid), SIGINT);
775 static void (*osig) ();
779 set_sigint_trap (void)
781 struct inferior *inf = current_inferior ();
782 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
784 if (inf->attach_flag || tinfo->run_terminal)
786 osig = (void (*)()) signal (SIGINT, pass_signal);
794 clear_sigint_trap (void)
798 signal (SIGINT, osig);
804 /* Create a new session if the inferior will run in a different tty.
805 A session is UNIX's way of grouping processes that share a controlling
806 terminal, so a new one is needed if the inferior terminal will be
807 different from GDB's.
809 Returns the session id of the new session, 0 if no session was created
810 or -1 if an error occurred. */
812 create_tty_session (void)
817 if (!job_control || inferior_thisrun_terminal == 0)
822 warning (_("Failed to create new terminal session: setsid: %s"),
823 safe_strerror (errno));
828 #endif /* HAVE_SETSID */
831 /* This is here because this is where we figure out whether we (probably)
832 have job control. Just using job_control only does part of it because
833 setpgid or setpgrp might not exist on a system without job control.
834 It might be considered misplaced (on the other hand, process groups and
835 job control are closely related to ttys).
837 For a more clean implementation, in libiberty, put a setpgid which merely
838 calls setpgrp and a setpgrp which does nothing (any system with job control
839 will have one or the other). */
847 #if defined (HAVE_TERMIOS) || defined (TIOCGPGRP)
849 /* The call setpgid (0, 0) is supposed to work and mean the same
850 thing as this, but on Ultrix 4.2A it fails with EPERM (and
851 setpgid (getpid (), getpid ()) succeeds). */
852 retval = setpgid (getpid (), getpid ());
858 retval = setpgrp (getpid (), getpid ());
860 #endif /* HAVE_SETPGRP */
861 #endif /* HAVE_SETPGID */
862 #endif /* defined (HAVE_TERMIOS) || defined (TIOCGPGRP) */
868 /* Get all the current tty settings (including whether we have a
869 tty at all!). We can't do this in _initialize_inflow because
870 serial_fdopen() won't work until the serial_ops_list is
871 initialized, but we don't want to do it lazily either, so
872 that we can guarantee stdin_serial is opened if there is
875 initialize_stdin_serial (void)
877 stdin_serial = serial_fdopen (0);
881 _initialize_inflow (void)
883 add_info ("terminal", term_info,
884 _("Print inferior's saved terminal status."));
886 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
887 &interactive_mode, _("\
888 Set whether GDB's standard input is a terminal."), _("\
889 Show whether GDB's standard input is a terminal."), _("\
890 If on, GDB assumes that standard input is a terminal. In practice, it\n\
891 means that GDB should wait for the user to answer queries associated to\n\
892 commands entered at the command prompt. If off, GDB assumes that standard\n\
893 input is not a terminal, and uses the default answer to all queries.\n\
894 If auto (the default), determine which mode to use based on the standard\n\
897 show_interactive_mode,
898 &setlist, &showlist);
900 terminal_is_ours = 1;
902 /* OK, figure out whether we have job control. If neither termios nor
903 sgtty (i.e. termio or go32), leave job_control 0. */
905 #if defined (HAVE_TERMIOS)
906 /* Do all systems with termios have the POSIX way of identifying job
907 control? I hope so. */
908 #ifdef _POSIX_JOB_CONTROL
911 #ifdef _SC_JOB_CONTROL
912 job_control = sysconf (_SC_JOB_CONTROL);
914 job_control = 0; /* Have to assume the worst. */
915 #endif /* _SC_JOB_CONTROL */
916 #endif /* _POSIX_JOB_CONTROL */
917 #endif /* HAVE_TERMIOS */
924 #endif /* TIOCGPGRP */
927 observer_attach_inferior_exit (inflow_inferior_exit);
930 = register_inferior_data_with_cleanup (inflow_inferior_data_cleanup);