command.c 69.4 KB
Newer Older
1 2 3
/*
 * command.c: Child command execution
 *
E
Eric Blake 已提交
4
 * Copyright (C) 2010-2012 Red Hat, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
 *
 */

#include <config.h>

#include <poll.h>
25
#include <signal.h>
26 27
#include <stdarg.h>
#include <stdlib.h>
28
#include <sys/stat.h>
29
#include <sys/wait.h>
30 31 32 33 34
#include <fcntl.h>

#if HAVE_CAPNG
# include <cap-ng.h>
#endif
35 36 37 38 39 40

#include "command.h"
#include "memory.h"
#include "virterror_internal.h"
#include "util.h"
#include "logging.h"
E
Eric Blake 已提交
41
#include "virfile.h"
42
#include "virpidfile.h"
43
#include "buf.h"
44
#include "ignore-value.h"
45

46 47 48
#define VIR_FROM_THIS VIR_FROM_NONE

#define virCommandError(code, ...)                                      \
49
    virReportErrorHelper(VIR_FROM_NONE, code, __FILE__,                 \
50 51
                         __FUNCTION__, __LINE__, __VA_ARGS__)

52
/* Flags for virExecWithHook */
53
enum {
54 55 56 57 58
    VIR_EXEC_NONE   = 0,
    VIR_EXEC_NONBLOCK = (1 << 0),
    VIR_EXEC_DAEMON = (1 << 1),
    VIR_EXEC_CLEAR_CAPS = (1 << 2),
    VIR_EXEC_RUN_SYNC = (1 << 3),
59 60
};

61 62 63 64 65 66 67 68 69 70 71 72 73
struct _virCommand {
    int has_error; /* ENOMEM on allocation failure, -1 for anything else.  */

    char **args;
    size_t nargs;
    size_t maxargs;

    char **env;
    size_t nenv;
    size_t maxenv;

    char *pwd;

74 75 76 77
    int *preserve; /* FDs to pass to child. */
    int preserve_size;
    int *transfer; /* FDs to close in parent. */
    int transfer_size;
78 79 80 81 82 83 84 85 86 87 88 89 90

    unsigned int flags;

    char *inbuf;
    char **outbuf;
    char **errbuf;

    int infd;
    int outfd;
    int errfd;
    int *outfdptr;
    int *errfdptr;

91 92 93 94
    bool handshake;
    int handshakeWait[2];
    int handshakeNotify[2];

95 96 97 98 99
    virExecHook hook;
    void *opaque;

    pid_t pid;
    char *pidfile;
100
    bool reap;
101 102

    unsigned long long capabilities;
103 104
};

105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
/*
 * virCommandFDIsSet:
 * @fd: FD to test
 * @set: the set
 * @set_size: actual size of @set
 *
 * Check if FD is already in @set or not.
 *
 * Returns true if @set contains @fd,
 * false otherwise.
 */
static bool
virCommandFDIsSet(int fd,
                  const int *set,
                  int set_size)
{
    int i = 0;

    while (i < set_size)
        if (set[i++] == fd)
            return true;

    return false;
}

/*
 * virCommandFDSet:
 * @fd: FD to be put into @set
 * @set: the set
 * @set_size: actual size of @set
 *
 * This is practically generalized implementation
 * of FD_SET() as we do not want to be limited
 * by FD_SETSIZE.
 *
 * Returns: 0 on success,
 *          -1 on usage error,
 *          ENOMEM on OOM
 */
static int
virCommandFDSet(int fd,
                int **set,
                int *set_size)
{
    if (fd < 0 || !set || !set_size)
        return -1;

    if (virCommandFDIsSet(fd, *set, *set_size))
        return 0;

    if (VIR_REALLOC_N(*set, *set_size + 1) < 0) {
        return ENOMEM;
    }

    (*set)[*set_size] = fd;
    (*set_size)++;

    return 0;
}
164

E
Eric Blake 已提交
165 166
#ifndef WIN32

167
static int virClearCapabilities(void) ATTRIBUTE_UNUSED;
168 169

# if HAVE_CAPNG
E
Eric Blake 已提交
170 171 172 173 174 175 176 177 178 179 180 181 182 183
static int virClearCapabilities(void)
{
    int ret;

    capng_clear(CAPNG_SELECT_BOTH);

    if ((ret = capng_apply(CAPNG_SELECT_BOTH)) < 0) {
        virCommandError(VIR_ERR_INTERNAL_ERROR,
                        _("cannot clear process capabilities %d"), ret);
        return -1;
    }

    return 0;
}
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210

/**
 * virSetCapabilities:
 *  @capabilities - capability flag to set.
 *                  In case of 0, this function is identical to
 *                  virClearCapabilities()
 *
 */
static int virSetCapabilities(unsigned long long capabilities)
{
    int ret, i;

    capng_clear(CAPNG_SELECT_BOTH);

    for (i = 0; i <= CAP_LAST_CAP; i++) {
        if (capabilities & (1ULL << i))
            capng_update(CAPNG_ADD, CAPNG_BOUNDING_SET, i);
    }

    if ((ret = capng_apply(CAPNG_SELECT_BOTH)) < 0) {
        virCommandError(VIR_ERR_INTERNAL_ERROR,
                        _("cannot apply process capabilities %d"), ret);
        return -1;
    }

    return 0;
}
E
Eric Blake 已提交
211 212 213 214 215 216 217
# else
static int virClearCapabilities(void)
{
//    VIR_WARN("libcap-ng support not compiled in, unable to clear "
//             "capabilities");
    return 0;
}
218

219 220
static int
virSetCapabilities(unsigned long long capabilities ATTRIBUTE_UNUSED)
221 222 223
{
    return 0;
}
E
Eric Blake 已提交
224 225
# endif

E
Eric Blake 已提交
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
/**
 * virFork:
 * @pid - a pointer to a pid_t that will receive the return value from
 *        fork()
 *
 * fork a new process while avoiding various race/deadlock conditions
 *
 * on return from virFork(), if *pid < 0, the fork failed and there is
 * no new process. Otherwise, just like fork(), if *pid == 0, it is the
 * child process returning, and if *pid > 0, it is the parent.
 *
 * Even if *pid >= 0, if the return value from virFork() is < 0, it
 * indicates a failure that occurred in the parent or child process
 * after the fork. In this case, the child process should call
 * _exit(EXIT_FAILURE) after doing any additional error reporting.
241
 */
E
Eric Blake 已提交
242 243 244
int
virFork(pid_t *pid)
{
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
    sigset_t oldmask, newmask;
    struct sigaction sig_action;
    int saved_errno, ret = -1;

    *pid = -1;

    /*
     * Need to block signals now, so that child process can safely
     * kill off caller's signal handlers without a race.
     */
    sigfillset(&newmask);
    if (pthread_sigmask(SIG_SETMASK, &newmask, &oldmask) != 0) {
        saved_errno = errno;
        virReportSystemError(errno,
                             "%s", _("cannot block signals"));
        goto cleanup;
    }

    /* Ensure we hold the logging lock, to protect child processes
     * from deadlocking on another thread's inherited mutex state */
    virLogLock();

    *pid = fork();
    saved_errno = errno; /* save for caller */

    /* Unlock for both parent and child process */
    virLogUnlock();

    if (*pid < 0) {
        /* attempt to restore signal mask, but ignore failure, to
           avoid obscuring the fork failure */
        ignore_value (pthread_sigmask(SIG_SETMASK, &oldmask, NULL));
        virReportSystemError(saved_errno,
                             "%s", _("cannot fork child process"));
        goto cleanup;
    }

    if (*pid) {

        /* parent process */

        /* Restore our original signal mask now that the child is
           safely running */
        if (pthread_sigmask(SIG_SETMASK, &oldmask, NULL) != 0) {
            saved_errno = errno; /* save for caller */
            virReportSystemError(errno, "%s", _("cannot unblock signals"));
            goto cleanup;
        }
        ret = 0;

    } else {

        /* child process */

        int logprio;
        int i;

        /* Remove any error callback so errors in child now
           get sent to stderr where they stand a fighting chance
           of being seen / logged */
        virSetErrorFunc(NULL, NULL);
        virSetErrorLogPriorityFunc(NULL);

        /* Make sure any hook logging is sent to stderr, since child
         * process may close the logfile FDs */
        logprio = virLogGetDefaultPriority();
        virLogReset();
        virLogSetDefaultPriority(logprio);

        /* Clear out all signal handlers from parent so nothing
           unexpected can happen in our child once we unblock
           signals */
        sig_action.sa_handler = SIG_DFL;
        sig_action.sa_flags = 0;
        sigemptyset(&sig_action.sa_mask);

        for (i = 1; i < NSIG; i++) {
            /* Only possible errors are EFAULT or EINVAL
               The former wont happen, the latter we
               expect, so no need to check return value */

            sigaction(i, &sig_action, NULL);
        }

        /* Unmask all signals in child, since we've no idea
           what the caller's done with their signal mask
           and don't want to propagate that to children */
        sigemptyset(&newmask);
        if (pthread_sigmask(SIG_SETMASK, &newmask, NULL) != 0) {
            saved_errno = errno; /* save for caller */
            virReportSystemError(errno, "%s", _("cannot unblock signals"));
            goto cleanup;
        }
        ret = 0;
    }

cleanup:
    if (ret < 0)
        errno = saved_errno;
    return ret;
}

E
Eric Blake 已提交
347 348 349 350 351 352 353 354
/*
 * Ensure that *null is an fd visiting /dev/null.  Return 0 on
 * success, -1 on failure.  Allows for lazy opening of shared
 * /dev/null fd only as required.
 */
static int
getDevNull(int *null)
{
355
    if (*null == -1 && (*null = open("/dev/null", O_RDWR|O_CLOEXEC)) < 0) {
E
Eric Blake 已提交
356 357 358 359 360 361 362 363
        virReportSystemError(errno,
                             _("cannot open %s"),
                             "/dev/null");
        return -1;
    }
    return 0;
}

364 365 366 367 368 369 370 371 372 373 374 375
/* Ensure that STD is an inheritable copy of FD.  Return 0 on success,
 * -1 on failure.  */
static int
prepareStdFd(int fd, int std)
{
    if (fd == std)
        return virSetInherit(fd, true);
    if (dup2(fd, std) != std)
        return -1;
    return 0;
}

376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
/*
 * @argv argv to exec
 * @envp optional environment to use for exec
 * @keepfd options fd_ret to keep open for child process
 * @retpid optional pointer to store child process pid
 * @infd optional file descriptor to use as child input, otherwise /dev/null
 * @outfd optional pointer to communicate output fd behavior
 *        outfd == NULL : Use /dev/null
 *        *outfd == -1  : Use a new fd
 *        *outfd != -1  : Use *outfd
 * @errfd optional pointer to communcate error fd behavior. See outfd
 * @flags possible combination of the following:
 *        VIR_EXEC_NONE     : Default function behavior
 *        VIR_EXEC_NONBLOCK : Set child process output fd's as non-blocking
 *        VIR_EXEC_DAEMON   : Daemonize the child process
 * @hook optional virExecHook function to call prior to exec
 * @data data to pass to the hook function
 * @pidfile path to use as pidfile for daemonized process (needs DAEMON flag)
T
Taku Izumi 已提交
394
 * @capabilities capabilities to keep
395 396 397
 */
