1 /* $OpenBSD: spawn.c,v 1.12 2019/11/28 09:45:16 nicm Exp $ */ 2 3 /* 4 * Copyright (c) 2019 Nicholas Marriott <nicholas.marriott@gmail.com> 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 21 #include <errno.h> 22 #include <paths.h> 23 #include <signal.h> 24 #include <stdlib.h> 25 #include <string.h> 26 #include <unistd.h> 27 #include <util.h> 28 29 #include "tmux.h" 30 31 /* 32 * Set up the environment and create a new window and pane or a new pane. 33 * 34 * We need to set up the following items: 35 * 36 * - history limit, comes from the session; 37 * 38 * - base index, comes from the session; 39 * 40 * - current working directory, may be specified - if it isn't it comes from 41 * either the client or the session; 42 * 43 * - PATH variable, comes from the client if any, otherwise from the session 44 * environment; 45 * 46 * - shell, comes from default-shell; 47 * 48 * - termios, comes from the session; 49 * 50 * - remaining environment, comes from the session. 51 */ 52 53 static void 54 spawn_log(const char *from, struct spawn_context *sc) 55 { 56 struct session *s = sc->s; 57 struct winlink *wl = sc->wl; 58 struct window_pane *wp0 = sc->wp0; 59 char tmp[128]; 60 const char *name; 61 62 log_debug("%s: %s, flags=%#x", from, sc->item->name, sc->flags); 63 64 if (wl != NULL && wp0 != NULL) 65 xsnprintf(tmp, sizeof tmp, "wl=%d wp0=%%%u", wl->idx, wp0->id); 66 else if (wl != NULL) 67 xsnprintf(tmp, sizeof tmp, "wl=%d wp0=none", wl->idx); 68 else if (wp0 != NULL) 69 xsnprintf(tmp, sizeof tmp, "wl=none wp0=%%%u", wp0->id); 70 else 71 xsnprintf(tmp, sizeof tmp, "wl=none wp0=none"); 72 log_debug("%s: s=$%u %s idx=%d", from, s->id, tmp, sc->idx); 73 74 name = sc->name; 75 if (name == NULL) 76 name = "none"; 77 log_debug("%s: name=%s", from, name); 78 } 79 80 struct winlink * 81 spawn_window(struct spawn_context *sc, char **cause) 82 { 83 struct session *s = sc->s; 84 struct window *w; 85 struct window_pane *wp; 86 struct winlink *wl; 87 int idx = sc->idx; 88 u_int sx, sy, xpixel, ypixel; 89 90 spawn_log(__func__, sc); 91 92 /* 93 * If the window already exists, we are respawning, so destroy all the 94 * panes except one. 95 */ 96 if (sc->flags & SPAWN_RESPAWN) { 97 w = sc->wl->window; 98 if (~sc->flags & SPAWN_KILL) { 99 TAILQ_FOREACH(wp, &w->panes, entry) { 100 if (wp->fd != -1) 101 break; 102 } 103 if (wp != NULL) { 104 xasprintf(cause, "window %s:%d still active", 105 s->name, sc->wl->idx); 106 return (NULL); 107 } 108 } 109 110 sc->wp0 = TAILQ_FIRST(&w->panes); 111 TAILQ_REMOVE(&w->panes, sc->wp0, entry); 112 113 layout_free(w); 114 window_destroy_panes(w); 115 116 TAILQ_INSERT_HEAD(&w->panes, sc->wp0, entry); 117 window_pane_resize(sc->wp0, w->sx, w->sy); 118 119 layout_init(w, sc->wp0); 120 window_set_active_pane(w, sc->wp0, 0); 121 } 122 123 /* 124 * Otherwise we have no window so we will need to create one. First 125 * check if the given index already exists and destroy it if so. 126 */ 127 if ((~sc->flags & SPAWN_RESPAWN) && idx != -1) { 128 wl = winlink_find_by_index(&s->windows, idx); 129 if (wl != NULL && (~sc->flags & SPAWN_KILL)) { 130 xasprintf(cause, "index %d in use", idx); 131 return (NULL); 132 } 133 if (wl != NULL) { 134 /* 135 * Can't use session_detach as it will destroy session 136 * if this makes it empty. 137 */ 138 wl->flags &= ~WINLINK_ALERTFLAGS; 139 notify_session_window("window-unlinked", s, wl->window); 140 winlink_stack_remove(&s->lastw, wl); 141 winlink_remove(&s->windows, wl); 142 143 if (s->curw == wl) { 144 s->curw = NULL; 145 sc->flags &= ~SPAWN_DETACHED; 146 } 147 } 148 } 149 150 /* Then create a window if needed. */ 151 if (~sc->flags & SPAWN_RESPAWN) { 152 if (idx == -1) 153 idx = -1 - options_get_number(s->options, "base-index"); 154 if ((sc->wl = winlink_add(&s->windows, idx)) == NULL) { 155 xasprintf(cause, "couldn't add window %d", idx); 156 return (NULL); 157 } 158 default_window_size(sc->c, s, NULL, &sx, &sy, &xpixel, &ypixel, 159 -1); 160 if ((w = window_create(sx, sy, xpixel, ypixel)) == NULL) { 161 winlink_remove(&s->windows, sc->wl); 162 xasprintf(cause, "couldn't create window %d", idx); 163 return (NULL); 164 } 165 if (s->curw == NULL) 166 s->curw = sc->wl; 167 sc->wl->session = s; 168 w->latest = sc->c; 169 winlink_set_window(sc->wl, w); 170 } else 171 w = NULL; 172 sc->flags |= SPAWN_NONOTIFY; 173 174 /* Spawn the pane. */ 175 wp = spawn_pane(sc, cause); 176 if (wp == NULL) { 177 if (~sc->flags & SPAWN_RESPAWN) 178 winlink_remove(&s->windows, sc->wl); 179 return (NULL); 180 } 181 182 /* Set the name of the new window. */ 183 if (~sc->flags & SPAWN_RESPAWN) { 184 if (sc->name != NULL) { 185 w->name = xstrdup(sc->name); 186 options_set_number(w->options, "automatic-rename", 0); 187 } else 188 w->name = xstrdup(default_window_name(w)); 189 } 190 191 /* Switch to the new window if required. */ 192 if (~sc->flags & SPAWN_DETACHED) 193 session_select(s, sc->wl->idx); 194 195 /* Fire notification if new window. */ 196 if (~sc->flags & SPAWN_RESPAWN) 197 notify_session_window("window-linked", s, w); 198 199 session_group_synchronize_from(s); 200 return (sc->wl); 201 } 202 203 struct window_pane * 204 spawn_pane(struct spawn_context *sc, char **cause) 205 { 206 struct cmdq_item *item = sc->item; 207 struct client *c = item->client; 208 struct session *s = sc->s; 209 struct window *w = sc->wl->window; 210 struct window_pane *new_wp; 211 struct environ *child; 212 struct environ_entry *ee; 213 char **argv, *cp, **argvp, *argv0, *cwd; 214 const char *cmd, *tmp; 215 int argc; 216 u_int idx; 217 struct termios now; 218 u_int hlimit; 219 struct winsize ws; 220 sigset_t set, oldset; 221 key_code key; 222 223 spawn_log(__func__, sc); 224 225 /* 226 * If we are respawning then get rid of the old process. Otherwise 227 * either create a new cell or assign to the one we are given. 228 */ 229 hlimit = options_get_number(s->options, "history-limit"); 230 if (sc->flags & SPAWN_RESPAWN) { 231 if (sc->wp0->fd != -1 && (~sc->flags & SPAWN_KILL)) { 232 window_pane_index(sc->wp0, &idx); 233 xasprintf(cause, "pane %s:%d.%u still active", 234 s->name, sc->wl->idx, idx); 235 return (NULL); 236 } 237 if (sc->wp0->fd != -1) { 238 bufferevent_free(sc->wp0->event); 239 close(sc->wp0->fd); 240 } 241 window_pane_reset_mode_all(sc->wp0); 242 screen_reinit(&sc->wp0->base); 243 input_init(sc->wp0); 244 new_wp = sc->wp0; 245 new_wp->flags &= ~(PANE_STATUSREADY|PANE_STATUSDRAWN); 246 } else if (sc->lc == NULL) { 247 new_wp = window_add_pane(w, NULL, hlimit, sc->flags); 248 layout_init(w, new_wp); 249 } else { 250 new_wp = window_add_pane(w, sc->wp0, hlimit, sc->flags); 251 layout_assign_pane(sc->lc, new_wp); 252 } 253 254 /* 255 * Now we have a pane with nothing running in it ready for the new 256 * process. Work out the command and arguments. 257 */ 258 if (sc->argc == 0 && (~sc->flags & SPAWN_RESPAWN)) { 259 cmd = options_get_string(s->options, "default-command"); 260 if (cmd != NULL && *cmd != '\0') { 261 argc = 1; 262 argv = (char **)&cmd; 263 } else { 264 argc = 0; 265 argv = NULL; 266 } 267 } else { 268 argc = sc->argc; 269 argv = sc->argv; 270 } 271 272 /* 273 * Replace the stored arguments if there are new ones. If not, the 274 * existing ones will be used (they will only exist for respawn). 275 */ 276 if (argc > 0) { 277 cmd_free_argv(new_wp->argc, new_wp->argv); 278 new_wp->argc = argc; 279 new_wp->argv = cmd_copy_argv(argc, argv); 280 } 281 282 /* 283 * Work out the current working directory. If respawning, use 284 * the pane's stored one unless specified. 285 */ 286 if (sc->cwd != NULL) 287 cwd = format_single(item, sc->cwd, c, s, NULL, NULL); 288 else if (~sc->flags & SPAWN_RESPAWN) 289 cwd = xstrdup(server_client_get_cwd(c, s)); 290 else 291 cwd = NULL; 292 if (cwd != NULL) { 293 free(new_wp->cwd); 294 new_wp->cwd = cwd; 295 } 296 297 /* Create an environment for this pane. */ 298 child = environ_for_session(s, 0); 299 if (sc->environ != NULL) 300 environ_copy(sc->environ, child); 301 environ_set(child, "TMUX_PANE", "%%%u", new_wp->id); 302 303 /* 304 * Then the PATH environment variable. The session one is replaced from 305 * the client if there is one because otherwise running "tmux new 306 * myprogram" wouldn't work if myprogram isn't in the session's path. 307 */ 308 if (c != NULL && c->session == NULL) { /* only unattached clients */ 309 ee = environ_find(c->environ, "PATH"); 310 if (ee != NULL) 311 environ_set(child, "PATH", "%s", ee->value); 312 } 313 if (environ_find(child, "PATH") == NULL) 314 environ_set(child, "%s", _PATH_DEFPATH); 315 316 /* Then the shell. If respawning, use the old one. */ 317 if (~sc->flags & SPAWN_RESPAWN) { 318 tmp = options_get_string(s->options, "default-shell"); 319 if (*tmp == '\0' || areshell(tmp)) 320 tmp = _PATH_BSHELL; 321 free(new_wp->shell); 322 new_wp->shell = xstrdup(tmp); 323 } 324 environ_set(child, "SHELL", "%s", new_wp->shell); 325 326 /* Log the arguments we are going to use. */ 327 log_debug("%s: shell=%s", __func__, new_wp->shell); 328 if (new_wp->argc != 0) { 329 cp = cmd_stringify_argv(new_wp->argc, new_wp->argv); 330 log_debug("%s: cmd=%s", __func__, cp); 331 free(cp); 332 } 333 if (cwd != NULL) 334 log_debug("%s: cwd=%s", __func__, cwd); 335 cmd_log_argv(new_wp->argc, new_wp->argv, "%s", __func__); 336 environ_log(child, "%s: environment ", __func__); 337 338 /* Initialize the window size. */ 339 memset(&ws, 0, sizeof ws); 340 ws.ws_col = screen_size_x(&new_wp->base); 341 ws.ws_row = screen_size_y(&new_wp->base); 342 ws.ws_xpixel = w->xpixel * ws.ws_col; 343 ws.ws_ypixel = w->ypixel * ws.ws_row; 344 345 /* Block signals until fork has completed. */ 346 sigfillset(&set); 347 sigprocmask(SIG_BLOCK, &set, &oldset); 348 349 /* If the command is empty, don't fork a child process. */ 350 if (sc->flags & SPAWN_EMPTY) { 351 new_wp->flags |= PANE_EMPTY; 352 new_wp->base.mode &= ~MODE_CURSOR; 353 new_wp->base.mode |= MODE_CRLF; 354 goto complete; 355 } 356 357 /* Fork the new process. */ 358 new_wp->pid = fdforkpty(ptm_fd, &new_wp->fd, new_wp->tty, NULL, &ws); 359 if (new_wp->pid == -1) { 360 xasprintf(cause, "fork failed: %s", strerror(errno)); 361 new_wp->fd = -1; 362 if (~sc->flags & SPAWN_RESPAWN) { 363 layout_close_pane(new_wp); 364 window_remove_pane(w, new_wp); 365 } 366 sigprocmask(SIG_SETMASK, &oldset, NULL); 367 return (NULL); 368 } 369 370 /* In the parent process, everything is done now. */ 371 if (new_wp->pid != 0) 372 goto complete; 373 374 /* 375 * Child process. Change to the working directory or home if that 376 * fails. 377 */ 378 if (chdir(new_wp->cwd) != 0) { 379 if ((tmp = find_home()) == NULL || chdir(tmp) != 0) 380 chdir("/"); 381 } 382 383 /* 384 * Update terminal escape characters from the session if available and 385 * force VERASE to tmux's backspace. 386 */ 387 if (tcgetattr(STDIN_FILENO, &now) != 0) 388 _exit(1); 389 if (s->tio != NULL) 390 memcpy(now.c_cc, s->tio->c_cc, sizeof now.c_cc); 391 key = options_get_number(global_options, "backspace"); 392 if (key >= 0x7f) 393 now.c_cc[VERASE] = '\177'; 394 else 395 now.c_cc[VERASE] = key; 396 if (tcsetattr(STDIN_FILENO, TCSANOW, &now) != 0) 397 _exit(1); 398 399 /* Clean up file descriptors and signals and update the environment. */ 400 closefrom(STDERR_FILENO + 1); 401 proc_clear_signals(server_proc, 1); 402 sigprocmask(SIG_SETMASK, &oldset, NULL); 403 log_close(); 404 environ_push(child); 405 406 /* 407 * If given multiple arguments, use execvp(). Copy the arguments to 408 * ensure they end in a NULL. 409 */ 410 if (new_wp->argc != 0 && new_wp->argc != 1) { 411 argvp = cmd_copy_argv(new_wp->argc, new_wp->argv); 412 execvp(argvp[0], argvp); 413 _exit(1); 414 } 415 416 /* 417 * If one argument, pass it to $SHELL -c. Otherwise create a login 418 * shell. 419 */ 420 cp = strrchr(new_wp->shell, '/'); 421 if (new_wp->argc == 1) { 422 tmp = new_wp->argv[0]; 423 if (cp != NULL && cp[1] != '\0') 424 xasprintf(&argv0, "%s", cp + 1); 425 else 426 xasprintf(&argv0, "%s", new_wp->shell); 427 execl(new_wp->shell, argv0, "-c", tmp, (char *)NULL); 428 _exit(1); 429 } 430 if (cp != NULL && cp[1] != '\0') 431 xasprintf(&argv0, "-%s", cp + 1); 432 else 433 xasprintf(&argv0, "-%s", new_wp->shell); 434 execl(new_wp->shell, argv0, (char *)NULL); 435 _exit(1); 436 437 complete: 438 new_wp->pipe_off = 0; 439 new_wp->flags &= ~PANE_EXITED; 440 441 sigprocmask(SIG_SETMASK, &oldset, NULL); 442 window_pane_set_event(new_wp); 443 444 if (sc->flags & SPAWN_RESPAWN) 445 return (new_wp); 446 if ((~sc->flags & SPAWN_DETACHED) || w->active == NULL) { 447 if (sc->flags & SPAWN_NONOTIFY) 448 window_set_active_pane(w, new_wp, 0); 449 else 450 window_set_active_pane(w, new_wp, 1); 451 } 452 if (~sc->flags & SPAWN_NONOTIFY) 453 notify_window("window-layout-changed", w); 454 return (new_wp); 455 } 456