virsh.c 374.0 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
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
3832 3833 3834
    {NULL, 0, 0, NULL}
};

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

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

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

3864
    if (!vshConnectionUsability (ctl, ctl->conn))
3865
        goto out;
3866

J
Jim Meyering 已提交
3867
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
3868
        goto out;
3869

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

3877 3878 3879 3880 3881
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

3882 3883
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
3884 3885
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
3886 3887 3888
    if (vshCommandOptBool (cmd, "tunnelled"))
        flags |= VIR_MIGRATE_TUNNELLED;

C
Chris Lalancette 已提交
3889 3890 3891 3892 3893
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

3894 3895 3896
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

3897 3898 3899 3900 3901 3902
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

3903 3904 3905 3906 3907 3908

    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
        goto out;


3909 3910 3911 3912
    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. */
3913

3914
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
3915
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
3916
            goto out;
3917
        }
3918

3919
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
3920
            ret = '0';
3921 3922 3923 3924 3925 3926
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
3927
        if (!dconn) goto out;
3928

3929
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
3930 3931
        if (ddom) {
            virDomainFree(ddom);
3932
            ret = '0';
3933 3934 3935
        }
        virConnectClose (dconn);
    }
3936

3937
out:
3938
#if HAVE_PTHREAD_SIGMASK
3939 3940
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
3941
#endif
3942
    if (dom) virDomainFree (dom);
3943
    VIR_FREE(xml);
3944 3945 3946
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970
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 已提交
3971
static bool
3972 3973 3974 3975 3976
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
3977
    bool functionReturn = false;
3978 3979 3980 3981 3982
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
3983 3984
    virDomainJobInfo jobinfo;
    bool verbose = false;
3985
    int timeout = 0;
W
Wen Congyang 已提交
3986 3987
    struct timeval start, curr;
    bool live_flag = false;
3988
    vshCtrlData data;
3989 3990 3991 3992 3993 3994
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
#endif
3995 3996

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

W
Wen Congyang 已提交
3999 4000 4001
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
4002
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
4003
        live_flag = true;
4004
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021
        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;
        }
    }

4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044
    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 已提交
4045
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
4046
    while (1) {
4047
repoll:
W
Wen Congyang 已提交
4048 4049 4050 4051
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
4052
                    functionReturn = true;
W
Wen Congyang 已提交
4053 4054 4055 4056 4057
                    if (verbose) {
                        /* print [100 %] */
                        print_job_progress(0, 1);
                    }
                } else
W
Wen Congyang 已提交
4058
                    functionReturn = false;
4059
            } else
W
Wen Congyang 已提交
4060
                functionReturn = false;
W
Wen Congyang 已提交
4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
4072
            functionReturn = false;
W
Wen Congyang 已提交
4073 4074 4075
            break;
        }

W
Wen Congyang 已提交
4076 4077 4078 4079 4080 4081 4082 4083 4084
        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 已提交
4085
        if (verbose) {
4086
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
4087
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
4088
#endif
W
Wen Congyang 已提交
4089
            ret = virDomainGetJobInfo(dom, &jobinfo);
4090
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
4091
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
4092
#endif
W
Wen Congyang 已提交
4093 4094
            if (ret == 0)
                print_job_progress(jobinfo.dataRemaining, jobinfo.dataTotal);
4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
4106
    return functionReturn;
4107 4108
}

4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119
/*
 * "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")},
4120
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
4121 4122 4123
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4124
static bool
4125 4126 4127
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
4128
    long long downtime = 0;
E
Eric Blake 已提交
4129
    bool ret = false;
4130

4131
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4132
        return false;
4133 4134

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

4137 4138
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
4139 4140 4141 4142 4143 4144 4145
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
4146
    ret = true;
4147 4148 4149 4150 4151 4152

done:
    virDomainFree(dom);
    return ret;
}

4153 4154 4155
/*
 * "net-autostart" command
 */
4156
static const vshCmdInfo info_network_autostart[] = {
4157
    {"help", N_("autostart a network")},
4158
    {"desc",
4159
     N_("Configure a network to be automatically started at boot.")},
4160 4161 4162
    {NULL, NULL}
};

4163
static const vshCmdOptDef opts_network_autostart[] = {
4164 4165
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4166 4167 4168
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4169
static bool
4170
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
4171 4172
{
    virNetworkPtr network;
4173
    const char *name;
4174 4175
    int autostart;

4176
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4177
        return false;
4178

J
Jim Meyering 已提交
4179
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4180
        return false;
4181 4182 4183 4184

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
4185
        if (autostart)
4186
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
4187
        else
4188
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
4189
        virNetworkFree(network);
E
Eric Blake 已提交
4190
        return false;
4191 4192
    }

4193
    if (autostart)
4194
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
4195
    else
4196
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
4197

L
Laine Stump 已提交
4198
    virNetworkFree(network);
E
Eric Blake 已提交
4199
    return true;
4200
}
K
Karel Zak 已提交
4201

4202 4203 4204
/*
 * "net-create" command
 */
4205
static const vshCmdInfo info_network_create[] = {
4206 4207
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
4208 4209 4210
    {NULL, NULL}
};

4211
static const vshCmdOptDef opts_network_create[] = {
4212
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4213 4214 4215
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4216
static bool
4217
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
4218 4219
{
    virNetworkPtr network;
4220
    const char *from = NULL;
E
Eric Blake 已提交
4221
    bool ret = true;
4222
    char *buffer;
4223

4224
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4225
        return false;
4226

4227
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4228
        return false;
4229

4230
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4231
        return false;
4232 4233

    network = virNetworkCreateXML(ctl->conn, buffer);
4234
    VIR_FREE(buffer);
4235

4236 4237 4238
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4239
        virNetworkFree(network);
4240
    } else {
4241
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
4242
        ret = false;
4243 4244 4245 4246 4247 4248 4249 4250
    }
    return ret;
}


/*
 * "net-define" command
 */
4251
static const vshCmdInfo info_network_define[] = {
4252 4253
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
4254 4255 4256
    {NULL, NULL}
};

4257
static const vshCmdOptDef opts_network_define[] = {
4258
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4259 4260 4261
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4262
static bool
4263
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
4264 4265
{
    virNetworkPtr network;
4266
    const char *from = NULL;
E
Eric Blake 已提交
4267
    bool ret = true;
4268
    char *buffer;
4269

4270
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4271
        return false;
4272

4273
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4274
        return false;
4275

4276
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4277
        return false;
4278 4279

    network = virNetworkDefineXML(ctl->conn, buffer);
4280
    VIR_FREE(buffer);
4281

4282 4283 4284
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4285
        virNetworkFree(network);
4286
    } else {
4287
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
4288
        ret = false;
4289 4290 4291 4292 4293 4294 4295 4296
    }
    return ret;
}


/*
 * "net-destroy" command
 */
4297
static const vshCmdInfo info_network_destroy[] = {
4298 4299
    {"help", N_("destroy a network")},
    {"desc", N_("Destroy a given network.")},
4300 4301 4302
    {NULL, NULL}
};

4303
static const vshCmdOptDef opts_network_destroy[] = {
4304
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4305 4306 4307
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4308
static bool
4309
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
4310 4311
{
    virNetworkPtr network;
E
Eric Blake 已提交
4312
    bool ret = true;
4313
    const char *name;
4314

4315
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4316
        return false;
4317

J
Jim Meyering 已提交
4318
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4319
        return false;
4320 4321 4322 4323

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

4328
    virNetworkFree(network);
4329 4330 4331 4332 4333 4334 4335
    return ret;
}


/*
 * "net-dumpxml" command
 */
4336
static const vshCmdInfo info_network_dumpxml[] = {
4337 4338
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
4339 4340 4341
    {NULL, NULL}
};

4342
static const vshCmdOptDef opts_network_dumpxml[] = {
4343
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4344 4345 4346
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4347
static bool
4348
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
4349 4350
{
    virNetworkPtr network;
E
Eric Blake 已提交
4351
    bool ret = true;
4352 4353
    char *dump;

4354
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4355
        return false;
4356

J
Jim Meyering 已提交
4357
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
4358
        return false;
4359 4360 4361

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
4362
        vshPrint(ctl, "%s", dump);
4363
        VIR_FREE(dump);
4364
    } else {
E
Eric Blake 已提交
4365
        ret = false;
4366 4367 4368 4369 4370 4371
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385
/*
 * "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 已提交
4386
static bool
O
Osier Yang 已提交
4387 4388 4389 4390 4391 4392 4393 4394 4395 4396
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 已提交
4397
        return false;
O
Osier Yang 已提交
4398 4399 4400

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4401
        return false;
O
Osier Yang 已提交
4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427

    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 已提交
4428
    return true;
O
Osier Yang 已提交
4429
}
4430

4431 4432 4433 4434
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
4435 4436
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
4437 4438 4439 4440
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
4441
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
4442 4443 4444
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4445
static bool
4446 4447
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4448
    bool ret = false;
4449 4450 4451 4452 4453
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
4454
    int flags = VIR_INTERFACE_XML_INACTIVE;
4455

4456
    if (!vshConnectionUsability(ctl, ctl->conn))
4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482
        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 已提交
4483
        ret = true;
4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495
        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)) {
4496 4497
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509
        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 已提交
4510
    ret = true;
4511 4512 4513 4514 4515

cleanup:
    if (iface)
        virInterfaceFree (iface);

4516 4517 4518
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
4519 4520 4521

    if (tmp) {
        unlink (tmp);
4522
        VIR_FREE(tmp);
4523 4524 4525 4526 4527
    }

    return ret;
}

4528 4529 4530
/*
 * "net-list" command
 */
4531
static const vshCmdInfo info_network_list[] = {
4532 4533
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
4534 4535 4536
    {NULL, NULL}
};

4537
static const vshCmdOptDef opts_network_list[] = {
4538 4539
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
4540 4541 4542
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4543
static bool
4544
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4545 4546 4547 4548 4549
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
4550
    char **activeNames = NULL, **inactiveNames = NULL;
4551 4552
    inactive |= all;

4553
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4554
        return false;
4555 4556

    if (active) {
4557 4558
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
4559
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
4560
            return false;
4561
        }
4562
        if (maxactive) {
4563
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
4564

4565
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
4566
                                                    maxactive)) < 0) {
4567
                vshError(ctl, "%s", _("Failed to list active networks"));
4568
                VIR_FREE(activeNames);
E
Eric Blake 已提交
4569
                return false;
4570
            }
4571

4572
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
4573
        }
4574 4575
    }
    if (inactive) {
4576 4577
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
4578
            vshError(ctl, "%s", _("Failed to list inactive networks"));
4579
            VIR_FREE(activeNames);
E
Eric Blake 已提交
4580
            return false;
4581
        }
4582 4583 4584
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4585 4586 4587
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
4588
                vshError(ctl, "%s", _("Failed to list inactive networks"));
4589 4590
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4591
                return false;
4592
            }
4593

4594 4595
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
4596
    }
4597 4598
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
4599
    vshPrintExtra(ctl, "-----------------------------------------\n");
4600 4601

    for (i = 0; i < maxactive; i++) {
4602 4603
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
4604 4605
        const char *autostartStr;
        int autostart = 0;
4606 4607 4608

        /* this kind of work with networks is not atomic operation */
        if (!network) {
4609
            VIR_FREE(activeNames[i]);
4610
            continue;
4611
        }
4612

4613 4614 4615
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
4616
            autostartStr = autostart ? _("yes") : _("no");
4617 4618 4619 4620 4621

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
4622
        virNetworkFree(network);
4623
        VIR_FREE(activeNames[i]);
4624 4625 4626
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
4627 4628
        const char *autostartStr;
        int autostart = 0;
4629 4630 4631

        /* this kind of work with networks is not atomic operation */
        if (!network) {
4632
            VIR_FREE(inactiveNames[i]);
4633
            continue;
4634
        }
4635

4636 4637 4638
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
4639
            autostartStr = autostart ? _("yes") : _("no");
4640

4641
        vshPrint(ctl, "%-20s %-10s %-10s\n",
4642 4643 4644
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
4645 4646

        virNetworkFree(network);
4647
        VIR_FREE(inactiveNames[i]);
4648
    }
4649 4650
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4651
    return true;
4652 4653 4654 4655 4656 4657
}


/*
 * "net-name" command
 */
4658
static const vshCmdInfo info_network_name[] = {
4659
    {"help", N_("convert a network UUID to network name")},
4660
    {"desc", ""},
4661 4662 4663
    {NULL, NULL}
};

4664
static const vshCmdOptDef opts_network_name[] = {
4665
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
4666 4667 4668
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4669
static bool
4670
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
4671 4672 4673
{
    virNetworkPtr network;

4674
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4675
        return false;
J
Jim Meyering 已提交
4676
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4677
                                           VSH_BYUUID)))
E
Eric Blake 已提交
4678
        return false;
4679 4680 4681

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
4682
    return true;
4683 4684 4685 4686 4687 4688
}


/*
 * "net-start" command
 */
4689
static const vshCmdInfo info_network_start[] = {
4690 4691
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
4692 4693 4694
    {NULL, NULL}
};

4695
static const vshCmdOptDef opts_network_start[] = {
4696
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
4697 4698 4699
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4700
static bool
4701
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
4702 4703
{
    virNetworkPtr network;
E
Eric Blake 已提交
4704
    bool ret = true;
4705

4706
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4707
        return false;
4708

J
Jim Meyering 已提交
4709
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
4710
         return false;
4711 4712 4713

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
4714
                 virNetworkGetName(network));
4715
    } else {
4716
        vshError(ctl, _("Failed to start network %s"),
4717
                 virNetworkGetName(network));
E
Eric Blake 已提交
4718
        ret = false;
4719
    }
L
Laine Stump 已提交
4720
    virNetworkFree(network);
4721 4722 4723 4724 4725 4726 4727
    return ret;
}


/*
 * "net-undefine" command
 */
4728
static const vshCmdInfo info_network_undefine[] = {
4729 4730
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
4731 4732 4733
    {NULL, NULL}
};

4734
static const vshCmdOptDef opts_network_undefine[] = {
4735
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4736 4737 4738
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4739
static bool
4740
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
4741 4742
{
    virNetworkPtr network;
E
Eric Blake 已提交
4743
    bool ret = true;
4744
    const char *name;
4745

4746
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4747
        return false;
4748

J
Jim Meyering 已提交
4749
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4750
        return false;
4751 4752 4753 4754

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

L
Laine Stump 已提交
4759
    virNetworkFree(network);
4760 4761 4762 4763 4764 4765 4766
    return ret;
}


/*
 * "net-uuid" command
 */
4767
static const vshCmdInfo info_network_uuid[] = {
4768
    {"help", N_("convert a network name to network UUID")},
4769
    {"desc", ""},
4770 4771 4772
    {NULL, NULL}
};

4773
static const vshCmdOptDef opts_network_uuid[] = {
4774
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
4775 4776 4777
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4778
static bool
4779
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
4780 4781 4782 4783
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

4784
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4785
        return false;
4786

J
Jim Meyering 已提交
4787
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
4788
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4789
        return false;
4790 4791 4792 4793

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

L
Laine Stump 已提交
4796
    virNetworkFree(network);
E
Eric Blake 已提交
4797
    return true;
4798 4799 4800
}


4801 4802 4803 4804 4805
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
4806 4807
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
4808 4809 4810 4811
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
4812 4813
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
4814 4815
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
4816
static bool
4817 4818 4819 4820 4821 4822 4823 4824 4825
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;

4826
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4827
        return false;
4828 4829 4830 4831

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
4832
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
4833
            return false;
4834 4835 4836 4837 4838 4839
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
4840
                vshError(ctl, "%s", _("Failed to list active interfaces"));
4841
                VIR_FREE(activeNames);
E
Eric Blake 已提交
4842
                return false;
4843 4844 4845 4846 4847 4848 4849 4850
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
4851
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4852
            VIR_FREE(activeNames);
E
Eric Blake 已提交
4853
            return false;
4854 4855 4856 4857
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

4858 4859 4860
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
4861
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
4862 4863
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4864
                return false;
4865 4866 4867 4868 4869
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
4870 4871
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
4872 4873 4874
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
4875 4876
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
4877 4878 4879

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

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4889
        VIR_FREE(activeNames[i]);
4890 4891
    }
    for (i = 0; i < maxinactive; i++) {
4892 4893
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
4894 4895 4896

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
4897
            VIR_FREE(inactiveNames[i]);
4898 4899 4900 4901 4902 4903 4904 4905
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
4906
        VIR_FREE(inactiveNames[i]);
4907
    }
