1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
11 #include <sys/epoll.h>
12 #include <sys/ioctl.h>
19 #include "alloc-util.h"
20 #include "errno-util.h"
25 #include "terminal-util.h"
26 #include "time-util.h"
35 PTYForwardFlags flags
;
37 sd_event_source
*stdin_event_source
;
38 sd_event_source
*stdout_event_source
;
39 sd_event_source
*master_event_source
;
41 sd_event_source
*sigwinch_event_source
;
43 struct termios saved_stdin_attr
;
44 struct termios saved_stdout_attr
;
46 bool close_input_fd
:1;
47 bool close_output_fd
:1;
52 bool stdin_readable
:1;
54 bool stdout_writable
:1;
56 bool master_readable
:1;
57 bool master_writable
:1;
60 bool read_from_master
:1;
68 char in_buffer
[LINE_MAX
], out_buffer
[LINE_MAX
];
69 size_t in_buffer_full
, out_buffer_full
;
71 usec_t escape_timestamp
;
72 unsigned escape_counter
;
74 PTYForwardHandler handler
;
78 #define ESCAPE_USEC (1*USEC_PER_SEC)
80 static void pty_forward_disconnect(PTYForward
*f
) {
85 f
->stdin_event_source
= sd_event_source_unref(f
->stdin_event_source
);
86 f
->stdout_event_source
= sd_event_source_unref(f
->stdout_event_source
);
88 f
->master_event_source
= sd_event_source_unref(f
->master_event_source
);
89 f
->sigwinch_event_source
= sd_event_source_unref(f
->sigwinch_event_source
);
90 f
->event
= sd_event_unref(f
->event
);
92 if (f
->output_fd
>= 0) {
94 (void) tcsetattr(f
->output_fd
, TCSANOW
, &f
->saved_stdout_attr
);
96 /* STDIN/STDOUT should not be non-blocking normally, so let's reset it */
97 (void) fd_nonblock(f
->output_fd
, false);
98 if (f
->close_output_fd
)
99 f
->output_fd
= safe_close(f
->output_fd
);
102 if (f
->input_fd
>= 0) {
104 (void) tcsetattr(f
->input_fd
, TCSANOW
, &f
->saved_stdin_attr
);
106 (void) fd_nonblock(f
->input_fd
, false);
107 if (f
->close_input_fd
)
108 f
->input_fd
= safe_close(f
->input_fd
);
111 f
->saved_stdout
= f
->saved_stdin
= false;
114 static int pty_forward_done(PTYForward
*f
, int rcode
) {
115 _cleanup_(sd_event_unrefp
) sd_event
*e
= NULL
;
121 e
= sd_event_ref(f
->event
);
124 pty_forward_disconnect(f
);
127 return f
->handler(f
, rcode
, f
->userdata
);
129 return sd_event_exit(e
, rcode
< 0 ? EXIT_FAILURE
: rcode
);
132 static bool look_for_escape(PTYForward
*f
, const char *buffer
, size_t n
) {
139 for (p
= buffer
; p
< buffer
+ n
; p
++) {
143 usec_t nw
= now(CLOCK_MONOTONIC
);
145 if (f
->escape_counter
== 0 || nw
> f
->escape_timestamp
+ ESCAPE_USEC
) {
146 f
->escape_timestamp
= nw
;
147 f
->escape_counter
= 1;
149 (f
->escape_counter
)++;
151 if (f
->escape_counter
>= 3)
155 f
->escape_timestamp
= 0;
156 f
->escape_counter
= 0;
163 static bool ignore_vhangup(PTYForward
*f
) {
166 if (f
->flags
& PTY_FORWARD_IGNORE_VHANGUP
)
169 if ((f
->flags
& PTY_FORWARD_IGNORE_INITIAL_VHANGUP
) && !f
->read_from_master
)
175 static bool drained(PTYForward
*f
) {
180 if (f
->out_buffer_full
> 0)
183 if (f
->master_readable
)
186 if (ioctl(f
->master
, TIOCINQ
, &q
) < 0)
187 log_debug_errno(errno
, "TIOCINQ failed on master: %m");
191 if (ioctl(f
->master
, TIOCOUTQ
, &q
) < 0)
192 log_debug_errno(errno
, "TIOCOUTQ failed on master: %m");
199 static int shovel(PTYForward
*f
) {
204 while ((f
->stdin_readable
&& f
->in_buffer_full
<= 0) ||
205 (f
->master_writable
&& f
->in_buffer_full
> 0) ||
206 (f
->master_readable
&& f
->out_buffer_full
<= 0) ||
207 (f
->stdout_writable
&& f
->out_buffer_full
> 0)) {
209 if (f
->stdin_readable
&& f
->in_buffer_full
< LINE_MAX
) {
211 k
= read(f
->input_fd
, f
->in_buffer
+ f
->in_buffer_full
, LINE_MAX
- f
->in_buffer_full
);
215 f
->stdin_readable
= false;
216 else if (errno
== EIO
|| ERRNO_IS_DISCONNECT(errno
)) {
217 f
->stdin_readable
= false;
218 f
->stdin_hangup
= true;
220 f
->stdin_event_source
= sd_event_source_unref(f
->stdin_event_source
);
222 log_error_errno(errno
, "read(): %m");
223 return pty_forward_done(f
, -errno
);
227 f
->stdin_readable
= false;
228 f
->stdin_hangup
= true;
230 f
->stdin_event_source
= sd_event_source_unref(f
->stdin_event_source
);
232 /* Check if ^] has been pressed three times within one second. If we get this we quite
234 if (look_for_escape(f
, f
->in_buffer
+ f
->in_buffer_full
, k
))
235 return pty_forward_done(f
, -ECANCELED
);
237 f
->in_buffer_full
+= (size_t) k
;
241 if (f
->master_writable
&& f
->in_buffer_full
> 0) {
243 k
= write(f
->master
, f
->in_buffer
, f
->in_buffer_full
);
246 if (IN_SET(errno
, EAGAIN
, EIO
))
247 f
->master_writable
= false;
248 else if (IN_SET(errno
, EPIPE
, ECONNRESET
)) {
249 f
->master_writable
= f
->master_readable
= false;
250 f
->master_hangup
= true;
252 f
->master_event_source
= sd_event_source_unref(f
->master_event_source
);
254 log_error_errno(errno
, "write(): %m");
255 return pty_forward_done(f
, -errno
);
258 assert(f
->in_buffer_full
>= (size_t) k
);
259 memmove(f
->in_buffer
, f
->in_buffer
+ k
, f
->in_buffer_full
- k
);
260 f
->in_buffer_full
-= k
;
264 if (f
->master_readable
&& f
->out_buffer_full
< LINE_MAX
) {
266 k
= read(f
->master
, f
->out_buffer
+ f
->out_buffer_full
, LINE_MAX
- f
->out_buffer_full
);
269 /* Note that EIO on the master device
270 * might be caused by vhangup() or
271 * temporary closing of everything on
272 * the other side, we treat it like
273 * EAGAIN here and try again, unless
274 * ignore_vhangup is off. */
276 if (errno
== EAGAIN
|| (errno
== EIO
&& ignore_vhangup(f
)))
277 f
->master_readable
= false;
278 else if (IN_SET(errno
, EPIPE
, ECONNRESET
, EIO
)) {
279 f
->master_readable
= f
->master_writable
= false;
280 f
->master_hangup
= true;
282 f
->master_event_source
= sd_event_source_unref(f
->master_event_source
);
284 log_error_errno(errno
, "read(): %m");
285 return pty_forward_done(f
, -errno
);
288 f
->read_from_master
= true;
289 f
->out_buffer_full
+= (size_t) k
;
293 if (f
->stdout_writable
&& f
->out_buffer_full
> 0) {
295 k
= write(f
->output_fd
, f
->out_buffer
, f
->out_buffer_full
);
299 f
->stdout_writable
= false;
300 else if (errno
== EIO
|| ERRNO_IS_DISCONNECT(errno
)) {
301 f
->stdout_writable
= false;
302 f
->stdout_hangup
= true;
303 f
->stdout_event_source
= sd_event_source_unref(f
->stdout_event_source
);
305 log_error_errno(errno
, "write(): %m");
306 return pty_forward_done(f
, -errno
);
312 f
->last_char
= f
->out_buffer
[k
-1];
313 f
->last_char_set
= true;
316 assert(f
->out_buffer_full
>= (size_t) k
);
317 memmove(f
->out_buffer
, f
->out_buffer
+ k
, f
->out_buffer_full
- k
);
318 f
->out_buffer_full
-= k
;
323 if (f
->stdin_hangup
|| f
->stdout_hangup
|| f
->master_hangup
) {
324 /* Exit the loop if any side hung up and if there's
325 * nothing more to write or nothing we could write. */
327 if ((f
->out_buffer_full
<= 0 || f
->stdout_hangup
) &&
328 (f
->in_buffer_full
<= 0 || f
->master_hangup
))
329 return pty_forward_done(f
, 0);
332 /* If we were asked to drain, and there's nothing more to handle from the master, then call the callback
334 if (f
->drain
&& drained(f
))
335 return pty_forward_done(f
, 0);
340 static int on_master_event(sd_event_source
*e
, int fd
, uint32_t revents
, void *userdata
) {
341 PTYForward
*f
= ASSERT_PTR(userdata
);
344 assert(e
== f
->master_event_source
);
346 assert(fd
== f
->master
);
348 if (revents
& (EPOLLIN
|EPOLLHUP
))
349 f
->master_readable
= true;
351 if (revents
& (EPOLLOUT
|EPOLLHUP
))
352 f
->master_writable
= true;
357 static int on_stdin_event(sd_event_source
*e
, int fd
, uint32_t revents
, void *userdata
) {
358 PTYForward
*f
= ASSERT_PTR(userdata
);
361 assert(e
== f
->stdin_event_source
);
363 assert(fd
== f
->input_fd
);
365 if (revents
& (EPOLLIN
|EPOLLHUP
))
366 f
->stdin_readable
= true;
371 static int on_stdout_event(sd_event_source
*e
, int fd
, uint32_t revents
, void *userdata
) {
372 PTYForward
*f
= ASSERT_PTR(userdata
);
375 assert(e
== f
->stdout_event_source
);
377 assert(fd
== f
->output_fd
);
379 if (revents
& (EPOLLOUT
|EPOLLHUP
))
380 f
->stdout_writable
= true;
385 static int on_sigwinch_event(sd_event_source
*e
, const struct signalfd_siginfo
*si
, void *userdata
) {
386 PTYForward
*f
= ASSERT_PTR(userdata
);
390 assert(e
== f
->sigwinch_event_source
);
392 /* The window size changed, let's forward that. */
393 if (ioctl(f
->output_fd
, TIOCGWINSZ
, &ws
) >= 0)
394 (void) ioctl(f
->master
, TIOCSWINSZ
, &ws
);
402 PTYForwardFlags flags
,
405 _cleanup_(pty_forward_freep
) PTYForward
*f
= NULL
;
409 f
= new(PTYForward
, 1);
413 *f
= (struct PTYForward
) {
421 f
->event
= sd_event_ref(event
);
423 r
= sd_event_default(&f
->event
);
428 if (FLAGS_SET(flags
, PTY_FORWARD_READ_ONLY
))
429 f
->output_fd
= STDOUT_FILENO
;
431 /* If we shall be invoked in interactive mode, let's switch on non-blocking mode, so that we
432 * never end up staving one direction while we block on the other. However, let's be careful
433 * here and not turn on O_NONBLOCK for stdin/stdout directly, but of re-opened copies of
434 * them. This has two advantages: when we are killed abruptly the stdin/stdout fds won't be
435 * left in O_NONBLOCK state for the next process using them. In addition, if some process
436 * running in the background wants to continue writing to our stdout it can do so without
437 * being confused by O_NONBLOCK. */
439 f
->input_fd
= fd_reopen(STDIN_FILENO
, O_RDONLY
|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
);
440 if (f
->input_fd
< 0) {
441 /* Handle failures gracefully, after all certain fd types cannot be reopened
443 log_debug_errno(f
->input_fd
, "Failed to reopen stdin, using original fd: %m");
445 r
= fd_nonblock(STDIN_FILENO
, true);
449 f
->input_fd
= STDIN_FILENO
;
451 f
->close_input_fd
= true;
453 f
->output_fd
= fd_reopen(STDOUT_FILENO
, O_WRONLY
|O_CLOEXEC
|O_NOCTTY
|O_NONBLOCK
);
454 if (f
->output_fd
< 0) {
455 log_debug_errno(f
->output_fd
, "Failed to reopen stdout, using original fd: %m");
457 r
= fd_nonblock(STDOUT_FILENO
, true);
461 f
->output_fd
= STDOUT_FILENO
;
463 f
->close_output_fd
= true;
466 r
= fd_nonblock(master
, true);
472 if (ioctl(f
->output_fd
, TIOCGWINSZ
, &ws
) < 0)
473 /* If we can't get the resolution from the output fd, then use our internal, regular width/height,
474 * i.e. something derived from $COLUMNS and $LINES if set. */
475 ws
= (struct winsize
) {
480 (void) ioctl(master
, TIOCSWINSZ
, &ws
);
482 if (!(flags
& PTY_FORWARD_READ_ONLY
)) {
483 assert(f
->input_fd
>= 0);
485 if (tcgetattr(f
->input_fd
, &f
->saved_stdin_attr
) >= 0) {
486 struct termios raw_stdin_attr
;
488 f
->saved_stdin
= true;
490 raw_stdin_attr
= f
->saved_stdin_attr
;
491 cfmakeraw(&raw_stdin_attr
);
492 raw_stdin_attr
.c_oflag
= f
->saved_stdin_attr
.c_oflag
;
493 tcsetattr(f
->input_fd
, TCSANOW
, &raw_stdin_attr
);
496 if (tcgetattr(f
->output_fd
, &f
->saved_stdout_attr
) >= 0) {
497 struct termios raw_stdout_attr
;
499 f
->saved_stdout
= true;
501 raw_stdout_attr
= f
->saved_stdout_attr
;
502 cfmakeraw(&raw_stdout_attr
);
503 raw_stdout_attr
.c_iflag
= f
->saved_stdout_attr
.c_iflag
;
504 raw_stdout_attr
.c_lflag
= f
->saved_stdout_attr
.c_lflag
;
505 tcsetattr(f
->output_fd
, TCSANOW
, &raw_stdout_attr
);
508 r
= sd_event_add_io(f
->event
, &f
->stdin_event_source
, f
->input_fd
, EPOLLIN
|EPOLLET
, on_stdin_event
, f
);
509 if (r
< 0 && r
!= -EPERM
)
513 (void) sd_event_source_set_description(f
->stdin_event_source
, "ptyfwd-stdin");
516 r
= sd_event_add_io(f
->event
, &f
->stdout_event_source
, f
->output_fd
, EPOLLOUT
|EPOLLET
, on_stdout_event
, f
);
518 /* stdout without epoll support. Likely redirected to regular file. */
519 f
->stdout_writable
= true;
523 (void) sd_event_source_set_description(f
->stdout_event_source
, "ptyfwd-stdout");
525 r
= sd_event_add_io(f
->event
, &f
->master_event_source
, master
, EPOLLIN
|EPOLLOUT
|EPOLLET
, on_master_event
, f
);
529 (void) sd_event_source_set_description(f
->master_event_source
, "ptyfwd-master");
531 r
= sd_event_add_signal(f
->event
, &f
->sigwinch_event_source
, SIGWINCH
, on_sigwinch_event
, f
);
535 (void) sd_event_source_set_description(f
->sigwinch_event_source
, "ptyfwd-sigwinch");
542 PTYForward
*pty_forward_free(PTYForward
*f
) {
543 pty_forward_disconnect(f
);
547 int pty_forward_get_last_char(PTYForward
*f
, char *ch
) {
551 if (!f
->last_char_set
)
558 int pty_forward_set_ignore_vhangup(PTYForward
*f
, bool b
) {
563 if (!!(f
->flags
& PTY_FORWARD_IGNORE_VHANGUP
) == b
)
566 SET_FLAG(f
->flags
, PTY_FORWARD_IGNORE_VHANGUP
, b
);
568 if (!ignore_vhangup(f
)) {
570 /* We shall now react to vhangup()s? Let's check
571 * immediately if we might be in one */
573 f
->master_readable
= true;
582 bool pty_forward_get_ignore_vhangup(PTYForward
*f
) {
585 return !!(f
->flags
& PTY_FORWARD_IGNORE_VHANGUP
);
588 bool pty_forward_is_done(PTYForward
*f
) {
594 void pty_forward_set_handler(PTYForward
*f
, PTYForwardHandler cb
, void *userdata
) {
598 f
->userdata
= userdata
;
601 bool pty_forward_drain(PTYForward
*f
) {
604 /* Starts draining the forwarder. Specifically:
606 * - Returns true if there are no unprocessed bytes from the pty, false otherwise
608 * - Makes sure the handler function is called the next time the number of unprocessed bytes hits zero
615 int pty_forward_set_priority(PTYForward
*f
, int64_t priority
) {
619 if (f
->stdin_event_source
) {
620 r
= sd_event_source_set_priority(f
->stdin_event_source
, priority
);
625 r
= sd_event_source_set_priority(f
->stdout_event_source
, priority
);
629 r
= sd_event_source_set_priority(f
->master_event_source
, priority
);
633 r
= sd_event_source_set_priority(f
->sigwinch_event_source
, priority
);
640 int pty_forward_set_width_height(PTYForward
*f
, unsigned width
, unsigned height
) {
645 if (width
== UINT_MAX
&& height
== UINT_MAX
)
648 if (width
!= UINT_MAX
&&
649 (width
== 0 || width
> USHRT_MAX
))
652 if (height
!= UINT_MAX
&&
653 (height
== 0 || height
> USHRT_MAX
))
656 if (width
== UINT_MAX
|| height
== UINT_MAX
) {
657 if (ioctl(f
->master
, TIOCGWINSZ
, &ws
) < 0)
660 if (width
!= UINT_MAX
)
662 if (height
!= UINT_MAX
)
665 ws
= (struct winsize
) {
670 if (ioctl(f
->master
, TIOCSWINSZ
, &ws
) < 0)
673 /* Make sure we ignore SIGWINCH window size events from now on */
674 f
->sigwinch_event_source
= sd_event_source_unref(f
->sigwinch_event_source
);