virsh.c 393.7 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
    VSH_OT_DATA,     /* string data (as non-option) */
129
    VSH_OT_ARGV      /* remaining arguments */
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
enum {
    VSH_OFLAG_NONE     = 0,        /* without flags */
    VSH_OFLAG_REQ      = (1 << 0), /* option required */
    VSH_OFLAG_EMPTY_OK = (1 << 1), /* empty string option allowed */
L
Lai Jiangshan 已提交
155
    VSH_OFLAG_REQ_OPT  = (1 << 2), /* --optionname required */
E
Eric Blake 已提交
156
};
K
Karel Zak 已提交
157 158 159 160 161 162 163 164

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

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

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

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

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

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

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

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

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

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

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

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

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

265
static vshCmdOpt *vshCommandOpt(const vshCmd *cmd, const char *name);
266 267
static int vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
268 269 270
static int vshCommandOptUInt(const vshCmd *cmd, const char *name,
                             unsigned int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
271 272 273 274 275 276 277 278 279
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;
280 281 282
static int vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                                  unsigned long long *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
E
Eric Blake 已提交
283
static bool vshCommandOptBool(const vshCmd *cmd, const char *name);
284 285
static const vshCmdOpt *vshCommandOptArgv(const vshCmd *cmd,
                                          const vshCmdOpt *opt);
K
Karel Zak 已提交
286

287 288 289
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
290
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
291

292
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
293
                                          const char **name, int flag);
K
Karel Zak 已提交
294 295

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

299
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
300
                                            const char **name, int flag);
301 302

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
303 304
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
305 306
                           VSH_BYUUID|VSH_BYNAME)

307
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
308
                                                  const char **name, int flag);
309 310 311 312 313 314

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

315
static virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
316
                                                const char **name, int flag);
317 318 319 320 321 322

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

323
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
324
                            const char *optname, const char **name, int flag);
325 326 327 328 329 330

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

331
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
332 333
                                           const char *optname,
                                           const char *pooloptname,
334
                                           const char **name, int flag);
335 336

/* default is lookup by Name and UUID */
337
#define vshCommandOptVol(_ctl, _cmd, _optname, _pooloptname, _name)   \
338 339 340
    vshCommandOptVolBy(_ctl, _cmd, _optname, _pooloptname, _name,     \
                           VSH_BYUUID|VSH_BYNAME)

341
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
342
                                        const char **name);
343

344
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
345
    ATTRIBUTE_FMT_PRINTF(2, 3);
346
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
347
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
348 349

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

352
static int vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason);
K
Karel Zak 已提交
353
static const char *vshDomainStateToString(int state);
354
static const char *vshDomainStateReasonToString(int state, int reason);
355
static const char *vshDomainControlStateToString(int state);
356
static const char *vshDomainVcpuStateToString(int state);
E
Eric Blake 已提交
357
static bool vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
K
Karel Zak 已提交
358

359 360 361 362
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

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

372
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
373 374
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
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 429 430 431 432 433 434
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
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449

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;

450
  /* User visible sort, so we want locale-specific case comparison.  */
451 452 453
  return strcasecmp(*sa, *sb);
}

454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
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 已提交
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
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)
{
501 502 503 504 505 506 507 508
    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)
509
            goto out;
510
    }
J
John Levon 已提交
511 512

    if (last_error->code == VIR_ERR_OK) {
513
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
514 515 516
        goto out;
    }

517
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
518 519 520 521 522 523

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

524 525 526 527 528 529 530 531 532
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;
}

533 534 535 536 537
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

538 539 540 541 542
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

543 544 545 546 547 548
/*
 * 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
 */
549 550 551 552
static void vshCatchDisconnect(int sig, siginfo_t *siginfo,
                               void *context ATTRIBUTE_UNUSED) {
    if ((sig == SIGPIPE) ||
        (SA_SIGINFO && siginfo->si_signo == SIGPIPE))
553 554 555 556 557 558 559 560 561
        disconnected++;
}

/*
 * vshSetupSignals:
 *
 * Catch SIGPIPE signals which may arise when disconnection
 * from libvirtd occurs
 */
L
Laine Stump 已提交
562
static void
563 564 565 566 567 568 569 570 571 572 573 574 575
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 已提交
576
 * Reconnect after a disconnect from libvirtd
577 578
 *
 */
L
Laine Stump 已提交
579
static void
580 581 582 583 584 585
vshReconnect(vshControl *ctl)
{
    bool connected = false;

    if (ctl->conn != NULL) {
        connected = true;
586
        virConnectClose(ctl->conn);
587
    }
588 589 590 591 592 593

    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);
    if (!ctl->conn)
        vshError(ctl, "%s", _("Failed to reconnect to the hypervisor"));
594
    else if (connected)
595 596
        vshError(ctl, "%s", _("Reconnected to the hypervisor"));
    disconnected = 0;
597
    ctl->useGetInfo = false;
598
}
599

K
Karel Zak 已提交
600 601 602 603 604 605
/* ---------------
 * Commands
 * ---------------
 */

/*
606
 * "help" command
K
Karel Zak 已提交
607
 */
608
static const vshCmdInfo info_help[] = {
609
    {"help", N_("print help")},
610 611
    {"desc", N_("Prints global help, command specific help, or help for a\n"
                "    group of related commands")},
612

613
    {NULL, NULL}
K
Karel Zak 已提交
614 615
};

616
static const vshCmdOptDef opts_help[] = {
617
    {"command", VSH_OT_DATA, 0, N_("Prints global help, command specific help, or help for a group of related commands")},
618
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
619 620
};

E
Eric Blake 已提交
621
static bool
622
cmdHelp(vshControl *ctl, const vshCmd *cmd)
623
 {
624
    const char *name = NULL;
625

626
    if (vshCommandOptString(cmd, "command", &name) <= 0) {
627
        const vshCmdGrp *grp;
628
        const vshCmdDef *def;
629

630 631 632 633 634 635 636 637 638 639 640 641 642
        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 已提交
643
        return true;
644
    }
645

E
Eric Blake 已提交
646
    if (vshCmddefSearch(name)) {
647
        return vshCmddefHelp(ctl, name);
E
Eric Blake 已提交
648
    } else if (vshCmdGrpSearch(name)) {
649 650 651
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
E
Eric Blake 已提交
652
        return false;
K
Karel Zak 已提交
653 654 655
    }
}

656 657 658
/*
 * "autostart" command
 */
659
static const vshCmdInfo info_autostart[] = {
660
    {"help", N_("autostart a domain")},
661
    {"desc",
662
     N_("Configure a domain to be automatically started at boot.")},
663 664 665
    {NULL, NULL}
};

666
static const vshCmdOptDef opts_autostart[] = {
667 668
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
669 670 671
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
672
static bool
673
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
674 675
{
    virDomainPtr dom;
676
    const char *name;
677 678
    int autostart;

679
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
680
        return false;
681

J
Jim Meyering 已提交
682
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
683
        return false;
684 685 686 687

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
688
        if (autostart)
689
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
690
        else
691
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
692
        virDomainFree(dom);
E
Eric Blake 已提交
693
        return false;
694 695
    }

696
    if (autostart)
697
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
698
    else
699
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
700

701
    virDomainFree(dom);
E
Eric Blake 已提交
702
    return true;
703 704
}

K
Karel Zak 已提交
705
/*
706
 * "connect" command
K
Karel Zak 已提交
707
 */
708
static const vshCmdInfo info_connect[] = {
709
    {"help", N_("(re)connect to hypervisor")},
710
    {"desc",
711
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
712
    {NULL, NULL}
K
Karel Zak 已提交
713 714
};

715
static const vshCmdOptDef opts_connect[] = {
E
Eric Blake 已提交
716 717
    {"name",     VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("hypervisor connection URI")},
718
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
719
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
720 721
};

E
Eric Blake 已提交
722
static bool
723
cmdConnect(vshControl *ctl, const vshCmd *cmd)
724
{
E
Eric Blake 已提交
725
    bool ro = vshCommandOptBool(cmd, "readonly");
726
    const char *name = NULL;
727

K
Karel Zak 已提交
728
    if (ctl->conn) {
729 730 731
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
E
Eric Blake 已提交
732
            return false;
K
Karel Zak 已提交
733 734 735
        }
        ctl->conn = NULL;
    }
736

737
    VIR_FREE(ctl->name);
738 739
    if (vshCommandOptString(cmd, "name", &name) < 0) {
        vshError(ctl, "%s", _("Please specify valid connection URI"));
E
Eric Blake 已提交
740
        return false;
741
    }
742
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
743

744
    ctl->useGetInfo = false;
E
Eric Blake 已提交
745
    ctl->readonly = ro;
K
Karel Zak 已提交
746

747 748 749
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

E
Eric Blake 已提交
753
    return !!ctl->conn;
K
Karel Zak 已提交
754 755
}

756 757
#ifndef WIN32

758
/*
759
 * "console" command
760
 */
761
static const vshCmdInfo info_console[] = {
762
    {"help", N_("connect to the guest console")},
763
    {"desc",
764
     N_("Connect the virtual serial console for the guest")},
765 766 767
    {NULL, NULL}
};

768
static const vshCmdOptDef opts_console[] = {
769
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
770
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
771 772 773
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
774
static bool
775
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
776
{
E
Eric Blake 已提交
777
    bool ret = false;
778
    int state;
779

780
    if ((state = vshDomainState(ctl, dom, NULL)) < 0) {
781 782 783 784
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

785
    if (state == VIR_DOMAIN_SHUTOFF) {
786 787 788 789
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

790 791
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
    vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
792
    if (vshRunConsole(dom, name) == 0)
E
Eric Blake 已提交
793
        ret = true;
794 795

 cleanup:
796

797 798 799
    return ret;
}

E
Eric Blake 已提交
800
static bool
801 802 803
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
804
    bool ret = false;
805
    const char *name = NULL;
806

807
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
808
        return false;
809 810

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

813 814 815 816
    if (vshCommandOptString(cmd, "devname", &name) < 0) {
        vshError(ctl, "%s", _("Invalid devname"));
        goto cleanup;
    }
817

818
    ret = cmdRunConsole(ctl, dom, name);
819

820
cleanup:
821 822 823 824
    virDomainFree(dom);
    return ret;
}

825 826 827
#endif /* WIN32 */


K
Karel Zak 已提交
828 829 830
/*
 * "list" command
 */
831
static const vshCmdInfo info_list[] = {
832 833
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
834
    {NULL, NULL}
K
Karel Zak 已提交
835 836
};

837
static const vshCmdOptDef opts_list[] = {
838 839
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
840 841 842
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
843

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

855
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
856
        return false;
857

858
    if (active) {
859 860
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
861
            vshError(ctl, "%s", _("Failed to list active domains"));
E
Eric Blake 已提交
862
            return false;
863 864 865 866 867
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
868
                vshError(ctl, "%s", _("Failed to list active domains"));
869
                VIR_FREE(ids);
E
Eric Blake 已提交
870
                return false;
871 872
            }

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

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
887
                vshError(ctl, "%s", _("Failed to list inactive domains"));
888 889
                VIR_FREE(ids);
                VIR_FREE(names);
E
Eric Blake 已提交
890
                return false;
891
            }
892

893
            qsort(&names[0], maxname, sizeof(char*), namesorter);
894
        }
895
    }
896
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
897
    vshPrintExtra(ctl, "----------------------------------\n");
898 899

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

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

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

        /* this kind of work with domains is not atomic operation */
916
        if (!dom) {
917
            VIR_FREE(names[i]);
918
            continue;
919
        }
920

921 922 923 924
        vshPrint(ctl, "%3s %-20s %s\n",
                 "-",
                 names[i],
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
925

926
        virDomainFree(dom);
927
        VIR_FREE(names[i]);
928
    }
929 930
    VIR_FREE(ids);
    VIR_FREE(names);
E
Eric Blake 已提交
931
    return true;
K
Karel Zak 已提交
932 933 934
}

/*
K
Karel Zak 已提交
935
 * "domstate" command
K
Karel Zak 已提交
936
 */
937
static const vshCmdInfo info_domstate[] = {
938 939
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
940
    {NULL, NULL}
K
Karel Zak 已提交
941 942
};

943
static const vshCmdOptDef opts_domstate[] = {
944
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
945
    {"reason", VSH_OT_BOOL, 0, N_("also print reason for the state")},
946
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
947 948
};

E
Eric Blake 已提交
949
static bool
950
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
951
{
K
Karel Zak 已提交
952
    virDomainPtr dom;
E
Eric Blake 已提交
953
    bool ret = true;
954 955
    int showReason = vshCommandOptBool(cmd, "reason");
    int state, reason;
956

957
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
958
        return false;
959

J
Jim Meyering 已提交
960
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
961
        return false;
962

963
    if ((state = vshDomainState(ctl, dom, &reason)) < 0) {
E
Eric Blake 已提交
964
        ret = false;
965 966 967 968 969 970 971 972 973 974 975
        goto cleanup;
    }

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

977
cleanup:
978 979 980 981
    virDomainFree(dom);
    return ret;
}

982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
/*
 * "domcontrol" command
 */
static const vshCmdInfo info_domcontrol[] = {
    {"help", N_("domain control interface state")},
    {"desc", N_("Returns state of a control interface to the domain.")},
    {NULL, NULL}
};

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

static bool
cmdDomControl(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = true;
    virDomainControlInfo info;

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

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

    if (virDomainGetControlInfo(dom, &info, 0) < 0) {
        ret = false;
        goto cleanup;
    }

    if (info.state != VIR_DOMAIN_CONTROL_OK &&
        info.state != VIR_DOMAIN_CONTROL_ERROR) {
        vshPrint(ctl, "%s (%0.3fs)\n",
                 _(vshDomainControlStateToString(info.state)),
                 info.stateTime / 1000.0);
    } else {
        vshPrint(ctl, "%s\n",
                 _(vshDomainControlStateToString(info.state)));
    }

cleanup:
    virDomainFree(dom);
    return ret;
}

1029 1030
/* "domblkstat" command
 */
1031
static const vshCmdInfo info_domblkstat[] = {
1032 1033
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
1034 1035 1036
    {NULL,NULL}
};

1037
static const vshCmdOptDef opts_domblkstat[] = {
1038 1039
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
1040 1041 1042
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1043
static bool
1044
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
1045 1046
{
    virDomainPtr dom;
1047
    const char *name = NULL, *device = NULL;
1048 1049
    struct _virDomainBlockStats stats;

1050
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1051
        return false;
1052

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

1056
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
L
Laine Stump 已提交
1057
        virDomainFree(dom);
E
Eric Blake 已提交
1058
        return false;
L
Laine Stump 已提交
1059
    }
1060 1061

    if (virDomainBlockStats (dom, device, &stats, sizeof stats) == -1) {
1062
        vshError(ctl, _("Failed to get block stats %s %s"), name, device);
1063
        virDomainFree(dom);
E
Eric Blake 已提交
1064
        return false;
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
    }

    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 已提交
1083
    return true;
1084 1085 1086 1087
}

/* "domifstat" command
 */
1088
static const vshCmdInfo info_domifstat[] = {
1089 1090
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1091 1092 1093
    {NULL,NULL}
};

1094
static const vshCmdOptDef opts_domifstat[] = {
1095 1096
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1097 1098 1099
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1100
static bool
1101
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1102 1103
{
    virDomainPtr dom;
1104
    const char *name = NULL, *device = NULL;
1105 1106
    struct _virDomainInterfaceStats stats;

1107
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1108
        return false;
1109

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

1113
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1114
        virDomainFree(dom);
E
Eric Blake 已提交
1115
        return false;
L
Laine Stump 已提交
1116
    }
1117 1118

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1119
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1120
        virDomainFree(dom);
E
Eric Blake 已提交
1121
        return false;
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
    }

    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 已提交
1149
    return true;
1150 1151
}

1152 1153 1154
/*
 * "dommemstats" command
 */
1155
static const vshCmdInfo info_dommemstat[] = {
1156 1157
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1158 1159 1160
    {NULL,NULL}
};

1161
static const vshCmdOptDef opts_dommemstat[] = {
1162
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1163 1164 1165
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1166
static bool
1167
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1168 1169
{
    virDomainPtr dom;
1170
    const char *name;
1171 1172 1173
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1178
        return false;
1179 1180 1181 1182 1183

    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 已提交
1184
        return false;
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
    }

    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);
1200 1201
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON)
            vshPrint (ctl, "actual %llu\n", stats[i].val);
1202 1203 1204
    }

    virDomainFree(dom);
E
Eric Blake 已提交
1205
    return true;
1206 1207
}

1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
/*
 * "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 已提交
1223
static bool
1224 1225 1226 1227
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1228
    bool ret = true;
1229
    const char *device = NULL;
1230

1231
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1232
        return false;
1233 1234

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

1237
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1238
        virDomainFree(dom);
E
Eric Blake 已提交
1239
        return false;
1240 1241 1242 1243
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1244
        return false;
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
    }

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

1255 1256 1257
/*
 * "suspend" command
 */
1258
static const vshCmdInfo info_suspend[] = {
1259 1260
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1261
    {NULL, NULL}
1262 1263
};

1264
static const vshCmdOptDef opts_suspend[] = {
1265
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1266
    {NULL, 0, 0, NULL}
1267 1268
};

E
Eric Blake 已提交
1269
static bool
1270
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1271
{
1272
    virDomainPtr dom;
1273
    const char *name;
E
Eric Blake 已提交
1274
    bool ret = true;
1275

1276
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1277
        return false;
1278

J
Jim Meyering 已提交
1279
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1280
        return false;
1281 1282

    if (virDomainSuspend(dom) == 0) {
1283
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1284
    } else {
1285
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1286
        ret = false;
1287
    }
1288

1289 1290 1291 1292
    virDomainFree(dom);
    return ret;
}

1293 1294 1295
/*
 * "create" command
 */
1296
static const vshCmdInfo info_create[] = {
1297 1298
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1299 1300 1301
    {NULL, NULL}
};

1302
static const vshCmdOptDef opts_create[] = {
1303
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1304
#ifndef WIN32
1305
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1306
#endif
1307
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1308 1309 1310
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1311
static bool
1312
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1313 1314
{
    virDomainPtr dom;
1315
    const char *from = NULL;
E
Eric Blake 已提交
1316
    bool ret = true;
1317
    char *buffer;
1318
#ifndef WIN32
1319
    int console = vshCommandOptBool(cmd, "console");
1320
#endif
1321
    unsigned int flags = VIR_DOMAIN_NONE;
1322

1323
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1324
        return false;
1325

1326
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1327
        return false;
1328

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

1332 1333 1334 1335
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1336
    VIR_FREE(buffer);
1337

1338
    if (dom != NULL) {
1339
        vshPrint(ctl, _("Domain %s created from %s\n"),
1340
                 virDomainGetName(dom), from);
1341
#ifndef WIN32
1342
        if (console)
1343
            cmdRunConsole(ctl, dom, NULL);
1344
#endif
1345
        virDomainFree(dom);
1346
    } else {
1347
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1348
        ret = false;
1349 1350 1351 1352
    }
    return ret;
}

1353 1354 1355
/*
 * "define" command
 */
1356
static const vshCmdInfo info_define[] = {
1357 1358
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1359 1360 1361
    {NULL, NULL}
};

1362
static const vshCmdOptDef opts_define[] = {
1363
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1364 1365 1366
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1367
static bool
1368
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1369 1370
{
    virDomainPtr dom;
1371
    const char *from = NULL;
E
Eric Blake 已提交
1372
    bool ret = true;
1373
    char *buffer;
1374

1375
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1376
        return false;
1377

1378
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1379
        return false;
1380

1381
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1382
        return false;
1383 1384

    dom = virDomainDefineXML(ctl->conn, buffer);
1385
    VIR_FREE(buffer);
1386

1387
    if (dom != NULL) {
1388
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1389
                 virDomainGetName(dom), from);
1390
        virDomainFree(dom);
1391
    } else {
1392
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1393
        ret = false;
1394 1395 1396 1397 1398 1399 1400
    }
    return ret;
}

/*
 * "undefine" command
 */
1401
static const vshCmdInfo info_undefine[] = {
1402 1403
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1404 1405 1406
    {NULL, NULL}
};

1407
static const vshCmdOptDef opts_undefine[] = {
1408
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1409 1410 1411
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1412
static bool
1413
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1414 1415
{
    virDomainPtr dom;
E
Eric Blake 已提交
1416
    bool ret = true;
1417
    const char *name = NULL;
1418
    int id;
1419

1420
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1421
        return false;
1422

1423
    if (vshCommandOptString(cmd, "domain", &name) <= 0)
E
Eric Blake 已提交
1424
        return false;
1425 1426 1427

    if (name && virStrToLong_i(name, NULL, 10, &id) == 0
        && id >= 0 && (dom = virDomainLookupByID(ctl->conn, id))) {
1428 1429 1430 1431 1432
        vshError(ctl,
                 _("a running domain like %s cannot be undefined;\n"
                   "to undefine, first shutdown then undefine"
                   " using its name or UUID"),
                 name);
1433
        virDomainFree(dom);
E
Eric Blake 已提交
1434
        return false;
1435
    }
J
Jim Meyering 已提交
1436
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
1437
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
1438
        return false;
1439 1440

    if (virDomainUndefine(dom) == 0) {
1441
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1442
    } else {
1443
        vshError(ctl, _("Failed to undefine domain %s"), name);
E
Eric Blake 已提交
1444
        ret = false;
1445 1446
    }

1447
    virDomainFree(dom);
1448 1449 1450 1451 1452 1453 1454
    return ret;
}


/*
 * "start" command
 */
1455
static const vshCmdInfo info_start[] = {
1456
    {"help", N_("start a (previously defined) inactive domain")},
1457 1458 1459
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1460 1461 1462
    {NULL, NULL}
};

1463
static const vshCmdOptDef opts_start[] = {
1464
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1465
#ifndef WIN32
1466
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1467
#endif
E
Eric Blake 已提交
1468
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1469 1470 1471
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1472
static bool
1473
cmdStart(vshControl *ctl, const vshCmd *cmd)
1474 1475
{
    virDomainPtr dom;
E
Eric Blake 已提交
1476
    bool ret = true;
1477
#ifndef WIN32
1478
    int console = vshCommandOptBool(cmd, "console");
1479
#endif
E
Eric Blake 已提交
1480
    unsigned int flags = VIR_DOMAIN_NONE;
1481

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

1485 1486
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
1487
        return false;
1488 1489

    if (virDomainGetID(dom) != (unsigned int)-1) {
1490
        vshError(ctl, "%s", _("Domain is already active"));
1491
        virDomainFree(dom);
E
Eric Blake 已提交
1492
        return false;
1493 1494
    }

E
Eric Blake 已提交
1495 1496 1497 1498 1499 1500
    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) {
1501
        vshPrint(ctl, _("Domain %s started\n"),
1502
                 virDomainGetName(dom));
1503
#ifndef WIN32
1504
        if (console)
1505
            cmdRunConsole(ctl, dom, NULL);
1506
#endif
1507
    } else {
1508
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
E
Eric Blake 已提交
1509
        ret = false;
1510
    }
1511
    virDomainFree(dom);
1512 1513 1514
    return ret;
}

1515 1516 1517
/*
 * "save" command
 */
1518
static const vshCmdInfo info_save[] = {
1519 1520
    {"help", N_("save a domain state to a file")},
    {"desc", N_("Save a running domain.")},
1521
    {NULL, NULL}
1522 1523
};

1524
static const vshCmdOptDef opts_save[] = {
1525 1526
    {"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")},
1527
    {NULL, 0, 0, NULL}
1528 1529
};

E
Eric Blake 已提交
1530
static bool
1531
cmdSave(vshControl *ctl, const vshCmd *cmd)
1532
{
1533
    virDomainPtr dom;
1534 1535
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1536
    bool ret = true;
1537

1538
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1539
        return false;
1540

1541
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1542
        return false;
1543

J
Jim Meyering 已提交
1544
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1545
        return false;
1546 1547

    if (virDomainSave(dom, to) == 0) {
1548
        vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
1549
    } else {
1550
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
E
Eric Blake 已提交
1551
        ret = false;
1552
    }
1553

1554 1555 1556 1557
    virDomainFree(dom);
    return ret;
}

1558 1559 1560 1561 1562
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1563 1564 1565 1566
    {"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.")},
1567 1568 1569 1570 1571 1572 1573 1574
    {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 已提交
1575
static bool
1576 1577 1578
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1579
    const char *name;
E
Eric Blake 已提交
1580
    bool ret = true;
1581

1582
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1583
        return false;
1584 1585

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1586
        return false;
1587 1588 1589 1590 1591

    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 已提交
1592
        ret = false;
1593 1594 1595 1596 1597 1598
    }

    virDomainFree(dom);
    return ret;
}

1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612
/*
 * "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 已提交
1613
static bool
1614 1615 1616
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1617
    const char *name;
E
Eric Blake 已提交
1618
    bool ret = false;
1619 1620
    int hassave;

1621
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1622
        return false;
1623 1624

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1625
        return false;
1626 1627 1628

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1629
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645
        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 已提交
1646
    ret = true;
1647 1648 1649 1650 1651 1652

cleanup:
    virDomainFree(dom);
    return ret;
}

1653 1654 1655
/*
 * "schedinfo" command
 */
1656
static const vshCmdInfo info_schedinfo[] = {
1657 1658
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1659 1660 1661
    {NULL, NULL}
};

1662
static const vshCmdOptDef opts_schedinfo[] = {
1663 1664 1665 1666
    {"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")},
1667 1668 1669
    {"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")},
1670 1671 1672
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
1673
static int
1674
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
1675
                   virTypedParameterPtr param)
1676
{
1677
    const char *data = NULL;
1678 1679 1680

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
1681
        param->type == VIR_TYPED_PARAM_UINT &&
1682 1683
        vshCommandOptBool(cmd, "weight")) {
        int val;
1684
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
1685
            vshError(ctl, "%s", _("Invalid value of weight"));
1686
            return -1;
1687
        } else {
1688
            param->value.ui = val;
1689
        }
1690
        return 1;
1691 1692
    }

1693 1694
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
1695
        param->type == VIR_TYPED_PARAM_UINT &&
1696 1697
        vshCommandOptBool(cmd, "cap")) {
        int val;
1698
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
1699
            vshError(ctl, "%s", _("Invalid value of cap"));
1700
            return -1;
1701
        } else {
1702
            param->value.ui = val;
1703
        }