4908 4909
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
4910
    return true;
4911 4912 4913 4914 4915 4916 4917

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
4918
    {"help", N_("convert an interface MAC address to interface name")},
4919 4920 4921 4922 4923
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
4924
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
4925 4926 4927
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4928
static bool
4929 4930 4931 4932
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

4933
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4934
        return false;
4935 4936
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
4937
        return false;
4938 4939 4940

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
4941
    return true;
4942 4943 4944 4945 4946 4947
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
4948
    {"help", N_("convert an interface name to interface MAC address")},
4949 4950 4951 4952 4953
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
4954
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
4955 4956 4957
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4958
static bool
4959 4960 4961 4962
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

4963
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4964
        return false;
4965 4966
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4967
        return false;
4968 4969 4970

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
4971
    return true;
4972 4973 4974 4975 4976 4977
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
4978 4979
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
4980 4981 4982 4983
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
4984 4985
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
4986 4987 4988
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4989
static bool
4990 4991 4992
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
4993
    bool ret = true;
4994
    char *dump;
4995 4996 4997 4998 4999
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
5000

5001
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5002
        return false;
5003 5004

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

5007
    dump = virInterfaceGetXMLDesc(iface, flags);
5008
    if (dump != NULL) {
5009
        vshPrint(ctl, "%s", dump);
5010
        VIR_FREE(dump);
5011
    } else {
E
Eric Blake 已提交
5012
        ret = false;
5013 5014 5015 5016 5017 5018 5019 5020 5021 5022
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
5023 5024
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
5025 5026 5027 5028
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
5029
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
5030 5031 5032
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5033
static bool
5034 5035
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
5036
    virInterfacePtr iface;
5037
    const char *from = NULL;
E
Eric Blake 已提交
5038
    bool ret = true;
5039 5040
    char *buffer;

5041
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5042
        return false;
5043

5044
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5045
        return false;
5046 5047

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

5050
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
5051
    VIR_FREE(buffer);
5052

5053
    if (iface != NULL) {
5054
        vshPrint(ctl, _("Interface %s defined from %s\n"),
5055
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
5056
        virInterfaceFree (iface);
5057
    } else {
5058
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
5059
        ret = false;
5060 5061 5062 5063 5064 5065 5066 5067
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
5068 5069
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
5070 5071 5072 5073
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
5074
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5075 5076 5077
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5078
static bool
5079 5080 5081
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5082
    bool ret = true;
5083
    const char *name;
5084

5085
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5086
        return false;
5087 5088

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5089
        return false;
5090 5091 5092 5093

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
5094
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
5095
        ret = false;
5096 5097 5098 5099 5100 5101 5102 5103 5104 5105
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
5106 5107
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
5108 5109 5110 5111
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
5112
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5113 5114 5115
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5116
static bool
5117 5118 5119
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5120
    bool ret = true;
5121
    const char *name;
5122

5123
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5124
        return false;
5125 5126

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5127
        return false;
5128 5129 5130 5131

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
5132
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
5133
        ret = false;
5134 5135 5136 5137 5138 5139 5140 5141 5142 5143
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
5144 5145
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
    {"desc", N_("destroy a physical host interface.")},
5146 5147 5148 5149
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
5150
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5151 5152 5153
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5154
static bool
5155 5156 5157
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5158
    bool ret = true;
5159
    const char *name;
5160

5161
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5162
        return false;
5163 5164

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5165
        return false;
5166 5167 5168 5169

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
5170
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
5171
        ret = false;
5172 5173 5174 5175 5176 5177
    }

    virInterfaceFree(iface);
    return ret;
}

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 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262
/*
 * "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;
}
5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277

/*
 * "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 已提交
5278
static bool
5279 5280 5281
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
5282
    const char *from = NULL;
E
Eric Blake 已提交
5283
    bool ret = true;
5284 5285
    char *buffer;

5286
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5287
        return false;
5288

5289
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5290
        return false;
5291 5292

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5293
        return false;
5294 5295 5296 5297 5298 5299 5300 5301 5302 5303

    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 已提交
5304
        ret = false;
5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323
    }
    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 已提交
5324
static bool
5325 5326 5327
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5328
    bool ret = true;
5329
    const char *name;
5330

5331
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5332
        return false;
5333 5334

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
5335
        return false;
5336 5337 5338 5339 5340

    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 已提交
5341
        ret = false;
5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362
    }

    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 已提交
5363
static bool
5364 5365 5366
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5367
    bool ret = true;
5368 5369
    char *dump;

5370
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5371
        return false;
5372 5373

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
5374
        return false;
5375 5376 5377

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
5378
        vshPrint(ctl, "%s", dump);
5379 5380
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
5381
        ret = false;
5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400
    }

    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 已提交
5401
static bool
5402 5403 5404 5405 5406 5407
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

5408
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5409
        return false;
5410 5411 5412 5413

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
5414
        return false;
5415 5416 5417 5418 5419 5420 5421 5422
    }

    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 已提交
5423
        return false;
5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450
    }

    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 已提交
5451
    return true;
5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468
}


/*
 * "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 已提交
5469
static bool
5470 5471
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5472
    bool ret = false;
5473 5474 5475 5476 5477 5478
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

5479
    if (!vshConnectionUsability(ctl, ctl->conn))
5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505
        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 已提交
5506
        ret = true;
5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532
        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 已提交
5533
    ret = true;
5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551

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;
}


5552
/**************************************************************************/
5553
/*
5554
 * "pool-autostart" command
5555
 */
5556
static const vshCmdInfo info_pool_autostart[] = {
5557
    {"help", N_("autostart a pool")},
5558
    {"desc",
5559
     N_("Configure a pool to be automatically started at boot.")},
5560
    {NULL, NULL}
5561 5562
};

5563
static const vshCmdOptDef opts_pool_autostart[] = {
5564 5565
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5566 5567
    {NULL, 0, 0, NULL}
};
5568

E
Eric Blake 已提交
5569
static bool
5570
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
5571
{
5572
    virStoragePoolPtr pool;
5573
    const char *name;
5574
    int autostart;
5575

5576
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5577
        return false;
5578

5579
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5580
        return false;
5581

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

5584 5585
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
5586
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
5587
        else
5588
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
5589
        virStoragePoolFree(pool);
E
Eric Blake 已提交
5590
        return false;
5591 5592
    }

5593
    if (autostart)
5594
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
5595
    else
5596
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
5597

L
Laine Stump 已提交
5598
    virStoragePoolFree(pool);
E
Eric Blake 已提交
5599
    return true;
5600 5601
}

5602
/*
5603
 * "pool-create" command
5604
 */
5605
static const vshCmdInfo info_pool_create[] = {
5606 5607
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
5608 5609 5610
    {NULL, NULL}
};

5611
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
5612
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
5613
     N_("file containing an XML pool description")},
5614 5615 5616
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5617
static bool
5618
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
5619
{
5620
    virStoragePoolPtr pool;
5621
    const char *from = NULL;
E
Eric Blake 已提交
5622
    bool ret = true;
5623
    char *buffer;
5624

5625
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5626
        return false;
5627

5628
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5629
        return false;
5630

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

5634
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
5635
    VIR_FREE(buffer);
5636 5637 5638 5639

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5640
        virStoragePoolFree(pool);
5641
    } else {
5642
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
5643
        ret = false;
5644 5645
    }
    return ret;
5646 5647
}

5648

5649 5650 5651 5652
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
5653
    {"help", N_("create a device defined "
5654
                          "by an XML file on the node")},
5655
    {"desc", N_("Create a device on the node.  Note that this "
5656 5657 5658 5659 5660 5661 5662
                          "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,
5663
     N_("file containing an XML description of the device")},
5664 5665 5666
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5667
static bool
5668 5669 5670
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
5671
    const char *from = NULL;
E
Eric Blake 已提交
5672
    bool ret = true;
5673 5674
    char *buffer;

5675
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5676
        return false;
5677

5678
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5679
        return false;
5680

5681
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5682
        return false;
5683 5684

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
5685
    VIR_FREE(buffer);
5686 5687 5688 5689

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
5690
        virNodeDeviceFree(dev);
5691
    } else {
5692
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
5693
        ret = false;
5694 5695 5696 5697 5698 5699 5700 5701 5702 5703
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
5704 5705
    {"help", N_("destroy a device on the node")},
    {"desc", N_("Destroy a device on the node.  Note that this "
5706 5707 5708 5709 5710 5711
                          "command destroys devices on the physical host ")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
5712
     N_("name of the device to be destroyed")},
5713 5714 5715
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5716
static bool
5717 5718 5719
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
5720
    bool ret = true;
5721
    const char *name = NULL;
5722

5723
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
5724
        return false;
5725 5726
    }

5727
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
5728
        return false;
5729 5730 5731 5732 5733 5734

    dev = virNodeDeviceLookupByName(ctl->conn, name);

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
5735
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
5736
        ret = false;
5737 5738 5739 5740 5741 5742 5743
    }

    virNodeDeviceFree(dev);
    return ret;
}


5744
/*
5745
 * XML Building helper for pool-define-as and pool-create-as
5746
 */
5747
static const vshCmdOptDef opts_pool_X_as[] = {
5748 5749 5750 5751 5752 5753 5754 5755
    {"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")},
5756
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
5757 5758 5759
    {NULL, 0, 0, NULL}
};

5760
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
5761

5762 5763
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
5764
    virBuffer buf = VIR_BUFFER_INITIALIZER;
5765

5766
    if (vshCommandOptString(cmd, "name", &name) <= 0)
5767
        goto cleanup;
5768
    if (vshCommandOptString(cmd, "type", &type) <= 0)
5769 5770
        goto cleanup;

5771 5772 5773 5774 5775
    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 ||
5776 5777
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
5778
        goto cleanup;
5779
    }
5780

5781 5782
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
5783
    if (srcHost || srcPath || srcDev) {
5784
        virBufferAddLit(&buf, "  <source>\n");
5785

5786
        if (srcHost)
5787
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
5788
        if (srcPath)
5789
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
5790
        if (srcDev)
5791
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
5792
        if (srcFormat)
5793
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
5794
        if (srcName)
5795
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
5796 5797

        virBufferAddLit(&buf, "  </source>\n");
5798 5799
    }
    if (target) {
5800
        virBufferAddLit(&buf, "  <target>\n");
5801
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
5802
        virBufferAddLit(&buf, "  </target>\n");
5803
    }
5804 5805 5806 5807
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
5808
        return false;
5809
    }
5810 5811 5812

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
5813
    return true;
5814 5815

cleanup:
5816
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
5817
    return false;
5818 5819 5820 5821 5822 5823
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
5824 5825
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
5826 5827 5828
    {NULL, NULL}
};

E
Eric Blake 已提交
5829
static bool
5830 5831 5832
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
5833 5834
    const char *name;
    char *xml;
5835
    int printXML = vshCommandOptBool(cmd, "print-xml");
5836

5837
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5838
        return false;
5839 5840

    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
5841
        return false;
5842

5843
    if (printXML) {
5844
        vshPrint(ctl, "%s", xml);
5845
        VIR_FREE(xml);
5846
    } else {
5847
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
5848
        VIR_FREE(xml);
5849

5850 5851 5852 5853
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
5854
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
5855
            return false;
5856 5857
        }
    }
E
Eric Blake 已提交
5858
    return true;
5859 5860
}

5861

5862
/*
5863
 * "pool-define" command
5864
 */
5865
static const vshCmdInfo info_pool_define[] = {
5866 5867
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
5868 5869 5870
    {NULL, NULL}
};

5871
static const vshCmdOptDef opts_pool_define[] = {
5872
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
5873 5874 5875
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5876
static bool
5877
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
5878
{
5879
    virStoragePoolPtr pool;
5880
    const char *from = NULL;
E
Eric Blake 已提交
5881
    bool ret = true;
5882
    char *buffer;
5883

5884
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5885
        return false;
5886

5887
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5888
        return false;
5889

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

5893
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
5894
    VIR_FREE(buffer);
5895 5896 5897 5898

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
5899
        virStoragePoolFree(pool);
5900
    } else {
5901
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
5902
        ret = false;
5903 5904
    }
    return ret;
5905 5906
}

5907

5908 5909 5910
/*
 * "pool-define-as" command
 */
5911
static const vshCmdInfo info_pool_define_as[] = {
5912 5913
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
5914 5915 5916
    {NULL, NULL}
};

E
Eric Blake 已提交
5917
static bool
5918
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
5919 5920
{
    virStoragePoolPtr pool;
5921 5922
    const char *name;
    char *xml;
5923
    int printXML = vshCommandOptBool(cmd, "print-xml");
5924

5925
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5926
        return false;
5927

5928
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
5929
        return false;
5930

5931
    if (printXML) {
5932
        vshPrint(ctl, "%s", xml);
5933
        VIR_FREE(xml);
5934
    } else {
5935
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
5936
        VIR_FREE(xml);
5937

5938 5939 5940 5941
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
5942
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
5943
            return false;
5944 5945
        }
    }
E
Eric Blake 已提交
5946
    return true;
5947 5948 5949
}


5950
/*
5951
 * "pool-build" command
5952
 */
5953
static const vshCmdInfo info_pool_build[] = {
5954 5955
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
5956 5957 5958
    {NULL, NULL}
};

5959
static const vshCmdOptDef opts_pool_build[] = {
5960
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
5961 5962 5963
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5964
static bool
5965
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
5966
{
5967
    virStoragePoolPtr pool;
E
Eric Blake 已提交
5968
    bool ret = true;
5969
    const char *name;
5970

5971
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5972
        return false;
5973

5974
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
5975
        return false;
5976

5977
    if (virStoragePoolBuild(pool, 0) == 0) {
5978
        vshPrint(ctl, _("Pool %s built\n"), name);
5979
    } else {
5980
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
5981
        ret = false;
5982 5983
    }

5984 5985
    virStoragePoolFree(pool);

5986 5987 5988
    return ret;
}

5989

5990
/*
5991
 * "pool-destroy" command
5992
 */
5993
static const vshCmdInfo info_pool_destroy[] = {
5994 5995
    {"help", N_("destroy a pool")},
    {"desc", N_("Destroy a given pool.")},
5996 5997 5998
    {NULL, NULL}
};

5999
static const vshCmdOptDef opts_pool_destroy[] = {
6000
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6001 6002 6003
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6004
static bool
6005
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
6006
{
6007
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6008
    bool ret = true;
6009
    const char *name;
6010

6011
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6012
        return false;
6013

6014
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6015
        return false;
6016

6017 6018 6019
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
6020
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
6021
        ret = false;
6022 6023
    }

6024
    virStoragePoolFree(pool);
6025 6026 6027
    return ret;
}

6028

6029
/*
6030 6031
 * "pool-delete" command
 */
6032
static const vshCmdInfo info_pool_delete[] = {
6033 6034
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
6035 6036 6037
    {NULL, NULL}
};

6038
static const vshCmdOptDef opts_pool_delete[] = {
6039
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6040 6041 6042
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6043
static bool
6044
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
6045 6046
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6047
    bool ret = true;
6048
    const char *name;
6049

6050
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6051
        return false;
6052 6053

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6054
        return false;
6055 6056

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
6057
        vshPrint(ctl, _("Pool %s deleted\n"), name);
6058
    } else {
6059
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
6060
        ret = false;
6061 6062
    }

L
Laine Stump 已提交
6063
    virStoragePoolFree(pool);
6064 6065 6066 6067 6068 6069 6070
    return ret;
}


/*
 * "pool-refresh" command
 */
6071
static const vshCmdInfo info_pool_refresh[] = {
6072 6073
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
6074 6075 6076
    {NULL, NULL}
};

