1 /* Low level interface to ptrace, for GDB when running under Unix.
2 Copyright (C) 1986-2016 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"
30 #include "gdb_select.h"
35 #ifdef HAVE_SYS_IOCTL_H
36 #include <sys/ioctl.h>
43 extern void _initialize_inflow (void);
45 static void pass_signal (int);
47 static void child_terminal_ours_1 (int);
49 /* Record terminal status separately for debugger and inferior. */
51 static struct serial *stdin_serial;
53 /* Terminal related info we need to keep track of. Each inferior
54 holds an instance of this structure --- we save it whenever the
55 corresponding inferior stops, and restore it to the foreground
56 inferior when it resumes. */
59 /* The name of the tty (from the `tty' command) that we gave to the
60 inferior when it was started. */
63 /* TTY state. We save it whenever the inferior stops, and restore
64 it when it resumes. */
65 serial_ttystate ttystate;
67 #ifdef PROCESS_GROUP_TYPE
68 /* Process group. Saved and restored just like ttystate. */
69 PROCESS_GROUP_TYPE process_group;
72 /* fcntl flags. Saved and restored just like ttystate. */
76 /* Our own tty state, which we restore every time we need to deal with
77 the terminal. This is only set once, when GDB first starts. The
78 settings of flags which readline saves and restores and
80 static struct terminal_info our_terminal_info;
82 /* Snapshot of our own tty state taken during initialization of GDB.
83 This is used as the initial tty state given to each new inferior. */
84 static serial_ttystate initial_gdb_ttystate;
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 sighandler_t sigint_ours;
105 static sighandler_t 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;
139 enum gdb_has_a_terminal_flag_enum
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 /* Set the initial tty state that is to be inherited by new inferiors. */
166 set_initial_gdb_ttystate (void)
168 initial_gdb_ttystate = serial_get_tty_state (stdin_serial);
171 /* Does GDB have a terminal (on stdin)? */
173 gdb_has_a_terminal (void)
175 if (interactive_mode != AUTO_BOOLEAN_AUTO)
176 return interactive_mode == AUTO_BOOLEAN_TRUE;
178 switch (gdb_has_a_terminal_flag)
184 case have_not_checked:
185 /* Get all the current tty settings (including whether we have a
186 tty at all!). Can't do this in _initialize_inflow because
187 serial_fdopen() won't work until the serial_ops_list is
191 our_terminal_info.tflags = fcntl (0, F_GETFL, 0);
194 gdb_has_a_terminal_flag = no;
195 if (stdin_serial != NULL)
197 our_terminal_info.ttystate = serial_get_tty_state (stdin_serial);
199 if (our_terminal_info.ttystate != NULL)
201 gdb_has_a_terminal_flag = yes;
202 #ifdef PROCESS_GROUP_TYPE
203 our_terminal_info.process_group = gdb_getpgrp ();
208 return gdb_has_a_terminal_flag == yes;
210 /* "Can't happen". */
215 /* Macro for printing errors from ioctl operations */
217 #define OOPSY(what) \
219 fprintf_unfiltered(gdb_stderr, "[%s failed in terminal_inferior: %s]\n", \
220 what, safe_strerror (errno))
222 /* Initialize the terminal settings we record for the inferior,
223 before we actually run the inferior. */
226 child_terminal_init_with_pgrp (int pgrp)
228 struct inferior *inf = current_inferior ();
229 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
231 #ifdef PROCESS_GROUP_TYPE
232 /* Store the process group even without a terminal as it is used not
233 only to reset the tty foreground process group, but also to
234 interrupt the inferior. */
235 tinfo->process_group = pgrp;
238 if (gdb_has_a_terminal ())
240 xfree (tinfo->ttystate);
241 tinfo->ttystate = serial_copy_tty_state (stdin_serial,
242 initial_gdb_ttystate);
244 /* Make sure that next time we call terminal_inferior (which will be
245 before the program runs, as it needs to be), we install the new
247 terminal_is_ours = 1;
251 /* Save the terminal settings again. This is necessary for the TUI
252 when it switches to TUI or non-TUI mode; curses changes the terminal
253 and gdb must be able to restore it correctly. */
256 gdb_save_tty_state (void)
258 if (gdb_has_a_terminal ())
260 xfree (our_terminal_info.ttystate);
261 our_terminal_info.ttystate = serial_get_tty_state (stdin_serial);
266 child_terminal_init (struct target_ops *self)
268 #ifdef PROCESS_GROUP_TYPE
269 /* This is for Lynx, and should be cleaned up by having Lynx be a
270 separate debugging target with a version of target_terminal_init
271 which passes in the process group to a generic routine which does
272 all the work (and the non-threaded child_terminal_init can just
273 pass in inferior_ptid to the same routine). */
274 /* We assume INFERIOR_PID is also the child's process group. */
275 child_terminal_init_with_pgrp (ptid_get_pid (inferior_ptid));
276 #endif /* PROCESS_GROUP_TYPE */
279 /* Put the inferior's terminal settings into effect.
280 This is preparation for starting or resuming the inferior.
282 N.B. Targets that want to use this with async support must build that
283 support on top of this (e.g., the caller still needs to remove stdin
284 from the event loop). E.g., see linux_nat_terminal_inferior. */
287 child_terminal_inferior (struct target_ops *self)
289 struct inferior *inf;
290 struct terminal_info *tinfo;
292 if (!terminal_is_ours)
295 inf = current_inferior ();
296 tinfo = get_inflow_inferior_data (inf);
298 if (gdb_has_a_terminal ()
299 && tinfo->ttystate != NULL
300 && tinfo->run_terminal == NULL)
305 /* Is there a reason this is being done twice? It happens both
306 places we use F_SETFL, so I'm inclined to think perhaps there
307 is some reason, however perverse. Perhaps not though... */
308 result = fcntl (0, F_SETFL, tinfo->tflags);
309 result = fcntl (0, F_SETFL, tinfo->tflags);
310 OOPSY ("fcntl F_SETFL");
313 /* Because we were careful to not change in or out of raw mode in
314 terminal_ours, we will not change in our out of raw mode with
315 this call, so we don't flush any input. */
316 result = serial_set_tty_state (stdin_serial,
318 OOPSY ("setting tty state");
322 sigint_ours = signal (SIGINT, SIG_IGN);
324 sigquit_ours = signal (SIGQUIT, SIG_IGN);
328 /* If attach_flag is set, we don't know whether we are sharing a
329 terminal with the inferior or not. (attaching a process
330 without a terminal is one case where we do not; attaching a
331 process which we ran from the same shell as GDB via `&' is
332 one case where we do, I think (but perhaps this is not
333 `sharing' in the sense that we need to save and restore tty
334 state)). I don't know if there is any way to tell whether we
335 are sharing a terminal. So what we do is to go through all
336 the saving and restoring of the tty state, but ignore errors
337 setting the process group, which will happen if we are not
338 sharing a terminal). */
343 result = tcsetpgrp (0, tinfo->process_group);
344 if (!inf->attach_flag)
349 result = ioctl (0, TIOCSPGRP, &tinfo->process_group);
350 if (!inf->attach_flag)
356 terminal_is_ours = 0;
359 /* Put some of our terminal settings into effect,
360 enough to get proper results from our output,
361 but do not change into or out of RAW mode
362 so that no input is discarded.
364 After doing this, either terminal_ours or terminal_inferior
365 should be called to get back to a normal state of affairs.
367 N.B. The implementation is (currently) no different than
368 child_terminal_ours. See child_terminal_ours_1. */
371 child_terminal_ours_for_output (struct target_ops *self)
373 child_terminal_ours_1 (1);
376 /* Put our terminal settings into effect.
377 First record the inferior's terminal settings
378 so they can be restored properly later.
380 N.B. Targets that want to use this with async support must build that
381 support on top of this (e.g., the caller still needs to add stdin to the
382 event loop). E.g., see linux_nat_terminal_ours. */
385 child_terminal_ours (struct target_ops *self)
387 child_terminal_ours_1 (0);
390 /* output_only is not used, and should not be used unless we introduce
391 separate terminal_is_ours and terminal_is_ours_for_output
395 child_terminal_ours_1 (int output_only)
397 struct inferior *inf;
398 struct terminal_info *tinfo;
400 if (terminal_is_ours)
403 terminal_is_ours = 1;
405 /* Checking inferior->run_terminal is necessary so that
406 if GDB is running in the background, it won't block trying
407 to do the ioctl()'s below. Checking gdb_has_a_terminal
408 avoids attempting all the ioctl's when running in batch. */
410 inf = current_inferior ();
411 tinfo = get_inflow_inferior_data (inf);
413 if (tinfo->run_terminal != NULL || gdb_has_a_terminal () == 0)
418 /* Ignore this signal since it will happen when we try to set the
420 sighandler_t osigttou = NULL;
426 osigttou = signal (SIGTTOU, SIG_IGN);
429 xfree (tinfo->ttystate);
430 tinfo->ttystate = serial_get_tty_state (stdin_serial);
432 #ifdef PROCESS_GROUP_TYPE
433 if (!inf->attach_flag)
434 /* If setpgrp failed in terminal_inferior, this would give us
435 our process group instead of the inferior's. See
436 terminal_inferior for details. */
437 tinfo->process_group = gdb_getpgrp ();
440 /* Here we used to set ICANON in our ttystate, but I believe this
441 was an artifact from before when we used readline. Readline sets
442 the tty state when it needs to.
443 FIXME-maybe: However, query() expects non-raw mode and doesn't
444 use readline. Maybe query should use readline (on the other hand,
445 this only matters for HAVE_SGTTY, not termio or termios, I think). */
447 /* Set tty state to our_ttystate. We don't change in our out of raw
448 mode, to avoid flushing input. We need to do the same thing
449 regardless of output_only, because we don't have separate
450 terminal_is_ours and terminal_is_ours_for_output flags. It's OK,
451 though, since readline will deal with raw mode when/if it needs
454 serial_noflush_set_tty_state (stdin_serial, our_terminal_info.ttystate,
460 result = tcsetpgrp (0, our_terminal_info.process_group);
462 /* This fails on Ultrix with EINVAL if you run the testsuite
463 in the background with nohup, and then log out. GDB never
464 used to check for an error here, so perhaps there are other
465 such situations as well. */
467 fprintf_unfiltered (gdb_stderr,
468 "[tcsetpgrp failed in child_terminal_ours: %s]\n",
469 safe_strerror (errno));
474 result = ioctl (0, TIOCSPGRP, &our_terminal_info.process_group);
480 signal (SIGTTOU, osigttou);
485 signal (SIGINT, sigint_ours);
487 signal (SIGQUIT, sigquit_ours);
492 tinfo->tflags = fcntl (0, F_GETFL, 0);
494 /* Is there a reason this is being done twice? It happens both
495 places we use F_SETFL, so I'm inclined to think perhaps there
496 is some reason, however perverse. Perhaps not though... */
497 result = fcntl (0, F_SETFL, our_terminal_info.tflags);
498 result = fcntl (0, F_SETFL, our_terminal_info.tflags);
503 /* Per-inferior data key. */
504 static const struct inferior_data *inflow_inferior_data;
507 inflow_inferior_data_cleanup (struct inferior *inf, void *arg)
509 struct terminal_info *info = (struct terminal_info *) arg;
511 xfree (info->run_terminal);
512 xfree (info->ttystate);
516 /* Get the current svr4 data. If none is found yet, add it now. This
517 function always returns a valid object. */
519 static struct terminal_info *
520 get_inflow_inferior_data (struct inferior *inf)
522 struct terminal_info *info;
524 info = (struct terminal_info *) inferior_data (inf, inflow_inferior_data);
527 info = XCNEW (struct terminal_info);
528 set_inferior_data (inf, inflow_inferior_data, info);
534 /* This is a "inferior_exit" observer. Releases the TERMINAL_INFO member
535 of the inferior structure. This field is private to inflow.c, and
536 its type is opaque to the rest of GDB. PID is the target pid of
537 the inferior that is about to be removed from the inferior
541 inflow_inferior_exit (struct inferior *inf)
543 struct terminal_info *info;
545 info = (struct terminal_info *) inferior_data (inf, inflow_inferior_data);
548 xfree (info->run_terminal);
549 xfree (info->ttystate);
551 set_inferior_data (inf, inflow_inferior_data, NULL);
556 copy_terminal_info (struct inferior *to, struct inferior *from)
558 struct terminal_info *tinfo_to, *tinfo_from;
560 tinfo_to = get_inflow_inferior_data (to);
561 tinfo_from = get_inflow_inferior_data (from);
563 xfree (tinfo_to->run_terminal);
564 xfree (tinfo_to->ttystate);
566 *tinfo_to = *tinfo_from;
568 if (tinfo_from->run_terminal)
569 tinfo_to->run_terminal
570 = xstrdup (tinfo_from->run_terminal);
572 if (tinfo_from->ttystate)
574 = serial_copy_tty_state (stdin_serial, tinfo_from->ttystate);
578 term_info (char *arg, int from_tty)
580 target_terminal_info (arg, from_tty);
584 child_terminal_info (struct target_ops *self, const char *args, int from_tty)
586 struct inferior *inf;
587 struct terminal_info *tinfo;
589 if (!gdb_has_a_terminal ())
591 printf_filtered (_("This GDB does not control a terminal.\n"));
595 if (ptid_equal (inferior_ptid, null_ptid))
598 inf = current_inferior ();
599 tinfo = get_inflow_inferior_data (inf);
601 printf_filtered (_("Inferior's terminal status "
602 "(currently saved by GDB):\n"));
604 /* First the fcntl flags. */
608 flags = tinfo->tflags;
610 printf_filtered ("File descriptor flags = ");
613 #define O_ACCMODE (O_RDONLY | O_WRONLY | O_RDWR)
615 /* (O_ACCMODE) parens are to avoid Ultrix header file bug. */
616 switch (flags & (O_ACCMODE))
619 printf_filtered ("O_RDONLY");
622 printf_filtered ("O_WRONLY");
625 printf_filtered ("O_RDWR");
628 flags &= ~(O_ACCMODE);
631 if (flags & O_NONBLOCK)
632 printf_filtered (" | O_NONBLOCK");
633 flags &= ~O_NONBLOCK;
636 #if defined (O_NDELAY)
637 /* If O_NDELAY and O_NONBLOCK are defined to the same thing, we will
638 print it as O_NONBLOCK, which is good cause that is what POSIX
639 has, and the flag will already be cleared by the time we get here. */
640 if (flags & O_NDELAY)
641 printf_filtered (" | O_NDELAY");
645 if (flags & O_APPEND)
646 printf_filtered (" | O_APPEND");
649 #if defined (O_BINARY)
650 if (flags & O_BINARY)
651 printf_filtered (" | O_BINARY");
656 printf_filtered (" | 0x%x", flags);
657 printf_filtered ("\n");
660 #ifdef PROCESS_GROUP_TYPE
661 printf_filtered ("Process group = %d\n", (int) tinfo->process_group);
664 serial_print_tty_state (stdin_serial, tinfo->ttystate, gdb_stdout);
667 /* NEW_TTY_PREFORK is called before forking a new child process,
668 so we can record the state of ttys in the child to be formed.
669 TTYNAME is null if we are to share the terminal with gdb;
670 or points to a string containing the name of the desired tty.
672 NEW_TTY is called in new child processes under Unix, which will
673 become debugger target processes. This actually switches to
674 the terminal specified in the NEW_TTY_PREFORK call. */
677 new_tty_prefork (const char *ttyname)
679 /* Save the name for later, for determining whether we and the child
680 are sharing a tty. */
681 inferior_thisrun_terminal = ttyname;
684 #if !defined(__GO32__) && !defined(_WIN32)
685 /* If RESULT, assumed to be the return value from a system call, is
686 negative, print the error message indicated by errno and exit.
687 MSG should identify the operation that failed. */
689 check_syscall (const char *msg, int result)
693 print_sys_errmsg (msg, errno);
704 if (inferior_thisrun_terminal == 0)
706 #if !defined(__GO32__) && !defined(_WIN32)
708 /* Disconnect the child process from our controlling terminal. On some
709 systems (SVR4 for example), this may cause a SIGTTOU, so temporarily
711 tty = open ("/dev/tty", O_RDWR);
714 sighandler_t osigttou;
716 osigttou = signal (SIGTTOU, SIG_IGN);
717 ioctl (tty, TIOCNOTTY, 0);
719 signal (SIGTTOU, osigttou);
723 /* Now open the specified new terminal. */
724 tty = open (inferior_thisrun_terminal, O_RDWR | O_NOCTTY);
725 check_syscall (inferior_thisrun_terminal, tty);
727 /* Avoid use of dup2; doesn't exist on all systems. */
731 check_syscall ("dup'ing tty into fd 0", dup (tty));
736 check_syscall ("dup'ing tty into fd 1", dup (tty));
741 check_syscall ("dup'ing tty into fd 2", dup (tty));
745 /* Make tty our new controlling terminal. */
746 if (ioctl (tty, TIOCSCTTY, 0) == -1)
747 /* Mention GDB in warning because it will appear in the inferior's
748 terminal instead of GDB's. */
749 warning (_("GDB: Failed to set controlling terminal: %s"),
750 safe_strerror (errno));
755 #endif /* !go32 && !win32 */
758 /* NEW_TTY_POSTFORK is called after forking a new child process, and
759 adding it to the inferior table, to store the TTYNAME being used by
760 the child, or null if it sharing the terminal with gdb. */
763 new_tty_postfork (void)
765 /* Save the name for later, for determining whether we and the child
766 are sharing a tty. */
768 if (inferior_thisrun_terminal)
770 struct inferior *inf = current_inferior ();
771 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
773 tinfo->run_terminal = xstrdup (inferior_thisrun_terminal);
776 inferior_thisrun_terminal = NULL;
780 /* Call set_sigint_trap when you need to pass a signal on to an attached
781 process when handling SIGINT. */
784 pass_signal (int signo)
787 kill (ptid_get_pid (inferior_ptid), SIGINT);
791 static sighandler_t osig;
795 set_sigint_trap (void)
797 struct inferior *inf = current_inferior ();
798 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
800 if (inf->attach_flag || tinfo->run_terminal)
802 osig = signal (SIGINT, pass_signal);
810 clear_sigint_trap (void)
814 signal (SIGINT, osig);
820 /* Create a new session if the inferior will run in a different tty.
821 A session is UNIX's way of grouping processes that share a controlling
822 terminal, so a new one is needed if the inferior terminal will be
823 different from GDB's.
825 Returns the session id of the new session, 0 if no session was created
826 or -1 if an error occurred. */
828 create_tty_session (void)
833 if (!job_control || inferior_thisrun_terminal == 0)
838 warning (_("Failed to create new terminal session: setsid: %s"),
839 safe_strerror (errno));
844 #endif /* HAVE_SETSID */
847 /* This is here because this is where we figure out whether we (probably)
848 have job control. Just using job_control only does part of it because
849 setpgid or setpgrp might not exist on a system without job control.
850 It might be considered misplaced (on the other hand, process groups and
851 job control are closely related to ttys).
853 For a more clean implementation, in libiberty, put a setpgid which merely
854 calls setpgrp and a setpgrp which does nothing (any system with job control
855 will have one or the other). */
863 #if defined (HAVE_TERMIOS) || defined (TIOCGPGRP)
865 /* The call setpgid (0, 0) is supposed to work and mean the same
866 thing as this, but on Ultrix 4.2A it fails with EPERM (and
867 setpgid (getpid (), getpid ()) succeeds). */
868 retval = setpgid (getpid (), getpid ());
874 retval = setpgrp (getpid (), getpid ());
876 #endif /* HAVE_SETPGRP */
877 #endif /* HAVE_SETPGID */
878 #endif /* defined (HAVE_TERMIOS) || defined (TIOCGPGRP) */
884 /* Get all the current tty settings (including whether we have a
885 tty at all!). We can't do this in _initialize_inflow because
886 serial_fdopen() won't work until the serial_ops_list is
887 initialized, but we don't want to do it lazily either, so
888 that we can guarantee stdin_serial is opened if there is
891 initialize_stdin_serial (void)
893 stdin_serial = serial_fdopen (0);
897 _initialize_inflow (void)
899 add_info ("terminal", term_info,
900 _("Print inferior's saved terminal status."));
902 add_setshow_auto_boolean_cmd ("interactive-mode", class_support,
903 &interactive_mode, _("\
904 Set whether GDB's standard input is a terminal."), _("\
905 Show whether GDB's standard input is a terminal."), _("\
906 If on, GDB assumes that standard input is a terminal. In practice, it\n\
907 means that GDB should wait for the user to answer queries associated to\n\
908 commands entered at the command prompt. If off, GDB assumes that standard\n\
909 input is not a terminal, and uses the default answer to all queries.\n\
910 If auto (the default), determine which mode to use based on the standard\n\
913 show_interactive_mode,
914 &setlist, &showlist);
916 terminal_is_ours = 1;
918 /* OK, figure out whether we have job control. If neither termios nor
919 sgtty (i.e. termio or go32), leave job_control 0. */
921 #if defined (HAVE_TERMIOS)
922 /* Do all systems with termios have the POSIX way of identifying job
923 control? I hope so. */
924 #ifdef _POSIX_JOB_CONTROL
927 #ifdef _SC_JOB_CONTROL
928 job_control = sysconf (_SC_JOB_CONTROL);
930 job_control = 0; /* Have to assume the worst. */
931 #endif /* _SC_JOB_CONTROL */
932 #endif /* _POSIX_JOB_CONTROL */
933 #endif /* HAVE_TERMIOS */
940 #endif /* TIOCGPGRP */
943 observer_attach_inferior_exit (inflow_inferior_exit);
946 = register_inferior_data_with_cleanup (NULL, inflow_inferior_data_cleanup);