1704
        return 1;
1705
    }
1706

1707
    if (vshCommandOptString(cmd, "set", &data) > 0) {
1708 1709 1710
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
1711
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
1712
            return -1;
1713
        }
1714 1715 1716 1717 1718 1719 1720 1721 1722
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
1723
        case VIR_TYPED_PARAM_INT:
1724
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
1725
                vshError(ctl, "%s",
1726 1727 1728 1729
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
1730
        case VIR_TYPED_PARAM_UINT:
1731
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
1732
                vshError(ctl, "%s",
1733 1734 1735 1736
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
1737
        case VIR_TYPED_PARAM_LLONG:
1738
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
1739
                vshError(ctl, "%s",
J
Jim Meyering 已提交
1740
                         _("Invalid value for parameter, expecting a long long"));
1741 1742 1743
                return -1;
            }
            break;
1744
        case VIR_TYPED_PARAM_ULLONG:
1745
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
1746
                vshError(ctl, "%s",
1747 1748 1749 1750
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
1751
        case VIR_TYPED_PARAM_DOUBLE:
1752
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
1753
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
1754 1755 1756
                return -1;
            }
            break;
1757
        case VIR_TYPED_PARAM_BOOLEAN:
1758
            param->value.b = STREQ(val, "0") ? 0 : 1;
1759
        }
1760
        return 1;
1761
    }
1762

1763 1764
    return 0;
}
1765

1766

E
Eric Blake 已提交
1767
static bool
1768 1769 1770 1771
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
1772
    virTypedParameterPtr params = NULL;
1773 1774 1775
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
1776
    bool ret_val = false;
1777 1778 1779 1780 1781 1782 1783 1784 1785 1786
    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;
        }
1787
        flags = VIR_DOMAIN_AFFECT_CURRENT;
1788 1789
    } else {
        if (config)
1790
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
1791
        if (live)
1792
            flags |= VIR_DOMAIN_AFFECT_LIVE;
1793
    }
1794

1795
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1796
        return false;
1797

1798
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
1799
        return false;
1800 1801 1802

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
1803
    if (schedulertype != NULL) {
1804
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
1805
             schedulertype);
1806
        VIR_FREE(schedulertype);
1807
    } else {
1808
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
1809
        goto cleanup;
1810 1811
    }

1812
    if (nparams) {
1813
        params = vshMalloc(ctl, sizeof(*params) * nparams);
1814

1815
        memset(params, 0, sizeof(*params) * nparams);
1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826
        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);
        }
1827 1828 1829 1830
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
1831
        for (i = 0; i < nparams; i++) {
1832 1833 1834 1835 1836 1837 1838 1839 1840 1841
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
1842 1843 1844 1845 1846
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
1847 1848 1849
            if (ret == -1)
                goto cleanup;

1850 1851 1852 1853 1854 1855 1856
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
1857 1858
            if (ret == -1)
                goto cleanup;
1859 1860 1861 1862
        } 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.  */
1863 1864
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
1865 1866 1867 1868
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
1869 1870 1871 1872 1873 1874
            /* 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;
            }
1875 1876
        }

E
Eric Blake 已提交
1877
        ret_val = true;
1878
        for (i = 0; i < nparams; i++) {
1879
            switch (params[i].type) {
1880
            case VIR_TYPED_PARAM_INT:
1881
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1882
                 break;
1883
            case VIR_TYPED_PARAM_UINT:
1884
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1885
                 break;
1886
            case VIR_TYPED_PARAM_LLONG:
1887
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1888
                 break;
1889
            case VIR_TYPED_PARAM_ULLONG:
1890
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1891
                 break;
1892
            case VIR_TYPED_PARAM_DOUBLE:
1893
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1894
                 break;
1895
            case VIR_TYPED_PARAM_BOOLEAN:
1896
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
1897 1898
                 break;
            default:
1899
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
1900 1901 1902
            }
        }
    }
1903

1904
 cleanup:
1905
    VIR_FREE(params);
1906
    virDomainFree(dom);
1907
    return ret_val;
1908 1909
}

1910 1911 1912
/*
 * "restore" command
 */
1913
static const vshCmdInfo info_restore[] = {
1914 1915
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
1916
    {NULL, NULL}
1917 1918
};

1919
static const vshCmdOptDef opts_restore[] = {
1920
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
1921
    {NULL, 0, 0, NULL}
1922 1923
};

E
Eric Blake 已提交
1924
static bool
1925
cmdRestore(vshControl *ctl, const vshCmd *cmd)
1926
{
1927
    const char *from = NULL;
E
Eric Blake 已提交
1928
    bool ret = true;
1929

1930
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1931
        return false;
1932

1933
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1934
        return false;
1935 1936

    if (virDomainRestore(ctl->conn, from) == 0) {
1937
        vshPrint(ctl, _("Domain restored from %s\n"), from);
1938
    } else {
1939
        vshError(ctl, _("Failed to restore domain from %s"), from);
E
Eric Blake 已提交
1940
        ret = false;
1941 1942 1943 1944
    }
    return ret;
}

D
Daniel Veillard 已提交
1945 1946 1947
/*
 * "dump" command
 */
1948
static const vshCmdInfo info_dump[] = {
1949 1950
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
1951 1952 1953
    {NULL, NULL}
};

1954
static const vshCmdOptDef opts_dump[] = {
1955 1956 1957 1958
    {"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 已提交
1959 1960 1961
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1962
static bool
1963
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
1964 1965
{
    virDomainPtr dom;
1966 1967
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1968
    bool ret = true;
1969
    int flags = 0;
D
Daniel Veillard 已提交
1970

1971
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1972
        return false;
D
Daniel Veillard 已提交
1973

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

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

P
Paolo Bonzini 已提交
1980 1981
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
1982 1983 1984 1985
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;

    if (virDomainCoreDump(dom, to, flags) == 0) {
1986
        vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
D
Daniel Veillard 已提交
1987
    } else {
1988
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
E
Eric Blake 已提交
1989
        ret = false;
D
Daniel Veillard 已提交
1990 1991 1992 1993 1994 1995
    }

    virDomainFree(dom);
    return ret;
}

1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142
static const vshCmdInfo info_screenshot[] = {
    {"help", N_("take a screenshot of a current domain console and store it "
                "into a file")},
    {"desc", N_("screenshot of a current domain console")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_screenshot[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"file", VSH_OT_DATA, VSH_OFLAG_NONE, N_("where to store the screenshot")},
    {"screen", VSH_OT_INT, VSH_OFLAG_NONE, N_("ID of a screen to take screenshot of")},
    {NULL, 0, 0, NULL}
};

static int vshStreamSink(virStreamPtr st ATTRIBUTE_UNUSED,
                         const char *bytes, size_t nbytes, void *opaque)
{
    int *fd = opaque;

    return safewrite(*fd, bytes, nbytes);
}

/**
 * Generate string: '<domain name>-<timestamp>[<extension>]'
 */
static char *
vshGenFileName(vshControl *ctl, virDomainPtr dom, const char *mime)
{
    char timestr[100];
    struct timeval cur_time;
    struct tm time_info;
    const char *ext = NULL;
    char *ret = NULL;

    /* We should be already connected, but doesn't
     * hurt to check */
    if (!vshConnectionUsability(ctl, ctl->conn))
        return NULL;

    if (!dom) {
        vshError(ctl, "%s", _("Invalid domain supplied"));
        return NULL;
    }

    if (STREQ(mime, "image/x-portable-pixmap"))
        ext = ".ppm";
    else if (STREQ(mime, "image/png"))
        ext = ".png";
    /* add mime type here */

    gettimeofday(&cur_time, NULL);
    localtime_r(&cur_time.tv_sec, &time_info);
    strftime(timestr, sizeof(timestr), "%Y-%m-%d-%H:%M:%S", &time_info);

    if (virAsprintf(&ret, "%s-%s%s", virDomainGetName(dom),
                    timestr, ext ? ext : "") < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        return NULL;
    }

    return ret;
}

static bool
cmdScreenshot(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name = NULL;
    char *file = NULL;
    int fd = -1;
    virStreamPtr st = NULL;
    unsigned int screen = 0;
    unsigned int flags = 0; /* currently unused */
    int ret = false;
    bool created = true;
    bool generated = false;
    char *mime = NULL;

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

    if (vshCommandOptString(cmd, "file", (const char **) &file) < 0) {
        vshError(ctl, "%s", _("file must not be empty"));
        return false;
    }

    if (vshCommandOptUInt(cmd, "screen", &screen) < 0) {
        vshError(ctl, "%s", _("invalid screen ID"));
        return false;
    }

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

    st = virStreamNew(ctl->conn, 0);

    mime = virDomainScreenshot(dom, st, screen, flags);
    if (!mime) {
        vshError(ctl, _("could not take a screenshot of %s"), name);
        goto cleanup;
    }

    if (!file) {
        if (!(file=vshGenFileName(ctl, dom, mime)))
            return false;
        generated = true;
    }

    if ((fd = open(file, O_WRONLY|O_CREAT|O_EXCL, 0666)) < 0) {
        created = false;
        if (errno != EEXIST ||
            (fd = open(file, O_WRONLY|O_TRUNC, 0666)) < 0) {
            vshError(ctl, _("cannot create file %s"), file);
            goto cleanup;
        }
    }

    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
        vshError(ctl, _("could not receive data from domain %s"), name);
        goto cleanup;
    }

    if (VIR_CLOSE(fd) < 0) {
        vshError(ctl, _("cannot close file %s"), file);
        goto cleanup;
    }

    if (virStreamFinish(st) < 0) {
        vshError(ctl, _("cannot close stream on domain %s"), name);
        goto cleanup;
    }

    vshPrint(ctl, _("Screenshot saved to %s, with type of %s"), file, mime);
    ret = true;

cleanup:
    if (!ret && created)
        unlink(file);
    if (generated)
        VIR_FREE(file);
    virDomainFree(dom);
    if (st)
        virStreamFree(st);
    VIR_FORCE_CLOSE(fd);
    return ret;
}

2143 2144 2145
/*
 * "resume" command
 */
2146
static const vshCmdInfo info_resume[] = {
2147 2148
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
2149
    {NULL, NULL}
2150 2151
};

2152
static const vshCmdOptDef opts_resume[] = {
2153
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2154
    {NULL, 0, 0, NULL}
2155 2156
};

E
Eric Blake 已提交
2157
static bool
2158
cmdResume(vshControl *ctl, const vshCmd *cmd)
2159
{
2160
    virDomainPtr dom;
E
Eric Blake 已提交
2161
    bool ret = true;
2162
    const char *name;
2163

2164
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2165
        return false;
2166

J
Jim Meyering 已提交
2167
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2168
        return false;
2169 2170

    if (virDomainResume(dom) == 0) {
2171
        vshPrint(ctl, _("Domain %s resumed\n"), name);
2172
    } else {
2173
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
2174
        ret = false;
2175
    }
2176

2177 2178 2179 2180
    virDomainFree(dom);
    return ret;
}

2181 2182 2183
/*
 * "shutdown" command
 */
2184
static const vshCmdInfo info_shutdown[] = {
2185 2186
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
2187
    {NULL, NULL}
2188 2189
};

2190
static const vshCmdOptDef opts_shutdown[] = {
2191
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2192
    {NULL, 0, 0, NULL}
2193 2194
};

E
Eric Blake 已提交
2195
static bool
2196
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
2197
{
2198
    virDomainPtr dom;
E
Eric Blake 已提交
2199
    bool ret = true;
2200
    const char *name;
2201

2202
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2203
        return false;
2204

J
Jim Meyering 已提交
2205
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2206
        return false;
2207 2208

    if (virDomainShutdown(dom) == 0) {
2209
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
2210
    } else {
2211
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
2212
        ret = false;
2213
    }
2214

2215 2216 2217 2218
    virDomainFree(dom);
    return ret;
}

2219 2220 2221
/*
 * "reboot" command
 */
2222
static const vshCmdInfo info_reboot[] = {
2223 2224
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
2225 2226 2227
    {NULL, NULL}
};

2228
static const vshCmdOptDef opts_reboot[] = {
2229
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2230 2231 2232
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2233
static bool
2234
cmdReboot(vshControl *ctl, const vshCmd *cmd)
2235 2236
{
    virDomainPtr dom;
E
Eric Blake 已提交
2237
    bool ret = true;
2238
    const char *name;
2239

2240
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2241
        return false;
2242

J
Jim Meyering 已提交
2243
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2244
        return false;
2245 2246

    if (virDomainReboot(dom, 0) == 0) {
2247
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
2248
    } else {
2249
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
2250
        ret = false;
2251 2252 2253 2254 2255 2256
    }

    virDomainFree(dom);
    return ret;
}

2257 2258 2259
/*
 * "destroy" command
 */
2260
static const vshCmdInfo info_destroy[] = {
2261 2262
    {"help", N_("destroy a domain")},
    {"desc", N_("Destroy a given domain.")},
2263
    {NULL, NULL}
2264 2265
};

2266
static const vshCmdOptDef opts_destroy[] = {
2267
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2268
    {NULL, 0, 0, NULL}
2269 2270
};

E
Eric Blake 已提交
2271
static bool
2272
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2273
{
2274
    virDomainPtr dom;
E
Eric Blake 已提交
2275
    bool ret = true;
2276
    const char *name;
2277

2278
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2279
        return false;
2280

J
Jim Meyering 已提交
2281
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2282
        return false;
2283 2284

    if (virDomainDestroy(dom) == 0) {
2285
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2286
    } else {
2287
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
2288
        ret = false;
2289
    }
2290

2291
    virDomainFree(dom);
K
Karel Zak 已提交
2292 2293 2294 2295
    return ret;
}

/*
2296
 * "dominfo" command
K
Karel Zak 已提交
2297
 */
2298
static const vshCmdInfo info_dominfo[] = {
2299 2300
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2301
    {NULL, NULL}
K
Karel Zak 已提交
2302 2303
};

2304
static const vshCmdOptDef opts_dominfo[] = {
2305
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2306
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2307 2308
};

E
Eric Blake 已提交
2309
static bool
2310
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2311
{
K
Karel Zak 已提交
2312 2313
    virDomainInfo info;
    virDomainPtr dom;
2314
    virSecurityModel secmodel;
2315
    virSecurityLabelPtr seclabel;
2316
    int persistent = 0;
E
Eric Blake 已提交
2317 2318
    bool ret = true;
    int autostart;
2319
    unsigned int id;
2320
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2321

2322
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2323
        return false;
K
Karel Zak 已提交
2324

J
Jim Meyering 已提交
2325
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2326
        return false;
2327

2328 2329
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2330
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2331
    else
2332
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2333 2334
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2335
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2336
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2337 2338

    if ((str = virDomainGetOSType(dom))) {
2339
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2340
        VIR_FREE(str);
2341 2342 2343
    }

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

2347
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2348 2349

        if (info.cpuTime != 0) {
2350
            double cpuUsed = info.cpuTime;
2351

2352
            cpuUsed /= 1000000000.0;
2353

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

2357 2358
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2359
                 info.maxMem);
2360
        else
2361
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2362 2363
                 _("no limit"));

2364
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2365 2366
                 info.memory);

K
Karel Zak 已提交
2367
    } else {
E
Eric Blake 已提交
2368
        ret = false;
K
Karel Zak 已提交
2369
    }
2370

2371 2372 2373 2374 2375 2376 2377 2378 2379
    /* 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 */
2380
    if (!virDomainGetAutostart(dom, &autostart)) {
2381
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2382 2383 2384
                 autostart ? _("enable") : _("disable") );
    }

2385 2386 2387
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2388 2389
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
2390
            return false;
2391 2392 2393
        } else {
            virFreeError(last_error);
            last_error = NULL;
2394
        }
2395 2396 2397 2398 2399 2400 2401
    } 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 */
2402
            if (VIR_ALLOC(seclabel) < 0) {
2403
                virDomainFree(dom);
E
Eric Blake 已提交
2404
                return false;
2405 2406 2407 2408 2409
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
2410
                return false;
2411
            } else {
2412
                if (seclabel->label[0] != '\0')
2413
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
2414
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
2415
            }
2416 2417

            VIR_FREE(seclabel);
2418 2419
        }
    }
2420
    virDomainFree(dom);
K
Karel Zak 已提交
2421 2422 2423
    return ret;
}

2424 2425 2426 2427
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2428 2429
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2430 2431 2432 2433
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2434
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2435 2436 2437 2438
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
2439
static bool
2440 2441 2442 2443
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
2444
    bool ret = true;
2445

2446
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2447
        return false;
2448 2449

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2450
        return false;
2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476

    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 已提交
2477
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2478
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2479
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2480
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2481
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2482 2483 2484
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2485
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2486
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2487
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2488
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2489
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2490 2491 2492
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2493
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2494
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2495
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2496
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2497
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2498 2499
        }
    } else {
E
Eric Blake 已提交
2500
        ret = false;
2501 2502 2503 2504 2505 2506
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2507 2508 2509 2510
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2511 2512
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2513 2514 2515 2516
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2517
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2518 2519 2520
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2521
static bool
2522 2523 2524
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2525
    bool ret = true;
2526

2527
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2528
        return false;
2529 2530

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
2534
        ret = false;
2535 2536 2537 2538 2539

    virDomainFree(dom);
    return ret;
}

2540 2541 2542
/*
 * "freecell" command
 */
2543
static const vshCmdInfo info_freecell[] = {
2544 2545
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2546 2547 2548
    {NULL, NULL}
};

2549
static const vshCmdOptDef opts_freecell[] = {
2550
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2551
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
2552 2553 2554
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2555
static bool
2556
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2557
{
W
Wen Congyang 已提交
2558
    bool func_ret = false;
2559
    int ret;
2560
    int cell = -1, cell_given;
2561
    unsigned long long memory;
2562 2563 2564 2565
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
2566
    int all_given;
2567 2568 2569 2570
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
2571

2572

2573
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2574
        return false;
2575

2576 2577 2578 2579
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
2580 2581 2582 2583 2584 2585 2586 2587 2588
    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) {
2589 2590 2591
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2592 2593 2594
            goto cleanup;
        }

2595 2596 2597
        xml = xmlReadDoc((const xmlChar *) cap_xml, "node.xml", NULL,
                          XML_PARSE_NOENT | XML_PARSE_NONET |
                          XML_PARSE_NOWARNING);
2598

2599 2600
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2601 2602 2603
            goto cleanup;
        }

2604 2605 2606 2607 2608
        ctxt = xmlXPathNewContext(xml);
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
2609
            vshError(ctl, "%s", _("could not get information about "
2610
                                  "NUMA topology"));
2611 2612 2613
            goto cleanup;
        }

2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634
        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;
            }
        }

2635
        memory = 0;
2636 2637 2638 2639
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
2640 2641 2642 2643
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
2644
    } else {
2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658
        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));
2659 2660
    }

E
Eric Blake 已提交
2661
    func_ret = true;
2662

2663
cleanup:
2664 2665 2666
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
2667
    VIR_FREE(nodes);
2668 2669 2670
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
2671
    return func_ret;
2672 2673
}

E
Eric Blake 已提交
2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687
/*
 * "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 已提交
2688
static bool
E
Eric Blake 已提交
2689 2690
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
2691
    const char *type = NULL;
E
Eric Blake 已提交
2692 2693
    int vcpus;

2694 2695
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
2696
        return false;
2697
    }
E
Eric Blake 已提交
2698 2699

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2700
        return false;
E
Eric Blake 已提交
2701 2702 2703

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

E
Eric Blake 已提交
2707
    return true;
E
Eric Blake 已提交
2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727
}

/*
 * "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 已提交
2728
static bool
E
Eric Blake 已提交
2729 2730 2731
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2732
    bool ret = true;
E
Eric Blake 已提交
2733 2734 2735 2736 2737 2738 2739 2740 2741 2742
    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 已提交
2743
        return false;
E
Eric Blake 已提交
2744 2745 2746 2747
    }
    if (config && live) {
        vshError(ctl, "%s",
                 _("--config and --live cannot both be specified"));
E
Eric Blake 已提交
2748
        return false;
E
Eric Blake 已提交
2749 2750 2751 2752 2753 2754 2755 2756 2757 2758
    }
    /* 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 已提交
2759
        return false;
E
Eric Blake 已提交
2760 2761 2762
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2763
        return false;
E
Eric Blake 已提交
2764 2765

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2766
        return false;
E
Eric Blake 已提交
2767 2768 2769 2770 2771 2772

    /* 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 |
2773
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
2774 2775 2776 2777 2778 2779 2780 2781 2782
        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;
            }
2783 2784
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
2785 2786 2787 2788 2789
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2790
            ret = false;
E
Eric Blake 已提交
2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802
        } 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 |
2803
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
2804 2805 2806 2807 2808 2809 2810
        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 已提交
2811
            ret = false;
E
Eric Blake 已提交
2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822
        } 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)) {
2823
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847
        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 已提交
2848
            ret = false;
E
Eric Blake 已提交
2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859
        } 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)) {
2860
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
2861 2862 2863 2864 2865 2866 2867 2868 2869
        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 已提交
2870
            ret = false;
E
Eric Blake 已提交
2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884
        } 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;
}

2885 2886 2887
/*
 * "vcpuinfo" command
 */
2888
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
2889
    {"help", N_("detailed domain vcpu information")},
2890
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
2891 2892 2893
    {NULL, NULL}
};

2894
static const vshCmdOptDef opts_vcpuinfo[] = {
2895
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2896 2897 2898
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2899
static bool
2900
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
2901 2902 2903 2904 2905 2906 2907 2908
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
    unsigned char *cpumap;
    int ncpus;
    size_t cpumaplen;
E
Eric Blake 已提交
2909
    bool ret = true;
2910

2911
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2912
        return false;
2913

J
Jim Meyering 已提交
2914
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2915
        return false;
2916 2917 2918

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2919
        return false;
2920 2921 2922 2923
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2924
        return false;
2925 2926
    }

2927
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
2928
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
2929
    cpumap = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
2930

2931 2932 2933
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
                                   cpumap, cpumaplen)) >= 0) {
2934
        int n;
2935 2936 2937 2938 2939
        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 已提交
2940
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956
            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");
            }
        }
2957
    } else {
2958
        if (info.state == VIR_DOMAIN_SHUTOFF) {
2959 2960
            vshError(ctl, "%s",
                     _("Domain shut off, virtual CPUs not present."));
2961
        }
E
Eric Blake 已提交
2962
        ret = false;
2963 2964
    }

2965 2966
    VIR_FREE(cpumap);
    VIR_FREE(cpuinfo);
2967 2968 2969 2970 2971 2972 2973
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
2974
static const vshCmdInfo info_vcpupin[] = {
2975 2976
    {"help", N_("control domain vcpu affinity")},
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
2977 2978 2979
    {NULL, NULL}
};

2980
static const vshCmdOptDef opts_vcpupin[] = {
2981
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2982
    {"vcpu", VSH_OT_INT, VSH_OFLAG_REQ, N_("vcpu number")},
2983
    {"cpulist", VSH_OT_DATA, VSH_OFLAG_REQ, N_("host cpu number(s) (comma separated)")},
2984 2985 2986
    {"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")},
2987 2988 2989
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2990
static bool
2991
cmdVcpupin(vshControl *ctl, const vshCmd *cmd)
2992 2993 2994 2995 2996
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    int vcpu;
2997
    const char *cpulist = NULL;
E
Eric Blake 已提交
2998
    bool ret = true;
2999 3000
    unsigned char *cpumap;
    int cpumaplen;
3001 3002
    int i;
    enum { expect_num, expect_num_or_comma } state;
3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
    int flags = 0;

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
            return false;
        }
        flags = VIR_DOMAIN_AFFECT_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_AFFECT_LIVE;
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
3023

3024
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3025
        return false;
3026

J
Jim Meyering 已提交
3027
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3028
        return false;
3029

3030
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) <= 0) {
3031
        vshError(ctl, "%s", _("vcpupin: Invalid or missing vCPU number."));
3032
        virDomainFree(dom);
E
Eric Blake 已提交
3033
        return false;
3034 3035
    }

3036
    if (vshCommandOptString(cmd, "cpulist", &cpulist) <= 0) {
3037
        virDomainFree(dom);
E
Eric Blake 已提交
3038
        return false;
3039
    }
3040

3041 3042
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3043
        return false;
3044 3045 3046
    }

    if (virDomainGetInfo(dom, &info) != 0) {
3047
        vshError(ctl, "%s", _("vcpupin: failed to get domain informations."));
3048
        virDomainFree(dom);
E
Eric Blake 已提交
3049
        return false;
3050 3051 3052
    }

    if (vcpu >= info.nrVirtCpu) {
3053
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
3054
        virDomainFree(dom);
E
Eric Blake 已提交
3055
        return false;
3056 3057
    }

3058 3059 3060 3061
    /* Check that the cpulist parameter is a comma-separated list of
     * numbers and give an intelligent error message if not.
     */
    if (cpulist[0] == '\0') {
3062
        vshError(ctl, "%s", _("cpulist: Invalid format. Empty string."));
3063
        virDomainFree (dom);
E
Eric Blake 已提交
3064
        return false;
3065 3066 3067 3068 3069 3070
    }

    state = expect_num;
    for (i = 0; cpulist[i]; i++) {
        switch (state) {
        case expect_num:
3071
          if (!c_isdigit (cpulist[i])) {
3072 3073 3074
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
3075
                virDomainFree (dom);
E
Eric Blake 已提交
3076
                return false;
3077 3078 3079 3080 3081 3082
            }
            state = expect_num_or_comma;
            break;
        case expect_num_or_comma:
            if (cpulist[i] == ',')
                state = expect_num;
3083
            else if (!c_isdigit (cpulist[i])) {
3084 3085 3086
                vshError(ctl, _("cpulist: %s: Invalid format. Expecting "
                                "digit or comma at position %d (near '%c')."),
                         cpulist, i, cpulist[i]);
3087
                virDomainFree (dom);
E
Eric Blake 已提交
3088
                return false;
3089 3090 3091 3092
            }
        }
    }
    if (state == expect_num) {
3093 3094 3095
        vshError(ctl, _("cpulist: %s: Invalid format. Trailing comma "
                        "at position %d."),
                 cpulist, i);
3096
        virDomainFree (dom);
E
Eric Blake 已提交
3097
        return false;
3098 3099
    }

