Annotation of src/usr.bin/tmux/server.c, Revision 1.95
1.95 ! nicm 1: /* $OpenBSD: server.c,v 1.94 2010/09/26 20:43:30 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 <syslog.h>
35: #include <termios.h>
36: #include <time.h>
37: #include <unistd.h>
38:
39: #include "tmux.h"
40:
41: /*
42: * Main server functions.
43: */
44:
45: /* Client list. */
46: struct clients clients;
1.31 nicm 47: struct clients dead_clients;
1.1 nicm 48:
1.66 nicm 49: int server_fd;
50: int server_shutdown;
51: struct event server_ev_accept;
52: struct event server_ev_second;
1.45 nicm 53:
1.1 nicm 54: int server_create_socket(void);
1.66 nicm 55: void server_loop(void);
1.42 nicm 56: int server_should_shutdown(void);
1.66 nicm 57: void server_send_shutdown(void);
58: void server_clean_dead(void);
59: void server_accept_callback(int, short, void *);
60: void server_signal_callback(int, short, void *);
1.1 nicm 61: void server_child_signal(void);
1.66 nicm 62: void server_child_exited(pid_t, int);
63: void server_child_stopped(pid_t, int);
64: void server_second_callback(int, short, void *);
1.46 nicm 65: void server_lock_server(void);
66: void server_lock_sessions(void);
1.45 nicm 67:
1.60 nicm 68: /* Create server socket. */
69: int
70: server_create_socket(void)
1.1 nicm 71: {
1.60 nicm 72: struct sockaddr_un sa;
73: size_t size;
74: mode_t mask;
75: int fd, mode;
76:
77: memset(&sa, 0, sizeof sa);
78: sa.sun_family = AF_UNIX;
79: size = strlcpy(sa.sun_path, socket_path, sizeof sa.sun_path);
80: if (size >= sizeof sa.sun_path) {
81: errno = ENAMETOOLONG;
82: fatal("socket failed");
83: }
84: unlink(sa.sun_path);
85:
86: if ((fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1)
87: fatal("socket failed");
88:
1.89 nicm 89: mask = umask(S_IXUSR|S_IXGRP|S_IRWXO);
1.60 nicm 90: if (bind(fd, (struct sockaddr *) &sa, SUN_LEN(&sa)) == -1)
91: fatal("bind failed");
92: umask(mask);
93:
94: if (listen(fd, 16) == -1)
95: fatal("listen failed");
1.1 nicm 96:
97: if ((mode = fcntl(fd, F_GETFL)) == -1)
98: fatal("fcntl failed");
99: if (fcntl(fd, F_SETFL, mode|O_NONBLOCK) == -1)
100: fatal("fcntl failed");
101:
1.75 nicm 102: server_update_socket();
103:
1.60 nicm 104: return (fd);
105: }
106:
1.1 nicm 107: /* Fork new server. */
108: int
109: server_start(char *path)
110: {
1.82 nicm 111: struct window_pane *wp;
1.84 nicm 112: int pair[2];
1.83 nicm 113: char rpathbuf[MAXPATHLEN], *cause;
1.82 nicm 114: struct timeval tv;
115: u_int i;
1.1 nicm 116:
117: /* The first client is special and gets a socketpair; create it. */
118: if (socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC, pair) != 0)
119: fatal("socketpair failed");
120:
121: switch (fork()) {
122: case -1:
123: fatal("fork failed");
124: case 0:
125: break;
126: default:
127: close(pair[1]);
128: return (pair[0]);
129: }
130: close(pair[0]);
131:
132: /*
133: * Must daemonise before loading configuration as the PID changes so
134: * $TMUX would be wrong for sessions created in the config file.
135: */
1.16 nicm 136: if (daemon(1, 0) != 0)
1.1 nicm 137: fatal("daemon failed");
138:
1.88 nicm 139: /* event_init() was called in our parent, need to reinit. */
140: if (event_reinit(ev_base) != 0)
141: fatal("event_reinit failed");
1.92 nicm 142: clear_signals(0);
1.88 nicm 143:
1.16 nicm 144: logfile("server");
145: log_debug("server started, pid %ld", (long) getpid());
146:
1.1 nicm 147: ARRAY_INIT(&windows);
148: ARRAY_INIT(&clients);
1.31 nicm 149: ARRAY_INIT(&dead_clients);
1.1 nicm 150: ARRAY_INIT(&sessions);
1.31 nicm 151: ARRAY_INIT(&dead_sessions);
1.47 nicm 152: TAILQ_INIT(&session_groups);
1.15 nicm 153: mode_key_init_trees();
1.1 nicm 154: key_bindings_init();
155: utf8_build();
156:
157: start_time = time(NULL);
158: socket_path = path;
159:
1.16 nicm 160: if (realpath(socket_path, rpathbuf) == NULL)
161: strlcpy(rpathbuf, socket_path, sizeof rpathbuf);
162: log_debug("socket path %s", socket_path);
163: setproctitle("server (%s)", rpathbuf);
164:
1.66 nicm 165: server_fd = server_create_socket();
1.60 nicm 166: server_client_create(pair[1]);
1.16 nicm 167:
1.82 nicm 168: if (access(SYSTEM_CFG, R_OK) == 0)
1.83 nicm 169: load_cfg(SYSTEM_CFG, NULL, &cfg_causes);
1.82 nicm 170: else if (errno != ENOENT) {
1.83 nicm 171: cfg_add_cause(
172: &cfg_causes, "%s: %s", strerror(errno), SYSTEM_CFG);
1.64 nicm 173: }
1.82 nicm 174: if (cfg_file != NULL)
1.83 nicm 175: load_cfg(cfg_file, NULL, &cfg_causes);
1.82 nicm 176:
177: /*
178: * If there is a session already, put the current window and pane into
179: * more mode.
180: */
1.83 nicm 181: if (!ARRAY_EMPTY(&sessions) && !ARRAY_EMPTY(&cfg_causes)) {
1.82 nicm 182: wp = ARRAY_FIRST(&sessions)->curw->window->active;
1.85 nicm 183: window_pane_set_mode(wp, &window_copy_mode);
184: window_copy_init_for_output(wp);
1.83 nicm 185: for (i = 0; i < ARRAY_LENGTH(&cfg_causes); i++) {
186: cause = ARRAY_ITEM(&cfg_causes, i);
1.85 nicm 187: window_copy_add(wp, "%s", cause);
1.83 nicm 188: xfree(cause);
1.82 nicm 189: }
1.83 nicm 190: ARRAY_FREE(&cfg_causes);
1.82 nicm 191: }
192: cfg_finished = 1;
1.66 nicm 193:
194: event_set(&server_ev_accept,
195: server_fd, EV_READ|EV_PERSIST, server_accept_callback, NULL);
196: event_add(&server_ev_accept, NULL);
197:
198: memset(&tv, 0, sizeof tv);
199: tv.tv_sec = 1;
200: evtimer_set(&server_ev_second, server_second_callback, NULL);
201: evtimer_add(&server_ev_second, &tv);
202:
1.88 nicm 203: set_signals(server_signal_callback);
1.66 nicm 204: server_loop();
205: exit(0);
1.1 nicm 206: }
207:
208: /* Main server loop. */
1.66 nicm 209: void
210: server_loop(void)
1.1 nicm 211: {
1.66 nicm 212: while (!server_should_shutdown()) {
213: event_loop(EVLOOP_ONCE);
1.1 nicm 214:
1.60 nicm 215: server_window_loop();
216: server_client_loop();
1.1 nicm 217:
1.8 nicm 218: key_bindings_clean();
1.66 nicm 219: server_clean_dead();
1.80 nicm 220: }
1.66 nicm 221: }
1.31 nicm 222:
1.94 nicm 223: /* Check if the server should be shutting down (no more clients or sessions). */
1.66 nicm 224: int
225: server_should_shutdown(void)
226: {
227: u_int i;
1.1 nicm 228:
1.94 nicm 229: if (!options_get_number(&global_options, "exit-unattached")) {
230: for (i = 0; i < ARRAY_LENGTH(&sessions); i++) {
231: if (ARRAY_ITEM(&sessions, i) != NULL)
232: return (0);
233: }
1.1 nicm 234: }
235: for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
236: if (ARRAY_ITEM(&clients, i) != NULL)
1.66 nicm 237: return (0);
1.1 nicm 238: }
1.66 nicm 239: return (1);
1.1 nicm 240: }
241:
1.66 nicm 242: /* Shutdown the server by killing all clients and windows. */
1.1 nicm 243: void
1.66 nicm 244: server_send_shutdown(void)
1.1 nicm 245: {
1.66 nicm 246: struct client *c;
1.1 nicm 247: struct session *s;
1.66 nicm 248: u_int i;
1.1 nicm 249:
1.42 nicm 250: for (i = 0; i < ARRAY_LENGTH(&clients); i++) {
251: c = ARRAY_ITEM(&clients, i);
252: if (c != NULL) {
253: if (c->flags & (CLIENT_BAD|CLIENT_SUSPENDED))
1.60 nicm 254: server_client_lost(c);
1.42 nicm 255: else
256: server_write_client(c, MSG_SHUTDOWN, NULL, 0);
1.66 nicm 257: c->session = NULL;
1.42 nicm 258: }
259: }
260:
1.1 nicm 261: for (i = 0; i < ARRAY_LENGTH(&sessions); i++) {
1.66 nicm 262: if ((s = ARRAY_ITEM(&sessions, i)) != NULL)
1.1 nicm 263: session_destroy(s);
264: }
1.42 nicm 265: }
266:
1.66 nicm 267: /* Free dead, unreferenced clients and sessions. */
268: void
269: server_clean_dead(void)
270: {
271: struct session *s;
272: struct client *c;
273: u_int i;
274:
275: for (i = 0; i < ARRAY_LENGTH(&dead_sessions); i++) {
276: s = ARRAY_ITEM(&dead_sessions, i);
277: if (s == NULL || s->references != 0)
278: continue;
279: ARRAY_SET(&dead_sessions, i, NULL);
280: xfree(s);
281: }
282:
283: for (i = 0; i < ARRAY_LENGTH(&dead_clients); i++) {
284: c = ARRAY_ITEM(&dead_clients, i);
285: if (c == NULL || c->references != 0)
286: continue;
287: ARRAY_SET(&dead_clients, i, NULL);
288: xfree(c);
289: }
290: }
291:
292: /* Update socket execute permissions based on whether sessions are attached. */
1.75 nicm 293: void
1.66 nicm 294: server_update_socket(void)
1.42 nicm 295: {
1.66 nicm 296: struct session *s;
297: u_int i;
298: static int last = -1;
1.93 nicm 299: int n, mode;
300: struct stat sb;
1.1 nicm 301:
1.66 nicm 302: n = 0;
1.42 nicm 303: for (i = 0; i < ARRAY_LENGTH(&sessions); i++) {
1.66 nicm 304: s = ARRAY_ITEM(&sessions, i);
305: if (s != NULL && !(s->flags & SESSION_UNATTACHED)) {
306: n++;
307: break;
308: }
309: }
310:
311: if (n != last) {
312: last = n;
1.93 nicm 313:
314: if (stat(socket_path, &sb) != 0)
315: return;
316: mode = sb.st_mode;
317: if (n != 0) {
318: if (mode & S_IRUSR)
319: mode |= S_IXUSR;
320: if (mode & S_IRGRP)
321: mode |= S_IXGRP;
322: if (mode & S_IROTH)
323: mode |= S_IXOTH;
324: } else
325: mode &= ~(S_IXUSR|S_IXGRP|S_IXOTH);
326: chmod(socket_path, mode);
1.66 nicm 327: }
328: }
329:
330: /* Callback for server socket. */
1.78 nicm 331: /* ARGSUSED */
1.66 nicm 332: void
333: server_accept_callback(int fd, short events, unused void *data)
334: {
335: struct sockaddr_storage sa;
336: socklen_t slen = sizeof sa;
337: int newfd;
338:
339: if (!(events & EV_READ))
340: return;
341:
342: newfd = accept(fd, (struct sockaddr *) &sa, &slen);
343: if (newfd == -1) {
344: if (errno == EAGAIN || errno == EINTR || errno == ECONNABORTED)
345: return;
346: fatal("accept failed");
347: }
348: if (server_shutdown) {
349: close(newfd);
350: return;
1.42 nicm 351: }
1.66 nicm 352: server_client_create(newfd);
353: }
354:
355: /* Signal handler. */
1.78 nicm 356: /* ARGSUSED */
1.66 nicm 357: void
358: server_signal_callback(int sig, unused short events, unused void *data)
359: {
360: switch (sig) {
361: case SIGTERM:
362: server_shutdown = 1;
363: server_send_shutdown();
364: break;
365: case SIGCHLD:
366: server_child_signal();
367: break;
368: case SIGUSR1:
369: event_del(&server_ev_accept);
370: close(server_fd);
371: server_fd = server_create_socket();
372: event_set(&server_ev_accept, server_fd,
373: EV_READ|EV_PERSIST, server_accept_callback, NULL);
374: event_add(&server_ev_accept, NULL);
375: break;
1.1 nicm 376: }
377: }
378:
379: /* Handle SIGCHLD. */
380: void
381: server_child_signal(void)
382: {
1.66 nicm 383: int status;
384: pid_t pid;
1.1 nicm 385:
386: for (;;) {
387: switch (pid = waitpid(WAIT_ANY, &status, WNOHANG|WUNTRACED)) {
388: case -1:
389: if (errno == ECHILD)
390: return;
1.39 nicm 391: fatal("waitpid failed");
1.1 nicm 392: case 0:
393: return;
394: }
1.66 nicm 395: if (WIFSTOPPED(status))
396: server_child_stopped(pid, status);
1.79 nicm 397: else if (WIFEXITED(status) || WIFSIGNALED(status))
1.66 nicm 398: server_child_exited(pid, status);
399: }
400: }
401:
402: /* Handle exited children. */
403: void
404: server_child_exited(pid_t pid, int status)
405: {
406: struct window *w;
407: struct window_pane *wp;
408: struct job *job;
409: u_int i;
410:
411: for (i = 0; i < ARRAY_LENGTH(&windows); i++) {
412: if ((w = ARRAY_ITEM(&windows, i)) == NULL)
413: continue;
414: TAILQ_FOREACH(wp, &w->panes, entry) {
415: if (wp->pid == pid) {
1.77 nicm 416: server_destroy_pane(wp);
417: break;
1.53 nicm 418: }
419: }
1.80 nicm 420: }
1.1 nicm 421:
1.66 nicm 422: SLIST_FOREACH(job, &all_jobs, lentry) {
423: if (pid == job->pid) {
1.67 nicm 424: job_died(job, status); /* might free job */
425: break;
1.1 nicm 426: }
1.53 nicm 427: }
428: }
429:
1.66 nicm 430: /* Handle stopped children. */
1.31 nicm 431: void
1.66 nicm 432: server_child_stopped(pid_t pid, int status)
1.31 nicm 433: {
1.66 nicm 434: struct window *w;
435: struct window_pane *wp;
436: u_int i;
1.31 nicm 437:
1.66 nicm 438: if (WSTOPSIG(status) == SIGTTIN || WSTOPSIG(status) == SIGTTOU)
439: return;
1.31 nicm 440:
1.66 nicm 441: for (i = 0; i < ARRAY_LENGTH(&windows); i++) {
442: if ((w = ARRAY_ITEM(&windows, i)) == NULL)
1.31 nicm 443: continue;
1.66 nicm 444: TAILQ_FOREACH(wp, &w->panes, entry) {
445: if (wp->pid == pid) {
446: if (killpg(pid, SIGCONT) != 0)
447: kill(pid, SIGCONT);
448: }
449: }
1.31 nicm 450: }
1.1 nicm 451: }
452:
1.66 nicm 453: /* Handle once-per-second timer events. */
1.78 nicm 454: /* ARGSUSED */
1.1 nicm 455: void
1.66 nicm 456: server_second_callback(unused int fd, unused short events, unused void *arg)
1.1 nicm 457: {
1.60 nicm 458: struct window *w;
459: struct window_pane *wp;
1.66 nicm 460: struct timeval tv;
1.35 nicm 461: u_int i;
1.1 nicm 462:
1.60 nicm 463: if (options_get_number(&global_s_options, "lock-server"))
464: server_lock_server();
465: else
466: server_lock_sessions();
1.1 nicm 467:
1.60 nicm 468: for (i = 0; i < ARRAY_LENGTH(&windows); i++) {
469: w = ARRAY_ITEM(&windows, i);
470: if (w == NULL)
1.1 nicm 471: continue;
472:
1.60 nicm 473: TAILQ_FOREACH(wp, &w->panes, entry) {
474: if (wp->mode != NULL && wp->mode->timer != NULL)
475: wp->mode->timer(wp);
1.1 nicm 476: }
477: }
1.72 nicm 478:
479: server_client_status_timer();
1.66 nicm 480:
481: evtimer_del(&server_ev_second);
482: memset(&tv, 0, sizeof tv);
483: tv.tv_sec = 1;
484: evtimer_add(&server_ev_second, &tv);
1.1 nicm 485: }
486:
1.46 nicm 487: /* Lock the server if ALL sessions have hit the time limit. */
488: void
489: server_lock_server(void)
490: {
491: struct session *s;
492: u_int i;
493: int timeout;
494: time_t t;
495:
496: t = time(NULL);
497: for (i = 0; i < ARRAY_LENGTH(&sessions); i++) {
498: if ((s = ARRAY_ITEM(&sessions, i)) == NULL)
499: continue;
500:
1.59 nicm 501: if (s->flags & SESSION_UNATTACHED) {
1.65 nicm 502: if (gettimeofday(&s->activity_time, NULL) != 0)
503: fatal("gettimeofday failed");
1.59 nicm 504: continue;
505: }
506:
1.46 nicm 507: timeout = options_get_number(&s->options, "lock-after-time");
1.65 nicm 508: if (timeout <= 0 || t <= s->activity_time.tv_sec + timeout)
1.46 nicm 509: return; /* not timed out */
510: }
511:
512: server_lock();
513: recalculate_sizes();
514: }
515:
516: /* Lock any sessions which have timed out. */
517: void
518: server_lock_sessions(void)
519: {
1.80 nicm 520: struct session *s;
1.62 deraadt 521: u_int i;
1.46 nicm 522: int timeout;
1.62 deraadt 523: time_t t;
1.46 nicm 524:
1.62 deraadt 525: t = time(NULL);
526: for (i = 0; i < ARRAY_LENGTH(&sessions); i++) {
1.46 nicm 527: if ((s = ARRAY_ITEM(&sessions, i)) == NULL)
528: continue;
1.59 nicm 529:
530: if (s->flags & SESSION_UNATTACHED) {
1.65 nicm 531: if (gettimeofday(&s->activity_time, NULL) != 0)
532: fatal("gettimeofday failed");
1.59 nicm 533: continue;
534: }
1.46 nicm 535:
536: timeout = options_get_number(&s->options, "lock-after-time");
1.65 nicm 537: if (timeout > 0 && t > s->activity_time.tv_sec + timeout) {
1.46 nicm 538: server_lock_session(s);
539: recalculate_sizes();
1.1 nicm 540: }
541: }
542: }