6077
static const vshCmdOptDef opts_pool_refresh[] = {
6078
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6079 6080 6081
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6082
static bool
6083
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
6084 6085
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6086
    bool ret = true;
6087
    const char *name;
6088

6089
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6090
        return false;
6091 6092

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6093
        return false;
6094 6095 6096 6097

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
6098
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
6099
        ret = false;
6100 6101 6102 6103 6104 6105 6106 6107 6108 6109
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
6110
static const vshCmdInfo info_pool_dumpxml[] = {
6111 6112
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
6113 6114 6115
    {NULL, NULL}
};

6116
static const vshCmdOptDef opts_pool_dumpxml[] = {
6117
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6118 6119 6120
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6121
static bool
6122
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
6123 6124
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6125
    bool ret = true;
6126 6127
    char *dump;

6128
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6129
        return false;
6130 6131

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6132
        return false;
6133 6134 6135

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
6136
        vshPrint(ctl, "%s", dump);
6137
        VIR_FREE(dump);
6138
    } else {
E
Eric Blake 已提交
6139
        ret = false;
6140 6141 6142 6143 6144 6145 6146 6147 6148 6149
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
6150
static const vshCmdInfo info_pool_list[] = {
6151 6152
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
6153 6154 6155
    {NULL, NULL}
};

6156
static const vshCmdOptDef opts_pool_list[] = {
6157 6158
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
6159
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
6160 6161 6162
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6163
static bool
6164
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6165
{
6166 6167
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
6168 6169
    int i, ret;
    bool functionReturn;
6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185
    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 */
6186
    int all = vshCommandOptBool(cmd, "all");
6187 6188
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
6189 6190 6191
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

6192
    /* Check the connection to libvirtd daemon is still working */
6193
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6194
        return false;
6195

6196
    /* Retrieve the number of active storage pools */
6197
    if (active) {
6198 6199
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
6200
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
6201
            return false;
6202 6203
        }
    }
6204 6205

    /* Retrieve the number of inactive storage pools */
6206
    if (inactive) {
6207 6208
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
6209
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
6210
            return false;
6211
        }
6212
    }
6213

6214 6215
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
6216

6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228
    /* 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 已提交
6229
            return false;
6230 6231 6232
        }
    }

6233 6234 6235 6236 6237 6238 6239 6240
    /* 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 已提交
6241
            return false;
6242 6243
        }
    }
6244

6245 6246 6247 6248 6249 6250 6251 6252 6253 6254
    /* 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]);
6255
        if (!pool) {
6256
            VIR_FREE(poolNames[i]);
6257 6258 6259
            continue;
        }

6260
        /* Retrieve the autostart status of the pool */
6261
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
6262
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
6263
        else
6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281
            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;
        }
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 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394
        /* 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 */
6395 6396 6397
        virStoragePoolFree(pool);
    }

6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415
    /* 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);
6416 6417
        }

6418
        /* Cleanup and return */
E
Eric Blake 已提交
6419
        functionReturn = true;
6420 6421
        goto cleanup;
    }
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 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516
    /* 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 已提交
6517
    functionReturn = true;
6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531
    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 已提交
6532
    functionReturn = false;
6533

6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545
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]);
6546
    }
6547 6548 6549 6550 6551 6552 6553

    /* Cleanup the memory for the initial arrays*/
    VIR_FREE(poolInfoTexts);
    VIR_FREE(poolNames);

    /* Return the desired value */
    return functionReturn;
6554 6555
}

6556 6557 6558 6559
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
6560 6561
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6562 6563 6564 6565 6566
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6567 6568 6569
     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")},
6570
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
6571 6572 6573
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6574
static bool
6575 6576
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6577
    const char *type = NULL, *host = NULL;
6578 6579
    char *srcSpec = NULL;
    char *srcList;
6580
    const char *initiator = NULL;
6581

6582 6583
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
6584 6585
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
6586
        return false;
6587
    }
6588

6589
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6590
        return false;
6591 6592

    if (host) {
6593
        const char *port = NULL;
6594
        virBuffer buf = VIR_BUFFER_INITIALIZER;
6595 6596 6597 6598

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6599
            return false;
6600
        }
6601
        virBufferAddLit(&buf, "<source>\n");
6602
        virBufferAsprintf(&buf, "  <host name='%s'", host);
6603
        if (port)
6604
            virBufferAsprintf(&buf, " port='%s'", port);
6605
        virBufferAddLit(&buf, "/>\n");
6606 6607
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
6608
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
6609 6610
            virBufferAddLit(&buf, "  </initiator>\n");
        }
6611 6612 6613
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
6614
            return false;
6615
        }
6616
        srcSpec = virBufferContentAndReset(&buf);
6617 6618 6619
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6620
    VIR_FREE(srcSpec);
6621
    if (srcList == NULL) {
6622
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
6623
        return false;
6624 6625
    }
    vshPrint(ctl, "%s", srcList);
6626
    VIR_FREE(srcList);
6627

E
Eric Blake 已提交
6628
    return true;
6629 6630 6631 6632 6633 6634 6635
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
6636 6637
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
6638 6639 6640 6641 6642
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
6643
     N_("type of storage pool sources to discover")},
6644
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
6645
     N_("optional file of source xml to query for pools")},
6646 6647 6648
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6649
static bool
6650 6651
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
6652
    const char *type = NULL, *srcSpecFile = NULL;
6653
    char *srcSpec = NULL, *srcList;
6654

6655
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
6656
        return false;
6657

6658 6659
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
6660
        return false;
6661
    }
6662

6663
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6664
        return false;
6665 6666

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
6667
        return false;
6668 6669

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
6670
    VIR_FREE(srcSpec);
6671
    if (srcList == NULL) {
6672
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
6673
        return false;
6674 6675
    }
    vshPrint(ctl, "%s", srcList);
6676
    VIR_FREE(srcList);
6677

E
Eric Blake 已提交
6678
    return true;
6679 6680 6681
}


6682 6683 6684
/*
 * "pool-info" command
 */
6685
static const vshCmdInfo info_pool_info[] = {
6686 6687
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
6688 6689 6690
    {NULL, NULL}
};

6691
static const vshCmdOptDef opts_pool_info[] = {
6692
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6693 6694 6695
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6696
static bool
6697
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
6698 6699 6700
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
6701 6702
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
6703
    bool ret = true;
6704 6705
    char uuid[VIR_UUID_STRING_BUFLEN];

6706
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6707
        return false;
6708 6709

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6710
        return false;
6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736

    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;
6737 6738 6739 6740
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
6741 6742
        }

6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758
        /* 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"));

6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770
        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 已提交
6771
        ret = false;
6772 6773 6774 6775 6776 6777 6778 6779 6780 6781
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
6782
static const vshCmdInfo info_pool_name[] = {
6783
    {"help", N_("convert a pool UUID to pool name")},
6784
    {"desc", ""},
6785 6786 6787
    {NULL, NULL}
};

6788
static const vshCmdOptDef opts_pool_name[] = {
6789
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
6790 6791 6792
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6793
static bool
6794
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
6795 6796 6797
{
    virStoragePoolPtr pool;

6798
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6799
        return false;
6800
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
6801
                                           VSH_BYUUID)))
E
Eric Blake 已提交
6802
        return false;
6803 6804 6805

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6806
    return true;
6807 6808 6809 6810 6811 6812
}


/*
 * "pool-start" command
 */
6813
static const vshCmdInfo info_pool_start[] = {
6814 6815
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
6816 6817 6818
    {NULL, NULL}
};

6819
static const vshCmdOptDef opts_pool_start[] = {
6820
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
6821 6822 6823
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6824
static bool
6825
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
6826 6827
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6828
    bool ret = true;
6829

6830
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6831
        return false;
6832

6833
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
6834
         return false;
6835 6836 6837 6838 6839

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
6840
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
6841
        ret = false;
6842
    }
L
Laine Stump 已提交
6843 6844

    virStoragePoolFree(pool);
6845 6846 6847 6848
    return ret;
}


6849 6850 6851
/*
 * "vol-create-as" command
 */
6852
static const vshCmdInfo info_vol_create_as[] = {
6853 6854
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
6855 6856 6857
    {NULL, NULL}
};

6858
static const vshCmdOptDef opts_vol_create_as[] = {
6859 6860 6861 6862 6863
    {"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")},
6864 6865
    {"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")},
6866 6867 6868 6869 6870 6871 6872 6873 6874 6875
    {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 已提交
6876
        /* Deliberate fallthrough cases here :-) */
6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896
        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 已提交
6897
static bool
6898
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
6899 6900 6901
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
6902
    char *xml;
6903 6904
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
6905
    unsigned long long capacity, allocation = 0;
6906
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6907

6908
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6909
        return false;
6910 6911 6912

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
                                     VSH_BYNAME)))
E
Eric Blake 已提交
6913
        return false;
6914

6915
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6916 6917
        goto cleanup;

6918
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
6919 6920
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
6921
        vshError(ctl, _("Malformed size %s"), capacityStr);
6922

6923 6924
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
6925
        vshError(ctl, _("Malformed size %s"), allocationStr);
6926

6927 6928 6929 6930 6931 6932 6933
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

6934

6935
    virBufferAddLit(&buf, "<volume>\n");
6936 6937
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
6938
    if (allocationStr)
6939
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
6940 6941

    if (format) {
6942
        virBufferAddLit(&buf, "  <target>\n");
6943
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
6944
        virBufferAddLit(&buf, "  </target>\n");
6945
    }
6946

6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979
    /* 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 已提交
6980
            return false;
6981 6982 6983 6984 6985
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
6986
            return false;
6987 6988 6989 6990
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
6991
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
6992
        if (snapshotStrFormat)
6993
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
6994 6995 6996 6997 6998 6999 7000 7001
        virBufferAddLit(&buf, "  </backingStore>\n");

        /* Cleanup snapshot allocations */
        VIR_FREE(snapshotStrVolPath);
        virStorageVolFree(snapVol);
    }

    virBufferAddLit(&buf, "</volume>\n");
7002

7003 7004
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7005
        return false;
7006 7007 7008
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
7009
    VIR_FREE(xml);
7010 7011 7012 7013 7014
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
7015
        return true;
7016
    } else {
7017
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
7018
        return false;
7019 7020 7021
    }

 cleanup:
7022
    virBufferFreeAndReset(&buf);
7023
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7024
    return false;
7025 7026 7027
}


7028 7029 7030
/*
 * "pool-undefine" command
 */
7031
static const vshCmdInfo info_pool_undefine[] = {
7032 7033
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
7034 7035 7036
    {NULL, NULL}
};

7037
static const vshCmdOptDef opts_pool_undefine[] = {
7038
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7039 7040 7041
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7042
static bool
7043
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
7044 7045
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7046
    bool ret = true;
7047
    const char *name;
7048

7049
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7050
        return false;
7051 7052

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7053
        return false;
7054 7055 7056 7057

    if (virStoragePoolUndefine(pool) == 0) {
        vshPrint(ctl, _("Pool %s has been undefined\n"), name);
    } else {
7058
        vshError(ctl, _("Failed to undefine pool %s"), name);
E
Eric Blake 已提交
7059
        ret = false;
7060 7061
    }

L
Laine Stump 已提交
7062
    virStoragePoolFree(pool);
7063 7064 7065 7066 7067 7068 7069
    return ret;
}


/*
 * "pool-uuid" command
 */
7070
static const vshCmdInfo info_pool_uuid[] = {
7071
    {"help", N_("convert a pool name to pool UUID")},
7072
    {"desc", ""},
7073 7074 7075
    {NULL, NULL}
};

7076
static const vshCmdOptDef opts_pool_uuid[] = {
7077
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
7078 7079 7080
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7081
static bool
7082
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
7083 7084 7085 7086
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

7087
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7088
        return false;
7089 7090

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7091
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7092
        return false;
7093 7094 7095 7096

    if (virStoragePoolGetUUIDString(pool, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
7097
        vshError(ctl, "%s", _("failed to get pool UUID"));
7098

L
Laine Stump 已提交
7099
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7100
    return true;
7101 7102 7103 7104 7105 7106
}


/*
 * "vol-create" command
 */
7107
static const vshCmdInfo info_vol_create[] = {
7108 7109
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
7110 7111 7112
    {NULL, NULL}
};

7113
static const vshCmdOptDef opts_vol_create[] = {
7114 7115
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
7116 7117 7118
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7119
static bool
7120
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
7121 7122 7123
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7124
    const char *from = NULL;
E
Eric Blake 已提交
7125
    bool ret = true;
7126 7127
    char *buffer;

7128
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7129
        return false;
7130 7131

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7132
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7133
        return false;
7134

7135
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7136
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7137
        return false;
7138 7139 7140
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7141
        virshReportError(ctl);
7142
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7143
        return false;
7144 7145 7146
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
7147
    VIR_FREE(buffer);
7148 7149 7150 7151 7152 7153 7154
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
7155
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
7156
        ret = false;
7157 7158 7159 7160
    }
    return ret;
}

7161 7162 7163 7164
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
7165 7166
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
7167 7168 7169 7170
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
7171 7172 7173
    {"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 已提交
7174
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
7175 7176 7177
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7178
static bool
7179 7180 7181 7182
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
7183
    const char *from = NULL;
E
Eric Blake 已提交
7184
    bool ret = false;
7185 7186
    char *buffer = NULL;

7187
    if (!vshConnectionUsability(ctl, ctl->conn))
7188 7189 7190 7191 7192
        goto cleanup;

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
        goto cleanup;

7193
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7194 7195 7196 7197 7198 7199 7200
        goto cleanup;
    }

    if (!(inputvol = vshCommandOptVol(ctl, cmd, "vol", "inputpool", NULL)))
        goto cleanup;

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7201
        virshReportError(ctl);
7202 7203 7204 7205 7206 7207 7208 7209 7210
        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 {
7211
        vshError(ctl, _("Failed to create vol from %s"), from);
7212 7213 7214
        goto cleanup;
    }

E
Eric Blake 已提交
7215
    ret = true;
7216
cleanup:
7217
    VIR_FREE(buffer);
7218 7219 7220 7221
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
7222 7223
    if (newvol)
        virStorageVolFree(newvol);
7224 7225 7226 7227
    return ret;
}