3100
    cpumaplen = VIR_CPU_MAPLEN(VIR_NODEINFO_MAXCPUS(nodeinfo));
3101
    cpumap = vshCalloc(ctl, 1, cpumaplen);
3102 3103 3104 3105 3106 3107

    do {
        unsigned int cpu = atoi(cpulist);

        if (cpu < VIR_NODEINFO_MAXCPUS(nodeinfo)) {
            VIR_USE_CPU(cpumap, cpu);
3108
        } else {
3109
            vshError(ctl, _("Physical CPU %d doesn't exist."), cpu);
3110
            VIR_FREE(cpumap);
3111
            virDomainFree(dom);
E
Eric Blake 已提交
3112
            return false;
3113
        }
3114
        cpulist = strchr(cpulist, ',');
3115 3116 3117 3118
        if (cpulist)
            cpulist++;
    } while (cpulist);

3119 3120 3121 3122 3123 3124 3125 3126
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
3127 3128
    }

3129
    VIR_FREE(cpumap);
3130 3131 3132 3133
    virDomainFree(dom);
    return ret;
}

3134 3135 3136
/*
 * "setvcpus" command
 */
3137
static const vshCmdInfo info_setvcpus[] = {
3138 3139
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
3140 3141 3142
    {NULL, NULL}
};

3143
static const vshCmdOptDef opts_setvcpus[] = {
3144
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3145
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
3146 3147 3148
    {"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")},
3149 3150 3151
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3152
static bool
3153
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
3154 3155
{
    virDomainPtr dom;
3156
    int count = 0;
E
Eric Blake 已提交
3157
    bool ret = true;
E
Eric Blake 已提交
3158 3159 3160 3161
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int flags = ((maximum ? VIR_DOMAIN_VCPU_MAXIMUM : 0) |
3162 3163
                 (config ? VIR_DOMAIN_AFFECT_CONFIG : 0) |
                 (live ? VIR_DOMAIN_AFFECT_LIVE : 0));
3164

3165
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3166
        return false;
3167

J
Jim Meyering 已提交
3168
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3169
        return false;
3170

3171 3172 3173 3174
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
3175

E
Eric Blake 已提交
3176 3177
    if (!flags) {
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
3178
            ret = false;
E
Eric Blake 已提交
3179 3180
        }
    } else {
3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193
        /* 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 已提交
3194
                ret = false;
3195 3196 3197 3198 3199
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
3200
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
3201
            ret = false;
E
Eric Blake 已提交
3202
        }
3203 3204
    }

3205
  cleanup:
3206 3207 3208 3209
    virDomainFree(dom);
    return ret;
}

3210 3211 3212 3213 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 3240 3241 3242 3243
/*
 * "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;
}

3244 3245 3246
/*
 * "setmemory" command
 */
3247
static const vshCmdInfo info_setmem[] = {
3248 3249
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
3250 3251 3252
    {NULL, NULL}
};

3253
static const vshCmdOptDef opts_setmem[] = {
3254
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3255
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
3256 3257
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
3258
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3259 3260 3261
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3262
static bool
3263
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
3264 3265
{
    virDomainPtr dom;
3266
    virDomainInfo info;
3267
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
3268
    bool ret = true;
3269 3270
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3271
    int current = vshCommandOptBool(cmd, "current");
3272 3273
    int flags = 0;

3274 3275 3276
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3277
            return false;
3278
        }
3279
        flags = VIR_DOMAIN_AFFECT_CURRENT;
3280 3281
    } else {
        if (config)
3282
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3283
        if (live)
3284
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3285 3286 3287
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
3288
    }
3289

3290
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3291
        return false;
3292

J
Jim Meyering 已提交
3293
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3294
        return false;
3295

3296 3297
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3298
        return false;
3299 3300
    }

3301
    if (kilobytes <= 0) {
3302
        virDomainFree(dom);
3303
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
3304
        return false;
3305 3306
    }

3307 3308
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
3309
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
3310
        return false;
3311 3312 3313 3314
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
3315
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
3316
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
3317
        return false;
3318 3319
    }

3320
    if (flags == -1) {
3321
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
3322
            ret = false;
3323 3324 3325
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
3326
            ret = false;
3327
        }
3328 3329 3330 3331 3332 3333 3334 3335 3336
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
3337
static const vshCmdInfo info_setmaxmem[] = {
3338 3339
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
3340 3341 3342
    {NULL, NULL}
};

3343
static const vshCmdOptDef opts_setmaxmem[] = {
3344
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3345
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
3346 3347 3348
    {"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")},
3349 3350 3351
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3352
static bool
3353
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
3354 3355
{
    virDomainPtr dom;
3356
    int kilobytes = 0;
E
Eric Blake 已提交
3357
    bool ret = true;
3358 3359 3360 3361 3362 3363 3364 3365
    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 已提交
3366
            return false;
3367 3368 3369
        }
    } else {
        if (config)
3370
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3371
        if (live)
3372
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3373 3374 3375 3376
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
3377

3378
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3379
        return false;
3380

J
Jim Meyering 已提交
3381
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3382
        return false;
3383

3384 3385
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3386
        return false;
3387 3388
    }

3389
    if (kilobytes <= 0) {
3390
        virDomainFree(dom);
3391
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
3392
        return false;
3393 3394
    }

3395 3396 3397
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3398
            ret = false;
3399 3400 3401 3402
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3403
            ret = false;
3404
        }
3405 3406
    }

3407 3408 3409 3410
    virDomainFree(dom);
    return ret;
}

3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426
/*
 * "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]")},
H
Hu Tao 已提交
3427 3428 3429
    {"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")},
3430 3431 3432
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3433
static bool
3434 3435 3436 3437 3438 3439
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
    unsigned int i = 0;
3440
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3441
    bool ret = false;
H
Hu Tao 已提交
3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458
    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_AFFECT_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_AFFECT_LIVE;
    }
3459 3460

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3461
        return false;
3462 3463

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3464
        return false;
3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482

    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 */
H
Hu Tao 已提交
3483
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
3484 3485 3486 3487 3488 3489 3490
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3491
            ret = true;
3492 3493 3494 3495 3496
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
3497
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
3498 3499 3500 3501 3502 3503
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
3504
                case VIR_TYPED_PARAM_INT:
3505 3506 3507
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
3508
                case VIR_TYPED_PARAM_UINT:
3509 3510 3511
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
3512
                case VIR_TYPED_PARAM_LLONG:
3513 3514 3515
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
3516
                case VIR_TYPED_PARAM_ULLONG:
3517 3518 3519
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
3520
                case VIR_TYPED_PARAM_DOUBLE:
3521 3522 3523
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
3524
                case VIR_TYPED_PARAM_BOOLEAN:
3525 3526 3527 3528 3529 3530 3531 3532
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
3533
        ret = true;
3534 3535 3536 3537 3538 3539
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
3540
            temp->type = VIR_TYPED_PARAM_UINT;
3541 3542 3543 3544 3545 3546 3547 3548

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
H
Hu Tao 已提交
3549
        if (virDomainSetBlkioParameters(dom, params, nparams, flags) != 0)
3550 3551
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
3552
            ret = true;
3553 3554 3555 3556 3557 3558 3559 3560
    }

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

3561 3562 3563 3564
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
3565 3566 3567
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
3568 3569 3570 3571 3572 3573 3574
                "    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")},
3575
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3576
     N_("Max memory in kilobytes")},
3577
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3578
     N_("Memory during contention in kilobytes")},
3579
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3580
     N_("Max memory plus swap in kilobytes")},
3581
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
3582
     N_("Min guaranteed memory in kilobytes")},
3583 3584 3585
    {"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")},
3586 3587 3588
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3589
static bool
3590 3591 3592
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
3593 3594
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
3595 3596
    int nparams = 0;
    unsigned int i = 0;
3597
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3598
    bool ret = false;
3599 3600 3601 3602 3603 3604 3605 3606 3607 3608
    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;
        }
3609
        flags = VIR_DOMAIN_AFFECT_CURRENT;
3610 3611
    } else {
        if (config)
3612
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3613
        if (live)
3614
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3615
    }
3616 3617

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3618
        return false;
3619 3620

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

3623 3624 3625 3626 3627 3628 3629 3630 3631
    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;
    }

3632 3633 3634 3635 3636 3637 3638 3639 3640
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

3641 3642 3643
    if (min_guarantee)
        nparams++;

3644 3645
    if (nparams == 0) {
        /* get the number of memory parameters */
3646
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
3647 3648 3649 3650 3651
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

3652 3653
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3654
            ret = true;
3655 3656 3657
            goto cleanup;
        }

3658
        /* now go get all the memory parameters */
E
Eric Blake 已提交
3659
        params = vshCalloc(ctl, nparams, sizeof(*params));
3660
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
3661 3662 3663 3664 3665 3666
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
3667
                case VIR_TYPED_PARAM_INT:
3668 3669 3670
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
3671
                case VIR_TYPED_PARAM_UINT:
3672 3673 3674
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
3675
                case VIR_TYPED_PARAM_LLONG:
3676 3677 3678
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
3679
                case VIR_TYPED_PARAM_ULLONG:
3680 3681 3682 3683 3684
                    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);
3685
                    break;
3686
                case VIR_TYPED_PARAM_DOUBLE:
3687 3688 3689
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
3690
                case VIR_TYPED_PARAM_BOOLEAN:
3691 3692 3693 3694
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
3695
                    vshPrint(ctl, "unimplemented memory parameter type\n");
3696 3697 3698
            }
        }

E
Eric Blake 已提交
3699
        ret = true;
3700 3701
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
3702
        params = vshCalloc(ctl, nparams, sizeof(*params));
3703 3704 3705

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
3706
            temp->type = VIR_TYPED_PARAM_ULLONG;
3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725

            /*
             * 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;
3726
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
3727 3728
                        sizeof(temp->field));
                swap_hard_limit = 0;
3729 3730 3731 3732 3733
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
3734
            }
3735 3736 3737 3738

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
3739
        }
3740
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
3741
            vshError(ctl, "%s", _("Unable to change memory parameters"));
3742
        else
E
Eric Blake 已提交
3743
            ret = true;
3744 3745 3746
    }

  cleanup:
E
Eric Blake 已提交
3747
    VIR_FREE(params);
3748 3749 3750 3751
    virDomainFree(dom);
    return ret;
}

3752 3753 3754
/*
 * "nodeinfo" command
 */
3755
static const vshCmdInfo info_nodeinfo[] = {
3756 3757
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
3758 3759 3760
    {NULL, NULL}
};

E
Eric Blake 已提交
3761
static bool
3762
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3763 3764
{
    virNodeInfo info;
3765

3766
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3767
        return false;
3768 3769

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
3770
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
3771
        return false;
3772 3773 3774 3775 3776 3777 3778 3779 3780 3781
    }
    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 已提交
3782
    return true;
3783 3784
}

3785 3786 3787 3788 3789
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
3790
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
3791 3792 3793 3794 3795 3796 3797 3798 3799 3800
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_cpustats[] = {
    {"cpu", VSH_OT_INT, 0, N_("prints specified cpu statistics only.")},
    {"percent", VSH_OT_BOOL, 0, N_("prints by percentage during 1 second.")},
    {NULL, 0, 0, NULL}
};

static bool
3801
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
    int cpuNum = VIR_CPU_STATS_ALL_CPUS;
    virCPUStatsPtr params;
    int nparams = 0;
    bool ret = false;
    struct cpu_stats {
        unsigned long long user;
        unsigned long long sys;
        unsigned long long idle;
        unsigned long long iowait;
        unsigned long long util;
    } cpu_stats[2];
    double user_time, sys_time, idle_time, iowait_time, total_time;
    double usage;

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

    if (vshCommandOptInt(cmd, "cpu", &cpuNum) < 0) {
        vshError(ctl, "%s", _("Invalid value of cpuNum"));
        return false;
    }

    if (virNodeGetCPUStats(ctl->conn, cpuNum, NULL, &nparams, 0) != 0) {
        vshError(ctl, "%s",
                 _("Unable to get number of cpu stats"));
        return false;
    }
    if (nparams == 0) {
        /* nothing to output */
        return true;
    }

    memset(cpu_stats, 0, sizeof(cpu_stats));
    params = vshCalloc(ctl, nparams, sizeof(*params));

    i = 0;
    do {
        if (virNodeGetCPUStats(ctl->conn, cpuNum, params, &nparams, 0) != 0) {
            vshError(ctl, "%s", _("Unable to get node cpu stats"));
            goto cleanup;
        }

        for (j = 0; j < nparams; j++) {
            unsigned long long value = params[j].value;

            if (STREQ(params[j].field, VIR_CPU_STATS_KERNEL)) {
                cpu_stats[i].sys = value;
            } else if (STREQ(params[j].field, VIR_CPU_STATS_USER)) {
                cpu_stats[i].user = value;
            } else if (STREQ(params[j].field, VIR_CPU_STATS_IDLE)) {
                cpu_stats[i].idle = value;
            } else if (STREQ(params[j].field, VIR_CPU_STATS_IOWAIT)) {
                cpu_stats[i].iowait = value;
            } else if (STREQ(params[j].field, VIR_CPU_STATS_UTILIZATION)) {
                cpu_stats[i].util = value;
                flag_utilization = true;
            }
        }

        if (flag_utilization || !flag_percent)
            break;

        i++;
        sleep(1);
    } while (i < 2);

    if (!flag_percent) {
        if (!flag_utilization) {
            vshPrint(ctl, "%-15s %20llu\n", _("user  :"), cpu_stats[0].user);
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
            vshPrint(ctl, "%-15s %20llu\n", _("idle  :"), cpu_stats[0].idle);
            vshPrint(ctl, "%-15s %20llu\n", _("iowait:"), cpu_stats[0].iowait);
        }
    } else {
        if (flag_utilization) {
            usage = cpu_stats[0].util;

            vshPrint(ctl, "%-15s %5.1lf%%\n", _("usage:"), usage);
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle :"), 100 - usage);
        } else {
            user_time   = cpu_stats[1].user   - cpu_stats[0].user;
            sys_time    = cpu_stats[1].sys    - cpu_stats[0].sys;
            idle_time   = cpu_stats[1].idle   - cpu_stats[0].idle;
            iowait_time = cpu_stats[1].iowait - cpu_stats[0].iowait;
            total_time  = user_time + sys_time + idle_time + iowait_time;

            usage = (user_time + sys_time) / total_time * 100;

            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("usage:"), usage);
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("    user  :"), user_time / total_time * 100);
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("    system:"), sys_time  / total_time * 100);
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("idle  :"), idle_time     / total_time * 100);
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974
/*
 * "nodememstats" command
 */
static const vshCmdInfo info_nodememstats[] = {
    {"help", N_("Prints memory stats of the node.")},
    {"desc", N_("Returns memory stats of the node, in kilobytes.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_memstats[] = {
    {"cell", VSH_OT_INT, 0, N_("prints specified cell statistics only.")},
    {NULL, 0, 0, NULL}
};

static bool
cmdNodeMemStats(vshControl *ctl, const vshCmd *cmd)
{
    int nparams = 0;
    unsigned int i = 0;
    int cellNum = VIR_MEMORY_STATS_ALL_CELLS;
    virMemoryStatsPtr params = NULL;
    bool ret = false;

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

    if (vshCommandOptInt(cmd, "cell", &cellNum) < 0) {
        vshError(ctl, "%s", _("Invalid value of cellNum"));
        return false;
    }

    /* get the number of memory parameters */
    if (virNodeGetMemoryStats(ctl->conn, cellNum, NULL, &nparams, 0) != 0) {
        vshError(ctl, "%s",
                 _("Unable to get number of memory stats"));
        goto cleanup;
    }

    if (nparams == 0) {
        /* nothing to output */
        ret = true;
        goto cleanup;
    }

    /* now go get all the memory parameters */
    params = vshCalloc(ctl, nparams, sizeof(*params));
    if (virNodeGetMemoryStats(ctl->conn, cellNum, params, &nparams, 0) != 0) {
        vshError(ctl, "%s", _("Unable to get memory stats"));
        goto cleanup;
    }

    for (i = 0; i < nparams; i++)
        vshPrint(ctl, "%-7s: %20llu kB\n", params[i].field, params[i].value);

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

3975 3976 3977
/*
 * "capabilities" command
 */
3978
static const vshCmdInfo info_capabilities[] = {
3979 3980
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
3981 3982 3983
    {NULL, NULL}
};

E
Eric Blake 已提交
3984
static bool
3985
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3986 3987 3988
{
    char *caps;

3989
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3990
        return false;
3991 3992

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
3993
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
3994
        return false;
3995 3996
    }
    vshPrint (ctl, "%s\n", caps);
3997
    VIR_FREE(caps);
3998

E
Eric Blake 已提交
3999
    return true;
4000 4001
}

4002 4003 4004
/*
 * "dumpxml" command
 */
4005
static const vshCmdInfo info_dumpxml[] = {
4006 4007
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
4008
    {NULL, NULL}
4009 4010
};

4011
static const vshCmdOptDef opts_dumpxml[] = {
4012 4013 4014
    {"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")},
4015
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
4016
    {NULL, 0, 0, NULL}
4017 4018
};

E
Eric Blake 已提交
4019
static bool
4020
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
4021
{
4022
    virDomainPtr dom;
E
Eric Blake 已提交
4023
    bool ret = true;
4024
    char *dump;
4025 4026 4027
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
4028
    int update = vshCommandOptBool(cmd, "update-cpu");
4029 4030 4031 4032 4033

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
4034 4035
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
4036

4037
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4038
        return false;
4039

J
Jim Meyering 已提交
4040
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4041
        return false;
4042

4043
    dump = virDomainGetXMLDesc(dom, flags);
4044
    if (dump != NULL) {
4045
        vshPrint(ctl, "%s", dump);
4046
        VIR_FREE(dump);
4047
    } else {
E
Eric Blake 已提交
4048
        ret = false;
4049
    }
4050

4051 4052 4053 4054
    virDomainFree(dom);
    return ret;
}

4055 4056 4057 4058
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
4059 4060
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
4061 4062 4063 4064
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
4065 4066
    {"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")},
4067 4068 4069
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4070
static bool
4071 4072
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4073
    bool ret = true;
4074 4075
    const char *format = NULL;
    const char *configFile = NULL;
4076 4077 4078 4079
    char *configData;
    char *xmlData;
    int flags = 0;

4080
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4081
        return false;
4082

4083 4084
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
4085
        return false;
4086

4087
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
4088
        return false;
4089 4090 4091

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
4092
        vshPrint(ctl, "%s", xmlData);
4093
        VIR_FREE(xmlData);
4094
    } else {
E
Eric Blake 已提交
4095
        ret = false;
4096 4097 4098 4099 4100 4101 4102 4103 4104
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
4105 4106
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
4107 4108 4109 4110
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
4111 4112
    {"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")},
4113 4114 4115
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4116
static bool
4117 4118
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4119
    bool ret = true;
4120 4121
    const char *format = NULL;
    const char *xmlFile = NULL;
4122 4123 4124 4125
    char *configData;
    char *xmlData;
    int flags = 0;

4126
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4127
        return false;
4128

4129 4130
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
4131
        return false;
4132

4133
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
4134
        return false;
4135 4136 4137

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
4138
        vshPrint(ctl, "%s", configData);
4139
        VIR_FREE(configData);
4140
    } else {
E
Eric Blake 已提交
4141
        ret = false;
4142 4143 4144 4145 4146
    }

    return ret;
}

K
Karel Zak 已提交
4147
/*
K
Karel Zak 已提交
4148
 * "domname" command
K
Karel Zak 已提交
4149
 */
4150
static const vshCmdInfo info_domname[] = {
4151
    {"help", N_("convert a domain id or UUID to domain name")},
4152
    {"desc", ""},
4153
    {NULL, NULL}
K
Karel Zak 已提交
4154 4155
};

4156
static const vshCmdOptDef opts_domname[] = {
4157
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
4158
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4159 4160
};

E
Eric Blake 已提交
4161
static bool
4162
cmdDomname(vshControl *ctl, const vshCmd *cmd)
4163
{
K
Karel Zak 已提交
4164 4165
    virDomainPtr dom;

4166
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4167
        return false;
J
Jim Meyering 已提交
4168
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4169
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
4170
        return false;
4171

K
Karel Zak 已提交
4172 4173
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
4174
    return true;
K
Karel Zak 已提交
4175 4176 4177
}

/*
K
Karel Zak 已提交
4178
 * "domid" command
K
Karel Zak 已提交
4179
 */
4180
static const vshCmdInfo info_domid[] = {
4181
    {"help", N_("convert a domain name or UUID to domain id")},
4182
    {"desc", ""},
4183
    {NULL, NULL}
K
Karel Zak 已提交
4184 4185
};

4186
static const vshCmdOptDef opts_domid[] = {
4187
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
4188
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4189 4190
};

E
Eric Blake 已提交
4191
static bool
4192
cmdDomid(vshControl *ctl, const vshCmd *cmd)
4193
{
4194
    virDomainPtr dom;
4195
    unsigned int id;
K
Karel Zak 已提交
4196

4197
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4198
        return false;
J
Jim Meyering 已提交
4199
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4200
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
4201
        return false;
4202

4203 4204
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
4205
        vshPrint(ctl, "%s\n", "-");
4206
    else
4207
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
4208
    virDomainFree(dom);
E
Eric Blake 已提交
4209
    return true;
K
Karel Zak 已提交
4210
}
4211

K
Karel Zak 已提交
4212 4213 4214
/*
 * "domuuid" command
 */
4215
static const vshCmdInfo info_domuuid[] = {
4216
    {"help", N_("convert a domain name or id to domain UUID")},
4217
    {"desc", ""},
K
Karel Zak 已提交
4218 4219 4220
    {NULL, NULL}
};

4221
static const vshCmdOptDef opts_domuuid[] = {
4222
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
4223 4224 4225
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4226
static bool
4227
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
4228 4229
{
    virDomainPtr dom;
4230
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
4231

4232
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4233
        return false;
J
Jim Meyering 已提交
4234
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4235
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
4236
        return false;
4237

K
Karel Zak 已提交
4238 4239 4240
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
4241
        vshError(ctl, "%s", _("failed to get domain UUID"));
4242

4243
    virDomainFree(dom);
E
Eric Blake 已提交
4244
    return true;
K
Karel Zak 已提交
4245 4246
}

4247 4248 4249
/*
 * "migrate" command
 */
4250
static const vshCmdInfo info_migrate[] = {
4251 4252
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
4253 4254 4255
    {NULL, NULL}
};

4256
static const vshCmdOptDef opts_migrate[] = {
4257 4258 4259 4260 4261 4262 4263
    {"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")},
4264 4265
    {"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 已提交
4266
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
4267
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4268
    {"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)")},
4269 4270
    {"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 已提交
4271
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
4272
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
4273 4274 4275
    {NULL, 0, 0, NULL}
};

4276 4277 4278 4279 4280 4281 4282 4283
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
4284
{
4285
    char ret = '1';
4286
    virDomainPtr dom = NULL;
4287 4288 4289 4290
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
    int flags = 0;
4291 4292 4293
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
4294 4295
    const char *xmlfile = NULL;
    char *xml = NULL;
4296 4297
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;
4298 4299 4300 4301 4302

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

4305
    if (!vshConnectionUsability (ctl, ctl->conn))
4306
        goto out;
4307

J
Jim Meyering 已提交
4308
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
4309
        goto out;
4310

4311 4312
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
4313 4314
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
4315
        goto out;
4316
    }
4317

4318 4319 4320 4321 4322
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

4323 4324
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
4325 4326
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
4327 4328 4329
    if (vshCommandOptBool (cmd, "tunnelled"))
        flags |= VIR_MIGRATE_TUNNELLED;

C
Chris Lalancette 已提交
4330 4331 4332 4333 4334
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

4335 4336 4337
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

4338 4339 4340 4341 4342 4343
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

4344 4345 4346 4347 4348 4349

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


4350 4351 4352 4353
    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. */
4354

4355
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
4356
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
4357
            goto out;
4358
        }
4359

4360
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
4361
            ret = '0';
4362 4363 4364 4365 4366 4367
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
4368
        if (!dconn) goto out;
4369

4370
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
4371 4372
        if (ddom) {
            virDomainFree(ddom);
4373
            ret = '0';
4374 4375 4376
        }
        virConnectClose (dconn);
    }
4377

4378
out:
4379
#if HAVE_PTHREAD_SIGMASK
4380 4381
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
4382
#endif
4383
    if (dom) virDomainFree (dom);
4384
    VIR_FREE(xml);
4385 4386 4387
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
4388
static void
4389 4390
print_job_progress(const char *label, unsigned long long remaining,
                   unsigned long long total)
W
Wen Congyang 已提交
4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409
{
    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;
        }
    }

4410
    fprintf(stderr, "\r%s: [%3d %%]", label, progress);
W
Wen Congyang 已提交
4411 4412
}

E
Eric Blake 已提交
4413
static bool
4414 4415 4416 4417 4418
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
4419
    bool functionReturn = false;
4420 4421 4422 4423 4424
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
4425 4426
    virDomainJobInfo jobinfo;
    bool verbose = false;
4427
    int timeout = 0;
W
Wen Congyang 已提交
4428 4429
    struct timeval start, curr;
    bool live_flag = false;
4430
    vshCtrlData data;
4431 4432 4433 4434 4435 4436
#if HAVE_PTHREAD_SIGMASK
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
#endif
4437 4438

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

W
Wen Congyang 已提交
4441 4442 4443
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
4444
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
4445
        live_flag = true;
4446
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463
        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;
        }
    }

4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486
    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 已提交
4487
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
4488
    while (1) {
4489
repoll:
W
Wen Congyang 已提交
4490 4491 4492 4493
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
4494
                    functionReturn = true;
W
Wen Congyang 已提交
4495 4496
                    if (verbose) {
                        /* print [100 %] */
4497
                        print_job_progress("Migration", 0, 1);
W
Wen Congyang 已提交
4498 4499
                    }
                } else
W
Wen Congyang 已提交
4500
                    functionReturn = false;
4501
            } else
W
Wen Congyang 已提交
4502
                functionReturn = false;
W
Wen Congyang 已提交
4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
4514
            functionReturn = false;
W
Wen Congyang 已提交
4515 4516 4517
            break;
        }

W
Wen Congyang 已提交
4518 4519 4520 4521 4522 4523 4524 4525 4526
        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 已提交
