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