static int
virExecWithHook(const char *const*argv,
398
                const char *const*envp,
399 400
                const int *keepfd,
                int keepfd_size,
401 402 403 404 405
                pid_t *retpid,
                int infd, int *outfd, int *errfd,
                unsigned int flags,
                virExecHook hook,
                void *data,
T
Taku Izumi 已提交
406 407
                char *pidfile,
                unsigned long long capabilities)
408 409
{
    pid_t pid;
E
Eric Blake 已提交
410
    int null = -1, i, openmax;
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
    int pipeout[2] = {-1,-1};
    int pipeerr[2] = {-1,-1};
    int childout = -1;
    int childerr = -1;
    int tmpfd;
    const char *binary = NULL;
    int forkRet;

    if (argv[0][0] != '/') {
        if (!(binary = virFindFileInPath(argv[0]))) {
            virReportSystemError(ENOENT,
                                 _("Cannot find '%s' in path"),
                                 argv[0]);
            return -1;
        }
    } else {
        binary = argv[0];
    }

E
Eric Blake 已提交
430 431 432 433
    if (infd < 0) {
        if (getDevNull(&null) < 0)
            goto cleanup;
        infd = null;
434 435 436 437
    }

    if (outfd != NULL) {
        if (*outfd == -1) {
438
            if (pipe2(pipeout, O_CLOEXEC) < 0) {
439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
                virReportSystemError(errno,
                                     "%s", _("cannot create pipe"));
                goto cleanup;
            }

            if ((flags & VIR_EXEC_NONBLOCK) &&
                virSetNonBlock(pipeout[0]) == -1) {
                virReportSystemError(errno,
                                     "%s", _("Failed to set non-blocking file descriptor flag"));
                goto cleanup;
            }

            childout = pipeout[1];
        } else {
            childout = *outfd;
        }
    } else {
E
Eric Blake 已提交
456 457
        if (getDevNull(&null) < 0)
            goto cleanup;
458 459 460 461
        childout = null;
    }

    if (errfd != NULL) {
462 463 464
        if (errfd == outfd) {
            childerr = childout;
        } else if (*errfd == -1) {
465
            if (pipe2(pipeerr, O_CLOEXEC) < 0) {
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
                virReportSystemError(errno,
                                     "%s", _("Failed to create pipe"));
                goto cleanup;
            }

            if ((flags & VIR_EXEC_NONBLOCK) &&
                virSetNonBlock(pipeerr[0]) == -1) {
                virReportSystemError(errno,
                                     "%s", _("Failed to set non-blocking file descriptor flag"));
                goto cleanup;
            }

            childerr = pipeerr[1];
        } else {
            childerr = *errfd;
        }
    } else {
E
Eric Blake 已提交
483 484
        if (getDevNull(&null) < 0)
            goto cleanup;
485 486 487 488 489 490 491 492 493 494
        childerr = null;
    }

    forkRet = virFork(&pid);

    if (pid < 0) {
        goto cleanup;
    }

    if (pid) { /* parent */
495 496 497 498
        if (forkRet < 0) {
            goto cleanup;
        }

499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
        VIR_FORCE_CLOSE(null);
        if (outfd && *outfd == -1) {
            VIR_FORCE_CLOSE(pipeout[1]);
            *outfd = pipeout[0];
        }
        if (errfd && *errfd == -1) {
            VIR_FORCE_CLOSE(pipeerr[1]);
            *errfd = pipeerr[0];
        }

        *retpid = pid;

        if (binary != argv[0])
            VIR_FREE(binary);

        return 0;
    }

    /* child */

    if (forkRet < 0) {
        /* The fork was successful, but after that there was an error
         * in the child (which was already logged).
        */
        goto fork_error;
    }

    openmax = sysconf(_SC_OPEN_MAX);
527 528 529
    for (i = 3; i < openmax; i++) {
        if (i == infd || i == childout || i == childerr)
            continue;
530
        if (!keepfd || !virCommandFDIsSet(i, keepfd, keepfd_size)) {
531 532
            tmpfd = i;
            VIR_FORCE_CLOSE(tmpfd);
533 534 535
        } else if (virSetInherit(i, true) < 0) {
            virReportSystemError(errno, _("failed to preserve fd %d"), i);
            goto fork_error;
536
        }
537
    }
538

539
    if (prepareStdFd(infd, STDIN_FILENO) < 0) {
540 541 542 543
        virReportSystemError(errno,
                             "%s", _("failed to setup stdin file handle"));
        goto fork_error;
    }
544
    if (childout > 0 && prepareStdFd(childout, STDOUT_FILENO) < 0) {
545 546 547 548
        virReportSystemError(errno,
                             "%s", _("failed to setup stdout file handle"));
        goto fork_error;
    }
549
    if (childerr > 0 && prepareStdFd(childerr, STDERR_FILENO) < 0) {
550 551 552 553 554
        virReportSystemError(errno,
                             "%s", _("failed to setup stderr file handle"));
        goto fork_error;
    }

E
Eric Blake 已提交
555
    if (infd != STDIN_FILENO && infd != null)
556
        VIR_FORCE_CLOSE(infd);
E
Eric Blake 已提交
557
    if (childout > STDERR_FILENO && childout != null) {
558 559 560 561
        tmpfd = childout;   /* preserve childout value */
        VIR_FORCE_CLOSE(tmpfd);
    }
    if (childerr > STDERR_FILENO &&
E
Eric Blake 已提交
562 563
        childerr != childout &&
        childerr != null) {
564 565
        VIR_FORCE_CLOSE(childerr);
    }
E
Eric Blake 已提交
566
    VIR_FORCE_CLOSE(null);
567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593

    /* Initialize full logging for a while */
    virLogSetFromEnv();

    /* Daemonize as late as possible, so the parent process can detect
     * the above errors with wait* */
    if (flags & VIR_EXEC_DAEMON) {
        if (setsid() < 0) {
            virReportSystemError(errno,
                                 "%s", _("cannot become session leader"));
            goto fork_error;
        }

        if (chdir("/") < 0) {
            virReportSystemError(errno,
                                 "%s", _("cannot change to root directory"));
            goto fork_error;
        }

        pid = fork();
        if (pid < 0) {
            virReportSystemError(errno,
                                 "%s", _("cannot fork child process"));
            goto fork_error;
        }

        if (pid > 0) {
594
            if (pidfile && (virPidFileWritePath(pidfile,pid) < 0)) {
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613
                kill(pid, SIGTERM);
                usleep(500*1000);
                kill(pid, SIGTERM);
                virReportSystemError(errno,
                                     _("could not write pidfile %s for %d"),
                                     pidfile, pid);
                goto fork_error;
            }
            _exit(0);
        }
    }

    if (hook) {
        /* virFork reset all signal handlers to the defaults.
         * This is good for the child process, but our hook
         * risks running something that generates SIGPIPE,
         * so we need to temporarily block that again
         */
        struct sigaction waxon, waxoff;
614
        memset(&waxoff, 0, sizeof(waxoff));
615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
        waxoff.sa_handler = SIG_IGN;
        sigemptyset(&waxoff.sa_mask);
        memset(&waxon, 0, sizeof(waxon));
        if (sigaction(SIGPIPE, &waxoff, &waxon) < 0) {
            virReportSystemError(errno, "%s",
                                 _("Could not disable SIGPIPE"));
            goto fork_error;
        }

        if ((hook)(data) != 0) {
            VIR_DEBUG("Hook function failed.");
            goto fork_error;
        }

        if (sigaction(SIGPIPE, &waxon, NULL) < 0) {
            virReportSystemError(errno, "%s",
                                 _("Could not re-enable SIGPIPE"));
            goto fork_error;
        }
    }

    /* The steps above may need todo something privileged, so
     * we delay clearing capabilities until the last minute */
T
Taku Izumi 已提交
638 639 640
    if (capabilities || (flags & VIR_EXEC_CLEAR_CAPS))
        if (virSetCapabilities(capabilities) < 0)
            goto fork_error;
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676

    /* Close logging again to ensure no FDs leak to child */
    virLogReset();

    if (envp)
        execve(binary, (char **) argv, (char**)envp);
    else
        execv(binary, (char **) argv);

    virReportSystemError(errno,
                         _("cannot execute binary %s"),
                         argv[0]);

 fork_error:
    virDispatchError(NULL);
    _exit(EXIT_FAILURE);

 cleanup:
    /* This is cleanup of parent process only - child
       should never jump here on error */

    if (binary != argv[0])
        VIR_FREE(binary);

    /* NB we don't virCommandError() on any failures here
       because the code which jumped hre already raised
       an error condition which we must not overwrite */
    VIR_FORCE_CLOSE(pipeerr[0]);
    VIR_FORCE_CLOSE(pipeerr[1]);
    VIR_FORCE_CLOSE(pipeout[0]);
    VIR_FORCE_CLOSE(pipeout[1]);
    VIR_FORCE_CLOSE(null);
    return -1;
}

/**
E
Eric Blake 已提交
677
 * virRun:
678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
 * @argv NULL terminated argv to run
 * @status optional variable to return exit status in
 *
 * Run a command without using the shell.
 *
 * If status is NULL, then return 0 if the command run and
 * exited with 0 status; Otherwise return -1
 *
 * If status is not-NULL, then return 0 if the command ran.
 * The status variable is filled with the command exit status
 * and should be checked by caller for success. Return -1
 * only if the command could not be run.
 */
int
virRun(const char *const*argv, int *status)
{
    int ret;
    virCommandPtr cmd = virCommandNewArgs(argv);

    ret = virCommandRun(cmd, status);
    virCommandFree(cmd);
    return ret;
}

#else /* WIN32 */

int
virRun(const char *const *argv ATTRIBUTE_UNUSED,
       int *status)
{
    if (status)
        *status = ENOTSUP;
    else
        virCommandError(VIR_ERR_INTERNAL_ERROR,
                        "%s", _("virRun is not implemented for WIN32"));
    return -1;
}

static int
virExecWithHook(const char *const*argv ATTRIBUTE_UNUSED,
                const char *const*envp ATTRIBUTE_UNUSED,
719 720
                const int *keepfd ATTRIBUTE_UNUSED,
                int keepfd_size ATTRIBUTE_UNUSED,
721 722 723 724
                pid_t *retpid ATTRIBUTE_UNUSED,
                int infd ATTRIBUTE_UNUSED,
                int *outfd ATTRIBUTE_UNUSED,
                int *errfd ATTRIBUTE_UNUSED,
725
                int flags_unused ATTRIBUTE_UNUSED,
726 727
                virExecHook hook ATTRIBUTE_UNUSED,
                void *data ATTRIBUTE_UNUSED,
T
Taku Izumi 已提交
728 729
                char *pidfile ATTRIBUTE_UNUSED,
                unsigned long long capabilities ATTRIBUTE_UNUSED)
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751
{
    /* XXX: Some day we can implement pieces of virCommand/virExec on
     * top of _spawn() or CreateProcess(), but we can't implement
     * everything, since mingw completely lacks fork(), so we cannot
     * run hook code in the child.  */
    virCommandError(VIR_ERR_INTERNAL_ERROR,
                    "%s", _("virExec is not implemented for WIN32"));
    return -1;
}