4527
        if (verbose) {
4528
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
4529
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
4530
#endif
W
Wen Congyang 已提交
4531
            ret = virDomainGetJobInfo(dom, &jobinfo);
4532
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
4533
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
4534
#endif
W
Wen Congyang 已提交
4535
            if (ret == 0)
4536 4537
                print_job_progress("Migration", jobinfo.dataRemaining,
                                   jobinfo.dataTotal);
4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
4549
    return functionReturn;
4550 4551
}

4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562
/*
 * "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")},
4563
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
4564 4565 4566
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4567
static bool
4568 4569 4570
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
4571
    long long downtime = 0;
E
Eric Blake 已提交
4572
    bool ret = false;
4573

4574
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4575
        return false;
4576 4577

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

4580 4581
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
4582 4583 4584 4585 4586 4587 4588
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
4589
    ret = true;
4590 4591 4592 4593 4594 4595

done:
    virDomainFree(dom);
    return ret;
}

4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639
/*
 * "migrate-setspeed" command
 */
static const vshCmdInfo info_migrate_setspeed[] = {
    {"help", N_("Set the maximum migration bandwidth")},
    {"desc", N_("Set the maximum migration bandwidth (in Mbps) for a domain "
                "which is being migrated to another host.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_migrate_setspeed[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"bandwidth", VSH_OT_INT, VSH_OFLAG_REQ, N_("migration bandwidth limit in Mbps")},
    {NULL, 0, 0, NULL}
};

static bool
cmdMigrateSetMaxSpeed(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    unsigned long bandwidth = 0;
    bool ret = false;

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

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

    if (vshCommandOptUL(cmd, "bandwidth", &bandwidth) < 0) {
        vshError(ctl, "%s", _("migrate: Invalid bandwidth"));
        goto done;
    }

    if (virDomainMigrateSetMaxSpeed(dom, bandwidth, 0) < 0)
        goto done;

    ret = true;

done:
    virDomainFree(dom);
    return ret;
}

4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747
typedef enum {
    VSH_CMD_BLOCK_PULL_ONE = 0,
    VSH_CMD_BLOCK_PULL_ALL = 1,
    VSH_CMD_BLOCK_PULL_ABORT = 2,
    VSH_CMD_BLOCK_PULL_INFO = 3
} vshCmdBlockPullMode;

static int
blockPullImpl(vshControl *ctl, const vshCmd *cmd,
              virDomainBlockPullInfoPtr info, int mode)
{
    virDomainPtr dom;
    const char *name, *path;
    int ret = -1;

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

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

    if (vshCommandOptString(cmd, "path", &path) < 0)
        return false;

    if (mode == VSH_CMD_BLOCK_PULL_ONE)
        ret = virDomainBlockPull(dom, path, info, 0);
    else if (mode == VSH_CMD_BLOCK_PULL_ALL)
        ret = virDomainBlockPullAll(dom, path, 0);
    else if (mode == VSH_CMD_BLOCK_PULL_ABORT)
        ret = virDomainBlockPullAbort(dom, path, 0);
    else if (mode ==  VSH_CMD_BLOCK_PULL_INFO)
        ret = virDomainGetBlockPullInfo(dom, path, info, 0);

    virDomainFree(dom);
    return ret;
}

/*
 * "blockpull" command
 */
static const vshCmdInfo info_block_pull[] = {
    {"help", N_("Populate a disk from its backing image.")},
    {"desc", N_("Populate a disk from its backing image.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_block_pull[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified path of disk")},
    {"all", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("Populate the entire disk")},
    {"abort", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("Stop populating this disk")},
    {NULL, 0, 0, NULL}
};

static bool
cmdBlockPull(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockPullInfo info;
    int mode;
    bool all = vshCommandOptBool(cmd, "all");
    bool do_abort = vshCommandOptBool(cmd, "abort");

    if (all && do_abort) {
        vshError(ctl, "%s", _("--all and --abort are mutually exclusive"));
        return false;
    }

    if (all)
        mode = VSH_CMD_BLOCK_PULL_ALL;
    else if (do_abort)
        mode = VSH_CMD_BLOCK_PULL_ABORT;
    else
        mode = VSH_CMD_BLOCK_PULL_ONE;

    if (blockPullImpl(ctl, cmd, &info, mode) != 0)
        return false;
    if (mode == VSH_CMD_BLOCK_PULL_ONE)
        print_job_progress("Block pull", info.end - info.cur, info.end);
    return true;
}

/*
 * "blockpullinfo" command
 */
static const vshCmdInfo info_block_pull_info[] = {
    {"help", N_("Check progress of an active block pull operation.")},
    {"desc", N_("Check progress of an active block pull operation.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_block_pull_info[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified path of disk")},
    {NULL, 0, 0, NULL}
};

static bool
cmdBlockPullInfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockPullInfo info;

    if (blockPullImpl(ctl, cmd, &info, VSH_CMD_BLOCK_PULL_INFO) != 0)
        return false;
    print_job_progress("Block pull", info.end - info.cur, info.end);
    return true;
}


4748 4749 4750
/*
 * "net-autostart" command
 */
4751
static const vshCmdInfo info_network_autostart[] = {
4752
    {"help", N_("autostart a network")},
4753
    {"desc",
4754
     N_("Configure a network to be automatically started at boot.")},
4755 4756 4757
    {NULL, NULL}
};

4758
static const vshCmdOptDef opts_network_autostart[] = {
4759 4760
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4761 4762 4763
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4764
static bool
4765
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
4766 4767
{
    virNetworkPtr network;
4768
    const char *name;
4769 4770
    int autostart;

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

J
Jim Meyering 已提交
4774
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4775
        return false;
4776 4777 4778 4779

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
4780
        if (autostart)
4781
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
4782
        else
4783
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
4784
        virNetworkFree(network);
E
Eric Blake 已提交
4785
        return false;
4786 4787
    }

4788
    if (autostart)
4789
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
4790
    else
4791
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
4792

L
Laine Stump 已提交
4793
    virNetworkFree(network);
E
Eric Blake 已提交
4794
    return true;
4795
}
K
Karel Zak 已提交
4796

4797 4798 4799
/*
 * "net-create" command
 */
4800
static const vshCmdInfo info_network_create[] = {
4801 4802
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
4803 4804 4805
    {NULL, NULL}
};

4806
static const vshCmdOptDef opts_network_create[] = {
4807
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4808 4809 4810
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4811
static bool
4812
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
4813 4814
{
    virNetworkPtr network;
4815
    const char *from = NULL;
E
Eric Blake 已提交
4816
    bool ret = true;
4817
    char *buffer;
4818

4819
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4820
        return false;
4821

4822
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4823
        return false;
4824

4825
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4826
        return false;
4827 4828

    network = virNetworkCreateXML(ctl->conn, buffer);
4829
    VIR_FREE(buffer);
4830

4831 4832 4833
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4834
        virNetworkFree(network);
4835
    } else {
4836
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
4837
        ret = false;
4838 4839 4840 4841 4842 4843 4844 4845
    }
    return ret;
}


/*
 * "net-define" command
 */
4846
static const vshCmdInfo info_network_define[] = {
4847 4848
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
4849 4850 4851
    {NULL, NULL}
};

4852
static const vshCmdOptDef opts_network_define[] = {
4853
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4854 4855 4856
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4857
static bool
4858
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
4859 4860
{
    virNetworkPtr network;
4861
    const char *from = NULL;
E
Eric Blake 已提交
4862
    bool ret = true;
4863
    char *buffer;
4864

4865
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4866
        return false;
4867

4868
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4869
        return false;
4870

4871
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4872
        return false;
4873 4874

    network = virNetworkDefineXML(ctl->conn, buffer);
4875
    VIR_FREE(buffer);
4876

4877 4878 4879
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4880
        virNetworkFree(network);
4881
    } else {
4882
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
4883
        ret = false;
4884 4885 4886 4887 4888 4889 4890 4891
    }
    return ret;
}


/*
 * "net-destroy" command
 */
4892
static const vshCmdInfo info_network_destroy[] = {
4893 4894
    {"help", N_("destroy a network")},
    {"desc", N_("Destroy a given network.")},
4895 4896 4897
    {NULL, NULL}
};

4898
static const vshCmdOptDef opts_network_destroy[] = {
4899
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4900 4901 4902
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4903
static bool
4904
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
4905 4906
{
    virNetworkPtr network;
E
Eric Blake 已提交
4907
    bool ret = true;
4908
    const char *name;
4909

4910
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4911
        return false;
4912

J
Jim Meyering 已提交
4913
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4914
        return false;
4915 4916 4917 4918

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

4923
    virNetworkFree(network);
4924 4925 4926 4927 4928 4929 4930
    return ret;
}


/*
 * "net-dumpxml" command
 */
4931
static const vshCmdInfo info_network_dumpxml[] = {
4932 4933
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
4934 4935 4936
    {NULL, NULL}
};

4937
static const vshCmdOptDef opts_network_dumpxml[] = {
4938
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4939 4940 4941
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4942
static bool
4943
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
4944 4945
{
    virNetworkPtr network;
E
Eric Blake 已提交
4946
    bool ret = true;
4947 4948
    char *dump;

4949
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4950
        return false;
4951

J
Jim Meyering 已提交
4952
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
4953
        return false;
4954 4955 4956

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
4957
        vshPrint(ctl, "%s", dump);
4958
        VIR_FREE(dump);
4959
    } else {
E
Eric Blake 已提交
4960
        ret = false;
4961 4962 4963 4964 4965 4966
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980
/*
 * "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 已提交
4981
static bool
O
Osier Yang 已提交
4982 4983 4984 4985 4986 4987 4988 4989 4990 4991
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 已提交
4992
        return false;
O
Osier Yang 已提交
4993 4994 4995

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4996
        return false;
O
Osier Yang 已提交
4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022

    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 已提交
5023
    return true;
O
Osier Yang 已提交
5024
}
5025

5026 5027 5028 5029
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
5030 5031
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
5032 5033 5034 5035
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
5036
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5037 5038 5039
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5040
static bool
5041 5042
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5043
    bool ret = false;
5044 5045 5046 5047 5048
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
5049
    int flags = VIR_INTERFACE_XML_INACTIVE;
5050

5051
    if (!vshConnectionUsability(ctl, ctl->conn))
5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077
        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 已提交
5078
        ret = true;
5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090
        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)) {
5091 5092
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104
        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 已提交
5105
    ret = true;
5106 5107 5108 5109 5110

cleanup:
    if (iface)
        virInterfaceFree (iface);

5111 5112 5113
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
5114 5115 5116

    if (tmp) {
        unlink (tmp);
5117
        VIR_FREE(tmp);
5118 5119 5120 5121 5122
    }

    return ret;
}

5123 5124 5125
/*
 * "net-list" command
 */
5126
static const vshCmdInfo info_network_list[] = {
5127 5128
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
5129 5130 5131
    {NULL, NULL}
};

5132
static const vshCmdOptDef opts_network_list[] = {
5133 5134
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
5135 5136 5137
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5138
static bool
5139
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5140 5141 5142 5143 5144
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
5145
    char **activeNames = NULL, **inactiveNames = NULL;
5146 5147
    inactive |= all;

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

    if (active) {
5152 5153
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
5154
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
5155
            return false;
5156
        }
5157
        if (maxactive) {
5158
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
5159

5160
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
5161
                                                    maxactive)) < 0) {
5162
                vshError(ctl, "%s", _("Failed to list active networks"));
5163
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5164
                return false;
5165
            }
5166

5167
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
5168
        }
5169 5170
    }
    if (inactive) {
5171 5172
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
5173
            vshError(ctl, "%s", _("Failed to list inactive networks"));
5174
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5175
            return false;
5176
        }
5177 5178 5179
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5180 5181 5182
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
5183
                vshError(ctl, "%s", _("Failed to list inactive networks"));
5184 5185
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5186
                return false;
5187
            }
5188

5189 5190
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
5191
    }
5192 5193
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
5194
    vshPrintExtra(ctl, "-----------------------------------------\n");
5195 5196

    for (i = 0; i < maxactive; i++) {
5197 5198
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
5199 5200
        const char *autostartStr;
        int autostart = 0;
5201 5202 5203

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5204
            VIR_FREE(activeNames[i]);
5205
            continue;
5206
        }
5207

5208 5209 5210
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5211
            autostartStr = autostart ? _("yes") : _("no");
5212 5213 5214 5215 5216

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
5217
        virNetworkFree(network);
5218
        VIR_FREE(activeNames[i]);
5219 5220 5221
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
5222 5223
        const char *autostartStr;
        int autostart = 0;
5224 5225 5226

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5227
            VIR_FREE(inactiveNames[i]);
5228
            continue;
5229
        }
5230

5231 5232 5233
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5234
            autostartStr = autostart ? _("yes") : _("no");
5235

5236
        vshPrint(ctl, "%-20s %-10s %-10s\n",
5237 5238 5239
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
5240 5241

        virNetworkFree(network);
5242
        VIR_FREE(inactiveNames[i]);
5243
    }
5244 5245
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5246
    return true;
5247 5248 5249 5250 5251 5252
}


/*
 * "net-name" command
 */
5253
static const vshCmdInfo info_network_name[] = {
5254
    {"help", N_("convert a network UUID to network name")},
5255
    {"desc", ""},
5256 5257 5258
    {NULL, NULL}
};

5259
static const vshCmdOptDef opts_network_name[] = {
5260
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
5261 5262 5263
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5264
static bool
5265
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
5266 5267 5268
{
    virNetworkPtr network;

5269
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5270
        return false;
J
Jim Meyering 已提交
5271
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5272
                                           VSH_BYUUID)))
E
Eric Blake 已提交
5273
        return false;
5274 5275 5276

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
5277
    return true;
5278 5279 5280 5281 5282 5283
}


/*
 * "net-start" command
 */
5284
static const vshCmdInfo info_network_start[] = {
5285 5286
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
5287 5288 5289
    {NULL, NULL}
};

5290
static const vshCmdOptDef opts_network_start[] = {
5291
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
5292 5293 5294
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5295
static bool
5296
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
5297 5298
{
    virNetworkPtr network;
E
Eric Blake 已提交
5299
    bool ret = true;
5300

5301
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5302
        return false;
5303

J
Jim Meyering 已提交
5304
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
5305
         return false;
5306 5307 5308

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
5309
                 virNetworkGetName(network));
5310
    } else {
5311
        vshError(ctl, _("Failed to start network %s"),
5312
                 virNetworkGetName(network));
E
Eric Blake 已提交
5313
        ret = false;
5314
    }
L
Laine Stump 已提交
5315
    virNetworkFree(network);
5316 5317 5318 5319 5320 5321 5322
    return ret;
}


/*
 * "net-undefine" command
 */
5323
static const vshCmdInfo info_network_undefine[] = {
5324 5325
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
5326 5327 5328
    {NULL, NULL}
};

5329
static const vshCmdOptDef opts_network_undefine[] = {
5330
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5331 5332 5333
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5334
static bool
5335
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
5336 5337
{
    virNetworkPtr network;
E
Eric Blake 已提交
5338
    bool ret = true;
5339
    const char *name;
5340

5341
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5342
        return false;
5343

J
Jim Meyering 已提交
5344
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5345
        return false;
5346 5347 5348 5349

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

L
Laine Stump 已提交
5354
    virNetworkFree(network);
5355 5356 5357 5358 5359 5360 5361
    return ret;
}


/*
 * "net-uuid" command
 */
5362
static const vshCmdInfo info_network_uuid[] = {
5363
    {"help", N_("convert a network name to network UUID")},
5364
    {"desc", ""},
5365 5366 5367
    {NULL, NULL}
};

5368
static const vshCmdOptDef opts_network_uuid[] = {
5369
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
5370 5371 5372
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5373
static bool
5374
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
5375 5376 5377 5378
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

5379
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5380
        return false;
5381

J
Jim Meyering 已提交
5382
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5383
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5384
        return false;
5385 5386 5387 5388

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

L
Laine Stump 已提交
5391
    virNetworkFree(network);
E
Eric Blake 已提交
5392
    return true;
5393 5394 5395
}


5396 5397 5398 5399 5400
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
5401 5402
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
5403 5404 5405 5406
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
5407 5408
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
5409 5410
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
5411
static bool
5412 5413 5414 5415 5416 5417 5418 5419 5420
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;

5421
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5422
        return false;
5423 5424 5425 5426

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
5427
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
5428
            return false;
5429 5430 5431 5432 5433 5434
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
5435
                vshError(ctl, "%s", _("Failed to list active interfaces"));
5436
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5437
                return false;
5438 5439 5440 5441 5442 5443 5444 5445
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
5446
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
5447
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5448
            return false;
5449 5450 5451 5452
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5453 5454 5455
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
5456
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
5457 5458
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5459
                return false;
5460 5461 5462 5463 5464
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
5465 5466
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
5467 5468 5469
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
5470 5471
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
5472 5473 5474

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
5475
            VIR_FREE(activeNames[i]);
5476 5477 5478 5479 5480 5481 5482 5483
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
5484
        VIR_FREE(activeNames[i]);
5485 5486
    }
    for (i = 0; i < maxinactive; i++) {
5487 5488
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
5489 5490 5491

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
5492
            VIR_FREE(inactiveNames[i]);
5493 5494 5495 5496 5497 5498 5499 5500
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
5501
        VIR_FREE(inactiveNames[i]);
5502
    }
5503 5504
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5505
    return true;
5506 5507 5508 5509 5510 5511 5512

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
5513
    {"help", N_("convert an interface MAC address to interface name")},
5514 5515 5516 5517 5518
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
5519
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
5520 5521 5522
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5523
static bool
5524 5525 5526 5527
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

5528
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5529
        return false;
5530 5531
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
5532
        return false;
5533 5534 5535

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
5536
    return true;
5537 5538 5539 5540 5541 5542
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
5543
    {"help", N_("convert an interface name to interface MAC address")},
5544 5545 5546 5547 5548
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
5549
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
5550 5551 5552
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5553
static bool
5554 5555 5556 5557
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

5558
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5559
        return false;
5560 5561
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5562
        return false;
5563 5564 5565

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
5566
    return true;
5567 5568 5569 5570 5571 5572
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
5573 5574
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
5575 5576 5577 5578
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
5579 5580
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
5581 5582 5583
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5584
static bool
5585 5586 5587
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5588
    bool ret = true;
5589
    char *dump;
5590 5591 5592 5593 5594
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
5595

5596
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5597
        return false;
5598 5599

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

5602
    dump = virInterfaceGetXMLDesc(iface, flags);
5603
    if (dump != NULL) {
5604
        vshPrint(ctl, "%s", dump);
5605
        VIR_FREE(dump);
5606
    } else {
E
Eric Blake 已提交
5607
        ret = false;
5608 5609 5610 5611 5612 5613 5614 5615 5616 5617
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
5618 5619
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
5620 5621 5622 5623
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
5624
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
5625 5626 5627
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5628
static bool
5629 5630
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
5631
    virInterfacePtr iface;
5632
    const char *from = NULL;
E
Eric Blake 已提交
5633
    bool ret = true;
5634 5635
    char *buffer;

5636
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5637
        return false;
5638

5639
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5640
        return false;
5641 5642

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

5645
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
5646
    VIR_FREE(buffer);
5647

5648
    if (iface != NULL) {
5649
        vshPrint(ctl, _("Interface %s defined from %s\n"),
5650
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
5651
        virInterfaceFree (iface);
5652
    } else {
5653
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
5654
        ret = false;
5655 5656 5657 5658 5659 5660 5661 5662
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
5663 5664
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
5665 5666 5667 5668
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
5669
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5670 5671 5672
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5673
static bool
5674 5675 5676
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5677
    bool ret = true;
5678
    const char *name;
5679

5680
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5681
        return false;
5682 5683

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5684
        return false;
5685 5686 5687 5688

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
5689
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
5690
        ret = false;
5691 5692 5693 5694 5695 5696 5697 5698 5699 5700
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
5701 5702
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
5703 5704 5705 5706
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
5707
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5708 5709 5710
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5711
static bool
5712 5713 5714
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5715
    bool ret = true;
5716
    const char *name;
5717

5718
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5719
        return false;
5720 5721

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5722
        return false;
5723 5724 5725 5726

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
5727
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
5728
        ret = false;
5729 5730 5731 5732 5733 5734 5735 5736 5737 5738
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
5739 5740
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
    {"desc", N_("destroy a physical host interface.")},
5741 5742 5743 5744
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
5745
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5746 5747 5748
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5749
static bool
5750 5751 5752
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5753
    bool ret = true;
5754
    const char *name;
5755

5756
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5757
        return false;
5758 5759

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5760
        return false;
5761 5762 5763 5764

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
5765
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
5766
        ret = false;
5767 5768 5769 5770 5771 5772
    }

    virInterfaceFree(iface);
    return ret;
}

5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857
/*
 * "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;
}
5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872

/*
 * "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 已提交
5873
static bool
5874 5875 5876
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
5877
    const char *from = NULL;
E
Eric Blake 已提交
5878
    bool ret = true;
5879 5880
    char *buffer;

5881
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5882
        return false;
5883

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5888
        return false;
5889 5890 5891 5892 5893 5894 5895 5896 5897 5898

    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 已提交
5899
        ret = false;
5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918
    }
    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 已提交
5919
static bool
5920 5921 5922
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5923
    bool ret = true;
5924
    const char *name;
5925

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

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
5930
        return false;
5931 5932 5933 5934 5935

    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 已提交
5936
        ret = false;
5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957
    }

    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 已提交
5958
static bool
5959 5960 5961
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5962
    bool ret = true;
5963 5964
    char *dump;

5965
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5966
        return false;
5967 5968

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
5969
        return false;
5970 5971 5972

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
5973
        vshPrint(ctl, "%s", dump);
5974 5975
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
5976
        ret = false;
5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995
    }

    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 已提交
5996
static bool
5997 5998 5999 6000 6001 6002
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

6003
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6004
        return false;
6005 6006 6007 6008

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
6009
        return false;
6010 6011 6012 6013 6014 6015 6016 6017
    }

    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 已提交
6018
        return false;
6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045
    }

    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 已提交
6046
    return true;
6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063
}


/*
 * "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 已提交
6064
static bool
6065 6066
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6067
    bool ret = false;
6068 6069 6070 6071 6072 6073
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

6074
    if (!vshConnectionUsability(ctl, ctl->conn))
6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100
        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 已提交
6101
        ret = true;
6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127
        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 已提交
6128
    ret = true;
6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146

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


6147
/**************************************************************************/
6148
/*
6149
 * "pool-autostart" command
6150
 */
6151
static const vshCmdInfo info_pool_autostart[] = {
6152
    {"help", N_("autostart a pool")},
6153
    {"desc",
6154
     N_("Configure a pool to be automatically started at boot.")},
6155
    {NULL, NULL}
6156 6157
};

6158
static const vshCmdOptDef opts_pool_autostart[] = {
6159 6160
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6161 6162
    {NULL, 0, 0, NULL}
};
6163

E
Eric Blake 已提交
6164
static bool
6165
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
6166
{
6167
    virStoragePoolPtr pool;
6168
    const char *name;
6169
    int autostart;
6170

6171
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6172
        return false;
6173

6174
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6175
        return false;
6176

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

6179 6180
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
6181
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
6182
        else
6183
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
6184
        virStoragePoolFree(pool);
E
Eric Blake 已提交
6185
        return false;
6186 6187
    }

6188
    if (autostart)
6189
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
6190
    else
6191
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
6192

L
Laine Stump 已提交
6193
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6194
    return true;
6195 6196
}

6197
/*
6198
 * "pool-create" command
6199
 */
6200
static const vshCmdInfo info_pool_create[] = {
6201 6202
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
6203 6204 6205
    {NULL, NULL}
};

6206
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
6207
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
6208
     N_("file containing an XML pool description")},
6209 6210 6211
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6212
static bool
6213
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
6214
{
6215
    virStoragePoolPtr pool;
6216
    const char *from = NULL;
E
Eric Blake 已提交
6217
    bool ret = true;
6218
    char *buffer;
6219

6220
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6221
        return false;
6222

6223
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6224
        return false;
6225

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

6229
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
6230
    VIR_FREE(buffer);
6231 6232 6233 6234

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6235
        virStoragePoolFree(pool);
6236
    } else {
6237
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
6238
        ret = false;
6239 6240
    }
    return ret;
6241 6242
}

6243

6244 6245 6246 6247
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
6248
    {"help", N_("create a device defined "
6249
                          "by an XML file on the node")},
6250
    {"desc", N_("Create a device on the node.  Note that this "
6251 6252 6253 6254 6255 6256 6257
                          "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,
6258
     N_("file containing an XML description of the device")},
6259 6260 6261
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6262
static bool
6263 6264 6265
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
6266
    const char *from = NULL;
E
Eric Blake 已提交
6267
    bool ret = true;
6268 6269
    char *buffer;

6270
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6271
        return false;
6272

6273
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6274
        return false;
6275

6276
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6277
        return false;
6278 6279

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
6280
    VIR_FREE(buffer);
6281 6282 6283 6284

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
6285
        virNodeDeviceFree(dev);
6286
    } else {
6287
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
6288
        ret = false;
6289 6290 6291 6292 6293 6294 6295 6296 6297 6298
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
6299 6300
    {"help", N_("destroy a device on the node")},
    {"desc", N_("Destroy a device on the node.  Note that this "
6301 6302 6303 6304 6305 6306
                          "command destroys devices on the physical host ")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
6307
     N_("name of the device to be destroyed")},
6308 6309 6310
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6311
static bool
6312 6313 6314
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
6315
    bool ret = true;
6316
    const char *name = NULL;
6317

6318
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
6319
        return false;
6320 6321
    }

6322
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
6323
        return false;
6324 6325 6326 6327 6328 6329

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
6330
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
6331
        ret = false;
6332 6333 6334 6335 6336 6337 6338
    }

    virNodeDeviceFree(dev);
    return ret;
}


6339
/*
6340
 * XML Building helper for pool-define-as and pool-create-as
6341
 */
6342
static const vshCmdOptDef opts_pool_X_as[] = {
6343 6344 6345 6346 6347 6348 6349 6350
    {"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")},
6351
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
6352 6353 6354
    {NULL, 0, 0, NULL}
};

6355
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
6356

6357 6358
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
6359
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6360