static xmlChar *
7228
makeCloneXML(const char *origxml, const char *newname) {
7229

7230 7231 7232
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262
    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[] = {
7263 7264
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
7265 7266 7267 7268
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
7269 7270
    {"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 已提交
7271
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7272 7273 7274
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7275
static bool
7276 7277 7278 7279
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
7280
    const char *name = NULL;
7281
    char *origxml = NULL;
7282
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
7283
    bool ret = false;
7284

7285
    if (!vshConnectionUsability(ctl, ctl->conn))
7286 7287 7288 7289 7290 7291 7292
        goto cleanup;

    if (!(origvol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        goto cleanup;

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
7293
        vshError(ctl, "%s", _("failed to get parent pool"));
7294 7295 7296
        goto cleanup;
    }

7297
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315
        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 {
7316
        vshError(ctl, _("Failed to clone vol from %s"),
7317 7318 7319 7320
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
7321
    ret = true;
7322 7323

cleanup:
7324
    VIR_FREE(origxml);
7325 7326 7327
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
7328 7329
    if (newvol)
        virStorageVolFree(newvol);
7330 7331 7332 7333 7334
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347

/*
 * "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 已提交
7348
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362
    {"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 已提交
7363
static bool
7364 7365 7366 7367
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7368
    bool ret = false;
7369 7370 7371 7372 7373 7374 7375 7376 7377 7378
    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 已提交
7379
        return false;
7380 7381 7382 7383
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7384
        return false;
7385 7386 7387
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7388
        return false;
7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422
    }

    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 已提交
7423
    ret = true;
7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447

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 已提交
7448
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463
    {"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 已提交
7464
static bool
7465 7466 7467 7468
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7469
    bool ret = false;
7470 7471 7472 7473
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
7474
    bool created = false;
7475 7476

    if (!vshConnectionUsability(ctl, ctl->conn))
7477
        return false;
7478 7479 7480

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7481
        return false;
7482 7483 7484 7485
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7486
        return false;
7487 7488 7489
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
7490
        return false;
7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502

    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;
        }
7503 7504
    } else {
        created = true;
7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528
    }

    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 已提交
7529
    ret = true;
7530 7531

cleanup:
7532
    VIR_FORCE_CLOSE(fd);
7533
    if (!ret && created)
7534 7535 7536 7537 7538 7539 7540 7541 7542
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


7543 7544 7545
/*
 * "vol-delete" command
 */
7546
static const vshCmdInfo info_vol_delete[] = {
7547 7548
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
7549 7550 7551
    {NULL, NULL}
};

7552
static const vshCmdOptDef opts_vol_delete[] = {
7553
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7554
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7555 7556 7557
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7558
static bool
7559
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
7560 7561
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7562
    bool ret = true;
7563
    const char *name;
7564

7565
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7566
        return false;
7567 7568

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7569
        return false;
7570 7571 7572
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
7573
        vshPrint(ctl, _("Vol %s deleted\n"), name);
7574
    } else {
7575
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
7576
        ret = false;
7577 7578
    }

L
Laine Stump 已提交
7579
    virStorageVolFree(vol);
7580 7581 7582 7583
    return ret;
}


D
David Allan 已提交
7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594
/*
 * "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 已提交
7595
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
7596 7597 7598
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7599
static bool
D
David Allan 已提交
7600 7601 7602
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7603
    bool ret = true;
7604
    const char *name;
D
David Allan 已提交
7605

7606
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7607
        return false;
D
David Allan 已提交
7608 7609

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7610
        return false;
D
David Allan 已提交
7611 7612 7613 7614 7615 7616
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
7617
        ret = false;
D
David Allan 已提交
7618 7619 7620 7621 7622 7623 7624
    }

    virStorageVolFree(vol);
    return ret;
}


7625 7626 7627
/*
 * "vol-info" command
 */
7628
static const vshCmdInfo info_vol_info[] = {
7629 7630
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
7631 7632 7633
    {NULL, NULL}
};

7634
static const vshCmdOptDef opts_vol_info[] = {
7635
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7636
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7637 7638 7639
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7640
static bool
7641
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
7642 7643 7644
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
7645
    bool ret = true;
7646

7647
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7648
        return false;
7649 7650

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
7651
        return false;
7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667

    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 已提交
7668
        ret = false;
7669 7670 7671 7672 7673 7674 7675 7676 7677 7678
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
7679
static const vshCmdInfo info_vol_dumpxml[] = {
7680 7681
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
7682 7683 7684
    {NULL, NULL}
};

7685
static const vshCmdOptDef opts_vol_dumpxml[] = {
7686
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
7687
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7688 7689 7690
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7691
static bool
7692
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
7693 7694
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
7695
    bool ret = true;
7696 7697
    char *dump;

7698
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7699
        return false;
7700 7701

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
7702
        return false;
7703 7704 7705

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
7706
        vshPrint(ctl, "%s", dump);
7707
        VIR_FREE(dump);
7708
    } else {
E
Eric Blake 已提交
7709
        ret = false;
7710 7711 7712 7713 7714 7715 7716 7717 7718 7719
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
7720
static const vshCmdInfo info_vol_list[] = {
7721 7722
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
7723 7724 7725
    {NULL, NULL}
};

7726
static const vshCmdOptDef opts_vol_list[] = {
7727
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7728
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
7729 7730 7731
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7732
static bool
7733
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7734
{
7735
    virStorageVolInfo volumeInfo;
7736 7737
    virStoragePoolPtr pool;
    char **activeNames = NULL;
7738 7739 7740 7741 7742
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
7743 7744
    int ret;
    bool functionReturn;
7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755
    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;
7756

7757
    /* Check the connection to libvirtd daemon is still working */
7758
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7759
        return false;
7760

7761
    /* Look up the pool information given to us by the user */
7762
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7763
        return false;
7764

7765 7766
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
7767

7768 7769 7770
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7771
        return false;
7772 7773
    }

7774 7775 7776 7777 7778
    /* 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) {
7779
            vshError(ctl, "%s", _("Failed to list active vols"));
7780
            VIR_FREE(activeNames);
7781
            virStoragePoolFree(pool);
E
Eric Blake 已提交
7782
            return false;
7783 7784
        }

7785 7786 7787 7788 7789
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

        /* Set aside memory for volume information pointers */
        volInfoTexts = vshCalloc(ctl, numVolumes, sizeof(*volInfoTexts));
7790 7791
    }

7792 7793 7794 7795 7796
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
7797

7798 7799 7800 7801
        /* 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"));
7802 7803
        }

7804 7805 7806 7807 7808 7809 7810 7811 7812
        /* 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 */
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 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868
                /* 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;
        }
7869

7870
        /* Cleanup memory allocation */
7871
        virStorageVolFree(vol);
7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889
    }

    /* 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 已提交
7890
        functionReturn = true;
7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921
        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 已提交
7922 7923 7924 7925 7926
    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);
7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960

    /* 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 已提交
7961
    functionReturn = true;
7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975
    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 已提交
7976
    functionReturn = false;
7977 7978 7979 7980 7981 7982 7983 7984 7985 7986

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);
7987
        VIR_FREE(activeNames[i]);
7988
    }
7989 7990 7991 7992

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
7993
    VIR_FREE(activeNames);
7994
    virStoragePoolFree(pool);
7995 7996 7997

    /* Return the desired value */
    return functionReturn;
7998 7999 8000 8001 8002 8003
}


/*
 * "vol-name" command
 */
8004
static const vshCmdInfo info_vol_name[] = {
8005
    {"help", N_("returns the volume name for a given volume key or path")},
8006
    {"desc", ""},
8007 8008 8009
    {NULL, NULL}
};

8010
static const vshCmdOptDef opts_vol_name[] = {
8011
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
8012 8013 8014
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8015
static bool
8016
cmdVolName(vshControl *ctl, const vshCmd *cmd)
8017 8018 8019
{
    virStorageVolPtr vol;

8020
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8021
        return false;
8022 8023 8024

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
E
Eric Blake 已提交
8025
        return false;
8026 8027 8028

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8029
    return true;
8030 8031 8032
}


J
Justin Clift 已提交
8033 8034 8035 8036 8037 8038 8039 8040 8041 8042
/*
 * "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[] = {
8043
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
8044 8045 8046 8047
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8048
static bool
J
Justin Clift 已提交
8049 8050 8051 8052
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8053
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
8054 8055

    /* Check the connection to libvirtd daemon is still working */
8056
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8057
        return false;
J
Justin Clift 已提交
8058 8059 8060 8061

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
8062
        return false;
J
Justin Clift 已提交
8063 8064 8065 8066 8067 8068 8069
    }

    /* 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 已提交
8070
        return false;
J
Justin Clift 已提交
8071 8072
    }

8073 8074 8075 8076 8077 8078 8079 8080 8081
    /* 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 已提交
8082 8083 8084 8085

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8086
    return true;
J
Justin Clift 已提交
8087 8088
}

8089 8090 8091 8092

/*
 * "vol-key" command
 */
8093
static const vshCmdInfo info_vol_key[] = {
8094
    {"help", N_("returns the volume key for a given volume name or path")},
8095
    {"desc", ""},
8096 8097 8098
    {NULL, NULL}
};

8099
static const vshCmdOptDef opts_vol_key[] = {
8100
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
8101
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8102 8103 8104
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8105
static bool
8106
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
8107 8108 8109
{
    virStorageVolPtr vol;

8110
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8111
        return false;
8112

8113
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8114
        return false;
8115 8116 8117

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8118
    return true;
8119 8120 8121 8122 8123 8124 8125
}



/*
 * "vol-path" command
 */
8126
static const vshCmdInfo info_vol_path[] = {
8127
    {"help", N_("returns the volume path for a given volume name or key")},
8128
    {"desc", ""},
8129 8130 8131
    {NULL, NULL}
};

8132
static const vshCmdOptDef opts_vol_path[] = {
8133
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
8134
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8135 8136 8137
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8138
static bool
8139
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
8140 8141
{
    virStorageVolPtr vol;
8142
    const char *name = NULL;
8143

8144
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8145
        return false;
8146 8147

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8148
        return false;
8149
    }
8150 8151 8152

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8153
    return true;
8154 8155 8156
}


8157 8158 8159 8160
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
8161 8162
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
8163 8164
    {NULL, NULL}
};
8165

8166
static const vshCmdOptDef opts_secret_define[] = {
8167
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
8168 8169
    {NULL, 0, 0, NULL}
};
8170

E
Eric Blake 已提交
8171
static bool
8172 8173
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
8174
    const char *from = NULL;
8175
    char *buffer;
8176
    virSecretPtr res;
8177
    char uuid[VIR_UUID_STRING_BUFLEN];
8178

8179
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8180
        return false;
8181

8182
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8183
        return false;
8184 8185

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
8189
    VIR_FREE(buffer);
8190 8191

    if (res == NULL) {
8192
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
8193
        return false;
8194
    }
8195
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
8196
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
8197
        virSecretFree(res);
E
Eric Blake 已提交
8198
        return false;
8199 8200 8201
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
8202
    return true;
8203 8204 8205 8206 8207 8208
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
8209 8210
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
8211 8212 8213 8214
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
8215
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8216 8217 8218
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8219
static bool
8220 8221 8222
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8223
    bool ret = false;
8224 8225
    char *xml;

8226
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8227
        return false;
8228 8229 8230

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8231
        return false;
8232 8233 8234 8235

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
8236
    vshPrint(ctl, "%s", xml);
8237
    VIR_FREE(xml);
E
Eric Blake 已提交
8238
    ret = true;
8239 8240 8241 8242 8243 8244 8245 8246 8247 8248

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
8249 8250
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
8251 8252 8253 8254
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
8255 8256
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
8257 8258 8259
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8260
static bool
8261 8262 8263 8264
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
8265
    const char *base64 = NULL;
8266
    char *value;
E
Eric Blake 已提交
8267 8268
    int res;
    bool ret = false;
8269

8270
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8271
        return false;
8272 8273 8274

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8275
        return false;
8276

8277
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
8278 8279 8280
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
8281
        vshError(ctl, "%s", _("Invalid base64 data"));
8282 8283 8284
        goto cleanup;
    }
    if (value == NULL) {
8285
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
8286
        return false;
8287 8288 8289 8290
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
8291
    VIR_FREE(value);
8292 8293

    if (res != 0) {
8294
        vshError(ctl, "%s", _("Failed to set secret value"));
8295 8296 8297
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
8298
    ret = true;
8299 8300 8301 8302 8303 8304 8305 8306 8307 8308

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
8309 8310
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
8311 8312 8313 8314
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
8315
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8316 8317 8318
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8319
static bool
8320 8321 8322 8323 8324 8325
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
8326
    bool ret = false;
8327

8328
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8329
        return false;
8330 8331 8332

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8333
        return false;
8334 8335 8336 8337 8338 8339 8340

    value = virSecretGetValue(secret, &value_size, 0);
    if (value == NULL)
        goto cleanup;

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
8341
    VIR_FREE(value);
8342 8343

    if (base64 == NULL) {
8344
        vshError(ctl, "%s", _("Failed to allocate memory"));
8345 8346
        goto cleanup;
    }
8347
    vshPrint(ctl, "%s", base64);
8348
    memset(base64, 0, strlen(base64));
8349
    VIR_FREE(base64);
E
Eric Blake 已提交
8350
    ret = true;
8351 8352 8353 8354 8355 8356 8357 8358 8359 8360

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
8361 8362
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
8363 8364 8365 8366
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
8367
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8368 8369 8370
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8371
static bool
8372 8373 8374
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8375
    bool ret = false;
8376
    const char *uuid;
8377

8378
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8379
        return false;
8380 8381 8382

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
8383
        return false;
8384 8385

    if (virSecretUndefine(secret) < 0) {
8386
        vshError(ctl, _("Failed to delete secret %s"), uuid);
8387 8388 8389
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
8390
    ret = true;
8391 8392 8393 8394 8395 8396 8397 8398 8399 8400

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
8401 8402
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
8403 8404 8405
    {NULL, NULL}
};

E
Eric Blake 已提交
8406
static bool
8407 8408 8409 8410 8411
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

8412
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8413
        return false;
8414 8415 8416

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
8417
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
8418
        return false;
8419 8420 8421 8422 8423
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
8424
        vshError(ctl, "%s", _("Failed to list secrets"));
8425
        VIR_FREE(uuids);
E
Eric Blake 已提交
8426
        return false;
8427 8428 8429 8430
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

8431 8432
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
8433 8434

    for (i = 0; i < maxuuids; i++) {
8435 8436 8437 8438
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
8439
            VIR_FREE(uuids[i]);
8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457
            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);
8458
        VIR_FREE(uuids[i]);
8459
    }
8460
    VIR_FREE(uuids);
E
Eric Blake 已提交
8461
    return true;
8462
}
8463 8464 8465 8466 8467


/*
 * "version" command
 */
8468
static const vshCmdInfo info_version[] = {
8469 8470
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
8471 8472 8473 8474
    {NULL, NULL}
};


E
Eric Blake 已提交
8475
static bool
8476
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487
{
    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;

8488
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8489
        return false;
8490 8491 8492

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
8493
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
8494
        return false;
8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506
    }

    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) {
8507
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
8508
        return false;
8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525
    }
    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) {
8526
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
8527
        return false;
8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540
    }
    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 已提交
8541
    return true;
8542 8543
}

8544 8545 8546 8547
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
8548
    {"help", N_("enumerate devices on this host")},
8549
    {"desc", ""},
8550 8551 8552 8553
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
8554 8555
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
8556 8557 8558
    {NULL, 0, 0, NULL}
};

8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580
#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] = '-';
8581 8582
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
8583 8584 8585
    }

    /* Print this device */
8586
    vshPrint(ctl, "%s", indentBuf);
8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609
    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) {
8610
        vshPrint(ctl, "%s", indentBuf);
8611
        vshPrint(ctl, " |\n");
8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633
    }

    /* 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) {
8634
        vshPrint(ctl, "%s", indentBuf);
8635 8636 8637 8638
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
8639
static bool
8640 8641
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
8642
    const char *cap = NULL;
8643
    char **devices;
8644
    int num_devices, i;
8645
    int tree = vshCommandOptBool(cmd, "tree");
8646

8647
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8648
        return false;
8649

8650
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
8651 8652 8653 8654
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
8655
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
8656
        return false;
8657
    } else if (num_devices == 0) {
E
Eric Blake 已提交
8658
        return true;
8659 8660 8661 8662 8663 8664
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
8665
        vshError(ctl, "%s", _("Failed to list node devices"));
8666
        VIR_FREE(devices);
E
Eric Blake 已提交
8667
        return false;
8668
    }
8669
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
8670 8671 8672 8673 8674 8675 8676
    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 已提交
8677
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696
            } 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++) {
8697 8698
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
8699
        }
8700
        VIR_FREE(parents);
8701 8702 8703
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
8704
            VIR_FREE(devices[i]);
8705
        }
8706
    }
8707
    VIR_FREE(devices);
E
Eric Blake 已提交
8708
    return true;
8709 8710 8711 8712 8713 8714
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
8715 8716
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
8717 8718 8719 8720 8721
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
8722
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8723 8724 8725
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8726
static bool
8727 8728
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
8729
    const char *name = NULL;
8730
    virNodeDevicePtr device;
L
Laine Stump 已提交
8731
    char *xml;
8732

8733
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8734
        return false;
8735
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8736
        return false;
8737
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8738
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8739
        return false;
8740 8741
    }

L
Laine Stump 已提交
8742 8743 8744
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
8745
        return false;
L
Laine Stump 已提交
8746 8747 8748
    }

    vshPrint(ctl, "%s\n", xml);
8749
    VIR_FREE(xml);
8750
    virNodeDeviceFree(device);
E
Eric Blake 已提交
8751
    return true;
8752 8753
}

8754 8755 8756 8757
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
8758 8759
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
8760 8761 8762 8763 8764
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
8765
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8766 8767 8768
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8769
static bool
8770 8771
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
8772
    const char *name = NULL;
8773
    virNodeDevicePtr device;
E
Eric Blake 已提交
8774
    bool ret = true;
8775

8776
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8777
        return false;
8778
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8779
        return false;
8780
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8781
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8782
        return false;
8783 8784 8785 8786 8787
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
8788
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
8789
        ret = false;
8790 8791 8792 8793 8794 8795 8796 8797 8798
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
8799 8800
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
8801 8802 8803 8804 8805
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
8806
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8807 8808 8809
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8810
static bool
8811 8812
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
8813
    const char *name = NULL;
8814
    virNodeDevicePtr device;
E
Eric Blake 已提交
8815
    bool ret = true;
8816

8817
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8818
        return false;
8819
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8820
        return false;
8821
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8822
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8823
        return false;
8824 8825 8826 8827 8828
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
8829
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
8830
        ret = false;
8831 8832 8833 8834 8835 8836 8837 8838 8839
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
8840 8841
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
8842 8843 8844 8845 8846
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
8847
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
8848 8849 8850
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8851
static bool
8852 8853
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
8854
    const char *name = NULL;
8855
    virNodeDevicePtr device;
E
Eric Blake 已提交
8856
    bool ret = true;
8857

8858
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8859
        return false;
8860
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
8861
        return false;
8862
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
8863
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
8864
        return false;
8865 8866 8867 8868 8869
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
8870
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
8871
        ret = false;
8872 8873 8874 8875 8876
    }
    virNodeDeviceFree(device);
    return ret;
}

8877
/*
E
Eric Blake 已提交
8878
 * "hostname" command
8879
 */
