Annotation of src/usr.bin/tmux/session.c, Revision 1.29
1.29 ! nicm 1: /* $OpenBSD: session.c,v 1.28 2011/01/13 02:07:06 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/time.h>
21:
1.6 nicm 22: #include <paths.h>
1.1 nicm 23: #include <string.h>
24: #include <stdlib.h>
25: #include <unistd.h>
1.10 nicm 26: #include <time.h>
1.1 nicm 27:
28: #include "tmux.h"
29:
30: /* Global session list. */
31: struct sessions sessions;
1.7 nicm 32: struct sessions dead_sessions;
1.25 nicm 33: u_int next_session;
1.11 nicm 34: struct session_groups session_groups;
1.1 nicm 35:
1.18 nicm 36: struct winlink *session_next_alert(struct winlink *);
37: struct winlink *session_previous_alert(struct winlink *);
1.21 nicm 38:
1.25 nicm 39: RB_GENERATE(sessions, session, entry, session_cmp);
40:
41: int
42: session_cmp(struct session *s1, struct session *s2)
43: {
44: return (strcmp(s1->name, s2->name));
45: }
46:
1.21 nicm 47: /*
48: * Find if session is still alive. This is true if it is still on the global
49: * sessions list.
50: */
51: int
52: session_alive(struct session *s)
53: {
1.25 nicm 54: struct session *s_loop;
1.21 nicm 55:
1.25 nicm 56: RB_FOREACH(s_loop, sessions, &sessions) {
57: if (s_loop == s)
58: return (1);
59: }
60: return (0);
1.21 nicm 61: }
1.1 nicm 62:
63: /* Find session by name. */
64: struct session *
65: session_find(const char *name)
66: {
1.25 nicm 67: struct session s;
68:
69: s.name = (char *) name;
70: return (RB_FIND(sessions, &sessions, &s));
71: }
72:
73: /* Find session by index. */
74: struct session *
75: session_find_by_index(u_int idx)
76: {
1.1 nicm 77: struct session *s;
78:
1.25 nicm 79: RB_FOREACH(s, sessions, &sessions) {
80: if (s->idx == idx)
1.1 nicm 81: return (s);
82: }
83: return (NULL);
84: }
85:
86: /* Create a new session. */
87: struct session *
1.3 nicm 88: session_create(const char *name, const char *cmd, const char *cwd,
1.5 nicm 89: struct environ *env, struct termios *tio, int idx, u_int sx, u_int sy,
90: char **cause)
1.1 nicm 91: {
92: struct session *s;
93:
94: s = xmalloc(sizeof *s);
1.7 nicm 95: s->references = 0;
1.1 nicm 96: s->flags = 0;
1.7 nicm 97:
1.12 nicm 98: if (gettimeofday(&s->creation_time, NULL) != 0)
1.9 nicm 99: fatal("gettimeofday failed");
1.27 nicm 100: session_update_activity(s);
1.7 nicm 101:
1.19 nicm 102: s->cwd = xstrdup(cwd);
103:
1.1 nicm 104: s->curw = NULL;
1.11 nicm 105: TAILQ_INIT(&s->lastw);
1.1 nicm 106: RB_INIT(&s->windows);
1.7 nicm 107:
1.2 nicm 108: options_init(&s->options, &global_s_options);
1.3 nicm 109: environ_init(&s->environ);
110: if (env != NULL)
111: environ_copy(env, &s->environ);
1.8 nicm 112:
113: s->tio = NULL;
114: if (tio != NULL) {
115: s->tio = xmalloc(sizeof *s->tio);
116: memcpy(s->tio, tio, sizeof *s->tio);
117: }
1.1 nicm 118:
119: s->sx = sx;
120: s->sy = sy;
121:
1.25 nicm 122: s->idx = next_session++;
1.1 nicm 123: if (name != NULL)
124: s->name = xstrdup(name);
125: else
1.25 nicm 126: xasprintf(&s->name, "%u", s->idx);
127: RB_INSERT(sessions, &sessions, s);
1.15 nicm 128:
1.11 nicm 129: if (cmd != NULL) {
130: if (session_new(s, NULL, cmd, cwd, idx, cause) == NULL) {
131: session_destroy(s);
132: return (NULL);
133: }
134: session_select(s, RB_ROOT(&s->windows)->idx);
1.1 nicm 135: }
136:
137: log_debug("session %s created", s->name);
138:
139: return (s);
140: }
141:
142: /* Destroy a session. */
143: void
144: session_destroy(struct session *s)
145: {
146: log_debug("session %s destroyed", s->name);
147:
1.25 nicm 148: RB_REMOVE(sessions, &sessions, s);
1.1 nicm 149:
1.8 nicm 150: if (s->tio != NULL)
151: xfree(s->tio);
152:
1.11 nicm 153: session_group_remove(s);
1.3 nicm 154: environ_free(&s->environ);
1.1 nicm 155: options_free(&s->options);
156:
1.11 nicm 157: while (!TAILQ_EMPTY(&s->lastw))
158: winlink_stack_remove(&s->lastw, TAILQ_FIRST(&s->lastw));
1.1 nicm 159: while (!RB_EMPTY(&s->windows))
160: winlink_remove(&s->windows, RB_ROOT(&s->windows));
161:
1.19 nicm 162: xfree(s->cwd);
1.15 nicm 163:
1.25 nicm 164: RB_INSERT(sessions, &dead_sessions, s);
1.27 nicm 165: }
166:
167: /* Update session active time. */
168: void
169: session_update_activity(struct session *s)
170: {
171: if (gettimeofday(&s->activity_time, NULL) != 0)
172: fatal("gettimeofday");
1.20 nicm 173: }
174:
175: /* Find the next usable session. */
176: struct session *
177: session_next_session(struct session *s)
178: {
179: struct session *s2;
180:
1.25 nicm 181: if (RB_EMPTY(&sessions) || !session_alive(s))
1.20 nicm 182: return (NULL);
183:
1.29 ! nicm 184: s2 = RB_NEXT(sessions, &sessions, s);
1.28 nicm 185: if (s2 == NULL)
186: s2 = RB_MIN(sessions, &sessions);
1.25 nicm 187: if (s2 == s)
188: return (NULL);
1.20 nicm 189: return (s2);
190: }
191:
192: /* Find the previous usable session. */
193: struct session *
194: session_previous_session(struct session *s)
195: {
196: struct session *s2;
197:
1.25 nicm 198: if (RB_EMPTY(&sessions) || !session_alive(s))
1.20 nicm 199: return (NULL);
200:
1.29 ! nicm 201: s2 = RB_PREV(sessions, &sessions, s);
1.28 nicm 202: if (s2 == NULL)
203: s2 = RB_MAX(sessions, &sessions);
1.25 nicm 204: if (s2 == s)
205: return (NULL);
1.20 nicm 206: return (s2);
1.1 nicm 207: }
208:
209: /* Create a new window on a session. */
210: struct winlink *
1.15 nicm 211: session_new(struct session *s,
1.1 nicm 212: const char *name, const char *cmd, const char *cwd, int idx, char **cause)
213: {
214: struct window *w;
1.3 nicm 215: struct environ env;
1.6 nicm 216: const char *shell;
1.1 nicm 217: u_int hlimit;
218:
1.3 nicm 219: environ_init(&env);
220: environ_copy(&global_environ, &env);
221: environ_copy(&s->environ, &env);
222: server_fill_environ(s, &env);
1.1 nicm 223:
1.6 nicm 224: shell = options_get_string(&s->options, "default-shell");
225: if (*shell == '\0' || areshell(shell))
226: shell = _PATH_BSHELL;
227:
1.1 nicm 228: hlimit = options_get_number(&s->options, "history-limit");
1.4 nicm 229: w = window_create(
1.8 nicm 230: name, cmd, shell, cwd, &env, s->tio, s->sx, s->sy, hlimit, cause);
1.3 nicm 231: if (w == NULL) {
232: environ_free(&env);
1.1 nicm 233: return (NULL);
1.3 nicm 234: }
235: environ_free(&env);
1.1 nicm 236:
237: if (options_get_number(&s->options, "set-remain-on-exit"))
238: options_set_number(&w->options, "remain-on-exit", 1);
239:
240: return (session_attach(s, w, idx, cause));
241: }
242:
243: /* Attach a window to a session. */
244: struct winlink *
245: session_attach(struct session *s, struct window *w, int idx, char **cause)
246: {
247: struct winlink *wl;
248:
249: if ((wl = winlink_add(&s->windows, w, idx)) == NULL)
250: xasprintf(cause, "index in use: %d", idx);
1.11 nicm 251: session_group_synchronize_from(s);
1.1 nicm 252: return (wl);
253: }
254:
255: /* Detach a window from a session. */
256: int
257: session_detach(struct session *s, struct winlink *wl)
258: {
259: if (s->curw == wl &&
260: session_last(s) != 0 && session_previous(s, 0) != 0)
261: session_next(s, 0);
262:
1.18 nicm 263: wl->flags &= ~WINLINK_ALERTFLAGS;
1.1 nicm 264: winlink_stack_remove(&s->lastw, wl);
265: winlink_remove(&s->windows, wl);
1.11 nicm 266: session_group_synchronize_from(s);
1.1 nicm 267: if (RB_EMPTY(&s->windows)) {
268: session_destroy(s);
269: return (1);
270: }
271: return (0);
272: }
273:
274: /* Return if session has window. */
1.18 nicm 275: struct winlink *
1.1 nicm 276: session_has(struct session *s, struct window *w)
277: {
278: struct winlink *wl;
279:
280: RB_FOREACH(wl, winlinks, &s->windows) {
281: if (wl->window == w)
1.18 nicm 282: return (wl);
1.1 nicm 283: }
1.18 nicm 284: return (NULL);
1.1 nicm 285: }
286:
287: struct winlink *
1.18 nicm 288: session_next_alert(struct winlink *wl)
1.1 nicm 289: {
290: while (wl != NULL) {
1.18 nicm 291: if (wl->flags & WINLINK_ALERTFLAGS)
1.1 nicm 292: break;
1.14 nicm 293: wl = winlink_next(wl);
1.1 nicm 294: }
295: return (wl);
296: }
297:
298: /* Move session to next window. */
299: int
1.17 nicm 300: session_next(struct session *s, int alert)
1.1 nicm 301: {
302: struct winlink *wl;
303:
304: if (s->curw == NULL)
305: return (-1);
306:
1.14 nicm 307: wl = winlink_next(s->curw);
1.17 nicm 308: if (alert)
1.18 nicm 309: wl = session_next_alert(wl);
1.1 nicm 310: if (wl == NULL) {
311: wl = RB_MIN(winlinks, &s->windows);
1.18 nicm 312: if (alert && ((wl = session_next_alert(wl)) == NULL))
1.1 nicm 313: return (-1);
314: }
315: if (wl == s->curw)
316: return (1);
317: winlink_stack_remove(&s->lastw, wl);
318: winlink_stack_push(&s->lastw, s->curw);
319: s->curw = wl;
1.18 nicm 320: wl->flags &= ~WINLINK_ALERTFLAGS;
1.1 nicm 321: return (0);
322: }
323:
324: struct winlink *
1.18 nicm 325: session_previous_alert(struct winlink *wl)
1.1 nicm 326: {
327: while (wl != NULL) {
1.18 nicm 328: if (wl->flags & WINLINK_ALERTFLAGS)
1.1 nicm 329: break;
1.14 nicm 330: wl = winlink_previous(wl);
1.1 nicm 331: }
332: return (wl);
333: }
334:
335: /* Move session to previous window. */
336: int
1.17 nicm 337: session_previous(struct session *s, int alert)
1.1 nicm 338: {
339: struct winlink *wl;
340:
341: if (s->curw == NULL)
342: return (-1);
343:
1.14 nicm 344: wl = winlink_previous(s->curw);
1.17 nicm 345: if (alert)
1.18 nicm 346: wl = session_previous_alert(wl);
1.1 nicm 347: if (wl == NULL) {
348: wl = RB_MAX(winlinks, &s->windows);
1.18 nicm 349: if (alert && (wl = session_previous_alert(wl)) == NULL)
1.1 nicm 350: return (-1);
351: }
352: if (wl == s->curw)
353: return (1);
354: winlink_stack_remove(&s->lastw, wl);
355: winlink_stack_push(&s->lastw, s->curw);
356: s->curw = wl;
1.18 nicm 357: wl->flags &= ~WINLINK_ALERTFLAGS;
1.1 nicm 358: return (0);
359: }
360:
361: /* Move session to specific window. */
362: int
363: session_select(struct session *s, int idx)
364: {
365: struct winlink *wl;
366:
367: wl = winlink_find_by_index(&s->windows, idx);
368: if (wl == NULL)
369: return (-1);
370: if (wl == s->curw)
371: return (1);
372: winlink_stack_remove(&s->lastw, wl);
373: winlink_stack_push(&s->lastw, s->curw);
374: s->curw = wl;
1.18 nicm 375: wl->flags &= ~WINLINK_ALERTFLAGS;
1.1 nicm 376: return (0);
377: }
378:
379: /* Move session to last used window. */
380: int
381: session_last(struct session *s)
382: {
383: struct winlink *wl;
384:
1.11 nicm 385: wl = TAILQ_FIRST(&s->lastw);
1.1 nicm 386: if (wl == NULL)
387: return (-1);
388: if (wl == s->curw)
389: return (1);
390:
391: winlink_stack_remove(&s->lastw, wl);
392: winlink_stack_push(&s->lastw, s->curw);
393: s->curw = wl;
1.18 nicm 394: wl->flags &= ~WINLINK_ALERTFLAGS;
1.1 nicm 395: return (0);
1.11 nicm 396: }
397:
398: /* Find the session group containing a session. */
399: struct session_group *
400: session_group_find(struct session *target)
401: {
402: struct session_group *sg;
403: struct session *s;
404:
405: TAILQ_FOREACH(sg, &session_groups, entry) {
406: TAILQ_FOREACH(s, &sg->sessions, gentry) {
407: if (s == target)
408: return (sg);
409: }
410: }
411: return (NULL);
412: }
413:
414: /* Find session group index. */
415: u_int
416: session_group_index(struct session_group *sg)
417: {
418: struct session_group *sg2;
419: u_int i;
420:
421: i = 0;
422: TAILQ_FOREACH(sg2, &session_groups, entry) {
423: if (sg == sg2)
424: return (i);
425: i++;
426: }
427:
428: fatalx("session group not found");
429: }
430:
431: /*
432: * Add a session to the session group containing target, creating it if
1.15 nicm 433: * necessary.
1.11 nicm 434: */
435: void
436: session_group_add(struct session *target, struct session *s)
437: {
438: struct session_group *sg;
439:
440: if ((sg = session_group_find(target)) == NULL) {
441: sg = xmalloc(sizeof *sg);
442: TAILQ_INSERT_TAIL(&session_groups, sg, entry);
443: TAILQ_INIT(&sg->sessions);
444: TAILQ_INSERT_TAIL(&sg->sessions, target, gentry);
445: }
446: TAILQ_INSERT_TAIL(&sg->sessions, s, gentry);
447: }
448:
449: /* Remove a session from its group and destroy the group if empty. */
450: void
451: session_group_remove(struct session *s)
452: {
453: struct session_group *sg;
454:
455: if ((sg = session_group_find(s)) == NULL)
456: return;
457: TAILQ_REMOVE(&sg->sessions, s, gentry);
458: if (TAILQ_NEXT(TAILQ_FIRST(&sg->sessions), gentry) == NULL)
459: TAILQ_REMOVE(&sg->sessions, TAILQ_FIRST(&sg->sessions), gentry);
460: if (TAILQ_EMPTY(&sg->sessions)) {
461: TAILQ_REMOVE(&session_groups, sg, entry);
462: xfree(sg);
463: }
464: }
465:
466: /* Synchronize a session to its session group. */
467: void
468: session_group_synchronize_to(struct session *s)
469: {
470: struct session_group *sg;
471: struct session *target;
472:
473: if ((sg = session_group_find(s)) == NULL)
474: return;
475:
476: target = NULL;
477: TAILQ_FOREACH(target, &sg->sessions, gentry) {
478: if (target != s)
479: break;
480: }
481: session_group_synchronize1(target, s);
482: }
483:
484: /* Synchronize a session group to a session. */
485: void
486: session_group_synchronize_from(struct session *target)
487: {
488: struct session_group *sg;
489: struct session *s;
490:
491: if ((sg = session_group_find(target)) == NULL)
492: return;
493:
494: TAILQ_FOREACH(s, &sg->sessions, gentry) {
495: if (s != target)
496: session_group_synchronize1(target, s);
497: }
498: }
499:
500: /*
501: * Synchronize a session with a target session. This means destroying all
502: * winlinks then recreating them, then updating the current window, last window
503: * stack and alerts.
504: */
505: void
506: session_group_synchronize1(struct session *target, struct session *s)
507: {
508: struct winlinks old_windows, *ww;
509: struct winlink_stack old_lastw;
510: struct winlink *wl, *wl2;
511:
512: /* Don't do anything if the session is empty (it'll be destroyed). */
513: ww = &target->windows;
514: if (RB_EMPTY(ww))
515: return;
516:
517: /* If the current window has vanished, move to the next now. */
1.16 nicm 518: if (s->curw != NULL &&
519: winlink_find_by_index(ww, s->curw->idx) == NULL &&
520: session_last(s) != 0 && session_previous(s, 0) != 0)
521: session_next(s, 0);
1.11 nicm 522:
523: /* Save the old pointer and reset it. */
524: memcpy(&old_windows, &s->windows, sizeof old_windows);
525: RB_INIT(&s->windows);
526:
527: /* Link all the windows from the target. */
1.18 nicm 528: RB_FOREACH(wl, winlinks, ww) {
529: wl2 = winlink_add(&s->windows, wl->window, wl->idx);
530: wl2->flags |= wl->flags & WINLINK_ALERTFLAGS;
531: }
1.11 nicm 532:
533: /* Fix up the current window. */
534: if (s->curw != NULL)
535: s->curw = winlink_find_by_index(&s->windows, s->curw->idx);
536: else
537: s->curw = winlink_find_by_index(&s->windows, target->curw->idx);
538:
539: /* Fix up the last window stack. */
540: memcpy(&old_lastw, &s->lastw, sizeof old_lastw);
541: TAILQ_INIT(&s->lastw);
542: TAILQ_FOREACH(wl, &old_lastw, sentry) {
543: wl2 = winlink_find_by_index(&s->windows, wl->idx);
544: if (wl2 != NULL)
545: TAILQ_INSERT_TAIL(&s->lastw, wl2, sentry);
546: }
547:
548: /* Then free the old winlinks list. */
549: while (!RB_EMPTY(&old_windows)) {
550: wl = RB_ROOT(&old_windows);
1.13 nicm 551: winlink_remove(&old_windows, wl);
1.11 nicm 552: }
1.1 nicm 553: }