6361
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6362
        goto cleanup;
6363
    if (vshCommandOptString(cmd, "type", &type) <= 0)
6364 6365
        goto cleanup;

6366 6367 6368 6369 6370
    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 ||
6371 6372
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
6373
        goto cleanup;
6374
    }
6375

6376 6377
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
6378
    if (srcHost || srcPath || srcDev) {
6379
        virBufferAddLit(&buf, "  <source>\n");
6380

6381
        if (srcHost)
6382
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
6383
        if (srcPath)
6384
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
6385
        if (srcDev)
6386
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
6387
        if (srcFormat)
6388
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
6389
        if (srcName)
6390
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
6391 6392

        virBufferAddLit(&buf, "  </source>\n");
6393 6394
    }
    if (target) {
6395
        virBufferAddLit(&buf, "  <target>\n");
6396
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
6397
        virBufferAddLit(&buf, "  </target>\n");
6398
    }
6399 6400 6401 6402
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
6403
        return false;
6404
    }
6405 6406 6407

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
6408
    return true;
6409 6410

cleanup:
6411
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6412
    return false;
6413 6414 6415 6416 6417 6418
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
6419 6420
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
6421 6422 6423
    {NULL, NULL}
};

E
Eric Blake 已提交
6424
static bool
6425 6426 6427
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
6428 6429
    const char *name;
    char *xml;
6430
    int printXML = vshCommandOptBool(cmd, "print-xml");
6431

6432
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6433
        return false;
6434 6435

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

6438
    if (printXML) {
6439
        vshPrint(ctl, "%s", xml);
6440
        VIR_FREE(xml);
6441
    } else {
6442
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
6443
        VIR_FREE(xml);
6444

6445 6446 6447 6448
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
6449
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
6450
            return false;
6451 6452
        }
    }
E
Eric Blake 已提交
6453
    return true;
6454 6455
}

6456

6457
/*
6458
 * "pool-define" command
6459
 */
6460
static const vshCmdInfo info_pool_define[] = {
6461 6462
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
6463 6464 6465
    {NULL, NULL}
};

6466
static const vshCmdOptDef opts_pool_define[] = {
6467
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
6468 6469 6470
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6471
static bool
6472
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
6473
{
6474
    virStoragePoolPtr pool;
6475
    const char *from = NULL;
E
Eric Blake 已提交
6476
    bool ret = true;
6477
    char *buffer;
6478

6479
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6480
        return false;
6481

6482
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6483
        return false;
6484

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

6488
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
6489
    VIR_FREE(buffer);
6490 6491 6492 6493

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6494
        virStoragePoolFree(pool);
6495
    } else {
6496
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
6497
        ret = false;
6498 6499
    }
    return ret;
6500 6501
}

6502

6503 6504 6505
/*
 * "pool-define-as" command
 */
6506
static const vshCmdInfo info_pool_define_as[] = {
6507 6508
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
6509 6510 6511
    {NULL, NULL}
};

E
Eric Blake 已提交
6512
static bool
6513
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
6514 6515
{
    virStoragePoolPtr pool;
6516 6517
    const char *name;
    char *xml;
6518
    int printXML = vshCommandOptBool(cmd, "print-xml");
6519

6520
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6521
        return false;
6522

6523
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
6524
        return false;
6525

6526
    if (printXML) {
6527
        vshPrint(ctl, "%s", xml);
6528
        VIR_FREE(xml);
6529
    } else {
6530
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
6531
        VIR_FREE(xml);
6532

6533 6534 6535 6536
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
6537
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
6538
            return false;
6539 6540
        }
    }
E
Eric Blake 已提交
6541
    return true;
6542 6543 6544
}


6545
/*
6546
 * "pool-build" command
6547
 */
6548
static const vshCmdInfo info_pool_build[] = {
6549 6550
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
6551 6552 6553
    {NULL, NULL}
};

6554
static const vshCmdOptDef opts_pool_build[] = {
6555
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6556 6557 6558
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6559
static bool
6560
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
6561
{
6562
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6563
    bool ret = true;
6564
    const char *name;
6565

6566
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6567
        return false;
6568

6569
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6570
        return false;
6571

6572
    if (virStoragePoolBuild(pool, 0) == 0) {
6573
        vshPrint(ctl, _("Pool %s built\n"), name);
6574
    } else {
6575
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
6576
        ret = false;
6577 6578
    }

6579 6580
    virStoragePoolFree(pool);

6581 6582 6583
    return ret;
}

6584

6585
/*
6586
 * "pool-destroy" command
6587
 */
6588
static const vshCmdInfo info_pool_destroy[] = {
6589 6590
    {"help", N_("destroy a pool")},
    {"desc", N_("Destroy a given pool.")},
6591 6592 6593
    {NULL, NULL}
};

6594
static const vshCmdOptDef opts_pool_destroy[] = {
6595
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6596 6597 6598
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6599
static bool
6600
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
6601
{
6602
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6603
    bool ret = true;
6604
    const char *name;
6605

6606
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6607
        return false;
6608

6609
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6610
        return false;
6611

6612 6613 6614
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
6615
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
6616
        ret = false;
6617 6618
    }

6619
    virStoragePoolFree(pool);
6620 6621 6622
    return ret;
}

6623

6624
/*
6625 6626
 * "pool-delete" command
 */
6627
static const vshCmdInfo info_pool_delete[] = {
6628 6629
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
6630 6631 6632
    {NULL, NULL}
};

6633
static const vshCmdOptDef opts_pool_delete[] = {
6634
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6635 6636 6637
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6638
static bool
6639
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
6640 6641
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6642
    bool ret = true;
6643
    const char *name;
6644

6645
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6646
        return false;
6647 6648

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6649
        return false;
6650 6651

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
6652
        vshPrint(ctl, _("Pool %s deleted\n"), name);
6653
    } else {
6654
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
6655
        ret = false;
6656 6657
    }

L
Laine Stump 已提交
6658
    virStoragePoolFree(pool);
6659 6660 6661 6662 6663 6664 6665
    return ret;
}


/*
 * "pool-refresh" command
 */
6666
static const vshCmdInfo info_pool_refresh[] = {
6667 6668
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
6669 6670 6671
    {NULL, NULL}
};

6672
static const vshCmdOptDef opts_pool_refresh[] = {
6673
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6674 6675 6676
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6677
static bool
6678
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
6679 6680
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6681
    bool ret = true;
6682
    const char *name;
6683

6684
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6685
        return false;
6686 6687

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6688
        return false;
6689 6690 6691 6692

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
6693
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
6694
        ret = false;
6695 6696 6697 6698 6699 6700 6701 6702 6703 6704
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
6705
static const vshCmdInfo info_pool_dumpxml[] = {
6706 6707
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
6708 6709 6710
    {NULL, NULL}
};

6711
static const vshCmdOptDef opts_pool_dumpxml[] = {
6712
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6713 6714 6715
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6716
static bool
6717
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
6718 6719
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6720
    bool ret = true;
6721 6722
    char *dump;

6723
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6724
        return false;
6725 6726

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6727
        return false;
6728 6729 6730

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
6731
        vshPrint(ctl, "%s", dump);
6732
        VIR_FREE(dump);
6733
    } else {
E
Eric Blake 已提交
6734
        ret = false;
6735 6736 6737 6738 6739 6740 6741 6742 6743 6744
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
6745
static const vshCmdInfo info_pool_list[] = {
6746 6747
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
6748 6749 6750
    {NULL, NULL}
};

6751
static const vshCmdOptDef opts_pool_list[] = {
6752 6753
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
6754
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
6755 6756 6757
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6758
static bool
6759
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6760
{
6761 6762
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
6763 6764
    int i, ret;
    bool functionReturn;
6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780
    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 */
6781
    int all = vshCommandOptBool(cmd, "all");
6782 6783
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
6784 6785 6786
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

6787
    /* Check the connection to libvirtd daemon is still working */
6788
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6789
        return false;
6790

6791
    /* Retrieve the number of active storage pools */
6792
    if (active) {
6793 6794
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
6795
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
6796
            return false;
6797 6798
        }
    }
6799 6800

    /* Retrieve the number of inactive storage pools */
6801
    if (inactive) {
6802 6803
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
6804
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
6805
            return false;
6806
        }
6807
    }
6808

6809 6810
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
6811

6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823
    /* 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 已提交
6824
            return false;
6825 6826 6827
        }
    }

6828 6829 6830 6831 6832 6833 6834 6835
    /* 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 已提交
6836
            return false;
6837 6838
        }
    }
6839

6840 6841 6842 6843 6844 6845 6846 6847 6848 6849
    /* 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]);
6850
        if (!pool) {
6851
            VIR_FREE(poolNames[i]);
6852 6853 6854
            continue;
        }

6855
        /* Retrieve the autostart status of the pool */
6856
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
6857
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
6858
        else
6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876
            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;
        }
6877

6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989
        /* 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 */
6990 6991 6992
        virStoragePoolFree(pool);
    }

6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010
    /* 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);
7011 7012
        }

7013
        /* Cleanup and return */
E
Eric Blake 已提交
7014
        functionReturn = true;
7015 7016
        goto cleanup;
    }
7017

7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111
    /* 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 已提交
7112
    functionReturn = true;
7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126
    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 已提交
7127
    functionReturn = false;
7128

7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140
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]);
7141
    }
7142 7143 7144 7145 7146 7147 7148

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

    /* Return the desired value */
    return functionReturn;
7149 7150
}

7151 7152 7153 7154
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
7155 7156
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7157 7158 7159 7160 7161
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7162 7163 7164
     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")},
7165
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
7166 7167 7168
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7169
static bool
7170 7171
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7172
    const char *type = NULL, *host = NULL;
7173 7174
    char *srcSpec = NULL;
    char *srcList;
7175
    const char *initiator = NULL;
7176

7177 7178
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
7179 7180
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
7181
        return false;
7182
    }
7183

7184
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7185
        return false;
7186 7187

    if (host) {
7188
        const char *port = NULL;
7189
        virBuffer buf = VIR_BUFFER_INITIALIZER;
7190 7191 7192 7193

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7194
            return false;
7195
        }
7196
        virBufferAddLit(&buf, "<source>\n");
7197
        virBufferAsprintf(&buf, "  <host name='%s'", host);
7198
        if (port)
7199
            virBufferAsprintf(&buf, " port='%s'", port);
7200
        virBufferAddLit(&buf, "/>\n");
7201 7202
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
7203
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
7204 7205
            virBufferAddLit(&buf, "  </initiator>\n");
        }
7206 7207 7208
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
7209
            return false;
7210
        }
7211
        srcSpec = virBufferContentAndReset(&buf);
7212 7213 7214
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7215
    VIR_FREE(srcSpec);
7216
    if (srcList == NULL) {
7217
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7218
        return false;
7219 7220
    }
    vshPrint(ctl, "%s", srcList);
7221
    VIR_FREE(srcList);
7222

E
Eric Blake 已提交
7223
    return true;
7224 7225 7226 7227 7228 7229 7230
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
7231 7232
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7233 7234 7235 7236 7237
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7238
     N_("type of storage pool sources to discover")},
7239
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
7240
     N_("optional file of source xml to query for pools")},
7241 7242 7243
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7244
static bool
7245 7246
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7247
    const char *type = NULL, *srcSpecFile = NULL;
7248
    char *srcSpec = NULL, *srcList;
7249

7250
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
7251
        return false;
7252

7253 7254
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
7255
        return false;
7256
    }
7257

7258
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7259
        return false;
7260 7261

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
7262
        return false;
7263 7264

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7265
    VIR_FREE(srcSpec);
7266
    if (srcList == NULL) {
7267
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7268
        return false;
7269 7270
    }
    vshPrint(ctl, "%s", srcList);
7271
    VIR_FREE(srcList);
7272

E
Eric Blake 已提交
7273
    return true;
7274 7275 7276
}


7277 7278 7279
/*
 * "pool-info" command
 */
7280
static const vshCmdInfo info_pool_info[] = {
7281 7282
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
7283 7284 7285
    {NULL, NULL}
};

7286
static const vshCmdOptDef opts_pool_info[] = {
7287
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7288 7289 7290
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7291
static bool
7292
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
7293 7294 7295
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
7296 7297
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
7298
    bool ret = true;
7299 7300
    char uuid[VIR_UUID_STRING_BUFLEN];

7301
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7302
        return false;
7303 7304

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7305
        return false;
7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331

    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;
7332 7333 7334 7335
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
7336 7337
        }

7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353
        /* 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"));

7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365
        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 已提交
7366
        ret = false;
7367 7368 7369 7370 7371 7372 7373 7374 7375 7376
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
7377
static const vshCmdInfo info_pool_name[] = {
7378
    {"help", N_("convert a pool UUID to pool name")},
7379
    {"desc", ""},
7380 7381 7382
    {NULL, NULL}
};

7383
static const vshCmdOptDef opts_pool_name[] = {
7384
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
7385 7386 7387
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7388
static bool
7389
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
7390 7391 7392
{
    virStoragePoolPtr pool;

7393
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7394
        return false;
7395
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7396
                                           VSH_BYUUID)))
E
Eric Blake 已提交
7397
        return false;
7398 7399 7400

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7401
    return true;
7402 7403 7404 7405 7406 7407
}


/*
 * "pool-start" command
 */
7408
static const vshCmdInfo info_pool_start[] = {
7409 7410
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
7411 7412 7413
    {NULL, NULL}
};

7414
static const vshCmdOptDef opts_pool_start[] = {
7415
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
7416 7417 7418
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7419
static bool
7420
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
7421 7422
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7423
    bool ret = true;
7424

7425
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7426
        return false;
7427

7428
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
7429
         return false;
7430 7431 7432 7433 7434

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
7435
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
7436
        ret = false;
7437
    }
L
Laine Stump 已提交
7438 7439

    virStoragePoolFree(pool);
7440 7441 7442 7443
    return ret;
}


7444 7445 7446
/*
 * "vol-create-as" command
 */
7447
static const vshCmdInfo info_vol_create_as[] = {
7448 7449
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
7450 7451 7452
    {NULL, NULL}
};

7453
static const vshCmdOptDef opts_vol_create_as[] = {
7454 7455 7456 7457 7458
    {"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")},
7459 7460
    {"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")},
7461 7462 7463 7464 7465 7466 7467 7468 7469 7470
    {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 已提交
7471
        /* Deliberate fallthrough cases here :-) */
7472 7473 7474
        switch (*end) {
        case 'T':
            *val *= 1024;
7475
            /* fallthrough */
7476 7477
        case 'G':
            *val *= 1024;
7478
            /* fallthrough */
7479 7480
        case 'M':
            *val *= 1024;
7481
            /* fallthrough */
7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
7495
static bool
7496
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
7497 7498 7499
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7500
    char *xml;
7501 7502
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
7503
    unsigned long long capacity, allocation = 0;
7504
    virBuffer buf = VIR_BUFFER_INITIALIZER;
7505

7506
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7507
        return false;
7508 7509 7510

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

7513
    if (vshCommandOptString(cmd, "name", &name) <= 0)
7514 7515
        goto cleanup;

7516
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
7517 7518
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
7519
        vshError(ctl, _("Malformed size %s"), capacityStr);
7520

7521 7522
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
7523
        vshError(ctl, _("Malformed size %s"), allocationStr);
7524

7525 7526 7527 7528 7529 7530 7531
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

7532

7533
    virBufferAddLit(&buf, "<volume>\n");
7534 7535
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
7536
    if (allocationStr)
7537
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
7538 7539

    if (format) {
7540
        virBufferAddLit(&buf, "  <target>\n");
7541
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
7542
        virBufferAddLit(&buf, "  </target>\n");
7543
    }
7544

7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577
    /* 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 已提交
7578
            return false;
7579 7580 7581 7582 7583
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
7584
            return false;
7585 7586 7587 7588
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
7589
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
7590
        if (snapshotStrFormat)
7591
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
7592 7593 7594 7595 7596 7597 7598 7599
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

7601 7602
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7603
        return false;
7604 7605 7606
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
7607
    VIR_FREE(xml);
7608 7609 7610 7611 7612
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
7613
        return true;
7614
    } else {
7615
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
7616
        return false;
7617 7618 7619
    }

 cleanup:
7620
    virBufferFreeAndReset(&buf);
7621
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7622
    return false;
7623 7624 7625
}


7626 7627 7628
/*
 * "pool-undefine" command
 */
7629
static const vshCmdInfo info_pool_undefine[] = {
7630 7631
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
7632 7633 7634
    {NULL, NULL}
};

7635
static const vshCmdOptDef opts_pool_undefine[] = {
7636
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7637 7638 7639
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7640
static bool
7641
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
7642 7643
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7644
    bool ret = true;
7645
    const char *name;
7646

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

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7651
        return false;
7652 7653 7654 7655

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

L
Laine Stump 已提交
7660
    virStoragePoolFree(pool);
7661 7662 7663 7664 7665 7666 7667
    return ret;
}


/*
 * "pool-uuid" command
 */
7668
static const vshCmdInfo info_pool_uuid[] = {
7669
    {"help", N_("convert a pool name to pool UUID")},
7670
    {"desc", ""},
7671 7672 7673
    {NULL, NULL}
};

7674
static const vshCmdOptDef opts_pool_uuid[] = {
7675
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
7676 7677 7678
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7679
static bool
7680
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
7681 7682 7683 7684
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

7685
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7686
        return false;
7687 7688

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7689
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7690
        return false;
7691 7692 7693 7694

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

L
Laine Stump 已提交
7697
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7698
    return true;
7699 7700 7701 7702 7703 7704
}


/*
 * "vol-create" command
 */
7705
static const vshCmdInfo info_vol_create[] = {
7706 7707
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
7708 7709 7710
    {NULL, NULL}
};

7711
static const vshCmdOptDef opts_vol_create[] = {
7712 7713
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
7714 7715 7716
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7717
static bool
7718
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
7719 7720 7721
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7722
    const char *from = NULL;
E
Eric Blake 已提交
7723
    bool ret = true;
7724 7725
    char *buffer;

7726
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7727
        return false;
7728 7729

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

7733
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7734
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7735
        return false;
7736 7737 7738
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7739
        virshReportError(ctl);
7740
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7741
        return false;
7742 7743 7744
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
7745
    VIR_FREE(buffer);
7746 7747 7748 7749 7750 7751 7752
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
7753
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
7754
        ret = false;
7755 7756 7757 7758
    }
    return ret;
}

7759 7760 7761 7762
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
7763 7764
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
7765 7766 7767 7768
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
7769 7770 7771
    {"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 已提交
7772
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
7773 7774 7775
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7776
static bool
7777 7778 7779 7780
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
7781
    const char *from = NULL;
E
Eric Blake 已提交
7782
    bool ret = false;
7783 7784
    char *buffer = NULL;

7785
    if (!vshConnectionUsability(ctl, ctl->conn))
7786 7787 7788 7789 7790
        goto cleanup;

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

7791
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7792 7793 7794 7795 7796 7797 7798
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7799
        virshReportError(ctl);
7800 7801 7802 7803 7804 7805 7806 7807 7808
        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 {
7809
        vshError(ctl, _("Failed to create vol from %s"), from);
7810 7811 7812
        goto cleanup;
    }

E
Eric Blake 已提交
7813
    ret = true;
7814
cleanup:
7815
    VIR_FREE(buffer);
7816 7817 7818 7819
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
7820 7821
    if (newvol)
        virStorageVolFree(newvol);
7822 7823 7824 7825
    return ret;
}

static xmlChar *
7826
makeCloneXML(const char *origxml, const char *newname) {
7827

7828 7829 7830
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
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
    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[] = {
7861 7862
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
7863 7864 7865 7866
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
7867 7868
    {"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 已提交
7869
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7870 7871 7872
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7873
static bool
7874 7875 7876 7877
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
7878
    const char *name = NULL;
7879
    char *origxml = NULL;
7880
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
7881
    bool ret = false;
7882

7883
    if (!vshConnectionUsability(ctl, ctl->conn))
7884 7885 7886 7887 7888 7889 7890
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
7891
        vshError(ctl, "%s", _("failed to get parent pool"));
7892 7893 7894
        goto cleanup;
    }

7895
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913
        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 {
7914
        vshError(ctl, _("Failed to clone vol from %s"),
7915 7916 7917 7918
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
7919
    ret = true;
7920 7921

cleanup:
7922
    VIR_FREE(origxml);
7923 7924 7925
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
7926 7927
    if (newvol)
        virStorageVolFree(newvol);
7928 7929 7930 7931 7932
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945

/*
 * "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 已提交
7946
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960
    {"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 已提交
7961
static bool
7962 7963 7964 7965
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7966
    bool ret = false;
7967 7968 7969 7970 7971 7972 7973 7974 7975 7976
    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 已提交
7977
        return false;
7978 7979 7980 7981
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7982
        return false;
7983 7984 7985
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7986
        return false;
7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020
    }

    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 已提交
8021
    ret = true;
8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045

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 已提交
8046
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8047 8048 8049 8050 8051
    {"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}
};

E
Eric Blake 已提交
8052
static bool
8053 8054 8055 8056
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8057
    bool ret = false;
8058 8059 8060 8061
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
8062
    bool created = false;
8063 8064

    if (!vshConnectionUsability(ctl, ctl->conn))
8065
        return false;
8066 8067 8068

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8069
        return false;
8070 8071 8072 8073
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8074
        return false;
8075 8076 8077
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
8078
        return false;
8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090

    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;
        }
8091 8092
    } else {
        created = true;
8093 8094 8095 8096 8097 8098 8099 8100
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

8101
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116
        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 已提交
8117
    ret = true;
8118 8119

cleanup:
8120
    VIR_FORCE_CLOSE(fd);
8121
    if (!ret && created)
8122 8123 8124 8125 8126 8127 8128 8129 8130
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


8131 8132 8133
/*
 * "vol-delete" command
 */
8134
static const vshCmdInfo info_vol_delete[] = {
8135 8136
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
8137 8138 8139
    {NULL, NULL}
};

8140
static const vshCmdOptDef opts_vol_delete[] = {
8141
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8142
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8143 8144 8145
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8146
static bool
8147
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
8148 8149
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8150
    bool ret = true;
8151
    const char *name;
8152

8153
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8154
        return false;
8155 8156

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8157
        return false;
8158 8159 8160
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
8161
        vshPrint(ctl, _("Vol %s deleted\n"), name);
8162
    } else {
8163
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
8164
        ret = false;
8165 8166
    }

L
Laine Stump 已提交
8167
    virStorageVolFree(vol);
8168 8169 8170 8171
    return ret;
}


D
David Allan 已提交
8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182
/*
 * "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 已提交
8183
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
8184 8185 8186
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8187
static bool
D
David Allan 已提交
8188 8189 8190
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8191
    bool ret = true;
8192
    const char *name;
D
David Allan 已提交
8193

8194
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8195
        return false;
D
David Allan 已提交
8196 8197

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8198
        return false;
D
David Allan 已提交
8199 8200 8201 8202 8203 8204
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
8205
        ret = false;
D
David Allan 已提交
8206 8207 8208 8209 8210 8211 8212
    }

    virStorageVolFree(vol);
    return ret;
}


8213 8214 8215
/*
 * "vol-info" command
 */
8216
static const vshCmdInfo info_vol_info[] = {
8217 8218
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
8219 8220 8221
    {NULL, NULL}
};

8222
static const vshCmdOptDef opts_vol_info[] = {
8223
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8224
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8225 8226 8227
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8228
static bool
8229
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
8230 8231 8232
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
8233
    bool ret = true;
8234

8235
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8236
        return false;
8237 8238

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8239
        return false;
8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255

    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 已提交
8256
        ret = false;
8257 8258 8259 8260 8261 8262 8263 8264 8265 8266
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
8267
static const vshCmdInfo info_vol_dumpxml[] = {
8268 8269
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
8270 8271 8272
    {NULL, NULL}
};

8273
static const vshCmdOptDef opts_vol_dumpxml[] = {
8274
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8275
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8276 8277 8278
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8279
static bool
8280
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
8281 8282
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8283
    bool ret = true;
8284 8285
    char *dump;

8286
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8287
        return false;
8288 8289

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8290
        return false;
8291 8292 8293

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
8294
        vshPrint(ctl, "%s", dump);
8295
        VIR_FREE(dump);
8296
    } else {
E
Eric Blake 已提交
8297
        ret = false;
8298 8299 8300 8301 8302 8303 8304 8305 8306 8307
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
8308
static const vshCmdInfo info_vol_list[] = {
8309 8310
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
8311 8312 8313
    {NULL, NULL}
};

8314
static const vshCmdOptDef opts_vol_list[] = {
8315
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8316
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
8317 8318 8319
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8320
static bool
8321
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8322
{
8323
    virStorageVolInfo volumeInfo;
8324 8325
    virStoragePoolPtr pool;
    char **activeNames = NULL;
8326 8327 8328 8329 8330
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
8331 8332
    int ret;
    bool functionReturn;
8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343
    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;
8344

8345
    /* Check the connection to libvirtd daemon is still working */
8346
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8347
        return false;
8348

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

8353 8354
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
8355

8356 8357 8358
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8359
        return false;
8360 8361
    }

8362 8363 8364 8365 8366
    /* 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) {
8367
            vshError(ctl, "%s", _("Failed to list active vols"));
8368
            VIR_FREE(activeNames);
8369
            virStoragePoolFree(pool);
E
Eric Blake 已提交
8370
            return false;
8371 8372
        }

8373 8374 8375 8376 8377
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

8380 8381 8382 8383 8384
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
8385

8386 8387 8388 8389
        /* 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"));
8390 8391
        }

8392 8393 8394 8395 8396 8397 8398 8399 8400
        /* 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 */
8401

8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456
                /* 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;
        }
8457

8458
        /* Cleanup memory allocation */
8459
        virStorageVolFree(vol);
8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477
    }

    /* 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 已提交
8478
        functionReturn = true;
8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509
        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 已提交
8510 8511 8512 8513 8514
    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);
8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548

    /* 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 已提交
8549
    functionReturn = true;
8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563
    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 已提交
8564
    functionReturn = false;
8565 8566 8567 8568 8569 8570 8571 8572 8573 8574

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);
8575
        VIR_FREE(activeNames[i]);
8576
    }
8577 8578 8579 8580

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
8581
    VIR_FREE(activeNames);
8582
    virStoragePoolFree(pool);
8583 8584 8585

    /* Return the desired value */
    return functionReturn;
8586 8587 8588 8589 8590 8591
}


/*
 * "vol-name" command
 */
8592
static const vshCmdInfo info_vol_name[] = {
8593
    {"help", N_("returns the volume name for a given volume key or path")},
8594
    {"desc", ""},
8595 8596 8597
    {NULL, NULL}
};

8598
static const vshCmdOptDef opts_vol_name[] = {
8599
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
8600 8601 8602
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8603
static bool
8604
cmdVolName(vshControl *ctl, const vshCmd *cmd)
8605 8606 8607
{
    virStorageVolPtr vol;

8608
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8609
        return false;
8610 8611 8612

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
E
Eric Blake 已提交
8613
        return false;
8614 8615 8616

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8617
    return true;
8618 8619 8620
}


J
Justin Clift 已提交
8621 8622 8623 8624 8625 8626 8627 8628 8629 8630
/*
 * "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[] = {
8631
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
8632 8633 8634 8635
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8636
static bool
J
Justin Clift 已提交
8637 8638 8639 8640
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8641
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
8642 8643

    /* Check the connection to libvirtd daemon is still working */
8644
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8645
        return false;
J
Justin Clift 已提交
8646 8647 8648 8649

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
8650
        return false;
J
Justin Clift 已提交
8651 8652 8653 8654 8655 8656 8657
    }

    /* 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 已提交
8658
        return false;
J
Justin Clift 已提交
8659 8660
    }

8661 8662 8663 8664 8665 8666 8667 8668 8669
    /* 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 已提交
8670 8671 8672 8673

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8674
    return true;
J
Justin Clift 已提交
8675 8676
}

8677 8678 8679 8680

/*
 * "vol-key" command
 */
8681
static const vshCmdInfo info_vol_key[] = {
8682
    {"help", N_("returns the volume key for a given volume name or path")},
8683
    {"desc", ""},
8684 8685 8686
    {NULL, NULL}
};

8687
static const vshCmdOptDef opts_vol_key[] = {
8688
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
8689
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8690 8691 8692
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8693
static bool
8694
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
8695 8696 8697
{
    virStorageVolPtr vol;

8698
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8699
        return false;
8700

8701
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8702
        return false;
8703 8704 8705

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8706
    return true;
8707 8708 8709 8710 8711 8712 8713
}



/*
 * "vol-path" command
 */
8714
static const vshCmdInfo info_vol_path[] = {
8715
    {"help", N_("returns the volume path for a given volume name or key")},
8716
    {"desc", ""},
8717 8718 8719
    {NULL, NULL}
};

8720
static const vshCmdOptDef opts_vol_path[] = {
8721
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
8722
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8723 8724 8725
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8726
static bool
8727
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
8728 8729
{
    virStorageVolPtr vol;
8730
    const char *name = NULL;
8731

8732
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8733
        return false;
8734 8735

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8736
        return false;
8737
    }
8738 8739 8740

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8741
    return true;
8742 8743 8744
}


8745 8746 8747 8748
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
8749 8750
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
8751 8752
    {NULL, NULL}
};
8753

8754
static const vshCmdOptDef opts_secret_define[] = {
8755
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
8756 8757
    {NULL, 0, 0, NULL}
};
8758

E
Eric Blake 已提交
8759
static bool
8760 8761
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
8762
    const char *from = NULL;
8763
    char *buffer;
8764
    virSecretPtr res;
8765
    char uuid[VIR_UUID_STRING_BUFLEN];
8766

8767
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8768
        return false;
8769

8770
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8771
        return false;
8772 8773

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
8777
    VIR_FREE(buffer);
8778 8779

    if (res == NULL) {
8780
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
8781
        return false;
8782
    }
8783
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
8784
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
8785
        virSecretFree(res);
E
Eric Blake 已提交
8786
        return false;
8787 8788 8789
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
8790
    return true;
8791 8792 8793 8794 8795 8796
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
8797 8798
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
8799 8800 8801 8802
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
8803
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8804 8805 8806
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8807
static bool
8808 8809 8810
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8811
    bool ret = false;
8812 8813
    char *xml;

8814
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8815
        return false;
8816 8817 8818

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8819
        return false;
8820 8821 8822 8823

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
8824
    vshPrint(ctl, "%s", xml);
8825
    VIR_FREE(xml);
E
Eric Blake 已提交
8826
    ret = true;
8827 8828 8829 8830 8831 8832 8833 8834 8835 8836

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
8837 8838
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
8839 8840 8841 8842
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
8843 8844
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
8845 8846 8847
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8848
static bool
8849 8850 8851 8852
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
8853
    const char *base64 = NULL;
8854
    char *value;
E
Eric Blake 已提交
8855 8856
    int res;
    bool ret = false;
8857

8858
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8859
        return false;
8860 8861 8862

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

8865
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
8866 8867 8868
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
8869
        vshError(ctl, "%s", _("Invalid base64 data"));
8870 8871 8872
        goto cleanup;
    }
    if (value == NULL) {
8873
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
8874
        return false;
8875 8876 8877 8878
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
8879
    VIR_FREE(value);
8880 8881

    if (res != 0) {
8882
        vshError(ctl, "%s", _("Failed to set secret value"));
8883 8884 8885
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
8886
    ret = true;
8887 8888 8889 8890 8891 8892 8893 8894 8895 8896

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
8897 8898
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
8899 8900 8901 8902
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
8903
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8904 8905 8906
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8907
static bool
8908 8909 8910 8911 8912 8913
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
8914
    bool ret = false;
8915

8916
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8917
        return false;
8918 8919 8920

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8921
        return false;
8922 8923 8924 8925 8926 8927 8928

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
8929
    VIR_FREE(value);
8930 8931

    if (base64 == NULL) {
8932
        vshError(ctl, "%s", _("Failed to allocate memory"));
8933 8934
        goto cleanup;
    }
8935
    vshPrint(ctl, "%s", base64);
8936
    memset(base64, 0, strlen(base64));
8937
    VIR_FREE(base64);
E
Eric Blake 已提交
8938
    ret = true;
8939 8940 8941 8942 8943 8944 8945 8946 8947 8948

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
8949 8950
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
8951 8952 8953 8954
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
8955
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8956 8957 8958
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8959
static bool
8960 8961 8962
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8963
    bool ret = false;
8964
    const char *uuid;
8965

8966
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8967
        return false;
8968 8969 8970

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
8971
        return false;
8972 8973

    if (virSecretUndefine(secret) < 0) {
8974
        vshError(ctl, _("Failed to delete secret %s"), uuid);
8975 8976 8977
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
8978
    ret = true;
8979 8980 8981 8982 8983 8984 8985 8986 8987 8988

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
8989 8990
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
8991 8992 8993
    {NULL, NULL}
};

E
Eric Blake 已提交
8994
static bool
8995 8996 8997 8998 8999
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

9000
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9001
        return false;
9002 9003 9004

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
9005
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
9006
        return false;
9007 9008 9009 9010 9011
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
9012
        vshError(ctl, "%s", _("Failed to list secrets"));
9013
        VIR_FREE(uuids);
E
Eric Blake 已提交
9014
        return false;
9015 9016 9017 9018
    }

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

9019 9020
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
9021 9022

    for (i = 0; i < maxuuids; i++) {
9023 9024 9025 9026
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
9027
            VIR_FREE(uuids[i]);
9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045
            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);
9046
        VIR_FREE(uuids[i]);
9047
    }
9048
    VIR_FREE(uuids);
E
Eric Blake 已提交
9049
    return true;
9050
}
9051 9052 9053 9054 9055


/*
 * "version" command
 */
9056
static const vshCmdInfo info_version[] = {
9057 9058
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
9059 9060 9061
    {NULL, NULL}
};

9062 9063 9064 9065
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
9066

E
Eric Blake 已提交
9067
static bool
9068
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9069 9070 9071 9072 9073 9074
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
9075
    unsigned long daemonVersion;
9076 9077 9078 9079 9080
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

9081
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9082
        return false;
9083 9084 9085

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
9086
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
9087
        return false;
9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098 9099
    }

    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) {
9100
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
9101
        return false;
9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118
    }
    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) {
9119
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
9120
        return false;
9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133
    }
    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);
    }