8880
static const vshCmdInfo info_hostname[] = {
8881
    {"help", N_("print the hypervisor hostname")},
8882
    {"desc", ""},
8883 8884 8885
    {NULL, NULL}
};

E
Eric Blake 已提交
8886
static bool
8887
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8888 8889 8890
{
    char *hostname;

8891
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8892
        return false;
8893 8894 8895

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
8896
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
8897
        return false;
8898 8899 8900
    }

    vshPrint (ctl, "%s\n", hostname);
8901
    VIR_FREE(hostname);
8902

E
Eric Blake 已提交
8903
    return true;
8904 8905 8906 8907 8908
}

/*
 * "uri" command
 */
8909
static const vshCmdInfo info_uri[] = {
8910
    {"help", N_("print the hypervisor canonical URI")},
8911
    {"desc", ""},
8912 8913 8914
    {NULL, NULL}
};

E
Eric Blake 已提交
8915
static bool
8916
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8917 8918 8919
{
    char *uri;

8920
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8921
        return false;
8922 8923 8924

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
8925
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
8926
        return false;
8927 8928 8929
    }

    vshPrint (ctl, "%s\n", uri);
8930
    VIR_FREE(uri);
8931

E
Eric Blake 已提交
8932
    return true;
8933 8934
}

E
Eric Blake 已提交
8935 8936 8937 8938 8939 8940 8941 8942 8943 8944
/*
 * "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 已提交
8945
static bool
E
Eric Blake 已提交
8946 8947 8948 8949 8950
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8951
        return false;
E
Eric Blake 已提交
8952 8953 8954 8955

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
8956
        return false;
E
Eric Blake 已提交
8957 8958 8959 8960 8961
    }

    vshPrint (ctl, "%s", sysinfo);
    VIR_FREE(sysinfo);

E
Eric Blake 已提交
8962
    return true;
E
Eric Blake 已提交
8963 8964
}

8965 8966 8967
/*
 * "vncdisplay" command
 */
8968
static const vshCmdInfo info_vncdisplay[] = {
8969 8970
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
8971 8972 8973
    {NULL, NULL}
};

8974
static const vshCmdOptDef opts_vncdisplay[] = {
8975
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
8976 8977 8978
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8979
static bool
8980
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
8981 8982 8983 8984 8985
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
8986
    bool ret = false;
8987 8988 8989
    int port = 0;
    char *doc;

8990
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8991
        return false;
8992

J
Jim Meyering 已提交
8993
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
8994
        return false;
8995 8996 8997 8998 8999 9000 9001 9002

    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);
9003
    VIR_FREE(doc);
9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021
    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) ||
9022
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
9023 9024 9025 9026 9027 9028
        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 已提交
9029
    ret = true;
9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
9043
static const vshCmdInfo info_ttyconsole[] = {
9044 9045
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
9046 9047 9048
    {NULL, NULL}
};

9049
static const vshCmdOptDef opts_ttyconsole[] = {
9050
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9051 9052 9053
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9054
static bool
9055
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
9056 9057 9058 9059 9060
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9061
    bool ret = false;
9062 9063
    char *doc;

9064
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9065
        return false;
9066

J
Jim Meyering 已提交
9067
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9068
        return false;
9069 9070 9071 9072 9073 9074 9075 9076

    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);
9077
    VIR_FREE(doc);
9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089
    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 已提交
9090
    ret = true;
9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
9103
 */
9104
static const vshCmdInfo info_attach_device[] = {
9105 9106
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
9107 9108 9109
    {NULL, NULL}
};

9110
static const vshCmdOptDef opts_attach_device[] = {
9111 9112 9113
    {"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")},
9114 9115 9116
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9117
static bool
9118
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
9119 9120
{
    virDomainPtr dom;
9121
    const char *from = NULL;
9122
    char *buffer;
W
Wen Congyang 已提交
9123
    int ret;
J
Jim Fehlig 已提交
9124
    unsigned int flags;
9125

9126
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9127
        return false;
9128

J
Jim Meyering 已提交
9129
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9130
        return false;
9131

9132
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9133
        virDomainFree(dom);
E
Eric Blake 已提交
9134
        return false;
9135 9136
    }

9137
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9138
        virshReportError(ctl);
9139
        virDomainFree(dom);
E
Eric Blake 已提交
9140
        return false;
9141
    }
9142

J
Jim Fehlig 已提交
9143 9144 9145 9146 9147 9148 9149 9150
    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);
    }
9151
    VIR_FREE(buffer);
9152 9153

    if (ret < 0) {
9154
        vshError(ctl, _("Failed to attach device from %s"), from);
9155
        virDomainFree(dom);
E
Eric Blake 已提交
9156
        return false;
9157
    } else {
J
Jim Meyering 已提交
9158
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
9159 9160 9161
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9162
    return true;
9163 9164 9165 9166 9167 9168
}


/*
 * "detach-device" command
 */
9169
static const vshCmdInfo info_detach_device[] = {
9170 9171
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
9172 9173 9174
    {NULL, NULL}
};

9175
static const vshCmdOptDef opts_detach_device[] = {
9176 9177 9178
    {"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")},
9179 9180 9181
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9182
static bool
9183
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
9184 9185
{
    virDomainPtr dom;
9186
    const char *from = NULL;
9187
    char *buffer;
W
Wen Congyang 已提交
9188
    int ret;
J
Jim Fehlig 已提交
9189
    unsigned int flags;
9190

9191
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9192
        return false;
9193

J
Jim Meyering 已提交
9194
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9195
        return false;
9196

9197
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9198
        virDomainFree(dom);
E
Eric Blake 已提交
9199
        return false;
9200 9201
    }

9202
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9203
        virshReportError(ctl);
9204
        virDomainFree(dom);
E
Eric Blake 已提交
9205
        return false;
9206
    }
9207

J
Jim Fehlig 已提交
9208 9209 9210 9211 9212 9213 9214 9215
    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);
    }
9216
    VIR_FREE(buffer);
9217 9218

    if (ret < 0) {
9219
        vshError(ctl, _("Failed to detach device from %s"), from);
9220
        virDomainFree(dom);
E
Eric Blake 已提交
9221
        return false;
9222
    } else {
J
Jim Meyering 已提交
9223
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
9224 9225 9226
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9227
    return true;
9228 9229
}

9230

9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243
/*
 * "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")},
9244
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
9245 9246 9247
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9248
static bool
9249 9250 9251
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
9252
    const char *from = NULL;
9253
    char *buffer;
W
Wen Congyang 已提交
9254
    int ret;
9255 9256
    unsigned int flags;

9257
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9258
        return false;
9259 9260

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

9263
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9264
        virDomainFree(dom);
E
Eric Blake 已提交
9265
        return false;
9266 9267 9268
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9269
        virshReportError(ctl);
9270
        virDomainFree(dom);
E
Eric Blake 已提交
9271
        return false;
9272 9273 9274 9275 9276 9277 9278 9279 9280
    }

    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;
    }
9281 9282 9283 9284

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

9285 9286 9287 9288 9289 9290
    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 已提交
9291
        return false;
9292 9293 9294 9295 9296
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9297
    return true;
9298 9299 9300
}


9301 9302 9303
/*
 * "attach-interface" command
 */
9304
static const vshCmdInfo info_attach_interface[] = {
9305 9306
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
9307 9308 9309
    {NULL, NULL}
};

9310
static const vshCmdOptDef opts_attach_interface[] = {
9311 9312 9313 9314 9315 9316
    {"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")},
9317
    {"model", VSH_OT_DATA, 0, N_("model type")},
9318
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
9319 9320 9321
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9322
static bool
9323
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
9324 9325
{
    virDomainPtr dom = NULL;
9326 9327
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
9328
    int typ;
W
Wen Congyang 已提交
9329 9330
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9331
    unsigned int flags;
9332 9333
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9334

9335
    if (!vshConnectionUsability(ctl, ctl->conn))
9336 9337
        goto cleanup;

J
Jim Meyering 已提交
9338
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9339 9340
        goto cleanup;

9341
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9342 9343
        goto cleanup;

9344 9345 9346 9347
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
9348 9349
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
9350
        goto cleanup;
9351
    }
9352 9353

    /* check interface type */
9354
    if (STREQ(type, "network")) {
9355
        typ = 1;
9356
    } else if (STREQ(type, "bridge")) {
9357 9358
        typ = 2;
    } else {
E
Eric Blake 已提交
9359 9360
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
9361 9362 9363 9364
        goto cleanup;
    }

    /* Make XML of interface */
9365
    virBufferAsprintf(&buf, "<interface type='%s'>\n", type);
9366

9367
    if (typ == 1)
9368
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
9369
    else if (typ == 2)
9370
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
9371

9372
    if (target != NULL)
9373
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9374
    if (mac != NULL)
9375
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
9376
    if (script != NULL)
9377
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
9378
    if (model != NULL)
9379
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
9380

9381
    virBufferAddLit(&buf, "</interface>\n");
9382

9383 9384
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
9385
        goto cleanup;
9386 9387
    }

9388
    xml = virBufferContentAndReset(&buf);
9389

J
Jim Fehlig 已提交
9390 9391 9392 9393
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9394
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
9395
    } else {
9396
        ret = virDomainAttachDevice(dom, xml);
9397
    }
9398

9399 9400
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9401
    if (ret != 0) {
L
Laine Stump 已提交
9402
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
9403 9404
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
9405
        functionReturn = true;
J
Jim Fehlig 已提交
9406
    }
9407 9408 9409 9410

 cleanup:
    if (dom)
        virDomainFree(dom);
9411
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
9412
    return functionReturn;
9413 9414 9415 9416 9417
}

/*
 * "detach-interface" command
 */
9418
static const vshCmdInfo info_detach_interface[] = {
9419 9420
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
9421 9422 9423
    {NULL, NULL}
};

9424
static const vshCmdOptDef opts_detach_interface[] = {
9425 9426 9427 9428
    {"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")},
9429 9430 9431
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9432
static bool
9433
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
9434 9435 9436 9437 9438 9439 9440
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
9441
    const char *mac =NULL, *type = NULL;
9442
    char *doc;
9443
    char buf[64];
E
Eric Blake 已提交
9444
    int i = 0, diff_mac;
W
Wen Congyang 已提交
9445 9446
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
9447
    unsigned int flags;
9448

9449
    if (!vshConnectionUsability(ctl, ctl->conn))
9450 9451
        goto cleanup;

J
Jim Meyering 已提交
9452
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9453 9454
        goto cleanup;

9455
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9456 9457
        goto cleanup;

9458 9459
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
9460
        goto cleanup;
9461
    }
9462 9463 9464 9465 9466 9467 9468 9469

    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);
9470
    VIR_FREE(doc);
9471
    if (!xml) {
9472
        vshError(ctl, "%s", _("Failed to get interface information"));
9473 9474 9475 9476
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9477
        vshError(ctl, "%s", _("Failed to get interface information"));
9478 9479 9480
        goto cleanup;
    }

E
Eric Blake 已提交
9481
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
9482 9483 9484
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9485
        vshError(ctl, _("No found interface whose type is %s"), type);
9486 9487 9488
        goto cleanup;
    }

9489 9490 9491 9492 9493 9494
    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;
    }

9495 9496 9497 9498 9499 9500 9501
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9502 9503 9504 9505 9506
            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);
9507 9508 9509 9510 9511 9512 9513
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9514
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
9515 9516 9517 9518 9519
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9520
        vshError(ctl, "%s", _("Failed to allocate memory"));
9521 9522 9523
        goto cleanup;
    }

9524
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
9525
        vshError(ctl, "%s", _("Failed to create XML"));
9526 9527 9528
        goto cleanup;
    }

J
Jim Fehlig 已提交
9529 9530 9531 9532 9533 9534 9535 9536 9537 9538 9539 9540
    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 已提交
9541
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
9542
    } else {
J
Jim Meyering 已提交
9543
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
9544
        functionReturn = true;
9545
    }
9546 9547 9548 9549

 cleanup:
    if (dom)
        virDomainFree(dom);
9550
    xmlXPathFreeObject(obj);
9551
    xmlXPathFreeContext(ctxt);
9552 9553 9554 9555
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
9556
    return functionReturn;
9557 9558 9559 9560 9561
}

/*
 * "attach-disk" command
 */
9562
static const vshCmdInfo info_attach_disk[] = {
9563 9564
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
9565 9566 9567
    {NULL, NULL}
};

9568
static const vshCmdOptDef opts_attach_disk[] = {
9569 9570 9571 9572 9573 9574 9575 9576
    {"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")},
9577
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
9578 9579 9580
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9581
static bool
9582
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
9583 9584
{
    virDomainPtr dom = NULL;
9585 9586
    const char *source = NULL, *target = NULL, *driver = NULL,
                *subdriver = NULL, *type = NULL, *mode = NULL;
W
Wen Congyang 已提交
9587 9588
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
9589
    unsigned int flags;
9590
    const char *stype = NULL;
9591 9592
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9593

9594
    if (!vshConnectionUsability(ctl, ctl->conn))
9595 9596
        goto cleanup;

J
Jim Meyering 已提交
9597
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9598 9599
        goto cleanup;

9600
    if (vshCommandOptString(cmd, "source", &source) <= 0)
9601 9602
        goto cleanup;

9603
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9604 9605
        goto cleanup;

9606 9607 9608 9609 9610
    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) {
9611
        vshError(ctl, "%s", _("missing option"));
9612 9613
        goto cleanup;
    }
9614

9615 9616
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
9617
            isFile = true;
9618
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
9619
        isFile = true;
9620 9621 9622
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
9623 9624 9625
    }

    if (mode) {
9626
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
9627 9628
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
9629 9630 9631 9632 9633
            goto cleanup;
        }
    }

    /* Make XML of disk */
9634
    virBufferAsprintf(&buf, "<disk type='%s'",
9635 9636
                      (isFile) ? "file" : "block");
    if (type)
9637
        virBufferAsprintf(&buf, " device='%s'", type);
9638 9639
    virBufferAddLit(&buf, ">\n");

9640
    if (driver || subdriver)
9641
        virBufferAsprintf(&buf, "  <driver");
9642 9643

    if (driver)
9644
        virBufferAsprintf(&buf, " name='%s'", driver);
9645
    if (subdriver)
9646
        virBufferAsprintf(&buf, " type='%s'", subdriver);
9647 9648 9649

    if (driver || subdriver)
        virBufferAddLit(&buf, "/>\n");
9650

9651
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
9652 9653
                      (isFile) ? "file" : "dev",
                      source);
9654
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9655
    if (mode)
9656
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
9657 9658

    virBufferAddLit(&buf, "</disk>\n");
9659

9660 9661
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
9662
        return false;
9663 9664
    }

9665
    xml = virBufferContentAndReset(&buf);
9666

J
Jim Fehlig 已提交
9667 9668 9669 9670
    if (vshCommandOptBool(cmd, "persistent")) {
        flags = VIR_DOMAIN_DEVICE_MODIFY_CONFIG;
        if (virDomainIsActive(dom) == 1)
            flags |= VIR_DOMAIN_DEVICE_MODIFY_LIVE;
9671
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
9672
    } else {
9673
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
9674
    }
9675