int
virFork(pid_t *pid)
{
    *pid = -1;
    errno = ENOTSUP;

    return -1;
}

#endif /* WIN32 */


E
Eric Blake 已提交
752 753 754 755 756 757 758
/**
 * virCommandNew:
 * @binary: program to run
 *
 * Create a new command for named binary.  If @binary is relative,
 * it will be found via a PATH search of the parent's PATH (and not
 * any altered PATH set by virCommandAddEnv* commands).
759 760 761 762 763 764 765 766 767
 */
virCommandPtr
virCommandNew(const char *binary)
{
    const char *const args[] = { binary, NULL };

    return virCommandNewArgs(args);
}

E
Eric Blake 已提交
768 769 770 771
/**
 * virCommandNewArgs:
 * @args: array of arguments
 *
772
 * Create a new command with a NULL terminated
E
Eric Blake 已提交
773 774
 * set of args, taking binary from args[0].  More arguments can
 * be added later.  @args[0] is handled like @binary of virCommandNew.
775 776 777 778 779 780 781 782 783
 */
virCommandPtr
virCommandNewArgs(const char *const*args)
{
    virCommandPtr cmd;

    if (VIR_ALLOC(cmd) < 0)
        return NULL;

784 785 786 787 788
    cmd->handshakeWait[0] = -1;
    cmd->handshakeWait[1] = -1;
    cmd->handshakeNotify[0] = -1;
    cmd->handshakeNotify[1] = -1;

789 790 791 792 793 794 795 796
    cmd->infd = cmd->outfd = cmd->errfd = -1;
    cmd->pid = -1;

    virCommandAddArgSet(cmd, args);

    return cmd;
}

E
Eric Blake 已提交
797 798 799 800 801
/**
 * virCommandNewArgList:
 * @binary: program to run
 * @...: additional arguments
 *
802
 * Create a new command with a NULL terminated
E
Eric Blake 已提交
803 804
 * list of args, starting with the binary to run.  More arguments can
 * be added later.  @binary is handled as in virCommandNew.
805 806 807 808 809 810 811 812 813
 */
virCommandPtr
virCommandNewArgList(const char *binary, ...)
{
    virCommandPtr cmd = virCommandNew(binary);
    va_list list;
    const char *arg;

    if (!cmd || cmd->has_error)
E
Eric Blake 已提交
814
        return cmd;
815 816 817 818 819 820 821 822 823 824 825 826 827 828

    va_start(list, binary);
    while ((arg = va_arg(list, const char *)) != NULL)
        virCommandAddArg(cmd, arg);
    va_end(list);
    return cmd;
}


/*
 * Preserve the specified file descriptor in the child, instead of
 * closing it.  FD must not be one of the three standard streams.  If
 * transfer is true, then fd will be closed in the parent after a call
 * to Run/RunAsync/Free, otherwise caller is still responsible for fd.
E
Eric Blake 已提交
829 830
 * Returns true if a transferring caller should close FD now, and
 * false if the transfer is successfully recorded.
831
 */
E
Eric Blake 已提交
832
static bool
833 834
virCommandKeepFD(virCommandPtr cmd, int fd, bool transfer)
{
835 836
    int ret = 0;

837
    if (!cmd)
E
Eric Blake 已提交
838
        return fd > STDERR_FILENO;
839

840 841 842 843
    if (fd <= STDERR_FILENO ||
        (ret = virCommandFDSet(fd, &cmd->preserve, &cmd->preserve_size)) ||
        (transfer && (ret = virCommandFDSet(fd, &cmd->transfer,
                                            &cmd->transfer_size)))) {
844
        if (!cmd->has_error)
845
            cmd->has_error = ret ? ret : -1 ;
846
        VIR_DEBUG("cannot preserve %d", fd);
E
Eric Blake 已提交
847
        return fd > STDERR_FILENO;
848 849
    }

E
Eric Blake 已提交
850
    return false;
851 852
}

E
Eric Blake 已提交
853 854 855 856 857
/**
 * virCommandPreserveFD:
 * @cmd: the command to modify
 * @fd: fd to mark for inheritance into child
 *
858
 * Preserve the specified file descriptor
E
Eric Blake 已提交
859
 * in the child, instead of closing it on exec.
860 861 862 863 864
 * The parent is still responsible for managing fd.
 */
void
virCommandPreserveFD(virCommandPtr cmd, int fd)
{
E
Eric Blake 已提交
865
    virCommandKeepFD(cmd, fd, false);
866 867
}

E
Eric Blake 已提交
868 869 870 871 872
/**
 * virCommandTransferFD:
 * @cmd: the command to modify
 * @fd: fd to reassign to the child
 *
873
 * Transfer the specified file descriptor
E
Eric Blake 已提交
874
 * to the child, instead of closing it on exec.
E
Eric Blake 已提交
875 876
 * The parent should no longer use fd, and the parent's copy will
 * be automatically closed no later than during Run/RunAsync/Free.
877 878 879 880
 */
void
virCommandTransferFD(virCommandPtr cmd, int fd)
{
E
Eric Blake 已提交
881 882
    if (virCommandKeepFD(cmd, fd, true))
        VIR_FORCE_CLOSE(fd);
883 884 885
}


E
Eric Blake 已提交
886 887 888 889 890 891 892
/**
 * virCommandSetPidFile:
 * @cmd: the command to modify
 * @pidfile: filename to use
 *
 * Save the child PID in a pidfile.  The pidfile will be populated
 * before the exec of the child.
893 894 895 896 897 898 899 900 901 902 903 904 905 906
 */
void
virCommandSetPidFile(virCommandPtr cmd, const char *pidfile)
{
    if (!cmd || cmd->has_error)
        return;

    VIR_FREE(cmd->pidfile);
    if (!(cmd->pidfile = strdup(pidfile))) {
        cmd->has_error = ENOMEM;
    }
}


E
Eric Blake 已提交
907 908 909 910 911
/**
 * virCommandClearCaps:
 * @cmd: the command to modify
 *
 * Remove all capabilities from the child, after any hooks have been run.
912 913 914 915 916 917 918 919 920 921
 */
void
virCommandClearCaps(virCommandPtr cmd)
{
    if (!cmd || cmd->has_error)
        return;

    cmd->flags |= VIR_EXEC_CLEAR_CAPS;
}

E
Eric Blake 已提交
922 923 924 925 926
/**
 * virCommandAllowCap:
 * @cmd: the command to modify
 * @capability: what to allow
 *
927
 * Allow specific capabilities
928 929 930
 */
void
virCommandAllowCap(virCommandPtr cmd,
931
                   int capability)
932 933 934 935
{
    if (!cmd || cmd->has_error)
        return;

936
    cmd->capabilities |= (1ULL << capability);
937 938 939 940
}



E
Eric Blake 已提交
941 942 943 944 945 946 947
/**
 * virCommandDaemonize:
 * @cmd: the command to modify
 *
 * Daemonize the child process.  The child will have a current working
 * directory of /, and must be started with virCommandRun, which will
 * complete as soon as the daemon grandchild has started.
948 949 950 951 952 953 954 955 956 957
 */
void
virCommandDaemonize(virCommandPtr cmd)
{
    if (!cmd || cmd->has_error)
        return;

    cmd->flags |= VIR_EXEC_DAEMON;
}

E
Eric Blake 已提交
958 959 960 961
/**
 * virCommandNonblockingFDs:
 * @cmd: the command to modify
 *
962 963 964 965 966 967 968 969 970 971 972 973
 * Set FDs created by virCommandSetOutputFD and virCommandSetErrorFD
 * as non-blocking in the parent.
 */
void
virCommandNonblockingFDs(virCommandPtr cmd)
{
    if (!cmd || cmd->has_error)
        return;

    cmd->flags |= VIR_EXEC_NONBLOCK;
}

E
Eric Blake 已提交
974 975 976 977 978 979 980
/**
 * virCommandAddEnvFormat:
 * @cmd: the command to modify
 * @format: format of arguments, end result must be in name=value format
 * @...: arguments to be formatted
 *
 * Add an environment variable to the child created by a printf-style format.
981 982
 */
void
983
virCommandAddEnvFormat(virCommandPtr cmd, const char *format, ...)
984 985
{
    char *env;
986
    va_list list;
987 988 989 990

    if (!cmd || cmd->has_error)
        return;

991 992
    va_start(list, format);
    if (virVasprintf(&env, format, list) < 0) {
993
        cmd->has_error = ENOMEM;
994
        va_end(list);
995 996
        return;
    }
997
    va_end(list);
998

999
    /* Arg plus trailing NULL. */
1000 1001 1002 1003 1004 1005 1006 1007 1008
    if (VIR_RESIZE_N(cmd->env, cmd->maxenv, cmd->nenv, 1 + 1) < 0) {
        VIR_FREE(env);
        cmd->has_error = ENOMEM;
        return;
    }

    cmd->env[cmd->nenv++] = env;
}

E
Eric Blake 已提交
1009 1010 1011 1012 1013 1014
/**
 * virCommandAddEnvPair:
 * @cmd: the command to modify
 * @name: variable name, must not contain =
 * @value: value to assign to name
 *
1015 1016 1017 1018 1019 1020 1021 1022 1023
 * Add an environment variable to the child
 * using separate name & value strings
 */
void
virCommandAddEnvPair(virCommandPtr cmd, const char *name, const char *value)
{
    virCommandAddEnvFormat(cmd, "%s=%s", name, value);
}

1024

E
Eric Blake 已提交
1025 1026 1027 1028 1029
/**
 * virCommandAddEnvString:
 * @cmd: the command to modify
 * @str: name=value format
 *
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
 * Add an environment variable to the child
 * using a preformatted env string FOO=BAR
 */
void
virCommandAddEnvString(virCommandPtr cmd, const char *str)
{
    char *env;

    if (!cmd || cmd->has_error)
        return;

    if (!(env = strdup(str))) {
        cmd->has_error = ENOMEM;
        return;
    }

    /* env plus trailing NULL */
    if (VIR_RESIZE_N(cmd->env, cmd->maxenv, cmd->nenv, 1 + 1) < 0) {
        VIR_FREE(env);
        cmd->has_error = ENOMEM;
        return;
    }

    cmd->env[cmd->nenv++] = env;
}


