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