9676 9677
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9678
    if (ret != 0) {
L
Laine Stump 已提交
9679
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
9680 9681
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
9682
        functionReturn = true;
J
Jim Fehlig 已提交
9683
    }
9684 9685 9686 9687

 cleanup:
    if (dom)
        virDomainFree(dom);
9688
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
9689
    return functionReturn;
9690 9691 9692 9693 9694
}

/*
 * "detach-disk" command
 */
9695
static const vshCmdInfo info_detach_disk[] = {
9696 9697
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
9698 9699 9700
    {NULL, NULL}
};

9701
static const vshCmdOptDef opts_detach_disk[] = {
9702 9703 9704
    {"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")},
9705 9706 9707
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9708
static bool
9709
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
9710 9711 9712 9713 9714 9715 9716
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
9717
    const char *target = NULL;
9718
    char *doc;
E
Eric Blake 已提交
9719
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
9720 9721
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9722
    unsigned int flags;
9723

9724
    if (!vshConnectionUsability(ctl, ctl->conn))
9725 9726
        goto cleanup;

J
Jim Meyering 已提交
9727
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9728 9729
        goto cleanup;

9730
    if (vshCommandOptString(cmd, "target", &target) <= 0)
9731 9732 9733 9734 9735 9736 9737 9738 9739
        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);
9740
    VIR_FREE(doc);
9741
    if (!xml) {
9742
        vshError(ctl, "%s", _("Failed to get disk information"));
9743 9744 9745 9746
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
9747
        vshError(ctl, "%s", _("Failed to get disk information"));
9748 9749 9750 9751 9752 9753
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
9754
        vshError(ctl, "%s", _("Failed to get disk information"));
9755 9756 9757 9758 9759 9760 9761
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
9762 9763 9764 9765 9766
            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);
9767 9768 9769 9770 9771 9772 9773
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
9774
    vshError(ctl, _("No found disk whose target is %s"), target);
9775 9776 9777 9778 9779
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
9780
        vshError(ctl, "%s", _("Failed to allocate memory"));
9781 9782 9783
        goto cleanup;
    }

9784
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
9785
        vshError(ctl, "%s", _("Failed to create XML"));
9786 9787 9788
        goto cleanup;
    }

J
Jim Fehlig 已提交
9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800
    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 已提交
9801
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
9802
    } else {
J
Jim Meyering 已提交
9803
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
9804
        functionReturn = true;
9805
    }
9806 9807

 cleanup:
9808
    xmlXPathFreeObject(obj);
9809
    xmlXPathFreeContext(ctxt);
9810 9811 9812 9813 9814 9815
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
9816
    return functionReturn;
9817 9818
}

9819 9820 9821 9822
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
9823 9824
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
9825 9826 9827 9828
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
9829
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
9830 9831 9832
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9833
static bool
9834 9835
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
9836
    const char *from = NULL;
E
Eric Blake 已提交
9837
    bool ret = true;
9838 9839 9840
    char *buffer;
    int result;

9841
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9842
        return false;
9843

9844
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9845
        return false;
9846 9847

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
9851
    VIR_FREE(buffer);
9852 9853 9854 9855 9856

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
9857
        ret = false;
9858 9859 9860 9861 9862
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
9863
        ret = true;
9864 9865 9866 9867 9868
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
9869
        ret = true;
9870 9871 9872 9873 9874
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
9875
        ret = false;
9876 9877 9878 9879 9880
    }

    return ret;
}

9881 9882 9883 9884
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
9885 9886
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
9887 9888 9889 9890
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
9891
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
9892 9893 9894
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9895
static bool
9896 9897
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
9898
    const char *from = NULL;
E
Eric Blake 已提交
9899
    bool ret = true;
9900 9901 9902 9903 9904
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
9905
    xmlNodePtr node_list;
9906 9907 9908 9909 9910 9911
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

9912
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9913
        return false;
9914

9915
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9916
        return false;
9917 9918

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
9919
        return false;
9920 9921 9922 9923 9924

    doc = xmlNewDoc(NULL);
    if (doc == NULL)
        goto no_memory;

L
Laine Stump 已提交
9925 9926
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
9927 9928
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
9929
        ret = false;
9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965
        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 已提交
9966
        ret = false;
9967 9968 9969 9970 9971 9972 9973 9974
        goto cleanup;
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
9975
        ret = false;
9976 9977 9978 9979 9980 9981 9982 9983 9984 9985 9986 9987 9988 9989 9990 9991 9992

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 已提交
9993
    ret = false;
9994
    goto cleanup;
9995 9996
}

9997 9998 9999 10000 10001 10002 10003 10004
/* 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;

10005
    ret = vshMalloc(ctl, PATH_MAX);
10006 10007 10008

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
10009 10010
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
10011
    if (fd == -1) {
10012
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
10013
                 strerror(errno));
10014
        VIR_FREE(ret);
10015 10016 10017 10018
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
10019 10020
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
10021
        VIR_FORCE_CLOSE(fd);
10022
        unlink (ret);
10023
        VIR_FREE(ret);
10024 10025
        return NULL;
    }
S
Stefan Berger 已提交
10026
    if (VIR_CLOSE(fd) < 0) {
10027 10028
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
10029
        unlink (ret);
10030
        VIR_FREE(ret);
10031 10032 10033 10034 10035 10036 10037 10038 10039 10040 10041 10042 10043 10044 10045
        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 已提交
10046 10047 10048 10049
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
10050

10051
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
10052 10053 10054 10055
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
10056

10057 10058 10059 10060 10061
    /* 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 已提交
10062 10063
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
10064
     */
E
Eric Blake 已提交
10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076
    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);
10077 10078
    }

E
Eric Blake 已提交
10079 10080 10081 10082 10083 10084 10085
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
10086
    }
E
Eric Blake 已提交
10087
    ret = 0;
10088

E
Eric Blake 已提交
10089 10090 10091
cleanup:
    virCommandFree(cmd);
    return ret;
10092 10093 10094 10095 10096 10097 10098 10099
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
10100
        vshError(ctl,
10101
                 _("%s: failed to read temporary file: %s"),
10102
                 filename, strerror(errno));
10103 10104 10105 10106 10107
        return NULL;
    }
    return ret;
}

10108

P
Paolo Bonzini 已提交
10109 10110 10111 10112
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
10113 10114
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
10115 10116 10117 10118
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
10119
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
10120 10121 10122
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10123
static bool
10124
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
10125
{
10126
    const char *dir = NULL;
10127
    char *dir_malloced = NULL;
E
Eric Blake 已提交
10128
    bool ret = true;
P
Paolo Bonzini 已提交
10129 10130

    if (!ctl->imode) {
10131
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
10132
        return false;
P
Paolo Bonzini 已提交
10133 10134
    }

10135
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
10136
        uid_t uid = geteuid();
10137
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
10138 10139 10140 10141
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
10142
    if (chdir(dir) == -1) {
10143
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
10144
        ret = false;
P
Paolo Bonzini 已提交
10145 10146
    }

10147
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
10148
    return ret;
P
Paolo Bonzini 已提交
10149 10150 10151 10152 10153 10154
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
10155 10156
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
10157 10158 10159
    {NULL, NULL}
};

E
Eric Blake 已提交
10160
static bool
P
Paolo Bonzini 已提交
10161 10162 10163
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
10164
    bool ret = true;
P
Paolo Bonzini 已提交
10165

10166 10167
    cwd = getcwd(NULL, 0);
    if (!cwd) {
10168 10169
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
10170 10171
        ret = false;
    } else {
P
Paolo Bonzini 已提交
10172
        vshPrint (ctl, _("%s\n"), cwd);
10173 10174
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
10175

10176
    return ret;
P
Paolo Bonzini 已提交
10177 10178
}

E
Eric Blake 已提交
10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197
/*
 * "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 已提交
10198
static bool
E
Eric Blake 已提交
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 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238 10239 10240 10241 10242 10243
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 已提交
10244
        return false;
E
Eric Blake 已提交
10245 10246 10247 10248 10249
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
10250
    return true;
E
Eric Blake 已提交
10251 10252
}

10253 10254 10255 10256
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
10257 10258
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
10259 10260 10261 10262
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
10263
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10264 10265 10266 10267 10268 10269
    {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 已提交
10270
static bool
10271 10272
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
10273
    bool ret = false;
10274 10275 10276 10277 10278
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
10279
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
10280

10281
    if (!vshConnectionUsability(ctl, ctl->conn))
10282 10283
        goto cleanup;

J
Jim Meyering 已提交
10284
    dom = vshCommandOptDomain (ctl, cmd, NULL);
10285 10286 10287 10288
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
10289
    doc = virDomainGetXMLDesc (dom, flags);
10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307
    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 已提交
10308
        ret = true;
10309 10310 10311 10312 10313 10314 10315
        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.
     */
10316
    doc_reread = virDomainGetXMLDesc (dom, flags);
10317 10318 10319 10320
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
10321 10322
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334
        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 已提交
10335
    ret = true;
10336 10337 10338 10339 10340

 cleanup:
    if (dom)
        virDomainFree (dom);

10341 10342 10343
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
10344 10345 10346

    if (tmp) {
        unlink (tmp);
10347
        VIR_FREE(tmp);
10348 10349 10350 10351 10352
    }

    return ret;
}

10353

10354 10355 10356 10357
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
10358 10359
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
10360 10361 10362 10363
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
10364
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
10365 10366 10367 10368 10369 10370 10371 10372 10373 10374
    {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[] = {
10375 10376
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
10377 10378 10379 10380
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
10381
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10382 10383 10384 10385 10386 10387
    {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 已提交
10388 10389 10390
/*
 * "quit" command
 */
10391
static const vshCmdInfo info_quit[] = {
10392
    {"help", N_("quit this interactive terminal")},
10393
    {"desc", ""},
10394
    {NULL, NULL}
K
Karel Zak 已提交
10395 10396
};

E
Eric Blake 已提交
10397
static bool
10398
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10399
{
E
Eric Blake 已提交
10400 10401
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
10402 10403
}

10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418
/*
 * "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 已提交
10419
static bool
10420 10421 10422
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10423
    bool ret = false;
10424
    const char *from = NULL;
10425 10426 10427 10428 10429 10430 10431
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

10432
    if (!vshConnectionUsability(ctl, ctl->conn))
10433 10434 10435 10436 10437 10438
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10439
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
10440
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
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 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484
    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 已提交
10485
    ret = true;
10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515

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 已提交
10516
static bool
10517 10518 10519
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10520
    bool ret = false;
10521 10522 10523
    int current;
    virDomainSnapshotPtr snapshot = NULL;

10524
    if (!vshConnectionUsability(ctl, ctl->conn))
10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547
        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 已提交
10548
    ret = true;
10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572

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 已提交
10573
static bool
10574 10575 10576
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10577
    bool ret = false;
10578 10579
    int numsnaps;
    char **names = NULL;
10580
    int actual = 0;
10581 10582 10583 10584 10585 10586
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
10587 10588
    long long creation_longlong;
    time_t creation_time_t;
10589 10590 10591
    char timestr[100];
    struct tm time_info;

10592
    if (!vshConnectionUsability(ctl, ctl->conn))
10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

10604 10605
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
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 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646

    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;
10647 10648
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
10649
                continue;
10650 10651 10652 10653 10654 10655
            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);
10656
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
10657 10658 10659 10660 10661

            vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
        }
    }

E
Eric Blake 已提交
10662
    ret = true;
10663 10664 10665 10666 10667 10668 10669 10670 10671 10672

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);
10673 10674
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696
    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 已提交
10697
static bool
10698 10699 10700
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10701
    bool ret = false;
10702
    const char *name = NULL;
10703 10704 10705
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

10706
    if (!vshConnectionUsability(ctl, ctl->conn))
10707 10708 10709 10710 10711 10712
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10713
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10714 10715 10716 10717 10718 10719 10720 10721 10722 10723
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

10724
    vshPrint(ctl, "%s", xml);
10725

E
Eric Blake 已提交
10726
    ret = true;
10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
10739
 * "snapshot-revert" command
10740
 */
10741
static const vshCmdInfo info_snapshot_revert[] = {
10742 10743 10744 10745 10746
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

10747
static const vshCmdOptDef opts_snapshot_revert[] = {
10748 10749 10750 10751 10752
    {"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 已提交
10753
static bool
10754
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
10755 10756
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10757
    bool ret = false;
10758
    const char *name = NULL;
10759 10760
    virDomainSnapshotPtr snapshot = NULL;

10761
    if (!vshConnectionUsability(ctl, ctl->conn))
10762 10763 10764 10765 10766 10767
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10768
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10769 10770 10771 10772 10773 10774 10775 10776 10777
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    if (virDomainRevertToSnapshot(snapshot, 0) < 0)
        goto cleanup;

E
Eric Blake 已提交
10778
    ret = true;
10779 10780 10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804

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 已提交
10805
static bool
10806 10807 10808
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10809
    bool ret = false;
10810
    const char *name = NULL;
10811 10812 10813
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

10814
    if (!vshConnectionUsability(ctl, ctl->conn))
10815 10816 10817 10818 10819 10820
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10821
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833
        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 已提交
10834
    ret = true;
10835 10836 10837 10838 10839 10840 10841 10842 10843 10844

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856
/*
 * "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")},
10857
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
10858 10859 10860
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10861
static bool
10862 10863 10864
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
10865
    bool ret = false;
10866
    const char *monitor_cmd = NULL;
10867
    char *result = NULL;
10868
    unsigned int flags = 0;
10869 10870 10871 10872 10873 10874 10875 10876

    if (!vshConnectionUsability(ctl, ctl->conn))
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

10877
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
10878 10879 10880 10881
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

10882 10883 10884 10885
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
10886 10887 10888 10889
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
10890
    ret = true;
10891 10892 10893 10894 10895 10896 10897 10898 10899

cleanup:
    VIR_FREE(result);
    if (dom)
        virDomainFree(dom);

    return ret;
}

10900
static const vshCmdDef domManagementCmds[] = {
10901 10902 10903 10904 10905 10906 10907 10908
    {"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},
10909
#ifndef WIN32
10910
    {"console", cmdConsole, opts_console, info_console, 0},
10911
#endif
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 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963
    {"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}
10964 10965 10966
};

static const vshCmdDef domMonitoringCmds[] = {
10967 10968 10969 10970 10971 10972 10973 10974
    {"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}
10975 10976 10977
};

static const vshCmdDef storagePoolCmds[] = {
10978
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
10979
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
10980
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 10999 11000 11001
     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}
11002 11003 11004
};

static const vshCmdDef storageVolCmds[] = {
11005 11006 11007 11008 11009 11010 11011 11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022
    {"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}
11023
};
11024

11025
static const vshCmdDef networkCmds[] = {
11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044
    {"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}
11045
};
11046

11047
static const vshCmdDef nodedevCmds[] = {
11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062
    {"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}
11063 11064 11065
};

static const vshCmdDef ifaceCmds[] = {
11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083
    {"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},
11084 11085 11086 11087 11088 11089
    {"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},
11090
    {NULL, NULL, NULL, NULL, 0}
11091
};
11092

11093
static const vshCmdDef nwfilterCmds[] = {
11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104
    {"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}
11105
};
11106

11107
static const vshCmdDef secretCmds[] = {
11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119
    {"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}
11120
};
11121

11122
static const vshCmdDef virshCmds[] = {
11123 11124 11125 11126 11127 11128 11129
    {"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}
11130
};
11131

11132
static const vshCmdDef snapshotCmds[] = {
11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145
    {"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}
11146
};
11147

11148
static const vshCmdDef hostAndHypervisorCmds[] = {
11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159
    {"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 已提交
11160 11161
};

11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178
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 已提交
11179 11180 11181 11182
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
11183
static const char *
11184
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
11185
{
11186
    const vshCmdInfo *info;
11187

K
Karel Zak 已提交
11188
    for (info = cmd->info; info && info->name; info++) {
11189
        if (STREQ(info->name, name))
K
Karel Zak 已提交
11190 11191 11192 11193 11194
            return info->data;
    }
    return NULL;
}

11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226
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;
}

11227
static const vshCmdOptDef *
11228 11229
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
11230
{
11231 11232 11233 11234
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
11235

11236 11237 11238 11239 11240 11241
        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 已提交
11242
            return opt;
11243 11244 11245 11246 11247
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
11248 11249 11250
    return NULL;
}

11251
static const vshCmdOptDef *
11252 11253
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
11254
{
11255
    int i;
11256
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
11257

11258 11259 11260 11261 11262 11263 11264 11265 11266 11267
    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 已提交
11268 11269
}

11270 11271 11272
/*
 * Checks for required options
 */
11273
static int
11274 11275
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
11276
{
11277
    const vshCmdDef *def = cmd->def;
11278 11279 11280 11281 11282 11283 11284 11285 11286
    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];
11287

11288 11289 11290 11291 11292
            vshError(ctl,
                     opt->type == VSH_OT_DATA ?
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
11293 11294
        }
    }
11295
    return -1;
11296 11297
}

11298
static const vshCmdDef *
11299 11300
vshCmddefSearch(const char *cmdname)
{
11301
    const vshCmdGrp *g;
11302
    const vshCmdDef *c;
11303

11304 11305
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
11306
            if (STREQ(c->name, cmdname))
11307 11308 11309 11310
                return c;
        }
    }

K
Karel Zak 已提交
11311 11312 11313
    return NULL;
}

11314 11315 11316 11317 11318 11319
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
11320
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
11321 11322 11323 11324 11325 11326
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
11327
static bool
11328 11329 11330 11331 11332 11333 11334
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 已提交
11335
        return false;
11336 11337 11338 11339 11340 11341 11342 11343 11344 11345
    } 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 已提交
11346
    return true;
11347 11348
}