E
Eric Blake 已提交
1057 1058 1059 1060 1061
/**
 * virCommandAddEnvBuffer:
 * @cmd: the command to modify
 * @buf: buffer that contains name=value string, which will be reset on return
 *
1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
 * Convert a buffer containing preformatted name=value into an
 * environment variable of the child.
 * Correctly transfers memory errors or contents from buf to cmd.
 */
void
virCommandAddEnvBuffer(virCommandPtr cmd, virBufferPtr buf)
{
    if (!cmd || cmd->has_error) {
        virBufferFreeAndReset(buf);
        return;
    }

    /* env plus trailing NULL. */
    if (virBufferError(buf) ||
        VIR_RESIZE_N(cmd->env, cmd->maxenv, cmd->nenv, 1 + 1) < 0) {
        cmd->has_error = ENOMEM;
        virBufferFreeAndReset(buf);
        return;
    }
1081 1082 1083 1084
    if (!virBufferUse(buf)) {
        cmd->has_error = EINVAL;
        return;
    }
1085 1086 1087 1088 1089

    cmd->env[cmd->nenv++] = virBufferContentAndReset(buf);
}


E
Eric Blake 已提交
1090 1091 1092 1093 1094
/**
 * virCommandAddEnvPass:
 * @cmd: the command to modify
 * @name: the name to look up in current environment
 *
1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110
 * Pass an environment variable to the child
 * using current process' value
 */
void
virCommandAddEnvPass(virCommandPtr cmd, const char *name)
{
    char *value;
    if (!cmd || cmd->has_error)
        return;

    value = getenv(name);
    if (value)
        virCommandAddEnvPair(cmd, name, value);
}


E
Eric Blake 已提交
1111 1112 1113 1114
/**
 * virCommandAddEnvPassCommon:
 * @cmd: the command to modify
 *
1115
 * Set LC_ALL to C, and propagate other essential environment
E
Eric Blake 已提交
1116
 * variables (such as PATH) from the parent process.
1117 1118 1119 1120
 */
void
virCommandAddEnvPassCommon(virCommandPtr cmd)
{
1121 1122 1123
    if (!cmd || cmd->has_error)
        return;

1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
    /* Attempt to Pre-allocate; allocation failure will be detected
     * later during virCommandAdd*.  */
    ignore_value(VIR_RESIZE_N(cmd->env, cmd->maxenv, cmd->nenv, 9));

    virCommandAddEnvPair(cmd, "LC_ALL", "C");

    virCommandAddEnvPass(cmd, "LD_PRELOAD");
    virCommandAddEnvPass(cmd, "LD_LIBRARY_PATH");
    virCommandAddEnvPass(cmd, "PATH");
    virCommandAddEnvPass(cmd, "HOME");
    virCommandAddEnvPass(cmd, "USER");
    virCommandAddEnvPass(cmd, "LOGNAME");
    virCommandAddEnvPass(cmd, "TMPDIR");
}

E
Eric Blake 已提交
1139 1140 1141 1142 1143
/**
 * virCommandAddArg:
 * @cmd: the command to modify
 * @val: the argument to add
 *
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
 * Add a command line argument to the child
 */
void
virCommandAddArg(virCommandPtr cmd, const char *val)
{
    char *arg;

    if (!cmd || cmd->has_error)
        return;

    if (!(arg = strdup(val))) {
        cmd->has_error = ENOMEM;
        return;
    }

    /* Arg plus trailing NULL. */
    if (VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, 1 + 1) < 0) {
        VIR_FREE(arg);
        cmd->has_error = ENOMEM;
        return;
    }

    cmd->args[cmd->nargs++] = arg;
}


E
Eric Blake 已提交
1170 1171 1172 1173 1174
/**
 * virCommandAddArgBuffer:
 * @cmd: the command to modify
 * @buf: buffer that contains argument string, which will be reset on return
 *
1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
 * Convert a buffer into a command line argument to the child.
 * Correctly transfers memory errors or contents from buf to cmd.
 */
void
virCommandAddArgBuffer(virCommandPtr cmd, virBufferPtr buf)
{
    if (!cmd || cmd->has_error) {
        virBufferFreeAndReset(buf);
        return;
    }

    /* Arg plus trailing NULL. */
    if (virBufferError(buf) ||
        VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, 1 + 1) < 0) {
        cmd->has_error = ENOMEM;
        virBufferFreeAndReset(buf);
        return;
    }

1194 1195 1196 1197 1198 1199 1200 1201
    cmd->args[cmd->nargs] = virBufferContentAndReset(buf);
    if (!cmd->args[cmd->nargs])
        cmd->args[cmd->nargs] = strdup("");
    if (!cmd->args[cmd->nargs]) {
        cmd->has_error = ENOMEM;
        return;
    }
    cmd->nargs++;
1202 1203 1204
}


E
Eric Blake 已提交
1205 1206 1207 1208 1209 1210 1211
/**
 * virCommandAddArgFormat:
 * @cmd: the command to modify
 * @format: format of arguments, end result must be in name=value format
 * @...: arguments to be formatted
 *
 * Add a command line argument created by a printf-style format.
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
 */
void
virCommandAddArgFormat(virCommandPtr cmd, const char *format, ...)
{
    char *arg;
    va_list list;

    if (!cmd || cmd->has_error)
        return;

    va_start(list, format);
    if (virVasprintf(&arg, format, list) < 0) {
        cmd->has_error = ENOMEM;
        va_end(list);
        return;
    }
    va_end(list);

    /* Arg plus trailing NULL. */
    if (VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, 1 + 1) < 0) {
        VIR_FREE(arg);
        cmd->has_error = ENOMEM;
        return;
    }

    cmd->args[cmd->nargs++] = arg;
}

E
Eric Blake 已提交
1240 1241 1242 1243 1244 1245
/**
 * virCommandAddArgPair:
 * @cmd: the command to modify
 * @name: left half of argument
 * @value: right half of argument
 *
1246 1247 1248 1249 1250 1251 1252 1253
 * Add "NAME=VAL" as a single command line argument to the child
 */
void
virCommandAddArgPair(virCommandPtr cmd, const char *name, const char *val)
{
    virCommandAddArgFormat(cmd, "%s=%s", name, val);
}

E
Eric Blake 已提交
1254 1255 1256 1257 1258
/**
 * virCommandAddArgSet:
 * @cmd: the command to modify
 * @vals: array of arguments to add
 *
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
 * Add a NULL terminated list of args
 */
void
virCommandAddArgSet(virCommandPtr cmd, const char *const*vals)
{
    int narg = 0;

    if (!cmd || cmd->has_error)
        return;

1269 1270 1271 1272 1273
    if (vals[0] == NULL) {
        cmd->has_error = EINVAL;
        return;
    }

1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
    while (vals[narg] != NULL)
        narg++;

    /* narg plus trailing NULL. */
    if (VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, narg + 1) < 0) {
        cmd->has_error = ENOMEM;
        return;
    }

    narg = 0;
    while (vals[narg] != NULL) {
        char *arg = strdup(vals[narg++]);
        if (!arg) {
            cmd->has_error = ENOMEM;
            return;
        }
        cmd->args[cmd->nargs++] = arg;
    }
}

E
Eric Blake 已提交
1294 1295 1296 1297 1298 1299
/**
 * virCommandAddArgList:
 * @cmd: the command to modify
 * @...: list of arguments to add
 *
 * Add a NULL terminated list of args.
1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336
 */
void
virCommandAddArgList(virCommandPtr cmd, ...)
{
    va_list list;
    int narg = 0;

    if (!cmd || cmd->has_error)
        return;

    va_start(list, cmd);
    while (va_arg(list, const char *) != NULL)
        narg++;
    va_end(list);

    /* narg plus trailing NULL. */
    if (VIR_RESIZE_N(cmd->args, cmd->maxargs, cmd->nargs, narg + 1) < 0) {
        cmd->has_error = ENOMEM;
        return;
    }

    va_start(list, cmd);
    while (1) {
        char *arg = va_arg(list, char *);
        if (!arg)
            break;
        arg = strdup(arg);
        if (!arg) {
            cmd->has_error = ENOMEM;
            va_end(list);
            return;
        }
        cmd->args[cmd->nargs++] = arg;
    }
    va_end(list);
}

E
Eric Blake 已提交
1337 1338 1339 1340 1341
/**
 * virCommandSetWorkingDirectory:
 * @cmd: the command to modify
 * @pwd: directory to use
 *
1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
 * Set the working directory of a non-daemon child process, rather
 * than the parent's working directory.  Daemons automatically get /
 * without using this call.
 */
void
virCommandSetWorkingDirectory(virCommandPtr cmd, const char *pwd)
{
    if (!cmd || cmd->has_error)
        return;

    if (cmd->pwd) {
        cmd->has_error = -1;
1354
        VIR_DEBUG("cannot set directory twice");
1355 1356 1357 1358 1359 1360 1361 1362
    } else {
        cmd->pwd = strdup(pwd);
        if (!cmd->pwd)
            cmd->has_error = ENOMEM;
    }
}


E
Eric Blake 已提交
1363 1364 1365 1366 1367 1368 1369
/**
 * virCommandSetInputBuffer:
 * @cmd: the command to modify
 * @inbuf: string to feed to stdin
 *
 * Feed the child's stdin from a string buffer.  This requires the use
 * of virCommandRun().
1370 1371 1372 1373 1374 1375 1376 1377 1378
 */
void
virCommandSetInputBuffer(virCommandPtr cmd, const char *inbuf)
{
    if (!cmd || cmd->has_error)
        return;

    if (cmd->infd != -1 || cmd->inbuf) {
        cmd->has_error = -1;
1379
        VIR_DEBUG("cannot specify input twice");
1380 1381 1382 1383 1384 1385 1386 1387 1388
        return;
    }

    cmd->inbuf = strdup(inbuf);
    if (!cmd->inbuf)
        cmd->has_error = ENOMEM;
}


E
Eric Blake 已提交
1389 1390 1391 1392 1393
/**
 * virCommandSetOutputBuffer:
 * @cmd: the command to modify
 * @outbuf: address of variable to store malloced result buffer
 *
1394 1395 1396 1397
 * Capture the child's stdout to a string buffer.  *outbuf is
 * guaranteed to be allocated after successful virCommandRun or
 * virCommandWait, and is best-effort allocated after failed
 * virCommandRun; caller is responsible for freeing *outbuf.
E
Eric Blake 已提交
1398
 * This requires the use of virCommandRun.
1399 1400 1401 1402
 */
void
virCommandSetOutputBuffer(virCommandPtr cmd, char **outbuf)
{
1403
    *outbuf = NULL;
1404 1405 1406 1407 1408
    if (!cmd || cmd->has_error)
        return;

    if (cmd->outfdptr) {
        cmd->has_error = -1;
1409
        VIR_DEBUG("cannot specify output twice");
1410 1411 1412 1413 1414 1415 1416 1417
        return;
    }

    cmd->outbuf = outbuf;
    cmd->outfdptr = &cmd->outfd;
}


