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"
35 #include "job-control.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 child_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 set once, when GDB first starts, and then
80 whenever we enter/leave TUI mode (gdb_save_tty_state). The
81 settings of flags which readline saves and restores are
83 static struct terminal_info our_terminal_info;
85 /* Snapshot of the initial tty state taken during initialization of
86 GDB, before readline/ncurses have had a chance to change it. This
87 is used as the initial tty state given to each new spawned
88 inferior. Unlike our_terminal_info, this is only ever set
90 static serial_ttystate initial_gdb_ttystate;
92 static struct terminal_info *get_inflow_inferior_data (struct inferior *);
94 #ifdef PROCESS_GROUP_TYPE
96 /* Return the process group of the current inferior. */
99 inferior_process_group (void)
101 return get_inflow_inferior_data (current_inferior ())->process_group;
105 /* While the inferior is running, we want SIGINT and SIGQUIT to go to the
106 inferior only. If we have job control, that takes care of it. If not,
107 we save our handlers in these two variables and set SIGINT and SIGQUIT
110 static sighandler_t sigint_ours;
111 static sighandler_t sigquit_ours;
113 /* The name of the tty (from the `tty' command) that we're giving to
114 the inferior when starting it up. This is only (and should only
115 be) used as a transient global by new_tty_prefork,
116 create_tty_session, new_tty and new_tty_postfork, all called from
117 fork_inferior, while forking a new child. */
118 static const char *inferior_thisrun_terminal;
120 /* Nonzero if our terminal settings are in effect. Zero if the
121 inferior's settings are in effect. Ignored if !gdb_has_a_terminal
124 int terminal_is_ours;
126 #ifdef PROCESS_GROUP_TYPE
127 static PROCESS_GROUP_TYPE
130 int process_group = -1;
133 process_group = tcgetpgrp (0);
136 process_group = getpgrp ();
139 ioctl (0, TIOCGPGRP, &process_group);
141 return process_group;
145 /* See terminal.h. */
148 set_initial_gdb_ttystate (void)
150 /* Note we can't do any of this in _initialize_inflow because at
151 that point stdin_serial has not been created yet. */
153 initial_gdb_ttystate = serial_get_tty_state (stdin_serial);
155 if (initial_gdb_ttystate != NULL)
157 our_terminal_info.ttystate
158 = serial_copy_tty_state (stdin_serial, initial_gdb_ttystate);
160 our_terminal_info.tflags = fcntl (0, F_GETFL, 0);
162 #ifdef PROCESS_GROUP_TYPE
163 our_terminal_info.process_group = gdb_getpgrp ();
168 /* Does GDB have a terminal (on stdin)? */
171 gdb_has_a_terminal (void)
173 return initial_gdb_ttystate != NULL;
176 /* Macro for printing errors from ioctl operations */
178 #define OOPSY(what) \
180 fprintf_unfiltered(gdb_stderr, "[%s failed in terminal_inferior: %s]\n", \
181 what, safe_strerror (errno))
183 /* Initialize the terminal settings we record for the inferior,
184 before we actually run the inferior. */
187 child_terminal_init_with_pgrp (int pgrp)
189 struct inferior *inf = current_inferior ();
190 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
192 #ifdef PROCESS_GROUP_TYPE
193 /* Store the process group even without a terminal as it is used not
194 only to reset the tty foreground process group, but also to
195 interrupt the inferior. */
196 tinfo->process_group = pgrp;
199 if (gdb_has_a_terminal ())
201 xfree (tinfo->ttystate);
202 tinfo->ttystate = serial_copy_tty_state (stdin_serial,
203 initial_gdb_ttystate);
205 /* Make sure that next time we call terminal_inferior (which will be
206 before the program runs, as it needs to be), we install the new
208 terminal_is_ours = 1;
212 /* Save the terminal settings again. This is necessary for the TUI
213 when it switches to TUI or non-TUI mode; curses changes the terminal
214 and gdb must be able to restore it correctly. */
217 gdb_save_tty_state (void)
219 if (gdb_has_a_terminal ())
221 xfree (our_terminal_info.ttystate);
222 our_terminal_info.ttystate = serial_get_tty_state (stdin_serial);
227 child_terminal_init (struct target_ops *self)
229 #ifdef PROCESS_GROUP_TYPE
230 /* This is for Lynx, and should be cleaned up by having Lynx be a
231 separate debugging target with a version of target_terminal_init
232 which passes in the process group to a generic routine which does
233 all the work (and the non-threaded child_terminal_init can just
234 pass in inferior_ptid to the same routine). */
235 /* We assume INFERIOR_PID is also the child's process group. */
236 child_terminal_init_with_pgrp (ptid_get_pid (inferior_ptid));
237 #endif /* PROCESS_GROUP_TYPE */
240 /* Put the inferior's terminal settings into effect.
241 This is preparation for starting or resuming the inferior.
243 N.B. Targets that want to use this with async support must build that
244 support on top of this (e.g., the caller still needs to remove stdin
245 from the event loop). E.g., see linux_nat_terminal_inferior. */
248 child_terminal_inferior (struct target_ops *self)
250 struct inferior *inf;
251 struct terminal_info *tinfo;
253 if (!terminal_is_ours)
256 inf = current_inferior ();
257 tinfo = get_inflow_inferior_data (inf);
259 if (gdb_has_a_terminal ()
260 && tinfo->ttystate != NULL
261 && tinfo->run_terminal == NULL)
266 /* Is there a reason this is being done twice? It happens both
267 places we use F_SETFL, so I'm inclined to think perhaps there
268 is some reason, however perverse. Perhaps not though... */
269 result = fcntl (0, F_SETFL, tinfo->tflags);
270 result = fcntl (0, F_SETFL, tinfo->tflags);
271 OOPSY ("fcntl F_SETFL");
274 /* Because we were careful to not change in or out of raw mode in
275 terminal_ours, we will not change in our out of raw mode with
276 this call, so we don't flush any input. */
277 result = serial_set_tty_state (stdin_serial,
279 OOPSY ("setting tty state");
283 sigint_ours = signal (SIGINT, SIG_IGN);
285 sigquit_ours = signal (SIGQUIT, SIG_IGN);
289 /* If attach_flag is set, we don't know whether we are sharing a
290 terminal with the inferior or not. (attaching a process
291 without a terminal is one case where we do not; attaching a
292 process which we ran from the same shell as GDB via `&' is
293 one case where we do, I think (but perhaps this is not
294 `sharing' in the sense that we need to save and restore tty
295 state)). I don't know if there is any way to tell whether we
296 are sharing a terminal. So what we do is to go through all
297 the saving and restoring of the tty state, but ignore errors
298 setting the process group, which will happen if we are not
299 sharing a terminal). */
304 result = tcsetpgrp (0, tinfo->process_group);
305 if (!inf->attach_flag)
310 result = ioctl (0, TIOCSPGRP, &tinfo->process_group);
311 if (!inf->attach_flag)
317 terminal_is_ours = 0;
320 /* Put some of our terminal settings into effect,
321 enough to get proper results from our output,
322 but do not change into or out of RAW mode
323 so that no input is discarded.
325 After doing this, either terminal_ours or terminal_inferior
326 should be called to get back to a normal state of affairs.
328 N.B. The implementation is (currently) no different than
329 child_terminal_ours. See child_terminal_ours_1. */
332 child_terminal_ours_for_output (struct target_ops *self)
334 child_terminal_ours_1 (1);
337 /* Put our terminal settings into effect.
338 First record the inferior's terminal settings
339 so they can be restored properly later.
341 N.B. Targets that want to use this with async support must build that
342 support on top of this (e.g., the caller still needs to add stdin to the
343 event loop). E.g., see linux_nat_terminal_ours. */
346 child_terminal_ours (struct target_ops *self)
348 child_terminal_ours_1 (0);
351 /* output_only is not used, and should not be used unless we introduce
352 separate terminal_is_ours and terminal_is_ours_for_output
356 child_terminal_ours_1 (int output_only)
358 struct inferior *inf;
359 struct terminal_info *tinfo;
361 if (terminal_is_ours)
364 terminal_is_ours = 1;
366 /* Checking inferior->run_terminal is necessary so that
367 if GDB is running in the background, it won't block trying
368 to do the ioctl()'s below. Checking gdb_has_a_terminal
369 avoids attempting all the ioctl's when running in batch. */
371 inf = current_inferior ();
372 tinfo = get_inflow_inferior_data (inf);
374 if (tinfo->run_terminal != NULL || gdb_has_a_terminal () == 0)
379 /* Ignore this signal since it will happen when we try to set the
381 sighandler_t osigttou = NULL;
383 int result ATTRIBUTE_UNUSED;
387 osigttou = signal (SIGTTOU, SIG_IGN);
390 xfree (tinfo->ttystate);
391 tinfo->ttystate = serial_get_tty_state (stdin_serial);
393 #ifdef PROCESS_GROUP_TYPE
394 if (!inf->attach_flag)
395 /* If setpgrp failed in terminal_inferior, this would give us
396 our process group instead of the inferior's. See
397 terminal_inferior for details. */
398 tinfo->process_group = gdb_getpgrp ();
401 /* Here we used to set ICANON in our ttystate, but I believe this
402 was an artifact from before when we used readline. Readline sets
403 the tty state when it needs to.
404 FIXME-maybe: However, query() expects non-raw mode and doesn't
405 use readline. Maybe query should use readline (on the other hand,
406 this only matters for HAVE_SGTTY, not termio or termios, I think). */
408 /* Set tty state to our_ttystate. We don't change in our out of raw
409 mode, to avoid flushing input. We need to do the same thing
410 regardless of output_only, because we don't have separate
411 terminal_is_ours and terminal_is_ours_for_output flags. It's OK,
412 though, since readline will deal with raw mode when/if it needs
415 serial_noflush_set_tty_state (stdin_serial, our_terminal_info.ttystate,
421 result = tcsetpgrp (0, our_terminal_info.process_group);
423 /* This fails on Ultrix with EINVAL if you run the testsuite
424 in the background with nohup, and then log out. GDB never
425 used to check for an error here, so perhaps there are other
426 such situations as well. */
428 fprintf_unfiltered (gdb_stderr,
429 "[tcsetpgrp failed in child_terminal_ours: %s]\n",
430 safe_strerror (errno));
435 result = ioctl (0, TIOCSPGRP, &our_terminal_info.process_group);
441 signal (SIGTTOU, osigttou);
446 signal (SIGINT, sigint_ours);
448 signal (SIGQUIT, sigquit_ours);
453 tinfo->tflags = fcntl (0, F_GETFL, 0);
455 /* Is there a reason this is being done twice? It happens both
456 places we use F_SETFL, so I'm inclined to think perhaps there
457 is some reason, however perverse. Perhaps not though... */
458 result = fcntl (0, F_SETFL, our_terminal_info.tflags);
459 result = fcntl (0, F_SETFL, our_terminal_info.tflags);
464 /* Per-inferior data key. */
465 static const struct inferior_data *inflow_inferior_data;
468 inflow_inferior_data_cleanup (struct inferior *inf, void *arg)
470 struct terminal_info *info = (struct terminal_info *) arg;
472 xfree (info->run_terminal);
473 xfree (info->ttystate);
477 /* Get the current svr4 data. If none is found yet, add it now. This
478 function always returns a valid object. */
480 static struct terminal_info *
481 get_inflow_inferior_data (struct inferior *inf)
483 struct terminal_info *info;
485 info = (struct terminal_info *) inferior_data (inf, inflow_inferior_data);
488 info = XCNEW (struct terminal_info);
489 set_inferior_data (inf, inflow_inferior_data, info);
495 /* This is a "inferior_exit" observer. Releases the TERMINAL_INFO member
496 of the inferior structure. This field is private to inflow.c, and
497 its type is opaque to the rest of GDB. PID is the target pid of
498 the inferior that is about to be removed from the inferior
502 inflow_inferior_exit (struct inferior *inf)
504 struct terminal_info *info;
506 info = (struct terminal_info *) inferior_data (inf, inflow_inferior_data);
509 xfree (info->run_terminal);
510 xfree (info->ttystate);
512 set_inferior_data (inf, inflow_inferior_data, NULL);
517 copy_terminal_info (struct inferior *to, struct inferior *from)
519 struct terminal_info *tinfo_to, *tinfo_from;
521 tinfo_to = get_inflow_inferior_data (to);
522 tinfo_from = get_inflow_inferior_data (from);
524 xfree (tinfo_to->run_terminal);
525 xfree (tinfo_to->ttystate);
527 *tinfo_to = *tinfo_from;
529 if (tinfo_from->run_terminal)
530 tinfo_to->run_terminal
531 = xstrdup (tinfo_from->run_terminal);
533 if (tinfo_from->ttystate)
535 = serial_copy_tty_state (stdin_serial, tinfo_from->ttystate);
539 term_info (char *arg, int from_tty)
541 target_terminal_info (arg, from_tty);
545 child_terminal_info (struct target_ops *self, const char *args, int from_tty)
547 struct inferior *inf;
548 struct terminal_info *tinfo;
550 if (!gdb_has_a_terminal ())
552 printf_filtered (_("This GDB does not control a terminal.\n"));
556 if (ptid_equal (inferior_ptid, null_ptid))
559 inf = current_inferior ();
560 tinfo = get_inflow_inferior_data (inf);
562 printf_filtered (_("Inferior's terminal status "
563 "(currently saved by GDB):\n"));
565 /* First the fcntl flags. */
569 flags = tinfo->tflags;
571 printf_filtered ("File descriptor flags = ");
574 #define O_ACCMODE (O_RDONLY | O_WRONLY | O_RDWR)
576 /* (O_ACCMODE) parens are to avoid Ultrix header file bug. */
577 switch (flags & (O_ACCMODE))
580 printf_filtered ("O_RDONLY");
583 printf_filtered ("O_WRONLY");
586 printf_filtered ("O_RDWR");
589 flags &= ~(O_ACCMODE);
592 if (flags & O_NONBLOCK)
593 printf_filtered (" | O_NONBLOCK");
594 flags &= ~O_NONBLOCK;
597 #if defined (O_NDELAY)
598 /* If O_NDELAY and O_NONBLOCK are defined to the same thing, we will
599 print it as O_NONBLOCK, which is good cause that is what POSIX
600 has, and the flag will already be cleared by the time we get here. */
601 if (flags & O_NDELAY)
602 printf_filtered (" | O_NDELAY");
606 if (flags & O_APPEND)
607 printf_filtered (" | O_APPEND");
610 #if defined (O_BINARY)
611 if (flags & O_BINARY)
612 printf_filtered (" | O_BINARY");
617 printf_filtered (" | 0x%x", flags);
618 printf_filtered ("\n");
621 #ifdef PROCESS_GROUP_TYPE
622 printf_filtered ("Process group = %d\n", (int) tinfo->process_group);
625 serial_print_tty_state (stdin_serial, tinfo->ttystate, gdb_stdout);
628 /* NEW_TTY_PREFORK is called before forking a new child process,
629 so we can record the state of ttys in the child to be formed.
630 TTYNAME is null if we are to share the terminal with gdb;
631 or points to a string containing the name of the desired tty.
633 NEW_TTY is called in new child processes under Unix, which will
634 become debugger target processes. This actually switches to
635 the terminal specified in the NEW_TTY_PREFORK call. */
638 new_tty_prefork (const char *ttyname)
640 /* Save the name for later, for determining whether we and the child
641 are sharing a tty. */
642 inferior_thisrun_terminal = ttyname;
645 #if !defined(__GO32__) && !defined(_WIN32)
646 /* If RESULT, assumed to be the return value from a system call, is
647 negative, print the error message indicated by errno and exit.
648 MSG should identify the operation that failed. */
650 check_syscall (const char *msg, int result)
654 print_sys_errmsg (msg, errno);
665 if (inferior_thisrun_terminal == 0)
667 #if !defined(__GO32__) && !defined(_WIN32)
669 /* Disconnect the child process from our controlling terminal. On some
670 systems (SVR4 for example), this may cause a SIGTTOU, so temporarily
672 tty = open ("/dev/tty", O_RDWR);
675 sighandler_t osigttou;
677 osigttou = signal (SIGTTOU, SIG_IGN);
678 ioctl (tty, TIOCNOTTY, 0);
680 signal (SIGTTOU, osigttou);
684 /* Now open the specified new terminal. */
685 tty = open (inferior_thisrun_terminal, O_RDWR | O_NOCTTY);
686 check_syscall (inferior_thisrun_terminal, tty);
688 /* Avoid use of dup2; doesn't exist on all systems. */
692 check_syscall ("dup'ing tty into fd 0", dup (tty));
697 check_syscall ("dup'ing tty into fd 1", dup (tty));
702 check_syscall ("dup'ing tty into fd 2", dup (tty));
706 /* Make tty our new controlling terminal. */
707 if (ioctl (tty, TIOCSCTTY, 0) == -1)
708 /* Mention GDB in warning because it will appear in the inferior's
709 terminal instead of GDB's. */
710 warning (_("GDB: Failed to set controlling terminal: %s"),
711 safe_strerror (errno));
716 #endif /* !go32 && !win32 */
719 /* NEW_TTY_POSTFORK is called after forking a new child process, and
720 adding it to the inferior table, to store the TTYNAME being used by
721 the child, or null if it sharing the terminal with gdb. */
724 new_tty_postfork (void)
726 /* Save the name for later, for determining whether we and the child
727 are sharing a tty. */
729 if (inferior_thisrun_terminal)
731 struct inferior *inf = current_inferior ();
732 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
734 tinfo->run_terminal = xstrdup (inferior_thisrun_terminal);
737 inferior_thisrun_terminal = NULL;
741 /* Call set_sigint_trap when you need to pass a signal on to an attached
742 process when handling SIGINT. */
745 pass_signal (int signo)
748 kill (ptid_get_pid (inferior_ptid), SIGINT);
752 static sighandler_t osig;
756 set_sigint_trap (void)
758 struct inferior *inf = current_inferior ();
759 struct terminal_info *tinfo = get_inflow_inferior_data (inf);
761 if (inf->attach_flag || tinfo->run_terminal)
763 osig = signal (SIGINT, pass_signal);
771 clear_sigint_trap (void)
775 signal (SIGINT, osig);
781 /* Create a new session if the inferior will run in a different tty.
782 A session is UNIX's way of grouping processes that share a controlling
783 terminal, so a new one is needed if the inferior terminal will be
784 different from GDB's.
786 Returns the session id of the new session, 0 if no session was created
787 or -1 if an error occurred. */
789 create_tty_session (void)
794 if (!job_control || inferior_thisrun_terminal == 0)
799 warning (_("Failed to create new terminal session: setsid: %s"),
800 safe_strerror (errno));
805 #endif /* HAVE_SETSID */
808 /* Get all the current tty settings (including whether we have a
809 tty at all!). We can't do this in _initialize_inflow because
810 serial_fdopen() won't work until the serial_ops_list is
811 initialized, but we don't want to do it lazily either, so
812 that we can guarantee stdin_serial is opened if there is
815 initialize_stdin_serial (void)
817 stdin_serial = serial_fdopen (0);
821 _initialize_inflow (void)
823 add_info ("terminal", term_info,
824 _("Print inferior's saved terminal status."));
826 terminal_is_ours = 1;
828 /* OK, figure out whether we have job control. */
831 observer_attach_inferior_exit (inflow_inferior_exit);
834 = register_inferior_data_with_cleanup (NULL, inflow_inferior_data_cleanup);