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