1 /* Low level interface to ptrace, for GDB when running under Unix.
2 Copyright (C) 1986-1996, 1998-2012 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
26 #include "gdbthread.h"
29 #include "gdb_string.h"
32 #include "gdb_select.h"
37 #ifdef HAVE_SYS_IOCTL_H
38 #include <sys/ioctl.h>
45 extern void _initialize_inflow (void);
47 static void pass_signal (int);
49 static void terminal_ours_1 (int);
51 /* Record terminal status separately for debugger and inferior. */
53 static struct serial *stdin_serial;
55 /* Terminal related info we need to keep track of. Each inferior
56 holds an instance of this structure --- we save it whenever the
57 corresponding inferior stops, and restore it to the foreground
58 inferior when it resumes. */
61 /* The name of the tty (from the `tty' command) that we gave to the
62 inferior when it was started. */
65 /* TTY state. We save it whenever the inferior stops, and restore
66 it when it resumes. */
67 serial_ttystate ttystate;
69 #ifdef PROCESS_GROUP_TYPE
70 /* Process group. Saved and restored just like ttystate. */
71 PROCESS_GROUP_TYPE process_group;
74 /* fcntl flags. Saved and restored just like ttystate. */
78 /* Our own tty state, which we restore every time we need to deal with
79 the terminal. This is only set once, when GDB first starts. The
80 settings of flags which readline saves and restores and
82 static struct terminal_info our_terminal_info;
84 static struct terminal_info *get_inflow_inferior_data (struct inferior *);
86 #ifdef PROCESS_GROUP_TYPE
88 /* Return the process group of the current inferior. */
91 inferior_process_group (void)
93 return get_inflow_inferior_data (current_inferior ())->process_group;
97 /* While the inferior is running, we want SIGINT and SIGQUIT to go to the
98 inferior only. If we have job control, that takes care of it. If not,
99 we save our handlers in these two variables and set SIGINT and SIGQUIT
102 static void (*sigint_ours) ();
103 static void (*sigquit_ours) ();
105 /* The name of the tty (from the `tty' command) that we're giving to
106 the inferior when starting it up. This is only (and should only
107 be) used as a transient global by new_tty_prefork,
108 create_tty_session, new_tty and new_tty_postfork, all called from
109 fork_inferior, while forking a new child. */
110 static const char *inferior_thisrun_terminal;
112 /* Nonzero if our terminal settings are in effect. Zero if the
113 inferior's settings are in effect. Ignored if !gdb_has_a_terminal
116 int terminal_is_ours;
118 #ifdef PROCESS_GROUP_TYPE
119 static PROCESS_GROUP_TYPE
122 int process_group = -1;
125 process_group = tcgetpgrp (0);
128 process_group = getpgrp ();
131 ioctl (0, TIOCGPGRP, &process_group);
133 return process_group;
139 yes, no, have_not_checked
141 gdb_has_a_terminal_flag = have_not_checked;
143 /* The value of the "interactive-mode" setting. */
144 static enum auto_boolean interactive_mode = AUTO_BOOLEAN_AUTO;
146 /* Implement the "show interactive-mode" option. */
149 show_interactive_mode (struct ui_file *file, int from_tty,
150 struct cmd_list_element *c,
153 if (interactive_mode == AUTO_BOOLEAN_AUTO)
154 fprintf_filtered (file, "Debugger's interactive mode "
155 "is %s (currently %s).\n",
156 value, gdb_has_a_terminal () ? "on" : "off");
158 fprintf_filtered (file, "Debugger's interactive mode is %s.\n", value);
161 /* Does GDB have a terminal (on stdin)? */
163 gdb_has_a_terminal (void)
165 if (interactive_mode != AUTO_BOOLEAN_AUTO)
166 return interactive_mode == AUTO_BOOLEAN_TRUE;
168 switch (gdb_has_a_terminal_flag)
174 case have_not_checked:
175 /* Get all the current tty settings (including whether we have a
176 tty at all!). Can't do this in _initialize_inflow because
177 serial_fdopen() won't work until the serial_ops_list is
181 our_terminal_info.tflags = fcntl (0, F_GETFL, 0);
184 gdb_has_a_terminal_flag = no;
185 if (stdin_serial != NULL)
187 our_terminal_info.ttystate = serial_get_tty_state (stdin_serial);
189 if (our_terminal_info.ttystate != NULL)
191 gdb_has_a_terminal_flag = yes;
192 #ifdef PROCESS_GROUP_TYPE
193 our_terminal_info.process_group = gdb_getpgrp ();
198 return gdb_has_a_terminal_flag == yes;
200 /* "Can't happen". */
205 /* Macro for printing errors from ioctl operations */
207 #define OOPSY(what) \
209 fprintf_unfiltered(gdb_stderr, "[%s failed in terminal_inferior: %s]\n", \
210 what, safe_strerror (errno))
212 static void terminal_ours_1 (int);
214 /* Initialize the terminal settings we record for the inferior,
215 before we actually run the inferior. */
218 terminal_init_inferior_with_pgrp (int pgrp)
220 if (gdb_has_a_terminal ())
222 struct inferior *inf = current_inferior ();
223 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
225 xfree (tinfo->ttystate);
226 tinfo->ttystate = serial_copy_tty_state (stdin_serial,
227 our_terminal_info.ttystate);
229 #ifdef PROCESS_GROUP_TYPE
230 tinfo->process_group = pgrp;
233 /* Make sure that next time we call terminal_inferior (which will be
234 before the program runs, as it needs to be), we install the new
236 terminal_is_ours = 1;
240 /* Save the terminal settings again. This is necessary for the TUI
241 when it switches to TUI or non-TUI mode; curses changes the terminal
242 and gdb must be able to restore it correctly. */
245 terminal_save_ours (void)
247 if (gdb_has_a_terminal ())
249 xfree (our_terminal_info.ttystate);
250 our_terminal_info.ttystate = serial_get_tty_state (stdin_serial);
255 terminal_init_inferior (void)
257 #ifdef PROCESS_GROUP_TYPE
258 /* This is for Lynx, and should be cleaned up by having Lynx be a separate
259 debugging target with a version of target_terminal_init_inferior which
260 passes in the process group to a generic routine which does all the work
261 (and the non-threaded child_terminal_init_inferior can just pass in
262 inferior_ptid to the same routine). */
263 /* We assume INFERIOR_PID is also the child's process group. */
264 terminal_init_inferior_with_pgrp (PIDGET (inferior_ptid));
265 #endif /* PROCESS_GROUP_TYPE */
268 /* Put the inferior's terminal settings into effect.
269 This is preparation for starting or resuming the inferior. */
272 terminal_inferior (void)
274 struct inferior *inf;
275 struct terminal_info *tinfo;
277 if (!terminal_is_ours)
280 inf = current_inferior ();
281 tinfo = get_inflow_inferior_data (inf);
283 if (gdb_has_a_terminal ()
284 && tinfo->ttystate != NULL
285 && tinfo->run_terminal == NULL)
290 /* Is there a reason this is being done twice? It happens both
291 places we use F_SETFL, so I'm inclined to think perhaps there
292 is some reason, however perverse. Perhaps not though... */
293 result = fcntl (0, F_SETFL, tinfo->tflags);
294 result = fcntl (0, F_SETFL, tinfo->tflags);
295 OOPSY ("fcntl F_SETFL");
298 /* Because we were careful to not change in or out of raw mode in
299 terminal_ours, we will not change in our out of raw mode with
300 this call, so we don't flush any input. */
301 result = serial_set_tty_state (stdin_serial,
303 OOPSY ("setting tty state");
307 sigint_ours = (void (*)()) signal (SIGINT, SIG_IGN);
309 sigquit_ours = (void (*)()) signal (SIGQUIT, SIG_IGN);
313 /* If attach_flag is set, we don't know whether we are sharing a
314 terminal with the inferior or not. (attaching a process
315 without a terminal is one case where we do not; attaching a
316 process which we ran from the same shell as GDB via `&' is
317 one case where we do, I think (but perhaps this is not
318 `sharing' in the sense that we need to save and restore tty
319 state)). I don't know if there is any way to tell whether we
320 are sharing a terminal. So what we do is to go through all
321 the saving and restoring of the tty state, but ignore errors
322 setting the process group, which will happen if we are not
323 sharing a terminal). */
328 result = tcsetpgrp (0, tinfo->process_group);
329 if (!inf->attach_flag)
334 result = ioctl (0, TIOCSPGRP, &tinfo->process_group);
335 if (!inf->attach_flag)
341 terminal_is_ours = 0;
344 /* Put some of our terminal settings into effect,
345 enough to get proper results from our output,
346 but do not change into or out of RAW mode
347 so that no input is discarded.
349 After doing this, either terminal_ours or terminal_inferior
350 should be called to get back to a normal state of affairs. */
353 terminal_ours_for_output (void)
358 /* Put our terminal settings into effect.
359 First record the inferior's terminal settings
360 so they can be restored properly later. */
368 /* output_only is not used, and should not be used unless we introduce
369 separate terminal_is_ours and terminal_is_ours_for_output
373 terminal_ours_1 (int output_only)
375 struct inferior *inf;
376 struct terminal_info *tinfo;
378 if (terminal_is_ours)
381 terminal_is_ours = 1;
383 /* Checking inferior->run_terminal is necessary so that
384 if GDB is running in the background, it won't block trying
385 to do the ioctl()'s below. Checking gdb_has_a_terminal
386 avoids attempting all the ioctl's when running in batch. */
388 inf = current_inferior ();
389 tinfo = get_inflow_inferior_data (inf);
391 if (tinfo->run_terminal != NULL || gdb_has_a_terminal () == 0)
396 /* Ignore this signal since it will happen when we try to set the
398 void (*osigttou) () = NULL;
404 osigttou = (void (*)()) signal (SIGTTOU, SIG_IGN);
407 xfree (tinfo->ttystate);
408 tinfo->ttystate = serial_get_tty_state (stdin_serial);
410 #ifdef PROCESS_GROUP_TYPE
411 if (!inf->attach_flag)
412 /* If setpgrp failed in terminal_inferior, this would give us
413 our process group instead of the inferior's. See
414 terminal_inferior for details. */
415 tinfo->process_group = gdb_getpgrp ();
418 /* Here we used to set ICANON in our ttystate, but I believe this
419 was an artifact from before when we used readline. Readline sets
420 the tty state when it needs to.
421 FIXME-maybe: However, query() expects non-raw mode and doesn't
422 use readline. Maybe query should use readline (on the other hand,
423 this only matters for HAVE_SGTTY, not termio or termios, I think). */
425 /* Set tty state to our_ttystate. We don't change in our out of raw
426 mode, to avoid flushing input. We need to do the same thing
427 regardless of output_only, because we don't have separate
428 terminal_is_ours and terminal_is_ours_for_output flags. It's OK,
429 though, since readline will deal with raw mode when/if it needs
432 serial_noflush_set_tty_state (stdin_serial, our_terminal_info.ttystate,
438 result = tcsetpgrp (0, our_terminal_info.process_group);
440 /* This fails on Ultrix with EINVAL if you run the testsuite
441 in the background with nohup, and then log out. GDB never
442 used to check for an error here, so perhaps there are other
443 such situations as well. */
445 fprintf_unfiltered (gdb_stderr,
446 "[tcsetpgrp failed in terminal_ours: %s]\n",
447 safe_strerror (errno));
452 result = ioctl (0, TIOCSPGRP, &our_terminal_info.process_group);
458 signal (SIGTTOU, osigttou);
463 signal (SIGINT, sigint_ours);
465 signal (SIGQUIT, sigquit_ours);
470 tinfo->tflags = fcntl (0, F_GETFL, 0);
472 /* Is there a reason this is being done twice? It happens both
473 places we use F_SETFL, so I'm inclined to think perhaps there
474 is some reason, however perverse. Perhaps not though... */
475 result = fcntl (0, F_SETFL, our_terminal_info.tflags);
476 result = fcntl (0, F_SETFL, our_terminal_info.tflags);
481 /* Per-inferior data key. */
482 static const struct inferior_data *inflow_inferior_data;
485 inflow_inferior_data_cleanup (struct inferior *inf, void *arg)
487 struct terminal_info *info;
489 info = inferior_data (inf, inflow_inferior_data);
492 xfree (info->run_terminal);
493 xfree (info->ttystate);
498 /* Get the current svr4 data. If none is found yet, add it now. This
499 function always returns a valid object. */
501 static struct terminal_info *
502 get_inflow_inferior_data (struct inferior *inf)
504 struct terminal_info *info;
506 info = inferior_data (inf, inflow_inferior_data);
509 info = XZALLOC (struct terminal_info);
510 set_inferior_data (inf, inflow_inferior_data, info);
516 /* This is a "inferior_exit" observer. Releases the TERMINAL_INFO member
517 of the inferior structure. This field is private to inflow.c, and
518 its type is opaque to the rest of GDB. PID is the target pid of
519 the inferior that is about to be removed from the inferior
523 inflow_inferior_exit (struct inferior *inf)
525 struct terminal_info *info;
527 info = inferior_data (inf, inflow_inferior_data);
530 xfree (info->run_terminal);
531 xfree (info->ttystate);
533 set_inferior_data (inf, inflow_inferior_data, NULL);
538 copy_terminal_info (struct inferior *to, struct inferior *from)
540 struct terminal_info *tinfo_to, *tinfo_from;
542 tinfo_to = get_inflow_inferior_data (to);
543 tinfo_from = get_inflow_inferior_data (from);
545 xfree (tinfo_to->run_terminal);
546 xfree (tinfo_to->ttystate);
548 *tinfo_to = *tinfo_from;
550 if (tinfo_from->run_terminal)
551 tinfo_to->run_terminal
552 = xstrdup (tinfo_from->run_terminal);
554 if (tinfo_from->ttystate)
556 = serial_copy_tty_state (stdin_serial, tinfo_from->ttystate);
560 term_info (char *arg, int from_tty)
562 target_terminal_info (arg, from_tty);
566 child_terminal_info (char *args, int from_tty)
568 struct inferior *inf;
569 struct terminal_info *tinfo;
571 if (!gdb_has_a_terminal ())
573 printf_filtered (_("This GDB does not control a terminal.\n"));
577 if (ptid_equal (inferior_ptid, null_ptid))
580 inf = current_inferior ();
581 tinfo = get_inflow_inferior_data (inf);
583 printf_filtered (_("Inferior's terminal status "
584 "(currently saved by GDB):\n"));
586 /* First the fcntl flags. */
590 flags = tinfo->tflags;
592 printf_filtered ("File descriptor flags = ");
595 #define O_ACCMODE (O_RDONLY | O_WRONLY | O_RDWR)
597 /* (O_ACCMODE) parens are to avoid Ultrix header file bug. */
598 switch (flags & (O_ACCMODE))
601 printf_filtered ("O_RDONLY");
604 printf_filtered ("O_WRONLY");
607 printf_filtered ("O_RDWR");
610 flags &= ~(O_ACCMODE);
613 if (flags & O_NONBLOCK)
614 printf_filtered (" | O_NONBLOCK");
615 flags &= ~O_NONBLOCK;
618 #if defined (O_NDELAY)
619 /* If O_NDELAY and O_NONBLOCK are defined to the same thing, we will
620 print it as O_NONBLOCK, which is good cause that is what POSIX
621 has, and the flag will already be cleared by the time we get here. */
622 if (flags & O_NDELAY)
623 printf_filtered (" | O_NDELAY");
627 if (flags & O_APPEND)
628 printf_filtered (" | O_APPEND");
631 #if defined (O_BINARY)
632 if (flags & O_BINARY)
633 printf_filtered (" | O_BINARY");
638 printf_filtered (" | 0x%x", flags);
639 printf_filtered ("\n");
642 #ifdef PROCESS_GROUP_TYPE
643 printf_filtered ("Process group = %d\n", (int) tinfo->process_group);
646 serial_print_tty_state (stdin_serial, tinfo->ttystate, gdb_stdout);
649 /* NEW_TTY_PREFORK is called before forking a new child process,
650 so we can record the state of ttys in the child to be formed.
651 TTYNAME is null if we are to share the terminal with gdb;
652 or points to a string containing the name of the desired tty.
654 NEW_TTY is called in new child processes under Unix, which will
655 become debugger target processes. This actually switches to
656 the terminal specified in the NEW_TTY_PREFORK call. */
659 new_tty_prefork (const char *ttyname)
661 /* Save the name for later, for determining whether we and the child
662 are sharing a tty. */
663 inferior_thisrun_terminal = ttyname;
666 #if !defined(__GO32__) && !defined(_WIN32)
667 /* If RESULT, assumed to be the return value from a system call, is
668 negative, print the error message indicated by errno and exit.
669 MSG should identify the operation that failed. */
671 check_syscall (const char *msg, int result)
675 print_sys_errmsg (msg, errno);
686 if (inferior_thisrun_terminal == 0)
688 #if !defined(__GO32__) && !defined(_WIN32)
690 /* Disconnect the child process from our controlling terminal. On some
691 systems (SVR4 for example), this may cause a SIGTTOU, so temporarily
693 tty = open ("/dev/tty", O_RDWR);
698 osigttou = (void (*)()) signal (SIGTTOU, SIG_IGN);
699 ioctl (tty, TIOCNOTTY, 0);
701 signal (SIGTTOU, osigttou);
705 /* Now open the specified new terminal. */
706 tty = open (inferior_thisrun_terminal, O_RDWR | O_NOCTTY);
707 check_syscall (inferior_thisrun_terminal, tty);
709 /* Avoid use of dup2; doesn't exist on all systems. */
713 check_syscall ("dup'ing tty into fd 0", dup (tty));
718 check_syscall ("dup'ing tty into fd 1", dup (tty));
723 check_syscall ("dup'ing tty into fd 2", dup (tty));
727 /* Make tty our new controlling terminal. */
728 if (ioctl (tty, TIOCSCTTY, 0) == -1)
729 /* Mention GDB in warning because it will appear in the inferior's
730 terminal instead of GDB's. */
731 warning (_("GDB: Failed to set controlling terminal: %s"),
732 safe_strerror (errno));
737 #endif /* !go32 && !win32 */
740 /* NEW_TTY_POSTFORK is called after forking a new child process, and
741 adding it to the inferior table, to store the TTYNAME being used by
742 the child, or null if it sharing the terminal with gdb. */
745 new_tty_postfork (void)
747 /* Save the name for later, for determining whether we and the child
748 are sharing a tty. */
750 if (inferior_thisrun_terminal)
752 struct inferior *inf = current_inferior ();
753 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
755 tinfo->run_terminal = xstrdup (inferior_thisrun_terminal);
758 inferior_thisrun_terminal = NULL;
762 /* Call set_sigint_trap when you need to pass a signal on to an attached
763 process when handling SIGINT. */
766 pass_signal (int signo)
769 kill (PIDGET (inferior_ptid), SIGINT);
773 static void (*osig) ();
777 set_sigint_trap (void)
779 struct inferior *inf = current_inferior ();
780 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
782 if (inf->attach_flag || tinfo->run_terminal)
784 osig = (void (*)()) signal (SIGINT, pass_signal);
792 clear_sigint_trap (void)
796 signal (SIGINT, osig);
802 /* Create a new session if the inferior will run in a different tty.
803 A session is UNIX's way of grouping processes that share a controlling
804 terminal, so a new one is needed if the inferior terminal will be
805 different from GDB's.
807 Returns the session id of the new session, 0 if no session was created
808 or -1 if an error occurred. */
810 create_tty_session (void)
815 if (!job_control || inferior_thisrun_terminal == 0)
820 warning (_("Failed to create new terminal session: setsid: %s"),
821 safe_strerror (errno));
826 #endif /* HAVE_SETSID */
829 /* This is here because this is where we figure out whether we (probably)
830 have job control. Just using job_control only does part of it because
831 setpgid or setpgrp might not exist on a system without job control.
832 It might be considered misplaced (on the other hand, process groups and
833 job control are closely related to ttys).
835 For a more clean implementation, in libiberty, put a setpgid which merely
836 calls setpgrp and a setpgrp which does nothing (any system with job control
837 will have one or the other). */
845 #if defined (HAVE_TERMIOS) || defined (TIOCGPGRP)
847 /* The call setpgid (0, 0) is supposed to work and mean the same
848 thing as this, but on Ultrix 4.2A it fails with EPERM (and
849 setpgid (getpid (), getpid ()) succeeds). */
850 retval = setpgid (getpid (), getpid ());
856 retval = setpgrp (getpid (), getpid ());
858 #endif /* HAVE_SETPGRP */
859 #endif /* HAVE_SETPGID */
860 #endif /* defined (HAVE_TERMIOS) || defined (TIOCGPGRP) */
866 /* Get all the current tty settings (including whether we have a
867 tty at all!). We can't do this in _initialize_inflow because
868 serial_fdopen() won't work until the serial_ops_list is
869 initialized, but we don't want to do it lazily either, so
870 that we can guarantee stdin_serial is opened if there is
873 initialize_stdin_serial (void)
875 stdin_serial = serial_fdopen (0);
879 _initialize_inflow (void)
881 add_info ("terminal", term_info,
882 _("Print inferior's saved terminal status."));
884 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
885 &interactive_mode, _("\
886 Set whether GDB's standard input is a terminal."), _("\
887 Show whether GDB's standard input is a terminal."), _("\
888 If on, GDB assumes that standard input is a terminal. In practice, it\n\
889 means that GDB should wait for the user to answer queries associated to\n\
890 commands entered at the command prompt. If off, GDB assumes that standard\n\
891 input is not a terminal, and uses the default answer to all queries.\n\
892 If auto (the default), determine which mode to use based on the standard\n\
895 show_interactive_mode,
896 &setlist, &showlist);
898 terminal_is_ours = 1;
900 /* OK, figure out whether we have job control. If neither termios nor
901 sgtty (i.e. termio or go32), leave job_control 0. */
903 #if defined (HAVE_TERMIOS)
904 /* Do all systems with termios have the POSIX way of identifying job
905 control? I hope so. */
906 #ifdef _POSIX_JOB_CONTROL
909 #ifdef _SC_JOB_CONTROL
910 job_control = sysconf (_SC_JOB_CONTROL);
912 job_control = 0; /* Have to assume the worst. */
913 #endif /* _SC_JOB_CONTROL */
914 #endif /* _POSIX_JOB_CONTROL */
915 #endif /* HAVE_TERMIOS */
922 #endif /* TIOCGPGRP */
925 observer_attach_inferior_exit (inflow_inferior_exit);
928 = register_inferior_data_with_cleanup (inflow_inferior_data_cleanup);