1 /* Low level interface to ptrace, for GDB when running under Unix.
2 Copyright (C) 1986-2017 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"
34 #include "gdb_termios.h"
36 #ifdef HAVE_SYS_IOCTL_H
37 #include <sys/ioctl.h>
44 extern void _initialize_inflow (void);
46 static void pass_signal (int);
48 static void child_terminal_ours_1 (int);
50 /* Record terminal status separately for debugger and inferior. */
52 static struct serial
*stdin_serial
;
54 /* Terminal related info we need to keep track of. Each inferior
55 holds an instance of this structure --- we save it whenever the
56 corresponding inferior stops, and restore it to the foreground
57 inferior when it resumes. */
60 /* The name of the tty (from the `tty' command) that we gave to the
61 inferior when it was started. */
64 /* TTY state. We save it whenever the inferior stops, and restore
65 it when it resumes. */
66 serial_ttystate ttystate
;
68 #ifdef PROCESS_GROUP_TYPE
69 /* Process group. Saved and restored just like ttystate. */
70 PROCESS_GROUP_TYPE process_group
;
73 /* fcntl flags. Saved and restored just like ttystate. */
77 /* Our own tty state, which we restore every time we need to deal with
78 the terminal. This is set once, when GDB first starts, and then
79 whenever we enter/leave TUI mode (gdb_save_tty_state). The
80 settings of flags which readline saves and restores are
82 static struct terminal_info our_terminal_info
;
84 /* Snapshot of the initial tty state taken during initialization of
85 GDB, before readline/ncurses have had a chance to change it. This
86 is used as the initial tty state given to each new spawned
87 inferior. Unlike our_terminal_info, this is only ever set
89 static serial_ttystate initial_gdb_ttystate
;
91 static struct terminal_info
*get_inflow_inferior_data (struct inferior
*);
93 #ifdef PROCESS_GROUP_TYPE
95 /* Return the process group of the current inferior. */
98 inferior_process_group (void)
100 return get_inflow_inferior_data (current_inferior ())->process_group
;
104 /* While the inferior is running, we want SIGINT and SIGQUIT to go to the
105 inferior only. If we have job control, that takes care of it. If not,
106 we save our handlers in these two variables and set SIGINT and SIGQUIT
109 static sighandler_t sigint_ours
;
110 static sighandler_t sigquit_ours
;
112 /* The name of the tty (from the `tty' command) that we're giving to
113 the inferior when starting it up. This is only (and should only
114 be) used as a transient global by new_tty_prefork,
115 create_tty_session, new_tty and new_tty_postfork, all called from
116 fork_inferior, while forking a new child. */
117 static const char *inferior_thisrun_terminal
;
119 /* Nonzero if our terminal settings are in effect. Zero if the
120 inferior's settings are in effect. Ignored if !gdb_has_a_terminal
123 int terminal_is_ours
;
125 #ifdef PROCESS_GROUP_TYPE
126 static PROCESS_GROUP_TYPE
129 int process_group
= -1;
132 process_group
= tcgetpgrp (0);
135 process_group
= getpgrp ();
138 ioctl (0, TIOCGPGRP
, &process_group
);
140 return process_group
;
144 /* See terminal.h. */
147 set_initial_gdb_ttystate (void)
149 /* Note we can't do any of this in _initialize_inflow because at
150 that point stdin_serial has not been created yet. */
152 initial_gdb_ttystate
= serial_get_tty_state (stdin_serial
);
154 if (initial_gdb_ttystate
!= NULL
)
156 our_terminal_info
.ttystate
157 = serial_copy_tty_state (stdin_serial
, initial_gdb_ttystate
);
159 our_terminal_info
.tflags
= fcntl (0, F_GETFL
, 0);
161 #ifdef PROCESS_GROUP_TYPE
162 our_terminal_info
.process_group
= gdb_getpgrp ();
167 /* Does GDB have a terminal (on stdin)? */
170 gdb_has_a_terminal (void)
172 return initial_gdb_ttystate
!= NULL
;
175 /* Macro for printing errors from ioctl operations */
177 #define OOPSY(what) \
179 fprintf_unfiltered(gdb_stderr, "[%s failed in terminal_inferior: %s]\n", \
180 what, safe_strerror (errno))
182 /* Initialize the terminal settings we record for the inferior,
183 before we actually run the inferior. */
186 child_terminal_init_with_pgrp (int pgrp
)
188 struct inferior
*inf
= current_inferior ();
189 struct terminal_info
*tinfo
= get_inflow_inferior_data (inf
);
191 #ifdef PROCESS_GROUP_TYPE
192 /* Store the process group even without a terminal as it is used not
193 only to reset the tty foreground process group, but also to
194 interrupt the inferior. */
195 tinfo
->process_group
= pgrp
;
198 if (gdb_has_a_terminal ())
200 xfree (tinfo
->ttystate
);
201 tinfo
->ttystate
= serial_copy_tty_state (stdin_serial
,
202 initial_gdb_ttystate
);
204 /* Make sure that next time we call terminal_inferior (which will be
205 before the program runs, as it needs to be), we install the new
207 terminal_is_ours
= 1;
211 /* Save the terminal settings again. This is necessary for the TUI
212 when it switches to TUI or non-TUI mode; curses changes the terminal
213 and gdb must be able to restore it correctly. */
216 gdb_save_tty_state (void)
218 if (gdb_has_a_terminal ())
220 xfree (our_terminal_info
.ttystate
);
221 our_terminal_info
.ttystate
= serial_get_tty_state (stdin_serial
);
226 child_terminal_init (struct target_ops
*self
)
228 #ifdef PROCESS_GROUP_TYPE
229 /* This is for Lynx, and should be cleaned up by having Lynx be a
230 separate debugging target with a version of target_terminal_init
231 which passes in the process group to a generic routine which does
232 all the work (and the non-threaded child_terminal_init can just
233 pass in inferior_ptid to the same routine). */
234 /* We assume INFERIOR_PID is also the child's process group. */
235 child_terminal_init_with_pgrp (ptid_get_pid (inferior_ptid
));
236 #endif /* PROCESS_GROUP_TYPE */
239 /* Put the inferior's terminal settings into effect.
240 This is preparation for starting or resuming the inferior.
242 N.B. Targets that want to use this with async support must build that
243 support on top of this (e.g., the caller still needs to remove stdin
244 from the event loop). E.g., see linux_nat_terminal_inferior. */
247 child_terminal_inferior (struct target_ops
*self
)
249 struct inferior
*inf
;
250 struct terminal_info
*tinfo
;
252 if (!terminal_is_ours
)
255 inf
= current_inferior ();
256 tinfo
= get_inflow_inferior_data (inf
);
258 if (gdb_has_a_terminal ()
259 && tinfo
->ttystate
!= NULL
260 && tinfo
->run_terminal
== NULL
)
265 /* Is there a reason this is being done twice? It happens both
266 places we use F_SETFL, so I'm inclined to think perhaps there
267 is some reason, however perverse. Perhaps not though... */
268 result
= fcntl (0, F_SETFL
, tinfo
->tflags
);
269 result
= fcntl (0, F_SETFL
, tinfo
->tflags
);
270 OOPSY ("fcntl F_SETFL");
273 /* Because we were careful to not change in or out of raw mode in
274 terminal_ours, we will not change in our out of raw mode with
275 this call, so we don't flush any input. */
276 result
= serial_set_tty_state (stdin_serial
,
278 OOPSY ("setting tty state");
282 sigint_ours
= signal (SIGINT
, SIG_IGN
);
284 sigquit_ours
= signal (SIGQUIT
, SIG_IGN
);
288 /* If attach_flag is set, we don't know whether we are sharing a
289 terminal with the inferior or not. (attaching a process
290 without a terminal is one case where we do not; attaching a
291 process which we ran from the same shell as GDB via `&' is
292 one case where we do, I think (but perhaps this is not
293 `sharing' in the sense that we need to save and restore tty
294 state)). I don't know if there is any way to tell whether we
295 are sharing a terminal. So what we do is to go through all
296 the saving and restoring of the tty state, but ignore errors
297 setting the process group, which will happen if we are not
298 sharing a terminal). */
303 result
= tcsetpgrp (0, tinfo
->process_group
);
304 if (!inf
->attach_flag
)
309 result
= ioctl (0, TIOCSPGRP
, &tinfo
->process_group
);
310 if (!inf
->attach_flag
)
316 terminal_is_ours
= 0;
319 /* Put some of our terminal settings into effect,
320 enough to get proper results from our output,
321 but do not change into or out of RAW mode
322 so that no input is discarded.
324 After doing this, either terminal_ours or terminal_inferior
325 should be called to get back to a normal state of affairs.
327 N.B. The implementation is (currently) no different than
328 child_terminal_ours. See child_terminal_ours_1. */
331 child_terminal_ours_for_output (struct target_ops
*self
)
333 child_terminal_ours_1 (1);
336 /* Put our terminal settings into effect.
337 First record the inferior's terminal settings
338 so they can be restored properly later.
340 N.B. Targets that want to use this with async support must build that
341 support on top of this (e.g., the caller still needs to add stdin to the
342 event loop). E.g., see linux_nat_terminal_ours. */
345 child_terminal_ours (struct target_ops
*self
)
347 child_terminal_ours_1 (0);
350 /* output_only is not used, and should not be used unless we introduce
351 separate terminal_is_ours and terminal_is_ours_for_output
355 child_terminal_ours_1 (int output_only
)
357 struct inferior
*inf
;
358 struct terminal_info
*tinfo
;
360 if (terminal_is_ours
)
363 terminal_is_ours
= 1;
365 /* Checking inferior->run_terminal is necessary so that
366 if GDB is running in the background, it won't block trying
367 to do the ioctl()'s below. Checking gdb_has_a_terminal
368 avoids attempting all the ioctl's when running in batch. */
370 inf
= current_inferior ();
371 tinfo
= get_inflow_inferior_data (inf
);
373 if (tinfo
->run_terminal
!= NULL
|| gdb_has_a_terminal () == 0)
378 /* Ignore this signal since it will happen when we try to set the
380 sighandler_t osigttou
= NULL
;
382 int result ATTRIBUTE_UNUSED
;
386 osigttou
= signal (SIGTTOU
, SIG_IGN
);
389 xfree (tinfo
->ttystate
);
390 tinfo
->ttystate
= serial_get_tty_state (stdin_serial
);
392 #ifdef PROCESS_GROUP_TYPE
393 if (!inf
->attach_flag
)
394 /* If setpgrp failed in terminal_inferior, this would give us
395 our process group instead of the inferior's. See
396 terminal_inferior for details. */
397 tinfo
->process_group
= gdb_getpgrp ();
400 /* Here we used to set ICANON in our ttystate, but I believe this
401 was an artifact from before when we used readline. Readline sets
402 the tty state when it needs to.
403 FIXME-maybe: However, query() expects non-raw mode and doesn't
404 use readline. Maybe query should use readline (on the other hand,
405 this only matters for HAVE_SGTTY, not termio or termios, I think). */
407 /* Set tty state to our_ttystate. We don't change in our out of raw
408 mode, to avoid flushing input. We need to do the same thing
409 regardless of output_only, because we don't have separate
410 terminal_is_ours and terminal_is_ours_for_output flags. It's OK,
411 though, since readline will deal with raw mode when/if it needs
414 serial_noflush_set_tty_state (stdin_serial
, our_terminal_info
.ttystate
,
420 result
= tcsetpgrp (0, our_terminal_info
.process_group
);
422 /* This fails on Ultrix with EINVAL if you run the testsuite
423 in the background with nohup, and then log out. GDB never
424 used to check for an error here, so perhaps there are other
425 such situations as well. */
427 fprintf_unfiltered (gdb_stderr
,
428 "[tcsetpgrp failed in child_terminal_ours: %s]\n",
429 safe_strerror (errno
));
434 result
= ioctl (0, TIOCSPGRP
, &our_terminal_info
.process_group
);
440 signal (SIGTTOU
, osigttou
);
445 signal (SIGINT
, sigint_ours
);
447 signal (SIGQUIT
, sigquit_ours
);
452 tinfo
->tflags
= fcntl (0, F_GETFL
, 0);
454 /* Is there a reason this is being done twice? It happens both
455 places we use F_SETFL, so I'm inclined to think perhaps there
456 is some reason, however perverse. Perhaps not though... */
457 result
= fcntl (0, F_SETFL
, our_terminal_info
.tflags
);
458 result
= fcntl (0, F_SETFL
, our_terminal_info
.tflags
);
463 /* Per-inferior data key. */
464 static const struct inferior_data
*inflow_inferior_data
;
467 inflow_inferior_data_cleanup (struct inferior
*inf
, void *arg
)
469 struct terminal_info
*info
= (struct terminal_info
*) arg
;
471 xfree (info
->run_terminal
);
472 xfree (info
->ttystate
);
476 /* Get the current svr4 data. If none is found yet, add it now. This
477 function always returns a valid object. */
479 static struct terminal_info
*
480 get_inflow_inferior_data (struct inferior
*inf
)
482 struct terminal_info
*info
;
484 info
= (struct terminal_info
*) inferior_data (inf
, inflow_inferior_data
);
487 info
= XCNEW (struct terminal_info
);
488 set_inferior_data (inf
, inflow_inferior_data
, info
);
494 /* This is a "inferior_exit" observer. Releases the TERMINAL_INFO member
495 of the inferior structure. This field is private to inflow.c, and
496 its type is opaque to the rest of GDB. PID is the target pid of
497 the inferior that is about to be removed from the inferior
501 inflow_inferior_exit (struct inferior
*inf
)
503 struct terminal_info
*info
;
505 info
= (struct terminal_info
*) inferior_data (inf
, inflow_inferior_data
);
508 xfree (info
->run_terminal
);
509 xfree (info
->ttystate
);
511 set_inferior_data (inf
, inflow_inferior_data
, NULL
);
516 copy_terminal_info (struct inferior
*to
, struct inferior
*from
)
518 struct terminal_info
*tinfo_to
, *tinfo_from
;
520 tinfo_to
= get_inflow_inferior_data (to
);
521 tinfo_from
= get_inflow_inferior_data (from
);
523 xfree (tinfo_to
->run_terminal
);
524 xfree (tinfo_to
->ttystate
);
526 *tinfo_to
= *tinfo_from
;
528 if (tinfo_from
->run_terminal
)
529 tinfo_to
->run_terminal
530 = xstrdup (tinfo_from
->run_terminal
);
532 if (tinfo_from
->ttystate
)
534 = serial_copy_tty_state (stdin_serial
, tinfo_from
->ttystate
);
538 term_info (char *arg
, int from_tty
)
540 target_terminal_info (arg
, from_tty
);
544 child_terminal_info (struct target_ops
*self
, const char *args
, int from_tty
)
546 struct inferior
*inf
;
547 struct terminal_info
*tinfo
;
549 if (!gdb_has_a_terminal ())
551 printf_filtered (_("This GDB does not control a terminal.\n"));
555 if (ptid_equal (inferior_ptid
, null_ptid
))
558 inf
= current_inferior ();
559 tinfo
= get_inflow_inferior_data (inf
);
561 printf_filtered (_("Inferior's terminal status "
562 "(currently saved by GDB):\n"));
564 /* First the fcntl flags. */
568 flags
= tinfo
->tflags
;
570 printf_filtered ("File descriptor flags = ");
573 #define O_ACCMODE (O_RDONLY | O_WRONLY | O_RDWR)
575 /* (O_ACCMODE) parens are to avoid Ultrix header file bug. */
576 switch (flags
& (O_ACCMODE
))
579 printf_filtered ("O_RDONLY");
582 printf_filtered ("O_WRONLY");
585 printf_filtered ("O_RDWR");
588 flags
&= ~(O_ACCMODE
);
591 if (flags
& O_NONBLOCK
)
592 printf_filtered (" | O_NONBLOCK");
593 flags
&= ~O_NONBLOCK
;
596 #if defined (O_NDELAY)
597 /* If O_NDELAY and O_NONBLOCK are defined to the same thing, we will
598 print it as O_NONBLOCK, which is good cause that is what POSIX
599 has, and the flag will already be cleared by the time we get here. */
600 if (flags
& O_NDELAY
)
601 printf_filtered (" | O_NDELAY");
605 if (flags
& O_APPEND
)
606 printf_filtered (" | O_APPEND");
609 #if defined (O_BINARY)
610 if (flags
& O_BINARY
)
611 printf_filtered (" | O_BINARY");
616 printf_filtered (" | 0x%x", flags
);
617 printf_filtered ("\n");
620 #ifdef PROCESS_GROUP_TYPE
621 printf_filtered ("Process group = %d\n", (int) tinfo
->process_group
);
624 serial_print_tty_state (stdin_serial
, tinfo
->ttystate
, gdb_stdout
);
627 /* NEW_TTY_PREFORK is called before forking a new child process,
628 so we can record the state of ttys in the child to be formed.
629 TTYNAME is null if we are to share the terminal with gdb;
630 or points to a string containing the name of the desired tty.
632 NEW_TTY is called in new child processes under Unix, which will
633 become debugger target processes. This actually switches to
634 the terminal specified in the NEW_TTY_PREFORK call. */
637 new_tty_prefork (const char *ttyname
)
639 /* Save the name for later, for determining whether we and the child
640 are sharing a tty. */
641 inferior_thisrun_terminal
= ttyname
;
644 #if !defined(__GO32__) && !defined(_WIN32)
645 /* If RESULT, assumed to be the return value from a system call, is
646 negative, print the error message indicated by errno and exit.
647 MSG should identify the operation that failed. */
649 check_syscall (const char *msg
, int result
)
653 print_sys_errmsg (msg
, errno
);
664 if (inferior_thisrun_terminal
== 0)
666 #if !defined(__GO32__) && !defined(_WIN32)
668 /* Disconnect the child process from our controlling terminal. On some
669 systems (SVR4 for example), this may cause a SIGTTOU, so temporarily
671 tty
= open ("/dev/tty", O_RDWR
);
674 sighandler_t osigttou
;
676 osigttou
= signal (SIGTTOU
, SIG_IGN
);
677 ioctl (tty
, TIOCNOTTY
, 0);
679 signal (SIGTTOU
, osigttou
);
683 /* Now open the specified new terminal. */
684 tty
= open (inferior_thisrun_terminal
, O_RDWR
| O_NOCTTY
);
685 check_syscall (inferior_thisrun_terminal
, tty
);
687 /* Avoid use of dup2; doesn't exist on all systems. */
691 check_syscall ("dup'ing tty into fd 0", dup (tty
));
696 check_syscall ("dup'ing tty into fd 1", dup (tty
));
701 check_syscall ("dup'ing tty into fd 2", dup (tty
));
705 /* Make tty our new controlling terminal. */
706 if (ioctl (tty
, TIOCSCTTY
, 0) == -1)
707 /* Mention GDB in warning because it will appear in the inferior's
708 terminal instead of GDB's. */
709 warning (_("GDB: Failed to set controlling terminal: %s"),
710 safe_strerror (errno
));
715 #endif /* !go32 && !win32 */
718 /* NEW_TTY_POSTFORK is called after forking a new child process, and
719 adding it to the inferior table, to store the TTYNAME being used by
720 the child, or null if it sharing the terminal with gdb. */
723 new_tty_postfork (void)
725 /* Save the name for later, for determining whether we and the child
726 are sharing a tty. */
728 if (inferior_thisrun_terminal
)
730 struct inferior
*inf
= current_inferior ();
731 struct terminal_info
*tinfo
= get_inflow_inferior_data (inf
);
733 tinfo
->run_terminal
= xstrdup (inferior_thisrun_terminal
);
736 inferior_thisrun_terminal
= NULL
;
740 /* Call set_sigint_trap when you need to pass a signal on to an attached
741 process when handling SIGINT. */
744 pass_signal (int signo
)
747 kill (ptid_get_pid (inferior_ptid
), SIGINT
);
751 static sighandler_t osig
;
755 set_sigint_trap (void)
757 struct inferior
*inf
= current_inferior ();
758 struct terminal_info
*tinfo
= get_inflow_inferior_data (inf
);
760 if (inf
->attach_flag
|| tinfo
->run_terminal
)
762 osig
= signal (SIGINT
, pass_signal
);
770 clear_sigint_trap (void)
774 signal (SIGINT
, osig
);
780 /* Create a new session if the inferior will run in a different tty.
781 A session is UNIX's way of grouping processes that share a controlling
782 terminal, so a new one is needed if the inferior terminal will be
783 different from GDB's.
785 Returns the session id of the new session, 0 if no session was created
786 or -1 if an error occurred. */
788 create_tty_session (void)
793 if (!job_control
|| inferior_thisrun_terminal
== 0)
798 warning (_("Failed to create new terminal session: setsid: %s"),
799 safe_strerror (errno
));
804 #endif /* HAVE_SETSID */
807 /* This is here because this is where we figure out whether we (probably)
808 have job control. Just using job_control only does part of it because
809 setpgid or setpgrp might not exist on a system without job control.
810 It might be considered misplaced (on the other hand, process groups and
811 job control are closely related to ttys).
813 For a more clean implementation, in libiberty, put a setpgid which merely
814 calls setpgrp and a setpgrp which does nothing (any system with job control
815 will have one or the other). */
823 #if defined (HAVE_TERMIOS) || defined (TIOCGPGRP)
825 /* The call setpgid (0, 0) is supposed to work and mean the same
826 thing as this, but on Ultrix 4.2A it fails with EPERM (and
827 setpgid (getpid (), getpid ()) succeeds). */
828 retval
= setpgid (getpid (), getpid ());
834 retval
= setpgrp (getpid (), getpid ());
836 #endif /* HAVE_SETPGRP */
837 #endif /* HAVE_SETPGID */
838 #endif /* defined (HAVE_TERMIOS) || defined (TIOCGPGRP) */
844 /* Get all the current tty settings (including whether we have a
845 tty at all!). We can't do this in _initialize_inflow because
846 serial_fdopen() won't work until the serial_ops_list is
847 initialized, but we don't want to do it lazily either, so
848 that we can guarantee stdin_serial is opened if there is
851 initialize_stdin_serial (void)
853 stdin_serial
= serial_fdopen (0);
857 _initialize_inflow (void)
859 add_info ("terminal", term_info
,
860 _("Print inferior's saved terminal status."));
862 terminal_is_ours
= 1;
864 /* OK, figure out whether we have job control. If neither termios nor
865 sgtty (i.e. termio or go32), leave job_control 0. */
867 #if defined (HAVE_TERMIOS)
868 /* Do all systems with termios have the POSIX way of identifying job
869 control? I hope so. */
870 #ifdef _POSIX_JOB_CONTROL
873 #ifdef _SC_JOB_CONTROL
874 job_control
= sysconf (_SC_JOB_CONTROL
);
876 job_control
= 0; /* Have to assume the worst. */
877 #endif /* _SC_JOB_CONTROL */
878 #endif /* _POSIX_JOB_CONTROL */
879 #endif /* HAVE_TERMIOS */
886 #endif /* TIOCGPGRP */
889 observer_attach_inferior_exit (inflow_inferior_exit
);
892 = register_inferior_data_with_cleanup (NULL
, inflow_inferior_data_cleanup
);