E
Eric Blake 已提交
11349
static bool
11350
vshCmddefHelp(vshControl *ctl, const char *cmdname)
11351
{
11352
    const vshCmdDef *def = vshCmddefSearch(cmdname);
11353

K
Karel Zak 已提交
11354
    if (!def) {
11355
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
11356
        return false;
11357
    } else {
E
Eric Blake 已提交
11358 11359
        const char *desc = _(vshCmddefGetInfo(def, "desc"));
        const char *help = _(vshCmddefGetInfo(def, "help"));
11360
        char buf[256];
11361 11362 11363 11364 11365 11366
        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 已提交
11367
            return false;
11368
        }
K
Karel Zak 已提交
11369

11370
        fputs(_("  NAME\n"), stdout);
11371 11372
        fprintf(stdout, "    %s - %s\n", def->name, help);

11373 11374 11375 11376 11377
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
11378
                const char *fmt = "%s";
11379 11380
                switch (opt->type) {
                case VSH_OT_BOOL:
11381
                    fmt = "[--%s]";
11382 11383
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
11384
                    /* xgettext:c-format */
11385 11386
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
11387 11388
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
11389 11390
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
11391 11392
                    break;
                case VSH_OT_DATA:
11393
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
11394 11395 11396 11397 11398 11399
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
                    fmt = _("[<string>]...");
                    break;
                default:
11400
                    assert(0);
11401
                }
11402
                fputc(' ', stdout);
E
Eric Blake 已提交
11403
                fprintf(stdout, fmt, opt->name);
11404
            }
K
Karel Zak 已提交
11405
        }
11406 11407 11408
        fputc('\n', stdout);

        if (desc[0]) {
11409
            /* Print the description only if it's not empty.  */
11410
            fputs(_("\n  DESCRIPTION\n"), stdout);
K
Karel Zak 已提交
11411 11412
            fprintf(stdout, "    %s\n", desc);
        }
11413

K
Karel Zak 已提交
11414
        if (def->opts) {
11415
            const vshCmdOptDef *opt;
11416
            fputs(_("\n  OPTIONS\n"), stdout);
11417
            for (opt = def->opts; opt->name; opt++) {
11418 11419
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
11420
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
11421 11422
                    break;
                case VSH_OT_INT:
11423 11424 11425
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
11426 11427
                    break;
                case VSH_OT_STRING:
11428
                    /* OT_STRING should never be VSH_OFLAG_REQ */
11429
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
11430 11431
                    break;
                case VSH_OT_DATA:
11432 11433
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
11434 11435 11436 11437 11438 11439 11440
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
                    continue;
                default:
                    assert(0);
                }
11441

E
Eric Blake 已提交
11442
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
11443
            }
K
Karel Zak 已提交
11444 11445 11446
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
11447
    return true;
K
Karel Zak 已提交
11448 11449 11450 11451 11452 11453
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
11454 11455 11456
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
11457 11458
    vshCmdOpt *a = arg;

11459
    while (a) {
K
Karel Zak 已提交
11460
        vshCmdOpt *tmp = a;
11461

K
Karel Zak 已提交
11462 11463
        a = a->next;

11464 11465
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
11466 11467 11468 11469
    }
}

static void
11470
vshCommandFree(vshCmd *cmd)
11471
{
K
Karel Zak 已提交
11472 11473
    vshCmd *c = cmd;

11474
    while (c) {
K
Karel Zak 已提交
11475
        vshCmd *tmp = c;
11476

K
Karel Zak 已提交
11477 11478 11479 11480
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
11481
        VIR_FREE(tmp);
K
Karel Zak 已提交
11482 11483 11484 11485 11486 11487 11488
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
11489
vshCommandOpt(const vshCmd *cmd, const char *name)
11490
{
K
Karel Zak 已提交
11491
    vshCmdOpt *opt = cmd->opts;
11492 11493

    while (opt) {
11494
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
11495 11496 11497 11498 11499 11500 11501
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
11502 11503 11504 11505 11506 11507 11508 11509 11510
 * @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 已提交
11511 11512
 */
static int
11513
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
11514
{
K
Karel Zak 已提交
11515
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11516
    int ret = 0, num;
11517
    char *end_p = NULL;
11518

11519
    if ((arg != NULL) && (arg->data != NULL)) {
11520 11521 11522 11523 11524 11525
        num = strtol(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11526
    }
11527
    return ret;
K
Karel Zak 已提交
11528 11529
}

11530 11531 11532 11533 11534 11535
/*
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
11536 11537
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11538 11539
    int ret = 0;
    unsigned long num;
11540 11541 11542
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
11543 11544 11545 11546 11547 11548
        num = strtoul(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
11549
    }
11550
    return ret;
11551 11552
}

K
Karel Zak 已提交
11553 11554
/*
 * Returns option as STRING
11555
 * See vshCommandOptInt()
K
Karel Zak 已提交
11556
 */
11557 11558
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
11559
{
K
Karel Zak 已提交
11560
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11561 11562 11563
    int ret = 0;

    if (arg && arg->data) {
E
Eric Blake 已提交
11564 11565 11566 11567
        if (*arg->data
            || (arg->def && (arg->def->flag & VSH_OFLAG_EMPTY_OK))) {
            *value = arg->data;
            ret = 1;
11568 11569
        } else if (arg->def && ((arg->def->flag) & VSH_OFLAG_REQ)) {
            vshError(NULL, _("Missing required option '%s'"), name);
E
Eric Blake 已提交
11570 11571 11572 11573
            ret = -1;
        } else {
            /* Treat "--option ''" as if option had not been specified. */
            ret = 0;
11574 11575
        }
    }
11576

11577
    return ret;
K
Karel Zak 已提交
11578 11579
}

11580 11581
/*
 * Returns option as long long
11582
 * See vshCommandOptInt()
11583
 */
11584 11585 11586
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
11587 11588
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
11589 11590
    int ret = 0;
    long long num;
11591 11592
    char *end_p = NULL;

11593 11594 11595 11596 11597 11598 11599 11600 11601
    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;
11602 11603
}

11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624
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 已提交
11625
/*
E
Eric Blake 已提交
11626
 * Returns true/false if the option exists
K
Karel Zak 已提交
11627
 */
E
Eric Blake 已提交
11628
static bool
11629
vshCommandOptBool(const vshCmd *cmd, const char *name)
11630
{
E
Eric Blake 已提交
11631
    return vshCommandOpt(cmd, name) != NULL;
K
Karel Zak 已提交
11632 11633
}

11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654
/*
 * 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 已提交
11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672
/* 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)
11673
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
11674 11675 11676
                 cmd->def->name, optname);
    return found;
}
11677

K
Karel Zak 已提交
11678
static virDomainPtr
J
Jim Meyering 已提交
11679
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
11680
                      const char **name, int flag)
11681
{
K
Karel Zak 已提交
11682
    virDomainPtr dom = NULL;
11683
    const char *n = NULL;
K
Karel Zak 已提交
11684
    int id;
J
Jim Meyering 已提交
11685 11686 11687
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11688

11689
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11690 11691
        return NULL;

K
Karel Zak 已提交
11692
    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
11693 11694
             cmd->def->name, optname, n);

K
Karel Zak 已提交
11695 11696
    if (name)
        *name = n;
11697

K
Karel Zak 已提交
11698
    /* try it by ID */
11699
    if (flag & VSH_BYID) {
11700
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
11701 11702 11703 11704
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
11705
    }
K
Karel Zak 已提交
11706
    /* try it by UUID */
11707
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
11708
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
11709
                 cmd->def->name, optname);
K
Karel Zak 已提交
11710
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
11711
    }
K
Karel Zak 已提交
11712
    /* try it by NAME */
11713
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11714
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
11715
                 cmd->def->name, optname);
K
Karel Zak 已提交
11716
        dom = virDomainLookupByName(ctl->conn, n);
11717
    }
K
Karel Zak 已提交
11718

11719
    if (!dom)
11720
        vshError(ctl, _("failed to get domain '%s'"), n);
11721

K
Karel Zak 已提交
11722 11723 11724
    return dom;
}

11725
static virNetworkPtr
J
Jim Meyering 已提交
11726
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
11727
                       const char **name, int flag)
11728 11729
{
    virNetworkPtr network = NULL;
11730
    const char *n = NULL;
J
Jim Meyering 已提交
11731 11732 11733
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
11734

11735
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11736 11737 11738 11739 11740 11741 11742 11743 11744
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
11745
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
11746
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
11747
                 cmd->def->name, optname);
11748 11749 11750 11751
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
11752
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
11753 11754 11755 11756 11757
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
11758
        vshError(ctl, _("failed to get network '%s'"), n);
11759 11760 11761 11762

    return network;
}

11763 11764 11765

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
11766
                        const char **name, int flag)
11767 11768
{
    virNWFilterPtr nwfilter = NULL;
11769
    const char *n = NULL;
11770 11771 11772 11773
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11774
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801
        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;
}

11802 11803
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
11804
                         const char **name, int flag)
11805 11806
{
    virInterfacePtr iface = NULL;
11807
    const char *n = NULL;
11808 11809 11810 11811
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11812
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11813 11814 11815 11816 11817 11818 11819 11820 11821
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
11822
    if ((flag & VSH_BYNAME)) {
11823 11824 11825 11826 11827 11828 11829 11830 11831 11832 11833 11834
        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)
11835
        vshError(ctl, _("failed to get interface '%s'"), n);
11836 11837 11838 11839

    return iface;
}

11840
static virStoragePoolPtr
11841
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
11842
                    const char **name, int flag)
11843 11844
{
    virStoragePoolPtr pool = NULL;
11845
    const char *n = NULL;
11846

11847
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11848 11849 11850 11851 11852 11853 11854 11855 11856
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
11857
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
11858
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
11859
                 cmd->def->name, optname);
11860 11861 11862
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
11863
    if (pool == NULL && (flag & VSH_BYNAME)) {
11864 11865 11866 11867 11868 11869
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
11870
        vshError(ctl, _("failed to get pool '%s'"), n);
11871 11872 11873 11874 11875

    return pool;
}

static virStorageVolPtr
11876
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
11877 11878
                   const char *optname,
                   const char *pooloptname,
11879
                   const char **name, int flag)
11880 11881 11882
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
11883
    const char *n = NULL, *p = NULL;
11884

11885
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11886 11887
        return NULL;

11888 11889
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
11890
        return NULL;
11891
    }
11892 11893 11894 11895 11896 11897 11898 11899 11900 11901

    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;

11902
    /* try it by name */
11903
    if (pool && (flag & VSH_BYNAME)) {
11904
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
11905 11906 11907
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
11908
    /* try it by key */
11909 11910 11911 11912 11913
    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);
    }
11914
    /* try it by path */
11915 11916 11917 11918 11919 11920 11921
    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)
11922
        vshError(ctl, _("failed to get vol '%s'"), n);
11923 11924 11925 11926 11927 11928 11929

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

11930
static virSecretPtr
11931
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
11932 11933
{
    virSecretPtr secret = NULL;
11934
    const char *n = NULL;
11935 11936 11937 11938 11939
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

11940
    if (vshCommandOptString(cmd, optname, &n) <= 0)
11941 11942 11943 11944 11945 11946 11947 11948 11949 11950
        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)
11951
        vshError(ctl, _("failed to get secret '%s'"), n);
11952 11953 11954 11955

    return secret;
}

K
Karel Zak 已提交
11956 11957 11958
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
11959
static bool
11960
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
11961
{
E
Eric Blake 已提交
11962
    bool ret = true;
11963 11964

    while (cmd) {
K
Karel Zak 已提交
11965
        struct timeval before, after;
11966
        bool enable_timing = ctl->timing;
11967

11968 11969
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
11970 11971
            vshReconnect(ctl);

11972
        if (enable_timing)
K
Karel Zak 已提交
11973
            GETTIMEOFDAY(&before);
11974

K
Karel Zak 已提交
11975 11976
        ret = cmd->def->handler(ctl, cmd);

11977
        if (enable_timing)
K
Karel Zak 已提交
11978
            GETTIMEOFDAY(&after);
11979

11980
        if (!ret)
J
John Levon 已提交
11981 11982
            virshReportError(ctl);

11983
        /* try to automatically catch disconnections */
11984
        if (!ret &&
11985 11986 11987 11988 11989 11990 11991 11992 11993
            ((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);

11994
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
11995 11996
            return ret;

11997
        if (enable_timing)
11998
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
11999 12000
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
12001
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
12002 12003 12004 12005 12006 12007
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
12008
 * Command parsing
K
Karel Zak 已提交
12009 12010 12011
 * ---------------
 */

12012 12013 12014 12015 12016 12017 12018 12019 12020 12021
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 已提交
12022
    /* vshCommandStringGetArg() */
12023
    char *pos;
L
Lai Jiangshan 已提交
12024 12025 12026
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
12027 12028
} vshCommandParser;

E
Eric Blake 已提交
12029
static bool
12030
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
12031
{
K
Karel Zak 已提交
12032 12033 12034
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
12035

K
Karel Zak 已提交
12036 12037 12038 12039
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
12040

12041
    while (1) {
K
Karel Zak 已提交
12042
        vshCmdOpt *last = NULL;
12043
        const vshCmdDef *cmd = NULL;
12044
        vshCommandToken tk;
L
Lai Jiangshan 已提交
12045
        bool data_only = false;
12046 12047 12048
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
12049

K
Karel Zak 已提交
12050
        first = NULL;
12051

12052
        while (1) {
12053
            const vshCmdOptDef *opt = NULL;
12054

K
Karel Zak 已提交
12055
            tkdata = NULL;
12056
            tk = parser->getNextArg(ctl, parser, &tkdata);
12057 12058

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
12059
                goto syntaxError;
H
Hu Tao 已提交
12060 12061
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
12062
                break;
H
Hu Tao 已提交
12063
            }
12064 12065

            if (cmd == NULL) {
K
Karel Zak 已提交
12066 12067
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
12068
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
12069
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
12070
                }
12071 12072 12073 12074 12075 12076 12077
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
12078
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
12079 12080 12081 12082
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
12083 12084 12085 12086 12087
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
12088 12089
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
12090
                    VIR_FREE(optstr);
K
Karel Zak 已提交
12091 12092
                    goto syntaxError;
                }
12093
                VIR_FREE(tkdata);
K
Karel Zak 已提交
12094 12095 12096

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
12097 12098 12099
                    if (optstr)
                        tkdata = optstr;
                    else
12100
                        tk = parser->getNextArg(ctl, parser, &tkdata);
12101
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
12102
                        goto syntaxError;
12103
                    if (tk != VSH_TK_ARG) {
12104
                        vshError(ctl,
12105
                                 _("expected syntax: --%s <%s>"),
12106 12107
                                 opt->name,
                                 opt->type ==
12108
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
12109 12110
                        goto syntaxError;
                    }
12111
                    opts_need_arg &= ~opts_seen;
12112 12113 12114 12115 12116 12117 12118 12119
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
12120
                }
L
Lai Jiangshan 已提交
12121 12122 12123 12124
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
12125
            } else {
L
Lai Jiangshan 已提交
12126
get_data:
12127 12128
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
12129
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
12130 12131 12132 12133 12134
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
12135
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
12136

K
Karel Zak 已提交
12137 12138 12139 12140
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
12141

K
Karel Zak 已提交
12142 12143 12144 12145 12146
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
12147

K
Karel Zak 已提交
12148
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
12149 12150
                         cmd->name,
                         opt->name,
12151 12152
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
12153 12154
            }
        }
12155

D
Daniel Veillard 已提交
12156
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
12157
        if (cmd) {
12158
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
12159

K
Karel Zak 已提交
12160 12161 12162 12163
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

12164
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
12165
                VIR_FREE(c);
12166
                goto syntaxError;
12167
            }
12168

K
Karel Zak 已提交
12169 12170 12171 12172 12173 12174
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
12175 12176 12177

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
12178
    }
12179

E
Eric Blake 已提交
12180
    return true;
K
Karel Zak 已提交
12181

12182
 syntaxError:
12183
    if (ctl->cmd) {
K
Karel Zak 已提交
12184
        vshCommandFree(ctl->cmd);
12185 12186
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
12187 12188
    if (first)
        vshCommandOptFree(first);
12189
    VIR_FREE(tkdata);
E
Eric Blake 已提交
12190
    return false;
K
Karel Zak 已提交
12191 12192
}

12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210
/* --------------------
 * 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 已提交
12211 12212
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
12213 12214 12215 12216
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
12217
        return false;
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 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289

    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 已提交
12290 12291
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
12292 12293 12294 12295
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
12296
        return false;
12297 12298 12299 12300 12301 12302

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
12303
/* ---------------
12304
 * Misc utils
K
Karel Zak 已提交
12305 12306
 * ---------------
 */
12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334
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 已提交
12335
static const char *
12336 12337
vshDomainStateToString(int state)
{
12338
    switch ((virDomainState) state) {
12339
    case VIR_DOMAIN_RUNNING:
12340
        return N_("running");
12341
    case VIR_DOMAIN_BLOCKED:
12342
        return N_("idle");
12343
    case VIR_DOMAIN_PAUSED:
12344
        return N_("paused");
12345
    case VIR_DOMAIN_SHUTDOWN:
12346
        return N_("in shutdown");
12347
    case VIR_DOMAIN_SHUTOFF:
12348
        return N_("shut off");
12349
    case VIR_DOMAIN_CRASHED:
12350
        return N_("crashed");
12351
    case VIR_DOMAIN_NOSTATE:
12352
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
12353
    }
12354
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
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 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457
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");
}

12458 12459 12460 12461
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
12462
    case VIR_VCPU_OFFLINE:
12463
        return N_("offline");
12464
    case VIR_VCPU_BLOCKED:
12465
        return N_("idle");
12466
    case VIR_VCPU_RUNNING:
12467
        return N_("running");
12468
    default:
12469
        ;/*FALLTHROUGH*/
12470
    }