E
Eric Blake 已提交
1418 1419 1420 1421 1422
/**
 * virCommandSetErrorBuffer:
 * @cmd: the command to modify
 * @errbuf: address of variable to store malloced result buffer
 *
1423 1424 1425 1426
 * Capture the child's stderr to a string buffer.  *errbuf is
 * guaranteed to be allocated after successful virCommandRun or
 * virCommandWait, and is best-effort allocated after failed
 * virCommandRun; caller is responsible for freeing *errbuf.
1427 1428 1429 1430
 * This requires the use of virCommandRun.  It is possible to
 * pass the same pointer as for virCommandSetOutputBuffer(), in
 * which case the child process will interleave all output into
 * a single string.
1431 1432 1433 1434
 */
void
virCommandSetErrorBuffer(virCommandPtr cmd, char **errbuf)
{
1435
    *errbuf = NULL;
1436 1437 1438 1439 1440
    if (!cmd || cmd->has_error)
        return;

    if (cmd->errfdptr) {
        cmd->has_error = -1;
1441
        VIR_DEBUG("cannot specify stderr twice");
1442 1443 1444 1445 1446 1447 1448 1449
        return;
    }

    cmd->errbuf = errbuf;
    cmd->errfdptr = &cmd->errfd;
}


E
Eric Blake 已提交
1450 1451 1452 1453 1454
/**
 * virCommandSetInputFD:
 * @cmd: the command to modify
 * @infd: the descriptor to use
 *
1455 1456 1457 1458 1459 1460 1461 1462 1463 1464
 * Attach a file descriptor to the child's stdin
 */
void
virCommandSetInputFD(virCommandPtr cmd, int infd)
{
    if (!cmd || cmd->has_error)
        return;

    if (cmd->infd != -1 || cmd->inbuf) {
        cmd->has_error = -1;
1465
        VIR_DEBUG("cannot specify input twice");
1466 1467 1468 1469
        return;
    }
    if (infd < 0) {
        cmd->has_error = -1;
1470
        VIR_DEBUG("cannot specify invalid input fd");
1471 1472 1473 1474 1475 1476 1477
        return;
    }

    cmd->infd = infd;
}


E
Eric Blake 已提交
1478 1479 1480 1481 1482 1483 1484 1485
/**
 * virCommandSetOutputFD:
 * @cmd: the command to modify
 * @outfd: location of output fd
 *
 * Attach a file descriptor to the child's stdout.  If *@outfd is -1 on
 * entry, then a pipe will be created and returned in this variable when
 * the child is run.  Otherwise, *@outfd is used as the output.
1486 1487 1488 1489 1490 1491 1492 1493 1494
 */
void
virCommandSetOutputFD(virCommandPtr cmd, int *outfd)
{
    if (!cmd || cmd->has_error)
        return;

    if (cmd->outfdptr) {
        cmd->has_error = -1;
1495
        VIR_DEBUG("cannot specify output twice");
1496 1497 1498 1499 1500 1501 1502
        return;
    }

    cmd->outfdptr = outfd;
}


E
Eric Blake 已提交
1503 1504 1505 1506 1507 1508 1509 1510 1511
/**
 * virCommandSetErrorFD:
 * @cmd: the command to modify
 * @errfd: location of error fd
 *
 * Attach a file descriptor to the child's stderr.  If *@errfd is -1 on
 * entry, then a pipe will be created and returned in this variable when
 * the child is run.  Otherwise, *@errfd is used for error collection,
 * and may be the same as outfd given to virCommandSetOutputFD().
1512 1513 1514 1515 1516 1517 1518 1519 1520
 */
void
virCommandSetErrorFD(virCommandPtr cmd, int *errfd)
{
    if (!cmd || cmd->has_error)
        return;

    if (cmd->errfdptr) {
        cmd->has_error = -1;
1521
        VIR_DEBUG("cannot specify stderr twice");
1522 1523 1524 1525 1526 1527 1528
        return;
    }

    cmd->errfdptr = errfd;
}


E
Eric Blake 已提交
1529 1530 1531 1532 1533 1534
/**
 * virCommandSetPreExecHook:
 * @cmd: the command to modify
 * @hook: the hook to run
 * @opaque: argument to pass to the hook
 *
1535 1536 1537
 * Run HOOK(OPAQUE) in the child as the last thing before changing
 * directories, dropping capabilities, and executing the new process.
 * Force the child to fail if HOOK does not return zero.
E
Eric Blake 已提交
1538 1539 1540
 *
 * Since @hook runs in the child, it should be careful to avoid
 * any functions that are not async-signal-safe.
1541 1542 1543 1544 1545 1546 1547 1548 1549
 */
void
virCommandSetPreExecHook(virCommandPtr cmd, virExecHook hook, void *opaque)
{
    if (!cmd || cmd->has_error)
        return;

    if (cmd->hook) {
        cmd->has_error = -1;
1550
        VIR_DEBUG("cannot specify hook twice");
1551 1552 1553 1554 1555 1556 1557
        return;
    }
    cmd->hook = hook;
    cmd->opaque = opaque;
}


E
Eric Blake 已提交
1558 1559 1560 1561 1562
/**
 * virCommandWriteArgLog:
 * @cmd: the command to log
 * @logfd: where to log the results
 *
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594
 * Call after adding all arguments and environment settings, but before
 * Run/RunAsync, to immediately output the environment and arguments of
 * cmd to logfd.  If virCommandRun cannot succeed (because of an
 * out-of-memory condition while building cmd), nothing will be logged.
 */
void
virCommandWriteArgLog(virCommandPtr cmd, int logfd)
{
    int ioError = 0;
    size_t i;

    /* Any errors will be reported later by virCommandRun, which means
     * no command will be run, so there is nothing to log. */
    if (!cmd || cmd->has_error)
        return;

    for (i = 0 ; i < cmd->nenv ; i++) {
        if (safewrite(logfd, cmd->env[i], strlen(cmd->env[i])) < 0)
            ioError = errno;
        if (safewrite(logfd, " ", 1) < 0)
            ioError = errno;
    }
    for (i = 0 ; i < cmd->nargs ; i++) {
        if (safewrite(logfd, cmd->args[i], strlen(cmd->args[i])) < 0)
            ioError = errno;
        if (safewrite(logfd, i == cmd->nargs - 1 ? "\n" : " ", 1) < 0)
            ioError = errno;
    }

    if (ioError) {
        char ebuf[1024];
        VIR_WARN("Unable to write command %s args to logfile: %s",
1595
                 cmd->args[0], virStrerror(ioError, ebuf, sizeof(ebuf)));
1596 1597 1598 1599
    }
}


E
Eric Blake 已提交
1600 1601 1602 1603
/**
 * virCommandToString:
 * @cmd: the command to convert
 *
1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617
 * Call after adding all arguments and environment settings, but before
 * Run/RunAsync, to return a string representation of the environment and
 * arguments of cmd.  If virCommandRun cannot succeed (because of an
 * out-of-memory condition while building cmd), NULL will be returned.
 * Caller is responsible for freeing the resulting string.
 */
char *
virCommandToString(virCommandPtr cmd)
{
    size_t i;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    /* Cannot assume virCommandRun will be called; so report the error
     * now.  If virCommandRun is called, it will report the same error. */
1618 1619
    if (!cmd ||cmd->has_error == ENOMEM) {
        virReportOOMError();
1620 1621
        return NULL;
    }
1622 1623 1624
    if (cmd->has_error) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("invalid use of command API"));
1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647
        return NULL;
    }

    for (i = 0; i < cmd->nenv; i++) {
        virBufferAdd(&buf, cmd->env[i], strlen(cmd->env[i]));
        virBufferAddChar(&buf, ' ');
    }
    virBufferAdd(&buf, cmd->args[0], strlen(cmd->args[0]));
    for (i = 1; i < cmd->nargs; i++) {
        virBufferAddChar(&buf, ' ');
        virBufferAdd(&buf, cmd->args[i], strlen(cmd->args[i]));
    }

    if (virBufferError(&buf)) {
        virBufferFreeAndReset(&buf);
        virReportOOMError();
        return NULL;
    }

    return virBufferContentAndReset(&buf);
}


E
Eric Blake 已提交
1648 1649 1650 1651
/**
 * virCommandTranslateStatus:
 * @status: child exit status to translate
 *
1652
 * Translate an exit status into a malloc'd string.  Generic helper
E
Eric Blake 已提交
1653 1654
 * for virCommandRun(), virCommandWait(), virRun(), and virPidWait()
 * status argument, as well as raw waitpid().
1655 1656 1657 1658 1659 1660
 */
char *
virCommandTranslateStatus(int status)
{
    char *buf;
    if (WIFEXITED(status)) {
1661 1662
        ignore_value(virAsprintf(&buf, _("exit status %d"),
                                 WEXITSTATUS(status)));
1663
    } else if (WIFSIGNALED(status)) {
1664 1665
        ignore_value(virAsprintf(&buf, _("fatal signal %d"),
                                 WTERMSIG(status)));
1666
    } else {
1667
        ignore_value(virAsprintf(&buf, _("invalid value %d"), status));
1668 1669 1670 1671 1672
    }
    return buf;
}


1673 1674 1675 1676
/*
 * Manage input and output to the child process.
 */
