virsh.c 373.6 KB
Newer Older
1
/*
2
 * virsh.c: a shell to exercise the libvirt API
3
 *
4
 * Copyright (C) 2005, 2007-2011 Red Hat, Inc.
5 6 7 8
 *
 * See COPYING.LIB for the License of this software
 *
 * Daniel Veillard <veillard@redhat.com>
K
Karel Zak 已提交
9
 * Karel Zak <kzak@redhat.com>
K
Karel Zak 已提交
10
 * Daniel P. Berrange <berrange@redhat.com>
11 12
 */

13
#include <config.h>
14

15
#include <stdio.h>
K
Karel Zak 已提交
16 17 18
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
19
#include <unistd.h>
20
#include <errno.h>
K
Karel Zak 已提交
21
#include <getopt.h>
22
#include <sys/types.h>
K
Karel Zak 已提交
23
#include <sys/time.h>
E
Eric Blake 已提交
24
#include <sys/wait.h>
J
Jim Meyering 已提交
25
#include "c-ctype.h"
26
#include <fcntl.h>
27
#include <locale.h>
28
#include <time.h>
29
#include <limits.h>
30
#include <assert.h>
31
#include <sys/stat.h>
32
#include <inttypes.h>
33
#include <signal.h>
34
#include <poll.h>
K
Karel Zak 已提交
35

36 37 38
#include <libxml/parser.h>
#include <libxml/tree.h>
#include <libxml/xpath.h>
39
#include <libxml/xmlsave.h>
40

41
#ifdef HAVE_READLINE_READLINE_H
42 43
# include <readline/readline.h>
# include <readline/history.h>
44
#endif
K
Karel Zak 已提交
45

46
#include "internal.h"
47
#include "virterror_internal.h"
48
#include "base64.h"
49
#include "buf.h"
50
#include "console.h"
51
#include "util.h"
52
#include "memory.h"
53
#include "xml.h"
54
#include "libvirt/libvirt-qemu.h"
55
#include "files.h"
56
#include "event_poll.h"
57
#include "configmake.h"
58
#include "threads.h"
E
Eric Blake 已提交
59
#include "command.h"
60
#include "count-one-bits.h"
K
Karel Zak 已提交
61 62 63

static char *progname;

64 65
#define VIRSH_MAX_XML_FILE 10*1024*1024

K
Karel Zak 已提交
66 67 68 69 70 71 72 73
#define VSH_PROMPT_RW    "virsh # "
#define VSH_PROMPT_RO    "virsh > "

#define GETTIMEOFDAY(T) gettimeofday(T, NULL)
#define DIFF_MSEC(T, U) \
        ((((int) ((T)->tv_sec - (U)->tv_sec)) * 1000000.0 + \
          ((int) ((T)->tv_usec - (U)->tv_usec))) / 1000.0)

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
/**
 * The log configuration
 */
#define MSG_BUFFER    4096
#define SIGN_NAME     "virsh"
#define DIR_MODE      (S_IWUSR | S_IRUSR | S_IXUSR | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)  /* 0755 */
#define FILE_MODE     (S_IWUSR | S_IRUSR | S_IRGRP | S_IROTH)                                /* 0644 */
#define LOCK_MODE     (S_IWUSR | S_IRUSR)                                                    /* 0600 */
#define LVL_DEBUG     "DEBUG"
#define LVL_INFO      "INFO"
#define LVL_NOTICE    "NOTICE"
#define LVL_WARNING   "WARNING"
#define LVL_ERROR     "ERROR"

/**
 * vshErrorLevel:
 *
J
Jim Meyering 已提交
91
 * Indicates the level of a log message
92 93 94 95 96 97 98 99 100
 */
typedef enum {
    VSH_ERR_DEBUG = 0,
    VSH_ERR_INFO,
    VSH_ERR_NOTICE,
    VSH_ERR_WARNING,
    VSH_ERR_ERROR
} vshErrorLevel;

K
Karel Zak 已提交
101 102 103 104 105
/*
 * virsh command line grammar:
 *
 *    command_line    =     <command>\n | <command>; <command>; ...
 *
E
Eric Blake 已提交
106
 *    command         =    <keyword> <option> [--] <data>
K
Karel Zak 已提交
107 108 109 110 111
 *
 *    option          =     <bool_option> | <int_option> | <string_option>
 *    data            =     <string>
 *
 *    bool_option     =     --optionname
E
Eric Blake 已提交
112 113
 *    int_option      =     --optionname <number> | --optionname=<number>
 *    string_option   =     --optionname <string> | --optionname=<string>
114
 *
E
Eric Blake 已提交
115
 *    keyword         =     [a-zA-Z][a-zA-Z-]*
116
 *    number          =     [0-9]+
E
Eric Blake 已提交
117
 *    string          =     ('[^']*'|"([^\\"]|\\.)*"|([^ \t\n\\'"]|\\.))+
K
Karel Zak 已提交
118 119 120 121
 *
 */

/*
122
 * vshCmdOptType - command option type
123
 */
K
Karel Zak 已提交
124
typedef enum {
125 126 127
    VSH_OT_BOOL,     /* optional boolean option */
    VSH_OT_STRING,   /* optional string option */
    VSH_OT_INT,      /* optional or mandatory int option */
128 129
    VSH_OT_DATA,     /* string data (as non-option) */
    VSH_OT_ARGV      /* remaining arguments, opt->name should be "" */
K
Karel Zak 已提交
130 131
} vshCmdOptType;

132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
/*
 * Command group types
 */
#define VSH_CMD_GRP_DOM_MANAGEMENT   "Domain Management"
#define VSH_CMD_GRP_DOM_MONITORING   "Domain Monitoring"
#define VSH_CMD_GRP_STORAGE_POOL     "Storage Pool"
#define VSH_CMD_GRP_STORAGE_VOL      "Storage Volume"
#define VSH_CMD_GRP_NETWORK          "Networking"
#define VSH_CMD_GRP_NODEDEV          "Node Device"
#define VSH_CMD_GRP_IFACE            "Interface"
#define VSH_CMD_GRP_NWFILTER         "Network Filter"
#define VSH_CMD_GRP_SECRET           "Secret"
#define VSH_CMD_GRP_SNAPSHOT         "Snapshot"
#define VSH_CMD_GRP_HOST_AND_HV      "Host and Hypervisor"
#define VSH_CMD_GRP_VIRSH            "Virsh itself"

K
Karel Zak 已提交
148 149 150
/*
 * Command Option Flags
 */
E
Eric Blake 已提交
151 152 153 154 155
enum {
    VSH_OFLAG_NONE     = 0,        /* without flags */
    VSH_OFLAG_REQ      = (1 << 0), /* option required */
    VSH_OFLAG_EMPTY_OK = (1 << 1), /* empty string option allowed */
};
K
Karel Zak 已提交
156 157 158 159 160 161 162 163

/* dummy */
typedef struct __vshControl vshControl;
typedef struct __vshCmd vshCmd;

/*
 * vshCmdInfo -- information about command
 */
164 165 166
typedef struct {
    const char *name;           /* name of information */
    const char *data;           /* information */
K
Karel Zak 已提交
167 168 169 170 171
} vshCmdInfo;

/*
 * vshCmdOptDef - command option definition
 */
172 173 174 175 176
typedef struct {
    const char *name;           /* the name of option */
    vshCmdOptType type;         /* option type */
    int flag;                   /* flags */
    const char *help;           /* help string */
K
Karel Zak 已提交
177 178 179 180 181 182
} vshCmdOptDef;

/*
 * vshCmdOpt - command options
 */
typedef struct vshCmdOpt {
183
    const vshCmdOptDef *def;    /* pointer to relevant option */
184 185
    char *data;                 /* allocated data */
    struct vshCmdOpt *next;
K
Karel Zak 已提交
186 187
} vshCmdOpt;

188 189 190 191 192 193 194
/*
 * Command Usage Flags
 */
enum {
    VSH_CMD_FLAG_NOCONNECT = (1 << 0),  /* no prior connection needed */
};

K
Karel Zak 已提交
195 196 197
/*
 * vshCmdDef - command definition
 */
198 199
typedef struct {
    const char *name;
E
Eric Blake 已提交
200
    bool (*handler) (vshControl *, const vshCmd *);    /* command handler */
201 202
    const vshCmdOptDef *opts;   /* definition of command options */
    const vshCmdInfo *info;     /* details about command */
203
    int flags;                  /* bitwise OR of VSH_CMD_FLAG */
K
Karel Zak 已提交
204 205 206 207 208 209
} vshCmdDef;

/*
 * vshCmd - parsed command
 */
typedef struct __vshCmd {
210
    const vshCmdDef *def;       /* command definition */
211 212
    vshCmdOpt *opts;            /* list of command arguments */
    struct __vshCmd *next;      /* next command */
K
Karel Zak 已提交
213 214 215 216 217 218
} __vshCmd;

/*
 * vshControl
 */
typedef struct __vshControl {
K
Karel Zak 已提交
219
    char *name;                 /* connection name */
220
    virConnectPtr conn;         /* connection to hypervisor (MAY BE NULL) */
221 222
    vshCmd *cmd;                /* the current command */
    char *cmdstr;               /* string with command */
E
Eric Blake 已提交
223 224
    bool imode;                 /* interactive mode? */
    bool quiet;                 /* quiet mode */
225
    int debug;                  /* print debug messages? */
E
Eric Blake 已提交
226 227
    bool timing;                /* print timing info? */
    bool readonly;              /* connect readonly (first time only, not
228 229
                                 * during explicit connect command)
                                 */
230 231
    char *logfile;              /* log file name */
    int log_fd;                 /* log file descriptor */
232 233
    char *historydir;           /* readline history directory name */
    char *historyfile;          /* readline history file name */
234 235
    bool useGetInfo;            /* must use virDomainGetInfo, since
                                   virDomainGetState is not supported */
K
Karel Zak 已提交
236
} __vshControl;
237

238 239 240 241 242
typedef struct vshCmdGrp {
    const char *name;
    const char *keyword; /* help keyword */
    const vshCmdDef *commands;
} vshCmdGrp;
243

244
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
245

246 247
static void vshError(vshControl *ctl, const char *format, ...)
    ATTRIBUTE_FMT_PRINTF(2, 3);
E
Eric Blake 已提交
248 249
static bool vshInit(vshControl *ctl);
static bool vshDeinit(vshControl *ctl);
250
static void vshUsage(void);
251
static void vshOpenLogFile(vshControl *ctl);
252 253
static void vshOutputLogFile(vshControl *ctl, int log_level, const char *format, va_list ap)
    ATTRIBUTE_FMT_PRINTF(3, 0);
254
static void vshCloseLogFile(vshControl *ctl);
K
Karel Zak 已提交
255

E
Eric Blake 已提交
256
static bool vshParseArgv(vshControl *ctl, int argc, char **argv);
K
Karel Zak 已提交
257

258
static const char *vshCmddefGetInfo(const vshCmdDef *cmd, const char *info);
259
static const vshCmdDef *vshCmddefSearch(const char *cmdname);
E
Eric Blake 已提交
260
static bool vshCmddefHelp(vshControl *ctl, const char *name);
261
static const vshCmdGrp *vshCmdGrpSearch(const char *grpname);
E
Eric Blake 已提交
262
static bool vshCmdGrpHelp(vshControl *ctl, const char *name);
K
Karel Zak 已提交
263

264
static vshCmdOpt *vshCommandOpt(const vshCmd *cmd, const char *name);
265 266 267 268 269 270 271 272 273 274 275
static int vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
static int vshCommandOptUL(const vshCmd *cmd, const char *name,
                           unsigned long *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
static int vshCommandOptString(const vshCmd *cmd, const char *name,
                               const char **value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
static int vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                                 long long *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
276 277 278
static int vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                                  unsigned long long *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
E
Eric Blake 已提交
279
static bool vshCommandOptBool(const vshCmd *cmd, const char *name);
280
static char *vshCommandOptArgv(const vshCmd *cmd, int count);
K
Karel Zak 已提交
281

282 283 284
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
285
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
286

287
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
288
                                          const char **name, int flag);
K
Karel Zak 已提交
289 290

/* default is lookup by Id, Name and UUID */
J
Jim Meyering 已提交
291 292
#define vshCommandOptDomain(_ctl, _cmd, _name)                      \
    vshCommandOptDomainBy(_ctl, _cmd, _name, VSH_BYID|VSH_BYUUID|VSH_BYNAME)
293

294
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
295
                                            const char **name, int flag);
296 297

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
298 299
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
300 301
                           VSH_BYUUID|VSH_BYNAME)

302
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
303
                                                  const char **name, int flag);
304 305 306 307 308 309

/* default is lookup by Name and UUID */
#define vshCommandOptNWFilter(_ctl, _cmd, _name)                    \
    vshCommandOptNWFilterBy(_ctl, _cmd, _name,                      \
                            VSH_BYUUID|VSH_BYNAME)

310
static virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
311
                                                const char **name, int flag);
312 313 314 315 316 317

/* default is lookup by Name and MAC */
#define vshCommandOptInterface(_ctl, _cmd, _name)                    \
    vshCommandOptInterfaceBy(_ctl, _cmd, _name,                      \
                           VSH_BYMAC|VSH_BYNAME)

318
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
319
                            const char *optname, const char **name, int flag);
320 321 322 323 324 325

/* default is lookup by Name and UUID */
#define vshCommandOptPool(_ctl, _cmd, _optname, _name)           \
    vshCommandOptPoolBy(_ctl, _cmd, _optname, _name,             \
                           VSH_BYUUID|VSH_BYNAME)

326
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
327 328
                                           const char *optname,
                                           const char *pooloptname,
329
                                           const char **name, int flag);
330 331

/* default is lookup by Name and UUID */
332
#define vshCommandOptVol(_ctl, _cmd, _optname, _pooloptname, _name)   \
333 334 335
    vshCommandOptVolBy(_ctl, _cmd, _optname, _pooloptname, _name,     \
                           VSH_BYUUID|VSH_BYNAME)

336
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
337
                                        const char **name);
338

339
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
340
    ATTRIBUTE_FMT_PRINTF(2, 3);
341
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
342
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
343 344

/* XXX: add batch support */
345
#define vshPrint(_ctl, ...)   vshPrintExtra(NULL, __VA_ARGS__)
K
Karel Zak 已提交
346

347
static int vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason);
K
Karel Zak 已提交
348
static const char *vshDomainStateToString(int state);
349
static const char *vshDomainStateReasonToString(int state, int reason);
350
static const char *vshDomainVcpuStateToString(int state);
E
Eric Blake 已提交
351
static bool vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
K
Karel Zak 已提交
352

353 354 355 356
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

357
static void *_vshMalloc(vshControl *ctl, size_t sz, const char *filename, int line);
358 359
#define vshMalloc(_ctl, _sz)    _vshMalloc(_ctl, _sz, __FILE__, __LINE__)

360
static void *_vshCalloc(vshControl *ctl, size_t nmemb, size_t sz, const char *filename, int line);
361 362
#define vshCalloc(_ctl, _nmemb, _sz)    _vshCalloc(_ctl, _nmemb, _sz, __FILE__, __LINE__)

363
static void *_vshRealloc(vshControl *ctl, void *ptr, size_t sz, const char *filename, int line);
364 365
#define vshRealloc(_ctl, _ptr, _sz)    _vshRealloc(_ctl, _ptr, _sz, __FILE__, __LINE__)

366
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
367 368
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
static void *
_vshMalloc(vshControl *ctl, size_t size, const char *filename, int line)
{
    void *x;

    if ((x = malloc(size)))
        return x;
    vshError(ctl, _("%s: %d: failed to allocate %d bytes"),
             filename, line, (int) size);
    exit(EXIT_FAILURE);
}

static void *
_vshCalloc(vshControl *ctl, size_t nmemb, size_t size, const char *filename, int line)
{
    void *x;

    if ((x = calloc(nmemb, size)))
        return x;
    vshError(ctl, _("%s: %d: failed to allocate %d bytes"),
             filename, line, (int) (size*nmemb));
    exit(EXIT_FAILURE);
}

static void *
_vshRealloc(vshControl *ctl, void *ptr, size_t size, const char *filename, int line)
{
    void *x;

    if ((x = realloc(ptr, size)))
        return x;
    VIR_FREE(ptr);
    vshError(ctl, _("%s: %d: failed to allocate %d bytes"),
             filename, line, (int) size);
    exit(EXIT_FAILURE);
}

static char *
_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line)
{
    char *x;

    if (s == NULL)
        return(NULL);
    if ((x = strdup(s)))
        return x;
    vshError(ctl, _("%s: %d: failed to allocate %lu bytes"),
             filename, line, (unsigned long)strlen(s));
    exit(EXIT_FAILURE);
}

/* Poison the raw allocating identifiers in favor of our vsh variants.  */
#undef malloc
#undef calloc
#undef realloc
#undef strdup
#define malloc use_vshMalloc_instead_of_malloc
#define calloc use_vshCalloc_instead_of_calloc
#define realloc use_vshRealloc_instead_of_realloc
#define strdup use_vshStrdup_instead_of_strdup
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443

static int idsorter(const void *a, const void *b) {
  const int *ia = (const int *)a;
  const int *ib = (const int *)b;

  if (*ia > *ib)
    return 1;
  else if (*ia < *ib)
    return -1;
  return 0;
}
static int namesorter(const void *a, const void *b) {
  const char **sa = (const char**)a;
  const char **sb = (const char**)b;

444
  /* User visible sort, so we want locale-specific case comparison.  */
445 446 447
  return strcasecmp(*sa, *sb);
}

448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
static double
prettyCapacity(unsigned long long val,
               const char **unit) {
    if (val < 1024) {
        *unit = "";
        return (double)val;
    } else if (val < (1024.0l * 1024.0l)) {
        *unit = "KB";
        return (((double)val / 1024.0l));
    } else if (val < (1024.0l * 1024.0l * 1024.0l)) {
        *unit = "MB";
        return ((double)val / (1024.0l * 1024.0l));
    } else if (val < (1024.0l * 1024.0l * 1024.0l * 1024.0l)) {
        *unit = "GB";
        return ((double)val / (1024.0l * 1024.0l * 1024.0l));
    } else {
        *unit = "TB";
        return ((double)val / (1024.0l * 1024.0l * 1024.0l * 1024.0l));
    }
}


J
John Levon 已提交
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
static virErrorPtr last_error;

/*
 * Quieten libvirt until we're done with the command.
 */
static void
virshErrorHandler(void *unused ATTRIBUTE_UNUSED, virErrorPtr error)
{
    virFreeError(last_error);
    last_error = virSaveLastError();
    if (getenv("VIRSH_DEBUG") != NULL)
        virDefaultErrorFunc(error);
}

/*
 * Report an error when a command finishes.  This is better than before
 * (when correct operation would report errors), but it has some
 * problems: we lose the smarter formatting of virDefaultErrorFunc(),
 * and it can become harder to debug problems, if errors get reported
 * twice during one command.  This case shouldn't really happen anyway,
 * and it's IMHO a bug that libvirt does that sometimes.
 */
static void
virshReportError(vshControl *ctl)
{
495 496 497 498 499 500 501 502
    if (last_error == NULL) {
        /* Calling directly into libvirt util functions won't trigger the
         * error callback (which sets last_error), so check it ourselves.
         *
         * If the returned error has CODE_OK, this most likely means that
         * no error was ever raised, so just ignore */
        last_error = virSaveLastError();
        if (!last_error || last_error->code == VIR_ERR_OK)
503
            goto out;
504
    }
J
John Levon 已提交
505 506

    if (last_error->code == VIR_ERR_OK) {
507
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
508 509 510
        goto out;
    }

511
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
512 513 514 515 516 517

out:
    virFreeError(last_error);
    last_error = NULL;
}

518 519 520 521 522 523 524 525 526
static volatile sig_atomic_t intCaught = 0;

static void vshCatchInt(int sig ATTRIBUTE_UNUSED,
                        siginfo_t *siginfo ATTRIBUTE_UNUSED,
                        void *context ATTRIBUTE_UNUSED)
{
    intCaught = 1;
}

527 528 529 530 531
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

532 533 534 535 536
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

537 538 539 540 541 542
/*
 * vshCatchDisconnect:
 *
 * We get here when a SIGPIPE is being raised, we can't do much in the
 * handler, just save the fact it was raised
 */
543 544 545 546
static void vshCatchDisconnect(int sig, siginfo_t *siginfo,
                               void *context ATTRIBUTE_UNUSED) {
    if ((sig == SIGPIPE) ||
        (SA_SIGINFO && siginfo->si_signo == SIGPIPE))
547 548 549 550 551 552 553 554 555
        disconnected++;
}

/*
 * vshSetupSignals:
 *
 * Catch SIGPIPE signals which may arise when disconnection
 * from libvirtd occurs
 */
L
Laine Stump 已提交
556
static void
557 558 559 560 561 562 563 564 565 566 567 568 569
vshSetupSignals(void) {
    struct sigaction sig_action;

    sig_action.sa_sigaction = vshCatchDisconnect;
    sig_action.sa_flags = SA_SIGINFO;
    sigemptyset(&sig_action.sa_mask);

    sigaction(SIGPIPE, &sig_action, NULL);
}

/*
 * vshReconnect:
 *
L
Laine Stump 已提交
570
 * Reconnect after a disconnect from libvirtd
571 572
 *
 */
L
Laine Stump 已提交
573
static void
574 575 576 577 578 579
vshReconnect(vshControl *ctl)
{
    bool connected = false;

    if (ctl->conn != NULL) {
        connected = true;
580
        virConnectClose(ctl->conn);
581
    }
582 583 584 585 586 587

    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);
    if (!ctl->conn)
        vshError(ctl, "%s", _("Failed to reconnect to the hypervisor"));
588
    else if (connected)
589 590
        vshError(ctl, "%s", _("Reconnected to the hypervisor"));
    disconnected = 0;
591
    ctl->useGetInfo = false;
592
}
593

K
Karel Zak 已提交
594 595 596 597 598 599
/* ---------------
 * Commands
 * ---------------
 */

/*
600
 * "help" command
K
Karel Zak 已提交
601
 */
602
static const vshCmdInfo info_help[] = {
603
    {"help", N_("print help")},
604 605
    {"desc", N_("Prints global help, command specific help, or help for a\n"
                "    group of related commands")},
606

607
    {NULL, NULL}
K
Karel Zak 已提交
608 609
};

610
static const vshCmdOptDef opts_help[] = {
611
    {"command", VSH_OT_DATA, 0, N_("Prints global help, command specific help, or help for a group of related commands")},
612
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
613 614
};

E
Eric Blake 已提交
615
static bool
616
cmdHelp(vshControl *ctl, const vshCmd *cmd)
617
 {
618
    const char *name = NULL;
619

620
    if (vshCommandOptString(cmd, "command", &name) <= 0) {
621
        const vshCmdGrp *grp;
622
        const vshCmdDef *def;
623

624 625 626 627 628 629 630 631 632 633 634 635 636
        vshPrint(ctl, "%s", _("Grouped commands:\n\n"));

        for (grp = cmdGroups; grp->name; grp++) {
            vshPrint(ctl, _(" %s (help keyword '%s'):\n"), grp->name,
                     grp->keyword);

            for (def = grp->commands; def->name; def++)
                vshPrint(ctl, "    %-30s %s\n", def->name,
                         _(vshCmddefGetInfo(def, "help")));

            vshPrint(ctl, "\n");
        }

E
Eric Blake 已提交
637
        return true;
638
    }
639

E
Eric Blake 已提交
640
    if (vshCmddefSearch(name)) {
641
        return vshCmddefHelp(ctl, name);
E
Eric Blake 已提交
642
    } else if (vshCmdGrpSearch(name)) {
643 644 645
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
E
Eric Blake 已提交
646
        return false;
K
Karel Zak 已提交
647 648 649
    }
}

650 651 652
/*
 * "autostart" command
 */
653
static const vshCmdInfo info_autostart[] = {
654
    {"help", N_("autostart a domain")},
655
    {"desc",
656
     N_("Configure a domain to be automatically started at boot.")},
657 658 659
    {NULL, NULL}
};

660
static const vshCmdOptDef opts_autostart[] = {
661 662
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
663 664 665
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
666
static bool
667
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
668 669
{
    virDomainPtr dom;
670
    const char *name;
671 672
    int autostart;

673
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
674
        return false;
675

J
Jim Meyering 已提交
676
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
677
        return false;
678 679 680 681

    autostart = !vshCommandOptBool(cmd, "disable");

    if (virDomainSetAutostart(dom, autostart) < 0) {
682
        if (autostart)
683
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
684
        else
685
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
686
        virDomainFree(dom);
E
Eric Blake 已提交
687
        return false;
688 689
    }

690
    if (autostart)
691
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
692
    else
693
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
694

695
    virDomainFree(dom);
E
Eric Blake 已提交
696
    return true;
697 698
}

K
Karel Zak 已提交
699
/*
700
 * "connect" command
K
Karel Zak 已提交
701
 */
702
static const vshCmdInfo info_connect[] = {
703
    {"help", N_("(re)connect to hypervisor")},
704
    {"desc",
705
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
706
    {NULL, NULL}
K
Karel Zak 已提交
707 708
};

709
static const vshCmdOptDef opts_connect[] = {
E
Eric Blake 已提交
710 711
    {"name",     VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("hypervisor connection URI")},
712
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
713
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
714 715
};

E
Eric Blake 已提交
716
static bool
717
cmdConnect(vshControl *ctl, const vshCmd *cmd)
718
{
E
Eric Blake 已提交
719
    bool ro = vshCommandOptBool(cmd, "readonly");
720
    const char *name = NULL;
721

K
Karel Zak 已提交
722
    if (ctl->conn) {
723 724 725
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
E
Eric Blake 已提交
726
            return false;
K
Karel Zak 已提交
727 728 729
        }
        ctl->conn = NULL;
    }
730

731
    VIR_FREE(ctl->name);
732 733
    if (vshCommandOptString(cmd, "name", &name) < 0) {
        vshError(ctl, "%s", _("Please specify valid connection URI"));
E
Eric Blake 已提交
734
        return false;
735
    }
736
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
737

738
    ctl->useGetInfo = false;
E
Eric Blake 已提交
739
    ctl->readonly = ro;
K
Karel Zak 已提交
740

741 742 743
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

K
Karel Zak 已提交
744
    if (!ctl->conn)
745
        vshError(ctl, "%s", _("Failed to connect to the hypervisor"));
746

E
Eric Blake 已提交
747
    return !!ctl->conn;
K
Karel Zak 已提交
748 749
}

750 751
#ifndef WIN32

752
/*
753
 * "console" command
754
 */
755
static const vshCmdInfo info_console[] = {
756
    {"help", N_("connect to the guest console")},
757
    {"desc",
758
     N_("Connect the virtual serial console for the guest")},
759 760 761
    {NULL, NULL}
};

762
static const vshCmdOptDef opts_console[] = {
763
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
764
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
765 766 767
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
768
static bool
769
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
770
{
E
Eric Blake 已提交
771
    bool ret = false;
772
    int state;
773

774
    if ((state = vshDomainState(ctl, dom, NULL)) < 0) {
775 776 777 778
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

779
    if (state == VIR_DOMAIN_SHUTOFF) {
780 781 782 783
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

784 785
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
    vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
786
    if (vshRunConsole(dom, name) == 0)
E
Eric Blake 已提交
787
        ret = true;
788 789

 cleanup:
790

791 792 793
    return ret;
}

E
Eric Blake 已提交
794
static bool
795 796 797
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
798
    bool ret = false;
799
    const char *name = NULL;
800

801
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
802
        return false;
803 804

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
805
        return false;
806

807 808 809 810
    if (vshCommandOptString(cmd, "devname", &name) < 0) {
        vshError(ctl, "%s", _("Invalid devname"));
        goto cleanup;
    }
811

812
    ret = cmdRunConsole(ctl, dom, name);
813

814
cleanup:
815 816 817 818
    virDomainFree(dom);
    return ret;
}

819 820 821
#endif /* WIN32 */


K
Karel Zak 已提交
822 823 824
/*
 * "list" command
 */
825
static const vshCmdInfo info_list[] = {
826 827
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
828
    {NULL, NULL}
K
Karel Zak 已提交
829 830
};

831
static const vshCmdOptDef opts_list[] = {
832 833
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
834 835 836
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
837

E
Eric Blake 已提交
838
static bool
839
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
840
{
841 842 843 844
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
845
    char **names = NULL;
846 847
    int maxname = 0;
    inactive |= all;
K
Karel Zak 已提交
848

849
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
850
        return false;
851

852
    if (active) {
853 854
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
855
            vshError(ctl, "%s", _("Failed to list active domains"));
E
Eric Blake 已提交
856
            return false;
857 858 859 860 861
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
862
                vshError(ctl, "%s", _("Failed to list active domains"));
863
                VIR_FREE(ids);
E
Eric Blake 已提交
864
                return false;
865 866
            }

867
            qsort(&ids[0], maxid, sizeof(int), idsorter);
868
        }
869 870
    }
    if (inactive) {
871 872
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
873
            vshError(ctl, "%s", _("Failed to list inactive domains"));
874
            VIR_FREE(ids);
E
Eric Blake 已提交
875
            return false;
876
        }
877 878 879 880
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
881
                vshError(ctl, "%s", _("Failed to list inactive domains"));
882 883
                VIR_FREE(ids);
                VIR_FREE(names);
E
Eric Blake 已提交
884
                return false;
885
            }
886

887
            qsort(&names[0], maxname, sizeof(char*), namesorter);
888
        }
889
    }
890
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
891
    vshPrintExtra(ctl, "----------------------------------\n");
892 893

    for (i = 0; i < maxid; i++) {
K
Karel Zak 已提交
894
        virDomainPtr dom = virDomainLookupByID(ctl->conn, ids[i]);
895 896

        /* this kind of work with domains is not atomic operation */
K
Karel Zak 已提交
897 898
        if (!dom)
            continue;
899

K
Karel Zak 已提交
900
        vshPrint(ctl, "%3d %-20s %s\n",
901 902
                 virDomainGetID(dom),
                 virDomainGetName(dom),
903
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
904
        virDomainFree(dom);
K
Karel Zak 已提交
905
    }
906 907 908 909
    for (i = 0; i < maxname; i++) {
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);

        /* this kind of work with domains is not atomic operation */
910
        if (!dom) {
911
            VIR_FREE(names[i]);
912
            continue;
913
        }
914

915 916 917 918
        vshPrint(ctl, "%3s %-20s %s\n",
                 "-",
                 names[i],
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
919

920
        virDomainFree(dom);
921
        VIR_FREE(names[i]);
922
    }
923 924
    VIR_FREE(ids);
    VIR_FREE(names);
E
Eric Blake 已提交
925
    return true;
K
Karel Zak 已提交
926 927 928
}

/*
K
Karel Zak 已提交
929
 * "domstate" command
K
Karel Zak 已提交
930
 */
931
static const vshCmdInfo info_domstate[] = {
932 933
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
934
    {NULL, NULL}
K
Karel Zak 已提交
935 936
};

937
static const vshCmdOptDef opts_domstate[] = {
938
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
939
    {"reason", VSH_OT_BOOL, 0, N_("also print reason for the state")},
940
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
941 942
};

E
Eric Blake 已提交
943
static bool
944
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
945
{
K
Karel Zak 已提交
946
    virDomainPtr dom;
E
Eric Blake 已提交
947
    bool ret = true;
948 949
    int showReason = vshCommandOptBool(cmd, "reason");
    int state, reason;
950

951
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
952
        return false;
953

J
Jim Meyering 已提交
954
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
955
        return false;
956

957
    if ((state = vshDomainState(ctl, dom, &reason)) < 0) {
E
Eric Blake 已提交
958
        ret = false;
959 960 961 962 963 964 965 966 967 968 969
        goto cleanup;
    }

    if (showReason) {
        vshPrint(ctl, "%s (%s)\n",
                 _(vshDomainStateToString(state)),
                 vshDomainStateReasonToString(state, reason));
    } else {
        vshPrint(ctl, "%s\n",
                 _(vshDomainStateToString(state)));
    }
970

971
cleanup:
972 973 974 975
    virDomainFree(dom);
    return ret;
}

976 977
/* "domblkstat" command
 */
978
static const vshCmdInfo info_domblkstat[] = {
979 980
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
981 982 983
    {NULL,NULL}
};

984
static const vshCmdOptDef opts_domblkstat[] = {
985 986
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
987 988 989
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
990
static bool
991
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
992 993
{
    virDomainPtr dom;
994
    const char *name = NULL, *device = NULL;
995 996
    struct _virDomainBlockStats stats;

997
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
998
        return false;
999

J
Jim Meyering 已提交
1000
    if (!(dom = vshCommandOptDomain (ctl, cmd, &name)))
E
Eric Blake 已提交
1001
        return false;
1002

1003
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
L
Laine Stump 已提交
1004
        virDomainFree(dom);
E
Eric Blake 已提交
1005
        return false;
L
Laine Stump 已提交
1006
    }
1007 1008

    if (virDomainBlockStats (dom, device, &stats, sizeof stats) == -1) {
1009
        vshError(ctl, _("Failed to get block stats %s %s"), name, device);
1010
        virDomainFree(dom);
E
Eric Blake 已提交
1011
        return false;
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
    }

    if (stats.rd_req >= 0)
        vshPrint (ctl, "%s rd_req %lld\n", device, stats.rd_req);

    if (stats.rd_bytes >= 0)
        vshPrint (ctl, "%s rd_bytes %lld\n", device, stats.rd_bytes);

    if (stats.wr_req >= 0)
        vshPrint (ctl, "%s wr_req %lld\n", device, stats.wr_req);

    if (stats.wr_bytes >= 0)
        vshPrint (ctl, "%s wr_bytes %lld\n", device, stats.wr_bytes);

    if (stats.errs >= 0)
        vshPrint (ctl, "%s errs %lld\n", device, stats.errs);

    virDomainFree(dom);
E
Eric Blake 已提交
1030
    return true;
1031 1032 1033 1034
}

/* "domifstat" command
 */
1035
static const vshCmdInfo info_domifstat[] = {
1036 1037
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1038 1039 1040
    {NULL,NULL}
};

1041
static const vshCmdOptDef opts_domifstat[] = {
1042 1043
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1044 1045 1046
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1047
static bool
1048
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1049 1050
{
    virDomainPtr dom;
1051
    const char *name = NULL, *device = NULL;
1052 1053
    struct _virDomainInterfaceStats stats;

1054
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1055
        return false;
1056

J
Jim Meyering 已提交
1057
    if (!(dom = vshCommandOptDomain (ctl, cmd, &name)))
E
Eric Blake 已提交
1058
        return false;
1059

1060
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1061
        virDomainFree(dom);
E
Eric Blake 已提交
1062
        return false;
L
Laine Stump 已提交
1063
    }
1064 1065

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1066
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1067
        virDomainFree(dom);
E
Eric Blake 已提交
1068
        return false;
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
    }

    if (stats.rx_bytes >= 0)
        vshPrint (ctl, "%s rx_bytes %lld\n", device, stats.rx_bytes);

    if (stats.rx_packets >= 0)
        vshPrint (ctl, "%s rx_packets %lld\n", device, stats.rx_packets);

    if (stats.rx_errs >= 0)
        vshPrint (ctl, "%s rx_errs %lld\n", device, stats.rx_errs);

    if (stats.rx_drop >= 0)
        vshPrint (ctl, "%s rx_drop %lld\n", device, stats.rx_drop);

    if (stats.tx_bytes >= 0)
        vshPrint (ctl, "%s tx_bytes %lld\n", device, stats.tx_bytes);

    if (stats.tx_packets >= 0)
        vshPrint (ctl, "%s tx_packets %lld\n", device, stats.tx_packets);

    if (stats.tx_errs >= 0)
        vshPrint (ctl, "%s tx_errs %lld\n", device, stats.tx_errs);

    if (stats.tx_drop >= 0)
        vshPrint (ctl, "%s tx_drop %lld\n", device, stats.tx_drop);

    virDomainFree(dom);
E
Eric Blake 已提交
1096
    return true;
1097 1098
}

1099 1100 1101
/*
 * "dommemstats" command
 */
1102
static const vshCmdInfo info_dommemstat[] = {
1103 1104
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1105 1106 1107
    {NULL,NULL}
};

1108
static const vshCmdOptDef opts_dommemstat[] = {
1109
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1110 1111 1112
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1113
static bool
1114
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1115 1116
{
    virDomainPtr dom;
1117
    const char *name;
1118 1119 1120
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1121
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1122
        return false;
1123 1124

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1125
        return false;
1126 1127 1128 1129 1130

    nr_stats = virDomainMemoryStats (dom, stats, VIR_DOMAIN_MEMORY_STAT_NR, 0);
    if (nr_stats == -1) {
        vshError(ctl, _("Failed to get memory statistics for domain %s"), name);
        virDomainFree(dom);
E
Eric Blake 已提交
1131
        return false;
1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149
    }

    for (i = 0; i < nr_stats; i++) {
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_SWAP_IN)
            vshPrint (ctl, "swap_in %llu\n", stats[i].val);
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_SWAP_OUT)
            vshPrint (ctl, "swap_out %llu\n", stats[i].val);
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_MAJOR_FAULT)
            vshPrint (ctl, "major_fault %llu\n", stats[i].val);
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_MINOR_FAULT)
            vshPrint (ctl, "minor_fault %llu\n", stats[i].val);
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_UNUSED)
            vshPrint (ctl, "unused %llu\n", stats[i].val);
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_AVAILABLE)
            vshPrint (ctl, "available %llu\n", stats[i].val);
    }

    virDomainFree(dom);
E
Eric Blake 已提交
1150
    return true;
1151 1152
}

1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167
/*
 * "domblkinfo" command
 */
static const vshCmdInfo info_domblkinfo[] = {
    {"help", N_("domain block device size information")},
    {"desc", N_("Get block device size info for a domain.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_domblkinfo[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1168
static bool
1169 1170 1171 1172
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1173
    bool ret = true;
1174
    const char *device = NULL;
1175

1176
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1177
        return false;
1178 1179

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
1180
        return false;
1181

1182
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1183
        virDomainFree(dom);
E
Eric Blake 已提交
1184
        return false;
1185 1186 1187 1188
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1189
        return false;
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
    }

    vshPrint(ctl, "%-15s %llu\n", _("Capacity:"), info.capacity);
    vshPrint(ctl, "%-15s %llu\n", _("Allocation:"), info.allocation);
    vshPrint(ctl, "%-15s %llu\n", _("Physical:"), info.physical);

    virDomainFree(dom);
    return ret;
}

1200 1201 1202
/*
 * "suspend" command
 */
1203
static const vshCmdInfo info_suspend[] = {
1204 1205
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1206
    {NULL, NULL}
1207 1208
};

1209
static const vshCmdOptDef opts_suspend[] = {
1210
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1211
    {NULL, 0, 0, NULL}
1212 1213
};

E
Eric Blake 已提交
1214
static bool
1215
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1216
{
1217
    virDomainPtr dom;
1218
    const char *name;
E
Eric Blake 已提交
1219
    bool ret = true;
1220

1221
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1222
        return false;
1223

J
Jim Meyering 已提交
1224
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1225
        return false;
1226 1227

    if (virDomainSuspend(dom) == 0) {
1228
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1229
    } else {
1230
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1231
        ret = false;
1232
    }
1233

1234 1235 1236 1237
    virDomainFree(dom);
    return ret;
}

1238 1239 1240
/*
 * "create" command
 */
1241
static const vshCmdInfo info_create[] = {
1242 1243
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1244 1245 1246
    {NULL, NULL}
};

1247
static const vshCmdOptDef opts_create[] = {
1248
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1249
#ifndef WIN32
1250
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1251
#endif
1252
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1253 1254 1255
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1256
static bool
1257
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1258 1259
{
    virDomainPtr dom;
1260
    const char *from = NULL;
E
Eric Blake 已提交
1261
    bool ret = true;
1262
    char *buffer;
1263
#ifndef WIN32
1264
    int console = vshCommandOptBool(cmd, "console");
1265
#endif
1266
    unsigned int flags = VIR_DOMAIN_NONE;
1267

1268
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1269
        return false;
1270

1271
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1272
        return false;
1273

1274
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1275
        return false;
1276

1277 1278 1279 1280
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1281
    VIR_FREE(buffer);
1282

1283
    if (dom != NULL) {
1284
        vshPrint(ctl, _("Domain %s created from %s\n"),
1285
                 virDomainGetName(dom), from);
1286
#ifndef WIN32
1287
        if (console)
1288
            cmdRunConsole(ctl, dom, NULL);
1289
#endif
1290
        virDomainFree(dom);
1291
    } else {
1292
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1293
        ret = false;
1294 1295 1296 1297
    }
    return ret;
}

1298 1299 1300
/*
 * "define" command
 */
1301
static const vshCmdInfo info_define[] = {
1302 1303
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1304 1305 1306
    {NULL, NULL}
};

1307
static const vshCmdOptDef opts_define[] = {
1308
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1309 1310 1311
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1312
static bool
1313
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1314 1315
{
    virDomainPtr dom;
1316
    const char *from = NULL;
E
Eric Blake 已提交
1317
    bool ret = true;
1318
    char *buffer;
1319

1320
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1321
        return false;
1322

1323
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1324
        return false;
1325

1326
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1327
        return false;
1328 1329

    dom = virDomainDefineXML(ctl->conn, buffer);
1330
    VIR_FREE(buffer);
1331

1332
    if (dom != NULL) {
1333
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1334
                 virDomainGetName(dom), from);
1335
        virDomainFree(dom);
1336
    } else {
1337
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1338
        ret = false;
1339 1340 1341 1342 1343 1344 1345
    }
    return ret;
}

/*
 * "undefine" command
 */
1346
static const vshCmdInfo info_undefine[] = {
1347 1348
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1349 1350 1351
    {NULL, NULL}
};

1352
static const vshCmdOptDef opts_undefine[] = {
1353
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1354 1355 1356
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1357
static bool
1358
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1359 1360
{
    virDomainPtr dom;
E
Eric Blake 已提交
1361
    bool ret = true;
1362
    const char *name = NULL;
1363
    int id;
1364

1365
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1366
        return false;
1367

1368
    if (vshCommandOptString(cmd, "domain", &name) <= 0)
E
Eric Blake 已提交
1369
        return false;
1370 1371 1372

    if (name && virStrToLong_i(name, NULL, 10, &id) == 0
        && id >= 0 && (dom = virDomainLookupByID(ctl->conn, id))) {
1373 1374 1375 1376 1377
        vshError(ctl,
                 _("a running domain like %s cannot be undefined;\n"
                   "to undefine, first shutdown then undefine"
                   " using its name or UUID"),
                 name);
1378
        virDomainFree(dom);
E
Eric Blake 已提交
1379
        return false;
1380
    }
J
Jim Meyering 已提交
1381
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
1382
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
1383
        return false;
1384 1385

    if (virDomainUndefine(dom) == 0) {
1386
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1387
    } else {
1388
        vshError(ctl, _("Failed to undefine domain %s"), name);
E
Eric Blake 已提交
1389
        ret = false;
1390 1391
    }

1392
    virDomainFree(dom);
1393 1394 1395 1396 1397 1398 1399
    return ret;
}


/*
 * "start" command
 */
1400
static const vshCmdInfo info_start[] = {
1401
    {"help", N_("start a (previously defined) inactive domain")},
1402 1403 1404
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1405 1406 1407
    {NULL, NULL}
};

1408
static const vshCmdOptDef opts_start[] = {
1409
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1410
#ifndef WIN32
1411
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1412
#endif
E
Eric Blake 已提交
1413
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1414 1415 1416
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1417
static bool
1418
cmdStart(vshControl *ctl, const vshCmd *cmd)
1419 1420
{
    virDomainPtr dom;
E
Eric Blake 已提交
1421
    bool ret = true;
1422
#ifndef WIN32
1423
    int console = vshCommandOptBool(cmd, "console");
1424
#endif
E
Eric Blake 已提交
1425
    unsigned int flags = VIR_DOMAIN_NONE;
1426

1427
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1428
        return false;
1429

1430 1431
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
1432
        return false;
1433 1434

    if (virDomainGetID(dom) != (unsigned int)-1) {
1435
        vshError(ctl, "%s", _("Domain is already active"));
1436
        virDomainFree(dom);
E
Eric Blake 已提交
1437
        return false;
1438 1439
    }

E
Eric Blake 已提交
1440 1441 1442 1443 1444 1445
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;

    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
         : virDomainCreate(dom)) == 0) {
1446
        vshPrint(ctl, _("Domain %s started\n"),
1447
                 virDomainGetName(dom));
1448
#ifndef WIN32
1449
        if (console)
1450
            cmdRunConsole(ctl, dom, NULL);
1451
#endif
1452
    } else {
1453
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
E
Eric Blake 已提交
1454
        ret = false;
1455
    }
1456
    virDomainFree(dom);
1457 1458 1459
    return ret;
}

1460 1461 1462
/*
 * "save" command
 */
1463
static const vshCmdInfo info_save[] = {
1464 1465
    {"help", N_("save a domain state to a file")},
    {"desc", N_("Save a running domain.")},
1466
    {NULL, NULL}
1467 1468
};

1469
static const vshCmdOptDef opts_save[] = {
1470 1471
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("where to save the data")},
1472
    {NULL, 0, 0, NULL}
1473 1474
};

E
Eric Blake 已提交
1475
static bool
1476
cmdSave(vshControl *ctl, const vshCmd *cmd)
1477
{
1478
    virDomainPtr dom;
1479 1480
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1481
    bool ret = true;
1482

1483
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1484
        return false;
1485

1486
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1487
        return false;
1488

J
Jim Meyering 已提交
1489
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1490
        return false;
1491 1492

    if (virDomainSave(dom, to) == 0) {
1493
        vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
1494
    } else {
1495
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
E
Eric Blake 已提交
1496
        ret = false;
1497
    }
1498

1499 1500 1501 1502
    virDomainFree(dom);
    return ret;
}

1503 1504 1505 1506 1507
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1508 1509 1510 1511
    {"desc", N_("Save and destroy a running domain, so it can be restarted from\n"
                "    the same state at a later time.  When the virsh 'start'\n"
                "    command is next run for the domain, it will automatically\n"
                "    be started from this saved state.")},
1512 1513 1514 1515 1516 1517 1518 1519
    {NULL, NULL}
};

static const vshCmdOptDef opts_managedsave[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1520
static bool
1521 1522 1523
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1524
    const char *name;
E
Eric Blake 已提交
1525
    bool ret = true;
1526

1527
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1528
        return false;
1529 1530

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1531
        return false;
1532 1533 1534 1535 1536

    if (virDomainManagedSave(dom, 0) == 0) {
        vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    } else {
        vshError(ctl, _("Failed to save domain %s state"), name);
E
Eric Blake 已提交
1537
        ret = false;
1538 1539 1540 1541 1542 1543
    }

    virDomainFree(dom);
    return ret;
}

1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
/*
 * "managedsave-remove" command
 */
static const vshCmdInfo info_managedsaveremove[] = {
    {"help", N_("Remove managed save of a domain")},
    {"desc", N_("Remove an existing managed save state file from a domain")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_managedsaveremove[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1558
static bool
1559 1560 1561
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1562
    const char *name;
E
Eric Blake 已提交
1563
    bool ret = false;
1564 1565
    int hassave;

1566
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1567
        return false;
1568 1569

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1570
        return false;
1571 1572 1573

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1574
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590
        goto cleanup;
    }

    if (hassave) {
        if (virDomainManagedSaveRemove(dom, 0) < 0) {
            vshError(ctl, _("Failed to remove managed save image for domain %s"),
                     name);
            goto cleanup;
        }
        else
            vshPrint(ctl, _("Removed managedsave image for domain %s"), name);
    }
    else
        vshPrint(ctl, _("Domain %s has no manage save image; removal skipped"),
                 name);

E
Eric Blake 已提交
1591
    ret = true;
1592 1593 1594 1595 1596 1597

cleanup:
    virDomainFree(dom);
    return ret;
}

1598 1599 1600
/*
 * "schedinfo" command
 */
1601
static const vshCmdInfo info_schedinfo[] = {
1602 1603
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1604 1605 1606
    {NULL, NULL}
};

1607
static const vshCmdOptDef opts_schedinfo[] = {
1608 1609 1610 1611
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"set", VSH_OT_STRING, VSH_OFLAG_NONE, N_("parameter=value")},
    {"weight", VSH_OT_INT, VSH_OFLAG_NONE, N_("weight for XEN_CREDIT")},
    {"cap", VSH_OT_INT, VSH_OFLAG_NONE, N_("cap for XEN_CREDIT")},
1612 1613 1614
    {"current", VSH_OT_BOOL, 0, N_("get/set current scheduler info")},
    {"config", VSH_OT_BOOL, 0, N_("get/set value to be used on next boot")},
    {"live", VSH_OT_BOOL, 0, N_("get/set value from running domain")},
1615 1616 1617
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
1618
static int
1619
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
1620
                   virTypedParameterPtr param)
1621
{
1622
    const char *data = NULL;
1623 1624 1625

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
1626
        param->type == VIR_TYPED_PARAM_UINT &&
1627 1628
        vshCommandOptBool(cmd, "weight")) {
        int val;
1629
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
1630
            vshError(ctl, "%s", _("Invalid value of weight"));
1631
            return -1;
1632
        } else {
1633
            param->value.ui = val;
1634
        }
1635
        return 1;
1636 1637
    }

1638 1639
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
1640
        param->type == VIR_TYPED_PARAM_UINT &&
1641 1642
        vshCommandOptBool(cmd, "cap")) {
        int val;
1643
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
1644
            vshError(ctl, "%s", _("Invalid value of cap"));
1645
            return -1;
1646
        } else {
1647
            param->value.ui = val;
1648
        }
1649
        return 1;
1650
    }
1651

1652
    if (vshCommandOptString(cmd, "set", &data) > 0) {
1653 1654 1655
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
1656
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
1657
            return -1;
1658
        }
1659 1660 1661 1662 1663 1664 1665 1666 1667
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
1668
        case VIR_TYPED_PARAM_INT:
1669
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
1670
                vshError(ctl, "%s",
1671 1672 1673 1674
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
1675
        case VIR_TYPED_PARAM_UINT:
1676
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
1677
                vshError(ctl, "%s",
1678 1679 1680 1681
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
1682
        case VIR_TYPED_PARAM_LLONG:
1683
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
1684
                vshError(ctl, "%s",
J
Jim Meyering 已提交
1685
                         _("Invalid value for parameter, expecting a long long"));
1686 1687 1688
                return -1;
            }
            break;
1689
        case VIR_TYPED_PARAM_ULLONG:
1690
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
1691
                vshError(ctl, "%s",
1692 1693 1694 1695
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
1696
        case VIR_TYPED_PARAM_DOUBLE:
1697
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
1698
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
1699 1700 1701
                return -1;
            }
            break;
1702
        case VIR_TYPED_PARAM_BOOLEAN:
1703
            param->value.b = STREQ(val, "0") ? 0 : 1;
1704
        }
1705
        return 1;
1706
    }
1707

1708 1709
    return 0;
}
1710

1711

E
Eric Blake 已提交
1712
static bool
1713 1714 1715 1716
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
1717
    virTypedParameterPtr params = NULL;
1718 1719 1720
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
1721
    bool ret_val = false;
1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738
    unsigned int flags = 0;
    int current = vshCommandOptBool(cmd, "current");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
            return false;
        }
        flags = VIR_DOMAIN_SCHEDPARAM_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_SCHEDPARAM_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_SCHEDPARAM_LIVE;
    }
1739

1740
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1741
        return false;
1742

1743
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
1744
        return false;
1745 1746 1747

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
1748
    if (schedulertype != NULL) {
1749
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
1750
             schedulertype);
1751
        VIR_FREE(schedulertype);
1752
    } else {
1753
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
1754
        goto cleanup;
1755 1756
    }

1757
    if (nparams) {
1758
        params = vshMalloc(ctl, sizeof(*params) * nparams);
1759

1760
        memset(params, 0, sizeof(*params) * nparams);
1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771
        if (flags || current) {
            /* We cannot query both live and config at once, so settle
               on current in that case.  If we are setting, then the
               two values should match when we re-query; otherwise, we
               report the error later.  */
            ret = virDomainGetSchedulerParametersFlags(dom, params, &nparams,
                                                       ((live && config) ? 0
                                                        : flags));
        } else {
            ret = virDomainGetSchedulerParameters(dom, params, &nparams);
        }
1772 1773 1774 1775
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
1776
        for (i = 0; i < nparams; i++) {
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

            if (ret == 1)
                update = 1;
        }

        /* Update parameters & refresh data */
        if (update) {
1787 1788 1789 1790 1791
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
1792 1793 1794
            if (ret == -1)
                goto cleanup;

1795 1796 1797 1798 1799 1800 1801
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
1802 1803
            if (ret == -1)
                goto cleanup;
1804 1805 1806 1807
        } else {
            /* See if we've tried to --set var=val.  If so, the fact that
               we reach this point (with update == 0) means that "var" did
               not match any of the settable parameters.  Report the error.  */
1808 1809
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
1810 1811 1812 1813
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
1814 1815 1816 1817 1818 1819
            /* When not doing --set, --live and --config do not mix.  */
            if (live && config) {
                vshError(ctl, "%s",
                         _("cannot query both live and config at once"));
                goto cleanup;
            }
1820 1821
        }

E
Eric Blake 已提交
1822
        ret_val = true;
1823
        for (i = 0; i < nparams; i++) {
1824
            switch (params[i].type) {
1825
            case VIR_TYPED_PARAM_INT:
1826
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1827
                 break;
1828
            case VIR_TYPED_PARAM_UINT:
1829
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1830
                 break;
1831
            case VIR_TYPED_PARAM_LLONG:
1832
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1833
                 break;
1834
            case VIR_TYPED_PARAM_ULLONG:
1835
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1836
                 break;
1837
            case VIR_TYPED_PARAM_DOUBLE:
1838
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1839
                 break;
1840
            case VIR_TYPED_PARAM_BOOLEAN:
1841
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
1842 1843
                 break;
            default:
1844
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
1845 1846 1847
            }
        }
    }
1848

1849
 cleanup:
1850
    VIR_FREE(params);
1851
    virDomainFree(dom);
1852
    return ret_val;
1853 1854
}

1855 1856 1857
/*
 * "restore" command
 */
1858
static const vshCmdInfo info_restore[] = {
1859 1860
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
1861
    {NULL, NULL}
1862 1863
};

1864
static const vshCmdOptDef opts_restore[] = {
1865
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
1866
    {NULL, 0, 0, NULL}
1867 1868
};

E
Eric Blake 已提交
1869
static bool
1870
cmdRestore(vshControl *ctl, const vshCmd *cmd)
1871
{
1872
    const char *from = NULL;
E
Eric Blake 已提交
1873
    bool ret = true;
1874

1875
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1876
        return false;
1877

1878
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1879
        return false;
1880 1881

    if (virDomainRestore(ctl->conn, from) == 0) {
1882
        vshPrint(ctl, _("Domain restored from %s\n"), from);
1883
    } else {
1884
        vshError(ctl, _("Failed to restore domain from %s"), from);
E
Eric Blake 已提交
1885
        ret = false;
1886 1887 1888 1889
    }
    return ret;
}

D
Daniel Veillard 已提交
1890 1891 1892
/*
 * "dump" command
 */
1893
static const vshCmdInfo info_dump[] = {
1894 1895
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
1896 1897 1898
    {NULL, NULL}
};

1899
static const vshCmdOptDef opts_dump[] = {
1900 1901 1902 1903
    {"live", VSH_OT_BOOL, 0, N_("perform a live core dump if supported")},
    {"crash", VSH_OT_BOOL, 0, N_("crash the domain after core dump")},
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("where to dump the core")},
D
Daniel Veillard 已提交
1904 1905 1906
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1907
static bool
1908
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
1909 1910
{
    virDomainPtr dom;
1911 1912
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1913
    bool ret = true;
1914
    int flags = 0;
D
Daniel Veillard 已提交
1915

1916
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1917
        return false;
D
Daniel Veillard 已提交
1918

1919
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1920
        return false;
D
Daniel Veillard 已提交
1921

J
Jim Meyering 已提交
1922
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1923
        return false;
D
Daniel Veillard 已提交
1924

P
Paolo Bonzini 已提交
1925 1926
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
1927 1928 1929 1930
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;

    if (virDomainCoreDump(dom, to, flags) == 0) {
1931
        vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
D
Daniel Veillard 已提交
1932
    } else {
1933
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
E
Eric Blake 已提交
1934
        ret = false;
D
Daniel Veillard 已提交
1935 1936 1937 1938 1939 1940
    }

    virDomainFree(dom);
    return ret;
}

1941 1942 1943
/*
 * "resume" command
 */
1944
static const vshCmdInfo info_resume[] = {
1945 1946
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
1947
    {NULL, NULL}
1948 1949
};

1950
static const vshCmdOptDef opts_resume[] = {
1951
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1952
    {NULL, 0, 0, NULL}
1953 1954
};

E
Eric Blake 已提交
1955
static bool
1956
cmdResume(vshControl *ctl, const vshCmd *cmd)
1957
{
1958
    virDomainPtr dom;
E
Eric Blake 已提交
1959
    bool ret = true;
1960
    const char *name;
1961

1962
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1963
        return false;
1964

J
Jim Meyering 已提交
1965
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1966
        return false;
1967 1968

    if (virDomainResume(dom) == 0) {
1969
        vshPrint(ctl, _("Domain %s resumed\n"), name);
1970
    } else {
1971
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
1972
        ret = false;
1973
    }
1974

1975 1976 1977 1978
    virDomainFree(dom);
    return ret;
}

1979 1980 1981
/*
 * "shutdown" command
 */
1982
static const vshCmdInfo info_shutdown[] = {
1983 1984
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
1985
    {NULL, NULL}
1986 1987
};

1988
static const vshCmdOptDef opts_shutdown[] = {
1989
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1990
    {NULL, 0, 0, NULL}
1991 1992
};

E
Eric Blake 已提交
1993
static bool
1994
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
1995
{
1996
    virDomainPtr dom;
E
Eric Blake 已提交
1997
    bool ret = true;
1998
    const char *name;
1999

2000
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2001
        return false;
2002

J
Jim Meyering 已提交
2003
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2004
        return false;
2005 2006

    if (virDomainShutdown(dom) == 0) {
2007
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
2008
    } else {
2009
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
2010
        ret = false;
2011
    }
2012

2013 2014 2015 2016
    virDomainFree(dom);
    return ret;
}

2017 2018 2019
/*
 * "reboot" command
 */
2020
static const vshCmdInfo info_reboot[] = {
2021 2022
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
2023 2024 2025
    {NULL, NULL}
};

2026
static const vshCmdOptDef opts_reboot[] = {
2027
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2028 2029 2030
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2031
static bool
2032
cmdReboot(vshControl *ctl, const vshCmd *cmd)
2033 2034
{
    virDomainPtr dom;
E
Eric Blake 已提交
2035
    bool ret = true;
2036
    const char *name;
2037

2038
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2039
        return false;
2040

J
Jim Meyering 已提交
2041
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2042
        return false;
2043 2044

    if (virDomainReboot(dom, 0) == 0) {
2045
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
2046
    } else {
2047
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
2048
        ret = false;
2049 2050 2051 2052 2053 2054
    }

    virDomainFree(dom);
    return ret;
}

2055 2056 2057
/*
 * "destroy" command
 */
2058
static const vshCmdInfo info_destroy[] = {
2059 2060
    {"help", N_("destroy a domain")},
    {"desc", N_("Destroy a given domain.")},
2061
    {NULL, NULL}
2062 2063
};

2064
static const vshCmdOptDef opts_destroy[] = {
2065
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2066
    {NULL, 0, 0, NULL}
2067 2068
};

E
Eric Blake 已提交
2069
static bool
2070
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2071
{
2072
    virDomainPtr dom;
E
Eric Blake 已提交
2073
    bool ret = true;
2074
    const char *name;
2075

2076
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2077
        return false;
2078

J
Jim Meyering 已提交
2079
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2080
        return false;
2081 2082

    if (virDomainDestroy(dom) == 0) {
2083
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2084
    } else {
2085
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
2086
        ret = false;
2087
    }
2088

2089
    virDomainFree(dom);
K
Karel Zak 已提交
2090 2091 2092 2093
    return ret;
}

/*
2094
 * "dominfo" command
K
Karel Zak 已提交
2095
 */
2096
static const vshCmdInfo info_dominfo[] = {
2097 2098
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2099
    {NULL, NULL}
K
Karel Zak 已提交
2100 2101
};

2102
static const vshCmdOptDef opts_dominfo[] = {
2103
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2104
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2105 2106
};

E
Eric Blake 已提交
2107
static bool
2108
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2109
{
K
Karel Zak 已提交
2110 2111
    virDomainInfo info;
    virDomainPtr dom;
2112
    virSecurityModel secmodel;
2113
    virSecurityLabelPtr seclabel;
2114
    int persistent = 0;
E
Eric Blake 已提交
2115 2116
    bool ret = true;
    int autostart;
2117
    unsigned int id;
2118
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2119

2120
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2121
        return false;
K
Karel Zak 已提交
2122

J
Jim Meyering 已提交
2123
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2124
        return false;
2125

2126 2127
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2128
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2129
    else
2130
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2131 2132
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2133
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2134
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2135 2136

    if ((str = virDomainGetOSType(dom))) {
2137
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2138
        VIR_FREE(str);
2139 2140 2141
    }

    if (virDomainGetInfo(dom, &info) == 0) {
2142
        vshPrint(ctl, "%-15s %s\n", _("State:"),
E
Eric Blake 已提交
2143
                 _(vshDomainStateToString(info.state)));
2144

2145
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2146 2147

        if (info.cpuTime != 0) {
2148
            double cpuUsed = info.cpuTime;
2149

2150
            cpuUsed /= 1000000000.0;
2151

2152
            vshPrint(ctl, "%-15s %.1lfs\n", _("CPU time:"), cpuUsed);
K
Karel Zak 已提交
2153
        }
2154

2155 2156
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2157
                 info.maxMem);
2158
        else
2159
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2160 2161
                 _("no limit"));

2162
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2163 2164
                 info.memory);

K
Karel Zak 已提交
2165
    } else {
E
Eric Blake 已提交
2166
        ret = false;
K
Karel Zak 已提交
2167
    }
2168

2169 2170 2171 2172 2173 2174 2175 2176 2177
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
    vshDebug(ctl, 5, "Domain persistent flag value: %d\n", persistent);
    if (persistent < 0)
        vshPrint(ctl, "%-15s %s\n", _("Persistent:"), _("unknown"));
    else
        vshPrint(ctl, "%-15s %s\n", _("Persistent:"), persistent ? _("yes") : _("no"));

    /* Check and display whether the domain autostarts or not */
2178
    if (!virDomainGetAutostart(dom, &autostart)) {
2179
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2180 2181 2182
                 autostart ? _("enable") : _("disable") );
    }

2183 2184 2185
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2186 2187
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
2188
            return false;
2189 2190 2191
        } else {
            virFreeError(last_error);
            last_error = NULL;
2192
        }
2193 2194 2195 2196 2197 2198 2199
    } else {
        /* Only print something if a security model is active */
        if (secmodel.model[0] != '\0') {
            vshPrint(ctl, "%-15s %s\n", _("Security model:"), secmodel.model);
            vshPrint(ctl, "%-15s %s\n", _("Security DOI:"), secmodel.doi);

            /* Security labels are only valid for active domains */
2200
            if (VIR_ALLOC(seclabel) < 0) {
2201
                virDomainFree(dom);
E
Eric Blake 已提交
2202
                return false;
2203 2204 2205 2206 2207
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
2208
                return false;
2209
            } else {
2210
                if (seclabel->label[0] != '\0')
2211
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
2212
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
2213
            }
2214 2215

            VIR_FREE(seclabel);
2216 2217
        }
    }
2218
    virDomainFree(dom);
K
Karel Zak 已提交
2219 2220 2221
    return ret;
}

2222 2223 2224 2225
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2226 2227
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2228 2229 2230 2231
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2232
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2233 2234 2235 2236
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
2237
static bool
2238 2239 2240 2241
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
2242
    bool ret = true;
2243

2244
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2245
        return false;
2246 2247

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2248
        return false;
2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274

    if (virDomainGetJobInfo(dom, &info) == 0) {
        const char *unit;
        double val;

        vshPrint(ctl, "%-17s ", _("Job type:"));
        switch (info.type) {
        case VIR_DOMAIN_JOB_BOUNDED:
            vshPrint(ctl, "%-12s\n", _("Bounded"));
            break;

        case VIR_DOMAIN_JOB_UNBOUNDED:
            vshPrint(ctl, "%-12s\n", _("Unbounded"));
            break;

        case VIR_DOMAIN_JOB_NONE:
        default:
            vshPrint(ctl, "%-12s\n", _("None"));
            goto cleanup;
        }

        vshPrint(ctl, "%-17s %-12llu ms\n", _("Time elapsed:"), info.timeElapsed);
        if (info.type == VIR_DOMAIN_JOB_BOUNDED)
            vshPrint(ctl, "%-17s %-12llu ms\n", _("Time remaining:"), info.timeRemaining);
        if (info.dataTotal || info.dataRemaining || info.dataProcessed) {
            val = prettyCapacity(info.dataProcessed, &unit);
E
Eric Blake 已提交
2275
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2276
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2277
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2278
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2279
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2280 2281 2282
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2283
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2284
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2285
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2286
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2287
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2288 2289 2290
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2291
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2292
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2293
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2294
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2295
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2296 2297
        }
    } else {
E
Eric Blake 已提交
2298
        ret = false;
2299 2300 2301 2302 2303 2304
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2305 2306 2307 2308
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2309 2310
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2311 2312 2313 2314
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2315
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2316 2317 2318
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2319
static bool
2320 2321 2322
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2323
    bool ret = true;
2324

2325
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2326
        return false;
2327 2328

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2329
        return false;
2330 2331

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
2332
        ret = false;
2333 2334 2335 2336 2337

    virDomainFree(dom);
    return ret;
}

2338 2339 2340
/*
 * "freecell" command
 */
2341
static const vshCmdInfo info_freecell[] = {
2342 2343
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2344 2345 2346
    {NULL, NULL}
};

2347
static const vshCmdOptDef opts_freecell[] = {
2348
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2349
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
2350 2351 2352
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2353
static bool
2354
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2355
{
W
Wen Congyang 已提交
2356
    bool func_ret = false;
2357
    int ret;
2358
    int cell = -1, cell_given;
2359
    unsigned long long memory;
2360 2361 2362 2363
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
2364
    int all_given;
2365 2366 2367 2368
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
2369

2370

2371
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2372
        return false;
2373

2374 2375 2376 2377
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
2378 2379 2380 2381 2382 2383 2384 2385 2386
    all_given = vshCommandOptBool(cmd, "all");

    if (all_given && cell_given) {
        vshError(ctl, "%s", _("--cellno and --all are mutually exclusive. "
                              "Please choose only one."));
        goto cleanup;
    }

    if (all_given) {
2387 2388 2389
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2390 2391 2392
            goto cleanup;
        }

2393 2394 2395
        xml = xmlReadDoc((const xmlChar *) cap_xml, "node.xml", NULL,
                          XML_PARSE_NOENT | XML_PARSE_NONET |
                          XML_PARSE_NOWARNING);
2396

2397 2398
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2399 2400 2401
            goto cleanup;
        }

2402 2403 2404 2405 2406
        ctxt = xmlXPathNewContext(xml);
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
2407
            vshError(ctl, "%s", _("could not get information about "
2408
                                  "NUMA topology"));
2409 2410 2411
            goto cleanup;
        }

2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432
        nodes_free = vshCalloc(ctl, nodes_cnt, sizeof(*nodes_free));
        nodes_id = vshCalloc(ctl, nodes_cnt, sizeof(*nodes_id));

        for (i = 0; i < nodes_cnt; i++) {
            unsigned long id;
            char *val = virXMLPropString(nodes[i], "id");
            if (virStrToLong_ul(val, NULL, 10, &id)) {
                vshError(ctl, "%s", _("conversion from string failed"));
                VIR_FREE(val);
                goto cleanup;
            }
            VIR_FREE(val);
            nodes_id[i]=id;
            ret = virNodeGetCellsFreeMemory(ctl->conn, &(nodes_free[i]), id, 1);
            if (ret != 1) {
                vshError(ctl, _("failed to get free memory for NUMA node "
                                "number: %lu"), id);
                goto cleanup;
            }
        }

2433
        memory = 0;
2434 2435 2436 2437
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
2438 2439 2440 2441
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
2442
    } else {
2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456
        if (!cell_given) {
            memory = virNodeGetFreeMemory(ctl->conn);
            if (memory == 0)
                goto cleanup;
        } else {
            ret = virNodeGetCellsFreeMemory(ctl->conn, &memory, cell, 1);
            if (ret != 1)
                goto cleanup;
        }

        if (cell == -1)
            vshPrint(ctl, "%s: %llu kB\n", _("Total"), (memory/1024));
        else
            vshPrint(ctl, "%d: %llu kB\n", cell, (memory/1024));
2457 2458
    }

E
Eric Blake 已提交
2459
    func_ret = true;
2460

2461
cleanup:
2462 2463 2464
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
2465
    VIR_FREE(nodes);
2466 2467 2468
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
2469
    return func_ret;
2470 2471
}

E
Eric Blake 已提交
2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485
/*
 * "maxvcpus" command
 */
static const vshCmdInfo info_maxvcpus[] = {
    {"help", N_("connection vcpu maximum")},
    {"desc", N_("Show maximum number of virtual CPUs for guests on this connection.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_maxvcpus[] = {
    {"type", VSH_OT_STRING, 0, N_("domain type")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2486
static bool
E
Eric Blake 已提交
2487 2488
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
2489
    const char *type = NULL;
E
Eric Blake 已提交
2490 2491
    int vcpus;

2492 2493
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
2494
        return false;
2495
    }
E
Eric Blake 已提交
2496 2497

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2498
        return false;
E
Eric Blake 已提交
2499 2500 2501

    vcpus = virConnectGetMaxVcpus(ctl->conn, type);
    if (vcpus < 0)
E
Eric Blake 已提交
2502
        return false;
E
Eric Blake 已提交
2503 2504
    vshPrint(ctl, "%d\n", vcpus);

E
Eric Blake 已提交
2505
    return true;
E
Eric Blake 已提交
2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525
}

/*
 * "vcpucount" command
 */
static const vshCmdInfo info_vcpucount[] = {
    {"help", N_("domain vcpu counts")},
    {"desc", N_("Returns the number of virtual CPUs used by the domain.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_vcpucount[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"maximum", VSH_OT_BOOL, 0, N_("get maximum cap on vcpus")},
    {"current", VSH_OT_BOOL, 0, N_("get current vcpu usage")},
    {"config", VSH_OT_BOOL, 0, N_("get value to be used on next boot")},
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2526
static bool
E
Eric Blake 已提交
2527 2528 2529
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2530
    bool ret = true;
E
Eric Blake 已提交
2531 2532 2533 2534 2535 2536 2537 2538 2539 2540
    int maximum = vshCommandOptBool(cmd, "maximum");
    int current = vshCommandOptBool(cmd, "current");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    bool all = maximum + current + config + live == 0;
    int count;

    if (maximum && current) {
        vshError(ctl, "%s",
                 _("--maximum and --current cannot both be specified"));
E
Eric Blake 已提交
2541
        return false;
E
Eric Blake 已提交
2542 2543 2544 2545
    }
    if (config && live) {
        vshError(ctl, "%s",
                 _("--config and --live cannot both be specified"));
E
Eric Blake 已提交
2546
        return false;
E
Eric Blake 已提交
2547 2548 2549 2550 2551 2552 2553 2554 2555 2556
    }
    /* We want one of each pair of mutually exclusive options; that
     * is, use of flags requires exactly two options.  */
    if (maximum + current + config + live == 1) {
        vshError(ctl,
                 _("when using --%s, either --%s or --%s must be specified"),
                 (maximum ? "maximum" : current ? "current"
                  : config ? "config" : "live"),
                 maximum + current ? "config" : "maximum",
                 maximum + current ? "live" : "current");
E
Eric Blake 已提交
2557
        return false;
E
Eric Blake 已提交
2558 2559 2560
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2561
        return false;
E
Eric Blake 已提交
2562 2563

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2564
        return false;
E
Eric Blake 已提交
2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580

    /* In all cases, try the new API first; if it fails because we are
     * talking to an older client, try a fallback API before giving
     * up.  */
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
                                             VIR_DOMAIN_VCPU_CONFIG));
        if (count < 0 && (last_error->code == VIR_ERR_NO_SUPPORT
                          || last_error->code == VIR_ERR_INVALID_ARG)) {
            char *tmp;
            char *xml = virDomainGetXMLDesc(dom, VIR_DOMAIN_XML_INACTIVE);
            if (xml && (tmp = strstr(xml, "<vcpu"))) {
                tmp = strchr(tmp, '>');
                if (!tmp || virStrToLong_i(tmp + 1, &tmp, 10, &count) < 0)
                    count = -1;
            }
2581 2582
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
2583 2584 2585 2586 2587
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2588
            ret = false;
E
Eric Blake 已提交
2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    if (all || (maximum && live)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
                                             VIR_DOMAIN_VCPU_LIVE));
        if (count < 0 && (last_error->code == VIR_ERR_NO_SUPPORT
                          || last_error->code == VIR_ERR_INVALID_ARG)) {
            count = virDomainGetMaxVcpus(dom);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2609
            ret = false;
E
Eric Blake 已提交
2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    if (all || (current && config)) {
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_VCPU_CONFIG);
        if (count < 0 && (last_error->code == VIR_ERR_NO_SUPPORT
                          || last_error->code == VIR_ERR_INVALID_ARG)) {
            char *tmp, *end;
            char *xml = virDomainGetXMLDesc(dom, VIR_DOMAIN_XML_INACTIVE);
            if (xml && (tmp = strstr(xml, "<vcpu"))) {
                end = strchr(tmp, '>');
                if (end) {
                    *end = '\0';
                    tmp = strstr(tmp, "current=");
                    if (!tmp)
                        tmp = end + 1;
                    else {
                        tmp += strlen("current=");
                        tmp += *tmp == '\'' || *tmp == '"';
                    }
                }
                if (!tmp || virStrToLong_i(tmp, &tmp, 10, &count) < 0)
                    count = -1;
            }
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2646
            ret = false;
E
Eric Blake 已提交
2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    if (all || (current && live)) {
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_VCPU_LIVE);
        if (count < 0 && (last_error->code == VIR_ERR_NO_SUPPORT
                          || last_error->code == VIR_ERR_INVALID_ARG)) {
            virDomainInfo info;
            if (virDomainGetInfo(dom, &info) == 0)
                count = info.nrVirtCpu;
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2668
            ret = false;
E
Eric Blake 已提交
2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    virDomainFree(dom);
    return ret;
}

2683 2684 2685
/*
 * "vcpuinfo" command
 */
2686
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
2687
    {"help", N_("detailed domain vcpu information")},
2688
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
2689 2690 2691
    {NULL, NULL}
};

2692
static const vshCmdOptDef opts_vcpuinfo[] = {
2693
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2694 2695 2696
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2697
static bool
2698
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
2699 2700 2701 2702 2703 2704 2705 2706
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
    unsigned char *cpumap;
    int ncpus;
    size_t cpumaplen;
E
Eric Blake 已提交
2707
    bool ret = true;
2708

2709
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2710
        return false;
2711

J
Jim Meyering 已提交
2712
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2713
        return false;
2714 2715 2716

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2717
        return false;
2718 2719 2720 2721
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2722
        return false;
2723 2724
    }

2725
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
2726
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2727
    cpumap = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
2728

2729 2730 2731
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
                                   cpumap, cpumaplen)) >= 0) {
2732
        int n;
2733 2734 2735 2736 2737
        for (n = 0 ; n < ncpus ; n++) {
            unsigned int m;
            vshPrint(ctl, "%-15s %d\n", _("VCPU:"), n);
            vshPrint(ctl, "%-15s %d\n", _("CPU:"), cpuinfo[n].cpu);
            vshPrint(ctl, "%-15s %s\n", _("State:"),
E
Eric Blake 已提交
2738
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754
            if (cpuinfo[n].cpuTime != 0) {
                double cpuUsed = cpuinfo[n].cpuTime;

                cpuUsed /= 1000000000.0;

                vshPrint(ctl, "%-15s %.1lfs\n", _("CPU time:"), cpuUsed);
            }
            vshPrint(ctl, "%-15s ", _("CPU Affinity:"));
            for (m = 0 ; m < VIR_NODEINFO_MAXCPUS(nodeinfo) ; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumap, cpumaplen, n, m) ? 'y' : '-');
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
2755
    } else {
2756
        if (info.state == VIR_DOMAIN_SHUTOFF) {
2757 2758
            vshError(ctl, "%s",
                     _("Domain shut off, virtual CPUs not present."));
2759
        }
E
Eric Blake 已提交
2760
        ret = false;
2761 2762
    }

2763 2764
    VIR_FREE(cpumap);
    VIR_FREE(cpuinfo);
2765 2766 2767 2768 2769 2770 2771
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
2772
static const vshCmdInfo info_vcpupin[] = {
2773 2774
    {"help", N_("control domain vcpu affinity")},
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
2775 2776 2777
    {NULL, NULL}
};

2778
static const vshCmdOptDef opts_vcpupin[] = {
2779
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2780
    {"vcpu", VSH_OT_INT, VSH_OFLAG_REQ, N_("vcpu number")},
2781
    {"cpulist", VSH_OT_DATA, VSH_OFLAG_REQ, N_("host cpu number(s) (comma separated)")},
2782 2783 2784
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2785
static bool
2786
cmdVcpupin(vshControl *ctl, const vshCmd *cmd)
2787 2788 2789 2790 2791
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    int vcpu;
2792
    const char *cpulist = NULL;
E
Eric Blake 已提交
2793
    bool ret = true;
2794 2795
    unsigned char *cpumap;
    int cpumaplen;
2796 2797
    int i;
    enum { expect_num, expect_num_or_comma } state;
2798

2799
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2800
        return false;
2801

J
Jim Meyering 已提交
2802
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2803
        return false;
2804

2805
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) <= 0) {
2806
        vshError(ctl, "%s", _("vcpupin: Invalid or missing vCPU number."));
2807
        virDomainFree(dom);
E
Eric Blake 已提交
2808
        return false;
2809 2810
    }

2811
    if (vshCommandOptString(cmd, "cpulist", &cpulist) <= 0) {
2812
        virDomainFree(dom);
E
Eric Blake 已提交
2813
        return false;
2814
    }
2815

2816 2817
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2818
        return false;
2819 2820 2821
    }

    if (virDomainGetInfo(dom, &info) != 0) {
2822
        vshError(ctl, "%s", _("vcpupin: failed to get domain informations."));
2823
        virDomainFree(dom);
E
Eric Blake 已提交
2824
        return false;
2825 2826 2827
    }

    if (vcpu >= info.nrVirtCpu) {
2828
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
2829
        virDomainFree(dom);
E
Eric Blake 已提交
2830
        return false;
2831 2832
    }

2833 2834 2835 2836
    /* Check that the cpulist parameter is a comma-separated list of
     * numbers and give an intelligent error message if not.
     */
    if (cpulist[0] == '\0') {
2837
        vshError(ctl, "%s", _("cpulist: Invalid format. Empty string."));
2838
        virDomainFree (dom);
E
Eric Blake 已提交
2839
        return false;
2840 2841 2842 2843 2844 2845
    }

    state = expect_num;
    for (i = 0; cpulist[i]; i++) {
        switch (state) {
        case expect_num:
2846
          if (!c_isdigit (cpulist[i])) {
2847 2848 2849
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2850
                virDomainFree (dom);
E
Eric Blake 已提交
2851
                return false;
2852 2853 2854 2855 2856 2857
            }
            state = expect_num_or_comma;
            break;
        case expect_num_or_comma:
            if (cpulist[i] == ',')
                state = expect_num;
2858
            else if (!c_isdigit (cpulist[i])) {
2859 2860 2861
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit or comma at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
2862
                virDomainFree (dom);
E
Eric Blake 已提交
2863
                return false;
2864 2865 2866 2867
            }
        }
    }
    if (state == expect_num) {
2868 2869 2870
        vshError(ctl, _("cpulist: %s: Invalid format. Trailing comma "
                        "at position %d."),
                 cpulist, i);
2871
        virDomainFree (dom);
E
Eric Blake 已提交
2872
        return false;
2873 2874
    }

2875
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2876
    cpumap = vshCalloc(ctl, 1, cpumaplen);
2877 2878 2879 2880 2881 2882

    do {
        unsigned int cpu = atoi(cpulist);

        if (cpu < VIR_NODEINFO_MAXCPUS(nodeinfo)) {
            VIR_USE_CPU(cpumap, cpu);
2883
        } else {
2884
            vshError(ctl, _("Physical CPU %d doesn't exist."), cpu);
2885
            VIR_FREE(cpumap);
2886
            virDomainFree(dom);
E
Eric Blake 已提交
2887
            return false;
2888
        }
2889
        cpulist = strchr(cpulist, ',');
2890 2891 2892 2893 2894
        if (cpulist)
            cpulist++;
    } while (cpulist);

    if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
E
Eric Blake 已提交
2895
        ret = false;
2896 2897
    }

2898
    VIR_FREE(cpumap);
2899 2900 2901 2902
    virDomainFree(dom);
    return ret;
}

2903 2904 2905
/*
 * "setvcpus" command
 */
2906
static const vshCmdInfo info_setvcpus[] = {
2907 2908
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
2909 2910 2911
    {NULL, NULL}
};

2912
static const vshCmdOptDef opts_setvcpus[] = {
2913
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2914
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
2915 2916 2917
    {"maximum", VSH_OT_BOOL, 0, N_("set maximum limit on next boot")},
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
2918 2919 2920
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2921
static bool
2922
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
2923 2924
{
    virDomainPtr dom;
2925
    int count = 0;
E
Eric Blake 已提交
2926
    bool ret = true;
E
Eric Blake 已提交
2927 2928 2929 2930 2931 2932
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int flags = ((maximum ? VIR_DOMAIN_VCPU_MAXIMUM : 0) |
                 (config ? VIR_DOMAIN_VCPU_CONFIG : 0) |
                 (live ? VIR_DOMAIN_VCPU_LIVE : 0));
2933

2934
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2935
        return false;
2936

J
Jim Meyering 已提交
2937
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2938
        return false;
2939

2940 2941 2942 2943
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
2944

E
Eric Blake 已提交
2945 2946
    if (!flags) {
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
2947
            ret = false;
E
Eric Blake 已提交
2948 2949
        }
    } else {
2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
            vshDebug(ctl, 5, "--maximum flag was given\n");

            /* If neither the --config nor --live flags were given, OR
               if just the --live flag was given, we need to error out
               warning the user that the --maximum flag can only be used
               with the --config flag */
            if (live || !config) {

                /* Warn the user about the invalid flag combination */
                vshError(ctl, _("--maximum must be used with --config only"));
E
Eric Blake 已提交
2963
                ret = false;
2964 2965 2966 2967 2968
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
2969
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
2970
            ret = false;
E
Eric Blake 已提交
2971
        }
2972 2973
    }

2974
  cleanup:
2975 2976 2977 2978
    virDomainFree(dom);
    return ret;
}

2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012
/*
 * "inject-nmi" command
 */
static const vshCmdInfo info_inject_nmi[] = {
    {"help", N_("Inject NMI to the guest")},
    {"desc", N_("Inject NMI to the guest domain.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_inject_nmi[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {NULL, 0, 0, NULL}
};


static bool
cmdInjectNMI(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int ret = true;

    if (!vshConnectionUsability(ctl, ctl->conn))
        return false;

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
        return false;

    if (virDomainInjectNMI(dom, 0) < 0)
            ret = false;

    virDomainFree(dom);
    return ret;
}

3013 3014 3015
/*
 * "setmemory" command
 */
3016
static const vshCmdInfo info_setmem[] = {
3017 3018
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
3019 3020 3021
    {NULL, NULL}
};

3022
static const vshCmdOptDef opts_setmem[] = {
3023
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3024
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
3025 3026
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
3027
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3028 3029 3030
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3031
static bool
3032
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
3033 3034
{
    virDomainPtr dom;
3035
    virDomainInfo info;
3036
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
3037
    bool ret = true;
3038 3039
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3040
    int current = vshCommandOptBool(cmd, "current");
3041 3042
    int flags = 0;

3043 3044 3045
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3046
            return false;
3047 3048 3049 3050 3051
        }
        flags = VIR_DOMAIN_MEM_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_MEM_CONFIG;
3052 3053
        if (live)
            flags |= VIR_DOMAIN_MEM_LIVE;
3054 3055 3056
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
3057
    }
3058

3059
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3060
        return false;
3061

J
Jim Meyering 已提交
3062
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3063
        return false;
3064

3065 3066
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3067
        return false;
3068 3069
    }

3070
    if (kilobytes <= 0) {
3071
        virDomainFree(dom);
3072
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
3073
        return false;
3074 3075
    }

3076 3077
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
3078
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
3079
        return false;
3080 3081 3082 3083
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
3084
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
3085
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
3086
        return false;
3087 3088
    }

3089
    if (flags == -1) {
3090
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
3091
            ret = false;
3092 3093 3094
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
3095
            ret = false;
3096
        }
3097 3098 3099 3100 3101 3102 3103 3104 3105
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
3106
static const vshCmdInfo info_setmaxmem[] = {
3107 3108
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
3109 3110 3111
    {NULL, NULL}
};

3112
static const vshCmdOptDef opts_setmaxmem[] = {
3113
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3114
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
3115 3116 3117
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3118 3119 3120
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3121
static bool
3122
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
3123 3124
{
    virDomainPtr dom;
3125
    int kilobytes = 0;
E
Eric Blake 已提交
3126
    bool ret = true;
3127 3128 3129 3130 3131 3132 3133 3134
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
    int flags = VIR_DOMAIN_MEM_MAXIMUM;

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3135
            return false;
3136 3137 3138 3139 3140 3141 3142 3143 3144 3145
        }
    } else {
        if (config)
            flags |= VIR_DOMAIN_MEM_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_MEM_LIVE;
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
3146

3147
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3148
        return false;
3149

J
Jim Meyering 已提交
3150
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3151
        return false;
3152

3153 3154
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3155
        return false;
3156 3157
    }

3158
    if (kilobytes <= 0) {
3159
        virDomainFree(dom);
3160
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
3161
        return false;
3162 3163
    }

3164 3165 3166
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3167
            ret = false;
3168 3169 3170 3171
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3172
            ret = false;
3173
        }
3174 3175
    }

3176 3177 3178 3179
    virDomainFree(dom);
    return ret;
}

3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198
/*
 * "blkiotune" command
 */
static const vshCmdInfo info_blkiotune[] = {
    {"help", N_("Get or set blkio parameters")},
    {"desc", N_("Get or set the current blkio parameters for a guest" \
                " domain.\n" \
                "    To get the blkio parameters use following command: \n\n" \
                "    virsh # blkiotune <domain>")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_blkiotune[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"weight", VSH_OT_INT, VSH_OFLAG_NONE,
     N_("IO Weight in range [100, 1000]")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3199
static bool
3200 3201 3202 3203 3204 3205
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
    unsigned int i = 0;
3206
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3207
    bool ret = false;
3208 3209

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3210
        return false;
3211 3212

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3213
        return false;
3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239

    if (vshCommandOptInt(cmd, "weight", &weight) < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

    if (weight) {
        nparams++;
        if (weight < 0) {
            virDomainFree(dom);
            vshError(ctl, _("Invalid value of %d for I/O weight"), weight);
            goto cleanup;
        }
    }

    if (nparams == 0) {
        /* get the number of blkio parameters */
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, 0) != 0) {
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3240
            ret = true;
3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
        if (virDomainGetBlkioParameters(dom, params, &nparams, 0) != 0) {
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
3253
                case VIR_TYPED_PARAM_INT:
3254 3255 3256
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
3257
                case VIR_TYPED_PARAM_UINT:
3258 3259 3260
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
3261
                case VIR_TYPED_PARAM_LLONG:
3262 3263 3264
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
3265
                case VIR_TYPED_PARAM_ULLONG:
3266 3267 3268
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
3269
                case VIR_TYPED_PARAM_DOUBLE:
3270 3271 3272
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
3273
                case VIR_TYPED_PARAM_BOOLEAN:
3274 3275 3276 3277 3278 3279 3280 3281
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
3282
        ret = true;
3283 3284 3285 3286 3287 3288
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
3289
            temp->type = VIR_TYPED_PARAM_UINT;
3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
        if (virDomainSetBlkioParameters(dom, params, nparams, 0) != 0)
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
3301
            ret = true;
3302 3303 3304 3305 3306 3307 3308 3309
    }

  cleanup:
    VIR_FREE(params);
    virDomainFree(dom);
    return ret;
}

3310 3311 3312 3313
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
3314 3315 3316
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
3317 3318 3319 3320 3321 3322 3323
                "    To get the memory parameters use following command: \n\n" \
                "    virsh # memtune <domain>")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_memtune[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3324
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3325
     N_("Max memory in kilobytes")},
3326
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3327
     N_("Memory during contention in kilobytes")},
3328
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3329
     N_("Max memory plus swap in kilobytes")},
3330
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
3331
     N_("Min guaranteed memory in kilobytes")},
3332 3333 3334
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3335 3336 3337
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3338
static bool
3339 3340 3341
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
3342 3343
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
3344 3345
    int nparams = 0;
    unsigned int i = 0;
3346
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3347
    bool ret = false;
3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364
    unsigned int flags = 0;
    int current = vshCommandOptBool(cmd, "current");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
            return false;
        }
        flags = VIR_DOMAIN_MEMORY_PARAM_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_MEMORY_PARAM_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_MEMORY_PARAM_LIVE;
    }
3365 3366

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3367
        return false;
3368 3369

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3370
        return false;
3371

3372 3373 3374 3375 3376 3377 3378 3379 3380
    if (vshCommandOptLongLong(cmd, "hard-limit", &hard_limit) < 0 ||
        vshCommandOptLongLong(cmd, "soft-limit", &soft_limit) < 0 ||
        vshCommandOptLongLong(cmd, "swap-hard-limit", &swap_hard_limit) < 0 ||
        vshCommandOptLongLong(cmd, "min-guarantee", &min_guarantee) < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

3381 3382 3383 3384 3385 3386 3387 3388 3389
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

3390 3391 3392
    if (min_guarantee)
        nparams++;

3393 3394
    if (nparams == 0) {
        /* get the number of memory parameters */
3395
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
3396 3397 3398 3399 3400
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

3401 3402
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3403
            ret = true;
3404 3405 3406
            goto cleanup;
        }

3407
        /* now go get all the memory parameters */
E
Eric Blake 已提交
3408
        params = vshCalloc(ctl, nparams, sizeof(*params));
3409
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
3410 3411 3412 3413 3414 3415
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
3416
                case VIR_TYPED_PARAM_INT:
3417 3418 3419
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
3420
                case VIR_TYPED_PARAM_UINT:
3421 3422 3423
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
3424
                case VIR_TYPED_PARAM_LLONG:
3425 3426 3427
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
3428
                case VIR_TYPED_PARAM_ULLONG:
3429 3430 3431 3432 3433
                    if (params[i].value.ul == VIR_DOMAIN_MEMORY_PARAM_UNLIMITED)
                        vshPrint(ctl, "%-15s: unlimited\n", params[i].field);
                    else
                        vshPrint(ctl, "%-15s: %llu kB\n", params[i].field,
                                 params[i].value.ul);
3434
                    break;
3435
                case VIR_TYPED_PARAM_DOUBLE:
3436 3437 3438
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
3439
                case VIR_TYPED_PARAM_BOOLEAN:
3440 3441 3442 3443
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
3444
                    vshPrint(ctl, "unimplemented memory parameter type\n");
3445 3446 3447
            }
        }

E
Eric Blake 已提交
3448
        ret = true;
3449 3450
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
3451
        params = vshCalloc(ctl, nparams, sizeof(*params));
3452 3453 3454

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
3455
            temp->type = VIR_TYPED_PARAM_ULLONG;
3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474

            /*
             * Some magic here, this is used to fill the params structure with
             * the valid arguments passed, after filling the particular
             * argument we purposely make them 0, so on the next pass it goes
             * to the next valid argument and so on.
             */
            if (soft_limit) {
                temp->value.ul = soft_limit;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SOFT_LIMIT,
                        sizeof(temp->field));
                soft_limit = 0;
            } else if (hard_limit) {
                temp->value.ul = hard_limit;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_HARD_LIMIT,
                        sizeof(temp->field));
                hard_limit = 0;
            } else if (swap_hard_limit) {
                temp->value.ul = swap_hard_limit;
3475
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
3476 3477
                        sizeof(temp->field));
                swap_hard_limit = 0;
3478 3479 3480 3481 3482
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
3483
            }
3484 3485 3486 3487

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
3488
        }
3489
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
3490
            vshError(ctl, "%s", _("Unable to change memory parameters"));
3491
        else
E
Eric Blake 已提交
3492
            ret = true;
3493 3494 3495
    }

  cleanup:
E
Eric Blake 已提交
3496
    VIR_FREE(params);
3497 3498 3499 3500
    virDomainFree(dom);
    return ret;
}

3501 3502 3503
/*
 * "nodeinfo" command
 */
3504
static const vshCmdInfo info_nodeinfo[] = {
3505 3506
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
3507 3508 3509
    {NULL, NULL}
};

E
Eric Blake 已提交
3510
static bool
3511
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3512 3513
{
    virNodeInfo info;
3514

3515
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3516
        return false;
3517 3518

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
3519
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
3520
        return false;
3521 3522 3523 3524 3525 3526 3527 3528 3529 3530
    }
    vshPrint(ctl, "%-20s %s\n", _("CPU model:"), info.model);
    vshPrint(ctl, "%-20s %d\n", _("CPU(s):"), info.cpus);
    vshPrint(ctl, "%-20s %d MHz\n", _("CPU frequency:"), info.mhz);
    vshPrint(ctl, "%-20s %d\n", _("CPU socket(s):"), info.sockets);
    vshPrint(ctl, "%-20s %d\n", _("Core(s) per socket:"), info.cores);
    vshPrint(ctl, "%-20s %d\n", _("Thread(s) per core:"), info.threads);
    vshPrint(ctl, "%-20s %d\n", _("NUMA cell(s):"), info.nodes);
    vshPrint(ctl, "%-20s %lu kB\n", _("Memory size:"), info.memory);

E
Eric Blake 已提交
3531
    return true;
3532 3533
}

3534 3535 3536
/*
 * "capabilities" command
 */
3537
static const vshCmdInfo info_capabilities[] = {
3538 3539
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
3540 3541 3542
    {NULL, NULL}
};

E
Eric Blake 已提交
3543
static bool
3544
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3545 3546 3547
{
    char *caps;

3548
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3549
        return false;
3550 3551

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
3552
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
3553
        return false;
3554 3555
    }
    vshPrint (ctl, "%s\n", caps);
3556
    VIR_FREE(caps);
3557

E
Eric Blake 已提交
3558
    return true;
3559 3560
}

3561 3562 3563
/*
 * "dumpxml" command
 */
3564
static const vshCmdInfo info_dumpxml[] = {
3565 3566
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
3567
    {NULL, NULL}
3568 3569
};

3570
static const vshCmdOptDef opts_dumpxml[] = {
3571 3572 3573
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
    {"security-info", VSH_OT_BOOL, 0, N_("include security sensitive information in XML dump")},
3574
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
3575
    {NULL, 0, 0, NULL}
3576 3577
};

E
Eric Blake 已提交
3578
static bool
3579
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
3580
{
3581
    virDomainPtr dom;
E
Eric Blake 已提交
3582
    bool ret = true;
3583
    char *dump;
3584 3585 3586
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
3587
    int update = vshCommandOptBool(cmd, "update-cpu");
3588 3589 3590 3591 3592

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
3593 3594
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
3595

3596
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3597
        return false;
3598

J
Jim Meyering 已提交
3599
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3600
        return false;
3601

3602
    dump = virDomainGetXMLDesc(dom, flags);
3603
    if (dump != NULL) {
3604
        vshPrint(ctl, "%s", dump);
3605
        VIR_FREE(dump);
3606
    } else {
E
Eric Blake 已提交
3607
        ret = false;
3608
    }
3609

3610 3611 3612 3613
    virDomainFree(dom);
    return ret;
}

3614 3615 3616 3617
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
3618 3619
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
3620 3621 3622 3623
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
3624 3625
    {"format", VSH_OT_DATA, VSH_OFLAG_REQ, N_("source config data format")},
    {"config", VSH_OT_DATA, VSH_OFLAG_REQ, N_("config data file to import from")},
3626 3627 3628
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3629
static bool
3630 3631
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
3632
    bool ret = true;
3633 3634
    const char *format = NULL;
    const char *configFile = NULL;
3635 3636 3637 3638
    char *configData;
    char *xmlData;
    int flags = 0;

3639
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3640
        return false;
3641

3642 3643
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
3644
        return false;
3645

3646
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
3647
        return false;
3648 3649 3650

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
3651
        vshPrint(ctl, "%s", xmlData);
3652
        VIR_FREE(xmlData);
3653
    } else {
E
Eric Blake 已提交
3654
        ret = false;
3655 3656 3657 3658 3659 3660 3661 3662 3663
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
3664 3665
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
3666 3667 3668 3669
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
3670 3671
    {"format", VSH_OT_DATA, VSH_OFLAG_REQ, N_("target config data type format")},
    {"xml", VSH_OT_DATA, VSH_OFLAG_REQ, N_("xml data file to export from")},
3672 3673 3674
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3675
static bool
3676 3677
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
3678
    bool ret = true;
3679 3680
    const char *format = NULL;
    const char *xmlFile = NULL;
3681 3682 3683 3684
    char *configData;
    char *xmlData;
    int flags = 0;

3685
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3686
        return false;
3687

3688 3689
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
3690
        return false;
3691

3692
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
3693
        return false;
3694 3695 3696

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
3697
        vshPrint(ctl, "%s", configData);
3698
        VIR_FREE(configData);
3699
    } else {
E
Eric Blake 已提交
3700
        ret = false;
3701 3702 3703 3704 3705
    }

    return ret;
}

K
Karel Zak 已提交
3706
/*
K
Karel Zak 已提交
3707
 * "domname" command
K
Karel Zak 已提交
3708
 */
3709
static const vshCmdInfo info_domname[] = {
3710
    {"help", N_("convert a domain id or UUID to domain name")},
3711
    {"desc", ""},
3712
    {NULL, NULL}
K
Karel Zak 已提交
3713 3714
};

3715
static const vshCmdOptDef opts_domname[] = {
3716
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
3717
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3718 3719
};

E
Eric Blake 已提交
3720
static bool
3721
cmdDomname(vshControl *ctl, const vshCmd *cmd)
3722
{
K
Karel Zak 已提交
3723 3724
    virDomainPtr dom;

3725
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3726
        return false;
J
Jim Meyering 已提交
3727
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3728
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
3729
        return false;
3730

K
Karel Zak 已提交
3731 3732
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
3733
    return true;
K
Karel Zak 已提交
3734 3735 3736
}

/*
K
Karel Zak 已提交
3737
 * "domid" command
K
Karel Zak 已提交
3738
 */
3739
static const vshCmdInfo info_domid[] = {
3740
    {"help", N_("convert a domain name or UUID to domain id")},
3741
    {"desc", ""},
3742
    {NULL, NULL}
K
Karel Zak 已提交
3743 3744
};

3745
static const vshCmdOptDef opts_domid[] = {
3746
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
3747
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3748 3749
};

E
Eric Blake 已提交
3750
static bool
3751
cmdDomid(vshControl *ctl, const vshCmd *cmd)
3752
{
3753
    virDomainPtr dom;
3754
    unsigned int id;
K
Karel Zak 已提交
3755

3756
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3757
        return false;
J
Jim Meyering 已提交
3758
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3759
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
3760
        return false;
3761

3762 3763
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3764
        vshPrint(ctl, "%s\n", "-");
3765
    else
3766
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
3767
    virDomainFree(dom);
E
Eric Blake 已提交
3768
    return true;
K
Karel Zak 已提交
3769
}
3770

K
Karel Zak 已提交
3771 3772 3773
/*
 * "domuuid" command
 */
3774
static const vshCmdInfo info_domuuid[] = {
3775
    {"help", N_("convert a domain name or id to domain UUID")},
3776
    {"desc", ""},
K
Karel Zak 已提交
3777 3778 3779
    {NULL, NULL}
};

3780
static const vshCmdOptDef opts_domuuid[] = {
3781
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
3782 3783 3784
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3785
static bool
3786
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
3787 3788
{
    virDomainPtr dom;
3789
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
3790

3791
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3792
        return false;
J
Jim Meyering 已提交
3793
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
3794
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
3795
        return false;
3796

K
Karel Zak 已提交
3797 3798 3799
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
3800
        vshError(ctl, "%s", _("failed to get domain UUID"));
3801

3802
    virDomainFree(dom);
E
Eric Blake 已提交
3803
    return true;
K
Karel Zak 已提交
3804 3805
}

3806 3807 3808
/*
 * "migrate" command
 */
3809
static const vshCmdInfo info_migrate[] = {
3810 3811
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
3812 3813 3814
    {NULL, NULL}
};

3815
static const vshCmdOptDef opts_migrate[] = {
3816 3817 3818 3819 3820 3821 3822
    {"live", VSH_OT_BOOL, 0, N_("live migration")},
    {"p2p", VSH_OT_BOOL, 0, N_("peer-2-peer migration")},
    {"direct", VSH_OT_BOOL, 0, N_("direct migration")},
    {"tunnelled", VSH_OT_BOOL, 0, N_("tunnelled migration")},
    {"persistent", VSH_OT_BOOL, 0, N_("persist VM on destination")},
    {"undefinesource", VSH_OT_BOOL, 0, N_("undefine VM on source")},
    {"suspend", VSH_OT_BOOL, 0, N_("do not restart the domain on the destination host")},
3823 3824
    {"copy-storage-all", VSH_OT_BOOL, 0, N_("migration with non-shared storage with full disk copy")},
    {"copy-storage-inc", VSH_OT_BOOL, 0, N_("migration with non-shared storage with incremental copy (same base image shared between source and destination)")},
W
Wen Congyang 已提交
3825
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
3826
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3827
    {"desturi", VSH_OT_DATA, VSH_OFLAG_REQ, N_("connection URI of the destination host as seen from the client(normal migration) or source(p2p migration)")},
3828 3829
    {"migrateuri", VSH_OT_DATA, 0, N_("migration URI, usually can be omitted")},
    {"dname", VSH_OT_DATA, 0, N_("rename to new name during migration (if supported)")},
W
Wen Congyang 已提交
3830
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
3831 3832 3833
    {NULL, 0, 0, NULL}
};

3834 3835 3836 3837 3838 3839 3840 3841
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
3842
{
3843
    char ret = '1';
3844
    virDomainPtr dom = NULL;
3845 3846 3847 3848
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
    int flags = 0;
3849 3850 3851
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
3852 3853
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;
3854 3855 3856 3857 3858

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
    if (pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask) < 0)
        goto out_sig;
3859
#endif
3860

3861
    if (!vshConnectionUsability (ctl, ctl->conn))
3862
        goto out;
3863

J
Jim Meyering 已提交
3864
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
3865
        goto out;
3866

3867 3868
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
3869 3870
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
3871
        goto out;
3872
    }
3873 3874 3875

    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
3876 3877
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
3878 3879 3880
    if (vshCommandOptBool (cmd, "tunnelled"))
        flags |= VIR_MIGRATE_TUNNELLED;

C
Chris Lalancette 已提交
3881 3882 3883 3884 3885
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

3886 3887 3888
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

3889 3890 3891 3892 3893 3894
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

    if (vshCommandOptBool (cmd, "copy-storage-inc"))
        flags |= VIR_MIGRATE_NON_SHARED_INC;

3895 3896 3897 3898
    if ((flags & VIR_MIGRATE_PEER2PEER) ||
        vshCommandOptBool (cmd, "direct")) {
        /* For peer2peer migration or direct migration we only expect one URI
         * a libvirt URI, or a hypervisor specific URI. */
3899

3900
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
3901
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
3902
            goto out;
3903
        }
3904

3905
        if (virDomainMigrateToURI (dom, desturi, flags, dname, 0) == 0)
3906
            ret = '0';
3907 3908 3909 3910 3911 3912
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
3913
        if (!dconn) goto out;
3914 3915 3916 3917

        ddom = virDomainMigrate (dom, dconn, flags, dname, migrateuri, 0);
        if (ddom) {
            virDomainFree(ddom);
3918
            ret = '0';
3919 3920 3921
        }
        virConnectClose (dconn);
    }
3922

3923
out:
3924
#if HAVE_PTHREAD_SIGMASK
3925 3926
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
3927
#endif
3928
    if (dom) virDomainFree (dom);
3929 3930 3931
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955
static void
print_job_progress(unsigned long long remaining, unsigned long long total)
{
    int progress;

    if (total == 0)
        /* migration has not been started */
        return;

    if (remaining == 0) {
        /* migration has completed */
        progress = 100;
    } else {
        /* use float to avoid overflow */
        progress = (int)(100.0 - remaining * 100.0 / total);
        if (progress >= 100) {
            /* migration has not completed, do not print [100 %] */
            progress = 99;
        }
    }

    fprintf(stderr, "\rMigration: [%3d %%]", progress);
}

E
Eric Blake 已提交
3956
static bool
3957 3958 3959 3960 3961
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
3962
    bool functionReturn = false;
3963 3964 3965 3966 3967
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
3968 3969
    virDomainJobInfo jobinfo;
    bool verbose = false;
3970
    int timeout = 0;
W
Wen Congyang 已提交
3971 3972
    struct timeval start, curr;
    bool live_flag = false;
3973
    vshCtrlData data;
3974 3975 3976 3977 3978 3979
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
#endif
3980 3981

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3982
        return false;
3983

W
Wen Congyang 已提交
3984 3985 3986
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
3987
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
3988
        live_flag = true;
3989
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006
        if (! live_flag) {
            vshError(ctl, "%s", _("migrate: Unexpected timeout for offline migration"));
            goto cleanup;
        }

        if (timeout < 1) {
            vshError(ctl, "%s", _("migrate: Invalid timeout"));
            goto cleanup;
        }

        /* Ensure that we can multiply by 1000 without overflowing. */
        if (timeout > INT_MAX / 1000) {
            vshError(ctl, "%s", _("migrate: Timeout is too big"));
            goto cleanup;
        }
    }

4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029
    if (pipe(p) < 0)
        goto cleanup;

    data.ctl = ctl;
    data.cmd = cmd;
    data.writefd = p[1];

    if (virThreadCreate(&workerThread,
                        true,
                        doMigrate,
                        &data) < 0)
        goto cleanup;

    intCaught = 0;
    sig_action.sa_sigaction = vshCatchInt;
    sig_action.sa_flags = SA_SIGINFO;
    sigemptyset(&sig_action.sa_mask);
    sigaction(SIGINT, &sig_action, &old_sig_action);

    pollfd.fd = p[0];
    pollfd.events = POLLIN;
    pollfd.revents = 0;

W
Wen Congyang 已提交
4030
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
4031
    while (1) {
4032
repoll:
W
Wen Congyang 已提交
4033 4034 4035 4036
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
4037
                    functionReturn = true;
W
Wen Congyang 已提交
4038 4039 4040 4041 4042
                    if (verbose) {
                        /* print [100 %] */
                        print_job_progress(0, 1);
                    }
                } else
W
Wen Congyang 已提交
4043
                    functionReturn = false;
4044
            } else
W
Wen Congyang 已提交
4045
                functionReturn = false;
W
Wen Congyang 已提交
4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
4057
            functionReturn = false;
W
Wen Congyang 已提交
4058 4059 4060
            break;
        }

W
Wen Congyang 已提交
4061 4062 4063 4064 4065 4066 4067 4068 4069
        GETTIMEOFDAY(&curr);
        if ( timeout && ((int)(curr.tv_sec - start.tv_sec)  * 1000 + \
                         (int)(curr.tv_usec - start.tv_usec) / 1000) > timeout * 1000 ) {
            /* suspend the domain when migration timeouts. */
            vshDebug(ctl, 5, "suspend the domain when migration timeouts\n");
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
4070
        if (verbose) {
4071
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
4072
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
4073
#endif
W
Wen Congyang 已提交
4074
            ret = virDomainGetJobInfo(dom, &jobinfo);
4075
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
4076
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
4077
#endif
W
Wen Congyang 已提交
4078 4079
            if (ret == 0)
                print_job_progress(jobinfo.dataRemaining, jobinfo.dataTotal);
4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
4091
    return functionReturn;
4092 4093
}

4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104
/*
 * "migrate-setmaxdowntime" command
 */
static const vshCmdInfo info_migrate_setmaxdowntime[] = {
    {"help", N_("set maximum tolerable downtime")},
    {"desc", N_("Set maximum tolerable downtime of a domain which is being live-migrated to another host.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_migrate_setmaxdowntime[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4105
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
4106 4107 4108
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4109
static bool
4110 4111 4112
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
4113
    long long downtime = 0;
E
Eric Blake 已提交
4114
    bool ret = false;
4115

4116
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4117
        return false;
4118 4119

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4120
        return false;
4121

4122 4123
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
4124 4125 4126 4127 4128 4129 4130
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

    if (virDomainMigrateSetMaxDowntime(dom, downtime, 0))
        goto done;

E
Eric Blake 已提交
4131
    ret = true;
4132 4133 4134 4135 4136 4137

done:
    virDomainFree(dom);
    return ret;
}

4138 4139 4140
/*
 * "net-autostart" command
 */
4141
static const vshCmdInfo info_network_autostart[] = {
4142
    {"help", N_("autostart a network")},
4143
    {"desc",
4144
     N_("Configure a network to be automatically started at boot.")},
4145 4146 4147
    {NULL, NULL}
};

4148
static const vshCmdOptDef opts_network_autostart[] = {
4149 4150
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4151 4152 4153
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4154
static bool
4155
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
4156 4157
{
    virNetworkPtr network;
4158
    const char *name;
4159 4160
    int autostart;

4161
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4162
        return false;
4163

J
Jim Meyering 已提交
4164
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4165
        return false;
4166 4167 4168 4169

    autostart = !vshCommandOptBool(cmd, "disable");

    if (virNetworkSetAutostart(network, autostart) < 0) {
4170
        if (autostart)
4171
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
4172
        else
4173
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
4174
        virNetworkFree(network);
E
Eric Blake 已提交
4175
        return false;
4176 4177
    }

4178
    if (autostart)
4179
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
4180
    else
4181
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
4182

L
Laine Stump 已提交
4183
    virNetworkFree(network);
E
Eric Blake 已提交
4184
    return true;
4185
}
K
Karel Zak 已提交
4186

4187 4188 4189
/*
 * "net-create" command
 */
4190
static const vshCmdInfo info_network_create[] = {
4191 4192
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
4193 4194 4195
    {NULL, NULL}
};

4196
static const vshCmdOptDef opts_network_create[] = {
4197
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4198 4199 4200
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4201
static bool
4202
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
4203 4204
{
    virNetworkPtr network;
4205
    const char *from = NULL;
E
Eric Blake 已提交
4206
    bool ret = true;
4207
    char *buffer;
4208

4209
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4210
        return false;
4211

4212
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4213
        return false;
4214

4215
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4216
        return false;
4217 4218

    network = virNetworkCreateXML(ctl->conn, buffer);
4219
    VIR_FREE(buffer);
4220

4221 4222 4223
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4224
        virNetworkFree(network);
4225
    } else {
4226
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
4227
        ret = false;
4228 4229 4230 4231 4232 4233 4234 4235
    }
    return ret;
}


/*
 * "net-define" command
 */
4236
static const vshCmdInfo info_network_define[] = {
4237 4238
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
4239 4240 4241
    {NULL, NULL}
};

4242
static const vshCmdOptDef opts_network_define[] = {
4243
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4244 4245 4246
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4247
static bool
4248
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
4249 4250
{
    virNetworkPtr network;
4251
    const char *from = NULL;
E
Eric Blake 已提交
4252
    bool ret = true;
4253
    char *buffer;
4254

4255
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4256
        return false;
4257

4258
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4259
        return false;
4260

4261
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4262
        return false;
4263 4264

    network = virNetworkDefineXML(ctl->conn, buffer);
4265
    VIR_FREE(buffer);
4266

4267 4268 4269
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4270
        virNetworkFree(network);
4271
    } else {
4272
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
4273
        ret = false;
4274 4275 4276 4277 4278 4279 4280 4281
    }
    return ret;
}


/*
 * "net-destroy" command
 */
4282
static const vshCmdInfo info_network_destroy[] = {
4283 4284
    {"help", N_("destroy a network")},
    {"desc", N_("Destroy a given network.")},
4285 4286 4287
    {NULL, NULL}
};

4288
static const vshCmdOptDef opts_network_destroy[] = {
4289
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4290 4291 4292
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4293
static bool
4294
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
4295 4296
{
    virNetworkPtr network;
E
Eric Blake 已提交
4297
    bool ret = true;
4298
    const char *name;
4299

4300
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4301
        return false;
4302

J
Jim Meyering 已提交
4303
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4304
        return false;
4305 4306 4307 4308

    if (virNetworkDestroy(network) == 0) {
        vshPrint(ctl, _("Network %s destroyed\n"), name);
    } else {
4309
        vshError(ctl, _("Failed to destroy network %s"), name);
E
Eric Blake 已提交
4310
        ret = false;
4311 4312
    }

4313
    virNetworkFree(network);
4314 4315 4316 4317 4318 4319 4320
    return ret;
}


/*
 * "net-dumpxml" command
 */
4321
static const vshCmdInfo info_network_dumpxml[] = {
4322 4323
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
4324 4325 4326
    {NULL, NULL}
};

4327
static const vshCmdOptDef opts_network_dumpxml[] = {
4328
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4329 4330 4331
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4332
static bool
4333
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
4334 4335
{
    virNetworkPtr network;
E
Eric Blake 已提交
4336
    bool ret = true;
4337 4338
    char *dump;

4339
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4340
        return false;
4341

J
Jim Meyering 已提交
4342
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
4343
        return false;
4344 4345 4346

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
4347
        vshPrint(ctl, "%s", dump);
4348
        VIR_FREE(dump);
4349
    } else {
E
Eric Blake 已提交
4350
        ret = false;
4351 4352 4353 4354 4355 4356
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370
/*
 * "net-info" command
 */
static const vshCmdInfo info_network_info[] = {
    {"help", N_("network information")},
    {"desc", "Returns basic information about the network"},
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_info[] = {
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4371
static bool
O
Osier Yang 已提交
4372 4373 4374 4375 4376 4377 4378 4379 4380 4381
cmdNetworkInfo(vshControl *ctl, const vshCmd *cmd)
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];
    int autostart;
    int persistent = -1;
    int active = -1;
    char *bridge = NULL;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4382
        return false;
O
Osier Yang 已提交
4383 4384 4385

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4386
        return false;
O
Osier Yang 已提交
4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412

    vshPrint(ctl, "%-15s %s\n", _("Name"), virNetworkGetName(network));

    if (virNetworkGetUUIDString(network, uuid) == 0)
        vshPrint(ctl, "%-15s %s\n", _("UUID"), uuid);

    active = virNetworkIsActive(network);
    if (active >= 0)
        vshPrint(ctl, "%-15s %s\n", _("Active:"), active? _("yes") : _("no"));

    persistent = virNetworkIsPersistent(network);
    if (persistent < 0)
        vshPrint(ctl, "%-15s %s\n", _("Persistent:"), _("unknown"));
    else
        vshPrint(ctl, "%-15s %s\n", _("Persistent:"), persistent ? _("yes") : _("no"));

    if (virNetworkGetAutostart(network, &autostart) < 0)
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
    else
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

    bridge = virNetworkGetBridgeName(network);
    if (bridge)
        vshPrint(ctl, "%-15s %s\n", _("Bridge:"), bridge);

    virNetworkFree(network);
E
Eric Blake 已提交
4413
    return true;
O
Osier Yang 已提交
4414
}
4415

4416 4417 4418 4419
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
4420 4421
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
4422 4423 4424 4425
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
4426
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4427 4428 4429
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4430
static bool
4431 4432
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4433
    bool ret = false;
4434 4435 4436 4437 4438
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
4439
    int flags = VIR_INTERFACE_XML_INACTIVE;
4440

4441
    if (!vshConnectionUsability(ctl, ctl->conn))
4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467
        goto cleanup;

    iface = vshCommandOptInterface (ctl, cmd, NULL);
    if (iface == NULL)
        goto cleanup;

    /* Get the XML configuration of the interface. */
    doc = virInterfaceGetXMLDesc (iface, flags);
    if (!doc)
        goto cleanup;

    /* Create and open the temporary file. */
    tmp = editWriteToTempFile (ctl, doc);
    if (!tmp) goto cleanup;

    /* Start the editor. */
    if (editFile (ctl, tmp) == -1) goto cleanup;

    /* Read back the edited file. */
    doc_edited = editReadBackFile (ctl, tmp);
    if (!doc_edited) goto cleanup;

    /* Compare original XML with edited.  Has it changed at all? */
    if (STREQ (doc, doc_edited)) {
        vshPrint (ctl, _("Interface %s XML configuration not changed.\n"),
                  virInterfaceGetName (iface));
E
Eric Blake 已提交
4468
        ret = true;
4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480
        goto cleanup;
    }

    /* Now re-read the interface XML.  Did someone else change it while
     * it was being edited?  This also catches problems such as us
     * losing a connection or the interface going away.
     */
    doc_reread = virInterfaceGetXMLDesc (iface, flags);
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
4481 4482
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494
        goto cleanup;
    }

    /* Everything checks out, so redefine the interface. */
    virInterfaceFree (iface);
    iface = virInterfaceDefineXML (ctl->conn, doc_edited, 0);
    if (!iface)
        goto cleanup;

    vshPrint (ctl, _("Interface %s XML configuration edited.\n"),
              virInterfaceGetName(iface));

E
Eric Blake 已提交
4495
    ret = true;
4496 4497 4498 4499 4500

cleanup:
    if (iface)
        virInterfaceFree (iface);

4501 4502 4503
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
4504 4505 4506

    if (tmp) {
        unlink (tmp);
4507
        VIR_FREE(tmp);
4508 4509 4510 4511 4512
    }

    return ret;
}

4513 4514 4515
/*
 * "net-list" command
 */
4516
static const vshCmdInfo info_network_list[] = {
4517 4518
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
4519 4520 4521
    {NULL, NULL}
};

4522
static const vshCmdOptDef opts_network_list[] = {
4523 4524
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
4525 4526 4527
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4528
static bool
4529
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4530 4531 4532 4533 4534
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
4535
    char **activeNames = NULL, **inactiveNames = NULL;
4536 4537
    inactive |= all;

4538
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4539
        return false;
4540 4541

    if (active) {
4542 4543
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
4544
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
4545
            return false;
4546
        }
4547
        if (maxactive) {
4548
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
4549

4550
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
4551
                                                    maxactive)) < 0) {
4552
                vshError(ctl, "%s", _("Failed to list active networks"));
4553
                VIR_FREE(activeNames);
E
Eric Blake 已提交
4554
                return false;
4555
            }
4556

4557
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
4558
        }
4559 4560
    }
    if (inactive) {
4561 4562
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
4563
            vshError(ctl, "%s", _("Failed to list inactive networks"));
4564
            VIR_FREE(activeNames);
E
Eric Blake 已提交
4565
            return false;
4566
        }
4567 4568 4569
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4570 4571 4572
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
4573
                vshError(ctl, "%s", _("Failed to list inactive networks"));
4574 4575
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4576
                return false;
4577
            }
4578

4579 4580
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
4581
    }
4582 4583
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
4584
    vshPrintExtra(ctl, "-----------------------------------------\n");
4585 4586

    for (i = 0; i < maxactive; i++) {
4587 4588
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
4589 4590
        const char *autostartStr;
        int autostart = 0;
4591 4592 4593

        /* this kind of work with networks is not atomic operation */
        if (!network) {
4594
            VIR_FREE(activeNames[i]);
4595
            continue;
4596
        }
4597

4598 4599 4600
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
4601
            autostartStr = autostart ? _("yes") : _("no");
4602 4603 4604 4605 4606

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
4607
        virNetworkFree(network);
4608
        VIR_FREE(activeNames[i]);
4609 4610 4611
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
4612 4613
        const char *autostartStr;
        int autostart = 0;
4614 4615 4616

        /* this kind of work with networks is not atomic operation */
        if (!network) {
4617
            VIR_FREE(inactiveNames[i]);
4618
            continue;
4619
        }
4620

4621 4622 4623
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
4624
            autostartStr = autostart ? _("yes") : _("no");
4625

4626
        vshPrint(ctl, "%-20s %-10s %-10s\n",
4627 4628 4629
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
4630 4631

        virNetworkFree(network);
4632
        VIR_FREE(inactiveNames[i]);
4633
    }
4634 4635
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4636
    return true;
4637 4638 4639 4640 4641 4642
}


/*
 * "net-name" command
 */
4643
static const vshCmdInfo info_network_name[] = {
4644
    {"help", N_("convert a network UUID to network name")},
4645
    {"desc", ""},
4646 4647 4648
    {NULL, NULL}
};

4649
static const vshCmdOptDef opts_network_name[] = {
4650
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
4651 4652 4653
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4654
static bool
4655
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
4656 4657 4658
{
    virNetworkPtr network;

4659
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4660
        return false;
J
Jim Meyering 已提交
4661
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4662
                                           VSH_BYUUID)))
E
Eric Blake 已提交
4663
        return false;
4664 4665 4666

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
4667
    return true;
4668 4669 4670 4671 4672 4673
}


/*
 * "net-start" command
 */
4674
static const vshCmdInfo info_network_start[] = {
4675 4676
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
4677 4678 4679
    {NULL, NULL}
};

4680
static const vshCmdOptDef opts_network_start[] = {
4681
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
4682 4683 4684
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4685
static bool
4686
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
4687 4688
{
    virNetworkPtr network;
E
Eric Blake 已提交
4689
    bool ret = true;
4690

4691
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4692
        return false;
4693

J
Jim Meyering 已提交
4694
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
4695
         return false;
4696 4697 4698

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
4699
                 virNetworkGetName(network));
4700
    } else {
4701
        vshError(ctl, _("Failed to start network %s"),
4702
                 virNetworkGetName(network));
E
Eric Blake 已提交
4703
        ret = false;
4704
    }
L
Laine Stump 已提交
4705
    virNetworkFree(network);
4706 4707 4708 4709 4710 4711 4712
    return ret;
}


/*
 * "net-undefine" command
 */
4713
static const vshCmdInfo info_network_undefine[] = {
4714 4715
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
4716 4717 4718
    {NULL, NULL}
};

4719
static const vshCmdOptDef opts_network_undefine[] = {
4720
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4721 4722 4723
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4724
static bool
4725
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
4726 4727
{
    virNetworkPtr network;
E
Eric Blake 已提交
4728
    bool ret = true;
4729
    const char *name;
4730

4731
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4732
        return false;
4733

J
Jim Meyering 已提交
4734
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4735
        return false;
4736 4737 4738 4739

    if (virNetworkUndefine(network) == 0) {
        vshPrint(ctl, _("Network %s has been undefined\n"), name);
    } else {
4740
        vshError(ctl, _("Failed to undefine network %s"), name);
E
Eric Blake 已提交
4741
        ret = false;
4742 4743
    }

L
Laine Stump 已提交
4744
    virNetworkFree(network);
4745 4746 4747 4748 4749 4750 4751
    return ret;
}


/*
 * "net-uuid" command
 */
4752
static const vshCmdInfo info_network_uuid[] = {
4753
    {"help", N_("convert a network name to network UUID")},
4754
    {"desc", ""},
4755 4756 4757
    {NULL, NULL}
};

4758
static const vshCmdOptDef opts_network_uuid[] = {
4759
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
4760 4761 4762
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4763
static bool
4764
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
4765 4766 4767 4768
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

4769
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4770
        return false;
4771

J
Jim Meyering 已提交
4772
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4773
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4774
        return false;
4775 4776 4777 4778

    if (virNetworkGetUUIDString(network, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
4779
        vshError(ctl, "%s", _("failed to get network UUID"));
4780

L
Laine Stump 已提交
4781
    virNetworkFree(network);
E
Eric Blake 已提交
4782
    return true;
4783 4784 4785
}


4786 4787 4788 4789 4790
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
4791 4792
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
4793 4794 4795 4796
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
4797 4798
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
4799 4800
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
4801
static bool
4802 4803 4804 4805 4806 4807 4808 4809 4810
cmdInterfaceList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
    char **activeNames = NULL, **inactiveNames = NULL;
    inactive |= all;

4811
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4812
        return false;
4813 4814 4815 4816

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
4817
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
4818
            return false;
4819 4820 4821 4822 4823 4824
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
4825
                vshError(ctl, "%s", _("Failed to list active interfaces"));
4826
                VIR_FREE(activeNames);
E
Eric Blake 已提交
4827
                return false;
4828 4829 4830 4831 4832 4833 4834 4835
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
4836
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4837
            VIR_FREE(activeNames);
E
Eric Blake 已提交
4838
            return false;
4839 4840 4841 4842
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4843 4844 4845
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
4846
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4847 4848
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4849
                return false;
4850 4851 4852 4853 4854
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
4855 4856
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
4857 4858 4859
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
4860 4861
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
4862 4863 4864

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4865
            VIR_FREE(activeNames[i]);
4866 4867 4868 4869 4870 4871 4872 4873
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4874
        VIR_FREE(activeNames[i]);
4875 4876
    }
    for (i = 0; i < maxinactive; i++) {
4877 4878
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
4879 4880 4881

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4882
            VIR_FREE(inactiveNames[i]);
4883 4884 4885 4886 4887 4888 4889 4890
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4891
        VIR_FREE(inactiveNames[i]);
4892
    }
4893 4894
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4895
    return true;
4896 4897 4898 4899 4900 4901 4902

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
4903
    {"help", N_("convert an interface MAC address to interface name")},
4904 4905 4906 4907 4908
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
4909
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
4910 4911 4912
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4913
static bool
4914 4915 4916 4917
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

4918
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4919
        return false;
4920 4921
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
4922
        return false;
4923 4924 4925

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
4926
    return true;
4927 4928 4929 4930 4931 4932
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
4933
    {"help", N_("convert an interface name to interface MAC address")},
4934 4935 4936 4937 4938
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
4939
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
4940 4941 4942
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4943
static bool
4944 4945 4946 4947
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

4948
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4949
        return false;
4950 4951
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4952
        return false;
4953 4954 4955

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
4956
    return true;
4957 4958 4959 4960 4961 4962
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
4963 4964
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
4965 4966 4967 4968
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
4969 4970
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
4971 4972 4973
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4974
static bool
4975 4976 4977
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
4978
    bool ret = true;
4979
    char *dump;
4980 4981 4982 4983 4984
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
4985

4986
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4987
        return false;
4988 4989

    if (!(iface = vshCommandOptInterface(ctl, cmd, NULL)))
E
Eric Blake 已提交
4990
        return false;
4991

4992
    dump = virInterfaceGetXMLDesc(iface, flags);
4993
    if (dump != NULL) {
4994
        vshPrint(ctl, "%s", dump);
4995
        VIR_FREE(dump);
4996
    } else {
E
Eric Blake 已提交
4997
        ret = false;
4998 4999 5000 5001 5002 5003 5004 5005 5006 5007
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
5008 5009
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
5010 5011 5012 5013
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
5014
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
5015 5016 5017
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5018
static bool
5019 5020
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
5021
    virInterfacePtr iface;
5022
    const char *from = NULL;
E
Eric Blake 已提交
5023
    bool ret = true;
5024 5025
    char *buffer;

5026
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5027
        return false;
5028

5029
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5030
        return false;
5031 5032

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5033
        return false;
5034

5035
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
5036
    VIR_FREE(buffer);
5037

5038
    if (iface != NULL) {
5039
        vshPrint(ctl, _("Interface %s defined from %s\n"),
5040
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
5041
        virInterfaceFree (iface);
5042
    } else {
5043
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
5044
        ret = false;
5045 5046 5047 5048 5049 5050 5051 5052
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
5053 5054
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
5055 5056 5057 5058
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
5059
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5060 5061 5062
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5063
static bool
5064 5065 5066
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5067
    bool ret = true;
5068
    const char *name;
5069

5070
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5071
        return false;
5072 5073

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5074
        return false;
5075 5076 5077 5078

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
5079
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
5080
        ret = false;
5081 5082 5083 5084 5085 5086 5087 5088 5089 5090
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
5091 5092
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
5093 5094 5095 5096
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
5097
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5098 5099 5100
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5101
static bool
5102 5103 5104
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5105
    bool ret = true;
5106
    const char *name;
5107

5108
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5109
        return false;
5110 5111

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5112
        return false;
5113 5114 5115 5116

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
5117
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
5118
        ret = false;
5119 5120 5121 5122 5123 5124 5125 5126 5127 5128
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
5129 5130
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
    {"desc", N_("destroy a physical host interface.")},
5131 5132 5133 5134
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
5135
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5136 5137 5138
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5139
static bool
5140 5141 5142
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5143
    bool ret = true;
5144
    const char *name;
5145

5146
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5147
        return false;
5148 5149

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5150
        return false;
5151 5152 5153 5154

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
5155
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
5156
        ret = false;
5157 5158 5159 5160 5161 5162
    }

    virInterfaceFree(iface);
    return ret;
}

5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247
/*
 * "iface-begin" command
 */
static const vshCmdInfo info_interface_begin[] = {
    {"help", N_("create a snapshot of current interfaces settings, "
                "which can be later commited (iface-commit) or "
                "restored (iface-rollback)")},
    {"desc", N_("Create a restore point for interfaces settings")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_begin[] = {
    {NULL, 0, 0, NULL}
};

static bool
cmdInterfaceBegin(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    if (!vshConnectionUsability(ctl, ctl->conn))
        return false;

    if (virInterfaceChangeBegin(ctl->conn, 0) < 0) {
        vshError(ctl, "%s", _("Failed to begin network config change transaction"));
        return false;
    }

    vshPrint(ctl, "%s", _("Network config change transaction started\n"));
    return true;
}

/*
 * "iface-commit" command
 */
static const vshCmdInfo info_interface_commit[] = {
    {"help", N_("commit changes made since iface-begin and free restore point")},
    {"desc", N_("commit changes and free restore point")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_commit[] = {
    {NULL, 0, 0, NULL}
};

static bool
cmdInterfaceCommit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    if (!vshConnectionUsability(ctl, ctl->conn))
        return false;

    if (virInterfaceChangeCommit(ctl->conn, 0) < 0) {
        vshError(ctl, "%s", _("Failed to commit network config change transaction"));
        return false;
    }

    vshPrint(ctl, "%s", _("Network config change transaction committed\n"));
    return true;
}

/*
 * "iface-rollback" command
 */
static const vshCmdInfo info_interface_rollback[] = {
    {"help", N_("rollback to previous saved configuration created via iface-begin")},
    {"desc", N_("rollback to previous restore point")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_rollback[] = {
    {NULL, 0, 0, NULL}
};

static bool
cmdInterfaceRollback(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    if (!vshConnectionUsability(ctl, ctl->conn))
        return false;

    if (virInterfaceChangeRollback(ctl->conn, 0) < 0) {
        vshError(ctl, "%s", _("Failed to rollback network config change transaction"));
        return false;
    }

    vshPrint(ctl, "%s", _("Network config change transaction rolled back\n"));
    return true;
}
5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262

/*
 * "nwfilter-define" command
 */
static const vshCmdInfo info_nwfilter_define[] = {
    {"help", N_("define or update a network filter from an XML file")},
    {"desc", N_("Define a new network filter or update an existing one.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_nwfilter_define[] = {
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network filter description")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5263
static bool
5264 5265 5266
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
5267
    const char *from = NULL;
E
Eric Blake 已提交
5268
    bool ret = true;
5269 5270
    char *buffer;

5271
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5272
        return false;
5273

5274
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5275
        return false;
5276 5277

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5278
        return false;
5279 5280 5281 5282 5283 5284 5285 5286 5287 5288

    nwfilter = virNWFilterDefineXML(ctl->conn, buffer);
    VIR_FREE(buffer);

    if (nwfilter != NULL) {
        vshPrint(ctl, _("Network filter %s defined from %s\n"),
                 virNWFilterGetName(nwfilter), from);
        virNWFilterFree(nwfilter);
    } else {
        vshError(ctl, _("Failed to define network filter from %s"), from);
E
Eric Blake 已提交
5289
        ret = false;
5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308
    }
    return ret;
}


/*
 * "nwfilter-undefine" command
 */
static const vshCmdInfo info_nwfilter_undefine[] = {
    {"help", N_("undefine a network filter")},
    {"desc", N_("Undefine a given network filter.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_nwfilter_undefine[] = {
    {"nwfilter", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network filter name or uuid")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5309
static bool
5310 5311 5312
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5313
    bool ret = true;
5314
    const char *name;
5315

5316
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5317
        return false;
5318 5319

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
5320
        return false;
5321 5322 5323 5324 5325

    if (virNWFilterUndefine(nwfilter) == 0) {
        vshPrint(ctl, _("Network filter %s undefined\n"), name);
    } else {
        vshError(ctl, _("Failed to undefine network filter %s"), name);
E
Eric Blake 已提交
5326
        ret = false;
5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347
    }

    virNWFilterFree(nwfilter);
    return ret;
}


/*
 * "nwfilter-dumpxml" command
 */
static const vshCmdInfo info_nwfilter_dumpxml[] = {
    {"help", N_("network filter information in XML")},
    {"desc", N_("Output the network filter information as an XML dump to stdout.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_nwfilter_dumpxml[] = {
    {"nwfilter", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network filter name or uuid")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5348
static bool
5349 5350 5351
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5352
    bool ret = true;
5353 5354
    char *dump;

5355
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5356
        return false;
5357 5358

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
5359
        return false;
5360 5361 5362

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
5363
        vshPrint(ctl, "%s", dump);
5364 5365
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
5366
        ret = false;
5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385
    }

    virNWFilterFree(nwfilter);
    return ret;
}

/*
 * "nwfilter-list" command
 */
static const vshCmdInfo info_nwfilter_list[] = {
    {"help", N_("list network filters")},
    {"desc", N_("Returns list of network filters.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_nwfilter_list[] = {
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5386
static bool
5387 5388 5389 5390 5391 5392
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

5393
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5394
        return false;
5395 5396 5397 5398

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
5399
        return false;
5400 5401 5402 5403 5404 5405 5406 5407
    }

    names = vshMalloc(ctl, sizeof(char *) * numfilters);

    if ((numfilters = virConnectListNWFilters(ctl->conn, names,
                                              numfilters)) < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
        VIR_FREE(names);
E
Eric Blake 已提交
5408
        return false;
5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435
    }

    qsort(&names[0], numfilters, sizeof(char *), namesorter);

    vshPrintExtra(ctl, "%-36s  %-20s \n", _("UUID"), _("Name"));
    vshPrintExtra(ctl,
       "----------------------------------------------------------------\n");

    for (i = 0; i < numfilters; i++) {
        virNWFilterPtr nwfilter =
            virNWFilterLookupByName(ctl->conn, names[i]);

        /* this kind of work with networks is not atomic operation */
        if (!nwfilter) {
            VIR_FREE(names[i]);
            continue;
        }

        virNWFilterGetUUIDString(nwfilter, uuid);
        vshPrint(ctl, "%-36s  %-20s\n",
                 uuid,
                 virNWFilterGetName(nwfilter));
        virNWFilterFree(nwfilter);
        VIR_FREE(names[i]);
    }

    VIR_FREE(names);
E
Eric Blake 已提交
5436
    return true;
5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453
}


/*
 * "nwfilter-edit" command
 */
static const vshCmdInfo info_nwfilter_edit[] = {
    {"help", N_("edit XML configuration for a network filter")},
    {"desc", N_("Edit the XML configuration for a network filter.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_nwfilter_edit[] = {
    {"nwfilter", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network filter name or uuid")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5454
static bool
5455 5456
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5457
    bool ret = false;
5458 5459 5460 5461 5462 5463
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

5464
    if (!vshConnectionUsability(ctl, ctl->conn))
5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490
        goto cleanup;

    nwfilter = vshCommandOptNWFilter (ctl, cmd, NULL);
    if (nwfilter == NULL)
        goto cleanup;

    /* Get the XML configuration of the interface. */
    doc = virNWFilterGetXMLDesc (nwfilter, 0);
    if (!doc)
        goto cleanup;

    /* Create and open the temporary file. */
    tmp = editWriteToTempFile (ctl, doc);
    if (!tmp) goto cleanup;

    /* Start the editor. */
    if (editFile (ctl, tmp) == -1) goto cleanup;

    /* Read back the edited file. */
    doc_edited = editReadBackFile (ctl, tmp);
    if (!doc_edited) goto cleanup;

    /* Compare original XML with edited.  Has it changed at all? */
    if (STREQ (doc, doc_edited)) {
        vshPrint (ctl, _("Network filter %s XML configuration not changed.\n"),
                  virNWFilterGetName (nwfilter));
E
Eric Blake 已提交
5491
        ret = true;
5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517
        goto cleanup;
    }

    /* Now re-read the network filter XML.  Did someone else change it while
     * it was being edited?  This also catches problems such as us
     * losing a connection or the interface going away.
     */
    doc_reread = virNWFilterGetXMLDesc (nwfilter, 0);
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
        goto cleanup;
    }

    /* Everything checks out, so redefine the interface. */
    virNWFilterFree (nwfilter);
    nwfilter = virNWFilterDefineXML (ctl->conn, doc_edited);
    if (!nwfilter)
        goto cleanup;

    vshPrint (ctl, _("Network filter %s XML configuration edited.\n"),
              virNWFilterGetName(nwfilter));

E
Eric Blake 已提交
5518
    ret = true;
5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536

cleanup:
    if (nwfilter)
        virNWFilterFree (nwfilter);

    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);

    if (tmp) {
        unlink (tmp);
        VIR_FREE(tmp);
    }

    return ret;
}


5537
/**************************************************************************/
5538
/*
5539
 * "pool-autostart" command
5540
 */
5541
static const vshCmdInfo info_pool_autostart[] = {
5542
    {"help", N_("autostart a pool")},
5543
    {"desc",
5544
     N_("Configure a pool to be automatically started at boot.")},
5545
    {NULL, NULL}
5546 5547
};

5548
static const vshCmdOptDef opts_pool_autostart[] = {
5549 5550
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5551 5552
    {NULL, 0, 0, NULL}
};
5553

E
Eric Blake 已提交
5554
static bool
5555
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
5556
{
5557
    virStoragePoolPtr pool;
5558
    const char *name;
5559
    int autostart;
5560

5561
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5562
        return false;
5563

5564
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5565
        return false;
5566

5567
    autostart = !vshCommandOptBool(cmd, "disable");
5568

5569 5570
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
5571
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
5572
        else
5573
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
5574
        virStoragePoolFree(pool);
E
Eric Blake 已提交
5575
        return false;
5576 5577
    }

5578
    if (autostart)
5579
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
5580
    else
5581
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
5582

L
Laine Stump 已提交
5583
    virStoragePoolFree(pool);
E
Eric Blake 已提交
5584
    return true;
5585 5586
}

5587
/*
5588
 * "pool-create" command
5589
 */
5590
static const vshCmdInfo info_pool_create[] = {
5591 5592
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
5593 5594 5595
    {NULL, NULL}
};

5596
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
5597
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
5598
     N_("file containing an XML pool description")},
5599 5600 5601
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5602
static bool
5603
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
5604
{
5605
    virStoragePoolPtr pool;
5606
    const char *from = NULL;
E
Eric Blake 已提交
5607
    bool ret = true;
5608
    char *buffer;
5609

5610
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5611
        return false;
5612

5613
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5614
        return false;
5615

5616
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5617
        return false;
5618

5619
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
5620
    VIR_FREE(buffer);
5621 5622 5623 5624

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5625
        virStoragePoolFree(pool);
5626
    } else {
5627
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
5628
        ret = false;
5629 5630
    }
    return ret;
5631 5632
}

5633

5634 5635 5636 5637
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
5638
    {"help", N_("create a device defined "
5639
                          "by an XML file on the node")},
5640
    {"desc", N_("Create a device on the node.  Note that this "
5641 5642 5643 5644 5645 5646 5647
                          "command creates devices on the physical host "
                          "that can then be assigned to a virtual machine.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_create[] = {
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
5648
     N_("file containing an XML description of the device")},
5649 5650 5651
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5652
static bool
5653 5654 5655
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
5656
    const char *from = NULL;
E
Eric Blake 已提交
5657
    bool ret = true;
5658 5659
    char *buffer;

5660
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5661
        return false;
5662

5663
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5664
        return false;
5665

5666
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5667
        return false;
5668 5669

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
5670
    VIR_FREE(buffer);
5671 5672 5673 5674

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
5675
        virNodeDeviceFree(dev);
5676
    } else {
5677
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
5678
        ret = false;
5679 5680 5681 5682 5683 5684 5685 5686 5687 5688
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
5689 5690
    {"help", N_("destroy a device on the node")},
    {"desc", N_("Destroy a device on the node.  Note that this "
5691 5692 5693 5694 5695 5696
                          "command destroys devices on the physical host ")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
5697
     N_("name of the device to be destroyed")},
5698 5699 5700
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5701
static bool
5702 5703 5704
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
5705
    bool ret = true;
5706
    const char *name = NULL;
5707

5708
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
5709
        return false;
5710 5711
    }

5712
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
5713
        return false;
5714 5715 5716 5717 5718 5719

    dev = virNodeDeviceLookupByName(ctl->conn, name);

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
5720
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
5721
        ret = false;
5722 5723 5724 5725 5726 5727 5728
    }

    virNodeDeviceFree(dev);
    return ret;
}


5729
/*
5730
 * XML Building helper for pool-define-as and pool-create-as
5731
 */
5732
static const vshCmdOptDef opts_pool_X_as[] = {
5733 5734 5735 5736 5737 5738 5739 5740
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the pool")},
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document, but don't define/create")},
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ, N_("type of the pool")},
    {"source-host", VSH_OT_DATA, 0, N_("source-host for underlying storage")},
    {"source-path", VSH_OT_DATA, 0, N_("source path for underlying storage")},
    {"source-dev", VSH_OT_DATA, 0, N_("source device for underlying storage")},
    {"source-name", VSH_OT_DATA, 0, N_("source name for underlying storage")},
    {"target", VSH_OT_DATA, 0, N_("target for underlying storage")},
5741
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
5742 5743 5744
    {NULL, 0, 0, NULL}
};

5745
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
5746

5747 5748
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
5749
    virBuffer buf = VIR_BUFFER_INITIALIZER;
5750

5751
    if (vshCommandOptString(cmd, "name", &name) <= 0)
5752
        goto cleanup;
5753
    if (vshCommandOptString(cmd, "type", &type) <= 0)
5754 5755
        goto cleanup;

5756 5757 5758 5759 5760
    if (vshCommandOptString(cmd, "source-host", &srcHost) < 0 ||
        vshCommandOptString(cmd, "source-path", &srcPath) < 0 ||
        vshCommandOptString(cmd, "source-dev", &srcDev) < 0 ||
        vshCommandOptString(cmd, "source-name", &srcName) < 0 ||
        vshCommandOptString(cmd, "source-format", &srcFormat) < 0 ||
5761 5762
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
5763
        goto cleanup;
5764
    }
5765

5766 5767
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
5768
    if (srcHost || srcPath || srcDev) {
5769
        virBufferAddLit(&buf, "  <source>\n");
5770

5771
        if (srcHost)
5772
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
5773
        if (srcPath)
5774
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
5775
        if (srcDev)
5776
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
5777
        if (srcFormat)
5778
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
5779
        if (srcName)
5780
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
5781 5782

        virBufferAddLit(&buf, "  </source>\n");
5783 5784
    }
    if (target) {
5785
        virBufferAddLit(&buf, "  <target>\n");
5786
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
5787
        virBufferAddLit(&buf, "  </target>\n");
5788
    }
5789 5790 5791 5792
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
5793
        return false;
5794
    }
5795 5796 5797

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
5798
    return true;
5799 5800

cleanup:
5801
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
5802
    return false;
5803 5804 5805 5806 5807 5808
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
5809 5810
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
5811 5812 5813
    {NULL, NULL}
};

E
Eric Blake 已提交
5814
static bool
5815 5816 5817
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
5818 5819
    const char *name;
    char *xml;
5820
    int printXML = vshCommandOptBool(cmd, "print-xml");
5821

5822
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5823
        return false;
5824 5825

    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
5826
        return false;
5827

5828
    if (printXML) {
5829
        vshPrint(ctl, "%s", xml);
5830
        VIR_FREE(xml);
5831
    } else {
5832
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
5833
        VIR_FREE(xml);
5834

5835 5836 5837 5838
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
5839
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
5840
            return false;
5841 5842
        }
    }
E
Eric Blake 已提交
5843
    return true;
5844 5845
}

5846

5847
/*
5848
 * "pool-define" command
5849
 */
5850
static const vshCmdInfo info_pool_define[] = {
5851 5852
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
5853 5854 5855
    {NULL, NULL}
};

5856
static const vshCmdOptDef opts_pool_define[] = {
5857
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
5858 5859 5860
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5861
static bool
5862
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
5863
{
5864
    virStoragePoolPtr pool;
5865
    const char *from = NULL;
E
Eric Blake 已提交
5866
    bool ret = true;
5867
    char *buffer;
5868

5869
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5870
        return false;
5871

5872
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5873
        return false;
5874

5875
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5876
        return false;
5877

5878
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
5879
    VIR_FREE(buffer);
5880 5881 5882 5883

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5884
        virStoragePoolFree(pool);
5885
    } else {
5886
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
5887
        ret = false;
5888 5889
    }
    return ret;
5890 5891
}

5892

5893 5894 5895
/*
 * "pool-define-as" command
 */
5896
static const vshCmdInfo info_pool_define_as[] = {
5897 5898
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
5899 5900 5901
    {NULL, NULL}
};

E
Eric Blake 已提交
5902
static bool
5903
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
5904 5905
{
    virStoragePoolPtr pool;
5906 5907
    const char *name;
    char *xml;
5908
    int printXML = vshCommandOptBool(cmd, "print-xml");
5909

5910
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5911
        return false;
5912

5913
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
5914
        return false;
5915

5916
    if (printXML) {
5917
        vshPrint(ctl, "%s", xml);
5918
        VIR_FREE(xml);
5919
    } else {
5920
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
5921
        VIR_FREE(xml);
5922

5923 5924 5925 5926
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
5927
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
5928
            return false;
5929 5930
        }
    }
E
Eric Blake 已提交
5931
    return true;
5932 5933 5934
}


5935
/*
5936
 * "pool-build" command
5937
 */
5938
static const vshCmdInfo info_pool_build[] = {
5939 5940
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
5941 5942 5943
    {NULL, NULL}
};

5944
static const vshCmdOptDef opts_pool_build[] = {
5945
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5946 5947 5948
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5949
static bool
5950
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
5951
{
5952
    virStoragePoolPtr pool;
E
Eric Blake 已提交
5953
    bool ret = true;
5954
    const char *name;
5955

5956
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5957
        return false;
5958

5959
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5960
        return false;
5961

5962
    if (virStoragePoolBuild(pool, 0) == 0) {
5963
        vshPrint(ctl, _("Pool %s built\n"), name);
5964
    } else {
5965
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
5966
        ret = false;
5967 5968
    }

5969 5970
    virStoragePoolFree(pool);

5971 5972 5973
    return ret;
}

5974

5975
/*
5976
 * "pool-destroy" command
5977
 */
5978
static const vshCmdInfo info_pool_destroy[] = {
5979 5980
    {"help", N_("destroy a pool")},
    {"desc", N_("Destroy a given pool.")},
5981 5982 5983
    {NULL, NULL}
};

5984
static const vshCmdOptDef opts_pool_destroy[] = {
5985
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5986 5987 5988
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5989
static bool
5990
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
5991
{
5992
    virStoragePoolPtr pool;
E
Eric Blake 已提交
5993
    bool ret = true;
5994
    const char *name;
5995

5996
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5997
        return false;
5998

5999
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6000
        return false;
6001

6002 6003 6004
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
6005
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
6006
        ret = false;
6007 6008
    }

6009
    virStoragePoolFree(pool);
6010 6011 6012
    return ret;
}

6013

6014
/*
6015 6016
 * "pool-delete" command
 */
6017
static const vshCmdInfo info_pool_delete[] = {
6018 6019
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
6020 6021 6022
    {NULL, NULL}
};

6023
static const vshCmdOptDef opts_pool_delete[] = {
6024
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6025 6026 6027
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6028
static bool
6029
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
6030 6031
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6032
    bool ret = true;
6033
    const char *name;
6034

6035
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6036
        return false;
6037 6038

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6039
        return false;
6040 6041

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
6042
        vshPrint(ctl, _("Pool %s deleted\n"), name);
6043
    } else {
6044
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
6045
        ret = false;
6046 6047
    }

L
Laine Stump 已提交
6048
    virStoragePoolFree(pool);
6049 6050 6051 6052 6053 6054 6055
    return ret;
}


/*
 * "pool-refresh" command
 */
6056
static const vshCmdInfo info_pool_refresh[] = {
6057 6058
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
6059 6060 6061
    {NULL, NULL}
};

6062
static const vshCmdOptDef opts_pool_refresh[] = {
6063
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6064 6065 6066
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6067
static bool
6068
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
6069 6070
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6071
    bool ret = true;
6072
    const char *name;
6073

6074
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6075
        return false;
6076 6077

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6078
        return false;
6079 6080 6081 6082

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
6083
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
6084
        ret = false;
6085 6086 6087 6088 6089 6090 6091 6092 6093 6094
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
6095
static const vshCmdInfo info_pool_dumpxml[] = {
6096 6097
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
6098 6099 6100
    {NULL, NULL}
};

6101
static const vshCmdOptDef opts_pool_dumpxml[] = {
6102
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6103 6104 6105
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6106
static bool
6107
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
6108 6109
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6110
    bool ret = true;
6111 6112
    char *dump;

6113
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6114
        return false;
6115 6116

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6117
        return false;
6118 6119 6120

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
6121
        vshPrint(ctl, "%s", dump);
6122
        VIR_FREE(dump);
6123
    } else {
E
Eric Blake 已提交
6124
        ret = false;
6125 6126 6127 6128 6129 6130 6131 6132 6133 6134
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
6135
static const vshCmdInfo info_pool_list[] = {
6136 6137
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
6138 6139 6140
    {NULL, NULL}
};

6141
static const vshCmdOptDef opts_pool_list[] = {
6142 6143
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
6144
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
6145 6146 6147
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6148
static bool
6149
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6150
{
6151 6152
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
6153 6154
    int i, ret;
    bool functionReturn;
6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170
    int numActivePools = 0, numInactivePools = 0, numAllPools = 0;
    size_t stringLength = 0, nameStrLength = 0;
    size_t autostartStrLength = 0, persistStrLength = 0;
    size_t stateStrLength = 0, capStrLength = 0;
    size_t allocStrLength = 0, availStrLength = 0;
    struct poolInfoText {
        char *state;
        char *autostart;
        char *persistent;
        char *capacity;
        char *allocation;
        char *available;
    };
    struct poolInfoText *poolInfoTexts = NULL;

    /* Determine the options passed by the user */
6171
    int all = vshCommandOptBool(cmd, "all");
6172 6173
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
6174 6175 6176
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

6177
    /* Check the connection to libvirtd daemon is still working */
6178
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6179
        return false;
6180

6181
    /* Retrieve the number of active storage pools */
6182
    if (active) {
6183 6184
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
6185
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
6186
            return false;
6187 6188
        }
    }
6189 6190

    /* Retrieve the number of inactive storage pools */
6191
    if (inactive) {
6192 6193
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
6194
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
6195
            return false;
6196
        }
6197
    }
6198

6199 6200
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
6201

6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213
    /* Allocate memory for arrays of storage pool names and info */
    poolNames = vshCalloc(ctl, numAllPools, sizeof(*poolNames));
    poolInfoTexts =
        vshCalloc(ctl, numAllPools, sizeof(*poolInfoTexts));

    /* Retrieve a list of active storage pool names */
    if (active) {
        if ((virConnectListStoragePools(ctl->conn,
                                        poolNames, numActivePools)) < 0) {
            vshError(ctl, "%s", _("Failed to list active pools"));
            VIR_FREE(poolInfoTexts);
            VIR_FREE(poolNames);
E
Eric Blake 已提交
6214
            return false;
6215 6216 6217
        }
    }

6218 6219 6220 6221 6222 6223 6224 6225
    /* Add the inactive storage pools to the end of the name list */
    if (inactive) {
        if ((virConnectListDefinedStoragePools(ctl->conn,
                                               &poolNames[numActivePools],
                                               numInactivePools)) < 0) {
            vshError(ctl, "%s", _("Failed to list inactive pools"));
            VIR_FREE(poolInfoTexts);
            VIR_FREE(poolNames);
E
Eric Blake 已提交
6226
            return false;
6227 6228
        }
    }
6229

6230 6231 6232 6233 6234 6235 6236 6237 6238 6239
    /* Sort the storage pool names */
    qsort(poolNames, numAllPools, sizeof(*poolNames), namesorter);

    /* Collect the storage pool information for display */
    for (i = 0; i < numAllPools; i++) {
        int autostart = 0, persistent = 0;

        /* Retrieve a pool object, looking it up by name */
        virStoragePoolPtr pool = virStoragePoolLookupByName(ctl->conn,
                                                            poolNames[i]);
6240
        if (!pool) {
6241
            VIR_FREE(poolNames[i]);
6242 6243 6244
            continue;
        }

6245
        /* Retrieve the autostart status of the pool */
6246
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
6247
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
6248
        else
6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
            vshDebug(ctl, 5, "Persistent flag value: %d\n", persistent);
            if (persistent < 0)
                poolInfoTexts[i].persistent = vshStrdup(ctl, _("unknown"));
            else
                poolInfoTexts[i].persistent = vshStrdup(ctl, persistent ?
                                                         _("yes") : _("no"));

            /* Keep the length of persistent string if longest so far */
            stringLength = strlen(poolInfoTexts[i].persistent);
            if (stringLength > persistStrLength)
                persistStrLength = stringLength;
        }
6267

6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379
        /* Collect further extended information about the pool */
        if (virStoragePoolGetInfo(pool, &info) != 0) {
            /* Something went wrong retrieving pool info, cope with it */
            vshError(ctl, "%s", _("Could not retrieve pool information"));
            poolInfoTexts[i].state = vshStrdup(ctl, _("unknown"));
            if (details) {
                poolInfoTexts[i].capacity = vshStrdup(ctl, _("unknown"));
                poolInfoTexts[i].allocation = vshStrdup(ctl, _("unknown"));
                poolInfoTexts[i].available = vshStrdup(ctl, _("unknown"));
            }
        } else {
            /* Decide which state string to display */
            if (details) {
                /* --details option was specified, we're using detailed state
                 * strings */
                switch (info.state) {
                case VIR_STORAGE_POOL_INACTIVE:
                    poolInfoTexts[i].state = vshStrdup(ctl, _("inactive"));
                    break;
                case VIR_STORAGE_POOL_BUILDING:
                    poolInfoTexts[i].state = vshStrdup(ctl, _("building"));
                    break;
                case VIR_STORAGE_POOL_RUNNING:
                    poolInfoTexts[i].state = vshStrdup(ctl, _("running"));
                    break;
                case VIR_STORAGE_POOL_DEGRADED:
                    poolInfoTexts[i].state = vshStrdup(ctl, _("degraded"));
                    break;
                case VIR_STORAGE_POOL_INACCESSIBLE:
                    poolInfoTexts[i].state = vshStrdup(ctl, _("inaccessible"));
                    break;
                }

                /* Create the pool size related strings */
                if (info.state == VIR_STORAGE_POOL_RUNNING ||
                    info.state == VIR_STORAGE_POOL_DEGRADED) {
                    double val;
                    const char *unit;

                    /* Create the capacity output string */
                    val = prettyCapacity(info.capacity, &unit);
                    ret = virAsprintf(&poolInfoTexts[i].capacity,
                                      "%.2lf %s", val, unit);
                    if (ret < 0) {
                        /* An error occurred creating the string, return */
                        goto asprintf_failure;
                    }

                    /* Create the allocation output string */
                    val = prettyCapacity(info.allocation, &unit);
                    ret = virAsprintf(&poolInfoTexts[i].allocation,
                                      "%.2lf %s", val, unit);
                    if (ret < 0) {
                        /* An error occurred creating the string, return */
                        goto asprintf_failure;
                    }

                    /* Create the available space output string */
                    val = prettyCapacity(info.available, &unit);
                    ret = virAsprintf(&poolInfoTexts[i].available,
                                      "%.2lf %s", val, unit);
                    if (ret < 0) {
                        /* An error occurred creating the string, return */
                        goto asprintf_failure;
                    }
                } else {
                    /* Capacity related information isn't available */
                    poolInfoTexts[i].capacity = vshStrdup(ctl, _("-"));
                    poolInfoTexts[i].allocation = vshStrdup(ctl, _("-"));
                    poolInfoTexts[i].available = vshStrdup(ctl, _("-"));
                }

                /* Keep the length of capacity string if longest so far */
                stringLength = strlen(poolInfoTexts[i].capacity);
                if (stringLength > capStrLength)
                    capStrLength = stringLength;

                /* Keep the length of allocation string if longest so far */
                stringLength = strlen(poolInfoTexts[i].allocation);
                if (stringLength > allocStrLength)
                    allocStrLength = stringLength;

                /* Keep the length of available string if longest so far */
                stringLength = strlen(poolInfoTexts[i].available);
                if (stringLength > availStrLength)
                    availStrLength = stringLength;
            } else {
                /* --details option was not specified, only active/inactive
                * state strings are used */
                if (info.state == VIR_STORAGE_POOL_INACTIVE)
                    poolInfoTexts[i].state = vshStrdup(ctl, _("inactive"));
                else
                    poolInfoTexts[i].state = vshStrdup(ctl, _("active"));
            }
        }

        /* Keep the length of name string if longest so far */
        stringLength = strlen(poolNames[i]);
        if (stringLength > nameStrLength)
            nameStrLength = stringLength;

        /* Keep the length of state string if longest so far */
        stringLength = strlen(poolInfoTexts[i].state);
        if (stringLength > stateStrLength)
            stateStrLength = stringLength;

        /* Keep the length of autostart string if longest so far */
        stringLength = strlen(poolInfoTexts[i].autostart);
        if (stringLength > autostartStrLength)
            autostartStrLength = stringLength;

        /* Free the pool object */
6380 6381 6382
        virStoragePoolFree(pool);
    }

6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400
    /* If the --details option wasn't selected, we output the pool
     * info using the fixed string format from previous versions to
     * maintain backward compatibility.
     */

    /* Output basic info then return if --details option not selected */
    if (!details) {
        /* Output old style header */
        vshPrintExtra(ctl, "%-20s %-10s %-10s\n", _("Name"), _("State"),
                      _("Autostart"));
        vshPrintExtra(ctl, "-----------------------------------------\n");

        /* Output old style pool info */
        for (i = 0; i < numAllPools; i++) {
            vshPrint(ctl, "%-20s %-10s %-10s\n",
                 poolNames[i],
                 poolInfoTexts[i].state,
                 poolInfoTexts[i].autostart);
6401 6402
        }

6403
        /* Cleanup and return */
E
Eric Blake 已提交
6404
        functionReturn = true;
6405 6406
        goto cleanup;
    }
6407

6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501
    /* We only get here if the --details option was selected. */

    /* Use the length of name header string if it's longest */
    stringLength = strlen(_("Name"));
    if (stringLength > nameStrLength)
        nameStrLength = stringLength;

    /* Use the length of state header string if it's longest */
    stringLength = strlen(_("State"));
    if (stringLength > stateStrLength)
        stateStrLength = stringLength;

    /* Use the length of autostart header string if it's longest */
    stringLength = strlen(_("Autostart"));
    if (stringLength > autostartStrLength)
        autostartStrLength = stringLength;

    /* Use the length of persistent header string if it's longest */
    stringLength = strlen(_("Persistent"));
    if (stringLength > persistStrLength)
        persistStrLength = stringLength;

    /* Use the length of capacity header string if it's longest */
    stringLength = strlen(_("Capacity"));
    if (stringLength > capStrLength)
        capStrLength = stringLength;

    /* Use the length of allocation header string if it's longest */
    stringLength = strlen(_("Allocation"));
    if (stringLength > allocStrLength)
        allocStrLength = stringLength;

    /* Use the length of available header string if it's longest */
    stringLength = strlen(_("Available"));
    if (stringLength > availStrLength)
        availStrLength = stringLength;

    /* Display the string lengths for debugging. */
    vshDebug(ctl, 5, "Longest name string = %lu chars\n",
             (unsigned long) nameStrLength);
    vshDebug(ctl, 5, "Longest state string = %lu chars\n",
             (unsigned long) stateStrLength);
    vshDebug(ctl, 5, "Longest autostart string = %lu chars\n",
             (unsigned long) autostartStrLength);
    vshDebug(ctl, 5, "Longest persistent string = %lu chars\n",
             (unsigned long) persistStrLength);
    vshDebug(ctl, 5, "Longest capacity string = %lu chars\n",
             (unsigned long) capStrLength);
    vshDebug(ctl, 5, "Longest allocation string = %lu chars\n",
             (unsigned long) allocStrLength);
    vshDebug(ctl, 5, "Longest available string = %lu chars\n",
             (unsigned long) availStrLength);

    /* Create the output template.  Each column is sized according to
     * the longest string.
     */
    char *outputStr;
    ret = virAsprintf(&outputStr,
              "%%-%lus  %%-%lus  %%-%lus  %%-%lus  %%%lus  %%%lus  %%%lus\n",
              (unsigned long) nameStrLength,
              (unsigned long) stateStrLength,
              (unsigned long) autostartStrLength,
              (unsigned long) persistStrLength,
              (unsigned long) capStrLength,
              (unsigned long) allocStrLength,
              (unsigned long) availStrLength);
    if (ret < 0) {
        /* An error occurred creating the string, return */
        goto asprintf_failure;
    }

    /* Display the header */
    vshPrint(ctl, outputStr, _("Name"), _("State"), _("Autostart"),
             _("Persistent"), _("Capacity"), _("Allocation"), _("Available"));
    for (i = nameStrLength + stateStrLength + autostartStrLength
                           + persistStrLength + capStrLength
                           + allocStrLength + availStrLength
                           + 12; i > 0; i--)
        vshPrintExtra(ctl, "-");
    vshPrintExtra(ctl, "\n");

    /* Display the pool info rows */
    for (i = 0; i < numAllPools; i++) {
        vshPrint(ctl, outputStr,
                 poolNames[i],
                 poolInfoTexts[i].state,
                 poolInfoTexts[i].autostart,
                 poolInfoTexts[i].persistent,
                 poolInfoTexts[i].capacity,
                 poolInfoTexts[i].allocation,
                 poolInfoTexts[i].available);
    }

    /* Cleanup and return */
E
Eric Blake 已提交
6502
    functionReturn = true;
6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516
    goto cleanup;

asprintf_failure:

    /* Display an appropriate error message then cleanup and return */
    switch (errno) {
    case ENOMEM:
        /* Couldn't allocate memory */
        vshError(ctl, "%s", _("Out of memory"));
        break;
    default:
        /* Some other error */
        vshError(ctl, _("virAsprintf failed (errno %d)"), errno);
    }
E
Eric Blake 已提交
6517
    functionReturn = false;
6518

6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530
cleanup:

    /* Safely free the memory allocated in this function */
    for (i = 0; i < numAllPools; i++) {
        /* Cleanup the memory for one pool info structure */
        VIR_FREE(poolInfoTexts[i].state);
        VIR_FREE(poolInfoTexts[i].autostart);
        VIR_FREE(poolInfoTexts[i].persistent);
        VIR_FREE(poolInfoTexts[i].capacity);
        VIR_FREE(poolInfoTexts[i].allocation);
        VIR_FREE(poolInfoTexts[i].available);
        VIR_FREE(poolNames[i]);
6531
    }
6532 6533 6534 6535 6536 6537 6538

    /* Cleanup the memory for the initial arrays*/
    VIR_FREE(poolInfoTexts);
    VIR_FREE(poolNames);

    /* Return the desired value */
    return functionReturn;
6539 6540
}

6541 6542 6543 6544
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
6545 6546
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6547 6548 6549 6550 6551
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6552 6553 6554
     N_("type of storage pool sources to find")},
    {"host", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional host to query")},
    {"port", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional port to query")},
6555
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
6556 6557 6558
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6559
static bool
6560 6561
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6562
    const char *type = NULL, *host = NULL;
6563 6564
    char *srcSpec = NULL;
    char *srcList;
6565
    const char *initiator = NULL;
6566

6567 6568
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
6569 6570
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
6571
        return false;
6572
    }
6573

6574
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6575
        return false;
6576 6577

    if (host) {
6578
        const char *port = NULL;
6579
        virBuffer buf = VIR_BUFFER_INITIALIZER;
6580 6581 6582 6583

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6584
            return false;
6585
        }
6586
        virBufferAddLit(&buf, "<source>\n");
6587
        virBufferAsprintf(&buf, "  <host name='%s'", host);
6588
        if (port)
6589
            virBufferAsprintf(&buf, " port='%s'", port);
6590
        virBufferAddLit(&buf, "/>\n");
6591 6592
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
6593
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
6594 6595
            virBufferAddLit(&buf, "  </initiator>\n");
        }
6596 6597 6598
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
6599
            return false;
6600
        }
6601
        srcSpec = virBufferContentAndReset(&buf);
6602 6603 6604
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6605
    VIR_FREE(srcSpec);
6606
    if (srcList == NULL) {
6607
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
6608
        return false;
6609 6610
    }
    vshPrint(ctl, "%s", srcList);
6611
    VIR_FREE(srcList);
6612

E
Eric Blake 已提交
6613
    return true;
6614 6615 6616 6617 6618 6619 6620
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
6621 6622
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6623 6624 6625 6626 6627
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6628
     N_("type of storage pool sources to discover")},
6629
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
6630
     N_("optional file of source xml to query for pools")},
6631 6632 6633
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6634
static bool
6635 6636
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6637
    const char *type = NULL, *srcSpecFile = NULL;
6638
    char *srcSpec = NULL, *srcList;
6639

6640
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
6641
        return false;
6642

6643 6644
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
6645
        return false;
6646
    }
6647

6648
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6649
        return false;
6650 6651

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
6652
        return false;
6653 6654

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6655
    VIR_FREE(srcSpec);
6656
    if (srcList == NULL) {
6657
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
6658
        return false;
6659 6660
    }
    vshPrint(ctl, "%s", srcList);
6661
    VIR_FREE(srcList);
6662

E
Eric Blake 已提交
6663
    return true;
6664 6665 6666
}


6667 6668 6669
/*
 * "pool-info" command
 */
6670
static const vshCmdInfo info_pool_info[] = {
6671 6672
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
6673 6674 6675
    {NULL, NULL}
};

6676
static const vshCmdOptDef opts_pool_info[] = {
6677
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6678 6679 6680
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6681
static bool
6682
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
6683 6684 6685
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
6686 6687
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
6688
    bool ret = true;
6689 6690
    char uuid[VIR_UUID_STRING_BUFLEN];

6691
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6692
        return false;
6693 6694

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6695
        return false;
6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721

    vshPrint(ctl, "%-15s %s\n", _("Name:"), virStoragePoolGetName(pool));

    if (virStoragePoolGetUUIDString(pool, &uuid[0])==0)
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);

    if (virStoragePoolGetInfo(pool, &info) == 0) {
        double val;
        const char *unit;
        switch (info.state) {
        case VIR_STORAGE_POOL_INACTIVE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inactive"));
            break;
        case VIR_STORAGE_POOL_BUILDING:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("building"));
            break;
        case VIR_STORAGE_POOL_RUNNING:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("running"));
            break;
        case VIR_STORAGE_POOL_DEGRADED:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("degraded"));
            break;
6722 6723 6724 6725
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
6726 6727
        }

6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
        vshDebug(ctl, 5, "Pool persistent flag value: %d\n", persistent);
        if (persistent < 0)
            vshPrint(ctl, "%-15s %s\n", _("Persistent:"),  _("unknown"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Persistent:"), persistent ? _("yes") : _("no"));

        /* Check and display whether the pool is autostarted or not */
        virStoragePoolGetAutostart(pool, &autostart);
        vshDebug(ctl, 5, "Pool autostart flag value: %d\n", autostart);
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755
        if (info.state == VIR_STORAGE_POOL_RUNNING ||
            info.state == VIR_STORAGE_POOL_DEGRADED) {
            val = prettyCapacity(info.capacity, &unit);
            vshPrint(ctl, "%-15s %2.2lf %s\n", _("Capacity:"), val, unit);

            val = prettyCapacity(info.allocation, &unit);
            vshPrint(ctl, "%-15s %2.2lf %s\n", _("Allocation:"), val, unit);

            val = prettyCapacity(info.available, &unit);
            vshPrint(ctl, "%-15s %2.2lf %s\n", _("Available:"), val, unit);
        }
    } else {
E
Eric Blake 已提交
6756
        ret = false;
6757 6758 6759 6760 6761 6762 6763 6764 6765 6766
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
6767
static const vshCmdInfo info_pool_name[] = {
6768
    {"help", N_("convert a pool UUID to pool name")},
6769
    {"desc", ""},
6770 6771 6772
    {NULL, NULL}
};

6773
static const vshCmdOptDef opts_pool_name[] = {
6774
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
6775 6776 6777
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6778
static bool
6779
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
6780 6781 6782
{
    virStoragePoolPtr pool;

6783
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6784
        return false;
6785
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6786
                                           VSH_BYUUID)))
E
Eric Blake 已提交
6787
        return false;
6788 6789 6790

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6791
    return true;
6792 6793 6794 6795 6796 6797
}


/*
 * "pool-start" command
 */
6798
static const vshCmdInfo info_pool_start[] = {
6799 6800
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
6801 6802 6803
    {NULL, NULL}
};

6804
static const vshCmdOptDef opts_pool_start[] = {
6805
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
6806 6807 6808
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6809
static bool
6810
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
6811 6812
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6813
    bool ret = true;
6814

6815
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6816
        return false;
6817

6818
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
6819
         return false;
6820 6821 6822 6823 6824

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
6825
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
6826
        ret = false;
6827
    }
L
Laine Stump 已提交
6828 6829

    virStoragePoolFree(pool);
6830 6831 6832 6833
    return ret;
}


6834 6835 6836
/*
 * "vol-create-as" command
 */
6837
static const vshCmdInfo info_vol_create_as[] = {
6838 6839
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
6840 6841 6842
    {NULL, NULL}
};

6843
static const vshCmdOptDef opts_vol_create_as[] = {
6844 6845 6846 6847 6848
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the volume")},
    {"capacity", VSH_OT_DATA, VSH_OFLAG_REQ, N_("size of the vol with optional k,M,G,T suffix")},
    {"allocation", VSH_OT_STRING, 0, N_("initial allocation size with optional k,M,G,T suffix")},
    {"format", VSH_OT_STRING, 0, N_("file format type raw,bochs,qcow,qcow2,vmdk")},
6849 6850
    {"backing-vol", VSH_OT_STRING, 0, N_("the backing volume if taking a snapshot")},
    {"backing-vol-format", VSH_OT_STRING, 0, N_("format of backing volume if taking a snapshot")},
6851 6852 6853 6854 6855 6856 6857 6858 6859 6860
    {NULL, 0, 0, NULL}
};

static int cmdVolSize(const char *data, unsigned long long *val)
{
    char *end;
    if (virStrToLong_ull(data, &end, 10, val) < 0)
        return -1;

    if (end && *end) {
D
Daniel Veillard 已提交
6861
        /* Deliberate fallthrough cases here :-) */
6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881
        switch (*end) {
        case 'T':
            *val *= 1024;
        case 'G':
            *val *= 1024;
        case 'M':
            *val *= 1024;
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
6882
static bool
6883
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
6884 6885 6886
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
6887
    char *xml;
6888 6889
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
6890
    unsigned long long capacity, allocation = 0;
6891
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6892

6893
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6894
        return false;
6895 6896 6897

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
                                     VSH_BYNAME)))
E
Eric Blake 已提交
6898
        return false;
6899

6900
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6901 6902
        goto cleanup;

6903
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
6904 6905
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
6906
        vshError(ctl, _("Malformed size %s"), capacityStr);
6907

6908 6909
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
6910
        vshError(ctl, _("Malformed size %s"), allocationStr);
6911

6912 6913 6914 6915 6916 6917 6918
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

6919

6920
    virBufferAddLit(&buf, "<volume>\n");
6921 6922
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
6923
    if (allocationStr)
6924
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
6925 6926

    if (format) {
6927
        virBufferAddLit(&buf, "  <target>\n");
6928
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
6929
        virBufferAddLit(&buf, "  </target>\n");
6930
    }
6931

6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
        vshDebug(ctl, 5, "%s: Look up backing store volume '%s' as name\n",
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
                vshDebug(ctl, 5, "%s: Backing store volume found using '%s' as name\n",
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
            vshDebug(ctl, 5, "%s: Look up backing store volume '%s' as key\n",
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
                vshDebug(ctl, 5, "%s: Backing store volume found using '%s' as key\n",
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
            vshDebug(ctl, 5, "%s: Look up backing store volume '%s' as path\n",
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
                vshDebug(ctl, 5, "%s: Backing store volume found using '%s' as path\n",
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
E
Eric Blake 已提交
6965
            return false;
6966 6967 6968 6969 6970
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
6971
            return false;
6972 6973 6974 6975
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
6976
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
6977
        if (snapshotStrFormat)
6978
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
6979 6980 6981 6982 6983 6984 6985 6986
        virBufferAddLit(&buf, "  </backingStore>\n");

        /* Cleanup snapshot allocations */
        VIR_FREE(snapshotStrVolPath);
        virStorageVolFree(snapVol);
    }

    virBufferAddLit(&buf, "</volume>\n");
6987

6988 6989
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
6990
        return false;
6991 6992 6993
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
6994
    VIR_FREE(xml);
6995 6996 6997 6998 6999
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
7000
        return true;
7001
    } else {
7002
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
7003
        return false;
7004 7005 7006
    }

 cleanup:
7007
    virBufferFreeAndReset(&buf);
7008
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7009
    return false;
7010 7011 7012
}


7013 7014 7015
/*
 * "pool-undefine" command
 */
7016
static const vshCmdInfo info_pool_undefine[] = {
7017 7018
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
7019 7020 7021
    {NULL, NULL}
};

7022
static const vshCmdOptDef opts_pool_undefine[] = {
7023
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7024 7025 7026
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7027
static bool
7028
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
7029 7030
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7031
    bool ret = true;
7032
    const char *name;
7033

7034
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7035
        return false;
7036 7037

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7038
        return false;
7039 7040 7041 7042

    if (virStoragePoolUndefine(pool) == 0) {
        vshPrint(ctl, _("Pool %s has been undefined\n"), name);
    } else {
7043
        vshError(ctl, _("Failed to undefine pool %s"), name);
E
Eric Blake 已提交
7044
        ret = false;
7045 7046
    }

L
Laine Stump 已提交
7047
    virStoragePoolFree(pool);
7048 7049 7050 7051 7052 7053 7054
    return ret;
}


/*
 * "pool-uuid" command
 */
7055
static const vshCmdInfo info_pool_uuid[] = {
7056
    {"help", N_("convert a pool name to pool UUID")},
7057
    {"desc", ""},
7058 7059 7060
    {NULL, NULL}
};

7061
static const vshCmdOptDef opts_pool_uuid[] = {
7062
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
7063 7064 7065
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7066
static bool
7067
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
7068 7069 7070 7071
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

7072
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7073
        return false;
7074 7075

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7076
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7077
        return false;
7078 7079 7080 7081

    if (virStoragePoolGetUUIDString(pool, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
7082
        vshError(ctl, "%s", _("failed to get pool UUID"));
7083

L
Laine Stump 已提交
7084
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7085
    return true;
7086 7087 7088 7089 7090 7091
}


/*
 * "vol-create" command
 */
7092
static const vshCmdInfo info_vol_create[] = {
7093 7094
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
7095 7096 7097
    {NULL, NULL}
};

7098
static const vshCmdOptDef opts_vol_create[] = {
7099 7100
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
7101 7102 7103
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7104
static bool
7105
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
7106 7107 7108
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7109
    const char *from = NULL;
E
Eric Blake 已提交
7110
    bool ret = true;
7111 7112
    char *buffer;

7113
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7114
        return false;
7115 7116

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7117
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7118
        return false;
7119

7120
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7121
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7122
        return false;
7123 7124 7125
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7126
        virshReportError(ctl);
7127
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7128
        return false;
7129 7130 7131
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
7132
    VIR_FREE(buffer);
7133 7134 7135 7136 7137 7138 7139
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
7140
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
7141
        ret = false;
7142 7143 7144 7145
    }
    return ret;
}

7146 7147 7148 7149
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
7150 7151
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
7152 7153 7154 7155
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
7156 7157 7158
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("input vol name or key")},
E
Eric Blake 已提交
7159
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
7160 7161 7162
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7163
static bool
7164 7165 7166 7167
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
7168
    const char *from = NULL;
E
Eric Blake 已提交
7169
    bool ret = false;
7170 7171
    char *buffer = NULL;

7172
    if (!vshConnectionUsability(ctl, ctl->conn))
7173 7174 7175 7176 7177
        goto cleanup;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
        goto cleanup;

7178
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7179 7180 7181 7182 7183 7184 7185
        goto cleanup;
    }

    if (!(inputvol = vshCommandOptVol(ctl, cmd, "vol", "inputpool", NULL)))
        goto cleanup;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7186
        virshReportError(ctl);
7187 7188 7189 7190 7191 7192 7193 7194 7195
        goto cleanup;
    }

    newvol = virStorageVolCreateXMLFrom(pool, buffer, inputvol, 0);

    if (newvol != NULL) {
        vshPrint(ctl, _("Vol %s created from input vol %s\n"),
                 virStorageVolGetName(newvol), virStorageVolGetName(inputvol));
    } else {
7196
        vshError(ctl, _("Failed to create vol from %s"), from);
7197 7198 7199
        goto cleanup;
    }

E
Eric Blake 已提交
7200
    ret = true;
7201
cleanup:
7202
    VIR_FREE(buffer);
7203 7204 7205 7206
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
7207 7208
    if (newvol)
        virStorageVolFree(newvol);
7209 7210 7211 7212
    return ret;
}

static xmlChar *
7213
makeCloneXML(const char *origxml, const char *newname) {
7214

7215 7216 7217
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247
    xmlChar *newxml = NULL;
    int size;

    doc = xmlReadDoc((const xmlChar *) origxml, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET | XML_PARSE_NOWARNING);
    if (!doc)
        goto cleanup;
    ctxt = xmlXPathNewContext(doc);
    if (!ctxt)
        goto cleanup;

    obj = xmlXPathEval(BAD_CAST "/volume/name", ctxt);
    if ((obj == NULL) || (obj->nodesetval == NULL) ||
        (obj->nodesetval->nodeTab == NULL))
        goto cleanup;

    xmlNodeSetContent(obj->nodesetval->nodeTab[0], (const xmlChar *)newname);
    xmlDocDumpMemory(doc, &newxml, &size);

cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(doc);
    return newxml;
}

/*
 * "vol-clone" command
 */
static const vshCmdInfo info_vol_clone[] = {
7248 7249
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
7250 7251 7252 7253
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
7254 7255
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("orig vol name or key")},
    {"newname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("clone name")},
E
Eric Blake 已提交
7256
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7257 7258 7259
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7260
static bool
7261 7262 7263 7264
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
7265
    const char *name = NULL;
7266
    char *origxml = NULL;
7267
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
7268
    bool ret = false;
7269

7270
    if (!vshConnectionUsability(ctl, ctl->conn))
7271 7272 7273 7274 7275 7276 7277
        goto cleanup;

    if (!(origvol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        goto cleanup;

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
7278
        vshError(ctl, "%s", _("failed to get parent pool"));
7279 7280 7281
        goto cleanup;
    }

7282
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300
        goto cleanup;

    origxml = virStorageVolGetXMLDesc(origvol, 0);
    if (!origxml)
        goto cleanup;

    newxml = makeCloneXML(origxml, name);
    if (!newxml) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
        goto cleanup;
    }

    newvol = virStorageVolCreateXMLFrom(origpool, (char *) newxml, origvol, 0);

    if (newvol != NULL) {
        vshPrint(ctl, _("Vol %s cloned from %s\n"),
                 virStorageVolGetName(newvol), virStorageVolGetName(origvol));
    } else {
7301
        vshError(ctl, _("Failed to clone vol from %s"),
7302 7303 7304 7305
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
7306
    ret = true;
7307 7308

cleanup:
7309
    VIR_FREE(origxml);
7310 7311 7312
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
7313 7314
    if (newvol)
        virStorageVolFree(newvol);
7315 7316 7317 7318 7319
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332

/*
 * "vol-upload" command
 */
static const vshCmdInfo info_vol_upload[] = {
    {"help", N_("upload a file into a volume")},
    {"desc", N_("Upload a file into a volume")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_upload[] = {
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file")},
E
Eric Blake 已提交
7333
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347
    {"offset", VSH_OT_INT, 0, N_("volume offset to upload to") },
    {"length", VSH_OT_INT, 0, N_("amount of data to upload") },
    {NULL, 0, 0, NULL}
};

static int
cmdVolUploadSource(virStreamPtr st ATTRIBUTE_UNUSED,
                   char *bytes, size_t nbytes, void *opaque)
{
    int *fd = opaque;

    return saferead(*fd, bytes, nbytes);
}

E
Eric Blake 已提交
7348
static bool
7349 7350 7351 7352
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7353
    bool ret = false;
7354 7355 7356 7357 7358 7359 7360 7361 7362 7363
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;

    if (!vshConnectionUsability(ctl, ctl->conn))
        goto cleanup;

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7364
        return false;
7365 7366 7367 7368
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7369
        return false;
7370 7371 7372
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7373
        return false;
7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407
    }

    if (vshCommandOptString(cmd, "file", &file) < 0) {
        vshError(ctl, _("file must not be empty"));
        goto cleanup;
    }

    if ((fd = open(file, O_RDONLY)) < 0) {
        vshError(ctl, _("cannot read %s"), file);
        goto cleanup;
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolUpload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot upload to volume %s"), name);
        goto cleanup;
    }

    if (virStreamSendAll(st, cmdVolUploadSource, &fd) < 0) {
        vshError(ctl, _("cannot send data to volume %s"), name);
        goto cleanup;
    }

    if (VIR_CLOSE(fd) < 0) {
        vshError(ctl, _("cannot close file %s"), file);
        virStreamAbort(st);
        goto cleanup;
    }

    if (virStreamFinish(st) < 0) {
        vshError(ctl, _("cannot close volume %s"), name);
        goto cleanup;
    }

E
Eric Blake 已提交
7408
    ret = true;
7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432

cleanup:
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    VIR_FORCE_CLOSE(fd);
    return ret;
}



/*
 * "vol-download" command
 */
static const vshCmdInfo info_vol_download[] = {
    {"help", N_("Download a volume to a file")},
    {"desc", N_("Download a volume to a file")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_download[] = {
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file")},
E
Eric Blake 已提交
7433
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448
    {"offset", VSH_OT_INT, 0, N_("volume offset to download from") },
    {"length", VSH_OT_INT, 0, N_("amount of data to download") },
    {NULL, 0, 0, NULL}
};


static int
cmdVolDownloadSink(virStreamPtr st ATTRIBUTE_UNUSED,
                   const char *bytes, size_t nbytes, void *opaque)
{
    int *fd = opaque;

    return safewrite(*fd, bytes, nbytes);
}

E
Eric Blake 已提交
7449
static bool
7450 7451 7452 7453
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7454
    bool ret = false;
7455 7456 7457 7458
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
7459
    bool created = false;
7460 7461

    if (!vshConnectionUsability(ctl, ctl->conn))
7462
        return false;
7463 7464 7465

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7466
        return false;
7467 7468 7469 7470
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7471
        return false;
7472 7473 7474
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
7475
        return false;
7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487

    if (vshCommandOptString(cmd, "file", &file) < 0) {
        vshError(ctl, _("file must not be empty"));
        goto cleanup;
    }

    if ((fd = open(file, O_WRONLY|O_CREAT|O_EXCL, 0666)) < 0) {
        if (errno != EEXIST ||
            (fd = open(file, O_WRONLY|O_TRUNC, 0666)) < 0) {
            vshError(ctl, _("cannot create %s"), file);
            goto cleanup;
        }
7488 7489
    } else {
        created = true;
7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

    if (virStreamRecvAll(st, cmdVolDownloadSink, &fd) < 0) {
        vshError(ctl, _("cannot receive data from volume %s"), name);
        goto cleanup;
    }

    if (VIR_CLOSE(fd) < 0) {
        vshError(ctl, _("cannot close file %s"), file);
        virStreamAbort(st);
        goto cleanup;
    }

    if (virStreamFinish(st) < 0) {
        vshError(ctl, _("cannot close volume %s"), name);
        goto cleanup;
    }

E
Eric Blake 已提交
7514
    ret = true;
7515 7516

cleanup:
7517
    VIR_FORCE_CLOSE(fd);
7518
    if (!ret && created)
7519 7520 7521 7522 7523 7524 7525 7526 7527
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


7528 7529 7530
/*
 * "vol-delete" command
 */
7531
static const vshCmdInfo info_vol_delete[] = {
7532 7533
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
7534 7535 7536
    {NULL, NULL}
};

7537
static const vshCmdOptDef opts_vol_delete[] = {
7538
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7539
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7540 7541 7542
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7543
static bool
7544
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
7545 7546
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7547
    bool ret = true;
7548
    const char *name;
7549

7550
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7551
        return false;
7552 7553

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7554
        return false;
7555 7556 7557
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
7558
        vshPrint(ctl, _("Vol %s deleted\n"), name);
7559
    } else {
7560
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
7561
        ret = false;
7562 7563
    }

L
Laine Stump 已提交
7564
    virStorageVolFree(vol);
7565 7566 7567 7568
    return ret;
}


D
David Allan 已提交
7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579
/*
 * "vol-wipe" command
 */
static const vshCmdInfo info_vol_wipe[] = {
    {"help", N_("wipe a vol")},
    {"desc", N_("Ensure data previously on a volume is not accessible to future reads")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_wipe[] = {
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7580
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
7581 7582 7583
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7584
static bool
D
David Allan 已提交
7585 7586 7587
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7588
    bool ret = true;
7589
    const char *name;
D
David Allan 已提交
7590

7591
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7592
        return false;
D
David Allan 已提交
7593 7594

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7595
        return false;
D
David Allan 已提交
7596 7597 7598 7599 7600 7601
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
7602
        ret = false;
D
David Allan 已提交
7603 7604 7605 7606 7607 7608 7609
    }

    virStorageVolFree(vol);
    return ret;
}


7610 7611 7612
/*
 * "vol-info" command
 */
7613
static const vshCmdInfo info_vol_info[] = {
7614 7615
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
7616 7617 7618
    {NULL, NULL}
};

7619
static const vshCmdOptDef opts_vol_info[] = {
7620
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7621
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7622 7623 7624
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7625
static bool
7626
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
7627 7628 7629
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
7630
    bool ret = true;
7631

7632
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7633
        return false;
7634 7635

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
7636
        return false;
7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652

    vshPrint(ctl, "%-15s %s\n", _("Name:"), virStorageVolGetName(vol));

    if (virStorageVolGetInfo(vol, &info) == 0) {
        double val;
        const char *unit;
        vshPrint(ctl, "%-15s %s\n", _("Type:"),
                 info.type == VIR_STORAGE_VOL_FILE ?
                 _("file") : _("block"));

        val = prettyCapacity(info.capacity, &unit);
        vshPrint(ctl, "%-15s %2.2lf %s\n", _("Capacity:"), val, unit);

        val = prettyCapacity(info.allocation, &unit);
        vshPrint(ctl, "%-15s %2.2lf %s\n", _("Allocation:"), val, unit);
    } else {
E
Eric Blake 已提交
7653
        ret = false;
7654 7655 7656 7657 7658 7659 7660 7661 7662 7663
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
7664
static const vshCmdInfo info_vol_dumpxml[] = {
7665 7666
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
7667 7668 7669
    {NULL, NULL}
};

7670
static const vshCmdOptDef opts_vol_dumpxml[] = {
7671
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7672
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7673 7674 7675
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7676
static bool
7677
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
7678 7679
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7680
    bool ret = true;
7681 7682
    char *dump;

7683
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7684
        return false;
7685 7686

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
7687
        return false;
7688 7689 7690

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
7691
        vshPrint(ctl, "%s", dump);
7692
        VIR_FREE(dump);
7693
    } else {
E
Eric Blake 已提交
7694
        ret = false;
7695 7696 7697 7698 7699 7700 7701 7702 7703 7704
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
7705
static const vshCmdInfo info_vol_list[] = {
7706 7707
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
7708 7709 7710
    {NULL, NULL}
};

7711
static const vshCmdOptDef opts_vol_list[] = {
7712
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7713
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
7714 7715 7716
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7717
static bool
7718
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7719
{
7720
    virStorageVolInfo volumeInfo;
7721 7722
    virStoragePoolPtr pool;
    char **activeNames = NULL;
7723 7724 7725 7726 7727
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
7728 7729
    int ret;
    bool functionReturn;
7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740
    int stringLength = 0;
    size_t allocStrLength = 0, capStrLength = 0;
    size_t nameStrLength = 0, pathStrLength = 0;
    size_t typeStrLength = 0;
    struct volInfoText {
        char *allocation;
        char *capacity;
        char *path;
        char *type;
    };
    struct volInfoText *volInfoTexts = NULL;
7741

7742
    /* Check the connection to libvirtd daemon is still working */
7743
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7744
        return false;
7745

7746
    /* Look up the pool information given to us by the user */
7747
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7748
        return false;
7749

7750 7751
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
7752

7753 7754 7755
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7756
        return false;
7757 7758
    }

7759 7760 7761 7762 7763
    /* Retrieve the list of volume names in the pool */
    if (numVolumes > 0) {
        activeNames = vshCalloc(ctl, numVolumes, sizeof(*activeNames));
        if ((numVolumes = virStoragePoolListVolumes(pool, activeNames,
                                                    numVolumes)) < 0) {
7764
            vshError(ctl, "%s", _("Failed to list active vols"));
7765
            VIR_FREE(activeNames);
7766
            virStoragePoolFree(pool);
E
Eric Blake 已提交
7767
            return false;
7768 7769
        }

7770 7771 7772 7773 7774
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

        /* Set aside memory for volume information pointers */
        volInfoTexts = vshCalloc(ctl, numVolumes, sizeof(*volInfoTexts));
7775 7776
    }

7777 7778 7779 7780 7781
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
7782

7783 7784 7785 7786
        /* Retrieve the volume path */
        if ((volInfoTexts[i].path = virStorageVolGetPath(vol)) == NULL) {
            /* Something went wrong retrieving a volume path, cope with it */
            volInfoTexts[i].path = vshStrdup(ctl, _("unknown"));
7787 7788
        }

7789 7790 7791 7792 7793 7794 7795 7796 7797
        /* If requested, retrieve volume type and sizing information */
        if (details) {
            if (virStorageVolGetInfo(vol, &volumeInfo) != 0) {
                /* Something went wrong retrieving volume info, cope with it */
                volInfoTexts[i].allocation = vshStrdup(ctl, _("unknown"));
                volInfoTexts[i].capacity = vshStrdup(ctl, _("unknown"));
                volInfoTexts[i].type = vshStrdup(ctl, _("unknown"));
            } else {
                /* Convert the returned volume info into output strings */
7798

7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853
                /* Volume type */
                if (volumeInfo.type == VIR_STORAGE_VOL_FILE)
                    volInfoTexts[i].type = vshStrdup(ctl, _("file"));
                else
                    volInfoTexts[i].type = vshStrdup(ctl, _("block"));

                /* Create the capacity output string */
                val = prettyCapacity(volumeInfo.capacity, &unit);
                ret = virAsprintf(&volInfoTexts[i].capacity,
                                  "%.2lf %s", val, unit);
                if (ret < 0) {
                    /* An error occurred creating the string, return */
                    goto asprintf_failure;
                }

                /* Create the allocation output string */
                val = prettyCapacity(volumeInfo.allocation, &unit);
                ret = virAsprintf(&volInfoTexts[i].allocation,
                                  "%.2lf %s", val, unit);
                if (ret < 0) {
                    /* An error occurred creating the string, return */
                    goto asprintf_failure;
                }
            }

            /* Remember the largest length for each output string.
             * This lets us displaying header and volume information rows
             * using a single, properly sized, printf style output string.
             */

            /* Keep the length of name string if longest so far */
            stringLength = strlen(activeNames[i]);
            if (stringLength > nameStrLength)
                nameStrLength = stringLength;

            /* Keep the length of path string if longest so far */
            stringLength = strlen(volInfoTexts[i].path);
            if (stringLength > pathStrLength)
                pathStrLength = stringLength;

            /* Keep the length of type string if longest so far */
            stringLength = strlen(volInfoTexts[i].type);
            if (stringLength > typeStrLength)
                typeStrLength = stringLength;

            /* Keep the length of capacity string if longest so far */
            stringLength = strlen(volInfoTexts[i].capacity);
            if (stringLength > capStrLength)
                capStrLength = stringLength;

            /* Keep the length of allocation string if longest so far */
            stringLength = strlen(volInfoTexts[i].allocation);
            if (stringLength > allocStrLength)
                allocStrLength = stringLength;
        }
7854

7855
        /* Cleanup memory allocation */
7856
        virStorageVolFree(vol);
7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874
    }

    /* If the --details option wasn't selected, we output the volume
     * info using the fixed string format from previous versions to
     * maintain backward compatibility.
     */

    /* Output basic info then return if --details option not selected */
    if (!details) {
        /* The old output format */
        vshPrintExtra(ctl, "%-20s %-40s\n", _("Name"), _("Path"));
        vshPrintExtra(ctl, "-----------------------------------------\n");
        for (i = 0; i < numVolumes; i++) {
            vshPrint(ctl, "%-20s %-40s\n", activeNames[i],
                     volInfoTexts[i].path);
        }

        /* Cleanup and return */
E
Eric Blake 已提交
7875
        functionReturn = true;
7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906
        goto cleanup;
    }

    /* We only get here if the --details option was selected. */

    /* Use the length of name header string if it's longest */
    stringLength = strlen(_("Name"));
    if (stringLength > nameStrLength)
        nameStrLength = stringLength;

    /* Use the length of path header string if it's longest */
    stringLength = strlen(_("Path"));
    if (stringLength > pathStrLength)
        pathStrLength = stringLength;

    /* Use the length of type header string if it's longest */
    stringLength = strlen(_("Type"));
    if (stringLength > typeStrLength)
        typeStrLength = stringLength;

    /* Use the length of capacity header string if it's longest */
    stringLength = strlen(_("Capacity"));
    if (stringLength > capStrLength)
        capStrLength = stringLength;

    /* Use the length of allocation header string if it's longest */
    stringLength = strlen(_("Allocation"));
    if (stringLength > allocStrLength)
        allocStrLength = stringLength;

    /* Display the string lengths for debugging */
C
Chris Lalancette 已提交
7907 7908 7909 7910 7911
    vshDebug(ctl, 5, "Longest name string = %zu chars\n", nameStrLength);
    vshDebug(ctl, 5, "Longest path string = %zu chars\n", pathStrLength);
    vshDebug(ctl, 5, "Longest type string = %zu chars\n", typeStrLength);
    vshDebug(ctl, 5, "Longest capacity string = %zu chars\n", capStrLength);
    vshDebug(ctl, 5, "Longest allocation string = %zu chars\n", allocStrLength);
7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945

    /* Create the output template */
    ret = virAsprintf(&outputStr,
                      "%%-%lus  %%-%lus  %%-%lus  %%%lus  %%%lus\n",
                      (unsigned long) nameStrLength,
                      (unsigned long) pathStrLength,
                      (unsigned long) typeStrLength,
                      (unsigned long) capStrLength,
                      (unsigned long) allocStrLength);
    if (ret < 0) {
        /* An error occurred creating the string, return */
        goto asprintf_failure;
    }

    /* Display the header */
    vshPrint(ctl, outputStr, _("Name"), _("Path"), _("Type"),
             ("Capacity"), _("Allocation"));
    for (i = nameStrLength + pathStrLength + typeStrLength
                           + capStrLength + allocStrLength
                           + 8; i > 0; i--)
        vshPrintExtra(ctl, "-");
    vshPrintExtra(ctl, "\n");

    /* Display the volume info rows */
    for (i = 0; i < numVolumes; i++) {
        vshPrint(ctl, outputStr,
                 activeNames[i],
                 volInfoTexts[i].path,
                 volInfoTexts[i].type,
                 volInfoTexts[i].capacity,
                 volInfoTexts[i].allocation);
    }

    /* Cleanup and return */
E
Eric Blake 已提交
7946
    functionReturn = true;
7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960
    goto cleanup;

asprintf_failure:

    /* Display an appropriate error message then cleanup and return */
    switch (errno) {
    case ENOMEM:
        /* Couldn't allocate memory */
        vshError(ctl, "%s", _("Out of memory"));
        break;
    default:
        /* Some other error */
        vshError(ctl, _("virAsprintf failed (errno %d)"), errno);
    }
E
Eric Blake 已提交
7961
    functionReturn = false;
7962 7963 7964 7965 7966 7967 7968 7969 7970 7971

cleanup:

    /* Safely free the memory allocated in this function */
    for (i = 0; i < numVolumes; i++) {
        /* Cleanup the memory for one volume info structure per loop */
        VIR_FREE(volInfoTexts[i].path);
        VIR_FREE(volInfoTexts[i].type);
        VIR_FREE(volInfoTexts[i].capacity);
        VIR_FREE(volInfoTexts[i].allocation);
7972
        VIR_FREE(activeNames[i]);
7973
    }
7974 7975 7976 7977

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
7978
    VIR_FREE(activeNames);
7979
    virStoragePoolFree(pool);
7980 7981 7982

    /* Return the desired value */
    return functionReturn;
7983 7984 7985 7986 7987 7988
}


/*
 * "vol-name" command
 */
7989
static const vshCmdInfo info_vol_name[] = {
7990
    {"help", N_("returns the volume name for a given volume key or path")},
7991
    {"desc", ""},
7992 7993 7994
    {NULL, NULL}
};

7995
static const vshCmdOptDef opts_vol_name[] = {
7996
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
7997 7998 7999
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8000
static bool
8001
cmdVolName(vshControl *ctl, const vshCmd *cmd)
8002 8003 8004
{
    virStorageVolPtr vol;

8005
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8006
        return false;
8007 8008 8009

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
E
Eric Blake 已提交
8010
        return false;
8011 8012 8013

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8014
    return true;
8015 8016 8017
}


J
Justin Clift 已提交
8018 8019 8020 8021 8022 8023 8024 8025 8026 8027
/*
 * "vol-pool" command
 */
static const vshCmdInfo info_vol_pool[] = {
    {"help", N_("returns the storage pool for a given volume key or path")},
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_pool[] = {
8028
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
8029 8030 8031 8032
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8033
static bool
J
Justin Clift 已提交
8034 8035 8036 8037
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8038
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
8039 8040

    /* Check the connection to libvirtd daemon is still working */
8041
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8042
        return false;
J
Justin Clift 已提交
8043 8044 8045 8046

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
8047
        return false;
J
Justin Clift 已提交
8048 8049 8050 8051 8052 8053 8054
    }

    /* Look up the parent storage pool for the volume */
    pool = virStoragePoolLookupByVolume(vol);
    if (pool == NULL) {
        vshError(ctl, "%s", _("failed to get parent pool"));
        virStorageVolFree(vol);
E
Eric Blake 已提交
8055
        return false;
J
Justin Clift 已提交
8056 8057
    }

8058 8059 8060 8061 8062 8063 8064 8065 8066
    /* Return the requested details of the parent storage pool */
    if (vshCommandOptBool(cmd, "uuid")) {
        /* Retrieve and return pool UUID string */
        if (virStoragePoolGetUUIDString(pool, &uuid[0]) == 0)
            vshPrint(ctl, "%s\n", uuid);
    } else {
        /* Return the storage pool name */
        vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    }
J
Justin Clift 已提交
8067 8068 8069 8070

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8071
    return true;
J
Justin Clift 已提交
8072 8073
}

8074 8075 8076 8077

/*
 * "vol-key" command
 */
8078
static const vshCmdInfo info_vol_key[] = {
8079
    {"help", N_("returns the volume key for a given volume name or path")},
8080
    {"desc", ""},
8081 8082 8083
    {NULL, NULL}
};

8084
static const vshCmdOptDef opts_vol_key[] = {
8085
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
8086
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8087 8088 8089
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8090
static bool
8091
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
8092 8093 8094
{
    virStorageVolPtr vol;

8095
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8096
        return false;
8097

8098
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8099
        return false;
8100 8101 8102

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8103
    return true;
8104 8105 8106 8107 8108 8109 8110
}



/*
 * "vol-path" command
 */
8111
static const vshCmdInfo info_vol_path[] = {
8112
    {"help", N_("returns the volume path for a given volume name or key")},
8113
    {"desc", ""},
8114 8115 8116
    {NULL, NULL}
};

8117
static const vshCmdOptDef opts_vol_path[] = {
8118
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
8119
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8120 8121 8122
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8123
static bool
8124
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
8125 8126
{
    virStorageVolPtr vol;
8127
    const char *name = NULL;
8128

8129
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8130
        return false;
8131 8132

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8133
        return false;
8134
    }
8135 8136 8137

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8138
    return true;
8139 8140 8141
}


8142 8143 8144 8145
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
8146 8147
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
8148 8149
    {NULL, NULL}
};
8150

8151
static const vshCmdOptDef opts_secret_define[] = {
8152
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
8153 8154
    {NULL, 0, 0, NULL}
};
8155

E
Eric Blake 已提交
8156
static bool
8157 8158
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
8159
    const char *from = NULL;
8160
    char *buffer;
8161
    virSecretPtr res;
8162
    char uuid[VIR_UUID_STRING_BUFLEN];
8163

8164
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8165
        return false;
8166

8167
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8168
        return false;
8169 8170

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
8171
        return false;
8172 8173

    res = virSecretDefineXML(ctl->conn, buffer, 0);
8174
    VIR_FREE(buffer);
8175 8176

    if (res == NULL) {
8177
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
8178
        return false;
8179
    }
8180
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
8181
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
8182
        virSecretFree(res);
E
Eric Blake 已提交
8183
        return false;
8184 8185 8186
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
8187
    return true;
8188 8189 8190 8191 8192 8193
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
8194 8195
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
8196 8197 8198 8199
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
8200
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8201 8202 8203
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8204
static bool
8205 8206 8207
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8208
    bool ret = false;
8209 8210
    char *xml;

8211
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8212
        return false;
8213 8214 8215

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8216
        return false;
8217 8218 8219 8220

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
8221
    vshPrint(ctl, "%s", xml);
8222
    VIR_FREE(xml);
E
Eric Blake 已提交
8223
    ret = true;
8224 8225 8226 8227 8228 8229 8230 8231 8232 8233

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
8234 8235
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
8236 8237 8238 8239
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
8240 8241
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
8242 8243 8244
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8245
static bool
8246 8247 8248 8249
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
8250
    const char *base64 = NULL;
8251
    char *value;
E
Eric Blake 已提交
8252 8253
    int res;
    bool ret = false;
8254

8255
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8256
        return false;
8257 8258 8259

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8260
        return false;
8261

8262
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
8263 8264 8265
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
8266
        vshError(ctl, "%s", _("Invalid base64 data"));
8267 8268 8269
        goto cleanup;
    }
    if (value == NULL) {
8270
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
8271
        return false;
8272 8273 8274 8275
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
8276
    VIR_FREE(value);
8277 8278

    if (res != 0) {
8279
        vshError(ctl, "%s", _("Failed to set secret value"));
8280 8281 8282
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
8283
    ret = true;
8284 8285 8286 8287 8288 8289 8290 8291 8292 8293

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
8294 8295
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
8296 8297 8298 8299
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
8300
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8301 8302 8303
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8304
static bool
8305 8306 8307 8308 8309 8310
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
8311
    bool ret = false;
8312

8313
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8314
        return false;
8315 8316 8317

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8318
        return false;
8319 8320 8321 8322 8323 8324 8325

    value = virSecretGetValue(secret, &value_size, 0);
    if (value == NULL)
        goto cleanup;

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
8326
    VIR_FREE(value);
8327 8328

    if (base64 == NULL) {
8329
        vshError(ctl, "%s", _("Failed to allocate memory"));
8330 8331
        goto cleanup;
    }
8332
    vshPrint(ctl, "%s", base64);
8333
    memset(base64, 0, strlen(base64));
8334
    VIR_FREE(base64);
E
Eric Blake 已提交
8335
    ret = true;
8336 8337 8338 8339 8340 8341 8342 8343 8344 8345

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
8346 8347
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
8348 8349 8350 8351
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
8352
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8353 8354 8355
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8356
static bool
8357 8358 8359
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8360
    bool ret = false;
8361
    const char *uuid;
8362

8363
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8364
        return false;
8365 8366 8367

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
8368
        return false;
8369 8370

    if (virSecretUndefine(secret) < 0) {
8371
        vshError(ctl, _("Failed to delete secret %s"), uuid);
8372 8373 8374
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
8375
    ret = true;
8376 8377 8378 8379 8380 8381 8382 8383 8384 8385

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
8386 8387
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
8388 8389 8390
    {NULL, NULL}
};

E
Eric Blake 已提交
8391
static bool
8392 8393 8394 8395 8396
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

8397
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8398
        return false;
8399 8400 8401

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
8402
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
8403
        return false;
8404 8405 8406 8407 8408
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
8409
        vshError(ctl, "%s", _("Failed to list secrets"));
8410
        VIR_FREE(uuids);
E
Eric Blake 已提交
8411
        return false;
8412 8413 8414 8415
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

8416 8417
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
8418 8419

    for (i = 0; i < maxuuids; i++) {
8420 8421 8422 8423
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
8424
            VIR_FREE(uuids[i]);
8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442
            continue;
        }

        switch (virSecretGetUsageType(sec)) {
        case VIR_SECRET_USAGE_TYPE_VOLUME:
            usageType = _("Volume");
            break;
        }

        if (usageType) {
            vshPrint(ctl, "%-36s %s %s\n",
                     uuids[i], usageType,
                     virSecretGetUsageID(sec));
        } else {
            vshPrint(ctl, "%-36s %s\n",
                     uuids[i], _("Unused"));
        }
        virSecretFree(sec);
8443
        VIR_FREE(uuids[i]);
8444
    }
8445
    VIR_FREE(uuids);
E
Eric Blake 已提交
8446
    return true;
8447
}
8448 8449 8450 8451 8452


/*
 * "version" command
 */
8453
static const vshCmdInfo info_version[] = {
8454 8455
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
8456 8457 8458 8459
    {NULL, NULL}
};


E
Eric Blake 已提交
8460
static bool
8461
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

8473
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8474
        return false;
8475 8476 8477

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
8478
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
8479
        return false;
8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491
    }

    includeVersion = LIBVIR_VERSION_NUMBER;
    major = includeVersion / 1000000;
    includeVersion %= 1000000;
    minor = includeVersion / 1000;
    rel = includeVersion % 1000;
    vshPrint(ctl, _("Compiled against library: libvir %d.%d.%d\n"),
             major, minor, rel);

    ret = virGetVersion(&libVersion, hvType, &apiVersion);
    if (ret < 0) {
8492
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
8493
        return false;
8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510
    }
    major = libVersion / 1000000;
    libVersion %= 1000000;
    minor = libVersion / 1000;
    rel = libVersion % 1000;
    vshPrint(ctl, _("Using library: libvir %d.%d.%d\n"),
             major, minor, rel);

    major = apiVersion / 1000000;
    apiVersion %= 1000000;
    minor = apiVersion / 1000;
    rel = apiVersion % 1000;
    vshPrint(ctl, _("Using API: %s %d.%d.%d\n"), hvType,
             major, minor, rel);

    ret = virConnectGetVersion(ctl->conn, &hvVersion);
    if (ret < 0) {
8511
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
8512
        return false;
8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525
    }
    if (hvVersion == 0) {
        vshPrint(ctl,
                 _("Cannot extract running %s hypervisor version\n"), hvType);
    } else {
        major = hvVersion / 1000000;
        hvVersion %= 1000000;
        minor = hvVersion / 1000;
        rel = hvVersion % 1000;

        vshPrint(ctl, _("Running hypervisor: %s %d.%d.%d\n"),
                 hvType, major, minor, rel);
    }
E
Eric Blake 已提交
8526
    return true;
8527 8528
}

8529 8530 8531 8532
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
8533
    {"help", N_("enumerate devices on this host")},
8534
    {"desc", ""},
8535 8536 8537 8538
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
8539 8540
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
8541 8542 8543
    {NULL, 0, 0, NULL}
};

8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565
#define MAX_DEPTH 100
#define INDENT_SIZE 4
#define INDENT_BUFLEN ((MAX_DEPTH * INDENT_SIZE) + 1)

static void
cmdNodeListDevicesPrint(vshControl *ctl,
                        char **devices,
                        char **parents,
                        int num_devices,
                        int devid,
                        int lastdev,
                        unsigned int depth,
                        unsigned int indentIdx,
                        char *indentBuf)
{
    int i;
    int nextlastdev = -1;

    /* Prepare indent for this device, but not if at root */
    if (depth && depth < MAX_DEPTH) {
        indentBuf[indentIdx] = '+';
        indentBuf[indentIdx+1] = '-';
8566 8567
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
8568 8569 8570
    }

    /* Print this device */
8571
    vshPrint(ctl, "%s", indentBuf);
8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594
    vshPrint(ctl, "%s\n", devices[devid]);


    /* Update indent to show '|' or ' ' for child devices */
    if (depth && depth < MAX_DEPTH) {
        if (devid == lastdev)
            indentBuf[indentIdx] = ' ';
        else
            indentBuf[indentIdx] = '|';
        indentBuf[indentIdx+1] = ' ';
        indentIdx+=2;
    }

    /* Determine the index of the last child device */
    for (i = 0 ; i < num_devices ; i++) {
        if (parents[i] &&
            STREQ(parents[i], devices[devid])) {
            nextlastdev = i;
        }
    }

    /* If there is a child device, then print another blank line */
    if (nextlastdev != -1) {
8595
        vshPrint(ctl, "%s", indentBuf);
8596
        vshPrint(ctl, " |\n");
8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618
    }

    /* Finally print all children */
    if (depth < MAX_DEPTH)
        indentBuf[indentIdx] = ' ';
    for (i = 0 ; i < num_devices ; i++) {
        if (depth < MAX_DEPTH) {
            indentBuf[indentIdx] = ' ';
            indentBuf[indentIdx+1] = ' ';
        }
        if (parents[i] &&
            STREQ(parents[i], devices[devid]))
            cmdNodeListDevicesPrint(ctl, devices, parents,
                                    num_devices, i, nextlastdev,
                                    depth + 1, indentIdx + 2, indentBuf);
        if (depth < MAX_DEPTH)
            indentBuf[indentIdx] = '\0';
    }

    /* If there was no child device, and we're the last in
     * a list of devices, then print another blank line */
    if (nextlastdev == -1 && devid == lastdev) {
8619
        vshPrint(ctl, "%s", indentBuf);
8620 8621 8622 8623
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
8624
static bool
8625 8626
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
8627
    const char *cap = NULL;
8628
    char **devices;
8629
    int num_devices, i;
8630
    int tree = vshCommandOptBool(cmd, "tree");
8631

8632
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8633
        return false;
8634

8635
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
8636 8637 8638 8639
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
8640
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
8641
        return false;
8642
    } else if (num_devices == 0) {
E
Eric Blake 已提交
8643
        return true;
8644 8645 8646 8647 8648 8649
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
8650
        vshError(ctl, "%s", _("Failed to list node devices"));
8651
        VIR_FREE(devices);
E
Eric Blake 已提交
8652
        return false;
8653
    }
8654
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
8655 8656 8657 8658 8659 8660 8661
    if (tree) {
        char indentBuf[INDENT_BUFLEN];
        char **parents = vshMalloc(ctl, sizeof(char *) * num_devices);
        for (i = 0; i < num_devices; i++) {
            virNodeDevicePtr dev = virNodeDeviceLookupByName(ctl->conn, devices[i]);
            if (dev && STRNEQ(devices[i], "computer")) {
                const char *parent = virNodeDeviceGetParent(dev);
E
Eric Blake 已提交
8662
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681
            } else {
                parents[i] = NULL;
            }
            virNodeDeviceFree(dev);
        }
        for (i = 0 ; i < num_devices ; i++) {
            memset(indentBuf, '\0', sizeof indentBuf);
            if (parents[i] == NULL)
                cmdNodeListDevicesPrint(ctl,
                                        devices,
                                        parents,
                                        num_devices,
                                        i,
                                        i,
                                        0,
                                        0,
                                        indentBuf);
        }
        for (i = 0 ; i < num_devices ; i++) {
8682 8683
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
8684
        }
8685
        VIR_FREE(parents);
8686 8687 8688
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
8689
            VIR_FREE(devices[i]);
8690
        }
8691
    }
8692
    VIR_FREE(devices);
E
Eric Blake 已提交
8693
    return true;
8694 8695 8696 8697 8698 8699
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
8700 8701
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
8702 8703 8704 8705 8706
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
8707
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8708 8709 8710
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8711
static bool
8712 8713
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
8714
    const char *name = NULL;
8715
    virNodeDevicePtr device;
L
Laine Stump 已提交
8716
    char *xml;
8717

8718
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8719
        return false;
8720
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8721
        return false;
8722
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8723
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8724
        return false;
8725 8726
    }

L
Laine Stump 已提交
8727 8728 8729
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
8730
        return false;
L
Laine Stump 已提交
8731 8732 8733
    }

    vshPrint(ctl, "%s\n", xml);
8734
    VIR_FREE(xml);
8735
    virNodeDeviceFree(device);
E
Eric Blake 已提交
8736
    return true;
8737 8738
}

8739 8740 8741 8742
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
8743 8744
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
8745 8746 8747 8748 8749
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
8750
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8751 8752 8753
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8754
static bool
8755 8756
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
8757
    const char *name = NULL;
8758
    virNodeDevicePtr device;
E
Eric Blake 已提交
8759
    bool ret = true;
8760

8761
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8762
        return false;
8763
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8764
        return false;
8765
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8766
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8767
        return false;
8768 8769 8770 8771 8772
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
8773
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
8774
        ret = false;
8775 8776 8777 8778 8779 8780 8781 8782 8783
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
8784 8785
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
8786 8787 8788 8789 8790
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
8791
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8792 8793 8794
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8795
static bool
8796 8797
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
8798
    const char *name = NULL;
8799
    virNodeDevicePtr device;
E
Eric Blake 已提交
8800
    bool ret = true;
8801

8802
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8803
        return false;
8804
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8805
        return false;
8806
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8807
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8808
        return false;
8809 8810 8811 8812 8813
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
8814
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
8815
        ret = false;
8816 8817 8818 8819 8820 8821 8822 8823 8824
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
8825 8826
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
8827 8828 8829 8830 8831
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
8832
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8833 8834 8835
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8836
static bool
8837 8838
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
8839
    const char *name = NULL;
8840
    virNodeDevicePtr device;
E
Eric Blake 已提交
8841
    bool ret = true;
8842

8843
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8844
        return false;
8845
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8846
        return false;
8847
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8848
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8849
        return false;
8850 8851 8852 8853 8854
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
8855
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
8856
        ret = false;
8857 8858 8859 8860 8861
    }
    virNodeDeviceFree(device);
    return ret;
}

8862
/*
E
Eric Blake 已提交
8863
 * "hostname" command
8864
 */
8865
static const vshCmdInfo info_hostname[] = {
8866
    {"help", N_("print the hypervisor hostname")},
8867
    {"desc", ""},
8868 8869 8870
    {NULL, NULL}
};

E
Eric Blake 已提交
8871
static bool
8872
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8873 8874 8875
{
    char *hostname;

8876
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8877
        return false;
8878 8879 8880

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
8881
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
8882
        return false;
8883 8884 8885
    }

    vshPrint (ctl, "%s\n", hostname);
8886
    VIR_FREE(hostname);
8887

E
Eric Blake 已提交
8888
    return true;
8889 8890 8891 8892 8893
}

/*
 * "uri" command
 */
8894
static const vshCmdInfo info_uri[] = {
8895
    {"help", N_("print the hypervisor canonical URI")},
8896
    {"desc", ""},
8897 8898 8899
    {NULL, NULL}
};

E
Eric Blake 已提交
8900
static bool
8901
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8902 8903 8904
{
    char *uri;

8905
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8906
        return false;
8907 8908 8909

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
8910
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
8911
        return false;
8912 8913 8914
    }

    vshPrint (ctl, "%s\n", uri);
8915
    VIR_FREE(uri);
8916

E
Eric Blake 已提交
8917
    return true;
8918 8919
}

E
Eric Blake 已提交
8920 8921 8922 8923 8924 8925 8926 8927 8928 8929
/*
 * "sysinfo" command
 */
static const vshCmdInfo info_sysinfo[] = {
    {"help", N_("print the hypervisor sysinfo")},
    {"desc",
     N_("output an XML string for the hypervisor sysinfo, if available")},
    {NULL, NULL}
};

E
Eric Blake 已提交
8930
static bool
E
Eric Blake 已提交
8931 8932 8933 8934 8935
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8936
        return false;
E
Eric Blake 已提交
8937 8938 8939 8940

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
8941
        return false;
E
Eric Blake 已提交
8942 8943 8944 8945 8946
    }

    vshPrint (ctl, "%s", sysinfo);
    VIR_FREE(sysinfo);

E
Eric Blake 已提交
8947
    return true;
E
Eric Blake 已提交
8948 8949
}

8950 8951 8952
/*
 * "vncdisplay" command
 */
8953
static const vshCmdInfo info_vncdisplay[] = {
8954 8955
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
8956 8957 8958
    {NULL, NULL}
};

8959
static const vshCmdOptDef opts_vncdisplay[] = {
8960
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8961 8962 8963
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8964
static bool
8965
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
8966 8967 8968 8969 8970
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
8971
    bool ret = false;
8972 8973 8974
    int port = 0;
    char *doc;

8975
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8976
        return false;
8977

J
Jim Meyering 已提交
8978
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
8979
        return false;
8980 8981 8982 8983 8984 8985 8986 8987

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
8988
    VIR_FREE(doc);
8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        goto cleanup;

    obj = xmlXPathEval(BAD_CAST "string(/domain/devices/graphics[@type='vnc']/@port)", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_STRING) ||
        (obj->stringval == NULL) || (obj->stringval[0] == 0)) {
        goto cleanup;
    }
    if (virStrToLong_i((const char *)obj->stringval, NULL, 10, &port) || port < 0)
        goto cleanup;
    xmlXPathFreeObject(obj);

    obj = xmlXPathEval(BAD_CAST "string(/domain/devices/graphics[@type='vnc']/@listen)", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_STRING) ||
        (obj->stringval == NULL) || (obj->stringval[0] == 0) ||
9007
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
9008 9009 9010 9011 9012 9013
        vshPrint(ctl, ":%d\n", port-5900);
    } else {
        vshPrint(ctl, "%s:%d\n", (const char *)obj->stringval, port-5900);
    }
    xmlXPathFreeObject(obj);
    obj = NULL;
E
Eric Blake 已提交
9014
    ret = true;
9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
9028
static const vshCmdInfo info_ttyconsole[] = {
9029 9030
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
9031 9032 9033
    {NULL, NULL}
};

9034
static const vshCmdOptDef opts_ttyconsole[] = {
9035
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9036 9037 9038
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9039
static bool
9040
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
9041 9042 9043 9044 9045
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9046
    bool ret = false;
9047 9048
    char *doc;

9049
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9050
        return false;
9051

J
Jim Meyering 已提交
9052
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9053
        return false;
9054 9055 9056 9057 9058 9059 9060 9061

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
9062
    VIR_FREE(doc);
9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        goto cleanup;

    obj = xmlXPathEval(BAD_CAST "string(/domain/devices/console/@tty)", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_STRING) ||
        (obj->stringval == NULL) || (obj->stringval[0] == 0)) {
        goto cleanup;
    }
    vshPrint(ctl, "%s\n", (const char *)obj->stringval);
E
Eric Blake 已提交
9075
    ret = true;
9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
9088
 */
9089
static const vshCmdInfo info_attach_device[] = {
9090 9091
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
9092 9093 9094
    {NULL, NULL}
};

9095
static const vshCmdOptDef opts_attach_device[] = {
9096 9097 9098
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"file",   VSH_OT_DATA, VSH_OFLAG_REQ, N_("XML file")},
    {"persistent", VSH_OT_BOOL, 0, N_("persist device attachment")},
9099 9100 9101
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9102
static bool
9103
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
9104 9105
{
    virDomainPtr dom;
9106
    const char *from = NULL;
9107
    char *buffer;
W
Wen Congyang 已提交
9108
    int ret;
J
Jim Fehlig 已提交
9109
    unsigned int flags;
9110

9111
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9112
        return false;
9113

J
Jim Meyering 已提交
9114
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9115
        return false;
9116

9117
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9118
        virDomainFree(dom);
E
Eric Blake 已提交
9119
        return false;
9120 9121
    }

9122
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9123
        virshReportError(ctl);
9124
        virDomainFree(dom);
E
Eric Blake 已提交
9125
        return false;
9126
    }
9127

J
Jim Fehlig 已提交
9128 9129 9130 9131 9132 9133 9134 9135
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
           flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
9136
    VIR_FREE(buffer);
9137 9138

    if (ret < 0) {
9139
        vshError(ctl, _("Failed to attach device from %s"), from);
9140
        virDomainFree(dom);
E
Eric Blake 已提交
9141
        return false;
9142
    } else {
J
Jim Meyering 已提交
9143
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
9144 9145 9146
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9147
    return true;
9148 9149 9150 9151 9152 9153
}


/*
 * "detach-device" command
 */
9154
static const vshCmdInfo info_detach_device[] = {
9155 9156
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
9157 9158 9159
    {NULL, NULL}
};

9160
static const vshCmdOptDef opts_detach_device[] = {
9161 9162 9163
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"file",   VSH_OT_DATA, VSH_OFLAG_REQ, N_("XML file")},
    {"persistent", VSH_OT_BOOL, 0, N_("persist device detachment")},
9164 9165 9166
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9167
static bool
9168
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
9169 9170
{
    virDomainPtr dom;
9171
    const char *from = NULL;
9172
    char *buffer;
W
Wen Congyang 已提交
9173
    int ret;
J
Jim Fehlig 已提交
9174
    unsigned int flags;
9175

9176
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9177
        return false;
9178

J
Jim Meyering 已提交
9179
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9180
        return false;
9181

9182
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9183
        virDomainFree(dom);
E
Eric Blake 已提交
9184
        return false;
9185 9186
    }

9187
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9188
        virshReportError(ctl);
9189
        virDomainFree(dom);
E
Eric Blake 已提交
9190
        return false;
9191
    }
9192

J
Jim Fehlig 已提交
9193 9194 9195 9196 9197 9198 9199 9200
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
           flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
9201
    VIR_FREE(buffer);
9202 9203

    if (ret < 0) {
9204
        vshError(ctl, _("Failed to detach device from %s"), from);
9205
        virDomainFree(dom);
E
Eric Blake 已提交
9206
        return false;
9207
    } else {
J
Jim Meyering 已提交
9208
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
9209 9210 9211
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9212
    return true;
9213 9214
}

9215

9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228
/*
 * "update-device" command
 */
static const vshCmdInfo info_update_device[] = {
    {"help", N_("update device from an XML file")},
    {"desc", N_("Update device from an XML <file>.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_update_device[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"file",   VSH_OT_DATA, VSH_OFLAG_REQ, N_("XML file")},
    {"persistent", VSH_OT_BOOL, 0, N_("persist device update")},
9229
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
9230 9231 9232
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9233
static bool
9234 9235 9236
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
9237
    const char *from = NULL;
9238
    char *buffer;
W
Wen Congyang 已提交
9239
    int ret;
9240 9241
    unsigned int flags;

9242
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9243
        return false;
9244 9245

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9246
        return false;
9247

9248
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9249
        virDomainFree(dom);
E
Eric Blake 已提交
9250
        return false;
9251 9252 9253
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9254
        virshReportError(ctl);
9255
        virDomainFree(dom);
E
Eric Blake 已提交
9256
        return false;
9257 9258 9259 9260 9261 9262 9263 9264 9265
    }

    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
           flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
    } else {
        flags = VIR_DOMAIN_DEVICE_MODIFY_LIVE;
    }
9266 9267 9268 9269

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

9270 9271 9272 9273 9274 9275
    ret = virDomainUpdateDeviceFlags(dom, buffer, flags);
    VIR_FREE(buffer);

    if (ret < 0) {
        vshError(ctl, _("Failed to update device from %s"), from);
        virDomainFree(dom);
E
Eric Blake 已提交
9276
        return false;
9277 9278 9279 9280 9281
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9282
    return true;
9283 9284 9285
}


9286 9287 9288
/*
 * "attach-interface" command
 */
9289
static const vshCmdInfo info_attach_interface[] = {
9290 9291
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
9292 9293 9294
    {NULL, NULL}
};

9295
static const vshCmdOptDef opts_attach_interface[] = {
9296 9297 9298 9299 9300 9301
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"type",   VSH_OT_DATA, VSH_OFLAG_REQ, N_("network interface type")},
    {"source", VSH_OT_DATA, VSH_OFLAG_REQ, N_("source of network interface")},
    {"target", VSH_OT_DATA, 0, N_("target network name")},
    {"mac",    VSH_OT_DATA, 0, N_("MAC address")},
    {"script", VSH_OT_DATA, 0, N_("script used to bridge network interface")},
9302
    {"model", VSH_OT_DATA, 0, N_("model type")},
9303
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
9304 9305 9306
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9307
static bool
9308
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
9309 9310
{
    virDomainPtr dom = NULL;
9311 9312
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
9313
    int typ;
W
Wen Congyang 已提交
9314 9315
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9316
    unsigned int flags;
9317 9318
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9319

9320
    if (!vshConnectionUsability(ctl, ctl->conn))
9321 9322
        goto cleanup;

J
Jim Meyering 已提交
9323
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9324 9325
        goto cleanup;

9326
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9327 9328
        goto cleanup;

9329 9330 9331 9332
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
9333 9334
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
9335
        goto cleanup;
9336
    }
9337 9338

    /* check interface type */
9339
    if (STREQ(type, "network")) {
9340
        typ = 1;
9341
    } else if (STREQ(type, "bridge")) {
9342 9343
        typ = 2;
    } else {
E
Eric Blake 已提交
9344 9345
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
9346 9347 9348 9349
        goto cleanup;
    }

    /* Make XML of interface */
9350
    virBufferAsprintf(&buf, "<interface type='%s'>\n", type);
9351

9352
    if (typ == 1)
9353
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
9354
    else if (typ == 2)
9355
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
9356

9357
    if (target != NULL)
9358
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9359
    if (mac != NULL)
9360
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
9361
    if (script != NULL)
9362
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
9363
    if (model != NULL)
9364
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
9365

9366
    virBufferAddLit(&buf, "</interface>\n");
9367

9368 9369
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
9370
        goto cleanup;
9371 9372
    }

9373
    xml = virBufferContentAndReset(&buf);
9374

J
Jim Fehlig 已提交
9375 9376 9377 9378
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9379
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
9380
    } else {
9381
        ret = virDomainAttachDevice(dom, xml);
9382
    }
9383

9384 9385
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9386
    if (ret != 0) {
L
Laine Stump 已提交
9387
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
9388 9389
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
9390
        functionReturn = true;
J
Jim Fehlig 已提交
9391
    }
9392 9393 9394 9395

 cleanup:
    if (dom)
        virDomainFree(dom);
9396
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
9397
    return functionReturn;
9398 9399 9400 9401 9402
}

/*
 * "detach-interface" command
 */
9403
static const vshCmdInfo info_detach_interface[] = {
9404 9405
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
9406 9407 9408
    {NULL, NULL}
};

9409
static const vshCmdOptDef opts_detach_interface[] = {
9410 9411 9412 9413
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"type",   VSH_OT_DATA, VSH_OFLAG_REQ, N_("network interface type")},
    {"mac",    VSH_OT_STRING, 0, N_("MAC address")},
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface detachment")},
9414 9415 9416
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9417
static bool
9418
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
9419 9420 9421 9422 9423 9424 9425
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
9426
    const char *mac =NULL, *type = NULL;
9427
    char *doc;
9428
    char buf[64];
E
Eric Blake 已提交
9429
    int i = 0, diff_mac;
W
Wen Congyang 已提交
9430 9431
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
9432
    unsigned int flags;
9433

9434
    if (!vshConnectionUsability(ctl, ctl->conn))
9435 9436
        goto cleanup;

J
Jim Meyering 已提交
9437
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9438 9439
        goto cleanup;

9440
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9441 9442
        goto cleanup;

9443 9444
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
9445
        goto cleanup;
9446
    }
9447 9448 9449 9450 9451 9452 9453 9454

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
9455
    VIR_FREE(doc);
9456
    if (!xml) {
9457
        vshError(ctl, "%s", _("Failed to get interface information"));
9458 9459 9460 9461
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9462
        vshError(ctl, "%s", _("Failed to get interface information"));
9463 9464 9465
        goto cleanup;
    }

E
Eric Blake 已提交
9466
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
9467 9468 9469
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9470
        vshError(ctl, _("No found interface whose type is %s"), type);
9471 9472 9473
        goto cleanup;
    }

9474 9475 9476 9477 9478 9479
    if ((!mac) && (obj->nodesetval->nodeNr > 1)) {
        vshError(ctl, _("Domain has %d interfaces. Please specify which one "
                        "to detach using --mac"), obj->nodesetval->nodeNr);
        goto cleanup;
    }

9480 9481 9482 9483 9484 9485 9486
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9487 9488 9489 9490 9491
            if (cur->type == XML_ELEMENT_NODE &&
                xmlStrEqual(cur->name, BAD_CAST "mac")) {
                char *tmp_mac = virXMLPropString(cur, "address");
                diff_mac = virMacAddrCompare (tmp_mac, mac);
                VIR_FREE(tmp_mac);
9492 9493 9494 9495 9496 9497 9498
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9499
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
9500 9501 9502 9503 9504
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9505
        vshError(ctl, "%s", _("Failed to allocate memory"));
9506 9507 9508
        goto cleanup;
    }

9509
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
9510
        vshError(ctl, "%s", _("Failed to create XML"));
9511 9512 9513
        goto cleanup;
    }

J
Jim Fehlig 已提交
9514 9515 9516 9517 9518 9519 9520 9521 9522 9523 9524 9525
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
9526
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
9527
    } else {
J
Jim Meyering 已提交
9528
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
9529
        functionReturn = true;
9530
    }
9531 9532 9533 9534

 cleanup:
    if (dom)
        virDomainFree(dom);
9535
    xmlXPathFreeObject(obj);
9536
    xmlXPathFreeContext(ctxt);
9537 9538 9539 9540
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
9541
    return functionReturn;
9542 9543 9544 9545 9546
}

/*
 * "attach-disk" command
 */
9547
static const vshCmdInfo info_attach_disk[] = {
9548 9549
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
9550 9551 9552
    {NULL, NULL}
};

9553
static const vshCmdOptDef opts_attach_disk[] = {
9554 9555 9556 9557 9558 9559 9560 9561
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"source",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("source of disk device")},
    {"target",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("target of disk device")},
    {"driver",    VSH_OT_STRING, 0, N_("driver of disk device")},
    {"subdriver", VSH_OT_STRING, 0, N_("subdriver of disk device")},
    {"type",    VSH_OT_STRING, 0, N_("target device type")},
    {"mode",    VSH_OT_STRING, 0, N_("mode of device reading and writing")},
    {"persistent", VSH_OT_BOOL, 0, N_("persist disk attachment")},
9562
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
9563 9564 9565
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9566
static bool
9567
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
9568 9569
{
    virDomainPtr dom = NULL;
9570 9571
    const char *source = NULL, *target = NULL, *driver = NULL,
                *subdriver = NULL, *type = NULL, *mode = NULL;
W
Wen Congyang 已提交
9572 9573
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
9574
    unsigned int flags;
9575
    const char *stype = NULL;
9576 9577
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9578

9579
    if (!vshConnectionUsability(ctl, ctl->conn))
9580 9581
        goto cleanup;

J
Jim Meyering 已提交
9582
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9583 9584
        goto cleanup;

9585
    if (vshCommandOptString(cmd, "source", &source) <= 0)
9586 9587
        goto cleanup;

9588
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9589 9590
        goto cleanup;

9591 9592 9593 9594 9595
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
9596
        vshError(ctl, "%s", _("missing option"));
9597 9598
        goto cleanup;
    }
9599

9600 9601
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
9602
            isFile = true;
9603
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
9604
        isFile = true;
9605 9606 9607
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
9608 9609 9610
    }

    if (mode) {
9611
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
9612 9613
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
9614 9615 9616 9617 9618
            goto cleanup;
        }
    }

    /* Make XML of disk */
9619
    virBufferAsprintf(&buf, "<disk type='%s'",
9620 9621
                      (isFile) ? "file" : "block");
    if (type)
9622
        virBufferAsprintf(&buf, " device='%s'", type);
9623 9624
    virBufferAddLit(&buf, ">\n");

9625
    if (driver || subdriver)
9626
        virBufferAsprintf(&buf, "  <driver");
9627 9628

    if (driver)
9629
        virBufferAsprintf(&buf, " name='%s'", driver);
9630
    if (subdriver)
9631
        virBufferAsprintf(&buf, " type='%s'", subdriver);
9632 9633 9634

    if (driver || subdriver)
        virBufferAddLit(&buf, "/>\n");
9635

9636
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
9637 9638
                      (isFile) ? "file" : "dev",
                      source);
9639
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9640
    if (mode)
9641
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
9642 9643

    virBufferAddLit(&buf, "</disk>\n");
9644

9645 9646
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
9647
        return false;
9648 9649
    }

9650
    xml = virBufferContentAndReset(&buf);
9651

J
Jim Fehlig 已提交
9652 9653 9654 9655
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9656
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
9657
    } else {
9658
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
9659
    }
9660

9661 9662
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9663
    if (ret != 0) {
L
Laine Stump 已提交
9664
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
9665 9666
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
9667
        functionReturn = true;
J
Jim Fehlig 已提交
9668
    }
9669 9670 9671 9672

 cleanup:
    if (dom)
        virDomainFree(dom);
9673
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
9674
    return functionReturn;
9675 9676 9677 9678 9679
}

/*
 * "detach-disk" command
 */
9680
static const vshCmdInfo info_detach_disk[] = {
9681 9682
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
9683 9684 9685
    {NULL, NULL}
};

9686
static const vshCmdOptDef opts_detach_disk[] = {
9687 9688 9689
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"target", VSH_OT_DATA, VSH_OFLAG_REQ, N_("target of disk device")},
    {"persistent", VSH_OT_BOOL, 0, N_("persist disk detachment")},
9690 9691 9692
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9693
static bool
9694
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
9695 9696 9697 9698 9699 9700 9701
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
9702
    const char *target = NULL;
9703
    char *doc;
E
Eric Blake 已提交
9704
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
9705 9706
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9707
    unsigned int flags;
9708

9709
    if (!vshConnectionUsability(ctl, ctl->conn))
9710 9711
        goto cleanup;

J
Jim Meyering 已提交
9712
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9713 9714
        goto cleanup;

9715
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9716 9717 9718 9719 9720 9721 9722 9723 9724
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
9725
    VIR_FREE(doc);
9726
    if (!xml) {
9727
        vshError(ctl, "%s", _("Failed to get disk information"));
9728 9729 9730 9731
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9732
        vshError(ctl, "%s", _("Failed to get disk information"));
9733 9734 9735 9736 9737 9738
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9739
        vshError(ctl, "%s", _("Failed to get disk information"));
9740 9741 9742 9743 9744 9745 9746
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9747 9748 9749 9750 9751
            if (cur->type == XML_ELEMENT_NODE &&
                xmlStrEqual(cur->name, BAD_CAST "target")) {
                char *tmp_tgt = virXMLPropString(cur, "dev");
                diff_tgt = STREQ(tmp_tgt, target);
                VIR_FREE(tmp_tgt);
9752 9753 9754 9755 9756 9757 9758
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9759
    vshError(ctl, _("No found disk whose target is %s"), target);
9760 9761 9762 9763 9764
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9765
        vshError(ctl, "%s", _("Failed to allocate memory"));
9766 9767 9768
        goto cleanup;
    }

9769
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
9770
        vshError(ctl, "%s", _("Failed to create XML"));
9771 9772 9773
        goto cleanup;
    }

J
Jim Fehlig 已提交
9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
9786
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
9787
    } else {
J
Jim Meyering 已提交
9788
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
9789
        functionReturn = true;
9790
    }
9791 9792

 cleanup:
9793
    xmlXPathFreeObject(obj);
9794
    xmlXPathFreeContext(ctxt);
9795 9796 9797 9798 9799 9800
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
9801
    return functionReturn;
9802 9803
}

9804 9805 9806 9807
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
9808 9809
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
9810 9811 9812 9813
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
9814
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
9815 9816 9817
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9818
static bool
9819 9820
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
9821
    const char *from = NULL;
E
Eric Blake 已提交
9822
    bool ret = true;
9823 9824 9825
    char *buffer;
    int result;

9826
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9827
        return false;
9828

9829
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9830
        return false;
9831 9832

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
9833
        return false;
9834 9835

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
9836
    VIR_FREE(buffer);
9837 9838 9839 9840 9841

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
9842
        ret = false;
9843 9844 9845 9846 9847
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
9848
        ret = true;
9849 9850 9851 9852 9853
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
9854
        ret = true;
9855 9856 9857 9858 9859
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
9860
        ret = false;
9861 9862 9863 9864 9865
    }

    return ret;
}

9866 9867 9868 9869
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
9870 9871
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
9872 9873 9874 9875
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
9876
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
9877 9878 9879
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9880
static bool
9881 9882
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
9883
    const char *from = NULL;
E
Eric Blake 已提交
9884
    bool ret = true;
9885 9886 9887 9888 9889
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
9890
    xmlNodePtr node_list;
9891 9892 9893 9894 9895 9896
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

9897
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9898
        return false;
9899

9900
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9901
        return false;
9902 9903

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
9904
        return false;
9905 9906 9907 9908 9909

    doc = xmlNewDoc(NULL);
    if (doc == NULL)
        goto no_memory;

L
Laine Stump 已提交
9910 9911
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
9912 9913
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
9914
        ret = false;
9915 9916 9917 9918 9919 9920 9921 9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950
        goto cleanup;
    }

    xmlAddChildList((xmlNodePtr) doc, node_list);

    ctxt = xmlXPathNewContext(doc);
    if (!ctxt)
        goto no_memory;

    obj = xmlXPathEval(BAD_CAST "//cpu[not(ancestor::cpu)]", ctxt);
    if ((obj == NULL) || (obj->nodesetval == NULL) ||
        (obj->nodesetval->nodeTab == NULL))
        goto cleanup;

    for (i = 0;i < obj->nodesetval->nodeNr;i++) {
        buf = xmlBufferCreate();
        if (buf == NULL)
            goto no_memory;
        sctxt = xmlSaveToBuffer(buf, NULL, 0);
        if (sctxt == NULL) {
            xmlBufferFree(buf);
            goto no_memory;
        }

        xmlSaveTree(sctxt, obj->nodesetval->nodeTab[i]);
        xmlSaveClose(sctxt);

        list = vshRealloc(ctl, list, sizeof(char *) * (count + 1));
        list[count++] = (char *) buf->content;
        buf->content = NULL;
        xmlBufferFree(buf);
        buf = NULL;
    }

    if (count == 0) {
        vshError(ctl, _("No host CPU specified in '%s'"), from);
E
Eric Blake 已提交
9951
        ret = false;
9952 9953 9954 9955 9956 9957 9958 9959
        goto cleanup;
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
9960
        ret = false;
9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977

cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(doc);
    VIR_FREE(result);
    if ((list != NULL) && (count > 0)) {
        for (i = 0;i < count;i++)
            VIR_FREE(list[i]);
    }
    VIR_FREE(list);
    VIR_FREE(buffer);

    return ret;

no_memory:
    vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
9978
    ret = false;
9979
    goto cleanup;
9980 9981
}

9982 9983 9984 9985 9986 9987 9988 9989
/* Common code for the edit / net-edit / pool-edit functions which follow. */
static char *
editWriteToTempFile (vshControl *ctl, const char *doc)
{
    char *ret;
    const char *tmpdir;
    int fd;

9990
    ret = vshMalloc(ctl, PATH_MAX);
9991 9992 9993

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
9994 9995
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
9996
    if (fd == -1) {
9997
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
9998
                 strerror(errno));
9999
        VIR_FREE(ret);
10000 10001 10002 10003
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
10004 10005
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
10006
        VIR_FORCE_CLOSE(fd);
10007
        unlink (ret);
10008
        VIR_FREE(ret);
10009 10010
        return NULL;
    }
S
Stefan Berger 已提交
10011
    if (VIR_CLOSE(fd) < 0) {
10012 10013
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
10014
        unlink (ret);
10015
        VIR_FREE(ret);
10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030
        return NULL;
    }

    /* Temporary filename: caller frees. */
    return ret;
}

/* Characters permitted in $EDITOR environment variable and temp filename. */
#define ACCEPTED_CHARS \
  "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-/_.:@"

static int
editFile (vshControl *ctl, const char *filename)
{
    const char *editor;
E
Eric Blake 已提交
10031 10032 10033 10034
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
10035

10036
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
10037 10038 10039 10040
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
10041

10042 10043 10044 10045 10046
    /* Check that filename doesn't contain shell meta-characters, and
     * if it does, refuse to run.  Follow the Unix conventions for
     * EDITOR: the user can intentionally specify command options, so
     * we don't protect any shell metacharacters there.  Lots more
     * than virsh will misbehave if EDITOR has bogus contents (which
E
Eric Blake 已提交
10047 10048
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
10049
     */
E
Eric Blake 已提交
10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061
    if (strspn (editor, ACCEPTED_CHARS) != strlen (editor)) {
        if (strspn (filename, ACCEPTED_CHARS) != strlen (filename)) {
            vshError(ctl,
                     _("%s: temporary filename contains shell meta or other "
                       "unacceptable characters (is $TMPDIR wrong?)"),
                     filename);
            return -1;
        }
        cmd = virCommandNewArgList("sh", "-c", NULL);
        virCommandAddArgFormat(cmd, "%s %s", editor, filename);
    } else {
        cmd = virCommandNewArgList(editor, filename, NULL);
10062 10063
    }

E
Eric Blake 已提交
10064 10065 10066 10067 10068 10069 10070
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
10071
    }
E
Eric Blake 已提交
10072
    ret = 0;
10073

E
Eric Blake 已提交
10074 10075 10076
cleanup:
    virCommandFree(cmd);
    return ret;
10077 10078 10079 10080 10081 10082 10083 10084
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
10085
        vshError(ctl,
10086
                 _("%s: failed to read temporary file: %s"),
10087
                 filename, strerror(errno));
10088 10089 10090 10091 10092
        return NULL;
    }
    return ret;
}

10093

P
Paolo Bonzini 已提交
10094 10095 10096 10097
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
10098 10099
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
10100 10101 10102 10103
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
10104
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
10105 10106 10107
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10108
static bool
10109
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
10110
{
10111
    const char *dir = NULL;
10112
    char *dir_malloced = NULL;
E
Eric Blake 已提交
10113
    bool ret = true;
P
Paolo Bonzini 已提交
10114 10115

    if (!ctl->imode) {
10116
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
10117
        return false;
P
Paolo Bonzini 已提交
10118 10119
    }

10120
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
10121
        uid_t uid = geteuid();
10122
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
10123 10124 10125 10126
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
10127
    if (chdir(dir) == -1) {
10128
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
10129
        ret = false;
P
Paolo Bonzini 已提交
10130 10131
    }

10132
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
10133
    return ret;
P
Paolo Bonzini 已提交
10134 10135 10136 10137 10138 10139
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
10140 10141
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
10142 10143 10144
    {NULL, NULL}
};

E
Eric Blake 已提交
10145
static bool
P
Paolo Bonzini 已提交
10146 10147 10148
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
10149
    bool ret = true;
P
Paolo Bonzini 已提交
10150

10151 10152
    cwd = getcwd(NULL, 0);
    if (!cwd) {
10153 10154
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
10155 10156
        ret = false;
    } else {
P
Paolo Bonzini 已提交
10157
        vshPrint (ctl, _("%s\n"), cwd);
10158 10159
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
10160

10161
    return ret;
P
Paolo Bonzini 已提交
10162 10163
}

E
Eric Blake 已提交
10164 10165 10166 10167 10168 10169 10170 10171 10172 10173 10174 10175 10176 10177 10178 10179 10180 10181 10182
/*
 * "echo" command
 */
static const vshCmdInfo info_echo[] = {
    {"help", N_("echo arguments")},
    {"desc", N_("Echo back arguments, possibly with quoting.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_echo[] = {
    {"shell", VSH_OT_BOOL, 0, N_("escape for shell use")},
    {"xml", VSH_OT_BOOL, 0, N_("escape for XML use")},
    {"", VSH_OT_ARGV, 0, N_("arguments to echo")},
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
10183
static bool
E
Eric Blake 已提交
10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

    while ((arg = vshCommandOptArgv(cmd, count)) != NULL) {
        bool close_quote = false;
        char *q;

        if (count)
            virBufferAddChar(&buf, ' ');
        /* Add outer '' only if arg included shell metacharacters.  */
        if (shell &&
            (strpbrk(arg, "\r\t\n !\"#$&'()*;<>?[\\]^`{|}~") || !*arg)) {
            virBufferAddChar(&buf, '\'');
            close_quote = true;
        }
        if (xml) {
            virBufferEscapeString(&buf, "%s", arg);
        } else {
            if (shell && (q = strchr(arg, '\''))) {
                do {
                    virBufferAdd(&buf, arg, q - arg);
                    virBufferAddLit(&buf, "'\\''");
                    arg = q + 1;
                    q = strchr(arg, '\'');
                } while (q);
            }
            virBufferAdd(&buf, arg, strlen(arg));
        }
        if (close_quote)
            virBufferAddChar(&buf, '\'');
        count++;
    }

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
10229
        return false;
E
Eric Blake 已提交
10230 10231 10232 10233 10234
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
10235
    return true;
E
Eric Blake 已提交
10236 10237
}

10238 10239 10240 10241
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
10242 10243
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
10244 10245 10246 10247
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
10248
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10249 10250 10251 10252 10253 10254
    {NULL, 0, 0, NULL}
};

/* This function also acts as a template to generate cmdNetworkEdit
 * and cmdPoolEdit functions (below) using a sed script in the Makefile.
 */
E
Eric Blake 已提交
10255
static bool
10256 10257
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
10258
    bool ret = false;
10259 10260 10261 10262 10263
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
10264
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
10265

10266
    if (!vshConnectionUsability(ctl, ctl->conn))
10267 10268
        goto cleanup;

J
Jim Meyering 已提交
10269
    dom = vshCommandOptDomain (ctl, cmd, NULL);
10270 10271 10272 10273
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
10274
    doc = virDomainGetXMLDesc (dom, flags);
10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292
    if (!doc)
        goto cleanup;

    /* Create and open the temporary file. */
    tmp = editWriteToTempFile (ctl, doc);
    if (!tmp) goto cleanup;

    /* Start the editor. */
    if (editFile (ctl, tmp) == -1) goto cleanup;

    /* Read back the edited file. */
    doc_edited = editReadBackFile (ctl, tmp);
    if (!doc_edited) goto cleanup;

    /* Compare original XML with edited.  Has it changed at all? */
    if (STREQ (doc, doc_edited)) {
        vshPrint (ctl, _("Domain %s XML configuration not changed.\n"),
                  virDomainGetName (dom));
E
Eric Blake 已提交
10293
        ret = true;
10294 10295 10296 10297 10298 10299 10300
        goto cleanup;
    }

    /* Now re-read the domain XML.  Did someone else change it while
     * it was being edited?  This also catches problems such as us
     * losing a connection or the domain going away.
     */
10301
    doc_reread = virDomainGetXMLDesc (dom, flags);
10302 10303 10304 10305
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
10306 10307
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319
        goto cleanup;
    }

    /* Everything checks out, so redefine the domain. */
    virDomainFree (dom);
    dom = virDomainDefineXML (ctl->conn, doc_edited);
    if (!dom)
        goto cleanup;

    vshPrint (ctl, _("Domain %s XML configuration edited.\n"),
              virDomainGetName(dom));

E
Eric Blake 已提交
10320
    ret = true;
10321 10322 10323 10324 10325

 cleanup:
    if (dom)
        virDomainFree (dom);

10326 10327 10328
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
10329 10330 10331

    if (tmp) {
        unlink (tmp);
10332
        VIR_FREE(tmp);
10333 10334 10335 10336 10337
    }

    return ret;
}

10338

10339 10340 10341 10342
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
10343 10344
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
10345 10346 10347 10348
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
10349
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
10350 10351 10352 10353 10354 10355 10356 10357 10358 10359
    {NULL, 0, 0, NULL}
};

/* This is generated from this file by a sed script in the Makefile. */
#include "virsh-net-edit.c"

/*
 * "pool-edit" command
 */
static const vshCmdInfo info_pool_edit[] = {
10360 10361
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
10362 10363 10364 10365
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
10366
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10367 10368 10369 10370 10371 10372
    {NULL, 0, 0, NULL}
};

/* This is generated from this file by a sed script in the Makefile. */
#include "virsh-pool-edit.c"

K
Karel Zak 已提交
10373 10374 10375
/*
 * "quit" command
 */
10376
static const vshCmdInfo info_quit[] = {
10377
    {"help", N_("quit this interactive terminal")},
10378
    {"desc", ""},
10379
    {NULL, NULL}
K
Karel Zak 已提交
10380 10381
};

E
Eric Blake 已提交
10382
static bool
10383
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10384
{
E
Eric Blake 已提交
10385 10386
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
10387 10388
}

10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
    {"help", N_("Create a snapshot")},
    {"desc", N_("Snapshot create")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_create[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"xmlfile", VSH_OT_DATA, 0, N_("domain snapshot XML")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10404
static bool
10405 10406 10407
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10408
    bool ret = false;
10409
    const char *from = NULL;
10410 10411 10412 10413 10414 10415 10416
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

10417
    if (!vshConnectionUsability(ctl, ctl->conn))
10418 10419 10420 10421 10422 10423
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10424
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
10425
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469
    else {
        if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
            /* we have to report the error here because during cleanup
             * we'll run through virDomainFree(), which loses the
             * last error
             */
            virshReportError(ctl);
            goto cleanup;
        }
    }
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

    snapshot = virDomainSnapshotCreateXML(dom, buffer, 0);
    if (snapshot == NULL)
        goto cleanup;

    doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domainsnapshot.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        goto cleanup;

    name = virXPathString("string(/domainsnapshot/name)", ctxt);
    if (!name) {
        vshError(ctl, "%s",
                 _("Could not find 'name' element in domain snapshot XML"));
        goto cleanup;
    }

    vshPrint(ctl, _("Domain snapshot %s created"), name);
    if (from)
        vshPrint(ctl, _(" from '%s'"), from);
    vshPrint(ctl, "\n");

E
Eric Blake 已提交
10470
    ret = true;
10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500

cleanup:
    VIR_FREE(name);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
    {"help", N_("Get the current snapshot")},
    {"desc", N_("Get the current snapshot")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10501
static bool
10502 10503 10504
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10505
    bool ret = false;
10506 10507 10508
    int current;
    virDomainSnapshotPtr snapshot = NULL;

10509
    if (!vshConnectionUsability(ctl, ctl->conn))
10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
        char *xml;

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

        xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
        if (!xml)
            goto cleanup;

        vshPrint(ctl, "%s", xml);
        VIR_FREE(xml);
    }

E
Eric Blake 已提交
10533
    ret = true;
10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-list" command
 */
static const vshCmdInfo info_snapshot_list[] = {
    {"help", N_("List snapshots for a domain")},
    {"desc", N_("Snapshot List")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_list[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10558
static bool
10559 10560 10561
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10562
    bool ret = false;
10563 10564
    int numsnaps;
    char **names = NULL;
10565
    int actual = 0;
10566 10567 10568 10569 10570 10571
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
10572 10573
    long long creation_longlong;
    time_t creation_time_t;
10574 10575 10576
    char timestr[100];
    struct tm time_info;

10577
    if (!vshConnectionUsability(ctl, ctl->conn))
10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

10589 10590
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631

    if (numsnaps) {
        if (VIR_ALLOC_N(names, numsnaps) < 0)
            goto cleanup;

        actual = virDomainSnapshotListNames(dom, names, numsnaps, 0);
        if (actual < 0)
            goto cleanup;

        qsort(&names[0], actual, sizeof(char*), namesorter);

        for (i = 0; i < actual; i++) {
            /* free up memory from previous iterations of the loop */
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
            if (xml)
                xmlFreeDoc(xml);
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

            xml = xmlReadDoc((const xmlChar *) doc, "domainsnapshot.xml", NULL,
                             XML_PARSE_NOENT | XML_PARSE_NONET |
                             XML_PARSE_NOWARNING);
            if (!xml)
                continue;
            ctxt = xmlXPathNewContext(xml);
            if (!ctxt)
                continue;

            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
10632 10633
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
10634
                continue;
10635 10636 10637 10638 10639 10640
            creation_time_t = creation_longlong;
            if (creation_time_t != creation_longlong) {
                vshError(ctl, "%s", _("time_t overflow"));
                continue;
            }
            localtime_r(&creation_time_t, &time_info);
10641
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
10642 10643 10644 10645 10646

            vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
        }
    }

E
Eric Blake 已提交
10647
    ret = true;
10648 10649 10650 10651 10652 10653 10654 10655 10656 10657

cleanup:
    /* this frees up memory from the last iteration of the loop */
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    VIR_FREE(doc);
10658 10659
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681
    VIR_FREE(names);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-dumpxml" command
 */
static const vshCmdInfo info_snapshot_dumpxml[] = {
    {"help", N_("Dump XML for a domain snapshot")},
    {"desc", N_("Snapshot Dump XML")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_dumpxml[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10682
static bool
10683 10684 10685
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10686
    bool ret = false;
10687
    const char *name = NULL;
10688 10689 10690
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

10691
    if (!vshConnectionUsability(ctl, ctl->conn))
10692 10693 10694 10695 10696 10697
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10698
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10699 10700 10701 10702 10703 10704 10705 10706 10707 10708
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

10709
    vshPrint(ctl, "%s", xml);
10710

E
Eric Blake 已提交
10711
    ret = true;
10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
10724
 * "snapshot-revert" command
10725
 */
10726
static const vshCmdInfo info_snapshot_revert[] = {
10727 10728 10729 10730 10731
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

10732
static const vshCmdOptDef opts_snapshot_revert[] = {
10733 10734 10735 10736 10737
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10738
static bool
10739
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
10740 10741
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10742
    bool ret = false;
10743
    const char *name = NULL;
10744 10745
    virDomainSnapshotPtr snapshot = NULL;

10746
    if (!vshConnectionUsability(ctl, ctl->conn))
10747 10748 10749 10750 10751 10752
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10753
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10754 10755 10756 10757 10758 10759 10760 10761 10762
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    if (virDomainRevertToSnapshot(snapshot, 0) < 0)
        goto cleanup;

E
Eric Blake 已提交
10763
    ret = true;
10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 10774 10775 10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-delete" command
 */
static const vshCmdInfo info_snapshot_delete[] = {
    {"help", N_("Delete a domain snapshot")},
    {"desc", N_("Snapshot Delete")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_delete[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {"children", VSH_OT_BOOL, 0, N_("delete snapshot and all children")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10790
static bool
10791 10792 10793
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10794
    bool ret = false;
10795
    const char *name = NULL;
10796 10797 10798
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

10799
    if (!vshConnectionUsability(ctl, ctl->conn))
10800 10801 10802 10803 10804 10805
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10806
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    if (virDomainSnapshotDelete(snapshot, flags) < 0)
        goto cleanup;

E
Eric Blake 已提交
10819
    ret = true;
10820 10821 10822 10823 10824 10825 10826 10827 10828 10829

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
    {"help", N_("Qemu Monitor Command")},
    {"desc", N_("Qemu Monitor Command")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"cmd", VSH_OT_DATA, VSH_OFLAG_REQ, N_("command")},
10842
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
10843 10844 10845
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10846
static bool
10847 10848 10849
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10850
    bool ret = false;
10851
    const char *monitor_cmd = NULL;
10852
    char *result = NULL;
10853
    unsigned int flags = 0;
10854 10855 10856 10857 10858 10859 10860 10861

    if (!vshConnectionUsability(ctl, ctl->conn))
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10862
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
10863 10864 10865 10866
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

10867 10868 10869 10870
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
10871 10872 10873 10874
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
10875
    ret = true;
10876 10877 10878 10879 10880 10881 10882 10883 10884

cleanup:
    VIR_FREE(result);
    if (dom)
        virDomainFree(dom);

    return ret;
}

10885
static const vshCmdDef domManagementCmds[] = {
10886 10887 10888 10889 10890 10891 10892 10893
    {"attach-device", cmdAttachDevice, opts_attach_device,
     info_attach_device, 0},
    {"attach-disk", cmdAttachDisk, opts_attach_disk,
     info_attach_disk, 0},
    {"attach-interface", cmdAttachInterface, opts_attach_interface,
     info_attach_interface, 0},
    {"autostart", cmdAutostart, opts_autostart, info_autostart, 0},
    {"blkiotune", cmdBlkiotune, opts_blkiotune, info_blkiotune, 0},
10894
#ifndef WIN32
10895
    {"console", cmdConsole, opts_console, info_console, 0},
10896
#endif
10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948
    {"cpu-baseline", cmdCPUBaseline, opts_cpu_baseline, info_cpu_baseline, 0},
    {"cpu-compare", cmdCPUCompare, opts_cpu_compare, info_cpu_compare, 0},
    {"create", cmdCreate, opts_create, info_create, 0},
    {"define", cmdDefine, opts_define, info_define, 0},
    {"destroy", cmdDestroy, opts_destroy, info_destroy, 0},
    {"detach-device", cmdDetachDevice, opts_detach_device,
     info_detach_device, 0},
    {"detach-disk", cmdDetachDisk, opts_detach_disk, info_detach_disk, 0},
    {"detach-interface", cmdDetachInterface, opts_detach_interface,
     info_detach_interface, 0},
    {"domid", cmdDomid, opts_domid, info_domid, 0},
    {"domjobabort", cmdDomjobabort, opts_domjobabort, info_domjobabort, 0},
    {"domjobinfo", cmdDomjobinfo, opts_domjobinfo, info_domjobinfo, 0},
    {"domname", cmdDomname, opts_domname, info_domname, 0},
    {"domuuid", cmdDomuuid, opts_domuuid, info_domuuid, 0},
    {"domxml-from-native", cmdDomXMLFromNative, opts_domxmlfromnative,
     info_domxmlfromnative, 0},
    {"domxml-to-native", cmdDomXMLToNative, opts_domxmltonative,
     info_domxmltonative, 0},
    {"dump", cmdDump, opts_dump, info_dump, 0},
    {"dumpxml", cmdDumpXML, opts_dumpxml, info_dumpxml, 0},
    {"edit", cmdEdit, opts_edit, info_edit, 0},
    {"inject-nmi", cmdInjectNMI, opts_inject_nmi, info_inject_nmi, 0},
    {"managedsave", cmdManagedSave, opts_managedsave, info_managedsave, 0},
    {"managedsave-remove", cmdManagedSaveRemove, opts_managedsaveremove,
     info_managedsaveremove, 0},
    {"maxvcpus", cmdMaxvcpus, opts_maxvcpus, info_maxvcpus, 0},
    {"memtune", cmdMemtune, opts_memtune, info_memtune, 0},
    {"migrate", cmdMigrate, opts_migrate, info_migrate, 0},
    {"migrate-setmaxdowntime", cmdMigrateSetMaxDowntime,
     opts_migrate_setmaxdowntime, info_migrate_setmaxdowntime, 0},
    {"reboot", cmdReboot, opts_reboot, info_reboot, 0},
    {"restore", cmdRestore, opts_restore, info_restore, 0},
    {"resume", cmdResume, opts_resume, info_resume, 0},
    {"save", cmdSave, opts_save, info_save, 0},
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
    {"setmaxmem", cmdSetmaxmem, opts_setmaxmem, info_setmaxmem, 0},
    {"setmem", cmdSetmem, opts_setmem, info_setmem, 0},
    {"setvcpus", cmdSetvcpus, opts_setvcpus, info_setvcpus, 0},
    {"shutdown", cmdShutdown, opts_shutdown, info_shutdown, 0},
    {"start", cmdStart, opts_start, info_start, 0},
    {"suspend", cmdSuspend, opts_suspend, info_suspend, 0},
    {"ttyconsole", cmdTTYConsole, opts_ttyconsole, info_ttyconsole, 0},
    {"undefine", cmdUndefine, opts_undefine, info_undefine, 0},
    {"update-device", cmdUpdateDevice, opts_update_device,
     info_update_device, 0},
    {"vcpucount", cmdVcpucount, opts_vcpucount, info_vcpucount, 0},
    {"vcpuinfo", cmdVcpuinfo, opts_vcpuinfo, info_vcpuinfo, 0},
    {"vcpupin", cmdVcpupin, opts_vcpupin, info_vcpupin, 0},
    {"version", cmdVersion, NULL, info_version, 0},
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
10949 10950 10951
};

static const vshCmdDef domMonitoringCmds[] = {
10952 10953 10954 10955 10956 10957 10958 10959
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
    {"domifstat", cmdDomIfstat, opts_domifstat, info_domifstat, 0},
    {"dominfo", cmdDominfo, opts_dominfo, info_dominfo, 0},
    {"dommemstat", cmdDomMemStat, opts_dommemstat, info_dommemstat, 0},
    {"domstate", cmdDomstate, opts_domstate, info_domstate, 0},
    {"list", cmdList, opts_list, info_list, 0},
    {NULL, NULL, NULL, NULL, 0}
10960 10961 10962
};

static const vshCmdDef storagePoolCmds[] = {
10963
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
10964
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
10965
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986
     opts_find_storage_pool_sources, info_find_storage_pool_sources, 0},
    {"pool-autostart", cmdPoolAutostart, opts_pool_autostart,
     info_pool_autostart, 0},
    {"pool-build", cmdPoolBuild, opts_pool_build, info_pool_build, 0},
    {"pool-create-as", cmdPoolCreateAs, opts_pool_X_as, info_pool_create_as, 0},
    {"pool-create", cmdPoolCreate, opts_pool_create, info_pool_create, 0},
    {"pool-define-as", cmdPoolDefineAs, opts_pool_X_as, info_pool_define_as, 0},
    {"pool-define", cmdPoolDefine, opts_pool_define, info_pool_define, 0},
    {"pool-delete", cmdPoolDelete, opts_pool_delete, info_pool_delete, 0},
    {"pool-destroy", cmdPoolDestroy, opts_pool_destroy, info_pool_destroy, 0},
    {"pool-dumpxml", cmdPoolDumpXML, opts_pool_dumpxml, info_pool_dumpxml, 0},
    {"pool-edit", cmdPoolEdit, opts_pool_edit, info_pool_edit, 0},
    {"pool-info", cmdPoolInfo, opts_pool_info, info_pool_info, 0},
    {"pool-list", cmdPoolList, opts_pool_list, info_pool_list, 0},
    {"pool-name", cmdPoolName, opts_pool_name, info_pool_name, 0},
    {"pool-refresh", cmdPoolRefresh, opts_pool_refresh, info_pool_refresh, 0},
    {"pool-start", cmdPoolStart, opts_pool_start, info_pool_start, 0},
    {"pool-undefine", cmdPoolUndefine, opts_pool_undefine,
     info_pool_undefine, 0},
    {"pool-uuid", cmdPoolUuid, opts_pool_uuid, info_pool_uuid, 0},
    {NULL, NULL, NULL, NULL, 0}
10987 10988 10989
};

static const vshCmdDef storageVolCmds[] = {
10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001 11002 11003 11004 11005 11006 11007
    {"vol-clone", cmdVolClone, opts_vol_clone, info_vol_clone, 0},
    {"vol-create-as", cmdVolCreateAs, opts_vol_create_as,
     info_vol_create_as, 0},
    {"vol-create", cmdVolCreate, opts_vol_create, info_vol_create, 0},
    {"vol-create-from", cmdVolCreateFrom, opts_vol_create_from,
     info_vol_create_from, 0},
    {"vol-delete", cmdVolDelete, opts_vol_delete, info_vol_delete, 0},
    {"vol-download", cmdVolDownload, opts_vol_download, info_vol_download, 0},
    {"vol-dumpxml", cmdVolDumpXML, opts_vol_dumpxml, info_vol_dumpxml, 0},
    {"vol-info", cmdVolInfo, opts_vol_info, info_vol_info, 0},
    {"vol-key", cmdVolKey, opts_vol_key, info_vol_key, 0},
    {"vol-list", cmdVolList, opts_vol_list, info_vol_list, 0},
    {"vol-name", cmdVolName, opts_vol_name, info_vol_name, 0},
    {"vol-path", cmdVolPath, opts_vol_path, info_vol_path, 0},
    {"vol-pool", cmdVolPool, opts_vol_pool, info_vol_pool, 0},
    {"vol-upload", cmdVolUpload, opts_vol_upload, info_vol_upload, 0},
    {"vol-wipe", cmdVolWipe, opts_vol_wipe, info_vol_wipe, 0},
    {NULL, NULL, NULL, NULL, 0}
11008
};
11009

11010
static const vshCmdDef networkCmds[] = {
11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028 11029
    {"net-autostart", cmdNetworkAutostart, opts_network_autostart,
     info_network_autostart, 0},
    {"net-create", cmdNetworkCreate, opts_network_create,
     info_network_create, 0},
    {"net-define", cmdNetworkDefine, opts_network_define,
     info_network_define, 0},
    {"net-destroy", cmdNetworkDestroy, opts_network_destroy,
     info_network_destroy, 0},
    {"net-dumpxml", cmdNetworkDumpXML, opts_network_dumpxml,
     info_network_dumpxml, 0},
    {"net-edit", cmdNetworkEdit, opts_network_edit, info_network_edit, 0},
    {"net-info", cmdNetworkInfo, opts_network_info, info_network_info, 0},
    {"net-list", cmdNetworkList, opts_network_list, info_network_list, 0},
    {"net-name", cmdNetworkName, opts_network_name, info_network_name, 0},
    {"net-start", cmdNetworkStart, opts_network_start, info_network_start, 0},
    {"net-undefine", cmdNetworkUndefine, opts_network_undefine,
     info_network_undefine, 0},
    {"net-uuid", cmdNetworkUuid, opts_network_uuid, info_network_uuid, 0},
    {NULL, NULL, NULL, NULL, 0}
11030
};
11031

11032
static const vshCmdDef nodedevCmds[] = {
11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047
    {"nodedev-create", cmdNodeDeviceCreate, opts_node_device_create,
     info_node_device_create, 0},
    {"nodedev-destroy", cmdNodeDeviceDestroy, opts_node_device_destroy,
     info_node_device_destroy, 0},
    {"nodedev-dettach", cmdNodeDeviceDettach, opts_node_device_dettach,
     info_node_device_dettach, 0},
    {"nodedev-dumpxml", cmdNodeDeviceDumpXML, opts_node_device_dumpxml,
     info_node_device_dumpxml, 0},
    {"nodedev-list", cmdNodeListDevices, opts_node_list_devices,
     info_node_list_devices, 0},
    {"nodedev-reattach", cmdNodeDeviceReAttach, opts_node_device_reattach,
     info_node_device_reattach, 0},
    {"nodedev-reset", cmdNodeDeviceReset, opts_node_device_reset,
     info_node_device_reset, 0},
    {NULL, NULL, NULL, NULL, 0}
11048 11049 11050
};

static const vshCmdDef ifaceCmds[] = {
11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068
    {"iface-define", cmdInterfaceDefine, opts_interface_define,
     info_interface_define, 0},
    {"iface-destroy", cmdInterfaceDestroy, opts_interface_destroy,
     info_interface_destroy, 0},
    {"iface-dumpxml", cmdInterfaceDumpXML, opts_interface_dumpxml,
     info_interface_dumpxml, 0},
    {"iface-edit", cmdInterfaceEdit, opts_interface_edit,
     info_interface_edit, 0},
    {"iface-list", cmdInterfaceList, opts_interface_list,
     info_interface_list, 0},
    {"iface-mac", cmdInterfaceMAC, opts_interface_mac,
     info_interface_mac, 0},
    {"iface-name", cmdInterfaceName, opts_interface_name,
     info_interface_name, 0},
    {"iface-start", cmdInterfaceStart, opts_interface_start,
     info_interface_start, 0},
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine,
     info_interface_undefine, 0},
11069 11070 11071 11072 11073 11074
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
11075
    {NULL, NULL, NULL, NULL, 0}
11076
};
11077

11078
static const vshCmdDef nwfilterCmds[] = {
11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089
    {"nwfilter-define", cmdNWFilterDefine, opts_nwfilter_define,
     info_nwfilter_define, 0},
    {"nwfilter-dumpxml", cmdNWFilterDumpXML, opts_nwfilter_dumpxml,
     info_nwfilter_dumpxml, 0},
    {"nwfilter-edit", cmdNWFilterEdit, opts_nwfilter_edit,
     info_nwfilter_edit, 0},
    {"nwfilter-list", cmdNWFilterList, opts_nwfilter_list,
     info_nwfilter_list, 0},
    {"nwfilter-undefine", cmdNWFilterUndefine, opts_nwfilter_undefine,
     info_nwfilter_undefine, 0},
    {NULL, NULL, NULL, NULL, 0}
11090
};
11091

11092
static const vshCmdDef secretCmds[] = {
11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104
    {"secret-define", cmdSecretDefine, opts_secret_define,
     info_secret_define, 0},
    {"secret-dumpxml", cmdSecretDumpXML, opts_secret_dumpxml,
     info_secret_dumpxml, 0},
    {"secret-get-value", cmdSecretGetValue, opts_secret_get_value,
     info_secret_get_value, 0},
    {"secret-list", cmdSecretList, NULL, info_secret_list, 0},
    {"secret-set-value", cmdSecretSetValue, opts_secret_set_value,
     info_secret_set_value, 0},
    {"secret-undefine", cmdSecretUndefine, opts_secret_undefine,
     info_secret_undefine, 0},
    {NULL, NULL, NULL, NULL, 0}
11105
};
11106

11107
static const vshCmdDef virshCmds[] = {
11108 11109 11110 11111 11112 11113 11114
    {"cd", cmdCd, opts_cd, info_cd, VSH_CMD_FLAG_NOCONNECT},
    {"echo", cmdEcho, opts_echo, info_echo, VSH_CMD_FLAG_NOCONNECT},
    {"exit", cmdQuit, NULL, info_quit, VSH_CMD_FLAG_NOCONNECT},
    {"help", cmdHelp, opts_help, info_help, VSH_CMD_FLAG_NOCONNECT},
    {"pwd", cmdPwd, NULL, info_pwd, VSH_CMD_FLAG_NOCONNECT},
    {"quit", cmdQuit, NULL, info_quit, VSH_CMD_FLAG_NOCONNECT},
    {NULL, NULL, NULL, NULL, 0}
11115
};
11116

11117
static const vshCmdDef snapshotCmds[] = {
11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
    {"snapshot-current", cmdSnapshotCurrent, opts_snapshot_current,
     info_snapshot_current, 0},
    {"snapshot-delete", cmdSnapshotDelete, opts_snapshot_delete,
     info_snapshot_delete, 0},
    {"snapshot-dumpxml", cmdSnapshotDumpXML, opts_snapshot_dumpxml,
     info_snapshot_dumpxml, 0},
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
11131
};
11132

11133
static const vshCmdDef hostAndHypervisorCmds[] = {
11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144
    {"capabilities", cmdCapabilities, NULL, info_capabilities, 0},
    {"connect", cmdConnect, opts_connect, info_connect,
     VSH_CMD_FLAG_NOCONNECT},
    {"freecell", cmdFreecell, opts_freecell, info_freecell, 0},
    {"hostname", cmdHostname, NULL, info_hostname, 0},
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
    {"qemu-monitor-command", cmdQemuMonitorCommand, opts_qemu_monitor_command,
     info_qemu_monitor_command, 0},
    {"sysinfo", cmdSysinfo, NULL, info_sysinfo, 0},
    {"uri", cmdURI, NULL, info_uri, 0},
    {NULL, NULL, NULL, NULL, 0}
K
Karel Zak 已提交
11145 11146
};

11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163
static const vshCmdGrp cmdGroups[] = {
    {VSH_CMD_GRP_DOM_MANAGEMENT, "domain", domManagementCmds},
    {VSH_CMD_GRP_DOM_MONITORING, "monitor", domMonitoringCmds},
    {VSH_CMD_GRP_HOST_AND_HV, "host", hostAndHypervisorCmds},
    {VSH_CMD_GRP_IFACE, "interface", ifaceCmds},
    {VSH_CMD_GRP_NWFILTER, "filter", nwfilterCmds},
    {VSH_CMD_GRP_NETWORK, "network", networkCmds},
    {VSH_CMD_GRP_NODEDEV, "nodedev", nodedevCmds},
    {VSH_CMD_GRP_SECRET, "secret", secretCmds},
    {VSH_CMD_GRP_SNAPSHOT, "snapshot", snapshotCmds},
    {VSH_CMD_GRP_STORAGE_POOL, "pool", storagePoolCmds},
    {VSH_CMD_GRP_STORAGE_VOL, "volume", storageVolCmds},
    {VSH_CMD_GRP_VIRSH, "virsh", virshCmds},
    {NULL, NULL, NULL}
};


K
Karel Zak 已提交
11164 11165 11166 11167
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
11168
static const char *
11169
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
11170
{
11171
    const vshCmdInfo *info;
11172

K
Karel Zak 已提交
11173
    for (info = cmd->info; info && info->name; info++) {
11174
        if (STREQ(info->name, name))
K
Karel Zak 已提交
11175 11176 11177 11178 11179
            return info->data;
    }
    return NULL;
}

11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211
static int
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t* opts_need_arg,
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

    if (!cmd->opts)
        return 0;

    for (i = 0; cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];

        if (i > 31)
            return -1; /* too many options */
        if (opt->type == VSH_OT_BOOL) {
            if (opt->flag & VSH_OFLAG_REQ)
                return -1; /* bool options can't be mandatory */
            continue;
        }
        *opts_need_arg |= 1 << i;
        if (opt->flag & VSH_OFLAG_REQ) {
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
    }
    return 0;
}

11212
static const vshCmdOptDef *
11213 11214
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
11215
{
11216 11217 11218 11219
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
11220

11221 11222 11223 11224 11225 11226
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
            *opts_seen |= 1 << i;
K
Karel Zak 已提交
11227
            return opt;
11228 11229 11230 11231 11232
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
11233 11234 11235
    return NULL;
}

11236
static const vshCmdOptDef *
11237 11238
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
11239
{
11240
    int i;
11241
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
11242

11243 11244 11245 11246 11247 11248 11249 11250 11251 11252
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
    i = count_one_bits(*opts_need_arg ^ (*opts_need_arg - 1)) - 1;
    opt = &cmd->opts[i];
    if (opt->type != VSH_OT_ARGV)
        *opts_need_arg &= ~(1 << i);
    *opts_seen |= 1 << i;
    return opt;
K
Karel Zak 已提交
11253 11254
}

11255 11256 11257
/*
 * Checks for required options
 */
11258
static int
11259 11260
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
11261
{
11262
    const vshCmdDef *def = cmd->def;
11263 11264 11265 11266 11267 11268 11269 11270 11271
    int i;

    opts_required &= ~opts_seen;
    if (!opts_required)
        return 0;

    for (i = 0; def->opts[i].name; i++) {
        if (opts_required & (1 << i)) {
            const vshCmdOptDef *opt = &def->opts[i];
11272

11273 11274 11275 11276 11277
            vshError(ctl,
                     opt->type == VSH_OT_DATA ?
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
11278 11279
        }
    }
11280
    return -1;
11281 11282
}

11283
static const vshCmdDef *
11284 11285
vshCmddefSearch(const char *cmdname)
{
11286
    const vshCmdGrp *g;
11287
    const vshCmdDef *c;
11288

11289 11290
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
11291
            if (STREQ(c->name, cmdname))
11292 11293 11294 11295
                return c;
        }
    }

K
Karel Zak 已提交
11296 11297 11298
    return NULL;
}

11299 11300 11301 11302 11303 11304
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
11305
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
11306 11307 11308 11309 11310 11311
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
11312
static bool
11313 11314 11315 11316 11317 11318 11319
vshCmdGrpHelp(vshControl *ctl, const char *grpname)
{
    const vshCmdGrp *grp = vshCmdGrpSearch(grpname);
    const vshCmdDef *cmd = NULL;

    if (!grp) {
        vshError(ctl, _("command group '%s' doesn't exist"), grpname);
E
Eric Blake 已提交
11320
        return false;
11321 11322 11323 11324 11325 11326 11327 11328 11329 11330
    } else {
        vshPrint(ctl, _(" %s (help keyword '%s'):\n"), grp->name,
                 grp->keyword);

        for (cmd = grp->commands; cmd->name; cmd++) {
            vshPrint(ctl, "    %-30s %s\n", cmd->name,
                     _(vshCmddefGetInfo(cmd, "help")));
        }
    }

E
Eric Blake 已提交
11331
    return true;
11332 11333
}

E
Eric Blake 已提交
11334
static bool
11335
vshCmddefHelp(vshControl *ctl, const char *cmdname)
11336
{
11337
    const vshCmdDef *def = vshCmddefSearch(cmdname);
11338

K
Karel Zak 已提交
11339
    if (!def) {
11340
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
11341
        return false;
11342
    } else {
E
Eric Blake 已提交
11343 11344
        const char *desc = _(vshCmddefGetInfo(def, "desc"));
        const char *help = _(vshCmddefGetInfo(def, "help"));
11345
        char buf[256];
11346 11347 11348 11349 11350 11351
        uint32_t opts_need_arg;
        uint32_t opts_required;

        if (vshCmddefOptParse(def, &opts_need_arg, &opts_required)) {
            vshError(ctl, _("internal error: bad options in command: '%s'"),
                     def->name);
E
Eric Blake 已提交
11352
            return false;
11353
        }
K
Karel Zak 已提交
11354

11355
        fputs(_("  NAME\n"), stdout);
11356 11357
        fprintf(stdout, "    %s - %s\n", def->name, help);

11358 11359 11360 11361 11362
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
11363
                const char *fmt = "%s";
11364 11365
                switch (opt->type) {
                case VSH_OT_BOOL:
11366
                    fmt = "[--%s]";
11367 11368
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
11369
                    /* xgettext:c-format */
11370 11371
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
11372 11373
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
11374 11375
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
11376 11377
                    break;
                case VSH_OT_DATA:
11378
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
11379 11380 11381 11382 11383 11384
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
                    fmt = _("[<string>]...");
                    break;
                default:
11385
                    assert(0);
11386
                }
11387
                fputc(' ', stdout);
E
Eric Blake 已提交
11388
                fprintf(stdout, fmt, opt->name);
11389
            }
K
Karel Zak 已提交
11390
        }
11391 11392 11393
        fputc('\n', stdout);

        if (desc[0]) {
11394
            /* Print the description only if it's not empty.  */
11395
            fputs(_("\n  DESCRIPTION\n"), stdout);
K
Karel Zak 已提交
11396 11397
            fprintf(stdout, "    %s\n", desc);
        }
11398

K
Karel Zak 已提交
11399
        if (def->opts) {
11400
            const vshCmdOptDef *opt;
11401
            fputs(_("\n  OPTIONS\n"), stdout);
11402
            for (opt = def->opts; opt->name; opt++) {
11403 11404
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
11405
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
11406 11407
                    break;
                case VSH_OT_INT:
11408 11409 11410
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
11411 11412
                    break;
                case VSH_OT_STRING:
11413
                    /* OT_STRING should never be VSH_OFLAG_REQ */
11414
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
11415 11416
                    break;
                case VSH_OT_DATA:
11417 11418
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
11419 11420 11421 11422 11423 11424 11425
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
                    continue;
                default:
                    assert(0);
                }
11426

E
Eric Blake 已提交
11427
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
11428
            }
K
Karel Zak 已提交
11429 11430 11431
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
11432
    return true;
K
Karel Zak 已提交
11433 11434 11435 11436 11437 11438
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
11439 11440 11441
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
11442 11443
    vshCmdOpt *a = arg;

11444
    while (a) {
K
Karel Zak 已提交
11445
        vshCmdOpt *tmp = a;
11446

K
Karel Zak 已提交
11447 11448
        a = a->next;

11449 11450
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
11451 11452 11453 11454
    }
}

static void
11455
vshCommandFree(vshCmd *cmd)
11456
{
K
Karel Zak 已提交
11457 11458
    vshCmd *c = cmd;

11459
    while (c) {
K
Karel Zak 已提交
11460
        vshCmd *tmp = c;
11461

K
Karel Zak 已提交
11462 11463 11464 11465
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
11466
        VIR_FREE(tmp);
K
Karel Zak 已提交
11467 11468 11469 11470 11471 11472 11473
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
11474
vshCommandOpt(const vshCmd *cmd, const char *name)
11475
{
K
Karel Zak 已提交
11476
    vshCmdOpt *opt = cmd->opts;
11477 11478

    while (opt) {
11479
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
11480 11481 11482 11483 11484 11485 11486
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
11487 11488 11489 11490 11491 11492 11493 11494 11495
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Convert option to int
 * Return value:
 * >0 if option found and valid (@value updated)
 * 0 in case option not found (@value untouched)
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
11496 11497
 */
static int
11498
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
11499
{
K
Karel Zak 已提交
11500
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11501
    int ret = 0, num;
11502
    char *end_p = NULL;
11503

11504
    if ((arg != NULL) && (arg->data != NULL)) {
11505 11506 11507 11508 11509 11510
        num = strtol(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11511
    }
11512
    return ret;
K
Karel Zak 已提交
11513 11514
}

11515 11516 11517 11518 11519 11520
/*
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
11521 11522
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11523 11524
    int ret = 0;
    unsigned long num;
11525 11526 11527
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
11528 11529 11530 11531 11532 11533
        num = strtoul(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11534
    }
11535
    return ret;
11536 11537
}

K
Karel Zak 已提交
11538 11539
/*
 * Returns option as STRING
11540
 * See vshCommandOptInt()
K
Karel Zak 已提交
11541
 */
11542 11543
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
11544
{
K
Karel Zak 已提交
11545
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11546 11547 11548
    int ret = 0;

    if (arg && arg->data) {
E
Eric Blake 已提交
11549 11550 11551 11552
        if (*arg->data
            || (arg->def && (arg->def->flag & VSH_OFLAG_EMPTY_OK))) {
            *value = arg->data;
            ret = 1;
11553 11554
        } else if (arg->def && ((arg->def->flag) & VSH_OFLAG_REQ)) {
            vshError(NULL, _("Missing required option '%s'"), name);
E
Eric Blake 已提交
11555 11556 11557 11558
            ret = -1;
        } else {
            /* Treat "--option ''" as if option had not been specified. */
            ret = 0;
11559 11560
        }
    }
11561

11562
    return ret;
K
Karel Zak 已提交
11563 11564
}

11565 11566
/*
 * Returns option as long long
11567
 * See vshCommandOptInt()
11568
 */
11569 11570 11571
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
11572 11573
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11574 11575
    int ret = 0;
    long long num;
11576 11577
    char *end_p = NULL;

11578 11579 11580 11581 11582 11583 11584 11585 11586
    if ((arg != NULL) && (arg->data != NULL)) {
        num = strtoll(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
    }
    return ret;
11587 11588
}

11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
    int ret = 0;
    unsigned long long num;
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
        num = strtoull(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
    }
    return ret;
}


K
Karel Zak 已提交
11610
/*
E
Eric Blake 已提交
11611
 * Returns true/false if the option exists
K
Karel Zak 已提交
11612
 */
E
Eric Blake 已提交
11613
static bool
11614
vshCommandOptBool(const vshCmd *cmd, const char *name)
11615
{
E
Eric Blake 已提交
11616
    return vshCommandOpt(cmd, name) != NULL;
K
Karel Zak 已提交
11617 11618
}

11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639
/*
 * Returns the COUNT argv argument, or NULL after last argument.
 *
 * Requires that a VSH_OT_ARGV option with the name "" be last in the
 * list of supported options in CMD->def->opts.
 */
static char *
vshCommandOptArgv(const vshCmd *cmd, int count)
{
    vshCmdOpt *opt = cmd->opts;

    while (opt) {
        if (opt->def && opt->def->type == VSH_OT_ARGV) {
            if (count-- == 0)
                return opt->data;
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657
/* Determine whether CMD->opts includes an option with name OPTNAME.
   If not, give a diagnostic and return false.
   If so, return true.  */
static bool
cmd_has_option (vshControl *ctl, const vshCmd *cmd, const char *optname)
{
    /* Iterate through cmd->opts, to ensure that there is an entry
       with name OPTNAME and type VSH_OT_DATA. */
    bool found = false;
    const vshCmdOpt *opt;
    for (opt = cmd->opts; opt; opt = opt->next) {
        if (STREQ (opt->def->name, optname) && opt->def->type == VSH_OT_DATA) {
            found = true;
            break;
        }
    }

    if (!found)
11658
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
11659 11660 11661
                 cmd->def->name, optname);
    return found;
}
11662

K
Karel Zak 已提交
11663
static virDomainPtr
J
Jim Meyering 已提交
11664
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
11665
                      const char **name, int flag)
11666
{
K
Karel Zak 已提交
11667
    virDomainPtr dom = NULL;
11668
    const char *n = NULL;
K
Karel Zak 已提交
11669
    int id;
J
Jim Meyering 已提交
11670 11671 11672
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11673

11674
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11675 11676
        return NULL;

K
Karel Zak 已提交
11677
    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
11678 11679
             cmd->def->name, optname, n);

K
Karel Zak 已提交
11680 11681
    if (name)
        *name = n;
11682

K
Karel Zak 已提交
11683
    /* try it by ID */
11684
    if (flag & VSH_BYID) {
11685
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
11686 11687 11688 11689
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
11690
    }
K
Karel Zak 已提交
11691
    /* try it by UUID */
11692
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
11693
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
11694
                 cmd->def->name, optname);
K
Karel Zak 已提交
11695
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
11696
    }
K
Karel Zak 已提交
11697
    /* try it by NAME */
11698
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11699
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
11700
                 cmd->def->name, optname);
K
Karel Zak 已提交
11701
        dom = virDomainLookupByName(ctl->conn, n);
11702
    }
K
Karel Zak 已提交
11703

11704
    if (!dom)
11705
        vshError(ctl, _("failed to get domain '%s'"), n);
11706

K
Karel Zak 已提交
11707 11708 11709
    return dom;
}

11710
static virNetworkPtr
J
Jim Meyering 已提交
11711
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
11712
                       const char **name, int flag)
11713 11714
{
    virNetworkPtr network = NULL;
11715
    const char *n = NULL;
J
Jim Meyering 已提交
11716 11717 11718
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11719

11720
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11721 11722 11723 11724 11725 11726 11727 11728 11729
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
11730
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
11731
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
11732
                 cmd->def->name, optname);
11733 11734 11735 11736
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11737
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
11738 11739 11740 11741 11742
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
11743
        vshError(ctl, _("failed to get network '%s'"), n);
11744 11745 11746 11747

    return network;
}

11748 11749 11750

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
11751
                        const char **name, int flag)
11752 11753
{
    virNWFilterPtr nwfilter = NULL;
11754
    const char *n = NULL;
11755 11756 11757 11758
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11759
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
        vshDebug(ctl, 5, "%s: <%s> trying as nwfilter UUID\n",
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
        vshDebug(ctl, 5, "%s: <%s> trying as nwfilter NAME\n",
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

11787 11788
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
11789
                         const char **name, int flag)
11790 11791
{
    virInterfacePtr iface = NULL;
11792
    const char *n = NULL;
11793 11794 11795 11796
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11797
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11798 11799 11800 11801 11802 11803 11804 11805 11806
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
11807
    if ((flag & VSH_BYNAME)) {
11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819
        vshDebug(ctl, 5, "%s: <%s> trying as interface NAME\n",
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
        vshDebug(ctl, 5, "%s: <%s> trying as interface MAC\n",
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
11820
        vshError(ctl, _("failed to get interface '%s'"), n);
11821 11822 11823 11824

    return iface;
}

11825
static virStoragePoolPtr
11826
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
11827
                    const char **name, int flag)
11828 11829
{
    virStoragePoolPtr pool = NULL;
11830
    const char *n = NULL;
11831

11832
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11833 11834 11835 11836 11837 11838 11839 11840 11841
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
11842
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
11843
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
11844
                 cmd->def->name, optname);
11845 11846 11847
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
11848
    if (pool == NULL && (flag & VSH_BYNAME)) {
11849 11850 11851 11852 11853 11854
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
11855
        vshError(ctl, _("failed to get pool '%s'"), n);
11856 11857 11858 11859 11860

    return pool;
}

static virStorageVolPtr
11861
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
11862 11863
                   const char *optname,
                   const char *pooloptname,
11864
                   const char **name, int flag)
11865 11866 11867
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
11868
    const char *n = NULL, *p = NULL;
11869

11870
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11871 11872
        return NULL;

11873 11874
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
11875
        return NULL;
11876
    }
11877 11878 11879 11880 11881 11882 11883 11884 11885 11886

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

11887
    /* try it by name */
11888
    if (pool && (flag & VSH_BYNAME)) {
11889
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
11890 11891 11892
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
11893
    /* try it by key */
11894 11895 11896 11897 11898
    if (vol == NULL && (flag & VSH_BYUUID)) {
        vshDebug(ctl, 5, "%s: <%s> trying as vol key\n",
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
11899
    /* try it by path */
11900 11901 11902 11903 11904 11905 11906
    if (vol == NULL && (flag & VSH_BYUUID)) {
        vshDebug(ctl, 5, "%s: <%s> trying as vol path\n",
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
11907
        vshError(ctl, _("failed to get vol '%s'"), n);
11908 11909 11910 11911 11912 11913 11914

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

11915
static virSecretPtr
11916
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
11917 11918
{
    virSecretPtr secret = NULL;
11919
    const char *n = NULL;
11920 11921 11922 11923 11924
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11925
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11926 11927 11928 11929 11930 11931 11932 11933 11934 11935
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n", cmd->def->name, optname, n);

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
11936
        vshError(ctl, _("failed to get secret '%s'"), n);
11937 11938 11939 11940

    return secret;
}

K
Karel Zak 已提交
11941 11942 11943
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
11944
static bool
11945
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
11946
{
E
Eric Blake 已提交
11947
    bool ret = true;
11948 11949

    while (cmd) {
K
Karel Zak 已提交
11950
        struct timeval before, after;
11951
        bool enable_timing = ctl->timing;
11952

11953 11954
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
11955 11956
            vshReconnect(ctl);

11957
        if (enable_timing)
K
Karel Zak 已提交
11958
            GETTIMEOFDAY(&before);
11959

K
Karel Zak 已提交
11960 11961
        ret = cmd->def->handler(ctl, cmd);

11962
        if (enable_timing)
K
Karel Zak 已提交
11963
            GETTIMEOFDAY(&after);
11964

11965
        if (!ret)
J
John Levon 已提交
11966 11967
            virshReportError(ctl);

11968
        /* try to automatically catch disconnections */
11969
        if (!ret &&
11970 11971 11972 11973 11974 11975 11976 11977 11978
            ((disconnected != 0) ||
             ((last_error != NULL) &&
              (((last_error->code == VIR_ERR_SYSTEM_ERROR) &&
                (last_error->domain == VIR_FROM_REMOTE)) ||
               (last_error->code == VIR_ERR_RPC) ||
               (last_error->code == VIR_ERR_NO_CONNECT) ||
               (last_error->code == VIR_ERR_INVALID_CONN)))))
            vshReconnect(ctl);

11979
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
11980 11981
            return ret;

11982
        if (enable_timing)
11983
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
11984 11985
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
11986
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
11987 11988 11989 11990 11991 11992
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
11993
 * Command parsing
K
Karel Zak 已提交
11994 11995 11996
 * ---------------
 */

11997 11998 11999 12000 12001 12002 12003 12004 12005 12006
typedef enum {
    VSH_TK_ERROR, /* Failed to parse a token */
    VSH_TK_ARG, /* Arbitrary argument, might be option or empty */
    VSH_TK_SUBCMD_END, /* Separation between commands */
    VSH_TK_END /* No more commands */
} vshCommandToken;

typedef struct __vshCommandParser {
    vshCommandToken (*getNextArg)(vshControl *, struct __vshCommandParser *,
                                  char **);
L
Lai Jiangshan 已提交
12007
    /* vshCommandStringGetArg() */
12008
    char *pos;
L
Lai Jiangshan 已提交
12009 12010 12011
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
12012 12013
} vshCommandParser;

E
Eric Blake 已提交
12014
static bool
12015
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
12016
{
K
Karel Zak 已提交
12017 12018 12019
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
12020

K
Karel Zak 已提交
12021 12022 12023 12024
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
12025

12026
    while (1) {
K
Karel Zak 已提交
12027
        vshCmdOpt *last = NULL;
12028
        const vshCmdDef *cmd = NULL;
12029
        vshCommandToken tk;
L
Lai Jiangshan 已提交
12030
        bool data_only = false;
12031 12032 12033
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
12034

K
Karel Zak 已提交
12035
        first = NULL;
12036

12037
        while (1) {
12038
            const vshCmdOptDef *opt = NULL;
12039

K
Karel Zak 已提交
12040
            tkdata = NULL;
12041
            tk = parser->getNextArg(ctl, parser, &tkdata);
12042 12043

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
12044
                goto syntaxError;
H
Hu Tao 已提交
12045 12046
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
12047
                break;
H
Hu Tao 已提交
12048
            }
12049 12050

            if (cmd == NULL) {
K
Karel Zak 已提交
12051 12052
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
12053
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
12054
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
12055
                }
12056 12057 12058 12059 12060 12061 12062
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
12063
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
12064 12065 12066 12067
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
12068 12069 12070 12071 12072
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
12073 12074
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
12075
                    VIR_FREE(optstr);
K
Karel Zak 已提交
12076 12077
                    goto syntaxError;
                }
12078
                VIR_FREE(tkdata);
K
Karel Zak 已提交
12079 12080 12081

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
12082 12083 12084
                    if (optstr)
                        tkdata = optstr;
                    else
12085
                        tk = parser->getNextArg(ctl, parser, &tkdata);
12086
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
12087
                        goto syntaxError;
12088
                    if (tk != VSH_TK_ARG) {
12089
                        vshError(ctl,
12090
                                 _("expected syntax: --%s <%s>"),
12091 12092
                                 opt->name,
                                 opt->type ==
12093
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
12094 12095
                        goto syntaxError;
                    }
12096
                    opts_need_arg &= ~opts_seen;
12097 12098 12099 12100 12101 12102 12103 12104
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
12105
                }
L
Lai Jiangshan 已提交
12106 12107 12108 12109
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
12110
            } else {
L
Lai Jiangshan 已提交
12111
get_data:
12112 12113
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
12114
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
12115 12116 12117 12118 12119
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
12120
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
12121

K
Karel Zak 已提交
12122 12123 12124 12125
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
12126

K
Karel Zak 已提交
12127 12128 12129 12130 12131
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
12132

K
Karel Zak 已提交
12133
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
12134 12135
                         cmd->name,
                         opt->name,
12136 12137
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
12138 12139
            }
        }
12140

D
Daniel Veillard 已提交
12141
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
12142
        if (cmd) {
12143
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
12144

K
Karel Zak 已提交
12145 12146 12147 12148
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

12149
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
12150
                VIR_FREE(c);
12151
                goto syntaxError;
12152
            }
12153

K
Karel Zak 已提交
12154 12155 12156 12157 12158 12159
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
12160 12161 12162

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
12163
    }
12164

E
Eric Blake 已提交
12165
    return true;
K
Karel Zak 已提交
12166

12167
 syntaxError:
12168
    if (ctl->cmd) {
K
Karel Zak 已提交
12169
        vshCommandFree(ctl->cmd);
12170 12171
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
12172 12173
    if (first)
        vshCommandOptFree(first);
12174
    VIR_FREE(tkdata);
E
Eric Blake 已提交
12175
    return false;
K
Karel Zak 已提交
12176 12177
}

12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195
/* --------------------
 * Command argv parsing
 * --------------------
 */

static vshCommandToken ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
vshCommandArgvGetArg(vshControl *ctl, vshCommandParser *parser, char **res)
{
    if (parser->arg_pos == parser->arg_end) {
        *res = NULL;
        return VSH_TK_END;
    }

    *res = vshStrdup(ctl, *parser->arg_pos);
    parser->arg_pos++;
    return VSH_TK_ARG;
}

E
Eric Blake 已提交
12196 12197
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
12198 12199 12200 12201
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
12202
        return false;
12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274

    parser.arg_pos = argv;
    parser.arg_end = argv + nargs;
    parser.getNextArg = vshCommandArgvGetArg;
    return vshCommandParse(ctl, &parser);
}

/* ----------------------
 * Command string parsing
 * ----------------------
 */

static vshCommandToken ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
vshCommandStringGetArg(vshControl *ctl, vshCommandParser *parser, char **res)
{
    bool single_quote = false;
    bool double_quote = false;
    int sz = 0;
    char *p = parser->pos;
    char *q = vshStrdup(ctl, p);

    *res = q;

    while (*p && (*p == ' ' || *p == '\t'))
        p++;

    if (*p == '\0')
        return VSH_TK_END;
    if (*p == ';') {
        parser->pos = ++p;             /* = \0 or begin of next command */
        return VSH_TK_SUBCMD_END;
    }

    while (*p) {
        /* end of token is blank space or ';' */
        if (!double_quote && !single_quote &&
            (*p == ' ' || *p == '\t' || *p == ';'))
            break;

        if (!double_quote && *p == '\'') { /* single quote */
            single_quote = !single_quote;
            p++;
            continue;
        } else if (!single_quote && *p == '\\') { /* escape */
            /*
             * The same as the bash, a \ in "" is an escaper,
             * but a \ in '' is not an escaper.
             */
            p++;
            if (*p == '\0') {
                vshError(ctl, "%s", _("dangling \\"));
                return VSH_TK_ERROR;
            }
        } else if (!single_quote && *p == '"') { /* double quote */
            double_quote = !double_quote;
            p++;
            continue;
        }

        *q++ = *p++;
        sz++;
    }
    if (double_quote) {
        vshError(ctl, "%s", _("missing \""));
        return VSH_TK_ERROR;
    }

    *q = '\0';
    parser->pos = p;
    return VSH_TK_ARG;
}

E
Eric Blake 已提交
12275 12276
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
12277 12278 12279 12280
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
12281
        return false;
12282 12283 12284 12285 12286 12287

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
12288
/* ---------------
12289
 * Misc utils
K
Karel Zak 已提交
12290 12291
 * ---------------
 */
12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319
static int
vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason)
{
    virDomainInfo info;

    if (reason)
        *reason = -1;

    if (!ctl->useGetInfo) {
        int state;
        if (virDomainGetState(dom, &state, reason, 0) < 0) {
            virErrorPtr err = virGetLastError();
            if (err && err->code == VIR_ERR_NO_SUPPORT)
                ctl->useGetInfo = true;
            else
                return -1;
        } else {
            return state;
        }
    }

    /* fall back to virDomainGetInfo if virDomainGetState is not supported */
    if (virDomainGetInfo(dom, &info) < 0)
        return -1;
    else
        return info.state;
}

K
Karel Zak 已提交
12320
static const char *
12321 12322
vshDomainStateToString(int state)
{
12323
    switch ((virDomainState) state) {
12324
    case VIR_DOMAIN_RUNNING:
12325
        return N_("running");
12326
    case VIR_DOMAIN_BLOCKED:
12327
        return N_("idle");
12328
    case VIR_DOMAIN_PAUSED:
12329
        return N_("paused");
12330
    case VIR_DOMAIN_SHUTDOWN:
12331
        return N_("in shutdown");
12332
    case VIR_DOMAIN_SHUTOFF:
12333
        return N_("shut off");
12334
    case VIR_DOMAIN_CRASHED:
12335
        return N_("crashed");
12336
    case VIR_DOMAIN_NOSTATE:
12337
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
12338
    }
12339
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
12340 12341
}

12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442
static const char *
vshDomainStateReasonToString(int state, int reason)
{
    switch ((virDomainState) state) {
    case VIR_DOMAIN_NOSTATE:
        switch ((virDomainNostateReason) reason) {
        case VIR_DOMAIN_NOSTATE_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_RUNNING:
        switch ((virDomainRunningReason) reason) {
        case VIR_DOMAIN_RUNNING_BOOTED:
            return N_("booted");
        case VIR_DOMAIN_RUNNING_MIGRATED:
            return N_("migrated");
        case VIR_DOMAIN_RUNNING_RESTORED:
            return N_("restored");
        case VIR_DOMAIN_RUNNING_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_RUNNING_UNPAUSED:
            return N_("unpaused");
        case VIR_DOMAIN_RUNNING_MIGRATION_CANCELED:
            return N_("migration canceled");
        case VIR_DOMAIN_RUNNING_SAVE_CANCELED:
            return N_("save canceled");
        case VIR_DOMAIN_RUNNING_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_BLOCKED:
        switch ((virDomainBlockedReason) reason) {
        case VIR_DOMAIN_BLOCKED_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_PAUSED:
        switch ((virDomainPausedReason) reason) {
        case VIR_DOMAIN_PAUSED_USER:
            return N_("user");
        case VIR_DOMAIN_PAUSED_MIGRATION:
            return N_("migrating");
        case VIR_DOMAIN_PAUSED_SAVE:
            return N_("saving");
        case VIR_DOMAIN_PAUSED_DUMP:
            return N_("dumping");
        case VIR_DOMAIN_PAUSED_IOERROR:
            return N_("I/O error");
        case VIR_DOMAIN_PAUSED_WATCHDOG:
            return N_("watchdog");
        case VIR_DOMAIN_PAUSED_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_PAUSED_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_SHUTDOWN:
        switch ((virDomainShutdownReason) reason) {
        case VIR_DOMAIN_SHUTDOWN_USER:
            return N_("user");
        case VIR_DOMAIN_SHUTDOWN_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_SHUTOFF:
        switch ((virDomainShutoffReason) reason) {
        case VIR_DOMAIN_SHUTOFF_SHUTDOWN:
            return N_("shutdown");
        case VIR_DOMAIN_SHUTOFF_DESTROYED:
            return N_("destroyed");
        case VIR_DOMAIN_SHUTOFF_CRASHED:
            return N_("crashed");
        case VIR_DOMAIN_SHUTOFF_MIGRATED:
            return N_("migrated");
        case VIR_DOMAIN_SHUTOFF_SAVED:
            return N_("saved");
        case VIR_DOMAIN_SHUTOFF_FAILED:
            return N_("failed");
        case VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_SHUTOFF_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_CRASHED:
        switch ((virDomainCrashedReason) reason) {
        case VIR_DOMAIN_CRASHED_UNKNOWN:
            ;
        }
        break;
    }

    return N_("unknown");
}

12443 12444 12445 12446
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
12447
    case VIR_VCPU_OFFLINE:
12448
        return N_("offline");
12449
    case VIR_VCPU_BLOCKED:
12450
        return N_("idle");
12451
    case VIR_VCPU_RUNNING:
12452
        return N_("running");
12453
    default:
12454
        ;/*FALLTHROUGH*/
12455
    }
12456
    return N_("no state");
12457 12458
}

E
Eric Blake 已提交
12459
static bool
12460
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
12461
{
12462 12463
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
12464 12465
     */
    if (!conn) {
12466
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
12467
        return false;
K
Karel Zak 已提交
12468
    }
E
Eric Blake 已提交
12469
    return true;
K
Karel Zak 已提交
12470 12471
}

K
Karel Zak 已提交
12472
static void
12473
vshDebug(vshControl *ctl, int level, const char *format, ...)
12474
{
K
Karel Zak 已提交
12475
    va_list ap;
12476
    char *str;
K
Karel Zak 已提交
12477

12478 12479 12480 12481
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
12482 12483 12484 12485
    if (level > ctl->debug)
        return;

    va_start(ap, format);
12486 12487 12488 12489 12490
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
12491
    va_end(ap);
12492 12493
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
12494 12495 12496
}

static void
12497
vshPrintExtra(vshControl *ctl, const char *format, ...)
12498
{
K
Karel Zak 已提交
12499
    va_list ap;
12500
    char *str;
12501

12502
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
12503
        return;
12504

K
Karel Zak 已提交
12505
    va_start(ap, format);
12506 12507 12508 12509 12510
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
12511
    va_end(ap);
12512
    fputs(str, stdout);
12513
    VIR_FREE(str);
K
Karel Zak 已提交
12514 12515
}

K
Karel Zak 已提交
12516

K
Karel Zak 已提交
12517
static void
12518
vshError(vshControl *ctl, const char *format, ...)
12519
{
K
Karel Zak 已提交
12520
    va_list ap;
12521
    char *str;
12522

12523 12524 12525 12526 12527
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
12528

12529
    fputs(_("error: "), stderr);
12530

K
Karel Zak 已提交
12531
    va_start(ap, format);
12532 12533 12534
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
12535 12536
    va_end(ap);

12537 12538
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
12539 12540
}

12541

K
Karel Zak 已提交
12542
/*
12543
 * Initialize connection.
K
Karel Zak 已提交
12544
 */
E
Eric Blake 已提交
12545
static bool
12546
vshInit(vshControl *ctl)
12547
{
12548 12549
    char *debugEnv;

K
Karel Zak 已提交
12550
    if (ctl->conn)
E
Eric Blake 已提交
12551
        return false;
K
Karel Zak 已提交
12552

12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573
    if (ctl->debug == -1) {
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
            if (virStrToLong_i(debugEnv, NULL, 10, &ctl->debug) < 0 ||
                ctl->debug < VSH_ERR_DEBUG || ctl->debug > VSH_ERR_ERROR) {
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
                ctl->debug = VSH_ERR_DEBUG;
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

12574 12575
    vshOpenLogFile(ctl);

12576 12577
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
12578

12579 12580 12581
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

12582
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
12583
        return false;
12584

12585 12586 12587 12588
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
12589

12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600
        /* Connecting to a named connection must succeed, but we delay
         * connecting to the default connection until we need it
         * (since the first command might be 'connect' which allows a
         * non-default connection, or might be 'help' which needs no
         * connection).
         */
        if (!ctl->conn) {
            virshReportError(ctl);
            vshError(ctl, "%s", _("failed to connect to the hypervisor"));
            return false;
        }
12601
    }
K
Karel Zak 已提交
12602

E
Eric Blake 已提交
12603
    return true;
K
Karel Zak 已提交
12604 12605
}

12606 12607
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626
/**
 * vshOpenLogFile:
 *
 * Open log file.
 */
static void
vshOpenLogFile(vshControl *ctl)
{
    struct stat st;

    if (ctl->logfile == NULL)
        return;

    /* check log file */
    if (stat(ctl->logfile, &st) == -1) {
        switch (errno) {
            case ENOENT:
                break;
            default:
12627
                vshError(ctl, "%s",
J
Jim Meyering 已提交
12628
                         _("failed to get the log file information"));
12629
                exit(EXIT_FAILURE);
12630 12631 12632
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
12633 12634
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
12635 12636 12637 12638
        }
    }

    /* log file open */
12639
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
12640
        vshError(ctl, "%s",
J
Jim Meyering 已提交
12641
                 _("failed to open the log file. check the log file path"));
12642
        exit(EXIT_FAILURE);
12643 12644 12645 12646 12647 12648 12649 12650 12651
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
12652 12653
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
12654
{
12655 12656 12657
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671
    const char *lvl = "";
    struct timeval stTimeval;
    struct tm *stTm;

    if (ctl->log_fd == -1)
        return;

    /**
     * create log format
     *
     * [YYYY.MM.DD HH:MM:SS SIGNATURE PID] LOG_LEVEL message
    */
    gettimeofday(&stTimeval, NULL);
    stTm = localtime(&stTimeval.tv_sec);
12672
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
12673 12674 12675 12676 12677 12678
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
12679 12680
                      SIGN_NAME,
                      (int) getpid());
12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700
    switch (log_level) {
        case VSH_ERR_DEBUG:
            lvl = LVL_DEBUG;
            break;
        case VSH_ERR_INFO:
            lvl = LVL_INFO;
            break;
        case VSH_ERR_NOTICE:
            lvl = LVL_INFO;
            break;
        case VSH_ERR_WARNING:
            lvl = LVL_WARNING;
            break;
        case VSH_ERR_ERROR:
            lvl = LVL_ERROR;
            break;
        default:
            lvl = LVL_DEBUG;
            break;
    }
12701 12702 12703
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
12704

12705 12706
    if (virBufferError(&buf))
        goto error;
12707

12708 12709 12710 12711 12712
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
12713
    }
12714

12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725
    /* write log */
    if (safewrite(ctl->log_fd, str, len) < 0)
        goto error;

    return;

error:
    vshCloseLogFile(ctl);
    vshError(ctl, "%s", _("failed to write the log file"));
    virBufferFreeAndReset(&buf);
    VIR_FREE(str);
12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
12737 12738 12739
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
12740 12741 12742
    }

    if (ctl->logfile) {
12743
        VIR_FREE(ctl->logfile);
12744 12745 12746 12747
        ctl->logfile = NULL;
    }
}

12748
#ifdef USE_READLINE
12749

K
Karel Zak 已提交
12750 12751 12752 12753 12754
/* -----------------
 * Readline stuff
 * -----------------
 */

12755
/*
K
Karel Zak 已提交
12756 12757
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
12758
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
12759 12760
 */
static char *
12761 12762
vshReadlineCommandGenerator(const char *text, int state)
{
12763
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
12764
    const char *name;
12765 12766
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
12767 12768

    if (!state) {
12769 12770
        grp_list_index = 0;
        cmd_list_index = 0;
12771
        len = strlen(text);
K
Karel Zak 已提交
12772 12773
    }

12774 12775
    grp = cmdGroups;

K
Karel Zak 已提交
12776
    /* Return the next name which partially matches from the
12777
     * command list.
K
Karel Zak 已提交
12778
     */
12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792
    while (grp[grp_list_index].name) {
        cmds = grp[grp_list_index].commands;

        if (cmds[cmd_list_index].name) {
            while ((name = cmds[cmd_list_index].name)) {
                cmd_list_index++;

                if (STREQLEN(name, text, len))
                    return vshStrdup(NULL, name);
            }
        } else {
            cmd_list_index = 0;
            grp_list_index++;
        }
K
Karel Zak 已提交
12793 12794 12795 12796 12797 12798 12799
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
12800 12801
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
12802
    static int list_index, len;
12803
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
12804
    const char *name;
K
Karel Zak 已提交
12805 12806 12807 12808 12809 12810 12811 12812 12813

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

12814
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
12815
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
12816 12817 12818

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
12819
        len = strlen(text);
12820
        VIR_FREE(cmdname);
K
Karel Zak 已提交
12821 12822 12823 12824
    }

    if (!cmd)
        return NULL;
12825

12826 12827 12828
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
12829
    while ((name = cmd->opts[list_index].name)) {
12830
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
12831
        char *res;
12832

K
Karel Zak 已提交
12833
        list_index++;
12834

K
Karel Zak 已提交
12835
        if (opt->type == VSH_OT_DATA)
K
Karel Zak 已提交
12836 12837
            /* ignore non --option */
            continue;
12838

K
Karel Zak 已提交
12839
        if (len > 2) {
12840
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
12841 12842
                continue;
        }
12843
        res = vshMalloc(NULL, strlen(name) + 3);
12844
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
12845 12846 12847 12848 12849 12850 12851 12852
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
12853 12854 12855
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
12856 12857
    char **matches = (char **) NULL;

12858
    if (start == 0)
K
Karel Zak 已提交
12859
        /* command name generator */
12860
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
12861 12862
    else
        /* commands options */
12863
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
12864 12865 12866 12867
    return matches;
}


12868 12869
static int
vshReadlineInit(vshControl *ctl)
12870
{
12871 12872
    char *userdir = NULL;

K
Karel Zak 已提交
12873 12874 12875 12876 12877
    /* Allow conditional parsing of the ~/.inputrc file. */
    rl_readline_name = "virsh";

    /* Tell the completer that we want a crack first. */
    rl_attempted_completion_function = vshReadlineCompletion;
12878 12879 12880

    /* Limit the total size of the history buffer */
    stifle_history(500);
12881 12882

    /* Prepare to read/write history from/to the ~/.virsh/history file */
12883
    userdir = virGetUserDirectory(getuid());
12884

12885 12886
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
12887
        return -1;
12888
    }
12889 12890 12891

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12892
        VIR_FREE(userdir);
12893 12894 12895 12896 12897
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12898
        VIR_FREE(userdir);
12899 12900 12901
        return -1;
    }

12902
    VIR_FREE(userdir);
12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920

    read_history(ctl->historyfile);

    return 0;
}

static void
vshReadlineDeinit (vshControl *ctl)
{
    if (ctl->historyfile != NULL) {
        if (mkdir(ctl->historydir, 0755) < 0 && errno != EEXIST) {
            char ebuf[1024];
            vshError(ctl, _("Failed to create '%s': %s"),
                     ctl->historydir, virStrerror(errno, ebuf, sizeof ebuf));
        } else
            write_history(ctl->historyfile);
    }

12921 12922
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
12923 12924
}

12925 12926 12927 12928 12929 12930
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

12931
#else /* !USE_READLINE */
12932

12933 12934 12935 12936 12937 12938 12939
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

12940
static void
12941
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964
{
    /* empty */
}

static char *
vshReadline (vshControl *ctl, const char *prompt)
{
    char line[1024];
    char *r;
    int len;

    fputs (prompt, stdout);
    r = fgets (line, sizeof line, stdin);
    if (r == NULL) return NULL; /* EOF */

    /* Chomp trailing \n */
    len = strlen (r);
    if (len > 0 && r[len-1] == '\n')
        r[len-1] = '\0';

    return vshStrdup (ctl, r);
}

12965
#endif /* !USE_READLINE */
12966

K
Karel Zak 已提交
12967
/*
J
Jim Meyering 已提交
12968
 * Deinitialize virsh
K
Karel Zak 已提交
12969
 */
E
Eric Blake 已提交
12970
static bool
12971
vshDeinit(vshControl *ctl)
12972
{
12973
    vshReadlineDeinit(ctl);
12974
    vshCloseLogFile(ctl);
12975
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
12976
    if (ctl->conn) {
12977 12978 12979
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
12980 12981
        }
    }
D
Daniel P. Berrange 已提交
12982 12983
    virResetLastError();

E
Eric Blake 已提交
12984
    return true;
K
Karel Zak 已提交
12985
}
12986

K
Karel Zak 已提交
12987 12988 12989 12990
/*
 * Print usage
 */
static void
12991
vshUsage(void)
12992
{
12993
    const vshCmdGrp *grp;
12994
    const vshCmdDef *cmd;
12995

L
Lai Jiangshan 已提交
12996 12997
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
12998 12999 13000
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
13001
                      "    -d | --debug <num>      debug level [0-4]\n"
13002 13003 13004 13005
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
13006
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
13007
                      "    -V | --version=long     version and full options\n\n"
13008
                      "  commands (non interactive mode):\n\n"), progname, progname);
13009

13010 13011
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
13012

13013 13014 13015 13016 13017 13018 13019 13020 13021
        for (cmd = grp->commands; cmd->name; cmd++)
            fprintf(stdout,
                    "    %-30s %s\n", cmd->name, _(vshCmddefGetInfo(cmd, "help")));

        fprintf(stdout, "\n");
    }

    fprintf(stdout, "%s",
            _("\n  (specify help <group> for details about the commands in the group)\n"));
13022 13023 13024
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
13025 13026
}

13027 13028 13029 13030 13031 13032 13033 13034 13035 13036
/*
 * Show version and options compiled in
 */
static void
vshShowVersion(vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* FIXME - list a copyright blurb, as in GNU programs?  */
    vshPrint(ctl, _("Virsh command line tool of libvirt %s\n"), VERSION);
    vshPrint(ctl, _("See web site at %s\n\n"), "http://libvirt.org/");

L
Laine Stump 已提交
13037 13038
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073
#ifdef WITH_XEN
    vshPrint(ctl, " Xen");
#endif
#ifdef WITH_QEMU
    vshPrint(ctl, " QEmu/KVM");
#endif
#ifdef WITH_UML
    vshPrint(ctl, " UML");
#endif
#ifdef WITH_OPENVZ
    vshPrint(ctl, " OpenVZ");
#endif
#ifdef WITH_VBOX
    vshPrint(ctl, " VirtualBox");
#endif
#ifdef WITH_XENAPI
    vshPrint(ctl, " XenAPI");
#endif
#ifdef WITH_LXC
    vshPrint(ctl, " LXC");
#endif
#ifdef WITH_ESX
    vshPrint(ctl, " ESX");
#endif
#ifdef WITH_PHYP
    vshPrint(ctl, " PHYP");
#endif
#ifdef WITH_ONE
    vshPrint(ctl, " ONE");
#endif
#ifdef WITH_TEST
    vshPrint(ctl, " Test");
#endif
    vshPrint(ctl, "\n");

L
Laine Stump 已提交
13074
    vshPrint(ctl, "%s", _(" Networking:"));
13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100
#ifdef WITH_REMOTE
    vshPrint(ctl, " Remote");
#endif
#ifdef WITH_PROXY
    vshPrint(ctl, " Proxy");
#endif
#ifdef WITH_LIBVIRTD
    vshPrint(ctl, " Daemon");
#endif
#ifdef WITH_NETWORK
    vshPrint(ctl, " Network");
#endif
#ifdef WITH_BRIDGE
    vshPrint(ctl, " Bridging");
#endif
#ifdef WITH_NETCF
    vshPrint(ctl, " Netcf");
#endif
#ifdef WITH_NWFILTER
    vshPrint(ctl, " Nwfilter");
#endif
#ifdef WITH_VIRTUALPORT
    vshPrint(ctl, " VirtualPort");
#endif
    vshPrint(ctl, "\n");

L
Laine Stump 已提交
13101
    vshPrint(ctl, "%s", _(" Storage:"));
13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124
#ifdef WITH_STORAGE_DIR
    vshPrint(ctl, " Dir");
#endif
#ifdef WITH_STORAGE_DISK
    vshPrint(ctl, " Disk");
#endif
#ifdef WITH_STORAGE_FS
    vshPrint(ctl, " Filesystem");
#endif
#ifdef WITH_STORAGE_SCSI
    vshPrint(ctl, " SCSI");
#endif
#ifdef WITH_STORAGE_MPATH
    vshPrint(ctl, " Multipath");
#endif
#ifdef WITH_STORAGE_ISCSI
    vshPrint(ctl, " iSCSI");
#endif
#ifdef WITH_STORAGE_LVM
    vshPrint(ctl, " LVM");
#endif
    vshPrint(ctl, "\n");

L
Laine Stump 已提交
13125
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
13126
#ifdef WITH_SECDRIVER_APPARMOR
13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149
    vshPrint(ctl, " AppArmor");
#endif
#ifdef WITH_SECDRIVER_SELINUX
    vshPrint(ctl, " SELinux");
#endif
#ifdef WITH_SECRETS
    vshPrint(ctl, " Secrets");
#endif
#ifdef ENABLE_DEBUG
    vshPrint(ctl, " Debug");
#endif
#ifdef WITH_DTRACE
    vshPrint(ctl, " DTrace");
#endif
#ifdef USE_READLINE
    vshPrint(ctl, " Readline");
#endif
#ifdef WITH_DRIVER_MODULES
    vshPrint(ctl, " Modular");
#endif
    vshPrint(ctl, "\n");
}

K
Karel Zak 已提交
13150 13151 13152 13153
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
13154
static bool
13155
vshParseArgv(vshControl *ctl, int argc, char **argv)
13156
{
13157 13158
    bool help = false;
    int arg;
K
Karel Zak 已提交
13159
    struct option opt[] = {
E
Eric Blake 已提交
13160 13161 13162 13163 13164 13165 13166 13167 13168
        {"debug", required_argument, NULL, 'd'},
        {"help", no_argument, NULL, 'h'},
        {"quiet", no_argument, NULL, 'q'},
        {"timing", no_argument, NULL, 't'},
        {"version", optional_argument, NULL, 'v'},
        {"connect", required_argument, NULL, 'c'},
        {"readonly", no_argument, NULL, 'r'},
        {"log", required_argument, NULL, 'l'},
        {NULL, 0, NULL, 0}
13169 13170
    };

13171 13172 13173
    /* Standard (non-command) options. The leading + ensures that no
     * argument reordering takes place, so that command options are
     * not confused with top-level virsh options. */
13174
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
13175
        switch (arg) {
13176
        case 'd':
D
Daniel Veillard 已提交
13177
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
13178
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
13179 13180
                exit(EXIT_FAILURE);
            }
13181 13182
            break;
        case 'h':
13183
            help = true;
13184 13185
            break;
        case 'q':
E
Eric Blake 已提交
13186
            ctl->quiet = true;
13187 13188
            break;
        case 't':
E
Eric Blake 已提交
13189
            ctl->timing = true;
13190 13191 13192 13193
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
13194 13195 13196 13197 13198 13199
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
13200 13201 13202
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
13203
        case 'r':
E
Eric Blake 已提交
13204
            ctl->readonly = true;
13205
            break;
13206 13207 13208
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
13209
        default:
13210 13211
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
13212 13213 13214 13215
        }
    }

    if (help) {
13216 13217
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
13218 13219
            exit(EXIT_FAILURE);
        }
13220 13221 13222

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
13223
        exit(EXIT_SUCCESS);
13224 13225
    }

13226
    if (argc > optind) {
K
Karel Zak 已提交
13227
        /* parse command */
E
Eric Blake 已提交
13228
        ctl->imode = false;
13229 13230 13231
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
13232
        } else {
13233
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
13234 13235
        }
    }
E
Eric Blake 已提交
13236
    return true;
K
Karel Zak 已提交
13237 13238
}

13239 13240 13241 13242
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
13243
    char *defaultConn;
E
Eric Blake 已提交
13244
    bool ret = true;
K
Karel Zak 已提交
13245

13246 13247 13248
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
13249
    ctl->debug = -1;            /* Initialize log level */
13250

13251 13252
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
13253
        /* failure to setup locale is not fatal */
13254
    }
13255
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
13256
        perror("bindtextdomain");
E
Eric Blake 已提交
13257
        return EXIT_FAILURE;
13258
    }
13259
    if (!textdomain(PACKAGE)) {
13260
        perror("textdomain");
E
Eric Blake 已提交
13261
        return EXIT_FAILURE;
13262 13263
    }

13264 13265 13266 13267 13268
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

13269
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
13270 13271 13272
        progname = argv[0];
    else
        progname++;
13273

13274
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
13275
        ctl->name = vshStrdup(ctl, defaultConn);
13276 13277
    }

D
Daniel P. Berrange 已提交
13278 13279
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
13280
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
13281
    }
13282

D
Daniel P. Berrange 已提交
13283 13284
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
13285
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
13286
    }
13287

K
Karel Zak 已提交
13288
    if (!ctl->imode) {
13289
        ret = vshCommandRun(ctl, ctl->cmd);
13290
    } else {
K
Karel Zak 已提交
13291 13292
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
13293
            vshPrint(ctl,
13294
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
13295
                     progname);
J
Jim Meyering 已提交
13296
            vshPrint(ctl, "%s",
13297
                     _("Type:  'help' for help with commands\n"
13298
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
13299
        }
13300 13301 13302 13303 13304 13305

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
13306
        do {
13307
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
13308
            ctl->cmdstr =
13309
                vshReadline(ctl, prompt);
13310 13311
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
13312
            if (*ctl->cmdstr) {
13313
#if USE_READLINE
K
Karel Zak 已提交
13314
                add_history(ctl->cmdstr);
13315
#endif
13316
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
13317 13318
                    vshCommandRun(ctl, ctl->cmd);
            }
13319
            VIR_FREE(ctl->cmdstr);
13320
        } while (ctl->imode);
K
Karel Zak 已提交
13321

13322 13323
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
13324
    }
13325

K
Karel Zak 已提交
13326 13327
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
13328
}