Annotation of src/usr.bin/tmux/server.c, Revision 1.127
1.127 ! nicm 1: /* $OpenBSD: server.c,v 1.126 2015/06/04 11:43:51 nicm Exp $ */
1.1 nicm 2:
3: /*
4: * Copyright (c) 2007 Nicholas Marriott <nicm@users.sourceforge.net>
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:
44: struct clients clients;
45:
1.66 nicm 46: int server_fd;
47: int server_shutdown;
48: struct event server_ev_accept;
49: struct event server_ev_second;
1.45 nicm 50:
1.126 nicm 51: struct session *marked_session;
52: struct winlink *marked_winlink;
53: struct window *marked_window;
54: struct window_pane *marked_window_pane;
55: struct layout_cell *marked_layout_cell;
56:
57: int server_create_socket(void);
58: void server_loop(void);
59: int server_should_shutdown(void);
60: void server_send_shutdown(void);
61: void server_clean_dead(void);
62: void server_accept_callback(int, short, void *);
63: void server_signal_callback(int, short, void *);
64: void server_child_signal(void);
65: void server_child_exited(pid_t, int);
66: void server_child_stopped(pid_t, int);
67: void server_second_callback(int, short, void *);
68: void server_lock_server(void);
69: void server_lock_sessions(void);
70:
71: /* Set marked pane. */
72: void
73: server_set_marked(struct session *s, struct winlink *wl, struct window_pane *wp)
74: {
75: marked_session = s;
76: marked_winlink = wl;
77: marked_window = wl->window;
78: marked_window_pane = wp;
79: marked_layout_cell = wp->layout_cell;
80: }
81:
82: /* Clear marked pane. */
83: void
84: server_clear_marked(void)
85: {
86: marked_session = NULL;
87: marked_winlink = NULL;
88: marked_window = NULL;
89: marked_window_pane = NULL;
90: marked_layout_cell = NULL;
91: }
92:
93: /* Is this the marked pane? */
94: int
95: server_is_marked(struct session *s, struct winlink *wl, struct window_pane *wp)
96: {
97: if (s == NULL || wl == NULL || wp == NULL)
98: return (0);
99: if (marked_session != s || marked_winlink != wl)
100: return (0);
101: if (marked_window_pane != wp)
102: return (0);
103: return (server_check_marked());
104: }
105:
106: /* Check if the marked pane is still valid. */
107: int
108: server_check_marked(void)
109: {
110: struct winlink *wl;
111:
112: if (marked_window_pane == NULL)
113: return (0);
114: if (marked_layout_cell != marked_window_pane->layout_cell)
115: return (0);
116:
117: if (!session_alive(marked_session))
118: return (0);
119: RB_FOREACH(wl, winlinks, &marked_session->windows) {
120: if (wl->window == marked_window && wl == marked_winlink)
121: break;
122: }
123: if (wl == NULL)
124: return (0);
125:
126: if (!window_has_pane(marked_window, marked_window_pane))
127: return (0);
128: return (window_pane_visible(marked_window_pane));
129: }
1.45 nicm 130:
1.60 nicm 131: /* Create server socket. */
132: int
133: server_create_socket(void)
1.1 nicm 134: {
1.60 nicm 135: struct sockaddr_un sa;
136: size_t size;
137: mode_t mask;
1.100 nicm 138: int fd;
1.60 nicm 139:
140: memset(&sa, 0, sizeof sa);
141: sa.sun_family = AF_UNIX;
142: size = strlcpy(sa.sun_path, socket_path, sizeof sa.sun_path);
143: if (size >= sizeof sa.sun_path) {
144: errno = ENAMETOOLONG;
1.119 nicm 145: return (-1);
1.60 nicm 146: }
147: unlink(sa.sun_path);
148:
149: if ((fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1)
1.119 nicm 150: return (-1);
1.60 nicm 151:
1.89 nicm 152: mask = umask(S_IXUSR|S_IXGRP|S_IRWXO);
1.60 nicm 153: if (bind(fd, (struct sockaddr *) &sa, SUN_LEN(&sa)) == -1)
1.119 nicm 154: return (-1);
1.60 nicm 155: umask(mask);
156:
157: if (listen(fd, 16) == -1)
1.119 nicm 158: return (-1);
1.100 nicm 159: setblocking(fd, 0);
1.1 nicm 160:
1.60 nicm 161: return (fd);
162: }
163:
1.1 nicm 164: /* Fork new server. */
165: int
1.103 nicm 166: server_start(int lockfd, char *lockfile)
1.1 nicm 167: {
1.109 nicm 168: int pair[2];
169: struct timeval tv;
170: char *cause;
1.1 nicm 171:
172: /* The first client is special and gets a socketpair; create it. */
173: if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, pair) != 0)
174: fatal("socketpair failed");
1.115 nicm 175: log_debug("starting server");
1.1 nicm 176:
177: switch (fork()) {
178: case -1:
179: fatal("fork failed");
180: case 0:
181: break;
182: default:
183: close(pair[1]);
184: return (pair[0]);
185: }
186: close(pair[0]);
187:
188: /*
189: * Must daemonise before loading configuration as the PID changes so
190: * $TMUX would be wrong for sessions created in the config file.
191: */
1.16 nicm 192: if (daemon(1, 0) != 0)
1.1 nicm 193: fatal("daemon failed");
194:
1.88 nicm 195: /* event_init() was called in our parent, need to reinit. */
1.125 nicm 196: clear_signals(0);
1.88 nicm 197: if (event_reinit(ev_base) != 0)
198: fatal("event_reinit failed");
199:
1.16 nicm 200: logfile("server");
201: log_debug("server started, pid %ld", (long) getpid());
202:
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);
207: RB_INIT(&dead_sessions);
1.47 nicm 208: TAILQ_INIT(&session_groups);
1.15 nicm 209: mode_key_init_trees();
1.1 nicm 210: key_bindings_init();
211: utf8_build();
212:
213: start_time = time(NULL);
1.16 nicm 214: log_debug("socket path %s", socket_path);
1.96 nicm 215: setproctitle("server (%s)", socket_path);
1.16 nicm 216:
1.66 nicm 217: server_fd = server_create_socket();
1.119 nicm 218: if (server_fd == -1)
219: fatal("couldn't create socket");
220: server_update_socket();
1.60 nicm 221: server_client_create(pair[1]);
1.103 nicm 222:
223: unlink(lockfile);
1.105 nicm 224: free(lockfile);
1.103 nicm 225: close(lockfd);
1.16 nicm 226:
1.109 nicm 227: cfg_cmd_q = cmdq_new(NULL);
228: cfg_cmd_q->emptyfn = cfg_default_done;
229: cfg_finished = 0;
230: cfg_references = 1;
1.122 nicm 231: cfg_client = TAILQ_FIRST(&clients);
1.111 nicm 232: if (cfg_client != NULL)
233: cfg_client->references++;
1.109 nicm 234:
1.110 nicm 235: if (access(TMUX_CONF, R_OK) == 0) {
1.117 nicm 236: if (load_cfg(TMUX_CONF, cfg_cmd_q, &cause) == -1)
237: cfg_add_cause("%s: %s", TMUX_CONF, cause);
238: } else if (errno != ENOENT)
239: cfg_add_cause("%s: %s", TMUX_CONF, strerror(errno));
1.109 nicm 240: if (cfg_file != NULL) {
1.117 nicm 241: if (load_cfg(cfg_file, cfg_cmd_q, &cause) == -1)
242: cfg_add_cause("%s: %s", cfg_file, cause);
1.109 nicm 243: }
244: cmdq_continue(cfg_cmd_q);
1.66 nicm 245:
1.104 nicm 246: server_add_accept(0);
1.66 nicm 247:
248: memset(&tv, 0, sizeof tv);
249: tv.tv_sec = 1;
250: evtimer_set(&server_ev_second, server_second_callback, NULL);
251: evtimer_add(&server_ev_second, &tv);
252:
1.88 nicm 253: set_signals(server_signal_callback);
1.66 nicm 254: server_loop();
255: exit(0);
1.1 nicm 256: }
257:
258: /* Main server loop. */
1.66 nicm 259: void
260: server_loop(void)
1.1 nicm 261: {
1.66 nicm 262: while (!server_should_shutdown()) {
263: event_loop(EVLOOP_ONCE);
1.1 nicm 264:
1.60 nicm 265: server_window_loop();
266: server_client_loop();
1.1 nicm 267:
1.66 nicm 268: server_clean_dead();
1.80 nicm 269: }
1.66 nicm 270: }
1.31 nicm 271:
1.112 nicm 272: /* Check if the server should exit (no more clients or sessions). */
1.66 nicm 273: int
274: server_should_shutdown(void)
275: {
1.116 nicm 276: struct client *c;
1.1 nicm 277:
1.94 nicm 278: if (!options_get_number(&global_options, "exit-unattached")) {
1.97 nicm 279: if (!RB_EMPTY(&sessions))
280: return (0);
1.1 nicm 281: }
1.116 nicm 282:
1.122 nicm 283: TAILQ_FOREACH(c, &clients, entry) {
284: if (c->session != NULL)
1.116 nicm 285: return (0);
286: }
287:
288: /*
289: * No attached clients therefore want to exit - flush any waiting
290: * clients but don't actually exit until they've gone.
291: */
292: cmd_wait_for_flush();
1.122 nicm 293: if (!TAILQ_EMPTY(&clients))
294: return (0);
1.116 nicm 295:
1.66 nicm 296: return (1);
1.1 nicm 297: }
298:
1.66 nicm 299: /* Shutdown the server by killing all clients and windows. */
1.1 nicm 300: void
1.66 nicm 301: server_send_shutdown(void)
1.1 nicm 302: {
1.122 nicm 303: struct client *c, *c1;
304: struct session *s, *s1;
1.116 nicm 305:
306: cmd_wait_for_flush();
1.1 nicm 307:
1.122 nicm 308: TAILQ_FOREACH_SAFE(c, &clients, entry, c1) {
309: if (c->flags & (CLIENT_BAD|CLIENT_SUSPENDED))
310: server_client_lost(c);
311: else
312: server_write_client(c, MSG_SHUTDOWN, NULL, 0);
313: c->session = NULL;
1.42 nicm 314: }
315:
1.122 nicm 316: RB_FOREACH_SAFE(s, sessions, &sessions, s1)
1.97 nicm 317: session_destroy(s);
1.42 nicm 318: }
319:
1.66 nicm 320: /* Free dead, unreferenced clients and sessions. */
321: void
322: server_clean_dead(void)
323: {
1.122 nicm 324: struct session *s, *s1;
1.66 nicm 325:
1.122 nicm 326: RB_FOREACH_SAFE(s, sessions, &dead_sessions, s1) {
327: if (s->references != 0)
328: continue;
329: RB_REMOVE(sessions, &dead_sessions, s);
330: free(s->name);
331: free(s);
1.66 nicm 332: }
333: }
334:
335: /* Update socket execute permissions based on whether sessions are attached. */
1.75 nicm 336: void
1.66 nicm 337: server_update_socket(void)
1.42 nicm 338: {
1.66 nicm 339: struct session *s;
340: static int last = -1;
1.93 nicm 341: int n, mode;
342: struct stat sb;
1.1 nicm 343:
1.66 nicm 344: n = 0;
1.97 nicm 345: RB_FOREACH(s, sessions, &sessions) {
346: if (!(s->flags & SESSION_UNATTACHED)) {
1.66 nicm 347: n++;
348: break;
349: }
350: }
351:
352: if (n != last) {
353: last = n;
1.93 nicm 354:
355: if (stat(socket_path, &sb) != 0)
356: return;
357: mode = sb.st_mode;
358: if (n != 0) {
359: if (mode & S_IRUSR)
360: mode |= S_IXUSR;
361: if (mode & S_IRGRP)
362: mode |= S_IXGRP;
363: if (mode & S_IROTH)
364: mode |= S_IXOTH;
365: } else
366: mode &= ~(S_IXUSR|S_IXGRP|S_IXOTH);
367: chmod(socket_path, mode);
1.66 nicm 368: }
369: }
370:
371: /* Callback for server socket. */
372: void
373: server_accept_callback(int fd, short events, unused void *data)
374: {
375: struct sockaddr_storage sa;
376: socklen_t slen = sizeof sa;
377: int newfd;
378:
1.104 nicm 379: server_add_accept(0);
1.66 nicm 380: if (!(events & EV_READ))
381: return;
382:
383: newfd = accept(fd, (struct sockaddr *) &sa, &slen);
384: if (newfd == -1) {
385: if (errno == EAGAIN || errno == EINTR || errno == ECONNABORTED)
386: return;
1.104 nicm 387: if (errno == ENFILE || errno == EMFILE) {
388: /* Delete and don't try again for 1 second. */
389: server_add_accept(1);
390: return;
391: }
1.66 nicm 392: fatal("accept failed");
393: }
394: if (server_shutdown) {
395: close(newfd);
396: return;
1.42 nicm 397: }
1.66 nicm 398: server_client_create(newfd);
399: }
400:
1.104 nicm 401: /*
402: * Add accept event. If timeout is nonzero, add as a timeout instead of a read
403: * event - used to backoff when running out of file descriptors.
404: */
405: void
406: server_add_accept(int timeout)
407: {
408: struct timeval tv = { timeout, 0 };
409:
410: if (event_initialized(&server_ev_accept))
411: event_del(&server_ev_accept);
412:
413: if (timeout == 0) {
414: event_set(&server_ev_accept,
415: server_fd, EV_READ, server_accept_callback, NULL);
416: event_add(&server_ev_accept, NULL);
417: } else {
418: event_set(&server_ev_accept,
419: server_fd, EV_TIMEOUT, server_accept_callback, NULL);
420: event_add(&server_ev_accept, &tv);
421: }
422: }
423:
1.66 nicm 424: /* Signal handler. */
425: void
426: server_signal_callback(int sig, unused short events, unused void *data)
427: {
1.119 nicm 428: int fd;
1.120 nicm 429:
1.66 nicm 430: switch (sig) {
431: case SIGTERM:
432: server_shutdown = 1;
433: server_send_shutdown();
434: break;
435: case SIGCHLD:
436: server_child_signal();
437: break;
438: case SIGUSR1:
439: event_del(&server_ev_accept);
1.119 nicm 440: fd = server_create_socket();
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.66 nicm 447: break;
1.1 nicm 448: }
449: }
450:
451: /* Handle SIGCHLD. */
452: void
453: server_child_signal(void)
454: {
1.66 nicm 455: int status;
456: pid_t pid;
1.1 nicm 457:
458: for (;;) {
459: switch (pid = waitpid(WAIT_ANY, &status, WNOHANG|WUNTRACED)) {
460: case -1:
461: if (errno == ECHILD)
462: return;
1.39 nicm 463: fatal("waitpid failed");
1.1 nicm 464: case 0:
465: return;
466: }
1.66 nicm 467: if (WIFSTOPPED(status))
468: server_child_stopped(pid, status);
1.79 nicm 469: else if (WIFEXITED(status) || WIFSIGNALED(status))
1.66 nicm 470: server_child_exited(pid, status);
471: }
472: }
473:
474: /* Handle exited children. */
475: void
476: server_child_exited(pid_t pid, int status)
477: {
1.121 nicm 478: struct window *w, *w1;
1.66 nicm 479: struct window_pane *wp;
480: struct job *job;
481:
1.121 nicm 482: RB_FOREACH_SAFE(w, windows, &windows, w1) {
1.66 nicm 483: TAILQ_FOREACH(wp, &w->panes, entry) {
484: if (wp->pid == pid) {
1.118 nicm 485: wp->status = status;
1.77 nicm 486: server_destroy_pane(wp);
487: break;
1.53 nicm 488: }
489: }
1.80 nicm 490: }
1.1 nicm 491:
1.101 nicm 492: LIST_FOREACH(job, &all_jobs, lentry) {
1.66 nicm 493: if (pid == job->pid) {
1.67 nicm 494: job_died(job, status); /* might free job */
495: break;
1.1 nicm 496: }
1.53 nicm 497: }
498: }
499:
1.66 nicm 500: /* Handle stopped children. */
1.31 nicm 501: void
1.66 nicm 502: server_child_stopped(pid_t pid, int status)
1.31 nicm 503: {
1.66 nicm 504: struct window *w;
505: struct window_pane *wp;
1.31 nicm 506:
1.66 nicm 507: if (WSTOPSIG(status) == SIGTTIN || WSTOPSIG(status) == SIGTTOU)
508: return;
1.31 nicm 509:
1.121 nicm 510: RB_FOREACH(w, windows, &windows) {
1.66 nicm 511: TAILQ_FOREACH(wp, &w->panes, entry) {
512: if (wp->pid == pid) {
513: if (killpg(pid, SIGCONT) != 0)
514: kill(pid, SIGCONT);
515: }
516: }
1.31 nicm 517: }
1.1 nicm 518: }
519:
1.66 nicm 520: /* Handle once-per-second timer events. */
1.1 nicm 521: void
1.66 nicm 522: server_second_callback(unused int fd, unused short events, unused void *arg)
1.1 nicm 523: {
1.60 nicm 524: struct window *w;
525: struct window_pane *wp;
1.66 nicm 526: struct timeval tv;
1.1 nicm 527:
1.60 nicm 528: if (options_get_number(&global_s_options, "lock-server"))
529: server_lock_server();
530: else
531: server_lock_sessions();
1.1 nicm 532:
1.121 nicm 533: RB_FOREACH(w, windows, &windows) {
1.60 nicm 534: TAILQ_FOREACH(wp, &w->panes, entry) {
535: if (wp->mode != NULL && wp->mode->timer != NULL)
536: wp->mode->timer(wp);
1.1 nicm 537: }
538: }
1.72 nicm 539:
540: server_client_status_timer();
1.123 nicm 541:
542: format_clean();
1.66 nicm 543:
544: evtimer_del(&server_ev_second);
545: memset(&tv, 0, sizeof tv);
546: tv.tv_sec = 1;
547: evtimer_add(&server_ev_second, &tv);
1.1 nicm 548: }
549:
1.46 nicm 550: /* Lock the server if ALL sessions have hit the time limit. */
551: void
552: server_lock_server(void)
553: {
554: struct session *s;
555: int timeout;
556: time_t t;
557:
558: t = time(NULL);
1.97 nicm 559: RB_FOREACH(s, sessions, &sessions) {
1.99 nicm 560: if (s->flags & SESSION_UNATTACHED)
1.59 nicm 561: continue;
1.46 nicm 562: timeout = options_get_number(&s->options, "lock-after-time");
1.65 nicm 563: if (timeout <= 0 || t <= s->activity_time.tv_sec + timeout)
1.46 nicm 564: return; /* not timed out */
565: }
566:
567: server_lock();
568: recalculate_sizes();
569: }
570:
571: /* Lock any sessions which have timed out. */
572: void
573: server_lock_sessions(void)
574: {
1.80 nicm 575: struct session *s;
1.46 nicm 576: int timeout;
1.62 deraadt 577: time_t t;
1.46 nicm 578:
1.62 deraadt 579: t = time(NULL);
1.97 nicm 580: RB_FOREACH(s, sessions, &sessions) {
1.99 nicm 581: if (s->flags & SESSION_UNATTACHED)
1.59 nicm 582: continue;
1.46 nicm 583: timeout = options_get_number(&s->options, "lock-after-time");
1.65 nicm 584: if (timeout > 0 && t > s->activity_time.tv_sec + timeout) {
1.46 nicm 585: server_lock_session(s);
586: recalculate_sizes();
1.1 nicm 587: }
588: }
589: }