static int
E
Eric Blake 已提交
1677
virCommandProcessIO(virCommandPtr cmd, int *inpipe)
1678 1679 1680 1681
{
    int infd = -1, outfd = -1, errfd = -1;
    size_t inlen = 0, outlen = 0, errlen = 0;
    size_t inoff = 0;
1682
    int ret = 0;
1683 1684 1685 1686 1687

    /* With an input buffer, feed data to child
     * via pipe */
    if (cmd->inbuf) {
        inlen = strlen(cmd->inbuf);
E
Eric Blake 已提交
1688
        infd = *inpipe;
1689 1690
    }

1691 1692 1693 1694 1695
    /* With out/err buffer, the outfd/errfd have been filled with an
     * FD for us.  Guarantee an allocated string with partial results
     * even if we encounter a later failure, as well as freeing any
     * results accumulated over a prior run of the same command.  */
    if (cmd->outbuf) {
1696
        outfd = cmd->outfd;
1697 1698 1699 1700 1701 1702
        if (VIR_REALLOC_N(*cmd->outbuf, 1) < 0) {
            virReportOOMError();
            ret = -1;
        }
    }
    if (cmd->errbuf) {
1703
        errfd = cmd->errfd;
1704 1705 1706 1707 1708 1709 1710 1711
        if (VIR_REALLOC_N(*cmd->errbuf, 1) < 0) {
            virReportOOMError();
            ret = -1;
        }
    }
    if (ret == -1)
        goto cleanup;
    ret = -1;
1712 1713 1714 1715 1716 1717 1718 1719 1720

    for (;;) {
        int i;
        struct pollfd fds[3];
        int nfds = 0;

        if (infd != -1) {
            fds[nfds].fd = infd;
            fds[nfds].events = POLLOUT;
1721
            fds[nfds].revents = 0;
1722 1723 1724 1725 1726
            nfds++;
        }
        if (outfd != -1) {
            fds[nfds].fd = outfd;
            fds[nfds].events = POLLIN;
1727
            fds[nfds].revents = 0;
1728 1729 1730 1731 1732
            nfds++;
        }
        if (errfd != -1) {
            fds[nfds].fd = errfd;
            fds[nfds].events = POLLIN;
1733
            fds[nfds].revents = 0;
1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744
            nfds++;
        }

        if (nfds == 0)
            break;

        if (poll(fds, nfds, -1) < 0) {
            if ((errno == EAGAIN) || (errno == EINTR))
                continue;
            virReportSystemError(errno, "%s",
                                 _("unable to poll on child"));
1745
            goto cleanup;
1746 1747 1748
        }

        for (i = 0; i < nfds ; i++) {
1749
            if (fds[i].revents & (POLLIN | POLLHUP | POLLERR) &&
1750
                (fds[i].fd == errfd || fds[i].fd == outfd)) {
1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761
                char data[1024];
                char **buf;
                size_t *len;
                int done;
                if (fds[i].fd == outfd) {
                    buf = cmd->outbuf;
                    len = &outlen;
                } else {
                    buf = cmd->errbuf;
                    len = &errlen;
                }
1762 1763
                /* Silence a false positive from clang. */
                sa_assert(buf);
1764 1765 1766 1767 1768 1769

                done = read(fds[i].fd, data, sizeof(data));
                if (done < 0) {
                    if (errno != EINTR &&
                        errno != EAGAIN) {
                        virReportSystemError(errno, "%s",
1770 1771 1772
                                             (fds[i].fd == outfd) ?
                                             _("unable to read child stdout") :
                                             _("unable to read child stderr"));
1773
                        goto cleanup;
1774 1775 1776 1777 1778 1779 1780 1781 1782
                    }
                } else if (done == 0) {
                    if (fds[i].fd == outfd)
                        outfd = -1;
                    else
                        errfd = -1;
                } else {
                    if (VIR_REALLOC_N(*buf, *len + done + 1) < 0) {
                        virReportOOMError();
1783
                        goto cleanup;
1784 1785 1786 1787
                    }
                    memcpy(*buf + *len, data, done);
                    *len += done;
                }
1788 1789
            }

1790
            if (fds[i].revents & (POLLOUT | POLLERR) &&
1791
                fds[i].fd == infd) {
1792 1793
                int done;

1794 1795 1796
                /* Coverity 5.3.0 can't see that we only get here if
                 * infd is in the set because it was non-negative.  */
                sa_assert(infd != -1);
1797 1798 1799 1800 1801 1802 1803
                done = write(infd, cmd->inbuf + inoff,
                             inlen - inoff);
                if (done < 0) {
                    if (errno != EINTR &&
                        errno != EAGAIN) {
                        virReportSystemError(errno, "%s",
                                             _("unable to write to child input"));
1804
                        goto cleanup;
1805 1806 1807 1808
                    }
                } else {
                    inoff += done;
                    if (inoff == inlen) {
E
Eric Blake 已提交
1809 1810 1811
                        if (VIR_CLOSE(*inpipe) < 0)
                            VIR_DEBUG("ignoring failed close on fd %d", infd);
                        infd = -1;
1812 1813 1814 1815 1816 1817
                    }
                }
            }
        }
    }

1818 1819
    ret = 0;
cleanup:
1820
    if (cmd->outbuf && *cmd->outbuf)
1821
        (*cmd->outbuf)[outlen] = '\0';
1822
    if (cmd->errbuf && *cmd->errbuf)
1823 1824
        (*cmd->errbuf)[errlen] = '\0';
    return ret;
1825 1826
}

E
Eric Blake 已提交
1827 1828 1829 1830
/**
 * virCommandExec:
 * @cmd: command to run
 *
1831
 * Exec the command, replacing the current process. Meant to be called
E
Eric Blake 已提交
1832 1833
 * in the hook after already forking / cloning, so does not attempt to
 * daemonize or preserve any FDs.
1834 1835 1836 1837
 *
 * Returns -1 on any error executing the command.
 * Will not return on success.
 */
1838
#ifndef WIN32
1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852
int virCommandExec(virCommandPtr cmd)
{
    if (!cmd ||cmd->has_error == ENOMEM) {
        virReportOOMError();
        return -1;
    }
    if (cmd->has_error) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("invalid use of command API"));
        return -1;
    }

    return execve(cmd->args[0], cmd->args, cmd->env);
}
1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864
#else
int virCommandExec(virCommandPtr cmd ATTRIBUTE_UNUSED)
{
    /* Mingw execve() has a broken signature. Disable this
     * function until gnulib fixes the signature, since we
     * don't really need this on Win32 anyway.
     */
    virReportSystemError(ENOSYS, "%s",
                         _("Executing new processes is not supported on Win32 platform"));
    return -1;
}
#endif
1865

E
Eric Blake 已提交
1866 1867 1868 1869 1870
/**
 * virCommandRun:
 * @cmd: command to run
 * @exitstatus: optional status collection
 *
1871 1872 1873
 * Run the command and wait for completion.
 * Returns -1 on any error executing the
 * command. Returns 0 if the command executed,
E
Eric Blake 已提交
1874 1875
 * with the exit status set.  If @exitstatus is NULL, then the
 * child must exit with status 0 for this to succeed.
1876 1877 1878 1879 1880 1881 1882
 */
int
virCommandRun(virCommandPtr cmd, int *exitstatus)
{
    int ret = 0;
    char *outbuf = NULL;
    char *errbuf = NULL;
1883
    int infd[2] = { -1, -1 };
1884 1885 1886
    struct stat st;
    bool string_io;
    bool async_io = false;
1887
    char *str;
1888

1889 1890
    if (!cmd ||cmd->has_error == ENOMEM) {
        virReportOOMError();
1891 1892
        return -1;
    }
1893 1894 1895
    if (cmd->has_error) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("invalid use of command API"));
1896 1897 1898
        return -1;
    }

1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927
    /* Avoid deadlock, by requiring that any open fd not under our
     * control must be visiting a regular file, or that we are
     * daemonized and no string io is required.  */
    string_io = cmd->inbuf || cmd->outbuf || cmd->errbuf;
    if (cmd->infd != -1 &&
        (fstat(cmd->infd, &st) < 0 || !S_ISREG(st.st_mode)))
        async_io = true;
    if (cmd->outfdptr && cmd->outfdptr != &cmd->outfd &&
        (*cmd->outfdptr == -1 ||
         fstat(*cmd->outfdptr, &st) < 0 || !S_ISREG(st.st_mode)))
        async_io = true;
    if (cmd->errfdptr && cmd->errfdptr != &cmd->errfd &&
        (*cmd->errfdptr == -1 ||
         fstat(*cmd->errfdptr, &st) < 0 || !S_ISREG(st.st_mode)))
        async_io = true;
    if (async_io) {
        if (!(cmd->flags & VIR_EXEC_DAEMON) || string_io) {
            virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                            _("cannot mix caller fds with blocking execution"));
            return -1;
        }
    } else {
        if ((cmd->flags & VIR_EXEC_DAEMON) && string_io) {
            virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                            _("cannot mix string I/O with daemon"));
            return -1;
        }
    }

1928 1929 1930
    /* If we have an input buffer, we need
     * a pipe to feed the data to the child */
    if (cmd->inbuf) {
1931
        if (pipe2(infd, O_CLOEXEC) < 0) {
1932 1933 1934 1935 1936 1937 1938 1939
            virReportSystemError(errno, "%s",
                                 _("unable to open pipe"));
            cmd->has_error = -1;
            return -1;
        }
        cmd->infd = infd[0];
    }

1940 1941 1942 1943 1944 1945 1946
    /* If caller requested the same string for stdout and stderr, then
     * merge those into one string.  */
    if (cmd->outbuf && cmd->outbuf == cmd->errbuf) {
        cmd->errfdptr = &cmd->outfd;
        cmd->errbuf = NULL;
    }

1947
    /* If caller hasn't requested capture of stdout/err, then capture
1948 1949 1950
     * it ourselves so we can log it.  But the intermediate child for
     * a daemon has no expected output, and we don't want our
     * capturing pipes passed on to the daemon grandchild.
1951
     */
1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962
    if (!(cmd->flags & VIR_EXEC_DAEMON)) {
        if (!cmd->outfdptr) {
            cmd->outfdptr = &cmd->outfd;
            cmd->outbuf = &outbuf;
            string_io = true;
        }
        if (!cmd->errfdptr) {
            cmd->errfdptr = &cmd->errfd;
            cmd->errbuf = &errbuf;
            string_io = true;
        }
1963 1964
    }

1965
    cmd->flags |= VIR_EXEC_RUN_SYNC;
1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978
    if (virCommandRunAsync(cmd, NULL) < 0) {
        if (cmd->inbuf) {
            int tmpfd = infd[0];
            if (VIR_CLOSE(infd[0]) < 0)
                VIR_DEBUG("ignoring failed close on fd %d", tmpfd);
            tmpfd = infd[1];
            if (VIR_CLOSE(infd[1]) < 0)
                VIR_DEBUG("ignoring failed close on fd %d", tmpfd);
        }
        cmd->has_error = -1;
        return -1;
    }

1979
    if (string_io)
E
Eric Blake 已提交
1980
        ret = virCommandProcessIO(cmd, &infd[1]);
1981 1982 1983 1984

    if (virCommandWait(cmd, exitstatus) < 0)
        ret = -1;

1985 1986 1987 1988
    str = (exitstatus ? virCommandTranslateStatus(*exitstatus)
           : (char *) "status 0");
    VIR_DEBUG("Result %s, stdout: '%s' stderr: '%s'",
              NULLSTR(str),
1989 1990
              cmd->outbuf ? NULLSTR(*cmd->outbuf) : "(null)",
              cmd->errbuf ? NULLSTR(*cmd->errbuf) : "(null)");
1991 1992
    if (exitstatus)
        VIR_FREE(str);
1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004

    /* Reset any capturing, in case caller runs
     * this identical command again */
    if (cmd->inbuf) {
        int tmpfd = infd[0];
        if (VIR_CLOSE(infd[0]) < 0)
            VIR_DEBUG("ignoring failed close on fd %d", tmpfd);
        tmpfd = infd[1];
        if (VIR_CLOSE(infd[1]) < 0)
            VIR_DEBUG("ignoring failed close on fd %d", tmpfd);
    }
    if (cmd->outbuf == &outbuf) {
2005 2006
        int tmpfd ATTRIBUTE_UNUSED;
        tmpfd = cmd->outfd;
2007 2008 2009 2010
        if (VIR_CLOSE(cmd->outfd) < 0)
            VIR_DEBUG("ignoring failed close on fd %d", tmpfd);
        cmd->outfdptr = NULL;
        cmd->outbuf = NULL;
E
Eric Blake 已提交
2011
        VIR_FREE(outbuf);
2012 2013
    }
    if (cmd->errbuf == &errbuf) {
2014 2015
        int tmpfd ATTRIBUTE_UNUSED;
        tmpfd = cmd->errfd;
2016 2017 2018 2019
        if (VIR_CLOSE(cmd->errfd) < 0)
            VIR_DEBUG("ignoring failed close on fd %d", tmpfd);
        cmd->errfdptr = NULL;
        cmd->errbuf = NULL;
E
Eric Blake 已提交
2020
        VIR_FREE(errbuf);
2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035
    }

    return ret;
}


