Annotation of src/usr.bin/tmux/server.c, Revision 1.195
1.195 ! nicm 1: /* $OpenBSD: server.c,v 1.194 2020/06/18 08:34:22 nicm Exp $ */
1.1 nicm 2:
3: /*
1.157 nicm 4: * Copyright (c) 2007 Nicholas Marriott <nicholas.marriott@gmail.com>
1.1 nicm 5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER
15: * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
16: * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
18:
19: #include <sys/types.h>
20: #include <sys/ioctl.h>
21: #include <sys/socket.h>
22: #include <sys/stat.h>
23: #include <sys/un.h>
24: #include <sys/wait.h>
25:
26: #include <errno.h>
1.66 nicm 27: #include <event.h>
1.1 nicm 28: #include <fcntl.h>
1.5 nicm 29: #include <paths.h>
1.1 nicm 30: #include <signal.h>
31: #include <stdio.h>
32: #include <stdlib.h>
33: #include <string.h>
34: #include <termios.h>
35: #include <time.h>
36: #include <unistd.h>
37:
38: #include "tmux.h"
39:
40: /*
41: * Main server functions.
42: */
43:
1.155 nicm 44: struct clients clients;
1.1 nicm 45:
1.155 nicm 46: struct tmuxproc *server_proc;
1.186 nicm 47: static int server_fd = -1;
1.194 nicm 48: static uint64_t server_client_flags;
1.160 nicm 49: static int server_exit;
50: static struct event server_ev_accept;
1.155 nicm 51:
52: struct cmd_find_state marked_pane;
1.126 nicm 53:
1.190 nicm 54: static u_int message_next;
55: struct message_list message_log;
56:
1.160 nicm 57: static int server_loop(void);
58: static void server_send_exit(void);
59: static void server_accept(int, short, void *);
60: static void server_signal(int);
61: static void server_child_signal(void);
62: static void server_child_exited(pid_t, int);
63: static void server_child_stopped(pid_t, int);
1.126 nicm 64:
65: /* Set marked pane. */
66: void
67: server_set_marked(struct session *s, struct winlink *wl, struct window_pane *wp)
68: {
1.169 nicm 69: cmd_find_clear_state(&marked_pane, 0);
1.155 nicm 70: marked_pane.s = s;
71: marked_pane.wl = wl;
72: marked_pane.w = wl->window;
73: marked_pane.wp = wp;
1.126 nicm 74: }
75:
76: /* Clear marked pane. */
77: void
78: server_clear_marked(void)
79: {
1.169 nicm 80: cmd_find_clear_state(&marked_pane, 0);
1.126 nicm 81: }
82:
83: /* Is this the marked pane? */
84: int
85: server_is_marked(struct session *s, struct winlink *wl, struct window_pane *wp)
86: {
87: if (s == NULL || wl == NULL || wp == NULL)
88: return (0);
1.155 nicm 89: if (marked_pane.s != s || marked_pane.wl != wl)
1.126 nicm 90: return (0);
1.155 nicm 91: if (marked_pane.wp != wp)
1.126 nicm 92: return (0);
93: return (server_check_marked());
94: }
95:
96: /* Check if the marked pane is still valid. */
97: int
98: server_check_marked(void)
99: {
1.155 nicm 100: return (cmd_find_valid_state(&marked_pane));
1.126 nicm 101: }
1.45 nicm 102:
1.60 nicm 103: /* Create server socket. */
1.160 nicm 104: static int
1.188 nicm 105: server_create_socket(int flags, char **cause)
1.1 nicm 106: {
1.60 nicm 107: struct sockaddr_un sa;
108: size_t size;
109: mode_t mask;
1.178 nicm 110: int fd, saved_errno;
1.60 nicm 111:
112: memset(&sa, 0, sizeof sa);
113: sa.sun_family = AF_UNIX;
114: size = strlcpy(sa.sun_path, socket_path, sizeof sa.sun_path);
115: if (size >= sizeof sa.sun_path) {
116: errno = ENAMETOOLONG;
1.178 nicm 117: goto fail;
1.60 nicm 118: }
119: unlink(sa.sun_path);
120:
121: if ((fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1)
1.178 nicm 122: goto fail;
1.60 nicm 123:
1.188 nicm 124: if (flags & CLIENT_DEFAULTSOCKET)
125: mask = umask(S_IXUSR|S_IXGRP|S_IRWXO);
126: else
127: mask = umask(S_IXUSR|S_IRWXG|S_IRWXO);
1.178 nicm 128: if (bind(fd, (struct sockaddr *)&sa, sizeof sa) == -1) {
129: saved_errno = errno;
1.170 nicm 130: close(fd);
1.178 nicm 131: errno = saved_errno;
132: goto fail;
1.170 nicm 133: }
1.60 nicm 134: umask(mask);
135:
1.170 nicm 136: if (listen(fd, 128) == -1) {
1.178 nicm 137: saved_errno = errno;
1.170 nicm 138: close(fd);
1.178 nicm 139: errno = saved_errno;
140: goto fail;
1.170 nicm 141: }
1.100 nicm 142: setblocking(fd, 0);
1.1 nicm 143:
1.60 nicm 144: return (fd);
1.178 nicm 145:
146: fail:
147: if (cause != NULL) {
148: xasprintf(cause, "error creating %s (%s)", socket_path,
149: strerror(errno));
150: }
151: return (-1);
152: }
153:
1.1 nicm 154: /* Fork new server. */
155: int
1.188 nicm 156: server_start(struct tmuxproc *client, int flags, struct event_base *base,
157: int lockfd, char *lockfile)
1.1 nicm 158: {
1.167 nicm 159: int pair[2];
1.175 nicm 160: sigset_t set, oldset;
1.195 ! nicm 161: struct client *c = NULL;
1.178 nicm 162: char *cause = NULL;
1.1 nicm 163:
1.175 nicm 164: sigfillset(&set);
165: sigprocmask(SIG_BLOCK, &set, &oldset);
1.191 nicm 166:
167: if (~flags & CLIENT_NOFORK) {
168: if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, pair) != 0)
169: fatal("socketpair failed");
170:
171: switch (fork()) {
172: case -1:
173: fatal("fork failed");
174: case 0:
175: break;
176: default:
177: sigprocmask(SIG_SETMASK, &oldset, NULL);
178: close(pair[1]);
179: return (pair[0]);
180: }
181: close(pair[0]);
182: if (daemon(1, 0) != 0)
183: fatal("daemon failed");
184: }
185:
186: server_client_flags = flags;
1.176 nicm 187: proc_clear_signals(client, 0);
1.191 nicm 188:
1.174 nicm 189: if (event_reinit(base) != 0)
190: fatalx("event_reinit failed");
191: server_proc = proc_start("server");
1.191 nicm 192:
1.174 nicm 193: proc_set_signals(server_proc, server_signal);
1.175 nicm 194: sigprocmask(SIG_SETMASK, &oldset, NULL);
1.143 nicm 195:
1.171 nicm 196: if (log_get_level() > 1)
1.146 nicm 197: tty_create_log();
1.151 nicm 198: if (pledge("stdio rpath wpath cpath fattr unix getpw recvfd proc exec "
199: "tty ps", NULL) != 0)
1.143 nicm 200: fatal("pledge failed");
1.1 nicm 201:
1.192 nicm 202: input_key_build();
1.121 nicm 203: RB_INIT(&windows);
1.102 nicm 204: RB_INIT(&all_window_panes);
1.122 nicm 205: TAILQ_INIT(&clients);
1.97 nicm 206: RB_INIT(&sessions);
1.1 nicm 207: key_bindings_init();
1.190 nicm 208: TAILQ_INIT(&message_log);
1.1 nicm 209:
1.153 nicm 210: gettimeofday(&start_time, NULL);
1.16 nicm 211:
1.188 nicm 212: server_fd = server_create_socket(flags, &cause);
1.178 nicm 213: if (server_fd != -1)
214: server_update_socket();
1.191 nicm 215: if (~flags & CLIENT_NOFORK)
216: c = server_client_create(pair[1]);
217: else
218: options_set_number(global_options, "exit-empty", 0);
1.103 nicm 219:
1.154 nicm 220: if (lockfd >= 0) {
221: unlink(lockfile);
222: free(lockfile);
223: close(lockfd);
224: }
1.16 nicm 225:
1.178 nicm 226: if (cause != NULL) {
1.195 ! nicm 227: if (c != NULL) {
! 228: cmdq_append(c, cmdq_get_error(cause));
! 229: c->flags |= CLIENT_EXIT;
! 230: }
1.185 nicm 231: free(cause);
1.187 nicm 232: }
1.178 nicm 233:
1.104 nicm 234: server_add_accept(0);
1.144 nicm 235: proc_loop(server_proc, server_loop);
1.167 nicm 236:
1.183 nicm 237: job_kill_all();
238: status_prompt_save_history();
1.167 nicm 239:
1.66 nicm 240: exit(0);
1.1 nicm 241: }
242:
1.144 nicm 243: /* Server loop callback. */
1.160 nicm 244: static int
1.66 nicm 245: server_loop(void)
1.1 nicm 246: {
1.144 nicm 247: struct client *c;
1.162 nicm 248: u_int items;
249:
250: do {
251: items = cmdq_next(NULL);
1.164 nicm 252: TAILQ_FOREACH(c, &clients, entry) {
253: if (c->flags & CLIENT_IDENTIFIED)
254: items += cmdq_next(c);
255: }
1.162 nicm 256: } while (items != 0);
1.31 nicm 257:
1.144 nicm 258: server_client_loop();
1.179 nicm 259:
260: if (!options_get_number(global_options, "exit-empty") && !server_exit)
261: return (0);
1.1 nicm 262:
1.145 nicm 263: if (!options_get_number(global_options, "exit-unattached")) {
1.97 nicm 264: if (!RB_EMPTY(&sessions))
265: return (0);
1.1 nicm 266: }
1.116 nicm 267:
1.122 nicm 268: TAILQ_FOREACH(c, &clients, entry) {
269: if (c->session != NULL)
1.116 nicm 270: return (0);
271: }
272:
273: /*
274: * No attached clients therefore want to exit - flush any waiting
275: * clients but don't actually exit until they've gone.
276: */
277: cmd_wait_for_flush();
1.122 nicm 278: if (!TAILQ_EMPTY(&clients))
279: return (0);
1.116 nicm 280:
1.183 nicm 281: if (job_still_running())
282: return (0);
1.180 nicm 283:
1.66 nicm 284: return (1);
1.1 nicm 285: }
286:
1.141 nicm 287: /* Exit the server by killing all clients and windows. */
1.160 nicm 288: static void
1.141 nicm 289: server_send_exit(void)
1.1 nicm 290: {
1.122 nicm 291: struct client *c, *c1;
292: struct session *s, *s1;
1.116 nicm 293:
294: cmd_wait_for_flush();
1.1 nicm 295:
1.122 nicm 296: TAILQ_FOREACH_SAFE(c, &clients, entry, c1) {
1.144 nicm 297: if (c->flags & CLIENT_SUSPENDED)
1.122 nicm 298: server_client_lost(c);
1.180 nicm 299: else {
1.193 nicm 300: c->flags |= CLIENT_EXIT;
301: c->exit_type = CLIENT_EXIT_SHUTDOWN;
1.180 nicm 302: }
1.122 nicm 303: c->session = NULL;
1.42 nicm 304: }
305:
1.122 nicm 306: RB_FOREACH_SAFE(s, sessions, &sessions, s1)
1.184 nicm 307: session_destroy(s, 1, __func__);
1.66 nicm 308: }
309:
310: /* Update socket execute permissions based on whether sessions are attached. */
1.75 nicm 311: void
1.66 nicm 312: server_update_socket(void)
1.42 nicm 313: {
1.66 nicm 314: struct session *s;
315: static int last = -1;
1.93 nicm 316: int n, mode;
317: struct stat sb;
1.1 nicm 318:
1.66 nicm 319: n = 0;
1.97 nicm 320: RB_FOREACH(s, sessions, &sessions) {
1.182 nicm 321: if (s->attached != 0) {
1.66 nicm 322: n++;
323: break;
324: }
325: }
326:
327: if (n != last) {
328: last = n;
1.93 nicm 329:
330: if (stat(socket_path, &sb) != 0)
331: return;
1.159 semarie 332: mode = sb.st_mode & ACCESSPERMS;
1.93 nicm 333: if (n != 0) {
334: if (mode & S_IRUSR)
335: mode |= S_IXUSR;
336: if (mode & S_IRGRP)
337: mode |= S_IXGRP;
338: if (mode & S_IROTH)
339: mode |= S_IXOTH;
340: } else
341: mode &= ~(S_IXUSR|S_IXGRP|S_IXOTH);
342: chmod(socket_path, mode);
1.66 nicm 343: }
344: }
345:
346: /* Callback for server socket. */
1.160 nicm 347: static void
1.150 nicm 348: server_accept(int fd, short events, __unused void *data)
1.66 nicm 349: {
350: struct sockaddr_storage sa;
351: socklen_t slen = sizeof sa;
352: int newfd;
353:
1.104 nicm 354: server_add_accept(0);
1.66 nicm 355: if (!(events & EV_READ))
356: return;
357:
358: newfd = accept(fd, (struct sockaddr *) &sa, &slen);
359: if (newfd == -1) {
360: if (errno == EAGAIN || errno == EINTR || errno == ECONNABORTED)
361: return;
1.104 nicm 362: if (errno == ENFILE || errno == EMFILE) {
363: /* Delete and don't try again for 1 second. */
364: server_add_accept(1);
365: return;
366: }
1.66 nicm 367: fatal("accept failed");
368: }
1.141 nicm 369: if (server_exit) {
1.66 nicm 370: close(newfd);
371: return;
1.42 nicm 372: }
1.66 nicm 373: server_client_create(newfd);
374: }
375:
1.104 nicm 376: /*
377: * Add accept event. If timeout is nonzero, add as a timeout instead of a read
378: * event - used to backoff when running out of file descriptors.
379: */
380: void
381: server_add_accept(int timeout)
382: {
383: struct timeval tv = { timeout, 0 };
1.186 nicm 384:
385: if (server_fd == -1)
386: return;
1.104 nicm 387:
388: if (event_initialized(&server_ev_accept))
389: event_del(&server_ev_accept);
390:
391: if (timeout == 0) {
1.144 nicm 392: event_set(&server_ev_accept, server_fd, EV_READ, server_accept,
393: NULL);
1.104 nicm 394: event_add(&server_ev_accept, NULL);
395: } else {
1.144 nicm 396: event_set(&server_ev_accept, server_fd, EV_TIMEOUT,
397: server_accept, NULL);
1.104 nicm 398: event_add(&server_ev_accept, &tv);
399: }
400: }
401:
1.66 nicm 402: /* Signal handler. */
1.160 nicm 403: static void
1.144 nicm 404: server_signal(int sig)
1.66 nicm 405: {
1.119 nicm 406: int fd;
1.120 nicm 407:
1.173 nicm 408: log_debug("%s: %s", __func__, strsignal(sig));
1.66 nicm 409: switch (sig) {
1.191 nicm 410: case SIGINT:
1.66 nicm 411: case SIGTERM:
1.141 nicm 412: server_exit = 1;
413: server_send_exit();
1.66 nicm 414: break;
415: case SIGCHLD:
416: server_child_signal();
417: break;
418: case SIGUSR1:
419: event_del(&server_ev_accept);
1.188 nicm 420: fd = server_create_socket(server_client_flags, NULL);
1.119 nicm 421: if (fd != -1) {
422: close(server_fd);
423: server_fd = fd;
424: server_update_socket();
425: }
1.104 nicm 426: server_add_accept(0);
1.171 nicm 427: break;
428: case SIGUSR2:
429: proc_toggle_log(server_proc);
1.66 nicm 430: break;
1.1 nicm 431: }
432: }
433:
434: /* Handle SIGCHLD. */
1.160 nicm 435: static void
1.1 nicm 436: server_child_signal(void)
437: {
1.66 nicm 438: int status;
439: pid_t pid;
1.1 nicm 440:
441: for (;;) {
442: switch (pid = waitpid(WAIT_ANY, &status, WNOHANG|WUNTRACED)) {
443: case -1:
444: if (errno == ECHILD)
445: return;
1.39 nicm 446: fatal("waitpid failed");
1.1 nicm 447: case 0:
448: return;
449: }
1.66 nicm 450: if (WIFSTOPPED(status))
451: server_child_stopped(pid, status);
1.79 nicm 452: else if (WIFEXITED(status) || WIFSIGNALED(status))
1.66 nicm 453: server_child_exited(pid, status);
454: }
455: }
456:
457: /* Handle exited children. */
1.160 nicm 458: static void
1.66 nicm 459: server_child_exited(pid_t pid, int status)
460: {
1.121 nicm 461: struct window *w, *w1;
1.66 nicm 462: struct window_pane *wp;
463:
1.121 nicm 464: RB_FOREACH_SAFE(w, windows, &windows, w1) {
1.66 nicm 465: TAILQ_FOREACH(wp, &w->panes, entry) {
466: if (wp->pid == pid) {
1.118 nicm 467: wp->status = status;
1.177 nicm 468: wp->flags |= PANE_STATUSREADY;
1.172 nicm 469:
470: log_debug("%%%u exited", wp->id);
471: wp->flags |= PANE_EXITED;
472:
473: if (window_pane_destroy_ready(wp))
474: server_destroy_pane(wp, 1);
1.77 nicm 475: break;
1.53 nicm 476: }
477: }
1.80 nicm 478: }
1.183 nicm 479: job_check_died(pid, status);
1.53 nicm 480: }
481:
1.66 nicm 482: /* Handle stopped children. */
1.160 nicm 483: static void
1.66 nicm 484: server_child_stopped(pid_t pid, int status)
1.31 nicm 485: {
1.66 nicm 486: struct window *w;
487: struct window_pane *wp;
1.31 nicm 488:
1.66 nicm 489: if (WSTOPSIG(status) == SIGTTIN || WSTOPSIG(status) == SIGTTOU)
490: return;
1.31 nicm 491:
1.121 nicm 492: RB_FOREACH(w, windows, &windows) {
1.66 nicm 493: TAILQ_FOREACH(wp, &w->panes, entry) {
494: if (wp->pid == pid) {
495: if (killpg(pid, SIGCONT) != 0)
496: kill(pid, SIGCONT);
497: }
1.1 nicm 498: }
499: }
1.189 nicm 500: job_check_died(pid, status);
1.190 nicm 501: }
502:
503: /* Add to message log. */
504: void
505: server_add_message(const char *fmt, ...)
506: {
507: struct message_entry *msg, *msg1;
508: char *s;
509: va_list ap;
510: u_int limit;
511:
512: va_start(ap, fmt);
513: xvasprintf(&s, fmt, ap);
514: va_end(ap);
515:
516: log_debug("message: %s", s);
517:
518: msg = xcalloc(1, sizeof *msg);
519: gettimeofday(&msg->msg_time, NULL);
520: msg->msg_num = message_next++;
521: msg->msg = s;
522: TAILQ_INSERT_TAIL(&message_log, msg, entry);
523:
524: limit = options_get_number(global_options, "message-limit");
525: TAILQ_FOREACH_SAFE(msg, &message_log, entry, msg1) {
526: if (msg->msg_num + limit >= message_next)
527: break;
528: free(msg->msg);
529: TAILQ_REMOVE(&message_log, msg, entry);
530: free(msg);
531: }
1.1 nicm 532: }