9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148

    if (vshCommandOptBool(cmd, "daemon")) {
        ret = virConnectGetLibVersion(ctl->conn, &daemonVersion);
        if (ret < 0) {
            vshError(ctl, "%s", _("failed to get the daemon version"));
        } else {
            major = daemonVersion / 1000000;
            daemonVersion %= 1000000;
            minor = daemonVersion / 1000;
            rel = daemonVersion % 1000;
            vshPrint(ctl, _("Running against daemon: %d.%d.%d\n"),
                     major, minor, rel);
        }
    }

E
Eric Blake 已提交
9149
    return true;
9150 9151
}

9152 9153 9154 9155
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
9156
    {"help", N_("enumerate devices on this host")},
9157
    {"desc", ""},
9158 9159 9160 9161
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
9162 9163
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
9164 9165 9166
    {NULL, 0, 0, NULL}
};

9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188
#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] = '-';
9189 9190
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
9191 9192 9193
    }

    /* Print this device */
9194
    vshPrint(ctl, "%s", indentBuf);
9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217
    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) {
9218
        vshPrint(ctl, "%s", indentBuf);
9219
        vshPrint(ctl, " |\n");
9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241
    }

    /* 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) {
9242
        vshPrint(ctl, "%s", indentBuf);
9243 9244 9245 9246
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
9247
static bool
9248 9249
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
9250
    const char *cap = NULL;
9251
    char **devices;
9252
    int num_devices, i;
9253
    int tree = vshCommandOptBool(cmd, "tree");
9254

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

9258
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
9259 9260 9261 9262
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
9263
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
9264
        return false;
9265
    } else if (num_devices == 0) {
E
Eric Blake 已提交
9266
        return true;
9267 9268 9269 9270 9271 9272
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
9273
        vshError(ctl, "%s", _("Failed to list node devices"));
9274
        VIR_FREE(devices);
E
Eric Blake 已提交
9275
        return false;
9276
    }
9277
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
9278 9279 9280 9281 9282 9283 9284
    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 已提交
9285
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304
            } 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++) {
9305 9306
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
9307
        }
9308
        VIR_FREE(parents);
9309 9310 9311
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
9312
            VIR_FREE(devices[i]);
9313
        }
9314
    }
9315
    VIR_FREE(devices);
E
Eric Blake 已提交
9316
    return true;
9317 9318 9319 9320 9321 9322
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
9323 9324
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
9325 9326 9327 9328 9329
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
9330
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9331 9332 9333
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9334
static bool
9335 9336
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
9337
    const char *name = NULL;
9338
    virNodeDevicePtr device;
L
Laine Stump 已提交
9339
    char *xml;
9340

9341
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9342
        return false;
9343
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9344
        return false;
9345
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9346
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9347
        return false;
9348 9349
    }

L
Laine Stump 已提交
9350 9351 9352
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
9353
        return false;
L
Laine Stump 已提交
9354 9355 9356
    }

    vshPrint(ctl, "%s\n", xml);
9357
    VIR_FREE(xml);
9358
    virNodeDeviceFree(device);
E
Eric Blake 已提交
9359
    return true;
9360 9361
}

9362 9363 9364 9365
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
9366 9367
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
9368 9369 9370 9371 9372
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
9373
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9374 9375 9376
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9377
static bool
9378 9379
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
9380
    const char *name = NULL;
9381
    virNodeDevicePtr device;
E
Eric Blake 已提交
9382
    bool ret = true;
9383

9384
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9385
        return false;
9386
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9387
        return false;
9388
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9389
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9390
        return false;
9391 9392 9393 9394 9395
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
9396
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
9397
        ret = false;
9398 9399 9400 9401 9402 9403 9404 9405 9406
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
9407 9408
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
9409 9410 9411 9412 9413
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
9414
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9415 9416 9417
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9418
static bool
9419 9420
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
9421
    const char *name = NULL;
9422
    virNodeDevicePtr device;
E
Eric Blake 已提交
9423
    bool ret = true;
9424

9425
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9426
        return false;
9427
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9428
        return false;
9429
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9430
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9431
        return false;
9432 9433 9434 9435 9436
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
9437
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
9438
        ret = false;
9439 9440 9441 9442 9443 9444 9445 9446 9447
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
9448 9449
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
9450 9451 9452 9453 9454
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
9455
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9456 9457 9458
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9459
static bool
9460 9461
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
9462
    const char *name = NULL;
9463
    virNodeDevicePtr device;
E
Eric Blake 已提交
9464
    bool ret = true;
9465

9466
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9467
        return false;
9468
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9469
        return false;
9470
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9471
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9472
        return false;
9473 9474 9475 9476 9477
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
9478
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
9479
        ret = false;
9480 9481 9482 9483 9484
    }
    virNodeDeviceFree(device);
    return ret;
}

9485
/*
E
Eric Blake 已提交
9486
 * "hostname" command
9487
 */
9488
static const vshCmdInfo info_hostname[] = {
9489
    {"help", N_("print the hypervisor hostname")},
9490
    {"desc", ""},
9491 9492 9493
    {NULL, NULL}
};

E
Eric Blake 已提交
9494
static bool
9495
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9496 9497 9498
{
    char *hostname;

9499
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9500
        return false;
9501 9502 9503

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
9504
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
9505
        return false;
9506 9507 9508
    }

    vshPrint (ctl, "%s\n", hostname);
9509
    VIR_FREE(hostname);
9510

E
Eric Blake 已提交
9511
    return true;
9512 9513 9514 9515 9516
}

/*
 * "uri" command
 */
9517
static const vshCmdInfo info_uri[] = {
9518
    {"help", N_("print the hypervisor canonical URI")},
9519
    {"desc", ""},
9520 9521 9522
    {NULL, NULL}
};

E
Eric Blake 已提交
9523
static bool
9524
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9525 9526 9527
{
    char *uri;

9528
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9529
        return false;
9530 9531 9532

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
9533
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
9534
        return false;
9535 9536 9537
    }

    vshPrint (ctl, "%s\n", uri);
9538
    VIR_FREE(uri);
9539

E
Eric Blake 已提交
9540
    return true;
9541 9542
}

E
Eric Blake 已提交
9543 9544 9545 9546 9547 9548 9549 9550 9551 9552
/*
 * "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 已提交
9553
static bool
E
Eric Blake 已提交
9554 9555 9556 9557 9558
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9559
        return false;
E
Eric Blake 已提交
9560 9561 9562 9563

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
9564
        return false;
E
Eric Blake 已提交
9565 9566 9567 9568 9569
    }

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

E
Eric Blake 已提交
9570
    return true;
E
Eric Blake 已提交
9571 9572
}

9573 9574 9575
/*
 * "vncdisplay" command
 */
9576
static const vshCmdInfo info_vncdisplay[] = {
9577 9578
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
9579 9580 9581
    {NULL, NULL}
};

9582
static const vshCmdOptDef opts_vncdisplay[] = {
9583
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9584 9585 9586
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9587
static bool
9588
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
9589 9590 9591 9592 9593
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9594
    bool ret = false;
9595 9596 9597
    int port = 0;
    char *doc;

9598
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9599
        return false;
9600

J
Jim Meyering 已提交
9601
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9602
        return false;
9603 9604 9605 9606 9607 9608 9609 9610

    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);
9611
    VIR_FREE(doc);
9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629
    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) ||
9630
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
9631 9632 9633 9634 9635 9636
        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 已提交
9637
    ret = true;
9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650

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

/*
 * "ttyconsole" command
 */
9651
static const vshCmdInfo info_ttyconsole[] = {
9652 9653
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
9654 9655 9656
    {NULL, NULL}
};

9657
static const vshCmdOptDef opts_ttyconsole[] = {
9658
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9659 9660 9661
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9662
static bool
9663
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
9664 9665 9666 9667 9668
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9669
    bool ret = false;
9670 9671
    char *doc;

9672
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9673
        return false;
9674

J
Jim Meyering 已提交
9675
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9676
        return false;
9677 9678 9679 9680 9681 9682 9683 9684

    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);
9685
    VIR_FREE(doc);
9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697
    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 已提交
9698
    ret = true;
9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710

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

/*
 * "attach-device" command
9711
 */
9712
static const vshCmdInfo info_attach_device[] = {
9713 9714
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
9715 9716 9717
    {NULL, NULL}
};

9718
static const vshCmdOptDef opts_attach_device[] = {
9719 9720 9721
    {"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")},
9722 9723 9724
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9725
static bool
9726
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
9727 9728
{
    virDomainPtr dom;
9729
    const char *from = NULL;
9730
    char *buffer;
W
Wen Congyang 已提交
9731
    int ret;
J
Jim Fehlig 已提交
9732
    unsigned int flags;
9733

9734
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9735
        return false;
9736

J
Jim Meyering 已提交
9737
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9738
        return false;
9739

9740
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9741
        virDomainFree(dom);
E
Eric Blake 已提交
9742
        return false;
9743 9744
    }

9745
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9746
        virshReportError(ctl);
9747
        virDomainFree(dom);
E
Eric Blake 已提交
9748
        return false;
9749
    }
9750

J
Jim Fehlig 已提交
9751
    if (vshCommandOptBool(cmd, "persistent")) {
9752
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
9753
        if (virDomainIsActive(dom) == 1)
9754
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
9755 9756 9757 9758
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
9759
    VIR_FREE(buffer);
9760 9761

    if (ret < 0) {
9762
        vshError(ctl, _("Failed to attach device from %s"), from);
9763
        virDomainFree(dom);
E
Eric Blake 已提交
9764
        return false;
9765
    } else {
J
Jim Meyering 已提交
9766
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
9767 9768 9769
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9770
    return true;
9771 9772 9773 9774 9775 9776
}


/*
 * "detach-device" command
 */
9777
static const vshCmdInfo info_detach_device[] = {
9778 9779
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
9780 9781 9782
    {NULL, NULL}
};

9783
static const vshCmdOptDef opts_detach_device[] = {
9784 9785 9786
    {"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")},
9787 9788 9789
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9790
static bool
9791
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
9792 9793
{
    virDomainPtr dom;
9794
    const char *from = NULL;
9795
    char *buffer;
W
Wen Congyang 已提交
9796
    int ret;
J
Jim Fehlig 已提交
9797
    unsigned int flags;
9798

9799
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9800
        return false;
9801

J
Jim Meyering 已提交
9802
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9803
        return false;
9804

9805
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9806
        virDomainFree(dom);
E
Eric Blake 已提交
9807
        return false;
9808 9809
    }

9810
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9811
        virshReportError(ctl);
9812
        virDomainFree(dom);
E
Eric Blake 已提交
9813
        return false;
9814
    }
9815

J
Jim Fehlig 已提交
9816
    if (vshCommandOptBool(cmd, "persistent")) {
9817
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
9818
        if (virDomainIsActive(dom) == 1)
9819
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
9820 9821 9822 9823
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
9824
    VIR_FREE(buffer);
9825 9826

    if (ret < 0) {
9827
        vshError(ctl, _("Failed to detach device from %s"), from);
9828
        virDomainFree(dom);
E
Eric Blake 已提交
9829
        return false;
9830
    } else {
J
Jim Meyering 已提交
9831
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
9832 9833 9834
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9835
    return true;
9836 9837
}

9838

9839 9840 9841 9842 9843 9844 9845 9846 9847 9848 9849 9850 9851
/*
 * "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")},
9852
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
9853 9854 9855
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9856
static bool
9857 9858 9859
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
9860
    const char *from = NULL;
9861
    char *buffer;
W
Wen Congyang 已提交
9862
    int ret;
9863 9864
    unsigned int flags;

9865
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9866
        return false;
9867 9868

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

9871
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9872
        virDomainFree(dom);
E
Eric Blake 已提交
9873
        return false;
9874 9875 9876
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9877
        virshReportError(ctl);
9878
        virDomainFree(dom);
E
Eric Blake 已提交
9879
        return false;
9880 9881 9882
    }

    if (vshCommandOptBool(cmd, "persistent")) {
9883
        flags = VIR_DOMAIN_AFFECT_CONFIG;
9884
        if (virDomainIsActive(dom) == 1)
9885
           flags |= VIR_DOMAIN_AFFECT_LIVE;
9886
    } else {
9887
        flags = VIR_DOMAIN_AFFECT_LIVE;
9888
    }
9889 9890 9891 9892

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

9893 9894 9895 9896 9897 9898
    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 已提交
9899
        return false;
9900 9901 9902 9903 9904
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9905
    return true;
9906 9907 9908
}


9909 9910 9911
/*
 * "attach-interface" command
 */
9912
static const vshCmdInfo info_attach_interface[] = {
9913 9914
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
9915 9916 9917
    {NULL, NULL}
};

9918
static const vshCmdOptDef opts_attach_interface[] = {
9919 9920 9921 9922 9923 9924
    {"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")},
9925
    {"model", VSH_OT_DATA, 0, N_("model type")},
9926
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
9927 9928 9929
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9930
static bool
9931
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
9932 9933
{
    virDomainPtr dom = NULL;
9934 9935
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
9936
    int typ;
W
Wen Congyang 已提交
9937 9938
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9939
    unsigned int flags;
9940 9941
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9942

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

J
Jim Meyering 已提交
9946
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9947 9948
        goto cleanup;

9949
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9950 9951
        goto cleanup;

9952 9953 9954 9955
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
9956 9957
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
9958
        goto cleanup;
9959
    }
9960 9961

    /* check interface type */
9962
    if (STREQ(type, "network")) {
9963
        typ = 1;
9964
    } else if (STREQ(type, "bridge")) {
9965 9966
        typ = 2;
    } else {
E
Eric Blake 已提交
9967 9968
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
9969 9970 9971 9972
        goto cleanup;
    }

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

9975
    if (typ == 1)
9976
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
9977
    else if (typ == 2)
9978
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
9979

9980
    if (target != NULL)
9981
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9982
    if (mac != NULL)
9983
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
9984
    if (script != NULL)
9985
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
9986
    if (model != NULL)
9987
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
9988

9989
    virBufferAddLit(&buf, "</interface>\n");
9990

9991 9992
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
9993
        goto cleanup;
9994 9995
    }

9996
    xml = virBufferContentAndReset(&buf);
9997

J
Jim Fehlig 已提交
9998
    if (vshCommandOptBool(cmd, "persistent")) {
9999
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10000
        if (virDomainIsActive(dom) == 1)
10001
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10002
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
10003
    } else {
10004
        ret = virDomainAttachDevice(dom, xml);
10005
    }
10006

10007 10008
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10009
    if (ret != 0) {
L
Laine Stump 已提交
10010
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
10011 10012
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
10013
        functionReturn = true;
J
Jim Fehlig 已提交
10014
    }
10015 10016 10017 10018

 cleanup:
    if (dom)
        virDomainFree(dom);
10019
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10020
    return functionReturn;
10021 10022 10023 10024 10025
}

/*
 * "detach-interface" command
 */
10026
static const vshCmdInfo info_detach_interface[] = {
10027 10028
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
10029 10030 10031
    {NULL, NULL}
};

10032
static const vshCmdOptDef opts_detach_interface[] = {
10033 10034 10035 10036
    {"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")},
10037 10038 10039
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10040
static bool
10041
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
10042 10043 10044 10045 10046 10047 10048
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
10049
    const char *mac =NULL, *type = NULL;
10050
    char *doc;
10051
    char buf[64];
E
Eric Blake 已提交
10052
    int i = 0, diff_mac;
W
Wen Congyang 已提交
10053 10054
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
10055
    unsigned int flags;
10056

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

J
Jim Meyering 已提交
10060
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10061 10062
        goto cleanup;

10063
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10064 10065
        goto cleanup;

10066 10067
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
10068
        goto cleanup;
10069
    }
10070 10071 10072 10073 10074 10075 10076 10077

    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);
10078
    VIR_FREE(doc);
10079
    if (!xml) {
10080
        vshError(ctl, "%s", _("Failed to get interface information"));
10081 10082 10083 10084
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
10085
        vshError(ctl, "%s", _("Failed to get interface information"));
10086 10087 10088
        goto cleanup;
    }

E
Eric Blake 已提交
10089
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
10090 10091 10092
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10093
        vshError(ctl, _("No found interface whose type is %s"), type);
10094 10095 10096
        goto cleanup;
    }

10097 10098 10099 10100 10101 10102
    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;
    }

10103 10104 10105 10106 10107 10108 10109
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10110 10111 10112 10113 10114
            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);
10115 10116 10117 10118 10119 10120 10121
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10122
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
10123 10124 10125 10126 10127
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10128
        vshError(ctl, "%s", _("Failed to allocate memory"));
10129 10130 10131
        goto cleanup;
    }

10132
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
10133
        vshError(ctl, "%s", _("Failed to create XML"));
10134 10135 10136
        goto cleanup;
    }

J
Jim Fehlig 已提交
10137
    if (vshCommandOptBool(cmd, "persistent")) {
10138
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10139
        if (virDomainIsActive(dom) == 1)
10140
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10141 10142 10143 10144 10145 10146 10147 10148
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10149
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
10150
    } else {
J
Jim Meyering 已提交
10151
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
10152
        functionReturn = true;
10153
    }
10154 10155 10156 10157

 cleanup:
    if (dom)
        virDomainFree(dom);
10158
    xmlXPathFreeObject(obj);
10159
    xmlXPathFreeContext(ctxt);
10160 10161 10162 10163
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
10164
    return functionReturn;
10165 10166 10167 10168 10169
}

/*
 * "attach-disk" command
 */
10170
static const vshCmdInfo info_attach_disk[] = {
10171 10172
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
10173 10174 10175
    {NULL, NULL}
};

10176
static const vshCmdOptDef opts_attach_disk[] = {
10177 10178 10179 10180 10181 10182 10183 10184
    {"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")},
10185
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
10186 10187 10188
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10189
static bool
10190
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
10191 10192
{
    virDomainPtr dom = NULL;
10193 10194
    const char *source = NULL, *target = NULL, *driver = NULL,
                *subdriver = NULL, *type = NULL, *mode = NULL;
W
Wen Congyang 已提交
10195 10196
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
10197
    unsigned int flags;
10198
    const char *stype = NULL;
10199 10200
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10201

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

J
Jim Meyering 已提交
10205
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10206 10207
        goto cleanup;

10208
    if (vshCommandOptString(cmd, "source", &source) <= 0)
10209 10210
        goto cleanup;

10211
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10212 10213
        goto cleanup;

10214 10215 10216 10217 10218
    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) {
10219
        vshError(ctl, "%s", _("missing option"));
10220 10221
        goto cleanup;
    }