/*
 * Perform all virCommand-specific actions, along with the user hook.
 */
static int
virCommandHook(void *data)
{
    virCommandPtr cmd = data;
    int res = 0;

2036 2037
    if (cmd->hook) {
        VIR_DEBUG("Run hook %p %p", cmd->hook, cmd->opaque);
2038
        res = cmd->hook(cmd->opaque);
2039 2040
        VIR_DEBUG("Done hook %d", res);
    }
2041 2042 2043
    if (res == 0 && cmd->pwd) {
        VIR_DEBUG("Running child in %s", cmd->pwd);
        res = chdir(cmd->pwd);
2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086
        if (res < 0) {
            virReportSystemError(errno,
                                 _("Unable to change to %s"), cmd->pwd);
        }
    }
    if (cmd->handshake) {
        char c = res < 0 ? '0' : '1';
        int rv;
        VIR_DEBUG("Notifying parent for handshake start on %d", cmd->handshakeWait[1]);
        if (safewrite(cmd->handshakeWait[1], &c, sizeof(c)) != sizeof(c)) {
            virReportSystemError(errno, "%s", _("Unable to notify parent process"));
            return -1;
        }

        /* On failure we pass the error message back to parent,
         * so they don't have to dig through stderr logs
         */
        if (res < 0) {
            virErrorPtr err = virGetLastError();
            const char *msg = err ? err->message :
                _("Unknown failure during hook execution");
            size_t len = strlen(msg) + 1;
            if (safewrite(cmd->handshakeWait[1], msg, len) != len) {
                virReportSystemError(errno, "%s", _("Unable to send error to parent process"));
                return -1;
            }
            return -1;
        }

        VIR_DEBUG("Waiting on parent for handshake complete on %d", cmd->handshakeNotify[0]);
        if ((rv = saferead(cmd->handshakeNotify[0], &c, sizeof(c))) != sizeof(c)) {
            if (rv < 0)
                virReportSystemError(errno, "%s", _("Unable to wait on parent process"));
            else
                virReportSystemError(EIO, "%s", _("libvirtd quit during handshake"));
            return -1;
        }
        if (c != '1') {
            virReportSystemError(EINVAL, _("Unexpected confirm code '%c' from parent process"), c);
            return -1;
        }
        VIR_FORCE_CLOSE(cmd->handshakeWait[1]);
        VIR_FORCE_CLOSE(cmd->handshakeNotify[0]);
2087
    }
2088 2089 2090

    VIR_DEBUG("Hook is done %d", res);

2091 2092 2093 2094
    return res;
}


E
Eric Blake 已提交
2095 2096 2097 2098 2099
/**
 * virCommandRunAsync:
 * @cmd: command to start
 * @pid: optional variable to track child pid
 *
2100 2101 2102
 * Run the command asynchronously
 * Returns -1 on any error executing the
 * command. Returns 0 if the command executed.
2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113
 *
 * There are two approaches to child process cleanup.
 * 1. Use auto-cleanup, by passing NULL for pid.  The child will be
 * auto-reaped by virCommandFree, unless you reap it earlier via
 * virCommandWait or virCommandAbort.  Good for where cmd is in
 * scope for the duration of the child process.
 * 2. Use manual cleanup, by passing the address of a pid_t variable
 * for pid.  While cmd is still in scope, you may reap the child via
 * virCommandWait or virCommandAbort.  But after virCommandFree, if
 * you have not yet reaped the child, then it continues to run until
 * you call virPidWait or virPidAbort.
2114 2115 2116 2117 2118 2119 2120
 */
int
virCommandRunAsync(virCommandPtr cmd, pid_t *pid)
{
    int ret;
    char *str;
    int i;
2121
    bool synchronous = false;
2122

2123 2124
    if (!cmd || cmd->has_error == ENOMEM) {
        virReportOOMError();
2125 2126
        return -1;
    }
2127 2128 2129
    if (cmd->has_error) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("invalid use of command API"));
2130 2131 2132
        return -1;
    }

2133 2134 2135
    synchronous = cmd->flags & VIR_EXEC_RUN_SYNC;
    cmd->flags &= ~VIR_EXEC_RUN_SYNC;

2136 2137 2138 2139 2140 2141 2142 2143 2144
    /* Buffer management can only be requested via virCommandRun.  */
    if ((cmd->inbuf && cmd->infd == -1) ||
        (cmd->outbuf && cmd->outfdptr != &cmd->outfd) ||
        (cmd->errbuf && cmd->errfdptr != &cmd->errfd)) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("cannot mix string I/O with asynchronous command"));
        return -1;
    }

2145 2146
    if (cmd->pid != -1) {
        virCommandError(VIR_ERR_INTERNAL_ERROR,
E
Eric Blake 已提交
2147 2148
                        _("command is already running as pid %lld"),
                        (long long) cmd->pid);
2149 2150 2151
        return -1;
    }

2152 2153 2154 2155 2156
    if (!synchronous && (cmd->flags & VIR_EXEC_DAEMON)) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("daemonized command cannot use virCommandRunAsync"));
        return -1;
    }
2157 2158 2159 2160 2161 2162
    if (cmd->pwd && (cmd->flags & VIR_EXEC_DAEMON)) {
        virCommandError(VIR_ERR_INTERNAL_ERROR,
                        _("daemonized command cannot set working directory %s"),
                        cmd->pwd);
        return -1;
    }
2163 2164 2165 2166 2167
    if (cmd->pidfile && !(cmd->flags & VIR_EXEC_DAEMON)) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("creation of pid file requires daemonized command"));
        return -1;
    }
2168 2169 2170 2171 2172 2173 2174

    str = virCommandToString(cmd);
    VIR_DEBUG("About to run %s", str ? str : cmd->args[0]);
    VIR_FREE(str);

    ret = virExecWithHook((const char *const *)cmd->args,
                          (const char *const *)cmd->env,
2175 2176
                          cmd->preserve,
                          cmd->preserve_size,
2177 2178 2179 2180 2181 2182 2183
                          &cmd->pid,
                          cmd->infd,
                          cmd->outfdptr,
                          cmd->errfdptr,
                          cmd->flags,
                          virCommandHook,
                          cmd,
T
Taku Izumi 已提交
2184 2185
                          cmd->pidfile,
                          cmd->capabilities);
2186 2187 2188 2189

    VIR_DEBUG("Command result %d, with PID %d",
              ret, (int)cmd->pid);

2190 2191
    for (i = 0; i < cmd->transfer_size; i++) {
        VIR_FORCE_CLOSE(cmd->transfer[i]);
2192
    }
2193 2194
    cmd->transfer_size = 0;
    VIR_FREE(cmd->transfer);
2195 2196 2197

    if (ret == 0 && pid)
        *pid = cmd->pid;
2198 2199
    else
        cmd->reap = true;
2200 2201 2202 2203 2204

    return ret;
}


E
Eric Blake 已提交
2205 2206 2207 2208 2209
/**
 * virPidWait:
 * @pid: child to wait on
 * @exitstatus: optional status collection
 *
2210 2211 2212
 * Wait for a child process to complete.
 * Return -1 on any error waiting for
 * completion. Returns 0 if the command
E
Eric Blake 已提交
2213 2214
 * finished with the exit status set.  If @exitstatus is NULL, then the
 * child must exit with status 0 for this to succeed.
2215 2216 2217 2218 2219 2220 2221 2222
 */
int
virPidWait(pid_t pid, int *exitstatus)
{
    int ret;
    int status;

    if (pid <= 0) {
E
Eric Blake 已提交
2223 2224
        virReportSystemError(EINVAL, _("unable to wait for process %lld"),
                             (long long) pid);
2225 2226 2227 2228 2229 2230 2231 2232
        return -1;
    }

    /* Wait for intermediate process to exit */
    while ((ret = waitpid(pid, &status, 0)) == -1 &&
           errno == EINTR);

    if (ret == -1) {
E
Eric Blake 已提交
2233 2234
        virReportSystemError(errno, _("unable to wait for process %lld"),
                             (long long) pid);
2235 2236 2237 2238 2239 2240 2241
        return -1;
    }

    if (exitstatus == NULL) {
        if (status != 0) {
            char *st = virCommandTranslateStatus(status);
            virCommandError(VIR_ERR_INTERNAL_ERROR,
E
Eric Blake 已提交
2242 2243
                            _("Child process (%lld) status unexpected: %s"),
                            (long long) pid, NULLSTR(st));
2244 2245 2246 2247 2248 2249 2250 2251 2252 2253
            VIR_FREE(st);
            return -1;
        }
    } else {
        *exitstatus = status;
    }

    return 0;
}

E
Eric Blake 已提交
2254 2255 2256 2257 2258 2259 2260
/**
 * virCommandWait:
 * @cmd: command to wait on
 * @exitstatus: optional status collection
 *
 * Wait for the command previously started with virCommandRunAsync()
 * to complete. Return -1 on any error waiting for
2261
 * completion. Returns 0 if the command
E
Eric Blake 已提交
2262 2263
 * finished with the exit status set.  If @exitstatus is NULL, then the
 * child must exit with status 0 for this to succeed.
2264 2265 2266 2267 2268
 */
int
virCommandWait(virCommandPtr cmd, int *exitstatus)
{
    int ret;
2269
    int status = 0;
2270

2271 2272
    if (!cmd ||cmd->has_error == ENOMEM) {
        virReportOOMError();
2273 2274
        return -1;
    }
2275 2276 2277
    if (cmd->has_error) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("invalid use of command API"));
2278 2279 2280 2281 2282 2283 2284 2285 2286
        return -1;
    }

    if (cmd->pid == -1) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("command is not yet running"));
        return -1;
    }

2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297
    /* If virPidWait reaps pid but then returns failure because
     * exitstatus was NULL, then a second virCommandWait would risk
     * calling waitpid on an unrelated process.  Besides, that error
     * message is not as detailed as what we can provide.  So, we
     * guarantee that virPidWait only fails due to failure to wait,
     * and repeat the exitstatus check code ourselves.  */
    ret = virPidWait(cmd->pid, exitstatus ? exitstatus : &status);
    if (ret == 0) {
        cmd->pid = -1;
        cmd->reap = false;
        if (status) {
2298
            char *str = virCommandToString(cmd);
2299
            char *st = virCommandTranslateStatus(status);
2300
            virCommandError(VIR_ERR_INTERNAL_ERROR,
2301 2302
                            _("Child process (%s) status unexpected: %s"),
                            str ? str : cmd->args[0], NULLSTR(st));
2303
            VIR_FREE(str);
2304
            VIR_FREE(st);
2305 2306 2307 2308
            return -1;
        }
    }

