]> git.proxmox.com Git - mirror_lxc.git/blame - src/lxc/console.c
console: lxc_terminal_set_stdfds()
[mirror_lxc.git] / src / lxc / console.c
CommitLineData
b0a33c1e 1/*
2 * lxc: linux Container library
3 *
4 * (C) Copyright IBM Corp. 2007, 2008
5 *
6 * Authors:
9afe19d6 7 * Daniel Lezcano <daniel.lezcano at free.fr>
b0a33c1e 8 *
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
13 *
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
250b1eec 21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
b0a33c1e 22 */
23
9395937a
CB
24#include <errno.h>
25#include <fcntl.h>
b5159817 26#include <signal.h>
b0a33c1e 27#include <stdio.h>
e0dc0de7 28#include <stdlib.h>
8173e600 29#include <termios.h>
9395937a 30#include <unistd.h>
da41561c
CB
31#include <sys/epoll.h>
32#include <sys/types.h>
b0a33c1e 33
948955a2 34#include <lxc/lxccontainer.h>
f2363e38 35
9395937a
CB
36#include "af_unix.h"
37#include "caps.h"
38#include "commands.h"
00dbc43e 39#include "conf.h"
e827ff7e 40#include "config.h"
0d4137cc 41#include "console.h"
9395937a 42#include "log.h"
b5159817 43#include "lxclock.h"
9395937a
CB
44#include "mainloop.h"
45#include "start.h" /* for struct lxc_handler */
b5159817 46#include "utils.h"
36eb9bde 47
e827ff7e
SG
48#if HAVE_PTY_H
49#include <pty.h>
50#else
51#include <../include/openpty.h>
52#endif
53
de708fb7 54#define LXC_TERMINAL_BUFFER_SIZE 1024
732375f5 55
f36e1654 56lxc_log_define(console, lxc);
36eb9bde 57
b5159817 58static struct lxc_list lxc_ttys;
724e753c 59
b5159817 60typedef void (*sighandler_t)(int);
b5159817 61
a8e36388 62__attribute__((constructor)) void lxc_terminal_init(void)
b5159817
DE
63{
64 lxc_list_init(&lxc_ttys);
65}
724e753c 66
4e9c0330 67void lxc_terminal_winsz(int srcfd, int dstfd)
b5159817 68{
0519b5cc 69 int ret;
b5159817 70 struct winsize wsz;
0519b5cc
CB
71
72 if (!isatty(srcfd))
73 return;
74
75 ret = ioctl(srcfd, TIOCGWINSZ, &wsz);
76 if (ret < 0) {
77 WARN("Failed to get window size");
78 return;
724e753c 79 }
0519b5cc
CB
80
81 ret = ioctl(dstfd, TIOCSWINSZ, &wsz);
82 if (ret < 0)
83 WARN("Failed to set window size");
84 else
85 DEBUG("Set window size to %d columns and %d rows", wsz.ws_col,
86 wsz.ws_row);
87
88 return;
b5159817 89}
724e753c 90
7a10164a 91static void lxc_terminal_winch(struct lxc_tty_state *ts)
b5159817 92{
4e9c0330 93 lxc_terminal_winsz(ts->stdinfd, ts->masterfd);
0519b5cc 94
0d4137cc 95 if (ts->winch_proxy)
8ccbbf94 96 lxc_cmd_terminal_winch(ts->winch_proxy, ts->winch_proxy_lxcpath);
724e753c
MN
97}
98
dad4a039 99void lxc_terminal_sigwinch(int sig)
cd453b38 100{
025ed0f3
SH
101 struct lxc_list *it;
102 struct lxc_tty_state *ts;
cd453b38 103
025ed0f3
SH
104 lxc_list_for_each(it, &lxc_ttys) {
105 ts = it->elem;
7a10164a 106 lxc_terminal_winch(ts);
cd453b38 107 }
b5159817 108}
cd453b38 109
9bafc8cb
CB
110int lxc_terminal_signalfd_cb(int fd, uint32_t events, void *cbdata,
111 struct lxc_epoll_descr *descr)
b5159817 112{
1349e92e 113 ssize_t ret;
b5159817
DE
114 struct signalfd_siginfo siginfo;
115 struct lxc_tty_state *ts = cbdata;
116
1349e92e 117 ret = read(fd, &siginfo, sizeof(siginfo));
0d4137cc 118 if (ret < 0 || (size_t)ret < sizeof(siginfo)) {
0519b5cc 119 ERROR("Failed to read signal info");
b5159817 120 return -1;
cd453b38
DL
121 }
122
1349e92e 123 if (siginfo.ssi_signo == SIGTERM) {
9bafc8cb 124 DEBUG("Received SIGTERM. Detaching from the terminal");
a529bc25 125 return LXC_MAINLOOP_CLOSE;
1349e92e
CB
126 }
127
128 if (siginfo.ssi_signo == SIGWINCH)
7a10164a 129 lxc_terminal_winch(ts);
1349e92e 130
b5159817
DE
131 return 0;
132}
133
dc8c7883 134struct lxc_tty_state *lxc_terminal_signal_init(int srcfd, int dstfd)
b5159817 135{
1349e92e 136 int ret;
0519b5cc 137 bool istty;
b5159817
DE
138 sigset_t mask;
139 struct lxc_tty_state *ts;
140
141 ts = malloc(sizeof(*ts));
142 if (!ts)
143 return NULL;
144
145 memset(ts, 0, sizeof(*ts));
341c2aed 146 ts->stdinfd = srcfd;
b5159817 147 ts->masterfd = dstfd;
341c2aed 148 ts->sigfd = -1;
b5159817 149
1349e92e
CB
150 sigemptyset(&mask);
151
0519b5cc
CB
152 istty = isatty(srcfd) == 1;
153 if (!istty) {
25964232 154 INFO("fd %d does not refer to a tty device", srcfd);
1349e92e
CB
155 } else {
156 /* Add tty to list to be scanned at SIGWINCH time. */
157 lxc_list_add_elem(&ts->node, ts);
158 lxc_list_add_tail(&lxc_ttys, &ts->node);
159 sigaddset(&mask, SIGWINCH);
25964232
LF
160 }
161
1349e92e
CB
162 /* Exit the mainloop cleanly on SIGTERM. */
163 sigaddset(&mask, SIGTERM);
b5159817 164
1349e92e
CB
165 ret = sigprocmask(SIG_BLOCK, &mask, &ts->oldmask);
166 if (ret < 0) {
167 WARN("Failed to block signals");
168 goto on_error;
b5159817
DE
169 }
170
dc5f6125 171 ts->sigfd = signalfd(-1, &mask, SFD_CLOEXEC);
b5159817 172 if (ts->sigfd < 0) {
1349e92e 173 WARN("Failed to create signal fd");
341c2aed 174 sigprocmask(SIG_SETMASK, &ts->oldmask, NULL);
1349e92e 175 goto on_error;
b5159817
DE
176 }
177
1349e92e
CB
178 DEBUG("Created signal fd %d", ts->sigfd);
179 return ts;
180
181on_error:
182 ERROR("Failed to create signal fd");
183 if (ts->sigfd >= 0) {
184 close(ts->sigfd);
185 ts->sigfd = -1;
186 }
187 if (istty)
188 lxc_list_del(&ts->node);
b5159817 189 return ts;
cd453b38
DL
190}
191
a8867251 192void lxc_terminal_signal_fini(struct lxc_tty_state *ts)
63376d7d 193{
0e6da90b 194 if (ts->sigfd >= 0) {
b5159817 195 close(ts->sigfd);
1349e92e
CB
196
197 if (sigprocmask(SIG_SETMASK, &ts->oldmask, NULL) < 0)
198 WARN("%s - Failed to restore signal mask", strerror(errno));
0e6da90b 199 }
0d4137cc 200
1349e92e
CB
201 if (isatty(ts->stdinfd))
202 lxc_list_del(&ts->node);
203
b5159817
DE
204 free(ts);
205}
1560f6c9 206
9785b539 207static int lxc_console_truncate_log_file(struct lxc_pty *console)
861813e5
CB
208{
209 /* be very certain things are kosher */
210 if (!console->log_path || console->log_fd < 0)
211 return -EBADF;
212
213 return lxc_unpriv(ftruncate(console->log_fd, 0));
214}
215
9785b539 216static int lxc_console_rotate_log_file(struct lxc_pty *console)
861813e5
CB
217{
218 int ret;
219 size_t len;
220 char *tmp;
221
861813e5
CB
222 if (!console->log_path || console->log_rotate == 0)
223 return -EOPNOTSUPP;
224
225 /* be very certain things are kosher */
226 if (console->log_fd < 0)
227 return -EBADF;
228
229 len = strlen(console->log_path) + sizeof(".1");
230 tmp = alloca(len);
231
232 ret = snprintf(tmp, len, "%s.1", console->log_path);
233 if (ret < 0 || (size_t)ret >= len)
234 return -EFBIG;
235
236 close(console->log_fd);
237 console->log_fd = -1;
238 ret = lxc_unpriv(rename(console->log_path, tmp));
239 if (ret < 0)
240 return ret;
241
242 return lxc_console_create_log_file(console);
243}
244
9785b539 245static int lxc_console_write_log_file(struct lxc_pty *console, char *buf,
861813e5
CB
246 int bytes_read)
247{
248 int ret;
249 int64_t space_left = -1;
250 struct stat st;
251
252 if (console->log_fd < 0)
253 return 0;
254
255 /* A log size <= 0 means that there's no limit on the size of the log
256 * file at which point we simply ignore whether the log is supposed to
257 * be rotated or not.
258 */
259 if (console->log_size <= 0)
260 return lxc_write_nointr(console->log_fd, buf, bytes_read);
261
262 /* Get current size of the log file. */
263 ret = fstat(console->log_fd, &st);
264 if (ret < 0) {
265 SYSERROR("Failed to stat the console log file descriptor");
266 return -1;
267 }
268
269 /* handle non-regular files */
270 if ((st.st_mode & S_IFMT) != S_IFREG) {
271 /* This isn't a regular file. so rotating the file seems a
272 * dangerous thing to do, size limits are also very
273 * questionable. Let's not risk anything and tell the user that
274 * he's requesting us to do weird stuff.
275 */
276 if (console->log_rotate > 0 || console->log_size > 0)
277 return -EINVAL;
278
279 /* I mean, sure log wherever you want to. */
280 return lxc_write_nointr(console->log_fd, buf, bytes_read);
281 }
282
861813e5
CB
283 space_left = console->log_size - st.st_size;
284
285 /* User doesn't want to rotate the log file and there's no more space
286 * left so simply truncate it.
287 */
288 if (space_left <= 0 && console->log_rotate <= 0) {
289 ret = lxc_console_truncate_log_file(console);
290 if (ret < 0)
291 return ret;
292
293 if (bytes_read <= console->log_size)
294 return lxc_write_nointr(console->log_fd, buf, bytes_read);
295
296 /* Write as much as we can into the buffer and loose the rest. */
297 return lxc_write_nointr(console->log_fd, buf, console->log_size);
298 }
299
300 /* There's enough space left. */
301 if (bytes_read <= space_left)
302 return lxc_write_nointr(console->log_fd, buf, bytes_read);
303
304 /* There's not enough space left but at least write as much as we can
305 * into the old log file.
306 */
307 ret = lxc_write_nointr(console->log_fd, buf, space_left);
308 if (ret < 0)
309 return -1;
310
311 /* Calculate how many bytes we still need to write. */
312 bytes_read -= space_left;
313
89962c6c 314 /* There'd be more to write but we aren't instructed to rotate the log
861813e5
CB
315 * file so simply return. There's no error on our side here.
316 */
317 if (console->log_rotate > 0)
318 ret = lxc_console_rotate_log_file(console);
319 else
320 ret = lxc_console_truncate_log_file(console);
321 if (ret < 0)
322 return ret;
323
324 if (console->log_size < bytes_read) {
325 /* Well, this is unfortunate because it means that there is more
326 * to write than the user has granted us space. There are
327 * multiple ways to handle this but let's use the simplest one:
328 * write as much as we can, tell the user that there was more
329 * stuff to write and move on.
330 * Note that this scenario shouldn't actually happen with the
331 * standard pty-based console that LXC allocates since it will
332 * be switched into raw mode. In raw mode only 1 byte at a time
333 * should be read and written.
334 */
335 WARN("Size of console log file is smaller than the bytes to write");
336 ret = lxc_write_nointr(console->log_fd, buf, console->log_size);
337 if (ret < 0)
338 return -1;
339 bytes_read -= ret;
340 return bytes_read;
341 }
342
343 /* Yay, we made it. */
344 ret = lxc_write_nointr(console->log_fd, buf, bytes_read);
345 if (ret < 0)
346 return -1;
347 bytes_read -= ret;
348 return bytes_read;
349}
350
de708fb7 351int lxc_terminal_io_cb(int fd, uint32_t events, void *data,
a529bc25 352 struct lxc_epoll_descr *descr)
b5159817 353{
de708fb7
CB
354 struct lxc_pty *terminal = data;
355 char buf[LXC_TERMINAL_BUFFER_SIZE];
732375f5 356 int r, w, w_log, w_rbuf;
e0dc0de7 357
3e6580ec
CB
358 w = r = lxc_read_nointr(fd, buf, sizeof(buf));
359 if (r <= 0) {
de708fb7 360 INFO("Terminal client on fd %d has exited", fd);
b5159817 361 lxc_mainloop_del_handler(descr, fd);
c06a0555 362
de708fb7
CB
363 if (fd == terminal->master) {
364 terminal->master = -EBADF;
365 } else if (fd == terminal->peer) {
366 if (terminal->tty_state) {
367 lxc_terminal_signal_fini(terminal->tty_state);
368 terminal->tty_state = NULL;
0b1e242b 369 }
de708fb7 370 terminal->peer = -EBADF;
c06a0555
CB
371 } else {
372 ERROR("Handler received unexpected file descriptor");
0b1e242b 373 }
b5159817 374 close(fd);
c06a0555 375
a529bc25 376 return LXC_MAINLOOP_CLOSE;
33fcb7a0 377 }
63376d7d 378
de708fb7
CB
379 if (fd == terminal->peer)
380 w = lxc_write_nointr(terminal->master, buf, r);
b5159817 381
732375f5 382 w_rbuf = w_log = 0;
de708fb7 383 if (fd == terminal->master) {
732375f5 384 /* write to peer first */
de708fb7
CB
385 if (terminal->peer >= 0)
386 w = lxc_write_nointr(terminal->peer, buf, r);
732375f5 387
de708fb7
CB
388 /* write to terminal ringbuffer */
389 if (terminal->buffer_size > 0)
390 w_rbuf = lxc_ringbuf_write(&terminal->ringbuf, buf, r);
861813e5 391
de708fb7
CB
392 /* write to terminal log */
393 if (terminal->log_fd >= 0)
394 w_log = lxc_console_write_log_file(terminal, buf, r);
63376d7d
DL
395 }
396
b5159817 397 if (w != r)
de708fb7 398 WARN("Short write on terminal r:%d != w:%d", r, w);
732375f5
CB
399
400 if (w_rbuf < 0)
de708fb7 401 TRACE("%s - Failed to write %d bytes to terminal ringbuffer",
732375f5
CB
402 strerror(-w_rbuf), r);
403
404 if (w_log < 0)
de708fb7 405 TRACE("Failed to write %d bytes to terminal log", r);
0d4137cc 406
b5159817
DE
407 return 0;
408}
409
22b183ea 410static int lxc_terminal_mainloop_add_peer(struct lxc_pty *console)
b5159817 411{
a529bc25
CB
412 int ret;
413
b5159817 414 if (console->peer >= 0) {
a529bc25 415 ret = lxc_mainloop_add_handler(console->descr, console->peer,
de708fb7 416 lxc_terminal_io_cb, console);
a529bc25 417 if (ret < 0) {
0519b5cc 418 WARN("Failed to add console peer handler to mainloop");
a529bc25
CB
419 return -1;
420 }
63376d7d
DL
421 }
422
a529bc25
CB
423 if (!console->tty_state || console->tty_state->sigfd < 0)
424 return 0;
425
426 ret = lxc_mainloop_add_handler(console->descr, console->tty_state->sigfd,
9bafc8cb 427 lxc_terminal_signalfd_cb, console->tty_state);
a529bc25
CB
428 if (ret < 0) {
429 WARN("Failed to add signal handler to mainloop");
430 return -1;
b5159817 431 }
a529bc25
CB
432
433 return 0;
b5159817
DE
434}
435
093bce5f 436int lxc_terminal_mainloop_add(struct lxc_epoll_descr *descr,
9785b539 437 struct lxc_pty *console)
b5159817 438{
a529bc25 439 int ret;
b5159817
DE
440
441 if (console->master < 0) {
442 INFO("no console");
443 return 0;
596a818d
DE
444 }
445
30a33fbd 446 ret = lxc_mainloop_add_handler(descr, console->master,
de708fb7 447 lxc_terminal_io_cb, console);
30a33fbd
CB
448 if (ret < 0) {
449 ERROR("Failed to add handler for %d to mainloop", console->master);
b5159817 450 return -1;
28a4b0e5
DL
451 }
452
30a33fbd 453 /* We cache the descr so that we can add an fd to it when someone
c1ee47cd 454 * does attach to it in lxc_terminal_allocate().
b5159817
DE
455 */
456 console->descr = descr;
22b183ea 457 ret = lxc_terminal_mainloop_add_peer(console);
a529bc25
CB
458 if (ret < 0)
459 return -1;
cd453b38 460
b5159817
DE
461 return 0;
462}
28a4b0e5 463
0d4137cc 464int lxc_setup_tios(int fd, struct termios *oldtios)
b5159817
DE
465{
466 struct termios newtios;
e0dc0de7 467
b5159817
DE
468 if (!isatty(fd)) {
469 ERROR("'%d' is not a tty", fd);
470 return -1;
e0dc0de7
DL
471 }
472
b5159817
DE
473 /* Get current termios */
474 if (tcgetattr(fd, oldtios)) {
e0dc0de7 475 SYSERROR("failed to get current terminal settings");
b5159817 476 return -1;
e0dc0de7
DL
477 }
478
4dc96430
TJ
479 /* ensure we don't end up in an endless loop:
480 * The kernel might fire SIGTTOU while an
481 * ioctl() in tcsetattr() is executed. When the ioctl()
482 * is resumed and retries, the signal handler interrupts it again.
483 */
484 signal (SIGTTIN, SIG_IGN);
485 signal (SIGTTOU, SIG_IGN);
486
b5159817 487 newtios = *oldtios;
e0dc0de7 488
a7c97a40
CB
489 /* We use the same settings that ssh does. */
490 newtios.c_iflag |= IGNPAR;
491 newtios.c_iflag &= ~(ISTRIP | INLCR | IGNCR | ICRNL | IXON | IXANY | IXOFF);
492#ifdef IUCLC
493 newtios.c_iflag &= ~IUCLC;
494#endif
4dc96430 495 newtios.c_lflag &= ~(TOSTOP | ISIG | ICANON | ECHO | ECHOE | ECHOK | ECHONL);
a7c97a40
CB
496#ifdef IEXTEN
497 newtios.c_lflag &= ~IEXTEN;
498#endif
d3893399 499 newtios.c_oflag &= ~OPOST;
b5159817
DE
500 newtios.c_cc[VMIN] = 1;
501 newtios.c_cc[VTIME] = 0;
e0dc0de7 502
a7c97a40 503 /* Set new attributes. */
b5159817 504 if (tcsetattr(fd, TCSAFLUSH, &newtios)) {
e0dc0de7 505 ERROR("failed to set new terminal settings");
b5159817 506 return -1;
e0dc0de7
DL
507 }
508
63376d7d 509 return 0;
b5159817 510}
e0dc0de7 511
ec2a5cfc 512static void lxc_terminal_peer_proxy_free(struct lxc_pty *console)
b5159817 513{
0e6da90b 514 if (console->tty_state) {
a8867251 515 lxc_terminal_signal_fini(console->tty_state);
b5159817
DE
516 console->tty_state = NULL;
517 }
518 close(console->peerpty.master);
519 close(console->peerpty.slave);
520 console->peerpty.master = -1;
521 console->peerpty.slave = -1;
522 console->peerpty.busy = -1;
523 console->peerpty.name[0] = '\0';
596a818d 524 console->peer = -1;
b5159817 525}
596a818d 526
93ed4990 527static int lxc_terminal_peer_proxy_alloc(struct lxc_pty *console, int sockfd)
b5159817
DE
528{
529 struct termios oldtermio;
530 struct lxc_tty_state *ts;
025ed0f3 531 int ret;
b5159817
DE
532
533 if (console->master < 0) {
534 ERROR("console not set up");
535 return -1;
536 }
537 if (console->peerpty.busy != -1 || console->peer != -1) {
538 NOTICE("console already in use");
539 return -1;
540 }
541 if (console->tty_state) {
542 ERROR("console already has tty_state");
543 return -1;
596a818d
DE
544 }
545
b5159817
DE
546 /* this is the proxy pty that will be given to the client, and that
547 * the real pty master will send to / recv from
548 */
025ed0f3
SH
549 ret = openpty(&console->peerpty.master, &console->peerpty.slave,
550 console->peerpty.name, NULL, NULL);
025ed0f3 551 if (ret) {
b5159817
DE
552 SYSERROR("failed to create proxy pty");
553 return -1;
554 }
596a818d 555
0d4137cc 556 if (lxc_setup_tios(console->peerpty.slave, &oldtermio) < 0)
b5159817
DE
557 goto err1;
558
dc8c7883 559 ts = lxc_terminal_signal_init(console->peerpty.master, console->master);
b5159817
DE
560 if (!ts)
561 goto err1;
562
563 console->tty_state = ts;
564 console->peer = console->peerpty.slave;
565 console->peerpty.busy = sockfd;
22b183ea 566 ret = lxc_terminal_mainloop_add_peer(console);
a529bc25
CB
567 if (ret < 0)
568 goto err1;
b5159817 569
0059379f 570 DEBUG("%d %s peermaster:%d sockfd:%d", lxc_raw_getpid(), __FUNCTION__, console->peerpty.master, sockfd);
b5159817
DE
571 return 0;
572
573err1:
ec2a5cfc 574 lxc_terminal_peer_proxy_free(console);
63376d7d
DL
575 return -1;
576}
577
c1ee47cd 578int lxc_terminal_allocate(struct lxc_conf *conf, int sockfd, int *ttyreq)
b5159817
DE
579{
580 int masterfd = -1, ttynum;
581 struct lxc_tty_info *tty_info = &conf->tty_info;
9785b539 582 struct lxc_pty *console = &conf->console;
b5159817 583
b5159817 584 if (*ttyreq == 0) {
93ed4990 585 if (lxc_terminal_peer_proxy_alloc(console, sockfd) < 0)
b5159817
DE
586 goto out;
587 masterfd = console->peerpty.master;
588 goto out;
589 }
590
591 if (*ttyreq > 0) {
592 if (*ttyreq > tty_info->nbtty)
593 goto out;
594
595 if (tty_info->pty_info[*ttyreq - 1].busy)
596 goto out;
597
598 /* the requested tty is available */
599 ttynum = *ttyreq;
600 goto out_tty;
601 }
602
603 /* search for next available tty, fixup index tty1 => [0] */
0d4137cc
CB
604 for (ttynum = 1; ttynum <= tty_info->nbtty && tty_info->pty_info[ttynum - 1].busy; ttynum++)
605 ;
b5159817
DE
606
607 /* we didn't find any available slot for tty */
608 if (ttynum > tty_info->nbtty)
609 goto out;
610
611 *ttyreq = ttynum;
612
613out_tty:
614 tty_info->pty_info[ttynum - 1].busy = sockfd;
615 masterfd = tty_info->pty_info[ttynum - 1].master;
616out:
b5159817
DE
617 return masterfd;
618}
619
3dfe6f8d 620void lxc_terminal_free(struct lxc_conf *conf, int fd)
63376d7d 621{
b5159817
DE
622 int i;
623 struct lxc_tty_info *tty_info = &conf->tty_info;
9785b539 624 struct lxc_pty *console = &conf->console;
b5159817 625
b5159817
DE
626 for (i = 0; i < tty_info->nbtty; i++) {
627 if (tty_info->pty_info[i].busy == fd)
628 tty_info->pty_info[i].busy = 0;
629 }
630
631 if (console->peerpty.busy == fd) {
632 lxc_mainloop_del_handler(console->descr, console->peerpty.slave);
ec2a5cfc 633 lxc_terminal_peer_proxy_free(console);
b5159817 634 }
b5159817
DE
635}
636
7c716661 637static int lxc_terminal_peer_default(struct lxc_pty *console)
b5159817
DE
638{
639 struct lxc_tty_state *ts;
640 const char *path = console->path;
467c7ff3
CB
641 int fd;
642 int ret = 0;
b5159817 643
467c7ff3
CB
644 /* If no console was given, try current controlling terminal, there
645 * won't be one if we were started as a daemon (-d).
b5159817
DE
646 */
647 if (!path && !access("/dev/tty", F_OK)) {
b5159817
DE
648 fd = open("/dev/tty", O_RDWR);
649 if (fd >= 0) {
650 close(fd);
651 path = "/dev/tty";
652 }
653 }
654
467c7ff3
CB
655 if (!path) {
656 errno = ENOTTY;
657 DEBUG("process does not have a controlling terminal");
b5159817 658 goto out;
467c7ff3 659 }
b5159817 660
a63fade5 661 console->peer = lxc_unpriv(open(path, O_RDWR | O_CLOEXEC));
467c7ff3 662 if (console->peer < 0) {
a63fade5 663 ERROR("Failed to open \"%s\": %s", path, strerror(errno));
467c7ff3
CB
664 return -ENOTTY;
665 }
666 DEBUG("using \"%s\" as peer tty device", path);
b5159817 667
467c7ff3
CB
668 if (!isatty(console->peer)) {
669 ERROR("file descriptor for file \"%s\" does not refer to a tty device", path);
670 goto on_error1;
671 }
b5159817 672
dc8c7883 673 ts = lxc_terminal_signal_init(console->peer, console->master);
b5159817 674 console->tty_state = ts;
341c2aed 675 if (!ts) {
0519b5cc 676 WARN("Failed to install signal handler");
467c7ff3 677 goto on_error1;
341c2aed 678 }
b5159817 679
4e9c0330 680 lxc_terminal_winsz(console->peer, console->master);
b5159817
DE
681
682 console->tios = malloc(sizeof(*console->tios));
683 if (!console->tios) {
684 SYSERROR("failed to allocate memory");
467c7ff3 685 goto on_error1;
b5159817
DE
686 }
687
0d4137cc 688 if (lxc_setup_tios(console->peer, console->tios) < 0)
467c7ff3
CB
689 goto on_error2;
690 else
691 goto out;
b5159817 692
467c7ff3 693on_error2:
b5159817
DE
694 free(console->tios);
695 console->tios = NULL;
467c7ff3
CB
696
697on_error1:
b5159817
DE
698 close(console->peer);
699 console->peer = -1;
467c7ff3
CB
700 ret = -ENOTTY;
701
b5159817 702out:
467c7ff3 703 return ret;
b5159817
DE
704}
705
7ef7427e 706int lxc_terminal_write_ringbuffer(struct lxc_pty *console)
39c6cdb7
CB
707{
708 char *r_addr;
709 ssize_t ret;
710 uint64_t used;
711 struct lxc_ringbuf *buf = &console->ringbuf;
712
713 /* There's not log file where we can dump the ringbuffer to. */
714 if (console->log_fd < 0)
715 return 0;
716
717 /* The log file is simply appended to. */
718 if (console->log_size == 0)
719 return 0;
720
39c6cdb7
CB
721 used = lxc_ringbuf_used(buf);
722 if (used == 0)
723 return 0;
724
725 ret = lxc_console_truncate_log_file(console);
726 if (ret < 0)
727 return ret;
728
729 /* Write as much as we can without exceeding the limit. */
730 if (console->log_size < used)
731 used = console->log_size;
732
733 r_addr = lxc_ringbuf_get_read_addr(buf);
734 ret = lxc_write_nointr(console->log_fd, r_addr, used);
735 if (ret < 0)
736 return -EIO;
737
738 return 0;
739}
740
2aac071b 741void lxc_terminal_delete(struct lxc_pty *console)
b5159817 742{
69629c82
CB
743 int ret;
744
7ef7427e 745 ret = lxc_terminal_write_ringbuffer(console);
39c6cdb7
CB
746 if (ret < 0)
747 WARN("Failed to write console ringbuffer to console log file");
748
69629c82
CB
749 if (console->tios && console->peer >= 0) {
750 ret = tcsetattr(console->peer, TCSAFLUSH, console->tios);
751 if (ret < 0)
752 WARN("%s - Failed to set old terminal settings", strerror(errno));
753 }
596a818d
DE
754 free(console->tios);
755 console->tios = NULL;
756
bc9724f7
CB
757 if (console->peer >= 0)
758 close(console->peer);
025ed0f3 759 console->peer = -1;
bc9724f7
CB
760
761 if (console->master >= 0)
762 close(console->master);
596a818d 763 console->master = -1;
bc9724f7
CB
764
765 if (console->slave >= 0)
766 close(console->slave);
596a818d 767 console->slave = -1;
bc9724f7
CB
768
769 if (console->log_fd >= 0)
770 close(console->log_fd);
025ed0f3 771 console->log_fd = -1;
63376d7d
DL
772}
773
3b988b33
CB
774/**
775 * Note that this function needs to run before the mainloop starts. Since we
776 * register a handler for the console's masterfd when we create the mainloop
777 * the console handler needs to see an allocated ringbuffer.
778 */
9bc78083 779static int lxc_terminal_create_ringbuf(struct lxc_pty *console)
3b988b33
CB
780{
781 int ret;
782 struct lxc_ringbuf *buf = &console->ringbuf;
28f3b1cd 783 uint64_t size = console->buffer_size;
3b988b33
CB
784
785 /* no ringbuffer previously allocated and no ringbuffer requested */
786 if (!buf->addr && size <= 0)
787 return 0;
788
789 /* ringbuffer allocated but no new ringbuffer requested */
790 if (buf->addr && size <= 0) {
791 lxc_ringbuf_release(buf);
792 buf->addr = NULL;
793 buf->r_off = 0;
794 buf->w_off = 0;
795 buf->size = 0;
796 TRACE("Deallocated console ringbuffer");
797 return 0;
798 }
799
800 if (size <= 0)
801 return 0;
802
803 /* check wether the requested size for the ringbuffer has changed */
804 if (buf->addr && buf->size != size) {
805 TRACE("Console ringbuffer size changed from %" PRIu64
806 " to %" PRIu64 " bytes. Deallocating console ringbuffer",
807 buf->size, size);
808 lxc_ringbuf_release(buf);
809 }
810
811 ret = lxc_ringbuf_create(buf, size);
812 if (ret < 0) {
813 ERROR("Failed to setup %" PRIu64 " byte console ringbuffer", size);
814 return -1;
815 }
816
817 TRACE("Allocated %" PRIu64 " byte console ringbuffer", size);
818 return 0;
819}
820
a0309168
CB
821/**
822 * This is the console log file. Please note that the console log file is
823 * (implementation wise not content wise) independent of the console ringbuffer.
824 */
43366ca2 825int lxc_terminal_create_log_file(struct lxc_pty *console)
a0309168
CB
826{
827 if (!console->log_path)
828 return 0;
829
830 console->log_fd = lxc_unpriv(open(console->log_path, O_CLOEXEC | O_RDWR | O_CREAT | O_APPEND, 0600));
831 if (console->log_fd < 0) {
832 SYSERROR("Failed to open console log file \"%s\"", console->log_path);
833 return -1;
834 }
835
836 DEBUG("Using \"%s\" as console log file", console->log_path);
837 return 0;
838}
839
9785b539 840int lxc_pty_create(struct lxc_pty *console)
63376d7d 841{
69629c82 842 int ret, saved_errno;
b5159817 843
5777fe90
CB
844 ret = openpty(&console->master, &console->slave, console->name, NULL,
845 NULL);
69629c82 846 saved_errno = errno;
467c7ff3 847 if (ret < 0) {
69629c82 848 ERROR("%s - Failed to allocate a pty", strerror(saved_errno));
b5159817
DE
849 return -1;
850 }
851
69629c82
CB
852 ret = fcntl(console->master, F_SETFD, FD_CLOEXEC);
853 if (ret < 0) {
854 SYSERROR("Failed to set FD_CLOEXEC flag on console master");
b5159817
DE
855 goto err;
856 }
857
69629c82
CB
858 ret = fcntl(console->slave, F_SETFD, FD_CLOEXEC);
859 if (ret < 0) {
860 SYSERROR("Failed to set FD_CLOEXEC flag on console slave");
b5159817
DE
861 goto err;
862 }
863
7c716661 864 ret = lxc_terminal_peer_default(console);
467c7ff3 865 if (ret < 0) {
69629c82 866 ERROR("Failed to allocate a peer pty device");
467c7ff3
CB
867 goto err;
868 }
b5159817 869
5777fe90
CB
870 return 0;
871
872err:
2aac071b 873 lxc_terminal_delete(console);
5777fe90
CB
874 return -ENODEV;
875}
876
548029fa 877int lxc_terminal_create(struct lxc_conf *conf)
5777fe90
CB
878{
879 int ret;
9785b539 880 struct lxc_pty *console = &conf->console;
5777fe90 881
5777fe90
CB
882 if (console->path && !strcmp(console->path, "none")) {
883 INFO("No console was requested");
884 return 0;
885 }
886
887 ret = lxc_pty_create(console);
888 if (ret < 0)
889 return -1;
890
a0309168 891 /* create console log file */
43366ca2 892 ret = lxc_terminal_create_log_file(console);
a0309168
CB
893 if (ret < 0)
894 goto err;
895
896 /* create console ringbuffer */
9bc78083 897 ret = lxc_terminal_create_ringbuf(console);
a0309168
CB
898 if (ret < 0)
899 goto err;
b5159817
DE
900
901 return 0;
902
903err:
2aac071b 904 lxc_terminal_delete(console);
69629c82 905 return -ENODEV;
b5159817
DE
906}
907
ae6d3913 908int lxc_terminal_set_stdfds(int fd)
0d9acb99 909{
39a78bbe 910 if (fd < 0)
0d9acb99 911 return 0;
b5159817 912
39a78bbe
CB
913 if (isatty(STDIN_FILENO))
914 if (dup2(fd, STDIN_FILENO) < 0) {
915 SYSERROR("failed to duplicate stdin.");
916 return -1;
917 }
918
919 if (isatty(STDOUT_FILENO))
920 if (dup2(fd, STDOUT_FILENO) < 0) {
921 SYSERROR("failed to duplicate stdout.");
922 return -1;
923 }
924
925 if (isatty(STDERR_FILENO))
926 if (dup2(fd, STDERR_FILENO) < 0) {
927 SYSERROR("failed to duplicate stderr.");
928 return -1;
929 }
930
0d9acb99
DE
931 return 0;
932}
b5159817 933
0d4137cc
CB
934int lxc_console_cb_tty_stdin(int fd, uint32_t events, void *cbdata,
935 struct lxc_epoll_descr *descr)
b5159817
DE
936{
937 struct lxc_tty_state *ts = cbdata;
938 char c;
939
97bc2422 940 if (fd != ts->stdinfd)
a529bc25 941 return LXC_MAINLOOP_CLOSE;
97bc2422 942
e66b6c96 943 if (lxc_read_nointr(ts->stdinfd, &c, 1) <= 0)
a529bc25 944 return LXC_MAINLOOP_CLOSE;
63376d7d 945
525e2117 946 if (ts->escape >= 1) {
014d5e1e
CB
947 /* we want to exit the console with Ctrl+a q */
948 if (c == ts->escape && !ts->saw_escape) {
949 ts->saw_escape = 1;
950 return 0;
951 }
5c294060 952
014d5e1e 953 if (c == 'q' && ts->saw_escape)
a529bc25 954 return LXC_MAINLOOP_CLOSE;
014d5e1e
CB
955
956 ts->saw_escape = 0;
957 }
63376d7d 958
e66b6c96 959 if (lxc_write_nointr(ts->masterfd, &c, 1) <= 0)
a529bc25 960 return LXC_MAINLOOP_CLOSE;
b5159817 961
63376d7d
DL
962 return 0;
963}
964
0d4137cc
CB
965int lxc_console_cb_tty_master(int fd, uint32_t events, void *cbdata,
966 struct lxc_epoll_descr *descr)
63376d7d 967{
b5159817 968 struct lxc_tty_state *ts = cbdata;
de708fb7 969 char buf[LXC_TERMINAL_BUFFER_SIZE];
0d4137cc 970 int r, w;
63376d7d 971
97bc2422 972 if (fd != ts->masterfd)
a529bc25 973 return LXC_MAINLOOP_CLOSE;
97bc2422 974
e66b6c96
CB
975 r = lxc_read_nointr(fd, buf, sizeof(buf));
976 if (r <= 0)
a529bc25 977 return LXC_MAINLOOP_CLOSE;
1560f6c9 978
e66b6c96
CB
979 w = lxc_write_nointr(ts->stdoutfd, buf, r);
980 if (w <= 0) {
a529bc25 981 return LXC_MAINLOOP_CLOSE;
e66b6c96 982 } else if (w != r) {
a529bc25 983 SYSERROR("Failed to write");
b5159817 984 return 1;
f78a1f32
DL
985 }
986
b5159817
DE
987 return 0;
988}
989
990int lxc_console_getfd(struct lxc_container *c, int *ttynum, int *masterfd)
991{
992 return lxc_cmd_console(c->name, ttynum, masterfd, c->config_path);
993}
994
995int lxc_console(struct lxc_container *c, int ttynum,
996 int stdinfd, int stdoutfd, int stderrfd,
997 int escape)
998{
999 int ret, ttyfd, masterfd;
1000 struct lxc_epoll_descr descr;
1001 struct termios oldtios;
1002 struct lxc_tty_state *ts;
25964232 1003 int istty = 0;
b5159817 1004
b5159817 1005 ttyfd = lxc_cmd_console(c->name, &ttynum, &masterfd, c->config_path);
6834f805
CB
1006 if (ttyfd < 0)
1007 return -1;
b5159817
DE
1008
1009 ret = setsid();
33b4b411
CB
1010 if (ret < 0)
1011 TRACE("Process is already group leader");
b5159817 1012
dc8c7883 1013 ts = lxc_terminal_signal_init(stdinfd, masterfd);
b5159817
DE
1014 if (!ts) {
1015 ret = -1;
33b4b411 1016 goto close_fds;
b5159817
DE
1017 }
1018 ts->escape = escape;
1019 ts->winch_proxy = c->name;
1020 ts->winch_proxy_lxcpath = c->config_path;
3b975060 1021 ts->stdoutfd = stdoutfd;
b5159817 1022
6834f805 1023 istty = isatty(stdinfd);
25964232 1024 if (istty) {
4e9c0330 1025 lxc_terminal_winsz(stdinfd, masterfd);
8ccbbf94 1026 lxc_cmd_terminal_winch(ts->winch_proxy, ts->winch_proxy_lxcpath);
6834f805
CB
1027 } else {
1028 INFO("File descriptor %d does not refer to a tty device", stdinfd);
25964232 1029 }
b5159817
DE
1030
1031 ret = lxc_mainloop_open(&descr);
1032 if (ret) {
33b4b411
CB
1033 ERROR("Failed to create mainloop");
1034 goto sigwinch_fini;
b5159817
DE
1035 }
1036
341c2aed
CB
1037 if (ts->sigfd != -1) {
1038 ret = lxc_mainloop_add_handler(&descr, ts->sigfd,
9bafc8cb 1039 lxc_terminal_signalfd_cb, ts);
33b4b411 1040 if (ret < 0) {
0519b5cc 1041 ERROR("Failed to add signal handler to mainloop");
33b4b411 1042 goto close_mainloop;
341c2aed 1043 }
b5159817
DE
1044 }
1045
1046 ret = lxc_mainloop_add_handler(&descr, ts->stdinfd,
1047 lxc_console_cb_tty_stdin, ts);
33b4b411
CB
1048 if (ret < 0) {
1049 ERROR("Failed to add stdin handler");
1050 goto close_mainloop;
b5159817
DE
1051 }
1052
1053 ret = lxc_mainloop_add_handler(&descr, ts->masterfd,
1054 lxc_console_cb_tty_master, ts);
33b4b411
CB
1055 if (ret < 0) {
1056 ERROR("Failed to add master handler");
1057 goto close_mainloop;
b5159817
DE
1058 }
1059
686df166
CB
1060 if (ts->escape >= 1) {
1061 fprintf(stderr,
1062 "\n"
6834f805
CB
1063 "Connected to tty %1$d\n"
1064 "Type <Ctrl+%2$c q> to exit the console, "
1065 "<Ctrl+%2$c Ctrl+%2$c> to enter Ctrl+%2$c itself\n",
1066 ttynum, 'a' + escape - 1);
686df166 1067 }
6834f805
CB
1068
1069 if (istty) {
1070 ret = lxc_setup_tios(stdinfd, &oldtios);
1071 if (ret < 0)
1072 goto close_mainloop;
1073 }
1074
025ed0f3 1075 ret = lxc_mainloop(&descr, -1);
33b4b411
CB
1076 if (ret < 0) {
1077 ERROR("The mainloop returned an error");
6834f805 1078 goto restore_tios;
b5159817
DE
1079 }
1080
1081 ret = 0;
1082
6834f805
CB
1083restore_tios:
1084 if (istty) {
1085 istty = tcsetattr(stdinfd, TCSAFLUSH, &oldtios);
1086 if (istty < 0)
1087 WARN("%s - Failed to restore terminal properties",
1088 strerror(errno));
1089 }
1090
33b4b411 1091close_mainloop:
b5159817 1092 lxc_mainloop_close(&descr);
33b4b411
CB
1093
1094sigwinch_fini:
a8867251 1095 lxc_terminal_signal_fini(ts);
33b4b411
CB
1096
1097close_fds:
b5159817
DE
1098 close(masterfd);
1099 close(ttyfd);
33b4b411 1100
b5159817 1101 return ret;
63376d7d 1102}
e98affda
CB
1103
1104int lxc_make_controlling_pty(int fd)
1105{
1106 int ret;
1107
1108 setsid();
1109
1110 ret = ioctl(fd, TIOCSCTTY, (char *)NULL);
1111 if (ret < 0)
1112 return -1;
1113
1114 return 0;
1115}
1116
1117int lxc_login_pty(int fd)
1118{
1119 int ret;
1120
1121 ret = lxc_make_controlling_pty(fd);
1122 if (ret < 0)
1123 return -1;
1124
ae6d3913 1125 ret = lxc_terminal_set_stdfds(fd);
e98affda
CB
1126 if (ret < 0)
1127 return -1;
1128
1129 if (fd > STDERR_FILENO)
1130 close(fd);
1131
1132 return 0;
1133}
1134
1135void lxc_pty_info_init(struct lxc_pty_info *pty)
1136{
1137 pty->name[0] = '\0';
1138 pty->master = -EBADF;
1139 pty->slave = -EBADF;
1140 pty->busy = -1;
1141}
1142
9785b539 1143void lxc_pty_init(struct lxc_pty *pty)
e98affda
CB
1144{
1145 memset(pty, 0, sizeof(*pty));
1146 pty->slave = -EBADF;
1147 pty->master = -EBADF;
1148 pty->peer = -EBADF;
1149 pty->log_fd = -EBADF;
e98affda
CB
1150 lxc_pty_info_init(&pty->peerpty);
1151}
1152
9785b539 1153void lxc_pty_conf_free(struct lxc_pty *console)
e98affda 1154{
e98affda
CB
1155 free(console->log_path);
1156 free(console->path);
1157 if (console->buffer_size > 0 && console->ringbuf.addr)
1158 lxc_ringbuf_release(&console->ringbuf);
1159}
7cfeddd7 1160
9785b539 1161int lxc_pty_map_ids(struct lxc_conf *c, struct lxc_pty *pty)
7cfeddd7
CB
1162{
1163 int ret;
1164
1165 if (lxc_list_empty(&c->id_map))
1166 return 0;
1167
1168 ret = strcmp(pty->name, "");
1169 if (ret == 0)
1170 return 0;
1171
1172 ret = chown_mapped_root(pty->name, c);
1173 if (ret < 0) {
1174 ERROR("Failed to chown \"%s\"", pty->name);
1175 return -1;
1176 }
1177
1178 TRACE("Chowned \"%s\"", pty->name);
1179
1180 return 0;
1181}