10222

10223 10224
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
10225
            isFile = true;
10226
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
10227
        isFile = true;
10228 10229 10230
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
10231 10232 10233
    }

    if (mode) {
10234
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
10235 10236
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
10237 10238 10239 10240 10241
            goto cleanup;
        }
    }

    /* Make XML of disk */
10242
    virBufferAsprintf(&buf, "<disk type='%s'",
10243 10244
                      (isFile) ? "file" : "block");
    if (type)
10245
        virBufferAsprintf(&buf, " device='%s'", type);
10246 10247
    virBufferAddLit(&buf, ">\n");

10248
    if (driver || subdriver)
10249
        virBufferAsprintf(&buf, "  <driver");
10250 10251

    if (driver)
10252
        virBufferAsprintf(&buf, " name='%s'", driver);
10253
    if (subdriver)
10254
        virBufferAsprintf(&buf, " type='%s'", subdriver);
10255 10256 10257

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

10259
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
10260 10261
                      (isFile) ? "file" : "dev",
                      source);
10262
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10263
    if (mode)
10264
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
10265 10266

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

10268 10269
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
10270
        return false;
10271 10272
    }

10273
    xml = virBufferContentAndReset(&buf);
10274

J
Jim Fehlig 已提交
10275
    if (vshCommandOptBool(cmd, "persistent")) {
10276
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10277
        if (virDomainIsActive(dom) == 1)
10278
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10279
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
10280
    } else {
10281
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
10282
    }
10283

10284 10285
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10286
    if (ret != 0) {
L
Laine Stump 已提交
10287
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
10288 10289
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
10290
        functionReturn = true;
J
Jim Fehlig 已提交
10291
    }
10292 10293 10294 10295

 cleanup:
    if (dom)
        virDomainFree(dom);
10296
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10297
    return functionReturn;
10298 10299 10300 10301 10302
}

/*
 * "detach-disk" command
 */
10303
static const vshCmdInfo info_detach_disk[] = {
10304 10305
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
10306 10307 10308
    {NULL, NULL}
};

10309
static const vshCmdOptDef opts_detach_disk[] = {
10310 10311 10312
    {"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")},
10313 10314 10315
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10316
static bool
10317
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
10318 10319 10320 10321 10322 10323 10324
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
10325
    const char *target = NULL;
10326
    char *doc;
E
Eric Blake 已提交
10327
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
10328 10329
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
10330
    unsigned int flags;
10331

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

J
Jim Meyering 已提交
10335
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10336 10337
        goto cleanup;

10338
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10339 10340 10341 10342 10343 10344 10345 10346 10347
        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);
10348
    VIR_FREE(doc);
10349
    if (!xml) {
10350
        vshError(ctl, "%s", _("Failed to get disk information"));
10351 10352 10353 10354
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
10355
        vshError(ctl, "%s", _("Failed to get disk information"));
10356 10357 10358 10359 10360 10361
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10362
        vshError(ctl, "%s", _("Failed to get disk information"));
10363 10364 10365 10366 10367 10368 10369
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10370 10371 10372 10373 10374
            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);
10375 10376 10377 10378 10379 10380 10381
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10382
    vshError(ctl, _("No found disk whose target is %s"), target);
10383 10384 10385 10386 10387
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10388
        vshError(ctl, "%s", _("Failed to allocate memory"));
10389 10390 10391
        goto cleanup;
    }

10392
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
10393
        vshError(ctl, "%s", _("Failed to create XML"));
10394 10395 10396
        goto cleanup;
    }

J
Jim Fehlig 已提交
10397
    if (vshCommandOptBool(cmd, "persistent")) {
10398
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10399
        if (virDomainIsActive(dom) == 1)
10400
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10401 10402 10403 10404 10405 10406 10407 10408
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10409
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
10410
    } else {
J
Jim Meyering 已提交
10411
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
10412
        functionReturn = true;
10413
    }
10414 10415

 cleanup:
10416
    xmlXPathFreeObject(obj);
10417
    xmlXPathFreeContext(ctxt);
10418 10419 10420 10421 10422 10423
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
10424
    return functionReturn;
10425 10426
}

10427 10428 10429 10430
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
10431 10432
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
10433 10434 10435 10436
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
10437
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
10438 10439 10440
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10441
static bool
10442 10443
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
10444
    const char *from = NULL;
E
Eric Blake 已提交
10445
    bool ret = true;
10446 10447 10448
    char *buffer;
    int result;

10449
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10450
        return false;
10451

10452
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10453
        return false;
10454 10455

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
10459
    VIR_FREE(buffer);
10460 10461 10462 10463 10464

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
10465
        ret = false;
10466 10467 10468 10469 10470
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
10471
        ret = true;
10472 10473 10474 10475 10476
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
10477
        ret = true;
10478 10479 10480 10481 10482
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
10483
        ret = false;
10484 10485 10486 10487 10488
    }

    return ret;
}

10489 10490 10491 10492
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
10493 10494
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
10495 10496 10497 10498
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
10499
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
10500 10501 10502
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10503
static bool
10504 10505
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
10506
    const char *from = NULL;
E
Eric Blake 已提交
10507
    bool ret = true;
10508 10509 10510 10511 10512
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
10513
    xmlNodePtr node_list;
10514 10515 10516 10517 10518 10519
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

10520
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10521
        return false;
10522

10523
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10524
        return false;
10525 10526

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
10527
        return false;
10528 10529 10530 10531 10532

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

L
Laine Stump 已提交
10533 10534
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
10535 10536
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
10537
        ret = false;
10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573
        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 已提交
10574
        ret = false;
10575 10576 10577 10578 10579 10580 10581 10582
        goto cleanup;
    }

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

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
10583
        ret = false;
10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600

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 已提交
10601
    ret = false;
10602
    goto cleanup;
10603 10604
}

10605 10606 10607 10608 10609 10610 10611 10612
/* 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;

10613
    ret = vshMalloc(ctl, PATH_MAX);
10614 10615 10616

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
10617 10618
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
10619
    if (fd == -1) {
10620
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
10621
                 strerror(errno));
10622
        VIR_FREE(ret);
10623 10624 10625 10626
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
10627 10628
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
10629
        VIR_FORCE_CLOSE(fd);
10630
        unlink (ret);
10631
        VIR_FREE(ret);
10632 10633
        return NULL;
    }
S
Stefan Berger 已提交
10634
    if (VIR_CLOSE(fd) < 0) {
10635 10636
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
10637
        unlink (ret);
10638
        VIR_FREE(ret);
10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650 10651 10652 10653
        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 已提交
10654 10655 10656 10657
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
10658

10659
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
10660 10661 10662 10663
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
10664

10665 10666 10667 10668 10669
    /* 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 已提交
10670 10671
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
10672
     */
E
Eric Blake 已提交
10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684
    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);
10685 10686
    }

E
Eric Blake 已提交
10687 10688 10689 10690 10691 10692 10693
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
10694
    }
E
Eric Blake 已提交
10695
    ret = 0;
10696

E
Eric Blake 已提交
10697 10698 10699
cleanup:
    virCommandFree(cmd);
    return ret;
10700 10701 10702 10703 10704 10705 10706 10707
}

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

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
10708
        vshError(ctl,
10709
                 _("%s: failed to read temporary file: %s"),
10710
                 filename, strerror(errno));
10711 10712 10713 10714 10715
        return NULL;
    }
    return ret;
}

10716

P
Paolo Bonzini 已提交
10717 10718 10719 10720
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
10721 10722
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
10723 10724 10725 10726
    {NULL, NULL}
};

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

E
Eric Blake 已提交
10731
static bool
10732
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
10733
{
10734
    const char *dir = NULL;
10735
    char *dir_malloced = NULL;
E
Eric Blake 已提交
10736
    bool ret = true;
P
Paolo Bonzini 已提交
10737 10738

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

10743
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
10744
        uid_t uid = geteuid();
10745
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
10746 10747 10748 10749
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
10750
    if (chdir(dir) == -1) {
10751
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
10752
        ret = false;
P
Paolo Bonzini 已提交
10753 10754
    }

10755
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
10756
    return ret;
P
Paolo Bonzini 已提交
10757 10758 10759 10760 10761 10762
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
10763 10764
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
10765 10766 10767
    {NULL, NULL}
};

E
Eric Blake 已提交
10768
static bool
P
Paolo Bonzini 已提交
10769 10770 10771
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
10772
    bool ret = true;
P
Paolo Bonzini 已提交
10773

10774 10775
    cwd = getcwd(NULL, 0);
    if (!cwd) {
10776 10777
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
10778 10779
        ret = false;
    } else {
P
Paolo Bonzini 已提交
10780
        vshPrint (ctl, _("%s\n"), cwd);
10781 10782
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
10783

10784
    return ret;
P
Paolo Bonzini 已提交
10785 10786
}

E
Eric Blake 已提交
10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798
/*
 * "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")},
10799
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
10800 10801 10802 10803 10804 10805
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
10806
static bool
E
Eric Blake 已提交
10807 10808 10809 10810 10811
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
10812
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
10813 10814 10815 10816 10817 10818 10819 10820
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

10821
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
10822 10823 10824
        bool close_quote = false;
        char *q;

10825
        arg = opt->data;
E
Eric Blake 已提交
10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853
        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 已提交
10854
        return false;
E
Eric Blake 已提交
10855 10856 10857 10858 10859
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
10860
    return true;
E
Eric Blake 已提交
10861 10862
}

10863 10864 10865 10866
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
10867 10868
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
10869 10870 10871 10872
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
10873
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10874 10875 10876 10877 10878 10879
    {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 已提交
10880
static bool
10881 10882
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
10883
    bool ret = false;
10884 10885 10886 10887 10888
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
10889
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
10890

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

J
Jim Meyering 已提交
10894
    dom = vshCommandOptDomain (ctl, cmd, NULL);
10895 10896 10897 10898
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
10899
    doc = virDomainGetXMLDesc (dom, flags);
10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917
    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 已提交
10918
        ret = true;
10919 10920 10921 10922 10923 10924 10925
        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.
     */
10926
    doc_reread = virDomainGetXMLDesc (dom, flags);
10927 10928 10929 10930
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
10931 10932
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
10933 10934 10935 10936 10937 10938 10939 10940 10941 10942 10943 10944
        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 已提交
10945
    ret = true;
10946 10947 10948 10949 10950

 cleanup:
    if (dom)
        virDomainFree (dom);

10951 10952 10953
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
10954 10955 10956

    if (tmp) {
        unlink (tmp);
10957
        VIR_FREE(tmp);
10958 10959 10960 10961 10962
    }

    return ret;
}

10963

10964 10965 10966 10967
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
10968 10969
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
10970 10971 10972 10973
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
10974
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
10975 10976 10977 10978 10979 10980 10981 10982 10983 10984
    {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[] = {
10985 10986
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
10987 10988 10989 10990
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
10991
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10992 10993 10994 10995 10996 10997
    {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 已提交
10998 10999 11000
/*
 * "quit" command
 */
11001
static const vshCmdInfo info_quit[] = {
11002
    {"help", N_("quit this interactive terminal")},
11003
    {"desc", ""},
11004
    {NULL, NULL}
K
Karel Zak 已提交
11005 11006
};

E
Eric Blake 已提交
11007
static bool
11008
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11009
{
E
Eric Blake 已提交
11010 11011
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
11012 11013
}

11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 11024 11025 11026 11027 11028
/*
 * "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 已提交
11029
static bool
11030 11031 11032
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11033
    bool ret = false;
11034
    const char *from = NULL;
11035 11036 11037 11038 11039 11040 11041
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

11042
    if (!vshConnectionUsability(ctl, ctl->conn))
11043 11044 11045 11046 11047 11048
        goto cleanup;

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

11049
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
11050
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094
    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 已提交
11095
    ret = true;
11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125

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 已提交
11126
static bool
11127 11128 11129
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11130
    bool ret = false;
11131 11132 11133
    int current;
    virDomainSnapshotPtr snapshot = NULL;

11134
    if (!vshConnectionUsability(ctl, ctl->conn))
11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157
        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 已提交
11158
    ret = true;
11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182

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 已提交
11183
static bool
11184 11185 11186
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11187
    bool ret = false;
11188 11189
    int numsnaps;
    char **names = NULL;
11190
    int actual = 0;
11191 11192 11193 11194 11195 11196
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
11197 11198
    long long creation_longlong;
    time_t creation_time_t;
11199 11200 11201
    char timestr[100];
    struct tm time_info;

11202
    if (!vshConnectionUsability(ctl, ctl->conn))
11203 11204 11205 11206 11207 11208 11209 11210 11211 11212 11213
        goto cleanup;

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

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

11214 11215
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256

    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;
11257 11258
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
11259
                continue;
11260 11261 11262 11263 11264 11265
            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);
11266
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
11267 11268 11269 11270 11271

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

E
Eric Blake 已提交
11272
    ret = true;
11273 11274 11275 11276 11277 11278 11279 11280 11281 11282

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);
11283 11284
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298 11299 11300 11301 11302 11303 11304 11305 11306
    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 已提交
11307
static bool
11308 11309 11310
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11311
    bool ret = false;
11312
    const char *name = NULL;
11313 11314 11315
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

11316
    if (!vshConnectionUsability(ctl, ctl->conn))
11317 11318 11319 11320 11321 11322
        goto cleanup;

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

11323
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11324 11325 11326 11327 11328 11329 11330 11331 11332 11333
        goto cleanup;

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

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

11334
    vshPrint(ctl, "%s", xml);
11335

E
Eric Blake 已提交
11336
    ret = true;
11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348

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

    return ret;
}

/*
11349
 * "snapshot-revert" command
11350
 */
11351
static const vshCmdInfo info_snapshot_revert[] = {
11352 11353 11354 11355 11356
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

11357
static const vshCmdOptDef opts_snapshot_revert[] = {
11358 11359 11360 11361 11362
    {"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 已提交
11363
static bool
11364
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
11365 11366
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11367
    bool ret = false;
11368
    const char *name = NULL;
11369 11370
    virDomainSnapshotPtr snapshot = NULL;

11371
    if (!vshConnectionUsability(ctl, ctl->conn))
11372 11373 11374 11375 11376 11377
        goto cleanup;

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

11378
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11379 11380 11381 11382 11383 11384 11385 11386 11387
        goto cleanup;

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

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

E
Eric Blake 已提交
11388
    ret = true;
11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414

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 已提交
11415
static bool
11416 11417 11418
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11419
    bool ret = false;
11420
    const char *name = NULL;
11421 11422 11423
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

11424
    if (!vshConnectionUsability(ctl, ctl->conn))
11425 11426 11427 11428 11429 11430
        goto cleanup;

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

11431
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443
        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 已提交
11444
    ret = true;
11445 11446 11447 11448 11449 11450 11451 11452 11453 11454

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

    return ret;
}

11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466
/*
 * "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")},
11467
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
11468 11469 11470
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11471
static bool
11472 11473 11474
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11475
    bool ret = false;
11476
    const char *monitor_cmd = NULL;
11477
    char *result = NULL;
11478
    unsigned int flags = 0;
11479 11480 11481 11482 11483 11484 11485 11486

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

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

11487
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
11488 11489 11490 11491
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

11492 11493 11494 11495
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
11496 11497 11498 11499
        goto cleanup;

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

E
Eric Blake 已提交
11500
    ret = true;
11501 11502 11503 11504 11505 11506 11507 11508 11509

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

    return ret;
}

11510
static const vshCmdDef domManagementCmds[] = {
11511 11512 11513 11514 11515 11516 11517 11518
    {"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},
11519 11520
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockpullinfo", cmdBlockPullInfo, opts_block_pull_info, info_block_pull_info, 0},
11521
#ifndef WIN32
11522
    {"console", cmdConsole, opts_console, info_console, 0},
11523
#endif
11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554
    {"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},
11555 11556
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
11557 11558 11559 11560 11561
    {"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},
11562
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
11563 11564 11565 11566 11567 11568 11569 11570 11571 11572 11573 11574 11575
    {"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},
11576
    {"version", cmdVersion, opts_version, info_version, 0},
11577 11578
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
11579 11580 11581
};

static const vshCmdDef domMonitoringCmds[] = {
11582 11583
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
11584
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
11585 11586 11587 11588 11589 11590
    {"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}
11591 11592 11593
};

static const vshCmdDef storagePoolCmds[] = {
11594
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
11595
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
11596
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617
     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}
11618 11619 11620
};

static const vshCmdDef storageVolCmds[] = {
11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638
    {"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}
11639
};
11640

11641
static const vshCmdDef networkCmds[] = {
11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660
    {"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}
11661
};
11662

11663
static const vshCmdDef nodedevCmds[] = {
11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678
    {"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}
11679 11680 11681
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
11682 11683 11684 11685
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699
    {"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},
E
Eric Blake 已提交
11700 11701
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
11702 11703 11704 11705 11706
    {"iface-start", cmdInterfaceStart, opts_interface_start,
     info_interface_start, 0},
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine,
     info_interface_undefine, 0},
    {NULL, NULL, NULL, NULL, 0}
11707
};
11708

11709
static const vshCmdDef nwfilterCmds[] = {
11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720
    {"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}
11721
};
11722

11723
static const vshCmdDef secretCmds[] = {
11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735
    {"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}
11736
};
11737

11738
static const vshCmdDef virshCmds[] = {
11739 11740 11741 11742 11743 11744 11745
    {"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}
11746
};
11747

11748
static const vshCmdDef snapshotCmds[] = {
11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761
    {"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}
11762
};
11763

11764
static const vshCmdDef hostAndHypervisorCmds[] = {
11765 11766 11767 11768 11769
    {"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},
11770
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
11771
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
11772
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
11773 11774 11775 11776 11777
    {"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 已提交
11778 11779
};

11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796
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 已提交
11797 11798 11799 11800
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
11801
static const char *
11802
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
11803
{
11804
    const vshCmdInfo *info;
11805

K
Karel Zak 已提交
11806
    for (info = cmd->info; info && info->name; info++) {
11807
        if (STREQ(info->name, name))
K
Karel Zak 已提交
11808 11809 11810 11811 11812
            return info->data;
    }
    return NULL;
}

11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823 11824 11825 11826 11827 11828 11829 11830 11831 11832
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;
        }
L
Lai Jiangshan 已提交
11833 11834 11835 11836 11837 11838
        if (opt->flag & VSH_OFLAG_REQ_OPT) {
            if (opt->flag & VSH_OFLAG_REQ)
                *opts_required |= 1 << i;
            continue;
        }

11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850
        *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;
}

11851
static const vshCmdOptDef *
11852 11853
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
11854
{
11855 11856 11857 11858
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
11859

11860 11861 11862 11863 11864
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
11865 11866 11867 11868 11869
            if (opt->type == VSH_OT_ARGV) {
                vshError(ctl, _("variable argument <%s> "
                         "should not be used with --<%s>"), name, name);
                return NULL;
            }
11870
            *opts_seen |= 1 << i;
K
Karel Zak 已提交
11871
            return opt;
11872 11873 11874 11875 11876
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
11877 11878 11879
    return NULL;
}

11880
static const vshCmdOptDef *
11881 11882
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
11883
{
11884
    int i;
11885
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
11886

11887 11888 11889 11890 11891 11892 11893 11894 11895 11896
    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 已提交
11897 11898
}

11899 11900 11901
/*
 * Checks for required options
 */
11902
static int
11903 11904
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
11905
{
11906
    const vshCmdDef *def = cmd->def;
11907 11908 11909 11910 11911 11912 11913 11914 11915
    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];
11916

11917
            vshError(ctl,
11918
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
11919 11920 11921
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
11922 11923
        }
    }
11924
    return -1;
11925 11926
}

11927
static const vshCmdDef *
11928 11929
vshCmddefSearch(const char *cmdname)
{
11930
    const vshCmdGrp *g;
11931
    const vshCmdDef *c;
11932

11933 11934
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
11935
            if (STREQ(c->name, cmdname))
11936 11937 11938 11939
                return c;
        }
    }

K
Karel Zak 已提交
11940 11941 11942
    return NULL;
}

11943 11944 11945 11946 11947 11948
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
11949
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
11950 11951 11952 11953 11954 11955
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
11956
static bool
11957 11958 11959 11960 11961 11962 11963
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 已提交
11964
        return false;
11965 11966 11967 11968 11969 11970 11971 11972 11973 11974
    } 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 已提交
11975
    return true;
11976 11977
}

E
Eric Blake 已提交
11978
static bool
11979
vshCmddefHelp(vshControl *ctl, const char *cmdname)
11980
{
11981
    const vshCmdDef *def = vshCmddefSearch(cmdname);
11982

K
Karel Zak 已提交
11983
    if (!def) {
11984
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
11985
        return false;
11986
    } else {
E
Eric Blake 已提交
11987 11988
        const char *desc = _(vshCmddefGetInfo(def, "desc"));
        const char *help = _(vshCmddefGetInfo(def, "help"));
11989
        char buf[256];
11990 11991 11992 11993 11994 11995
        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 已提交
11996
            return false;
11997
        }
K
Karel Zak 已提交
11998

11999
        fputs(_("  NAME\n"), stdout);
12000 12001
        fprintf(stdout, "    %s - %s\n", def->name, help);

12002 12003 12004 12005 12006
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
12007
                const char *fmt = "%s";
12008 12009
                switch (opt->type) {
                case VSH_OT_BOOL:
12010
                    fmt = "[--%s]";
12011 12012
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
12013
                    /* xgettext:c-format */
12014 12015
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
12016 12017
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
12018 12019
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
12020 12021
                    break;
                case VSH_OT_DATA:
12022
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
12023 12024 12025
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
12026 12027
                    fmt = (opt->flag & VSH_OFLAG_REQ) ? _("<%s>...")
                           : _("[<%s>]...");
12028 12029
                    break;
                default:
12030
                    assert(0);
12031
                }
12032
                fputc(' ', stdout);
E
Eric Blake 已提交
12033
                fprintf(stdout, fmt, opt->name);
12034
            }
K
Karel Zak 已提交
12035
        }
12036 12037 12038
        fputc('\n', stdout);

        if (desc[0]) {
12039
            /* Print the description only if it's not empty.  */
12040
            fputs(_("\n  DESCRIPTION\n"), stdout);
K
Karel Zak 已提交
12041 12042
            fprintf(stdout, "    %s\n", desc);
        }
12043

K
Karel Zak 已提交
12044
        if (def->opts) {
12045
            const vshCmdOptDef *opt;
12046
            fputs(_("\n  OPTIONS\n"), stdout);
12047
            for (opt = def->opts; opt->name; opt++) {
12048 12049
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
12050
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
12051 12052
                    break;
                case VSH_OT_INT:
12053 12054 12055
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
12056 12057
                    break;
                case VSH_OT_STRING:
12058
                    /* OT_STRING should never be VSH_OFLAG_REQ */
12059
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
12060 12061
                    break;
                case VSH_OT_DATA:
12062 12063
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
12064 12065 12066
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
12067 12068
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
12069 12070 12071
                default:
                    assert(0);
                }
12072

E
Eric Blake 已提交
12073
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
12074
            }
K
Karel Zak 已提交
12075 12076 12077
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
12078
    return true;
K
Karel Zak 已提交
12079 12080 12081 12082 12083 12084
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
12085 12086 12087
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
12088 12089
    vshCmdOpt *a = arg;

12090
    while (a) {
K
Karel Zak 已提交
12091
        vshCmdOpt *tmp = a;
12092

K
Karel Zak 已提交
12093 12094
        a = a->next;

12095 12096
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
12097 12098 12099 12100
    }
}