2309
    return ret;
2310 2311 2312
}


E
Eric Blake 已提交
2313
#ifndef WIN32
E
Eric Blake 已提交
2314 2315 2316 2317
/**
 * virPidAbort:
 * @pid: child process to kill
 *
2318 2319 2320
 * Abort a child process if PID is positive and that child is still
 * running, without issuing any errors or affecting errno.  Designed
 * for error paths where some but not all paths to the cleanup code
E
Eric Blake 已提交
2321 2322
 * might have started the child process.  If @pid is 0 or negative,
 * this does nothing.
2323 2324
 */
void
2325
virPidAbort(pid_t pid)
2326 2327 2328 2329 2330 2331
{
    int saved_errno;
    int ret;
    int status;
    char *tmp = NULL;

2332
    if (pid <= 0)
2333 2334 2335 2336 2337 2338
        return;

    /* See if intermediate process has exited; if not, try a nice
     * SIGTERM followed by a more severe SIGKILL.
     */
    saved_errno = errno;
2339 2340
    VIR_DEBUG("aborting child process %d", pid);
    while ((ret = waitpid(pid, &status, WNOHANG)) == -1 &&
2341
           errno == EINTR);
2342
    if (ret == pid) {
2343 2344 2345 2346
        tmp = virCommandTranslateStatus(status);
        VIR_DEBUG("process has ended: %s", tmp);
        goto cleanup;
    } else if (ret == 0) {
2347 2348
        VIR_DEBUG("trying SIGTERM to child process %d", pid);
        kill(pid, SIGTERM);
2349
        usleep(10 * 1000);
2350
        while ((ret = waitpid(pid, &status, WNOHANG)) == -1 &&
2351
               errno == EINTR);
2352
        if (ret == pid) {
2353 2354 2355 2356
            tmp = virCommandTranslateStatus(status);
            VIR_DEBUG("process has ended: %s", tmp);
            goto cleanup;
        } else if (ret == 0) {
2357 2358 2359
            VIR_DEBUG("trying SIGKILL to child process %d", pid);
            kill(pid, SIGKILL);
            while ((ret = waitpid(pid, &status, 0)) == -1 &&
2360
                   errno == EINTR);
2361
            if (ret == pid) {
2362 2363 2364 2365 2366 2367
                tmp = virCommandTranslateStatus(status);
                VIR_DEBUG("process has ended: %s", tmp);
                goto cleanup;
            }
        }
    }
E
Eric Blake 已提交
2368
    VIR_DEBUG("failed to reap child %lld, abandoning it", (long long) pid);
2369 2370 2371

cleanup:
    VIR_FREE(tmp);
2372 2373 2374
    errno = saved_errno;
}

E
Eric Blake 已提交
2375 2376 2377 2378
/**
 * virCommandAbort:
 * @cmd: command to abort
 *
2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389
 * Abort an async command if it is running, without issuing
 * any errors or affecting errno.  Designed for error paths
 * where some but not all paths to the cleanup code might
 * have started the child process.
 */
void
virCommandAbort(virCommandPtr cmd)
{
    if (!cmd || cmd->pid == -1)
        return;
    virPidAbort(cmd->pid);
2390 2391 2392
    cmd->pid = -1;
    cmd->reap = false;
}
E
Eric Blake 已提交
2393
#else /* WIN32 */
2394 2395 2396 2397
void
virPidAbort(pid_t pid)
{
    /* Not yet ported to mingw.  Any volunteers?  */
2398
    VIR_DEBUG("failed to reap child %lld, abandoning it", (long long)pid);
2399 2400
}

E
Eric Blake 已提交
2401 2402 2403 2404 2405 2406 2407 2408
void
virCommandAbort(virCommandPtr cmd ATTRIBUTE_UNUSED)
{
    /* Mingw lacks WNOHANG and kill().  But since we haven't ported
     * virExecWithHook to mingw yet, there's no process to be killed,
     * making this implementation trivially correct for now :)  */
}
#endif
2409

2410

E
Eric Blake 已提交
2411 2412 2413 2414 2415 2416 2417 2418 2419
/**
 * virCommandRequireHandshake:
 * @cmd: command to modify
 *
 * Request that the child perform a handshake with
 * the parent when the hook function has completed
 * execution. The child will not exec() until the
 * parent has notified
 */
2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430
void virCommandRequireHandshake(virCommandPtr cmd)
{
    if (!cmd || cmd->has_error)
        return;

    if (cmd->handshake) {
        cmd->has_error = -1;
        VIR_DEBUG("Cannot require handshake twice");
        return;
    }

2431
    if (pipe2(cmd->handshakeWait, O_CLOEXEC) < 0) {
2432 2433 2434
        cmd->has_error = errno;
        return;
    }
2435
    if (pipe2(cmd->handshakeNotify, O_CLOEXEC) < 0) {
2436 2437 2438 2439 2440 2441
        VIR_FORCE_CLOSE(cmd->handshakeWait[0]);
        VIR_FORCE_CLOSE(cmd->handshakeWait[1]);
        cmd->has_error = errno;
        return;
    }

2442 2443 2444 2445
    VIR_DEBUG("Transfer handshake wait=%d notify=%d, "
              "keep handshake wait=%d notify=%d",
              cmd->handshakeWait[1], cmd->handshakeNotify[0],
              cmd->handshakeWait[0], cmd->handshakeNotify[1]);
2446 2447 2448 2449 2450
    virCommandTransferFD(cmd, cmd->handshakeWait[1]);
    virCommandTransferFD(cmd, cmd->handshakeNotify[0]);
    cmd->handshake = true;
}

E
Eric Blake 已提交
2451 2452 2453 2454 2455 2456 2457
/**
 * virCommandHandshakeWait:
 * @cmd: command to wait on
 *
 * Wait for the child to complete execution of its
 * hook function.  To be called in the parent.
 */
2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510
int virCommandHandshakeWait(virCommandPtr cmd)
{
    char c;
    int rv;
    if (!cmd ||cmd->has_error == ENOMEM) {
        virReportOOMError();
        return -1;
    }
    if (cmd->has_error || !cmd->handshake) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("invalid use of command API"));
        return -1;
    }

    if (cmd->handshakeWait[0] == -1) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("Handshake is already complete"));
        return -1;
    }

    VIR_DEBUG("Wait for handshake on %d", cmd->handshakeWait[0]);
    if ((rv = saferead(cmd->handshakeWait[0], &c, sizeof(c))) != sizeof(c)) {
        if (rv < 0)
            virReportSystemError(errno, "%s", _("Unable to wait for child process"));
        else
            virReportSystemError(EIO, "%s", _("Child process quit during startup handshake"));
        VIR_FORCE_CLOSE(cmd->handshakeWait[0]);
        return -1;
    }
    if (c != '1') {
        char *msg;
        ssize_t len;
        if (VIR_ALLOC_N(msg, 1024) < 0) {
            virReportOOMError();
            VIR_FORCE_CLOSE(cmd->handshakeWait[0]);
            return -1;
        }
        if ((len = saferead(cmd->handshakeWait[0], msg, 1024)) < 0) {
            VIR_FORCE_CLOSE(cmd->handshakeWait[0]);
            VIR_FREE(msg);
            virReportSystemError(errno, "%s", _("No error message from child failure"));
            return -1;
        }
        VIR_FORCE_CLOSE(cmd->handshakeWait[0]);
        msg[len-1] = '\0';
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s", msg);
        VIR_FREE(msg);
        return -1;
    }
    VIR_FORCE_CLOSE(cmd->handshakeWait[0]);
    return 0;
}

E
Eric Blake 已提交
2511 2512 2513 2514 2515 2516 2517
/**
 * virCommandHandshakeNotify:
 * @cmd: command to resume
 *
 * Notify the child that it is OK to exec() the
 * real binary now.  To be called in the parent.
 */
2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536
int virCommandHandshakeNotify(virCommandPtr cmd)
{
    char c = '1';
    if (!cmd ||cmd->has_error == ENOMEM) {
        virReportOOMError();
        return -1;
    }
    if (cmd->has_error || !cmd->handshake) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("invalid use of command API"));
        return -1;
    }

    if (cmd->handshakeNotify[1] == -1) {
        virCommandError(VIR_ERR_INTERNAL_ERROR, "%s",
                        _("Handshake is already complete"));
        return -1;
    }

2537
    VIR_DEBUG("Notify handshake on %d", cmd->handshakeNotify[1]);
2538 2539 2540 2541 2542 2543 2544 2545 2546 2547
    if (safewrite(cmd->handshakeNotify[1], &c, sizeof(c)) != sizeof(c)) {
        virReportSystemError(errno, "%s", _("Unable to notify child process"));
        VIR_FORCE_CLOSE(cmd->handshakeNotify[1]);
        return -1;
    }
    VIR_FORCE_CLOSE(cmd->handshakeNotify[1]);
    return 0;
}


E
Eric Blake 已提交
2548 2549 2550 2551
/**
 * virCommandFree:
 * @cmd: optional command to free
 *
2552 2553
 * Release all resources.  The only exception is that if you called
 * virCommandRunAsync with a non-null pid, then the asynchronous child
E
Eric Blake 已提交
2554
 * is not reaped, and you must call virPidWait() or virPidAbort() yourself.
2555 2556 2557 2558 2559 2560 2561 2562
 */
void
virCommandFree(virCommandPtr cmd)
{
    int i;
    if (!cmd)
        return;

2563 2564
    for (i = 0; i < cmd->transfer_size; i++) {
        VIR_FORCE_CLOSE(cmd->transfer[i]);
2565 2566
    }

E
Eric Blake 已提交
2567
    VIR_FREE(cmd->inbuf);
2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580
    VIR_FORCE_CLOSE(cmd->outfd);
    VIR_FORCE_CLOSE(cmd->errfd);

    for (i = 0 ; i < cmd->nargs ; i++)
        VIR_FREE(cmd->args[i]);
    VIR_FREE(cmd->args);

    for (i = 0 ; i < cmd->nenv ; i++)
        VIR_FREE(cmd->env[i]);
    VIR_FREE(cmd->env);

    VIR_FREE(cmd->pwd);

2581 2582 2583 2584 2585 2586 2587 2588
    if (cmd->handshake) {
        /* The other 2 fds in these arrays are closed
         * due to use with virCommandTransferFD
         */
        VIR_FORCE_CLOSE(cmd->handshakeWait[0]);
        VIR_FORCE_CLOSE(cmd->handshakeNotify[1]);
    }

2589 2590
    VIR_FREE(cmd->pidfile);

2591 2592 2593
    if (cmd->reap)
        virCommandAbort(cmd);

2594 2595 2596
    VIR_FREE(cmd->transfer);
    VIR_FREE(cmd->preserve);

2597 2598
    VIR_FREE(cmd);
}