lib/process.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "process.h"
  19 #include <errno.h>
  20 #include <fcntl.h>
  21 #include <signal.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <sys/stat.h>
  25 #include <sys/wait.h>
  26 #include <unistd.h>
  27 #include "coverage.h"
  28 #include "dynamic-string.h"
  29 #include "fatal-signal.h"
  30 #include "list.h"
  31 #include "poll-loop.h"
  32 #include "signals.h"
  33 #include "socket-util.h"
  34 #include "util.h"
  35 #include "vlog.h"
  36
  37 VLOG_DEFINE_THIS_MODULE(process);
  38
  39 COVERAGE_DEFINE(process_run);
  40 COVERAGE_DEFINE(process_run_capture);
  41 COVERAGE_DEFINE(process_sigchld);
  42 COVERAGE_DEFINE(process_start);
  43
  44 struct process {
  45     struct list node;
  46     char *name;
  47     pid_t pid;
  48
  49     /* Modified by signal handler. */
  50     volatile bool exited;
  51     volatile int status;
  52 };
  53
  54 /* Pipe used to signal child termination. */
  55 static int fds[2];
  56
  57 /* All processes. */
  58 static struct list all_processes = LIST_INITIALIZER(&all_processes);
  59
  60 static bool sigchld_is_blocked(void);
  61 static void block_sigchld(sigset_t *);
  62 static void unblock_sigchld(const sigset_t *);
  63 static void sigchld_handler(int signr OVS_UNUSED);
  64 static bool is_member(int x, const int *array, size_t);
  65
  66 /* Initializes the process subsystem (if it is not already initialized).  Calls
  67  * exit() if initialization fails.
  68  *
  69  * Calling this function is optional; it will be called automatically by
  70  * process_start() if necessary.  Calling it explicitly allows the client to
  71  * prevent the process from exiting at an unexpected time. */
  72 void
  73 process_init(void)
  74 {
  75     static bool inited;
  76     struct sigaction sa;
  77
  78     if (inited) {
  79         return;
  80     }
  81     inited = true;
  82
  83     /* Create notification pipe. */
  84     xpipe_nonblocking(fds);
  85
  86     /* Set up child termination signal handler. */
  87     memset(&sa, 0, sizeof sa);
  88     sa.sa_handler = sigchld_handler;
  89     sigemptyset(&sa.sa_mask);
  90     sa.sa_flags = SA_NOCLDSTOP | SA_RESTART;
  91     xsigaction(SIGCHLD, &sa, NULL);
  92 }
  93
  94 char *
  95 process_escape_args(char **argv)
  96 {
  97     struct ds ds = DS_EMPTY_INITIALIZER;
  98     char **argp;
  99     for (argp = argv; *argp; argp++) {
 100         const char *arg = *argp;
 101         const char *p;
 102         if (argp != argv) {
 103             ds_put_char(&ds, ' ');
 104         }
 105         if (arg[strcspn(arg, " \t\r\n\v\\\'\"")]) {
 106             ds_put_char(&ds, '"');
 107             for (p = arg; *p; p++) {
 108                 if (*p == '\\' || *p == '\"') {
 109                     ds_put_char(&ds, '\\');
 110                 }
 111                 ds_put_char(&ds, *p);
 112             }
 113             ds_put_char(&ds, '"');
 114         } else {
 115             ds_put_cstr(&ds, arg);
 116         }
 117     }
 118     return ds_cstr(&ds);
 119 }
 120
 121 /* Prepare to start a process whose command-line arguments are given by the
 122  * null-terminated 'argv' array.  Returns 0 if successful, otherwise a
 123  * positive errno value. */
 124 static int
 125 process_prestart(char **argv)
 126 {
 127     char *binary;
 128
 129     process_init();
 130
 131     /* Log the process to be started. */
 132     if (VLOG_IS_DBG_ENABLED()) {
 133         char *args = process_escape_args(argv);
 134         VLOG_DBG("starting subprocess: %s", args);
 135         free(args);
 136     }
 137
 138     /* execvp() will search PATH too, but the error in that case is more
 139      * obscure, since it is only reported post-fork. */
 140     binary = process_search_path(argv[0]);
 141     if (!binary) {
 142         VLOG_ERR("%s not found in PATH", argv[0]);
 143         return ENOENT;
 144     }
 145     free(binary);
 146
 147     return 0;
 148 }
 149
 150 /* Creates and returns a new struct process with the specified 'name' and
 151  * 'pid'.
 152  *
 153  * This is racy unless SIGCHLD is blocked (and has been blocked since before
 154  * the fork()) that created the subprocess.  */
 155 static struct process *
 156 process_register(const char *name, pid_t pid)
 157 {
 158     struct process *p;
 159     const char *slash;
 160
 161     ovs_assert(sigchld_is_blocked());
 162
 163     p = xzalloc(sizeof *p);
 164     p->pid = pid;
 165     slash = strrchr(name, '/');
 166     p->name = xstrdup(slash ? slash + 1 : name);
 167     p->exited = false;
 168
 169     list_push_back(&all_processes, &p->node);
 170
 171     return p;
 172 }
 173
 174 /* Starts a subprocess with the arguments in the null-terminated argv[] array.
 175  * argv[0] is used as the name of the process.  Searches the PATH environment
 176  * variable to find the program to execute.
 177  *
 178  * All file descriptors are closed before executing the subprocess, except for
 179  * fds 0, 1, and 2 and the 'n_keep_fds' fds listed in 'keep_fds'.  Also, any of
 180  * the 'n_null_fds' fds listed in 'null_fds' are replaced by /dev/null.
 181  *
 182  * Returns 0 if successful, otherwise a positive errno value indicating the
 183  * error.  If successful, '*pp' is assigned a new struct process that may be
 184  * used to query the process's status.  On failure, '*pp' is set to NULL. */
 185 int
 186 process_start(char **argv,
 187               const int keep_fds[], size_t n_keep_fds,
 188               const int null_fds[], size_t n_null_fds,
 189               struct process **pp)
 190 {
 191     sigset_t oldsigs;
 192     int nullfd;
 193     pid_t pid;
 194     int error;
 195
 196     *pp = NULL;
 197     COVERAGE_INC(process_start);
 198     error = process_prestart(argv);
 199     if (error) {
 200         return error;
 201     }
 202
 203     if (n_null_fds) {
 204         nullfd = get_null_fd();
 205         if (nullfd < 0) {
 206             return -nullfd;
 207         }
 208     } else {
 209         nullfd = -1;
 210     }
 211
 212     block_sigchld(&oldsigs);
 213     pid = fork();
 214     if (pid < 0) {
 215         unblock_sigchld(&oldsigs);
 216         VLOG_WARN("fork failed: %s", strerror(errno));
 217         return errno;
 218     } else if (pid) {
 219         /* Running in parent process. */
 220         *pp = process_register(argv[0], pid);
 221         unblock_sigchld(&oldsigs);
 222         return 0;
 223     } else {
 224         /* Running in child process. */
 225         int fd_max = get_max_fds();
 226         int fd;
 227
 228         fatal_signal_fork();
 229         unblock_sigchld(&oldsigs);
 230         for (fd = 0; fd < fd_max; fd++) {
 231             if (is_member(fd, null_fds, n_null_fds)) {
 232                 dup2(nullfd, fd);
 233             } else if (fd >= 3 && fd != nullfd
 234                        && !is_member(fd, keep_fds, n_keep_fds)) {
 235                 close(fd);
 236             }
 237         }
 238         if (nullfd >= 0
 239             && !is_member(nullfd, keep_fds, n_keep_fds)
 240             && !is_member(nullfd, null_fds, n_null_fds)) {
 241             close(nullfd);
 242         }
 243         execvp(argv[0], argv);
 244         fprintf(stderr, "execvp(\"%s\") failed: %s\n",
 245                 argv[0], strerror(errno));
 246         _exit(1);
 247     }
 248 }
 249
 250 /* Destroys process 'p'. */
 251 void
 252 process_destroy(struct process *p)
 253 {
 254     if (p) {
 255         sigset_t oldsigs;
 256
 257         block_sigchld(&oldsigs);
 258         list_remove(&p->node);
 259         unblock_sigchld(&oldsigs);
 260
 261         free(p->name);
 262         free(p);
 263     }
 264 }
 265
 266 /* Sends signal 'signr' to process 'p'.  Returns 0 if successful, otherwise a
 267  * positive errno value. */
 268 int
 269 process_kill(const struct process *p, int signr)
 270 {
 271     return (p->exited ? ESRCH
 272             : !kill(p->pid, signr) ? 0
 273             : errno);
 274 }
 275
 276 /* Returns the pid of process 'p'. */
 277 pid_t
 278 process_pid(const struct process *p)
 279 {
 280     return p->pid;
 281 }
 282
 283 /* Returns the name of process 'p' (the name passed to process_start() with any
 284  * leading directories stripped). */
 285 const char *
 286 process_name(const struct process *p)
 287 {
 288     return p->name;
 289 }
 290
 291 /* Returns true if process 'p' has exited, false otherwise. */
 292 bool
 293 process_exited(struct process *p)
 294 {
 295     if (p->exited) {
 296         return true;
 297     } else {
 298         char buf[_POSIX_PIPE_BUF];
 299         ignore(read(fds[0], buf, sizeof buf));
 300         return false;
 301     }
 302 }
 303
 304 /* Returns process 'p''s exit status, as reported by waitpid(2).
 305  * process_status(p) may be called only after process_exited(p) has returned
 306  * true. */
 307 int
 308 process_status(const struct process *p)
 309 {
 310     ovs_assert(p->exited);
 311     return p->status;
 312 }
 313
 314 int
 315 process_run(char **argv,
 316             const int keep_fds[], size_t n_keep_fds,
 317             const int null_fds[], size_t n_null_fds,
 318             int *status)
 319 {
 320     struct process *p;
 321     int retval;
 322
 323     COVERAGE_INC(process_run);
 324     retval = process_start(argv, keep_fds, n_keep_fds, null_fds, n_null_fds,
 325                            &p);
 326     if (retval) {
 327         *status = 0;
 328         return retval;
 329     }
 330
 331     while (!process_exited(p)) {
 332         process_wait(p);
 333         poll_block();
 334     }
 335     *status = process_status(p);
 336     process_destroy(p);
 337     return 0;
 338 }
 339
 340 /* Given 'status', which is a process status in the form reported by waitpid(2)
 341  * and returned by process_status(), returns a string describing how the
 342  * process terminated.  The caller is responsible for freeing the string when
 343  * it is no longer needed. */
 344 char *
 345 process_status_msg(int status)
 346 {
 347     struct ds ds = DS_EMPTY_INITIALIZER;
 348     if (WIFEXITED(status)) {
 349         ds_put_format(&ds, "exit status %d", WEXITSTATUS(status));
 350     } else if (WIFSIGNALED(status)) {
 351         char namebuf[SIGNAL_NAME_BUFSIZE];
 352
 353         ds_put_format(&ds, "killed (%s)",
 354                       signal_name(WTERMSIG(status), namebuf, sizeof namebuf));
 355     } else if (WIFSTOPPED(status)) {
 356         char namebuf[SIGNAL_NAME_BUFSIZE];
 357
 358         ds_put_format(&ds, "stopped (%s)",
 359                       signal_name(WSTOPSIG(status), namebuf, sizeof namebuf));
 360     } else {
 361         ds_put_format(&ds, "terminated abnormally (%x)", status);
 362     }
 363     if (WCOREDUMP(status)) {
 364         ds_put_cstr(&ds, ", core dumped");
 365     }
 366     return ds_cstr(&ds);
 367 }
 368
 369 /* Causes the next call to poll_block() to wake up when process 'p' has
 370  * exited. */
 371 void
 372 process_wait(struct process *p)
 373 {
 374     if (p->exited) {
 375         poll_immediate_wake();
 376     } else {
 377         poll_fd_wait(fds[0], POLLIN);
 378     }
 379 }
 380
 381 char *
 382 process_search_path(const char *name)
 383 {
 384     char *save_ptr = NULL;
 385     char *path, *dir;
 386     struct stat s;
 387
 388     if (strchr(name, '/') || !getenv("PATH")) {
 389         return stat(name, &s) == 0 ? xstrdup(name) : NULL;
 390     }
 391
 392     path = xstrdup(getenv("PATH"));
 393     for (dir = strtok_r(path, ":", &save_ptr); dir;
 394          dir = strtok_r(NULL, ":", &save_ptr)) {
 395         char *file = xasprintf("%s/%s", dir, name);
 396         if (stat(file, &s) == 0) {
 397             free(path);
 398             return file;
 399         }
 400         free(file);
 401     }
 402     free(path);
 403     return NULL;
 404 }
 405 \f
 406 /* process_run_capture() and supporting functions. */
 407
 408 struct stream {
 409     size_t max_size;
 410     struct ds log;
 411     int fds[2];
 412 };
 413
 414 static int
 415 stream_open(struct stream *s, size_t max_size)
 416 {
 417     int error;
 418
 419     s->max_size = max_size;
 420     ds_init(&s->log);
 421     if (pipe(s->fds)) {
 422         VLOG_WARN("failed to create pipe: %s", strerror(errno));
 423         return errno;
 424     }
 425     error = set_nonblocking(s->fds[0]);
 426     if (error) {
 427         close(s->fds[0]);
 428         close(s->fds[1]);
 429     }
 430     return error;
 431 }
 432
 433 static void
 434 stream_read(struct stream *s)
 435 {
 436     if (s->fds[0] < 0) {
 437         return;
 438     }
 439
 440     for (;;) {
 441         char buffer[512];
 442         int error;
 443         size_t n;
 444
 445         error = read_fully(s->fds[0], buffer, sizeof buffer, &n);
 446         ds_put_buffer(&s->log, buffer, n);
 447         if (error) {
 448             if (error == EAGAIN || error == EWOULDBLOCK) {
 449                 return;
 450             } else {
 451                 if (error != EOF) {
 452                     VLOG_WARN("error reading subprocess pipe: %s",
 453                               strerror(error));
 454                 }
 455                 break;
 456             }
 457         } else if (s->log.length > s->max_size) {
 458             VLOG_WARN("subprocess output overflowed %zu-byte buffer",
 459                       s->max_size);
 460             break;
 461         }
 462     }
 463     close(s->fds[0]);
 464     s->fds[0] = -1;
 465 }
 466
 467 static void
 468 stream_wait(struct stream *s)
 469 {
 470     if (s->fds[0] >= 0) {
 471         poll_fd_wait(s->fds[0], POLLIN);
 472     }
 473 }
 474
 475 static void
 476 stream_close(struct stream *s)
 477 {
 478     ds_destroy(&s->log);
 479     if (s->fds[0] >= 0) {
 480         close(s->fds[0]);
 481     }
 482     if (s->fds[1] >= 0) {
 483         close(s->fds[1]);
 484     }
 485 }
 486
 487 /* Starts the process whose arguments are given in the null-terminated array
 488  * 'argv' and waits for it to exit.  On success returns 0 and stores the
 489  * process exit value (suitable for passing to process_status_msg()) in
 490  * '*status'.  On failure, returns a positive errno value and stores 0 in
 491  * '*status'.
 492  *
 493  * If 'stdout_log' is nonnull, then the subprocess's output to stdout (up to a
 494  * limit of 'log_max' bytes) is captured in a memory buffer, which
 495  * when this function returns 0 is stored as a null-terminated string in
 496  * '*stdout_log'.  The caller is responsible for freeing '*stdout_log' (by
 497  * passing it to free()).  When this function returns an error, '*stdout_log'
 498  * is set to NULL.
 499  *
 500  * If 'stderr_log' is nonnull, then it is treated like 'stdout_log' except
 501  * that it captures the subprocess's output to stderr. */
 502 int
 503 process_run_capture(char **argv, char **stdout_log, char **stderr_log,
 504                     size_t max_log, int *status)
 505 {
 506     struct stream s_stdout, s_stderr;
 507     sigset_t oldsigs;
 508     pid_t pid;
 509     int error;
 510
 511     COVERAGE_INC(process_run_capture);
 512     if (stdout_log) {
 513         *stdout_log = NULL;
 514     }
 515     if (stderr_log) {
 516         *stderr_log = NULL;
 517     }
 518     *status = 0;
 519     error = process_prestart(argv);
 520     if (error) {
 521         return error;
 522     }
 523
 524     error = stream_open(&s_stdout, max_log);
 525     if (error) {
 526         return error;
 527     }
 528
 529     error = stream_open(&s_stderr, max_log);
 530     if (error) {
 531         stream_close(&s_stdout);
 532         return error;
 533     }
 534
 535     block_sigchld(&oldsigs);
 536     pid = fork();
 537     if (pid < 0) {
 538         error = errno;
 539
 540         unblock_sigchld(&oldsigs);
 541         VLOG_WARN("fork failed: %s", strerror(error));
 542
 543         stream_close(&s_stdout);
 544         stream_close(&s_stderr);
 545         *status = 0;
 546         return error;
 547     } else if (pid) {
 548         /* Running in parent process. */
 549         struct process *p;
 550
 551         p = process_register(argv[0], pid);
 552         unblock_sigchld(&oldsigs);
 553
 554         close(s_stdout.fds[1]);
 555         close(s_stderr.fds[1]);
 556         while (!process_exited(p)) {
 557             stream_read(&s_stdout);
 558             stream_read(&s_stderr);
 559
 560             stream_wait(&s_stdout);
 561             stream_wait(&s_stderr);
 562             process_wait(p);
 563             poll_block();
 564         }
 565         stream_read(&s_stdout);
 566         stream_read(&s_stderr);
 567
 568         if (stdout_log) {
 569             *stdout_log = ds_steal_cstr(&s_stdout.log);
 570         }
 571         if (stderr_log) {
 572             *stderr_log = ds_steal_cstr(&s_stderr.log);
 573         }
 574
 575         stream_close(&s_stdout);
 576         stream_close(&s_stderr);
 577
 578         *status = process_status(p);
 579         process_destroy(p);
 580         return 0;
 581     } else {
 582         /* Running in child process. */
 583         int max_fds;
 584         int i;
 585
 586         fatal_signal_fork();
 587         unblock_sigchld(&oldsigs);
 588
 589         dup2(get_null_fd(), 0);
 590         dup2(s_stdout.fds[1], 1);
 591         dup2(s_stderr.fds[1], 2);
 592
 593         max_fds = get_max_fds();
 594         for (i = 3; i < max_fds; i++) {
 595             close(i);
 596         }
 597
 598         execvp(argv[0], argv);
 599         fprintf(stderr, "execvp(\"%s\") failed: %s\n",
 600                 argv[0], strerror(errno));
 601         exit(EXIT_FAILURE);
 602     }
 603 }
 604 \f
 605 static void
 606 sigchld_handler(int signr OVS_UNUSED)
 607 {
 608     struct process *p;
 609
 610     COVERAGE_INC(process_sigchld);
 611     LIST_FOR_EACH (p, node, &all_processes) {
 612         if (!p->exited) {
 613             int retval, status;
 614             do {
 615                 retval = waitpid(p->pid, &status, WNOHANG);
 616             } while (retval == -1 && errno == EINTR);
 617             if (retval == p->pid) {
 618                 p->exited = true;
 619                 p->status = status;
 620             } else if (retval < 0) {
 621                 /* XXX We want to log something but we're in a signal
 622                  * handler. */
 623                 p->exited = true;
 624                 p->status = -1;
 625             }
 626         }
 627     }
 628     ignore(write(fds[1], "", 1));
 629 }
 630
 631 static bool
 632 is_member(int x, const int *array, size_t n)
 633 {
 634     size_t i;
 635
 636     for (i = 0; i < n; i++) {
 637         if (array[i] == x) {
 638             return true;
 639         }
 640     }
 641     return false;
 642 }
 643
 644 static bool
 645 sigchld_is_blocked(void)
 646 {
 647     sigset_t sigs;
 648
 649     xpthread_sigmask(SIG_SETMASK, NULL, &sigs);
 650     return sigismember(&sigs, SIGCHLD);
 651 }
 652
 653 static void
 654 block_sigchld(sigset_t *oldsigs)
 655 {
 656     sigset_t sigchld;
 657
 658     sigemptyset(&sigchld);
 659     sigaddset(&sigchld, SIGCHLD);
 660     xpthread_sigmask(SIG_BLOCK, &sigchld, oldsigs);
 661 }
 662
 663 static void
 664 unblock_sigchld(const sigset_t *oldsigs)
 665 {
 666     xpthread_sigmask(SIG_SETMASK, oldsigs, NULL);
 667 }