static void
12101
vshCommandFree(vshCmd *cmd)
12102
{
K
Karel Zak 已提交
12103 12104
    vshCmd *c = cmd;

12105
    while (c) {
K
Karel Zak 已提交
12106
        vshCmd *tmp = c;
12107

K
Karel Zak 已提交
12108 12109 12110 12111
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
12112
        VIR_FREE(tmp);
K
Karel Zak 已提交
12113 12114 12115 12116 12117 12118 12119
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
12120
vshCommandOpt(const vshCmd *cmd, const char *name)
12121
{
K
Karel Zak 已提交
12122
    vshCmdOpt *opt = cmd->opts;
12123 12124

    while (opt) {
12125
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
12126 12127 12128 12129 12130 12131 12132
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
12133 12134 12135 12136 12137 12138 12139 12140 12141
 * @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 已提交
12142 12143
 */
static int
12144
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
12145
{
K
Karel Zak 已提交
12146
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
12147
    int ret = 0, num;
12148
    char *end_p = NULL;
12149

12150
    if ((arg != NULL) && (arg->data != NULL)) {
12151 12152 12153 12154 12155 12156
        num = strtol(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
12157
    }
12158
    return ret;
K
Karel Zak 已提交
12159 12160
}

12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182 12183 12184

/*
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
    unsigned int ret = 0, num;
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
        num = strtoul(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
    }
    return ret;
}


12185 12186 12187 12188 12189 12190
/*
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
12191 12192
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
12193 12194
    int ret = 0;
    unsigned long num;
12195 12196 12197
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
12198 12199 12200 12201 12202 12203
        num = strtoul(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
12204
    }
12205
    return ret;
12206 12207
}

K
Karel Zak 已提交
12208 12209
/*
 * Returns option as STRING
12210
 * See vshCommandOptInt()
K
Karel Zak 已提交
12211
 */
12212 12213
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
12214
{
K
Karel Zak 已提交
12215
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
12216 12217 12218
    int ret = 0;

    if (arg && arg->data) {
E
Eric Blake 已提交
12219 12220 12221 12222
        if (*arg->data
            || (arg->def && (arg->def->flag & VSH_OFLAG_EMPTY_OK))) {
            *value = arg->data;
            ret = 1;
12223 12224
        } else if (arg->def && ((arg->def->flag) & VSH_OFLAG_REQ)) {
            vshError(NULL, _("Missing required option '%s'"), name);
E
Eric Blake 已提交
12225 12226 12227 12228
            ret = -1;
        } else {
            /* Treat "--option ''" as if option had not been specified. */
            ret = 0;
12229 12230
        }
    }
12231

12232
    return ret;
K
Karel Zak 已提交
12233 12234
}

12235 12236
/*
 * Returns option as long long
12237
 * See vshCommandOptInt()
12238
 */
12239 12240 12241
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
12242 12243
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
12244 12245
    int ret = 0;
    long long num;
12246 12247
    char *end_p = NULL;

12248 12249 12250 12251 12252 12253 12254 12255 12256
    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;
12257 12258
}

12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279
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 已提交
12280
/*
E
Eric Blake 已提交
12281
 * Returns true/false if the option exists
K
Karel Zak 已提交
12282
 */
E
Eric Blake 已提交
12283
static bool
12284
vshCommandOptBool(const vshCmd *cmd, const char *name)
12285
{
E
Eric Blake 已提交
12286
    return vshCommandOpt(cmd, name) != NULL;
K
Karel Zak 已提交
12287 12288
}

12289
/*
12290 12291
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
12292
 *
12293
 * Requires that a VSH_OT_ARGV option be last in the
12294 12295
 * list of supported options in CMD->def->opts.
 */
12296 12297
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
12298
{
12299
    opt = opt ? opt->next : cmd->opts;
12300 12301 12302

    while (opt) {
        if (opt->def && opt->def->type == VSH_OT_ARGV) {
12303
            return opt;
12304 12305 12306 12307 12308 12309
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327
/* 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)
12328
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
12329 12330 12331
                 cmd->def->name, optname);
    return found;
}
12332

K
Karel Zak 已提交
12333
static virDomainPtr
J
Jim Meyering 已提交
12334
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
12335
                      const char **name, int flag)
12336
{
K
Karel Zak 已提交
12337
    virDomainPtr dom = NULL;
12338
    const char *n = NULL;
K
Karel Zak 已提交
12339
    int id;
J
Jim Meyering 已提交
12340 12341 12342
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
12343

12344
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12345 12346
        return NULL;

K
Karel Zak 已提交
12347
    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
12348 12349
             cmd->def->name, optname, n);

K
Karel Zak 已提交
12350 12351
    if (name)
        *name = n;
12352

K
Karel Zak 已提交
12353
    /* try it by ID */
12354
    if (flag & VSH_BYID) {
12355
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
12356 12357 12358 12359
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
12360
    }
K
Karel Zak 已提交
12361
    /* try it by UUID */
12362
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
12363
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
12364
                 cmd->def->name, optname);
K
Karel Zak 已提交
12365
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
12366
    }
K
Karel Zak 已提交
12367
    /* try it by NAME */
12368
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
12369
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
12370
                 cmd->def->name, optname);
K
Karel Zak 已提交
12371
        dom = virDomainLookupByName(ctl->conn, n);
12372
    }
K
Karel Zak 已提交
12373

12374
    if (!dom)
12375
        vshError(ctl, _("failed to get domain '%s'"), n);
12376

K
Karel Zak 已提交
12377 12378 12379
    return dom;
}

12380
static virNetworkPtr
J
Jim Meyering 已提交
12381
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
12382
                       const char **name, int flag)
12383 12384
{
    virNetworkPtr network = NULL;
12385
    const char *n = NULL;
J
Jim Meyering 已提交
12386 12387 12388
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
12389

12390
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12391 12392 12393 12394 12395 12396 12397 12398 12399
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
12400
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
12401
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
12402
                 cmd->def->name, optname);
12403 12404 12405 12406
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
12407
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
12408 12409 12410 12411 12412
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
12413
        vshError(ctl, _("failed to get network '%s'"), n);
12414 12415 12416 12417

    return network;
}

12418 12419 12420

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
12421
                        const char **name, int flag)
12422 12423
{
    virNWFilterPtr nwfilter = NULL;
12424
    const char *n = NULL;
12425 12426 12427 12428
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

12429
    if (vshCommandOptString(cmd, optname, &n) <= 0)
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
        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;
}

12457 12458
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
12459
                         const char **name, int flag)
12460 12461
{
    virInterfacePtr iface = NULL;
12462
    const char *n = NULL;
12463 12464 12465 12466
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

12467
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12468 12469 12470 12471 12472 12473 12474 12475 12476
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
12477
    if ((flag & VSH_BYNAME)) {
12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489
        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)
12490
        vshError(ctl, _("failed to get interface '%s'"), n);
12491 12492 12493 12494

    return iface;
}

12495
static virStoragePoolPtr
12496
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
12497
                    const char **name, int flag)
12498 12499
{
    virStoragePoolPtr pool = NULL;
12500
    const char *n = NULL;
12501

12502
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12503 12504 12505 12506 12507 12508 12509 12510 12511
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
12512
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
12513
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
12514
                 cmd->def->name, optname);
12515 12516 12517
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
12518
    if (pool == NULL && (flag & VSH_BYNAME)) {
12519 12520 12521 12522 12523 12524
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
12525
        vshError(ctl, _("failed to get pool '%s'"), n);
12526 12527 12528 12529 12530

    return pool;
}

static virStorageVolPtr
12531
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
12532 12533
                   const char *optname,
                   const char *pooloptname,
12534
                   const char **name, int flag)
12535 12536 12537
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
12538
    const char *n = NULL, *p = NULL;
12539

12540
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12541 12542
        return NULL;

12543 12544
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
12545
        return NULL;
12546
    }
12547 12548 12549 12550 12551 12552 12553 12554 12555 12556

    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;

12557
    /* try it by name */
12558
    if (pool && (flag & VSH_BYNAME)) {
12559
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
12560 12561 12562
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
12563
    /* try it by key */
12564 12565 12566 12567 12568
    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);
    }
12569
    /* try it by path */
12570 12571 12572 12573 12574 12575 12576
    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)
12577
        vshError(ctl, _("failed to get vol '%s'"), n);
12578 12579 12580 12581 12582 12583 12584

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

12585
static virSecretPtr
12586
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
12587 12588
{
    virSecretPtr secret = NULL;
12589
    const char *n = NULL;
12590 12591 12592 12593 12594
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

12595
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12596 12597 12598 12599 12600 12601 12602 12603 12604 12605
        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)
12606
        vshError(ctl, _("failed to get secret '%s'"), n);
12607 12608 12609 12610

    return secret;
}

K
Karel Zak 已提交
12611 12612 12613
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
12614
static bool
12615
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
12616
{
E
Eric Blake 已提交
12617
    bool ret = true;
12618 12619

    while (cmd) {
K
Karel Zak 已提交
12620
        struct timeval before, after;
12621
        bool enable_timing = ctl->timing;
12622

12623 12624
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
12625 12626
            vshReconnect(ctl);

12627
        if (enable_timing)
K
Karel Zak 已提交
12628
            GETTIMEOFDAY(&before);
12629

K
Karel Zak 已提交
12630 12631
        ret = cmd->def->handler(ctl, cmd);

12632
        if (enable_timing)
K
Karel Zak 已提交
12633
            GETTIMEOFDAY(&after);
12634

12635
        if (!ret)
J
John Levon 已提交
12636 12637
            virshReportError(ctl);

12638
        /* try to automatically catch disconnections */
12639
        if (!ret &&
12640 12641 12642 12643 12644 12645 12646 12647 12648
            ((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);

12649
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
12650 12651
            return ret;

12652
        if (enable_timing)
12653
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
12654 12655
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
12656
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
12657 12658 12659 12660 12661 12662
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
12663
 * Command parsing
K
Karel Zak 已提交
12664 12665 12666
 * ---------------
 */

12667 12668 12669 12670 12671 12672 12673 12674 12675 12676
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 已提交
12677
    /* vshCommandStringGetArg() */
12678
    char *pos;
L
Lai Jiangshan 已提交
12679 12680 12681
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
12682 12683
} vshCommandParser;

E
Eric Blake 已提交
12684
static bool
12685
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
12686
{
K
Karel Zak 已提交
12687 12688 12689
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
12690

K
Karel Zak 已提交
12691 12692 12693 12694
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
12695

12696
    while (1) {
K
Karel Zak 已提交
12697
        vshCmdOpt *last = NULL;
12698
        const vshCmdDef *cmd = NULL;
12699
        vshCommandToken tk;
L
Lai Jiangshan 已提交
12700
        bool data_only = false;
12701 12702 12703
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
12704

K
Karel Zak 已提交
12705
        first = NULL;
12706

12707
        while (1) {
12708
            const vshCmdOptDef *opt = NULL;
12709

K
Karel Zak 已提交
12710
            tkdata = NULL;
12711
            tk = parser->getNextArg(ctl, parser, &tkdata);
12712 12713

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
12714
                goto syntaxError;
H
Hu Tao 已提交
12715 12716
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
12717
                break;
H
Hu Tao 已提交
12718
            }
12719 12720

            if (cmd == NULL) {
K
Karel Zak 已提交
12721 12722
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
12723
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
12724
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
12725
                }
12726 12727 12728 12729 12730 12731 12732
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
12733
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
12734 12735 12736 12737
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
12738 12739 12740 12741 12742
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
12743 12744
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
12745
                    VIR_FREE(optstr);
K
Karel Zak 已提交
12746 12747
                    goto syntaxError;
                }
12748
                VIR_FREE(tkdata);
K
Karel Zak 已提交
12749 12750 12751

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
12752 12753 12754
                    if (optstr)
                        tkdata = optstr;
                    else
12755
                        tk = parser->getNextArg(ctl, parser, &tkdata);
12756
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
12757
                        goto syntaxError;
12758
                    if (tk != VSH_TK_ARG) {
12759
                        vshError(ctl,
12760
                                 _("expected syntax: --%s <%s>"),
12761 12762
                                 opt->name,
                                 opt->type ==
12763
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
12764 12765
                        goto syntaxError;
                    }
12766
                    opts_need_arg &= ~opts_seen;
12767 12768 12769 12770 12771 12772 12773 12774
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
12775
                }
L
Lai Jiangshan 已提交
12776 12777 12778 12779
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
12780
            } else {
L
Lai Jiangshan 已提交
12781
get_data:
12782 12783
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
12784
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
12785 12786 12787 12788 12789
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
12790
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
12791

K
Karel Zak 已提交
12792 12793 12794 12795
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
12796

K
Karel Zak 已提交
12797 12798 12799 12800 12801
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
12802

K
Karel Zak 已提交
12803
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
12804 12805
                         cmd->name,
                         opt->name,
12806 12807
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
12808 12809
            }
        }
12810

D
Daniel Veillard 已提交
12811
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
12812
        if (cmd) {
12813
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
12814

K
Karel Zak 已提交
12815 12816 12817 12818
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

12819
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
12820
                VIR_FREE(c);
12821
                goto syntaxError;
12822
            }
12823

K
Karel Zak 已提交
12824 12825 12826 12827 12828 12829
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
12830 12831 12832

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
12833
    }
12834

E
Eric Blake 已提交
12835
    return true;
K
Karel Zak 已提交
12836

12837
 syntaxError:
12838
    if (ctl->cmd) {
K
Karel Zak 已提交
12839
        vshCommandFree(ctl->cmd);
12840 12841
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
12842 12843
    if (first)
        vshCommandOptFree(first);
12844
    VIR_FREE(tkdata);
E
Eric Blake 已提交
12845
    return false;
K
Karel Zak 已提交
12846 12847
}

12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865
/* --------------------
 * 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 已提交
12866 12867
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
12868 12869 12870 12871
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
12872
        return false;
12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944

    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 已提交
12945 12946
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
12947 12948 12949 12950
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
12951
        return false;
12952 12953 12954 12955 12956 12957

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
12958
/* ---------------
12959
 * Misc utils
K
Karel Zak 已提交
12960 12961
 * ---------------
 */
12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989
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 已提交
12990
static const char *
12991 12992
vshDomainStateToString(int state)
{
12993
    switch ((virDomainState) state) {
12994
    case VIR_DOMAIN_RUNNING:
12995
        return N_("running");
12996
    case VIR_DOMAIN_BLOCKED:
12997
        return N_("idle");
12998
    case VIR_DOMAIN_PAUSED:
12999
        return N_("paused");
13000
    case VIR_DOMAIN_SHUTDOWN:
13001
        return N_("in shutdown");
13002
    case VIR_DOMAIN_SHUTOFF:
13003
        return N_("shut off");
13004
    case VIR_DOMAIN_CRASHED:
13005
        return N_("crashed");
13006
    case VIR_DOMAIN_NOSTATE:
13007
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
13008
    }
13009
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
13010 13011
}

13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112
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");
}

13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129
static const char *
vshDomainControlStateToString(int state)
{
    switch ((virDomainControlState) state) {
    case VIR_DOMAIN_CONTROL_OK:
        return N_("ok");
    case VIR_DOMAIN_CONTROL_JOB:
        return N_("background job");
    case VIR_DOMAIN_CONTROL_OCCUPIED:
        return N_("occupied");
    case VIR_DOMAIN_CONTROL_ERROR:
        return N_("error");
    }

    return N_("unknown");
}

13130 13131 13132 13133
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
13134
    case VIR_VCPU_OFFLINE:
13135
        return N_("offline");
13136
    case VIR_VCPU_BLOCKED:
13137
        return N_("idle");
13138
    case VIR_VCPU_RUNNING:
13139
        return N_("running");
13140
    default:
13141
        ;/*FALLTHROUGH*/
13142
    }
13143
    return N_("no state");
13144 13145
}

E
Eric Blake 已提交
13146
static bool
13147
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
13148
{
13149 13150
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
13151 13152
     */
    if (!conn) {
13153
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
13154
        return false;
K
Karel Zak 已提交
13155
    }
E
Eric Blake 已提交
13156
    return true;
K
Karel Zak 已提交
13157 13158
}

K
Karel Zak 已提交
13159
static void
13160
vshDebug(vshControl *ctl, int level, const char *format, ...)
13161
{
K
Karel Zak 已提交
13162
    va_list ap;
13163
    char *str;
K
Karel Zak 已提交
13164

13165 13166 13167 13168
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
13169 13170 13171 13172
    if (level > ctl->debug)
        return;

    va_start(ap, format);
13173 13174 13175 13176 13177
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
13178
    va_end(ap);
13179 13180
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
13181 13182 13183
}

static void
13184
vshPrintExtra(vshControl *ctl, const char *format, ...)
13185
{
K
Karel Zak 已提交
13186
    va_list ap;
13187
    char *str;
13188

13189
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
13190
        return;
13191

K
Karel Zak 已提交
13192
    va_start(ap, format);
13193 13194 13195 13196 13197
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
13198
    va_end(ap);
13199
    fputs(str, stdout);
13200
    VIR_FREE(str);
K
Karel Zak 已提交
13201 13202
}

K
Karel Zak 已提交
13203

K
Karel Zak 已提交
13204
static void
13205
vshError(vshControl *ctl, const char *format, ...)
13206
{
K
Karel Zak 已提交
13207
    va_list ap;
13208
    char *str;
13209

13210 13211 13212 13213 13214
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
13215

13216
    fputs(_("error: "), stderr);
13217

K
Karel Zak 已提交
13218
    va_start(ap, format);
13219 13220 13221
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
13222 13223
    va_end(ap);

13224 13225
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
13226 13227
}

13228

K
Karel Zak 已提交
13229
/*
13230
 * Initialize connection.
K
Karel Zak 已提交
13231
 */
E
Eric Blake 已提交
13232
static bool
13233
vshInit(vshControl *ctl)
13234
{
13235 13236
    char *debugEnv;

K
Karel Zak 已提交
13237
    if (ctl->conn)
E
Eric Blake 已提交
13238
        return false;
K
Karel Zak 已提交
13239

13240 13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260
    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);
        }
    }

13261 13262
    vshOpenLogFile(ctl);

13263 13264
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
13265

13266 13267 13268
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

13269
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
13270
        return false;
13271

13272 13273 13274 13275
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
13276

13277 13278 13279 13280 13281 13282 13283 13284 13285 13286 13287
        /* 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;
        }
13288
    }
K
Karel Zak 已提交
13289

E
Eric Blake 已提交
13290
    return true;
K
Karel Zak 已提交
13291 13292
}

13293 13294
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

13295 13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310 13311 13312 13313
/**
 * 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:
13314
                vshError(ctl, "%s",
J
Jim Meyering 已提交
13315
                         _("failed to get the log file information"));
13316
                exit(EXIT_FAILURE);
13317 13318 13319
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
13320 13321
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
13322 13323 13324 13325
        }
    }

    /* log file open */
13326
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
13327
        vshError(ctl, "%s",
J
Jim Meyering 已提交
13328
                 _("failed to open the log file. check the log file path"));
13329
        exit(EXIT_FAILURE);
13330 13331 13332 13333 13334 13335 13336 13337 13338
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
13339 13340
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
13341
{
13342 13343 13344
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358
    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);
13359
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
13360 13361 13362 13363 13364 13365
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
13366 13367
                      SIGN_NAME,
                      (int) getpid());
13368 13369 13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387
    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;
    }
13388 13389 13390
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
13391

13392 13393
    if (virBufferError(&buf))
        goto error;
13394

13395 13396 13397 13398 13399
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
13400
    }
13401

13402 13403 13404 13405 13406 13407 13408 13409 13410 13411 13412
    /* 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);
13413 13414 13415 13416 13417 13418 13419 13420 13421 13422 13423
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
13424 13425 13426
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
13427 13428 13429
    }

    if (ctl->logfile) {
13430
        VIR_FREE(ctl->logfile);
13431 13432 13433 13434
        ctl->logfile = NULL;
    }
}

13435
#ifdef USE_READLINE
13436

K
Karel Zak 已提交
13437 13438 13439 13440 13441
/* -----------------
 * Readline stuff
 * -----------------
 */

13442
/*
K
Karel Zak 已提交
13443 13444
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
13445
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
13446 13447
 */
static char *
13448 13449
vshReadlineCommandGenerator(const char *text, int state)
{
13450
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
13451
    const char *name;
13452 13453
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
13454 13455

    if (!state) {
13456 13457
        grp_list_index = 0;
        cmd_list_index = 0;
13458
        len = strlen(text);
K
Karel Zak 已提交
13459 13460
    }

13461 13462
    grp = cmdGroups;

K
Karel Zak 已提交
13463
    /* Return the next name which partially matches from the
13464
     * command list.
K
Karel Zak 已提交
13465
     */
13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479
    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 已提交
13480 13481 13482 13483 13484 13485 13486
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
13487 13488
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
13489
    static int list_index, len;
13490
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
13491
    const char *name;
K
Karel Zak 已提交
13492 13493 13494 13495 13496 13497 13498 13499 13500

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

13501
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
13502
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
13503 13504 13505

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
13506
        len = strlen(text);
13507
        VIR_FREE(cmdname);
K
Karel Zak 已提交
13508 13509 13510 13511
    }

    if (!cmd)
        return NULL;
13512

13513 13514 13515
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
13516
    while ((name = cmd->opts[list_index].name)) {
13517
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
13518
        char *res;
13519

K
Karel Zak 已提交
13520
        list_index++;
13521

13522
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
13523 13524
            /* ignore non --option */
            continue;
13525

K
Karel Zak 已提交
13526
        if (len > 2) {
13527
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
13528 13529
                continue;
        }
13530
        res = vshMalloc(NULL, strlen(name) + 3);
13531
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
13532 13533 13534 13535 13536 13537 13538 13539
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
13540 13541 13542
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
13543 13544
    char **matches = (char **) NULL;

13545
    if (start == 0)
K
Karel Zak 已提交
13546
        /* command name generator */
13547
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
13548 13549
    else
        /* commands options */
13550
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
13551 13552 13553 13554
    return matches;
}


13555 13556
static int
vshReadlineInit(vshControl *ctl)
13557
{
13558 13559
    char *userdir = NULL;

K
Karel Zak 已提交
13560 13561 13562 13563 13564
    /* 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;
13565 13566 13567

    /* Limit the total size of the history buffer */
    stifle_history(500);
13568 13569

    /* Prepare to read/write history from/to the ~/.virsh/history file */
13570
    userdir = virGetUserDirectory(getuid());
13571

13572 13573
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
13574
        return -1;
13575
    }
13576 13577 13578

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
13579
        VIR_FREE(userdir);
13580 13581 13582 13583 13584
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
13585
        VIR_FREE(userdir);
13586 13587 13588
        return -1;
    }

13589
    VIR_FREE(userdir);
13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607

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

13608 13609
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
13610 13611
}

13612 13613 13614 13615 13616 13617
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

13618
#else /* !USE_READLINE */
13619

13620 13621 13622 13623 13624 13625 13626
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

13627
static void
13628
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651
{
    /* 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);
}

13652
#endif /* !USE_READLINE */
13653

K
Karel Zak 已提交
13654
/*
J
Jim Meyering 已提交
13655
 * Deinitialize virsh
K
Karel Zak 已提交
13656
 */
E
Eric Blake 已提交
13657
static bool
13658
vshDeinit(vshControl *ctl)
13659
{
13660
    vshReadlineDeinit(ctl);
13661
    vshCloseLogFile(ctl);
13662
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
13663
    if (ctl->conn) {
13664 13665 13666
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
13667 13668
        }
    }
D
Daniel P. Berrange 已提交
13669 13670
    virResetLastError();

E
Eric Blake 已提交
13671
    return true;
K
Karel Zak 已提交
13672
}
13673

K
Karel Zak 已提交
13674 13675 13676 13677
/*
 * Print usage
 */
static void
13678
vshUsage(void)
13679
{
13680
    const vshCmdGrp *grp;
13681
    const vshCmdDef *cmd;
13682

L
Lai Jiangshan 已提交
13683 13684
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
13685 13686 13687
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
13688
                      "    -d | --debug <num>      debug level [0-4]\n"
13689 13690 13691 13692
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
13693
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
13694
                      "    -V | --version=long     version and full options\n\n"
13695
                      "  commands (non interactive mode):\n\n"), progname, progname);
13696

13697 13698
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
13699

13700 13701 13702 13703 13704 13705 13706 13707 13708
        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"));
13709 13710 13711
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
13712 13713
}

13714 13715 13716 13717 13718 13719 13720 13721 13722 13723
/*
 * 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 已提交
13724 13725
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756 13757 13758 13759 13760
#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 已提交
13761
    vshPrint(ctl, "%s", _(" Networking:"));
13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787
#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 已提交
13788
    vshPrint(ctl, "%s", _(" Storage:"));
13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802 13803 13804 13805 13806 13807 13808 13809 13810 13811
#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 已提交
13812
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
13813
#ifdef WITH_SECDRIVER_APPARMOR
13814 13815 13816 13817 13818 13819 13820 13821 13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836
    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 已提交
13837 13838 13839 13840
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
13841
static bool
13842
vshParseArgv(vshControl *ctl, int argc, char **argv)
13843
{
13844 13845
    bool help = false;
    int arg;
K
Karel Zak 已提交
13846
    struct option opt[] = {
E
Eric Blake 已提交
13847 13848 13849 13850 13851 13852 13853 13854 13855
        {"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}
13856 13857
    };

13858 13859 13860
    /* 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. */
13861
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
13862
        switch (arg) {
13863
        case 'd':
D
Daniel Veillard 已提交
13864
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
13865
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
13866 13867
                exit(EXIT_FAILURE);
            }
13868 13869
            break;
        case 'h':
13870
            help = true;
13871 13872
            break;
        case 'q':
E
Eric Blake 已提交
13873
            ctl->quiet = true;
13874 13875
            break;
        case 't':
E
Eric Blake 已提交
13876
            ctl->timing = true;
13877 13878 13879 13880
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
13881 13882 13883 13884 13885 13886
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
13887 13888 13889
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
13890
        case 'r':
E
Eric Blake 已提交
13891
            ctl->readonly = true;
13892
            break;
13893 13894 13895
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
13896
        default:
13897 13898
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
13899 13900 13901 13902
        }
    }

    if (help) {
13903 13904
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
13905 13906
            exit(EXIT_FAILURE);
        }
13907 13908 13909

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
13910
        exit(EXIT_SUCCESS);
13911 13912
    }

13913
    if (argc > optind) {
K
Karel Zak 已提交
13914
        /* parse command */
E
Eric Blake 已提交
13915
        ctl->imode = false;
13916 13917 13918
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
13919
        } else {
13920
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
13921 13922
        }
    }
E
Eric Blake 已提交
13923
    return true;
K
Karel Zak 已提交
13924 13925
}

13926 13927 13928 13929
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
13930
    char *defaultConn;
E
Eric Blake 已提交
13931
    bool ret = true;
K
Karel Zak 已提交
13932

13933 13934 13935
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
13936
    ctl->debug = -1;            /* Initialize log level */
13937

13938 13939
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
13940
        /* failure to setup locale is not fatal */
13941
    }
13942
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
13943
        perror("bindtextdomain");
E
Eric Blake 已提交
13944
        return EXIT_FAILURE;
13945
    }
13946
    if (!textdomain(PACKAGE)) {
13947
        perror("textdomain");
E
Eric Blake 已提交
13948
        return EXIT_FAILURE;
13949 13950
    }

13951 13952 13953 13954 13955
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

13956
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
13957 13958 13959
        progname = argv[0];
    else
        progname++;
13960

13961
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
13962
        ctl->name = vshStrdup(ctl, defaultConn);
13963 13964
    }

D
Daniel P. Berrange 已提交
13965 13966
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
13967
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
13968
    }
13969

D
Daniel P. Berrange 已提交
13970 13971
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
13972
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
13973
    }
13974

K
Karel Zak 已提交
13975
    if (!ctl->imode) {
13976
        ret = vshCommandRun(ctl, ctl->cmd);
13977
    } else {
K
Karel Zak 已提交
13978 13979
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
13980
            vshPrint(ctl,
13981
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
13982
                     progname);
J
Jim Meyering 已提交
13983
            vshPrint(ctl, "%s",
13984
                     _("Type:  'help' for help with commands\n"
13985
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
13986
        }
13987 13988 13989 13990 13991 13992

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
13993
        do {
13994
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
13995
            ctl->cmdstr =
13996
                vshReadline(ctl, prompt);
13997 13998
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
13999
            if (*ctl->cmdstr) {
14000
#if USE_READLINE
K
Karel Zak 已提交
14001
                add_history(ctl->cmdstr);
14002
#endif
14003
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
14004 14005
                    vshCommandRun(ctl, ctl->cmd);
            }
14006
            VIR_FREE(ctl->cmdstr);
14007
        } while (ctl->imode);
K
Karel Zak 已提交
14008

14009 14010
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
14011
    }
14012

K
Karel Zak 已提交
14013 14014
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
14015
}