12471
    return N_("no state");
12472 12473
}

E
Eric Blake 已提交
12474
static bool
12475
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
12476
{
12477 12478
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
12479 12480
     */
    if (!conn) {
12481
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
12482
        return false;
K
Karel Zak 已提交
12483
    }
E
Eric Blake 已提交
12484
    return true;
K
Karel Zak 已提交
12485 12486
}

K
Karel Zak 已提交
12487
static void
12488
vshDebug(vshControl *ctl, int level, const char *format, ...)
12489
{
K
Karel Zak 已提交
12490
    va_list ap;
12491
    char *str;
K
Karel Zak 已提交
12492

12493 12494 12495 12496
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
12497 12498 12499 12500
    if (level > ctl->debug)
        return;

    va_start(ap, format);
12501 12502 12503 12504 12505
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
12506
    va_end(ap);
12507 12508
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
12509 12510 12511
}

static void
12512
vshPrintExtra(vshControl *ctl, const char *format, ...)
12513
{
K
Karel Zak 已提交
12514
    va_list ap;
12515
    char *str;
12516

12517
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
12518
        return;
12519

K
Karel Zak 已提交
12520
    va_start(ap, format);
12521 12522 12523 12524 12525
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
12526
    va_end(ap);
12527
    fputs(str, stdout);
12528
    VIR_FREE(str);
K
Karel Zak 已提交
12529 12530
}

K
Karel Zak 已提交
12531

K
Karel Zak 已提交
12532
static void
12533
vshError(vshControl *ctl, const char *format, ...)
12534
{
K
Karel Zak 已提交
12535
    va_list ap;
12536
    char *str;
12537

12538 12539 12540 12541 12542
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
12543

12544
    fputs(_("error: "), stderr);
12545

K
Karel Zak 已提交
12546
    va_start(ap, format);
12547 12548 12549
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
12550 12551
    va_end(ap);

12552 12553
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
12554 12555
}

12556

K
Karel Zak 已提交
12557
/*
12558
 * Initialize connection.
K
Karel Zak 已提交
12559
 */
E
Eric Blake 已提交
12560
static bool
12561
vshInit(vshControl *ctl)
12562
{
12563 12564
    char *debugEnv;

K
Karel Zak 已提交
12565
    if (ctl->conn)
E
Eric Blake 已提交
12566
        return false;
K
Karel Zak 已提交
12567

12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588
    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);
        }
    }

12589 12590
    vshOpenLogFile(ctl);

12591 12592
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
12593

12594 12595 12596
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

12597
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
12598
        return false;
12599

12600 12601 12602 12603
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
12604

12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615
        /* 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;
        }
12616
    }
K
Karel Zak 已提交
12617

E
Eric Blake 已提交
12618
    return true;
K
Karel Zak 已提交
12619 12620
}

12621 12622
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640 12641
/**
 * 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:
12642
                vshError(ctl, "%s",
J
Jim Meyering 已提交
12643
                         _("failed to get the log file information"));
12644
                exit(EXIT_FAILURE);
12645 12646 12647
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
12648 12649
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
12650 12651 12652 12653
        }
    }

    /* log file open */
12654
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
12655
        vshError(ctl, "%s",
J
Jim Meyering 已提交
12656
                 _("failed to open the log file. check the log file path"));
12657
        exit(EXIT_FAILURE);
12658 12659 12660 12661 12662 12663 12664 12665 12666
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
12667 12668
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
12669
{
12670 12671 12672
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686
    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);
12687
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
12688 12689 12690 12691 12692 12693
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
12694 12695
                      SIGN_NAME,
                      (int) getpid());
12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715
    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;
    }
12716 12717 12718
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
12719

12720 12721
    if (virBufferError(&buf))
        goto error;
12722

12723 12724 12725 12726 12727
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
12728
    }
12729

12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740
    /* 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);
12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
12752 12753 12754
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
12755 12756 12757
    }

    if (ctl->logfile) {
12758
        VIR_FREE(ctl->logfile);
12759 12760 12761 12762
        ctl->logfile = NULL;
    }
}

12763
#ifdef USE_READLINE
12764

K
Karel Zak 已提交
12765 12766 12767 12768 12769
/* -----------------
 * Readline stuff
 * -----------------
 */

12770
/*
K
Karel Zak 已提交
12771 12772
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
12773
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
12774 12775
 */
static char *
12776 12777
vshReadlineCommandGenerator(const char *text, int state)
{
12778
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
12779
    const char *name;
12780 12781
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
12782 12783

    if (!state) {
12784 12785
        grp_list_index = 0;
        cmd_list_index = 0;
12786
        len = strlen(text);
K
Karel Zak 已提交
12787 12788
    }

12789 12790
    grp = cmdGroups;

K
Karel Zak 已提交
12791
    /* Return the next name which partially matches from the
12792
     * command list.
K
Karel Zak 已提交
12793
     */
12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807
    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 已提交
12808 12809 12810 12811 12812 12813 12814
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
12815 12816
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
12817
    static int list_index, len;
12818
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
12819
    const char *name;
K
Karel Zak 已提交
12820 12821 12822 12823 12824 12825 12826 12827 12828

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

12829
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
12830
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
12831 12832 12833

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
12834
        len = strlen(text);
12835
        VIR_FREE(cmdname);
K
Karel Zak 已提交
12836 12837 12838 12839
    }

    if (!cmd)
        return NULL;
12840

12841 12842 12843
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
12844
    while ((name = cmd->opts[list_index].name)) {
12845
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
12846
        char *res;
12847

K
Karel Zak 已提交
12848
        list_index++;
12849

K
Karel Zak 已提交
12850
        if (opt->type == VSH_OT_DATA)
K
Karel Zak 已提交
12851 12852
            /* ignore non --option */
            continue;
12853

K
Karel Zak 已提交
12854
        if (len > 2) {
12855
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
12856 12857
                continue;
        }
12858
        res = vshMalloc(NULL, strlen(name) + 3);
12859
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
12860 12861 12862 12863 12864 12865 12866 12867
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
12868 12869 12870
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
12871 12872
    char **matches = (char **) NULL;

12873
    if (start == 0)
K
Karel Zak 已提交
12874
        /* command name generator */
12875
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
12876 12877
    else
        /* commands options */
12878
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
12879 12880 12881 12882
    return matches;
}


12883 12884
static int
vshReadlineInit(vshControl *ctl)
12885
{
12886 12887
    char *userdir = NULL;

K
Karel Zak 已提交
12888 12889 12890 12891 12892
    /* 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;
12893 12894 12895

    /* Limit the total size of the history buffer */
    stifle_history(500);
12896 12897

    /* Prepare to read/write history from/to the ~/.virsh/history file */
12898
    userdir = virGetUserDirectory(getuid());
12899

12900 12901
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
12902
        return -1;
12903
    }
12904 12905 12906

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12907
        VIR_FREE(userdir);
12908 12909 12910 12911 12912
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
12913
        VIR_FREE(userdir);
12914 12915 12916
        return -1;
    }

12917
    VIR_FREE(userdir);
12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935

    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);
    }

12936 12937
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
12938 12939
}

12940 12941 12942 12943 12944 12945
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

12946
#else /* !USE_READLINE */
12947

12948 12949 12950 12951 12952 12953 12954
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

12955
static void
12956
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979
{
    /* 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);
}

12980
#endif /* !USE_READLINE */
12981

K
Karel Zak 已提交
12982
/*
J
Jim Meyering 已提交
12983
 * Deinitialize virsh
K
Karel Zak 已提交
12984
 */
E
Eric Blake 已提交
12985
static bool
12986
vshDeinit(vshControl *ctl)
12987
{
12988
    vshReadlineDeinit(ctl);
12989
    vshCloseLogFile(ctl);
12990
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
12991
    if (ctl->conn) {
12992 12993 12994
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
12995 12996
        }
    }
D
Daniel P. Berrange 已提交
12997 12998
    virResetLastError();

E
Eric Blake 已提交
12999
    return true;
K
Karel Zak 已提交
13000
}
13001

K
Karel Zak 已提交
13002 13003 13004 13005
/*
 * Print usage
 */
static void
13006
vshUsage(void)
13007
{
13008
    const vshCmdGrp *grp;
13009
    const vshCmdDef *cmd;
13010

L
Lai Jiangshan 已提交
13011 13012
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
13013 13014 13015
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
13016
                      "    -d | --debug <num>      debug level [0-4]\n"
13017 13018 13019 13020
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
13021
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
13022
                      "    -V | --version=long     version and full options\n\n"
13023
                      "  commands (non interactive mode):\n\n"), progname, progname);
13024

13025 13026
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
13027

13028 13029 13030 13031 13032 13033 13034 13035 13036
        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"));
13037 13038 13039
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
13040 13041
}

13042 13043 13044 13045 13046 13047 13048 13049 13050 13051
/*
 * 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 已提交
13052 13053
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088
#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 已提交
13089
    vshPrint(ctl, "%s", _(" Networking:"));
13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115
#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 已提交
13116
    vshPrint(ctl, "%s", _(" Storage:"));
13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139
#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 已提交
13140
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
13141
#ifdef WITH_SECDRIVER_APPARMOR
13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164
    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 已提交
13165 13166 13167 13168
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
13169
static bool
13170
vshParseArgv(vshControl *ctl, int argc, char **argv)
13171
{
13172 13173
    bool help = false;
    int arg;
K
Karel Zak 已提交
13174
    struct option opt[] = {
E
Eric Blake 已提交
13175 13176 13177 13178 13179 13180 13181 13182 13183
        {"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}
13184 13185
    };

13186 13187 13188
    /* 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. */
13189
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
13190
        switch (arg) {
13191
        case 'd':
D
Daniel Veillard 已提交
13192
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
13193
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
13194 13195
                exit(EXIT_FAILURE);
            }
13196 13197
            break;
        case 'h':
13198
            help = true;
13199 13200
            break;
        case 'q':
E
Eric Blake 已提交
13201
            ctl->quiet = true;
13202 13203
            break;
        case 't':
E
Eric Blake 已提交
13204
            ctl->timing = true;
13205 13206 13207 13208
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
13209 13210 13211 13212 13213 13214
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
13215 13216 13217
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
13218
        case 'r':
E
Eric Blake 已提交
13219
            ctl->readonly = true;
13220
            break;
13221 13222 13223
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
13224
        default:
13225 13226
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
13227 13228 13229 13230
        }
    }

    if (help) {
13231 13232
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
13233 13234
            exit(EXIT_FAILURE);
        }
13235 13236 13237

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
13238
        exit(EXIT_SUCCESS);
13239 13240
    }

13241
    if (argc > optind) {
K
Karel Zak 已提交
13242
        /* parse command */
E
Eric Blake 已提交
13243
        ctl->imode = false;
13244 13245 13246
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
13247
        } else {
13248
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
13249 13250
        }
    }
E
Eric Blake 已提交
13251
    return true;
K
Karel Zak 已提交
13252 13253
}

13254 13255 13256 13257
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
13258
    char *defaultConn;
E
Eric Blake 已提交
13259
    bool ret = true;
K
Karel Zak 已提交
13260

13261 13262 13263
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
13264
    ctl->debug = -1;            /* Initialize log level */
13265

13266 13267
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
13268
        /* failure to setup locale is not fatal */
13269
    }
13270
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
13271
        perror("bindtextdomain");
E
Eric Blake 已提交
13272
        return EXIT_FAILURE;
13273
    }
13274
    if (!textdomain(PACKAGE)) {
13275
        perror("textdomain");
E
Eric Blake 已提交
13276
        return EXIT_FAILURE;
13277 13278
    }

13279 13280 13281 13282 13283
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

13284
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
13285 13286 13287
        progname = argv[0];
    else
        progname++;
13288

13289
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
13290
        ctl->name = vshStrdup(ctl, defaultConn);
13291 13292
    }

D
Daniel P. Berrange 已提交
13293 13294
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
13295
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
13296
    }
13297

D
Daniel P. Berrange 已提交
13298 13299
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
13300
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
13301
    }
13302

K
Karel Zak 已提交
13303
    if (!ctl->imode) {
13304
        ret = vshCommandRun(ctl, ctl->cmd);
13305
    } else {
K
Karel Zak 已提交
13306 13307
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
13308
            vshPrint(ctl,
13309
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
13310
                     progname);
J
Jim Meyering 已提交
13311
            vshPrint(ctl, "%s",
13312
                     _("Type:  'help' for help with commands\n"
13313
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
13314
        }
13315 13316 13317 13318 13319 13320

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
13321
        do {
13322
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
13323
            ctl->cmdstr =
13324
                vshReadline(ctl, prompt);
13325 13326
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
13327
            if (*ctl->cmdstr) {
13328
#if USE_READLINE
K
Karel Zak 已提交
13329
                add_history(ctl->cmdstr);
13330
#endif
13331
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
13332 13333
                    vshCommandRun(ctl, ctl->cmd);
            }
13334
            VIR_FREE(ctl->cmdstr);
13335
        } while (ctl->imode);
K
Karel Zak 已提交
13336

13337 13338
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
13339
    }
13340

K
Karel Zak 已提交
13341 13342
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
13343
}