virsh.c 425.9 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>
E
Eric Blake 已提交
35
#include <strings.h>
K
Karel Zak 已提交
36

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

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

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

static char *progname;

65 66
#define VIRSH_MAX_XML_FILE 10*1024*1024

K
Karel Zak 已提交
67 68 69 70 71 72 73 74
#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)

75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
/**
 * 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 已提交
92
 * Indicates the level of a log message
93 94 95 96 97 98 99 100 101
 */
typedef enum {
    VSH_ERR_DEBUG = 0,
    VSH_ERR_INFO,
    VSH_ERR_NOTICE,
    VSH_ERR_WARNING,
    VSH_ERR_ERROR
} vshErrorLevel;

J
Jiri Denemark 已提交
102 103
#define VSH_DEBUG_DEFAULT VSH_ERR_ERROR

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

/*
125
 * vshCmdOptType - command option type
126
 */
K
Karel Zak 已提交
127
typedef enum {
128 129 130
    VSH_OT_BOOL,     /* optional boolean option */
    VSH_OT_STRING,   /* optional string option */
    VSH_OT_INT,      /* optional or mandatory int option */
131
    VSH_OT_DATA,     /* string data (as non-option) */
132
    VSH_OT_ARGV      /* remaining arguments */
K
Karel Zak 已提交
133 134
} vshCmdOptType;

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150
/*
 * 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 已提交
151 152 153
/*
 * Command Option Flags
 */
E
Eric Blake 已提交
154 155 156 157
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 已提交
158
    VSH_OFLAG_REQ_OPT  = (1 << 2), /* --optionname required */
E
Eric Blake 已提交
159
};
K
Karel Zak 已提交
160 161 162 163 164 165

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

/*
E
Eric Blake 已提交
166 167 168 169 170
 * vshCmdInfo -- name/value pair for information about command
 *
 * Commands should have at least the following names:
 * "name" - command name
 * "desc" - description of command, or empty string
K
Karel Zak 已提交
171
 */
172
typedef struct {
E
Eric Blake 已提交
173 174
    const char *name;           /* name of information, or NULL for list end */
    const char *data;           /* non-NULL information */
K
Karel Zak 已提交
175 176 177 178 179
} vshCmdInfo;

/*
 * vshCmdOptDef - command option definition
 */
180
typedef struct {
E
Eric Blake 已提交
181
    const char *name;           /* the name of option, or NULL for list end */
182 183
    vshCmdOptType type;         /* option type */
    int flag;                   /* flags */
E
Eric Blake 已提交
184
    const char *help;           /* non-NULL help string */
K
Karel Zak 已提交
185 186 187 188
} vshCmdOptDef;

/*
 * vshCmdOpt - command options
E
Eric Blake 已提交
189 190 191
 *
 * After parsing a command, all arguments to the command have been
 * collected into a list of these objects.
K
Karel Zak 已提交
192 193
 */
typedef struct vshCmdOpt {
E
Eric Blake 已提交
194 195
    const vshCmdOptDef *def;    /* non-NULL pointer to option definition */
    char *data;                 /* allocated data, or NULL for bool option */
196
    struct vshCmdOpt *next;
K
Karel Zak 已提交
197 198
} vshCmdOpt;

199 200 201 202 203 204 205
/*
 * Command Usage Flags
 */
enum {
    VSH_CMD_FLAG_NOCONNECT = (1 << 0),  /* no prior connection needed */
};

K
Karel Zak 已提交
206 207 208
/*
 * vshCmdDef - command definition
 */
209
typedef struct {
E
Eric Blake 已提交
210
    const char *name;           /* name of command, or NULL for list end */
E
Eric Blake 已提交
211
    bool (*handler) (vshControl *, const vshCmd *);    /* command handler */
212 213
    const vshCmdOptDef *opts;   /* definition of command options */
    const vshCmdInfo *info;     /* details about command */
214
    unsigned int flags;         /* bitwise OR of VSH_CMD_FLAG */
K
Karel Zak 已提交
215 216 217 218 219 220
} vshCmdDef;

/*
 * vshCmd - parsed command
 */
typedef struct __vshCmd {
221
    const vshCmdDef *def;       /* command definition */
222 223
    vshCmdOpt *opts;            /* list of command arguments */
    struct __vshCmd *next;      /* next command */
K
Karel Zak 已提交
224 225 226 227 228 229
} __vshCmd;

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

249
typedef struct vshCmdGrp {
E
Eric Blake 已提交
250
    const char *name;    /* name of group, or NULL for list end */
251 252 253
    const char *keyword; /* help keyword */
    const vshCmdDef *commands;
} vshCmdGrp;
254

255
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
256

257 258
static void vshError(vshControl *ctl, const char *format, ...)
    ATTRIBUTE_FMT_PRINTF(2, 3);
E
Eric Blake 已提交
259 260
static bool vshInit(vshControl *ctl);
static bool vshDeinit(vshControl *ctl);
261
static void vshUsage(void);
262
static void vshOpenLogFile(vshControl *ctl);
263 264
static void vshOutputLogFile(vshControl *ctl, int log_level, const char *format, va_list ap)
    ATTRIBUTE_FMT_PRINTF(3, 0);
265
static void vshCloseLogFile(vshControl *ctl);
K
Karel Zak 已提交
266

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

269
static const char *vshCmddefGetInfo(const vshCmdDef *cmd, const char *info);
270
static const vshCmdDef *vshCmddefSearch(const char *cmdname);
E
Eric Blake 已提交
271
static bool vshCmddefHelp(vshControl *ctl, const char *name);
272
static const vshCmdGrp *vshCmdGrpSearch(const char *grpname);
E
Eric Blake 已提交
273
static bool vshCmdGrpHelp(vshControl *ctl, const char *name);
K
Karel Zak 已提交
274

E
Eric Blake 已提交
275 276 277
static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
    ATTRIBUTE_RETURN_CHECK;
278 279
static int vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
280 281 282
static int vshCommandOptUInt(const vshCmd *cmd, const char *name,
                             unsigned int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
283 284 285 286 287 288 289 290 291
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;
292 293 294
static int vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                                  unsigned long long *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
E
Eric Blake 已提交
295
static bool vshCommandOptBool(const vshCmd *cmd, const char *name);
296 297
static const vshCmdOpt *vshCommandOptArgv(const vshCmd *cmd,
                                          const vshCmdOpt *opt);
K
Karel Zak 已提交
298

299 300 301
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
302
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
303

304
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
305
                                          const char **name, int flag);
K
Karel Zak 已提交
306 307

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

311
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
312
                                            const char **name, int flag);
313 314

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
315 316
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
317 318
                           VSH_BYUUID|VSH_BYNAME)

319
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
320
                                                  const char **name, int flag);
321 322 323 324 325 326

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

327
static virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
328
                                                const char **name, int flag);
329 330 331 332 333 334

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

335
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
336
                            const char *optname, const char **name, int flag);
337 338 339 340 341 342

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

343
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
344 345
                                           const char *optname,
                                           const char *pooloptname,
346
                                           const char **name, int flag);
347 348

/* default is lookup by Name and UUID */
349
#define vshCommandOptVol(_ctl, _cmd, _optname, _pooloptname, _name)   \
350 351 352
    vshCommandOptVolBy(_ctl, _cmd, _optname, _pooloptname, _name,     \
                           VSH_BYUUID|VSH_BYNAME)

353
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
354
                                        const char **name);
355

356
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
357
    ATTRIBUTE_FMT_PRINTF(2, 3);
358
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
359
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
360 361

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

364
static int vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason);
K
Karel Zak 已提交
365
static const char *vshDomainStateToString(int state);
366
static const char *vshDomainStateReasonToString(int state, int reason);
367
static const char *vshDomainControlStateToString(int state);
368
static const char *vshDomainVcpuStateToString(int state);
E
Eric Blake 已提交
369
static bool vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
K
Karel Zak 已提交
370

371 372 373 374
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

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

384
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
385 386
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
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 435 436 437 438 439 440 441 442 443 444 445 446
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
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461

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;

462
  /* User visible sort, so we want locale-specific case comparison.  */
463 464 465
  return strcasecmp(*sa, *sb);
}

466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
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 已提交
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
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)
{
513 514 515 516 517 518 519 520
    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)
521
            goto out;
522
    }
J
John Levon 已提交
523 524

    if (last_error->code == VIR_ERR_OK) {
525
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
526 527 528
        goto out;
    }

529
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
530 531 532 533 534 535

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

536 537 538 539 540 541 542 543 544
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;
}

545 546 547 548 549
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

550 551 552 553 554
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

555 556 557 558 559 560
/*
 * 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
 */
561 562 563 564
static void vshCatchDisconnect(int sig, siginfo_t *siginfo,
                               void *context ATTRIBUTE_UNUSED) {
    if ((sig == SIGPIPE) ||
        (SA_SIGINFO && siginfo->si_signo == SIGPIPE))
565 566 567 568 569 570 571 572 573
        disconnected++;
}

/*
 * vshSetupSignals:
 *
 * Catch SIGPIPE signals which may arise when disconnection
 * from libvirtd occurs
 */
L
Laine Stump 已提交
574
static void
575 576 577 578 579 580 581 582 583 584 585 586 587
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 已提交
588
 * Reconnect after a disconnect from libvirtd
589 590
 *
 */
L
Laine Stump 已提交
591
static void
592 593 594 595 596 597
vshReconnect(vshControl *ctl)
{
    bool connected = false;

    if (ctl->conn != NULL) {
        connected = true;
598
        virConnectClose(ctl->conn);
599
    }
600 601 602 603 604 605

    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);
    if (!ctl->conn)
        vshError(ctl, "%s", _("Failed to reconnect to the hypervisor"));
606
    else if (connected)
607 608
        vshError(ctl, "%s", _("Reconnected to the hypervisor"));
    disconnected = 0;
609
    ctl->useGetInfo = false;
610
}
611

K
Karel Zak 已提交
612 613 614 615 616 617
/* ---------------
 * Commands
 * ---------------
 */

/*
618
 * "help" command
K
Karel Zak 已提交
619
 */
620
static const vshCmdInfo info_help[] = {
621
    {"help", N_("print help")},
622 623
    {"desc", N_("Prints global help, command specific help, or help for a\n"
                "    group of related commands")},
624

625
    {NULL, NULL}
K
Karel Zak 已提交
626 627
};

628
static const vshCmdOptDef opts_help[] = {
629
    {"command", VSH_OT_DATA, 0, N_("Prints global help, command specific help, or help for a group of related commands")},
630
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
631 632
};

E
Eric Blake 已提交
633
static bool
634
cmdHelp(vshControl *ctl, const vshCmd *cmd)
635
 {
636
    const char *name = NULL;
637

638
    if (vshCommandOptString(cmd, "command", &name) <= 0) {
639
        const vshCmdGrp *grp;
640
        const vshCmdDef *def;
641

642 643 644 645 646 647 648 649 650 651 652 653 654
        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 已提交
655
        return true;
656
    }
657

E
Eric Blake 已提交
658
    if (vshCmddefSearch(name)) {
659
        return vshCmddefHelp(ctl, name);
E
Eric Blake 已提交
660
    } else if (vshCmdGrpSearch(name)) {
661 662 663
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
E
Eric Blake 已提交
664
        return false;
K
Karel Zak 已提交
665 666 667
    }
}

668 669 670
/*
 * "autostart" command
 */
671
static const vshCmdInfo info_autostart[] = {
672
    {"help", N_("autostart a domain")},
673
    {"desc",
674
     N_("Configure a domain to be automatically started at boot.")},
675 676 677
    {NULL, NULL}
};

678
static const vshCmdOptDef opts_autostart[] = {
679 680
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
681 682 683
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
684
static bool
685
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
686 687
{
    virDomainPtr dom;
688
    const char *name;
689 690
    int autostart;

691
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
692
        return false;
693

J
Jim Meyering 已提交
694
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
695
        return false;
696 697 698 699

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
700
        if (autostart)
701
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
702
        else
703
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
704
        virDomainFree(dom);
E
Eric Blake 已提交
705
        return false;
706 707
    }

708
    if (autostart)
709
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
710
    else
711
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
712

713
    virDomainFree(dom);
E
Eric Blake 已提交
714
    return true;
715 716
}

K
Karel Zak 已提交
717
/*
718
 * "connect" command
K
Karel Zak 已提交
719
 */
720
static const vshCmdInfo info_connect[] = {
721
    {"help", N_("(re)connect to hypervisor")},
722
    {"desc",
723
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
724
    {NULL, NULL}
K
Karel Zak 已提交
725 726
};

727
static const vshCmdOptDef opts_connect[] = {
E
Eric Blake 已提交
728 729
    {"name",     VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("hypervisor connection URI")},
730
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
731
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
732 733
};

E
Eric Blake 已提交
734
static bool
735
cmdConnect(vshControl *ctl, const vshCmd *cmd)
736
{
E
Eric Blake 已提交
737
    bool ro = vshCommandOptBool(cmd, "readonly");
738
    const char *name = NULL;
739

K
Karel Zak 已提交
740
    if (ctl->conn) {
741 742 743
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
E
Eric Blake 已提交
744
            return false;
K
Karel Zak 已提交
745 746 747
        }
        ctl->conn = NULL;
    }
748

749
    VIR_FREE(ctl->name);
750 751
    if (vshCommandOptString(cmd, "name", &name) < 0) {
        vshError(ctl, "%s", _("Please specify valid connection URI"));
E
Eric Blake 已提交
752
        return false;
753
    }
754
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
755

756
    ctl->useGetInfo = false;
E
Eric Blake 已提交
757
    ctl->readonly = ro;
K
Karel Zak 已提交
758

759 760 761
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

E
Eric Blake 已提交
765
    return !!ctl->conn;
K
Karel Zak 已提交
766 767
}

768 769
#ifndef WIN32

770
/*
771
 * "console" command
772
 */
773
static const vshCmdInfo info_console[] = {
774
    {"help", N_("connect to the guest console")},
775
    {"desc",
776
     N_("Connect the virtual serial console for the guest")},
777 778 779
    {NULL, NULL}
};

780
static const vshCmdOptDef opts_console[] = {
781
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
782
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
783 784 785
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
786
static bool
787
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
788
{
E
Eric Blake 已提交
789
    bool ret = false;
790
    int state;
791

792
    if ((state = vshDomainState(ctl, dom, NULL)) < 0) {
793 794 795 796
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

797
    if (state == VIR_DOMAIN_SHUTOFF) {
798 799 800 801
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

802 803
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
    vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
804
    if (vshRunConsole(dom, name) == 0)
E
Eric Blake 已提交
805
        ret = true;
806 807

 cleanup:
808

809 810 811
    return ret;
}

E
Eric Blake 已提交
812
static bool
813 814 815
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
816
    bool ret = false;
817
    const char *name = NULL;
818

819
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
820
        return false;
821 822

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

825 826 827 828
    if (vshCommandOptString(cmd, "devname", &name) < 0) {
        vshError(ctl, "%s", _("Invalid devname"));
        goto cleanup;
    }
829

830
    ret = cmdRunConsole(ctl, dom, name);
831

832
cleanup:
833 834 835 836
    virDomainFree(dom);
    return ret;
}

837 838 839
#endif /* WIN32 */


K
Karel Zak 已提交
840 841 842
/*
 * "list" command
 */
843
static const vshCmdInfo info_list[] = {
844 845
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
846
    {NULL, NULL}
K
Karel Zak 已提交
847 848
};

849
static const vshCmdOptDef opts_list[] = {
850 851
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
852 853 854
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
855

E
Eric Blake 已提交
856
static bool
857
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
858
{
859 860 861 862
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
863
    char **names = NULL;
864 865
    int maxname = 0;
    inactive |= all;
K
Karel Zak 已提交
866

867
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
868
        return false;
869

870
    if (active) {
871 872
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
873
            vshError(ctl, "%s", _("Failed to list active domains"));
E
Eric Blake 已提交
874
            return false;
875 876 877 878 879
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
880
                vshError(ctl, "%s", _("Failed to list active domains"));
881
                VIR_FREE(ids);
E
Eric Blake 已提交
882
                return false;
883 884
            }

885
            qsort(&ids[0], maxid, sizeof(int), idsorter);
886
        }
887 888
    }
    if (inactive) {
889 890
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
891
            vshError(ctl, "%s", _("Failed to list inactive domains"));
892
            VIR_FREE(ids);
E
Eric Blake 已提交
893
            return false;
894
        }
895 896 897 898
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
899
                vshError(ctl, "%s", _("Failed to list inactive domains"));
900 901
                VIR_FREE(ids);
                VIR_FREE(names);
E
Eric Blake 已提交
902
                return false;
903
            }
904

905
            qsort(&names[0], maxname, sizeof(char*), namesorter);
906
        }
907
    }
908
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
909
    vshPrintExtra(ctl, "----------------------------------\n");
910 911

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

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

K
Karel Zak 已提交
918
        vshPrint(ctl, "%3d %-20s %s\n",
919 920
                 virDomainGetID(dom),
                 virDomainGetName(dom),
921
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
922
        virDomainFree(dom);
K
Karel Zak 已提交
923
    }
924 925 926 927
    for (i = 0; i < maxname; i++) {
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);

        /* this kind of work with domains is not atomic operation */
928
        if (!dom) {
929
            VIR_FREE(names[i]);
930
            continue;
931
        }
932

933 934 935 936
        vshPrint(ctl, "%3s %-20s %s\n",
                 "-",
                 names[i],
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
937

938
        virDomainFree(dom);
939
        VIR_FREE(names[i]);
940
    }
941 942
    VIR_FREE(ids);
    VIR_FREE(names);
E
Eric Blake 已提交
943
    return true;
K
Karel Zak 已提交
944 945 946
}

/*
K
Karel Zak 已提交
947
 * "domstate" command
K
Karel Zak 已提交
948
 */
949
static const vshCmdInfo info_domstate[] = {
950 951
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
952
    {NULL, NULL}
K
Karel Zak 已提交
953 954
};

955
static const vshCmdOptDef opts_domstate[] = {
956
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
957
    {"reason", VSH_OT_BOOL, 0, N_("also print reason for the state")},
958
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
959 960
};

E
Eric Blake 已提交
961
static bool
962
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
963
{
K
Karel Zak 已提交
964
    virDomainPtr dom;
E
Eric Blake 已提交
965
    bool ret = true;
966 967
    int showReason = vshCommandOptBool(cmd, "reason");
    int state, reason;
968

969
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
970
        return false;
971

J
Jim Meyering 已提交
972
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
973
        return false;
974

975
    if ((state = vshDomainState(ctl, dom, &reason)) < 0) {
E
Eric Blake 已提交
976
        ret = false;
977 978 979 980 981 982 983 984 985 986 987
        goto cleanup;
    }

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

989
cleanup:
990 991 992 993
    virDomainFree(dom);
    return ret;
}

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 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
/*
 * "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;
}

1041 1042
/* "domblkstat" command
 */
1043
static const vshCmdInfo info_domblkstat[] = {
1044 1045
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
1046 1047 1048
    {NULL,NULL}
};

1049
static const vshCmdOptDef opts_domblkstat[] = {
1050 1051
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
1052 1053 1054
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1055
static bool
1056
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
1057 1058
{
    virDomainPtr dom;
1059
    const char *name = NULL, *device = NULL;
1060 1061
    struct _virDomainBlockStats stats;

1062
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1063
        return false;
1064

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

1068
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
L
Laine Stump 已提交
1069
        virDomainFree(dom);
E
Eric Blake 已提交
1070
        return false;
L
Laine Stump 已提交
1071
    }
1072 1073

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

    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 已提交
1095
    return true;
1096 1097 1098 1099
}

/* "domifstat" command
 */
1100
static const vshCmdInfo info_domifstat[] = {
1101 1102
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1103 1104 1105
    {NULL,NULL}
};

1106
static const vshCmdOptDef opts_domifstat[] = {
1107 1108
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1109 1110 1111
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1112
static bool
1113
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1114 1115
{
    virDomainPtr dom;
1116
    const char *name = NULL, *device = NULL;
1117 1118
    struct _virDomainInterfaceStats stats;

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

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

1125
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1126
        virDomainFree(dom);
E
Eric Blake 已提交
1127
        return false;
L
Laine Stump 已提交
1128
    }
1129 1130

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1131
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1132
        virDomainFree(dom);
E
Eric Blake 已提交
1133
        return false;
1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
    }

    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 已提交
1161
    return true;
1162 1163
}

1164 1165 1166
/*
 * "dommemstats" command
 */
1167
static const vshCmdInfo info_dommemstat[] = {
1168 1169
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1170 1171 1172
    {NULL,NULL}
};

1173
static const vshCmdOptDef opts_dommemstat[] = {
1174
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1175 1176 1177
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1178
static bool
1179
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1180 1181
{
    virDomainPtr dom;
1182
    const char *name;
1183 1184 1185
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1186
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1187
        return false;
1188 1189

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1190
        return false;
1191 1192 1193 1194 1195

    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 已提交
1196
        return false;
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211
    }

    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);
1212 1213
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON)
            vshPrint (ctl, "actual %llu\n", stats[i].val);
1214 1215 1216
    }

    virDomainFree(dom);
E
Eric Blake 已提交
1217
    return true;
1218 1219
}

1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
/*
 * "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 已提交
1235
static bool
1236 1237 1238 1239
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1240
    bool ret = true;
1241
    const char *device = NULL;
1242

1243
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1244
        return false;
1245 1246

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

1249
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1250
        virDomainFree(dom);
E
Eric Blake 已提交
1251
        return false;
1252 1253 1254 1255
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1256
        return false;
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266
    }

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

1267 1268 1269
/*
 * "suspend" command
 */
1270
static const vshCmdInfo info_suspend[] = {
1271 1272
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1273
    {NULL, NULL}
1274 1275
};

1276
static const vshCmdOptDef opts_suspend[] = {
1277
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1278
    {NULL, 0, 0, NULL}
1279 1280
};

E
Eric Blake 已提交
1281
static bool
1282
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1283
{
1284
    virDomainPtr dom;
1285
    const char *name;
E
Eric Blake 已提交
1286
    bool ret = true;
1287

1288
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1289
        return false;
1290

J
Jim Meyering 已提交
1291
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1292
        return false;
1293 1294

    if (virDomainSuspend(dom) == 0) {
1295
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1296
    } else {
1297
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1298
        ret = false;
1299
    }
1300

1301 1302 1303 1304
    virDomainFree(dom);
    return ret;
}

1305 1306 1307
/*
 * "create" command
 */
1308
static const vshCmdInfo info_create[] = {
1309 1310
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1311 1312 1313
    {NULL, NULL}
};

1314
static const vshCmdOptDef opts_create[] = {
1315
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1316
#ifndef WIN32
1317
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1318
#endif
1319
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1320
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1321 1322 1323
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1324
static bool
1325
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1326 1327
{
    virDomainPtr dom;
1328
    const char *from = NULL;
E
Eric Blake 已提交
1329
    bool ret = true;
1330
    char *buffer;
1331
#ifndef WIN32
1332
    int console = vshCommandOptBool(cmd, "console");
1333
#endif
1334
    unsigned int flags = VIR_DOMAIN_NONE;
1335

1336
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1337
        return false;
1338

1339
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1340
        return false;
1341

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

1345 1346
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1347 1348
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1349 1350

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1351
    VIR_FREE(buffer);
1352

1353
    if (dom != NULL) {
1354
        vshPrint(ctl, _("Domain %s created from %s\n"),
1355
                 virDomainGetName(dom), from);
1356
#ifndef WIN32
1357
        if (console)
1358
            cmdRunConsole(ctl, dom, NULL);
1359
#endif
1360
        virDomainFree(dom);
1361
    } else {
1362
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1363
        ret = false;
1364 1365 1366 1367
    }
    return ret;
}

1368 1369 1370
/*
 * "define" command
 */
1371
static const vshCmdInfo info_define[] = {
1372 1373
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1374 1375 1376
    {NULL, NULL}
};

1377
static const vshCmdOptDef opts_define[] = {
1378
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1379 1380 1381
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1382
static bool
1383
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1384 1385
{
    virDomainPtr dom;
1386
    const char *from = NULL;
E
Eric Blake 已提交
1387
    bool ret = true;
1388
    char *buffer;
1389

1390
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1391
        return false;
1392

1393
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1394
        return false;
1395

1396
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1397
        return false;
1398 1399

    dom = virDomainDefineXML(ctl->conn, buffer);
1400
    VIR_FREE(buffer);
1401

1402
    if (dom != NULL) {
1403
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1404
                 virDomainGetName(dom), from);
1405
        virDomainFree(dom);
1406
    } else {
1407
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1408
        ret = false;
1409 1410 1411 1412 1413 1414 1415
    }
    return ret;
}

/*
 * "undefine" command
 */
1416
static const vshCmdInfo info_undefine[] = {
1417 1418
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1419 1420 1421
    {NULL, NULL}
};

1422
static const vshCmdOptDef opts_undefine[] = {
1423
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1424
    {"managed-save", VSH_OT_BOOL, 0, N_("remove domain managed state file")},
1425 1426 1427
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1428
static bool
1429
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1430 1431
{
    virDomainPtr dom;
E
Eric Blake 已提交
1432
    bool ret = true;
1433
    const char *name = NULL;
1434
    int id;
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
    int flags = 0;
    int managed_save = vshCommandOptBool(cmd, "managed-save");
    int has_managed_save = 0;
    int rc = -1;

    if (managed_save)
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;

    if (!managed_save)
        flags = -1;
1445

1446
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1447
        return false;
1448

1449
    if (vshCommandOptString(cmd, "domain", &name) <= 0)
E
Eric Blake 已提交
1450
        return false;
1451 1452 1453

    if (name && virStrToLong_i(name, NULL, 10, &id) == 0
        && id >= 0 && (dom = virDomainLookupByID(ctl->conn, id))) {
1454 1455 1456 1457 1458
        vshError(ctl,
                 _("a running domain like %s cannot be undefined;\n"
                   "to undefine, first shutdown then undefine"
                   " using its name or UUID"),
                 name);
1459
        virDomainFree(dom);
E
Eric Blake 已提交
1460
        return false;
1461
    }
J
Jim Meyering 已提交
1462
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
1463
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
1464
        return false;
1465

1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514
    has_managed_save = virDomainHasManagedSaveImage(dom, 0);
    if (has_managed_save < 0) {
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virshReportError(ctl);
            virDomainFree(dom);
            return false;
        } else {
            virFreeError(last_error);
            last_error = NULL;
        }
    }

    if (flags == -1) {
        if (has_managed_save == 1) {
            vshError(ctl,
                     _("Refusing to undefine while domain managed save "
                       "image exists"));
            virDomainFree(dom);
            return false;
        }

        rc = virDomainUndefine(dom);
    } else {
        rc = virDomainUndefineFlags(dom, flags);

        /* It might fail when virDomainUndefineFlags is not
         * supported on older libvirt, try to undefine the
         * domain with combo virDomainManagedSaveRemove and
         * virDomainUndefine.
         */
        if (rc < 0) {
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
                goto end;
            } else {
                virFreeError(last_error);
                last_error = NULL;
            }

            if ((has_managed_save == 1) &&
                virDomainManagedSaveRemove(dom, 0) < 0)
                goto end;

            rc = virDomainUndefine(dom);
        }
    }

end:
    if (rc == 0) {
1515
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1516
    } else {
1517
        vshError(ctl, _("Failed to undefine domain %s"), name);
E
Eric Blake 已提交
1518
        ret = false;
1519 1520
    }

1521
    virDomainFree(dom);
1522 1523 1524 1525 1526 1527 1528
    return ret;
}


/*
 * "start" command
 */
1529
static const vshCmdInfo info_start[] = {
1530
    {"help", N_("start a (previously defined) inactive domain")},
1531 1532 1533
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1534 1535 1536
    {NULL, NULL}
};

1537
static const vshCmdOptDef opts_start[] = {
1538
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1539
#ifndef WIN32
1540
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1541
#endif
E
Eric Blake 已提交
1542
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1543
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1544 1545
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when loading")},
1546 1547 1548
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1549
static bool
1550
cmdStart(vshControl *ctl, const vshCmd *cmd)
1551 1552
{
    virDomainPtr dom;
E
Eric Blake 已提交
1553
    bool ret = true;
1554
#ifndef WIN32
1555
    int console = vshCommandOptBool(cmd, "console");
1556
#endif
E
Eric Blake 已提交
1557
    unsigned int flags = VIR_DOMAIN_NONE;
1558

1559
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1560
        return false;
1561

1562 1563
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
1564
        return false;
1565 1566

    if (virDomainGetID(dom) != (unsigned int)-1) {
1567
        vshError(ctl, "%s", _("Domain is already active"));
1568
        virDomainFree(dom);
E
Eric Blake 已提交
1569
        return false;
1570 1571
    }

E
Eric Blake 已提交
1572 1573
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1574 1575
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1576 1577
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_START_BYPASS_CACHE;
E
Eric Blake 已提交
1578 1579 1580 1581

    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
         : virDomainCreate(dom)) == 0) {
1582
        vshPrint(ctl, _("Domain %s started\n"),
1583
                 virDomainGetName(dom));
1584
#ifndef WIN32
1585
        if (console)
1586
            cmdRunConsole(ctl, dom, NULL);
1587
#endif
1588
    } else {
1589
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
E
Eric Blake 已提交
1590
        ret = false;
1591
    }
1592
    virDomainFree(dom);
1593 1594 1595
    return ret;
}

1596 1597 1598
/*
 * "save" command
 */
1599
static const vshCmdInfo info_save[] = {
1600
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
1601
    {"desc", N_("Save the RAM state of a running domain.")},
1602
    {NULL, NULL}
1603 1604
};

1605
static const vshCmdOptDef opts_save[] = {
1606
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
1607 1608
    {"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")},
1609 1610
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
1611
    {NULL, 0, 0, NULL}
1612 1613
};

E
Eric Blake 已提交
1614
static bool
1615
cmdSave(vshControl *ctl, const vshCmd *cmd)
1616
{
1617
    virDomainPtr dom;
1618 1619
    const char *name = NULL;
    const char *to = NULL;
1620 1621
    bool ret = false;
    int flags = 0;
1622 1623
    const char *xmlfile = NULL;
    char *xml = NULL;
1624

1625
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1626
        return false;
1627

1628
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1629
        return false;
1630

1631 1632 1633
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;

1634 1635 1636 1637 1638
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

1642 1643 1644 1645 1646 1647
    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
        goto cleanup;

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
1648
         : virDomainSave(dom, to)) < 0) {
1649
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
1650
        goto cleanup;
1651
    }
1652

1653 1654 1655 1656
    vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
    ret = true;

cleanup:
1657
    VIR_FREE(xml);
1658 1659 1660 1661
    virDomainFree(dom);
    return ret;
}

1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833
/*
 * "save-image-dumpxml" command
 */
static const vshCmdInfo info_save_image_dumpxml[] = {
    {"help", N_("saved state domain information in XML")},
    {"desc", N_("Output the domain information for a saved state file,\n"
                "as an XML dump to stdout.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_save_image_dumpxml[] = {
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("saved state file to read")},
    {"security-info", VSH_OT_BOOL, 0, N_("include security sensitive information in XML dump")},
    {NULL, 0, 0, NULL}
};

static bool
cmdSaveImageDumpxml(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
    int flags = 0;
    char *xml = NULL;

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;

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

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

    xml = virDomainSaveImageGetXMLDesc(ctl->conn, file, flags);
    if (!xml)
        goto cleanup;

    vshPrint(ctl, "%s", xml);
    ret = true;

cleanup:
    VIR_FREE(xml);
    return ret;
}

/*
 * "save-image-define" command
 */
static const vshCmdInfo info_save_image_define[] = {
    {"help", N_("redefine the XML for a domain's saved state file")},
    {"desc", N_("Replace the domain XML associated with a saved state file")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_save_image_define[] = {
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("saved state file to modify")},
    {"xml", VSH_OT_STRING, VSH_OFLAG_REQ,
     N_("filename containing updated XML for the target")},
    {NULL, 0, 0, NULL}
};

static bool
cmdSaveImageDefine(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
    const char *xmlfile = NULL;
    char *xml = NULL;

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

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

    if (vshCommandOptString(cmd, "xml", &xmlfile) <= 0) {
        vshError(ctl, "%s", _("malformed or missing xml argument"));
        return false;
    }

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

    if (virDomainSaveImageDefineXML(ctl->conn, file, xml, 0) < 0) {
        vshError(ctl, _("Failed to update %s"), file);
        goto cleanup;
    }

    vshPrint(ctl, _("State file %s updated.\n"), file);
    ret = true;

cleanup:
    VIR_FREE(xml);
    return ret;
}

/*
 * "save-image-edit" command
 */
static const vshCmdInfo info_save_image_edit[] = {
    {"help", N_("edit XML for a domain's saved state file")},
    {"desc", N_("Edit the domain XML associated with a saved state file")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_save_image_edit[] = {
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("saved state file to edit")},
    {NULL, 0, 0, NULL}
};

static bool
cmdSaveImageEdit(vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    bool ret = false;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    int flags = VIR_DOMAIN_XML_SECURE;

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

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

    /* Get the XML configuration of the saved image.  */
    doc = virDomainSaveImageGetXMLDesc(ctl->conn, file, 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, _("Saved image %s XML configuration not changed.\n"),
                 file);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
    if (virDomainSaveImageDefineXML(ctl->conn, file, doc_edited, 0) < 0) {
        vshError(ctl, _("Failed to update %s"), file);
        goto cleanup;
    }

    vshPrint(ctl, _("State file %s edited.\n"), file);
    ret = true;

cleanup:
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
    return ret;
}

1834 1835 1836 1837 1838
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1839 1840 1841 1842
    {"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.")},
1843 1844 1845 1846
    {NULL, NULL}
};

static const vshCmdOptDef opts_managedsave[] = {
1847
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
1848 1849 1850 1851
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1852
static bool
1853 1854 1855
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1856
    const char *name;
1857 1858
    bool ret = false;
    int flags = 0;
1859

1860
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1861
        return false;
1862

1863 1864 1865
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;

1866
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1867
        return false;
1868

1869
    if (virDomainManagedSave(dom, flags) < 0) {
1870
        vshError(ctl, _("Failed to save domain %s state"), name);
1871
        goto cleanup;
1872 1873
    }

1874 1875 1876 1877
    vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    ret = true;

cleanup:
1878 1879 1880 1881
    virDomainFree(dom);
    return ret;
}

1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895
/*
 * "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 已提交
1896
static bool
1897 1898 1899
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1900
    const char *name;
E
Eric Blake 已提交
1901
    bool ret = false;
1902 1903
    int hassave;

1904
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1905
        return false;
1906 1907

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1908
        return false;
1909 1910 1911

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1912
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928
        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 已提交
1929
    ret = true;
1930 1931 1932 1933 1934 1935

cleanup:
    virDomainFree(dom);
    return ret;
}

1936 1937 1938
/*
 * "schedinfo" command
 */
1939
static const vshCmdInfo info_schedinfo[] = {
1940 1941
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1942 1943 1944
    {NULL, NULL}
};

1945
static const vshCmdOptDef opts_schedinfo[] = {
1946 1947 1948 1949
    {"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")},
1950 1951 1952
    {"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")},
1953 1954 1955
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
1956
static int
1957
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
1958
                   virTypedParameterPtr param)
1959
{
1960
    const char *data = NULL;
1961 1962 1963

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
1964
        param->type == VIR_TYPED_PARAM_UINT &&
1965 1966
        vshCommandOptBool(cmd, "weight")) {
        int val;
1967
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
1968
            vshError(ctl, "%s", _("Invalid value of weight"));
1969
            return -1;
1970
        } else {
1971
            param->value.ui = val;
1972
        }
1973
        return 1;
1974 1975
    }

1976 1977
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
1978
        param->type == VIR_TYPED_PARAM_UINT &&
1979 1980
        vshCommandOptBool(cmd, "cap")) {
        int val;
1981
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
1982
            vshError(ctl, "%s", _("Invalid value of cap"));
1983
            return -1;
1984
        } else {
1985
            param->value.ui = val;
1986
        }
1987
        return 1;
1988
    }
1989

1990
    if (vshCommandOptString(cmd, "set", &data) > 0) {
1991 1992 1993
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
1994
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
1995
            return -1;
1996
        }
1997 1998 1999 2000 2001 2002 2003 2004 2005
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
2006
        case VIR_TYPED_PARAM_INT:
2007
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
2008
                vshError(ctl, "%s",
2009 2010 2011 2012
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
2013
        case VIR_TYPED_PARAM_UINT:
2014
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
2015
                vshError(ctl, "%s",
2016 2017 2018 2019
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
2020
        case VIR_TYPED_PARAM_LLONG:
2021
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
2022
                vshError(ctl, "%s",
J
Jim Meyering 已提交
2023
                         _("Invalid value for parameter, expecting a long long"));
2024 2025 2026
                return -1;
            }
            break;
2027
        case VIR_TYPED_PARAM_ULLONG:
2028
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
2029
                vshError(ctl, "%s",
2030 2031 2032 2033
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
2034
        case VIR_TYPED_PARAM_DOUBLE:
2035
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
2036
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
2037 2038 2039
                return -1;
            }
            break;
2040
        case VIR_TYPED_PARAM_BOOLEAN:
2041
            param->value.b = STREQ(val, "0") ? 0 : 1;
2042
        }
2043
        return 1;
2044
    }
2045

2046 2047
    return 0;
}
2048

2049

E
Eric Blake 已提交
2050
static bool
2051 2052 2053 2054
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
2055
    virTypedParameterPtr params = NULL;
2056 2057 2058
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
2059
    bool ret_val = false;
2060 2061 2062 2063 2064 2065 2066 2067 2068 2069
    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;
        }
2070
        flags = VIR_DOMAIN_AFFECT_CURRENT;
2071 2072
    } else {
        if (config)
2073
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
2074
        if (live)
2075
            flags |= VIR_DOMAIN_AFFECT_LIVE;
2076
    }
2077

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

2081
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2082
        return false;
2083 2084 2085

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
2086
    if (schedulertype != NULL) {
2087
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
2088
             schedulertype);
2089
        VIR_FREE(schedulertype);
2090
    } else {
2091
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
2092
        goto cleanup;
2093 2094
    }

2095
    if (nparams) {
2096
        params = vshMalloc(ctl, sizeof(*params) * nparams);
2097

2098
        memset(params, 0, sizeof(*params) * nparams);
2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109
        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);
        }
2110 2111 2112 2113
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
2114
        for (i = 0; i < nparams; i++) {
2115 2116 2117 2118 2119 2120 2121 2122 2123 2124
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
2125 2126 2127 2128 2129
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
2130 2131 2132
            if (ret == -1)
                goto cleanup;

2133 2134 2135 2136 2137 2138 2139
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
2140 2141
            if (ret == -1)
                goto cleanup;
2142 2143 2144 2145
        } 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.  */
2146 2147
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
2148 2149 2150 2151
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
2152 2153 2154 2155 2156 2157
            /* 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;
            }
2158 2159
        }

E
Eric Blake 已提交
2160
        ret_val = true;
2161
        for (i = 0; i < nparams; i++) {
2162
            switch (params[i].type) {
2163
            case VIR_TYPED_PARAM_INT:
2164
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
2165
                 break;
2166
            case VIR_TYPED_PARAM_UINT:
2167
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
2168
                 break;
2169
            case VIR_TYPED_PARAM_LLONG:
2170
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
2171
                 break;
2172
            case VIR_TYPED_PARAM_ULLONG:
2173
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
2174
                 break;
2175
            case VIR_TYPED_PARAM_DOUBLE:
2176
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
2177
                 break;
2178
            case VIR_TYPED_PARAM_BOOLEAN:
2179
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
2180 2181
                 break;
            default:
2182
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
2183 2184 2185
            }
        }
    }
2186

2187
 cleanup:
2188
    VIR_FREE(params);
2189
    virDomainFree(dom);
2190
    return ret_val;
2191 2192
}

2193 2194 2195
/*
 * "restore" command
 */
2196
static const vshCmdInfo info_restore[] = {
2197 2198
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
2199
    {NULL, NULL}
2200 2201
};

2202
static const vshCmdOptDef opts_restore[] = {
2203
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
2204 2205
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when restoring")},
2206 2207
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2208
    {NULL, 0, 0, NULL}
2209 2210
};

E
Eric Blake 已提交
2211
static bool
2212
cmdRestore(vshControl *ctl, const vshCmd *cmd)
2213
{
2214
    const char *from = NULL;
2215 2216
    bool ret = false;
    int flags = 0;
2217 2218
    const char *xmlfile = NULL;
    char *xml = NULL;
2219

2220
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2221
        return false;
2222

2223
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2224
        return false;
2225

2226 2227 2228
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;

2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

    if (((flags || xml)
         ? virDomainRestoreFlags(ctl->conn, from, xml, flags)
2240
         : virDomainRestore(ctl->conn, from)) < 0) {
2241
        vshError(ctl, _("Failed to restore domain from %s"), from);
2242
        goto cleanup;
2243
    }
2244 2245 2246 2247 2248

    vshPrint(ctl, _("Domain restored from %s\n"), from);
    ret = true;

cleanup:
2249
    VIR_FREE(xml);
2250 2251 2252
    return ret;
}

D
Daniel Veillard 已提交
2253 2254 2255
/*
 * "dump" command
 */
2256
static const vshCmdInfo info_dump[] = {
2257 2258
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
2259 2260 2261
    {NULL, NULL}
};

2262
static const vshCmdOptDef opts_dump[] = {
2263 2264
    {"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")},
2265 2266
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when saving")},
2267 2268
    {"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 已提交
2269 2270 2271
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2272
static bool
2273
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
2274 2275
{
    virDomainPtr dom;
2276 2277
    const char *name = NULL;
    const char *to = NULL;
2278
    bool ret = false;
2279
    int flags = 0;
D
Daniel Veillard 已提交
2280

2281
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2282
        return false;
D
Daniel Veillard 已提交
2283

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

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

P
Paolo Bonzini 已提交
2290 2291
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
2292 2293
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;
2294 2295
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DUMP_BYPASS_CACHE;
2296

2297
    if (virDomainCoreDump(dom, to, flags) < 0) {
2298
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
2299
        goto cleanup;
D
Daniel Veillard 已提交
2300 2301
    }

2302 2303 2304 2305
    vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
    ret = true;

cleanup:
D
Daniel Veillard 已提交
2306 2307 2308 2309
    virDomainFree(dom);
    return ret;
}

2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456
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;
}

2457 2458 2459
/*
 * "resume" command
 */
2460
static const vshCmdInfo info_resume[] = {
2461 2462
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
2463
    {NULL, NULL}
2464 2465
};

2466
static const vshCmdOptDef opts_resume[] = {
2467
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2468
    {NULL, 0, 0, NULL}
2469 2470
};

E
Eric Blake 已提交
2471
static bool
2472
cmdResume(vshControl *ctl, const vshCmd *cmd)
2473
{
2474
    virDomainPtr dom;
E
Eric Blake 已提交
2475
    bool ret = true;
2476
    const char *name;
2477

2478
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2479
        return false;
2480

J
Jim Meyering 已提交
2481
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2482
        return false;
2483 2484

    if (virDomainResume(dom) == 0) {
2485
        vshPrint(ctl, _("Domain %s resumed\n"), name);
2486
    } else {
2487
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
2488
        ret = false;
2489
    }
2490

2491 2492 2493 2494
    virDomainFree(dom);
    return ret;
}

2495 2496 2497
/*
 * "shutdown" command
 */
2498
static const vshCmdInfo info_shutdown[] = {
2499 2500
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
2501
    {NULL, NULL}
2502 2503
};

2504
static const vshCmdOptDef opts_shutdown[] = {
2505
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2506
    {NULL, 0, 0, NULL}
2507 2508
};

E
Eric Blake 已提交
2509
static bool
2510
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
2511
{
2512
    virDomainPtr dom;
E
Eric Blake 已提交
2513
    bool ret = true;
2514
    const char *name;
2515

2516
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2517
        return false;
2518

J
Jim Meyering 已提交
2519
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2520
        return false;
2521 2522

    if (virDomainShutdown(dom) == 0) {
2523
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
2524
    } else {
2525
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
2526
        ret = false;
2527
    }
2528

2529 2530 2531 2532
    virDomainFree(dom);
    return ret;
}

2533 2534 2535
/*
 * "reboot" command
 */
2536
static const vshCmdInfo info_reboot[] = {
2537 2538
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
2539 2540 2541
    {NULL, NULL}
};

2542
static const vshCmdOptDef opts_reboot[] = {
2543
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2544 2545 2546
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2547
static bool
2548
cmdReboot(vshControl *ctl, const vshCmd *cmd)
2549 2550
{
    virDomainPtr dom;
E
Eric Blake 已提交
2551
    bool ret = true;
2552
    const char *name;
2553

2554
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2555
        return false;
2556

J
Jim Meyering 已提交
2557
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2558
        return false;
2559 2560

    if (virDomainReboot(dom, 0) == 0) {
2561
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
2562
    } else {
2563
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
2564
        ret = false;
2565 2566 2567 2568 2569 2570
    }

    virDomainFree(dom);
    return ret;
}

2571 2572 2573
/*
 * "destroy" command
 */
2574
static const vshCmdInfo info_destroy[] = {
2575 2576 2577
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
2578
    {NULL, NULL}
2579 2580
};

2581
static const vshCmdOptDef opts_destroy[] = {
2582
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2583
    {NULL, 0, 0, NULL}
2584 2585
};

E
Eric Blake 已提交
2586
static bool
2587
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2588
{
2589
    virDomainPtr dom;
E
Eric Blake 已提交
2590
    bool ret = true;
2591
    const char *name;
2592

2593
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2594
        return false;
2595

J
Jim Meyering 已提交
2596
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2597
        return false;
2598 2599

    if (virDomainDestroy(dom) == 0) {
2600
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2601
    } else {
2602
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
2603
        ret = false;
2604
    }
2605

2606
    virDomainFree(dom);
K
Karel Zak 已提交
2607 2608 2609 2610
    return ret;
}

/*
2611
 * "dominfo" command
K
Karel Zak 已提交
2612
 */
2613
static const vshCmdInfo info_dominfo[] = {
2614 2615
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2616
    {NULL, NULL}
K
Karel Zak 已提交
2617 2618
};

2619
static const vshCmdOptDef opts_dominfo[] = {
2620
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2621
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2622 2623
};

E
Eric Blake 已提交
2624
static bool
2625
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2626
{
K
Karel Zak 已提交
2627 2628
    virDomainInfo info;
    virDomainPtr dom;
2629
    virSecurityModel secmodel;
2630
    virSecurityLabelPtr seclabel;
2631
    int persistent = 0;
E
Eric Blake 已提交
2632 2633
    bool ret = true;
    int autostart;
2634
    unsigned int id;
2635
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2636
    int has_managed_save = 0;
2637

2638
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2639
        return false;
K
Karel Zak 已提交
2640

J
Jim Meyering 已提交
2641
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2642
        return false;
2643

2644 2645
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2646
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2647
    else
2648
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2649 2650
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2651
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2652
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2653 2654

    if ((str = virDomainGetOSType(dom))) {
2655
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2656
        VIR_FREE(str);
2657 2658 2659
    }

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

2663
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2664 2665

        if (info.cpuTime != 0) {
2666
            double cpuUsed = info.cpuTime;
2667

2668
            cpuUsed /= 1000000000.0;
2669

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

2673 2674
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2675
                 info.maxMem);
2676
        else
2677
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2678 2679
                 _("no limit"));

2680
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2681 2682
                 info.memory);

K
Karel Zak 已提交
2683
    } else {
E
Eric Blake 已提交
2684
        ret = false;
K
Karel Zak 已提交
2685
    }
2686

2687 2688
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
2689 2690
    vshDebug(ctl, VSH_ERR_DEBUG, "Domain persistent flag value: %d\n",
             persistent);
2691 2692 2693 2694 2695 2696
    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 */
2697
    if (!virDomainGetAutostart(dom, &autostart)) {
2698
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2699 2700 2701
                 autostart ? _("enable") : _("disable") );
    }

2702 2703 2704 2705 2706 2707 2708
    has_managed_save = virDomainHasManagedSaveImage(dom, 0);
    if (has_managed_save < 0)
        vshPrint(ctl, "%-15s %s\n", _("Managed save:"), _("unknown"));
    else
        vshPrint(ctl, "%-15s %s\n", _("Managed save:"),
                 has_managed_save ? _("yes") : _("no"));

2709 2710 2711
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2712 2713
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
2714
            return false;
2715 2716 2717
        } else {
            virFreeError(last_error);
            last_error = NULL;
2718
        }
2719 2720 2721 2722 2723 2724 2725
    } 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 */
2726
            if (VIR_ALLOC(seclabel) < 0) {
2727
                virDomainFree(dom);
E
Eric Blake 已提交
2728
                return false;
2729 2730 2731 2732 2733
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
2734
                return false;
2735
            } else {
2736
                if (seclabel->label[0] != '\0')
2737
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
2738
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
2739
            }
2740 2741

            VIR_FREE(seclabel);
2742 2743
        }
    }
2744
    virDomainFree(dom);
K
Karel Zak 已提交
2745 2746 2747
    return ret;
}

2748 2749 2750 2751
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2752 2753
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2754 2755 2756 2757
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2758
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2759 2760 2761 2762
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
2763
static bool
2764 2765 2766 2767
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
2768
    bool ret = true;
2769

2770
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2771
        return false;
2772 2773

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2774
        return false;
2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800

    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 已提交
2801
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2802
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2803
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2804
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2805
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2806 2807 2808
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2809
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2810
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2811
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2812
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2813
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2814 2815 2816
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2817
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2818
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2819
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2820
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2821
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2822 2823
        }
    } else {
E
Eric Blake 已提交
2824
        ret = false;
2825 2826 2827 2828 2829 2830
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2831 2832 2833 2834
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2835 2836
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2837 2838 2839 2840
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2841
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2842 2843 2844
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2845
static bool
2846 2847 2848
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2849
    bool ret = true;
2850

2851
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2852
        return false;
2853 2854

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
2858
        ret = false;
2859 2860 2861 2862 2863

    virDomainFree(dom);
    return ret;
}

2864 2865 2866
/*
 * "freecell" command
 */
2867
static const vshCmdInfo info_freecell[] = {
2868 2869
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2870 2871 2872
    {NULL, NULL}
};

2873
static const vshCmdOptDef opts_freecell[] = {
2874
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2875
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
2876 2877 2878
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2879
static bool
2880
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2881
{
W
Wen Congyang 已提交
2882
    bool func_ret = false;
2883
    int ret;
2884
    int cell = -1, cell_given;
2885
    unsigned long long memory;
2886 2887 2888 2889
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
2890
    int all_given;
2891 2892 2893 2894
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
2895

2896

2897
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2898
        return false;
2899

2900 2901 2902 2903
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
2904 2905 2906 2907 2908 2909 2910 2911 2912
    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) {
2913 2914 2915
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2916 2917 2918
            goto cleanup;
        }

2919 2920 2921
        xml = xmlReadDoc((const xmlChar *) cap_xml, "node.xml", NULL,
                          XML_PARSE_NOENT | XML_PARSE_NONET |
                          XML_PARSE_NOWARNING);
2922

2923 2924
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2925 2926 2927
            goto cleanup;
        }

2928 2929 2930 2931 2932
        ctxt = xmlXPathNewContext(xml);
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
2933
            vshError(ctl, "%s", _("could not get information about "
2934
                                  "NUMA topology"));
2935 2936 2937
            goto cleanup;
        }

2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958
        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;
            }
        }

2959
        memory = 0;
2960 2961 2962 2963
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
2964 2965 2966 2967
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
2968
    } else {
2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982
        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));
2983 2984
    }

E
Eric Blake 已提交
2985
    func_ret = true;
2986

2987
cleanup:
2988 2989 2990
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
2991
    VIR_FREE(nodes);
2992 2993 2994
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
2995
    return func_ret;
2996 2997
}

E
Eric Blake 已提交
2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011
/*
 * "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 已提交
3012
static bool
E
Eric Blake 已提交
3013 3014
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
3015
    const char *type = NULL;
E
Eric Blake 已提交
3016 3017
    int vcpus;

3018 3019
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
3020
        return false;
3021
    }
E
Eric Blake 已提交
3022 3023

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

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

E
Eric Blake 已提交
3031
    return true;
E
Eric Blake 已提交
3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045
}

/*
 * "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")},
3046
    {"active", VSH_OT_BOOL, 0, N_("get number of currently active vcpus")},
E
Eric Blake 已提交
3047
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
3048 3049 3050
    {"config", VSH_OT_BOOL, 0, N_("get value to be used on next boot")},
    {"current", VSH_OT_BOOL, 0,
     N_("get value according to current domain state")},
E
Eric Blake 已提交
3051 3052 3053
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3054
static bool
E
Eric Blake 已提交
3055 3056 3057
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3058
    bool ret = true;
E
Eric Blake 已提交
3059
    int maximum = vshCommandOptBool(cmd, "maximum");
3060
    int active = vshCommandOptBool(cmd, "active");
E
Eric Blake 已提交
3061 3062
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3063 3064
    int current = vshCommandOptBool(cmd, "current");
    bool all = maximum + active + current + config + live == 0;
E
Eric Blake 已提交
3065 3066
    int count;

3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081
    /* We want one of each pair of mutually exclusive options; that
     * is, use of flags requires exactly two options.  We reject the
     * use of more than 2 flags later on.  */
    if (maximum + active + current + config + live == 1) {
        if (maximum || active) {
            vshError(ctl,
                     _("when using --%s, one of --config, --live, or --current "
                       "must be specified"),
                     maximum ? "maximum" : "active");
        } else {
            vshError(ctl,
                     _("when using --%s, either --maximum or --active must be "
                       "specified"),
                     (current ? "current" : config ? "config" : "live"));
        }
E
Eric Blake 已提交
3082
        return false;
E
Eric Blake 已提交
3083
    }
3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096

    /* Backwards compatibility: prior to 0.9.4,
     * VIR_DOMAIN_AFFECT_CURRENT was unsupported, and --current meant
     * the opposite of --maximum.  Translate the old '--current
     * --live' into the new '--active --live', while treating the new
     * '--maximum --current' correctly rather than rejecting it as
     * '--maximum --active'.  */
    if (!maximum && !active && current) {
        current = false;
        active = true;
    }

    if (maximum && active) {
E
Eric Blake 已提交
3097
        vshError(ctl, "%s",
3098
                 _("--maximum and --active cannot both be specified"));
E
Eric Blake 已提交
3099
        return false;
E
Eric Blake 已提交
3100
    }
3101 3102 3103
    if (current + config + live > 1) {
        vshError(ctl, "%s",
                 _("--config, --live, and --current are mutually exclusive"));
E
Eric Blake 已提交
3104
        return false;
E
Eric Blake 已提交
3105 3106 3107
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3108
        return false;
E
Eric Blake 已提交
3109 3110

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

    /* In all cases, try the new API first; if it fails because we are
3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127
     * talking to an older client, generally we try a fallback API
     * before giving up.  --current requires the new API, since we
     * don't know whether the domain is running or inactive.  */
    if (current) {
        count = virDomainGetVcpusFlags(dom,
                                       maximum ? VIR_DOMAIN_VCPU_MAXIMUM : 0);
        if (count < 0) {
            virshReportError(ctl);
            ret = false;
        } else {
            vshPrint(ctl, "%d\n", count);
        }
    }

E
Eric Blake 已提交
3128 3129
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
3130
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
3131 3132 3133 3134 3135 3136 3137 3138 3139
        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;
            }
3140 3141
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
3142 3143 3144 3145 3146
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
3147
            ret = false;
E
Eric Blake 已提交
3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159
        } 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 |
3160
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
3161 3162 3163 3164 3165 3166 3167
        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 已提交
3168
            ret = false;
E
Eric Blake 已提交
3169 3170 3171 3172 3173 3174 3175 3176 3177 3178
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3179
    if (all || (active && config)) {
3180
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204
        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 已提交
3205
            ret = false;
E
Eric Blake 已提交
3206 3207 3208 3209 3210 3211 3212 3213 3214 3215
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3216
    if (all || (active && live)) {
3217
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
3218 3219 3220 3221 3222 3223 3224 3225 3226
        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 已提交
3227
            ret = false;
E
Eric Blake 已提交
3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241
        } 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;
}

3242 3243 3244
/*
 * "vcpuinfo" command
 */
3245
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
3246
    {"help", N_("detailed domain vcpu information")},
3247
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
3248 3249 3250
    {NULL, NULL}
};

3251
static const vshCmdOptDef opts_vcpuinfo[] = {
3252
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3253 3254 3255
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3256
static bool
3257
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
3258 3259 3260 3261 3262
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
3263 3264
    unsigned char *cpumaps;
    int ncpus, maxcpu;
3265
    size_t cpumaplen;
E
Eric Blake 已提交
3266
    bool ret = true;
3267
    int n, m;
3268

3269
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3270
        return false;
3271

J
Jim Meyering 已提交
3272
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3273
        return false;
3274 3275 3276

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3277
        return false;
3278 3279 3280 3281
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3282
        return false;
3283 3284
    }

3285
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
3286 3287 3288
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
3289

3290 3291
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
3292
                                   cpumaps, cpumaplen)) >= 0) {
3293 3294 3295 3296
        for (n = 0 ; n < ncpus ; n++) {
            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 已提交
3297
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
3298 3299 3300 3301 3302 3303 3304 3305
            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:"));
3306 3307
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
3308 3309 3310 3311 3312 3313
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
3314
    } else {
3315
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
3316
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3317 3318 3319
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
3320
            /* fallback plan to use virDomainGetVcpuPinInfo */
3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338

            for (n = 0; n < ncpus; n++) {
                vshPrint(ctl, "%-15s %d\n", _("VCPU:"), n);
                vshPrint(ctl, "%-15s %s\n", _("CPU:"), _("N/A"));
                vshPrint(ctl, "%-15s %s\n", _("State:"), _("N/A"));
                vshPrint(ctl, "%-15s %s\n", _("CPU time"), _("N/A"));
                vshPrint(ctl, "%-15s ", _("CPU Affinity:"));
                for (m = 0; m < maxcpu; m++) {
                    vshPrint(ctl, "%c",
                             VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
                }
                vshPrint(ctl, "\n");
                if (n < (ncpus - 1)) {
                    vshPrint(ctl, "\n");
                }
            }
        } else {
            ret = false;
3339
        }
3340 3341
    }

3342
    VIR_FREE(cpumaps);
3343
    VIR_FREE(cpuinfo);
3344 3345 3346 3347 3348 3349 3350
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
3351
static const vshCmdInfo info_vcpupin[] = {
3352
    {"help", N_("control or query domain vcpu affinity")},
3353
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
3354 3355 3356
    {NULL, NULL}
};

3357
static const vshCmdOptDef opts_vcpupin[] = {
3358
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3359 3360 3361
    {"vcpu", VSH_OT_INT, 0, N_("vcpu number")},
    {"cpulist", VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("host cpu number(s) to set, or omit option to query")},
3362 3363 3364
    {"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")},
3365 3366 3367
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3368
static bool
E
Eric Blake 已提交
3369
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
3370 3371 3372 3373
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
3374
    int vcpu = -1;
3375
    const char *cpulist = NULL;
E
Eric Blake 已提交
3376
    bool ret = true;
3377 3378
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
3379
    size_t cpumaplen;
3380 3381
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
3382
    bool unuse = false;
3383
    const char *cur;
3384 3385 3386
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
3387
    bool query = false; /* Query mode if no cpulist */
3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404
    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;
    }
3405

3406
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3407
        return false;
3408

J
Jim Meyering 已提交
3409
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3410
        return false;
3411

3412 3413
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
3414
        virDomainFree(dom);
E
Eric Blake 已提交
3415
        return false;
3416
    }
3417
    query = !cpulist;
3418

3419 3420 3421 3422
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
3423
        virDomainFree(dom);
E
Eric Blake 已提交
3424
        return false;
3425
    }
3426

3427 3428
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3429
        return false;
3430 3431 3432
    }

    if (virDomainGetInfo(dom, &info) != 0) {
3433
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
3434
        virDomainFree(dom);
E
Eric Blake 已提交
3435
        return false;
3436 3437 3438
    }

    if (vcpu >= info.nrVirtCpu) {
3439
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
3440
        virDomainFree(dom);
E
Eric Blake 已提交
3441
        return false;
3442 3443
    }

3444 3445
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
3446

3447 3448 3449 3450 3451 3452 3453 3454
    /* Query mode: show CPU affinity information then exit.*/
    if (query) {
        /* When query mode and neither "live", "config" nor "current"
         * is specified, set VIR_DOMAIN_AFFECT_CURRENT as flags */
        if (flags == -1)
            flags = VIR_DOMAIN_AFFECT_CURRENT;

        cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
E
Eric Blake 已提交
3455
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500
                                             cpumaps, cpumaplen, flags)) >= 0) {

            vshPrint(ctl, "%s %s\n", _("VCPU:"), _("CPU Affinity"));
            vshPrint(ctl, "----------------------------------\n");
            for (i = 0; i < ncpus; i++) {

               if (vcpu != -1 && i != vcpu)
                   continue;

               bit = lastbit = isInvert = false;
               lastcpu = -1;

               vshPrint(ctl, "%4d: ", i);
               for (cpu = 0; cpu < maxcpu; cpu++) {

                   bit = VIR_CPU_USABLE(cpumaps, cpumaplen, i, cpu);

                   isInvert = (bit ^ lastbit);
                   if (bit && isInvert) {
                       if (lastcpu == -1)
                           vshPrint(ctl, "%d", cpu);
                       else
                           vshPrint(ctl, ",%d", cpu);
                       lastcpu = cpu;
                   }
                   if (!bit && isInvert && lastcpu != cpu - 1)
                       vshPrint(ctl, "-%d", cpu - 1);
                   lastbit = bit;
               }
               if (bit && !isInvert) {
                  vshPrint(ctl, "-%d", maxcpu - 1);
               }
               vshPrint(ctl, "\n");
            }

        } else {
            ret = false;
        }
        VIR_FREE(cpumaps);
        goto cleanup;
    }

    /* Pin mode: pinning specified vcpu to specified physical cpus*/

    cpumap = vshCalloc(ctl, 0, cpumaplen);
3501 3502
    /* Parse cpulist */
    cur = cpulist;
3503
    if (*cur == 0) {
3504
        goto parse_error;
3505 3506 3507
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
3508
        cur = "";
3509
    }
3510 3511 3512 3513 3514 3515 3516

    while (*cur != 0) {

        /* the char '^' denotes exclusive */
        if (*cur == '^') {
            cur++;
            unuse = true;
3517 3518
        }

3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530
        /* parse physical CPU number */
        if (!c_isdigit(*cur))
            goto parse_error;
        cpu  = virParseNumber(&cur);
        if (cpu < 0) {
            goto parse_error;
        }
        if (cpu >= maxcpu) {
            vshError(ctl, _("Physical CPU %d doesn't exist."), cpu);
            goto parse_error;
        }
        virSkipSpaces(&cur);
3531

3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558
        if ((*cur == ',') || (*cur == 0)) {
            if (unuse) {
                VIR_UNUSE_CPU(cpumap, cpu);
            } else {
                VIR_USE_CPU(cpumap, cpu);
            }
        } else if (*cur == '-') {
            /* the char '-' denotes range */
            if (unuse) {
                goto parse_error;
            }
            cur++;
            virSkipSpaces(&cur);
            /* parse the end of range */
            lastcpu = virParseNumber(&cur);
            if (lastcpu < cpu) {
                goto parse_error;
            }
            if (lastcpu >= maxcpu) {
                vshError(ctl, _("Physical CPU %d doesn't exist."), maxcpu);
                goto parse_error;
            }
            for (i = cpu; i <= lastcpu; i++) {
                VIR_USE_CPU(cpumap, i);
            }
            virSkipSpaces(&cur);
        }
3559

3560 3561 3562 3563 3564 3565
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
3566
        } else {
3567
            goto parse_error;
3568
        }
3569
    }
3570

3571 3572 3573 3574 3575 3576 3577 3578
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
3579 3580
    }

3581
cleanup:
3582
    VIR_FREE(cpumap);
3583 3584
    virDomainFree(dom);
    return ret;
3585 3586 3587 3588 3589

parse_error:
    vshError(ctl, "%s", _("cpulist: Invalid format."));
    ret = false;
    goto cleanup;
3590 3591
}

3592 3593 3594
/*
 * "setvcpus" command
 */
3595
static const vshCmdInfo info_setvcpus[] = {
3596 3597
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
3598 3599 3600
    {NULL, NULL}
};

3601
static const vshCmdOptDef opts_setvcpus[] = {
3602
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3603
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
3604 3605 3606
    {"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")},
3607
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3608 3609 3610
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3611
static bool
3612
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
3613 3614
{
    virDomainPtr dom;
3615
    int count = 0;
E
Eric Blake 已提交
3616
    bool ret = true;
E
Eric Blake 已提交
3617 3618 3619
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637
    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 && !maximum)
            flags = -1;
    }
3638

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

J
Jim Meyering 已提交
3642
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3643
        return false;
3644

3645 3646 3647 3648
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
3649

3650
    if (flags == -1) {
E
Eric Blake 已提交
3651
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
3652
            ret = false;
E
Eric Blake 已提交
3653 3654
        }
    } else {
3655 3656 3657
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
3658
            vshDebug(ctl, VSH_ERR_DEBUG, "--maximum flag was given\n");
3659

3660 3661
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

3662 3663 3664 3665 3666 3667 3668 3669
            /* 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 已提交
3670
                ret = false;
3671 3672 3673 3674 3675
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
3676
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
3677
            ret = false;
E
Eric Blake 已提交
3678
        }
3679 3680
    }

3681
  cleanup:
3682 3683 3684 3685
    virDomainFree(dom);
    return ret;
}

3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719
/*
 * "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;
}

3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811
/*
 * "send-key" command
 */
static const vshCmdInfo info_send_key[] = {
    {"help", N_("Send keycodes to the guest")},
    {"desc", N_("Send keycodes to the guest, the keycodes must be integers\n"
                "    Examples:\n\n"
                "        virsh # send-key <domain> 37 18 21\n"
                "        virsh # send-key <domain> KEY_RIGHTCTRL KEY_C\n"
                "        virsh # send-key <domain> --codeset xt 37 18 21\n"
                "        virsh # send-key <domain> --holdtime 1000 0x15 18 0xf\n"
                )},
    {NULL, NULL}
};

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT, N_("the codeset of keycodes, default:linux")},
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
                 N_("the time (in millsecond) how long the keys will be held")},
    {"keycode", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("the key code")},
    {NULL, 0, 0, NULL}
};

static int get_integer_keycode(const char *key_name)
{
    long val;
    char *endptr;

    val = strtol(key_name, &endptr, 0);
    if (*endptr != '\0' || val > 0xffff || val <= 0)
         return -1;

    return val;
}

static bool
cmdSendKey(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int ret = false;
    const char *codeset_option;
    int codeset;
    int holdtime;
    int count = 0;
    const vshCmdOpt *opt = NULL;
    int keycode;
    unsigned int keycodes[VIR_DOMAIN_SEND_KEY_MAX_KEYS];

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

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

    if (vshCommandOptString(cmd, "codeset", &codeset_option) <= 0)
        codeset_option = "linux";

    if (vshCommandOptInt(cmd, "holdtime", &holdtime) <= 0)
        holdtime = 0;

    codeset = virKeycodeSetTypeFromString(codeset_option);
    if ((int)codeset < 0) {
        vshError(ctl, _("unknown codeset: '%s'"), codeset_option);
        goto cleanup;
    }

    while ((opt = vshCommandOptArgv(cmd, opt))) {
        if (count == VIR_DOMAIN_SEND_KEY_MAX_KEYS) {
            vshError(ctl, _("too many keycodes"));
            goto cleanup;
        }

        if ((keycode = get_integer_keycode(opt->data)) <= 0) {
            if ((keycode = virKeycodeValueFromString(codeset, opt->data)) <= 0) {
                vshError(ctl, _("invalid keycode: '%s'"), opt->data);
                goto cleanup;
            }
        }

        keycodes[count] = keycode;
        count++;
    }

    if (!(virDomainSendKey(dom, codeset, holdtime, keycodes, count, 0) < 0))
        ret = true;

cleanup:
    virDomainFree(dom);
    return ret;
}

3812 3813 3814
/*
 * "setmemory" command
 */
3815
static const vshCmdInfo info_setmem[] = {
3816 3817
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
3818 3819 3820
    {NULL, NULL}
};

3821
static const vshCmdOptDef opts_setmem[] = {
3822
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3823
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
3824 3825
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
3826
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3827 3828 3829
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3830
static bool
3831
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
3832 3833
{
    virDomainPtr dom;
3834
    virDomainInfo info;
3835
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
3836
    bool ret = true;
3837 3838
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3839
    int current = vshCommandOptBool(cmd, "current");
3840 3841
    int flags = 0;

3842 3843 3844
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3845
            return false;
3846
        }
3847
        flags = VIR_DOMAIN_AFFECT_CURRENT;
3848 3849
    } else {
        if (config)
3850
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3851
        if (live)
3852
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3853 3854 3855
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
3856
    }
3857

3858
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3859
        return false;
3860

J
Jim Meyering 已提交
3861
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3862
        return false;
3863

3864 3865
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3866
        return false;
3867 3868
    }

3869
    if (kilobytes <= 0) {
3870
        virDomainFree(dom);
3871
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
3872
        return false;
3873 3874
    }

3875 3876
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
3877
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
3878
        return false;
3879 3880 3881 3882
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
3883
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
3884
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
3885
        return false;
3886 3887
    }

3888
    if (flags == -1) {
3889
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
3890
            ret = false;
3891 3892 3893
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
3894
            ret = false;
3895
        }
3896 3897 3898 3899 3900 3901 3902 3903 3904
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
3905
static const vshCmdInfo info_setmaxmem[] = {
3906 3907
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
3908 3909 3910
    {NULL, NULL}
};

3911
static const vshCmdOptDef opts_setmaxmem[] = {
3912
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3913
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
3914 3915 3916
    {"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")},
3917 3918 3919
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3920
static bool
3921
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
3922 3923
{
    virDomainPtr dom;
3924
    int kilobytes = 0;
E
Eric Blake 已提交
3925
    bool ret = true;
3926 3927 3928 3929 3930 3931 3932 3933
    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 已提交
3934
            return false;
3935 3936 3937
        }
    } else {
        if (config)
3938
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3939
        if (live)
3940
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3941 3942 3943 3944
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
3945

3946
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3947
        return false;
3948

J
Jim Meyering 已提交
3949
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3950
        return false;
3951

3952 3953
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3954
        return false;
3955 3956
    }

3957
    if (kilobytes <= 0) {
3958
        virDomainFree(dom);
3959
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
3960
        return false;
3961 3962
    }

3963 3964 3965
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3966
            ret = false;
3967 3968 3969 3970
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3971
            ret = false;
3972
        }
3973 3974
    }

3975 3976 3977 3978
    virDomainFree(dom);
    return ret;
}

3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994
/*
 * "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 已提交
3995 3996 3997
    {"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")},
3998 3999 4000
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4001
static bool
4002 4003 4004 4005 4006
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
4007
    int rv = 0;
4008
    unsigned int i = 0;
4009
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4010
    bool ret = false;
H
Hu Tao 已提交
4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027
    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;
    }
4028 4029

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4030
        return false;
4031 4032

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

4035
    if ((rv = vshCommandOptInt(cmd, "weight", &weight)) < 0) {
4036 4037 4038 4039 4040
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

4041
    if (rv > 0) {
4042
        nparams++;
4043
        if (weight <= 0) {
4044 4045 4046 4047 4048 4049 4050
            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 已提交
4051
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
4052 4053 4054 4055 4056 4057 4058
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4059
            ret = true;
4060 4061 4062 4063 4064
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
4065
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
4066 4067 4068 4069 4070 4071
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4072
                case VIR_TYPED_PARAM_INT:
4073 4074 4075
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4076
                case VIR_TYPED_PARAM_UINT:
4077 4078 4079
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4080
                case VIR_TYPED_PARAM_LLONG:
4081 4082 4083
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4084
                case VIR_TYPED_PARAM_ULLONG:
4085 4086 4087
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
4088
                case VIR_TYPED_PARAM_DOUBLE:
4089 4090 4091
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4092
                case VIR_TYPED_PARAM_BOOLEAN:
4093 4094 4095 4096 4097 4098 4099 4100
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
4101
        ret = true;
4102 4103 4104 4105 4106 4107
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4108
            temp->type = VIR_TYPED_PARAM_UINT;
4109 4110 4111 4112 4113 4114 4115 4116

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
H
Hu Tao 已提交
4117
        if (virDomainSetBlkioParameters(dom, params, nparams, flags) != 0)
4118 4119
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
4120
            ret = true;
4121 4122 4123 4124 4125 4126 4127 4128
    }

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

4129 4130 4131 4132
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
4133 4134 4135
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
4136 4137 4138 4139 4140 4141 4142
                "    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")},
4143
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4144
     N_("Max memory in kilobytes")},
4145
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4146
     N_("Memory during contention in kilobytes")},
4147
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4148
     N_("Max memory plus swap in kilobytes")},
4149
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
4150
     N_("Min guaranteed memory in kilobytes")},
4151 4152 4153
    {"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")},
4154 4155 4156
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4157
static bool
4158 4159 4160
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
4161 4162
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
4163 4164
    int nparams = 0;
    unsigned int i = 0;
4165
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4166
    bool ret = false;
4167 4168 4169 4170 4171 4172 4173 4174 4175 4176
    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;
        }
4177
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4178 4179
    } else {
        if (config)
4180
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4181
        if (live)
4182
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4183
    }
4184 4185

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4186
        return false;
4187 4188

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

4191 4192 4193 4194 4195 4196 4197 4198 4199
    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;
    }

4200 4201 4202 4203 4204 4205 4206 4207 4208
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

4209 4210 4211
    if (min_guarantee)
        nparams++;

4212 4213
    if (nparams == 0) {
        /* get the number of memory parameters */
4214
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
4215 4216 4217 4218 4219
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

4220 4221
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4222
            ret = true;
4223 4224 4225
            goto cleanup;
        }

4226
        /* now go get all the memory parameters */
E
Eric Blake 已提交
4227
        params = vshCalloc(ctl, nparams, sizeof(*params));
4228
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
4229 4230 4231 4232 4233 4234
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4235
                case VIR_TYPED_PARAM_INT:
4236 4237 4238
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4239
                case VIR_TYPED_PARAM_UINT:
4240 4241 4242
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4243
                case VIR_TYPED_PARAM_LLONG:
4244 4245 4246
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4247
                case VIR_TYPED_PARAM_ULLONG:
4248 4249 4250 4251 4252
                    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);
4253
                    break;
4254
                case VIR_TYPED_PARAM_DOUBLE:
4255 4256 4257
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4258
                case VIR_TYPED_PARAM_BOOLEAN:
4259 4260 4261 4262
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
4263
                    vshPrint(ctl, "unimplemented memory parameter type\n");
4264 4265 4266
            }
        }

E
Eric Blake 已提交
4267
        ret = true;
4268 4269
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
4270
        params = vshCalloc(ctl, nparams, sizeof(*params));
4271 4272 4273

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4274
            temp->type = VIR_TYPED_PARAM_ULLONG;
4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293

            /*
             * 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;
4294
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
4295 4296
                        sizeof(temp->field));
                swap_hard_limit = 0;
4297 4298 4299 4300 4301
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
4302
            }
4303 4304 4305 4306

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
4307
        }
4308
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
4309
            vshError(ctl, "%s", _("Unable to change memory parameters"));
4310
        else
E
Eric Blake 已提交
4311
            ret = true;
4312 4313 4314
    }

  cleanup:
E
Eric Blake 已提交
4315
    VIR_FREE(params);
4316 4317 4318 4319
    virDomainFree(dom);
    return ret;
}

4320 4321 4322
/*
 * "nodeinfo" command
 */
4323
static const vshCmdInfo info_nodeinfo[] = {
4324 4325
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
4326 4327 4328
    {NULL, NULL}
};

E
Eric Blake 已提交
4329
static bool
4330
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4331 4332
{
    virNodeInfo info;
4333

4334
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4335
        return false;
4336 4337

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
4338
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
4339
        return false;
4340 4341 4342 4343 4344 4345 4346 4347 4348 4349
    }
    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 已提交
4350
    return true;
4351 4352
}

4353 4354 4355 4356 4357
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
4358
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
4359 4360 4361 4362 4363 4364 4365 4366 4367 4368
    {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
4369
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
4370 4371 4372 4373
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
4374 4375
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418
    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;

4419
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
4420
                cpu_stats[i].sys = value;
4421
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
4422
                cpu_stats[i].user = value;
4423
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
4424
                cpu_stats[i].idle = value;
4425
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
4426
                cpu_stats[i].iowait = value;
4427
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441
                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) {
4442
            vshPrint(ctl, "%-15s %20llu\n", _("user:"), cpu_stats[0].user);
4443
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
4444
            vshPrint(ctl, "%-15s %20llu\n", _("idle:"), cpu_stats[0].idle);
4445 4446 4447 4448 4449 4450 4451
            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);
4452
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle:"), 100 - usage);
4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464
        } 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",
4465
                     _("user:"), user_time / total_time * 100);
4466
            vshPrint(ctl, "%-15s %5.1lf%%\n",
4467
                     _("system:"), sys_time  / total_time * 100);
4468
            vshPrint(ctl, "%-15s %5.1lf%%\n",
4469
                     _("idle:"), idle_time     / total_time * 100);
4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500
/*
 * "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;
4501 4502
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542
    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;
}

4543 4544 4545
/*
 * "capabilities" command
 */
4546
static const vshCmdInfo info_capabilities[] = {
4547 4548
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
4549 4550 4551
    {NULL, NULL}
};

E
Eric Blake 已提交
4552
static bool
4553
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4554 4555 4556
{
    char *caps;

4557
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4558
        return false;
4559 4560

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
4561
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
4562
        return false;
4563 4564
    }
    vshPrint (ctl, "%s\n", caps);
4565
    VIR_FREE(caps);
4566

E
Eric Blake 已提交
4567
    return true;
4568 4569
}

4570 4571 4572
/*
 * "dumpxml" command
 */
4573
static const vshCmdInfo info_dumpxml[] = {
4574 4575
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
4576
    {NULL, NULL}
4577 4578
};

4579
static const vshCmdOptDef opts_dumpxml[] = {
4580 4581 4582
    {"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")},
4583
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
4584
    {NULL, 0, 0, NULL}
4585 4586
};

E
Eric Blake 已提交
4587
static bool
4588
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
4589
{
4590
    virDomainPtr dom;
E
Eric Blake 已提交
4591
    bool ret = true;
4592
    char *dump;
4593 4594 4595
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
4596
    int update = vshCommandOptBool(cmd, "update-cpu");
4597 4598 4599 4600 4601

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
4602 4603
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
4604

4605
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4606
        return false;
4607

J
Jim Meyering 已提交
4608
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4609
        return false;
4610

4611
    dump = virDomainGetXMLDesc(dom, flags);
4612
    if (dump != NULL) {
4613
        vshPrint(ctl, "%s", dump);
4614
        VIR_FREE(dump);
4615
    } else {
E
Eric Blake 已提交
4616
        ret = false;
4617
    }
4618

4619 4620 4621 4622
    virDomainFree(dom);
    return ret;
}

4623 4624 4625 4626
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
4627 4628
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
4629 4630 4631 4632
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
4633 4634
    {"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")},
4635 4636 4637
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4638
static bool
4639 4640
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4641
    bool ret = true;
4642 4643
    const char *format = NULL;
    const char *configFile = NULL;
4644 4645 4646 4647
    char *configData;
    char *xmlData;
    int flags = 0;

4648
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4649
        return false;
4650

4651 4652
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
4653
        return false;
4654

4655
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
4656
        return false;
4657 4658 4659

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
4660
        vshPrint(ctl, "%s", xmlData);
4661
        VIR_FREE(xmlData);
4662
    } else {
E
Eric Blake 已提交
4663
        ret = false;
4664 4665 4666 4667 4668 4669 4670 4671 4672
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
4673 4674
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
4675 4676 4677 4678
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
4679 4680
    {"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")},
4681 4682 4683
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4684
static bool
4685 4686
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4687
    bool ret = true;
4688 4689
    const char *format = NULL;
    const char *xmlFile = NULL;
4690 4691 4692 4693
    char *configData;
    char *xmlData;
    int flags = 0;

4694
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4695
        return false;
4696

4697 4698
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
4699
        return false;
4700

4701
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
4702
        return false;
4703 4704 4705

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
4706
        vshPrint(ctl, "%s", configData);
4707
        VIR_FREE(configData);
4708
    } else {
E
Eric Blake 已提交
4709
        ret = false;
4710 4711 4712 4713 4714
    }

    return ret;
}

K
Karel Zak 已提交
4715
/*
K
Karel Zak 已提交
4716
 * "domname" command
K
Karel Zak 已提交
4717
 */
4718
static const vshCmdInfo info_domname[] = {
4719
    {"help", N_("convert a domain id or UUID to domain name")},
4720
    {"desc", ""},
4721
    {NULL, NULL}
K
Karel Zak 已提交
4722 4723
};

4724
static const vshCmdOptDef opts_domname[] = {
4725
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
4726
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4727 4728
};

E
Eric Blake 已提交
4729
static bool
4730
cmdDomname(vshControl *ctl, const vshCmd *cmd)
4731
{
K
Karel Zak 已提交
4732 4733
    virDomainPtr dom;

4734
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4735
        return false;
J
Jim Meyering 已提交
4736
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4737
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
4738
        return false;
4739

K
Karel Zak 已提交
4740 4741
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
4742
    return true;
K
Karel Zak 已提交
4743 4744 4745
}

/*
K
Karel Zak 已提交
4746
 * "domid" command
K
Karel Zak 已提交
4747
 */
4748
static const vshCmdInfo info_domid[] = {
4749
    {"help", N_("convert a domain name or UUID to domain id")},
4750
    {"desc", ""},
4751
    {NULL, NULL}
K
Karel Zak 已提交
4752 4753
};

4754
static const vshCmdOptDef opts_domid[] = {
4755
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
4756
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4757 4758
};

E
Eric Blake 已提交
4759
static bool
4760
cmdDomid(vshControl *ctl, const vshCmd *cmd)
4761
{
4762
    virDomainPtr dom;
4763
    unsigned int id;
K
Karel Zak 已提交
4764

4765
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4766
        return false;
J
Jim Meyering 已提交
4767
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4768
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
4769
        return false;
4770

4771 4772
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
4773
        vshPrint(ctl, "%s\n", "-");
4774
    else
4775
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
4776
    virDomainFree(dom);
E
Eric Blake 已提交
4777
    return true;
K
Karel Zak 已提交
4778
}
4779

K
Karel Zak 已提交
4780 4781 4782
/*
 * "domuuid" command
 */
4783
static const vshCmdInfo info_domuuid[] = {
4784
    {"help", N_("convert a domain name or id to domain UUID")},
4785
    {"desc", ""},
K
Karel Zak 已提交
4786 4787 4788
    {NULL, NULL}
};

4789
static const vshCmdOptDef opts_domuuid[] = {
4790
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
4791 4792 4793
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4794
static bool
4795
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
4796 4797
{
    virDomainPtr dom;
4798
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
4799

4800
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4801
        return false;
J
Jim Meyering 已提交
4802
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4803
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
4804
        return false;
4805

K
Karel Zak 已提交
4806 4807 4808
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
4809
        vshError(ctl, "%s", _("failed to get domain UUID"));
4810

4811
    virDomainFree(dom);
E
Eric Blake 已提交
4812
    return true;
K
Karel Zak 已提交
4813 4814
}

4815 4816 4817
/*
 * "migrate" command
 */
4818
static const vshCmdInfo info_migrate[] = {
4819 4820
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
4821 4822 4823
    {NULL, NULL}
};

4824
static const vshCmdOptDef opts_migrate[] = {
4825 4826 4827 4828 4829 4830 4831
    {"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")},
4832 4833
    {"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)")},
4834 4835
    {"change-protection", VSH_OT_BOOL, 0,
     N_("prevent any configuration changes to domain until migration ends)")},
W
Wen Congyang 已提交
4836
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
4837
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4838
    {"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)")},
4839 4840
    {"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 已提交
4841
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
4842
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
4843 4844 4845
    {NULL, 0, 0, NULL}
};

4846 4847 4848 4849 4850 4851 4852 4853
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
4854
{
4855
    char ret = '1';
4856
    virDomainPtr dom = NULL;
4857 4858 4859 4860
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
    int flags = 0;
4861 4862 4863
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
4864 4865
    const char *xmlfile = NULL;
    char *xml = NULL;
4866
    sigset_t sigmask, oldsigmask;
4867 4868 4869 4870 4871

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
    if (pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask) < 0)
        goto out_sig;
4872

4873
    if (!vshConnectionUsability (ctl, ctl->conn))
4874
        goto out;
4875

J
Jim Meyering 已提交
4876
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
4877
        goto out;
4878

4879 4880
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
4881 4882
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
4883
        goto out;
4884
    }
4885

4886 4887 4888 4889 4890
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

4891 4892
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
4893 4894
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
4895
    if (vshCommandOptBool (cmd, "tunnelled"))
4896
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
4897

C
Chris Lalancette 已提交
4898 4899 4900 4901 4902
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

4903 4904 4905
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

4906 4907 4908 4909 4910 4911
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

4912 4913
    if (vshCommandOptBool (cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;
4914 4915 4916 4917 4918 4919

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


4920 4921 4922 4923
    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. */
4924

4925
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
4926
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
4927
            goto out;
4928
        }
4929

4930
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
4931
            ret = '0';
4932 4933 4934 4935 4936 4937
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
4938
        if (!dconn) goto out;
4939

4940
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
4941 4942
        if (ddom) {
            virDomainFree(ddom);
4943
            ret = '0';
4944 4945 4946
        }
        virConnectClose (dconn);
    }
4947

4948 4949 4950
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
4951
    if (dom) virDomainFree (dom);
4952
    VIR_FREE(xml);
4953 4954 4955
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
4956
static void
4957 4958
print_job_progress(const char *label, unsigned long long remaining,
                   unsigned long long total)
W
Wen Congyang 已提交
4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977
{
    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;
        }
    }

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

E
Eric Blake 已提交
4981
static bool
4982 4983 4984 4985 4986
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
4987
    bool functionReturn = false;
4988 4989 4990 4991 4992
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
4993 4994
    virDomainJobInfo jobinfo;
    bool verbose = false;
4995
    int timeout = 0;
W
Wen Congyang 已提交
4996 4997
    struct timeval start, curr;
    bool live_flag = false;
4998
    vshCtrlData data;
4999 5000 5001 5002
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
5003 5004

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

W
Wen Congyang 已提交
5007 5008 5009
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
5010
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
5011
        live_flag = true;
5012
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029
        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;
        }
    }

5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052
    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 已提交
5053
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
5054
    while (1) {
5055
repoll:
W
Wen Congyang 已提交
5056 5057 5058 5059
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
5060
                    functionReturn = true;
W
Wen Congyang 已提交
5061 5062
                    if (verbose) {
                        /* print [100 %] */
5063
                        print_job_progress("Migration", 0, 1);
W
Wen Congyang 已提交
5064 5065
                    }
                } else
W
Wen Congyang 已提交
5066
                    functionReturn = false;
5067
            } else
W
Wen Congyang 已提交
5068
                functionReturn = false;
W
Wen Congyang 已提交
5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
5080
            functionReturn = false;
W
Wen Congyang 已提交
5081 5082 5083
            break;
        }

W
Wen Congyang 已提交
5084 5085 5086 5087
        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. */
5088 5089
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "suspend the domain when migration timeouts\n");
W
Wen Congyang 已提交
5090 5091 5092 5093
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
5094 5095 5096 5097 5098
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
5099 5100
                print_job_progress("Migration", jobinfo.dataRemaining,
                                   jobinfo.dataTotal);
5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
5112
    return functionReturn;
5113 5114
}

5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125
/*
 * "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")},
5126
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
5127 5128 5129
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5130
static bool
5131 5132 5133
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
5134
    long long downtime = 0;
E
Eric Blake 已提交
5135
    bool ret = false;
5136

5137
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5138
        return false;
5139 5140

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

5143 5144
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
5145 5146 5147 5148 5149 5150 5151
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
5152
    ret = true;
5153 5154 5155 5156 5157 5158

done:
    virDomainFree(dom);
    return ret;
}

5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202
/*
 * "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;
}

5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325
typedef enum {
    VSH_CMD_BLOCK_JOB_ABORT = 0,
    VSH_CMD_BLOCK_JOB_INFO = 1,
    VSH_CMD_BLOCK_JOB_SPEED = 2,
    VSH_CMD_BLOCK_JOB_PULL = 3,
} VSH_CMD_BLOCK_JOB_MODE;

static int
blockJobImpl(vshControl *ctl, const vshCmd *cmd,
              virDomainBlockJobInfoPtr info, int mode)
{
    virDomainPtr dom = NULL;
    const char *name, *path;
    unsigned long bandwidth = 0;
    int ret = -1;

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
        goto out;

    if (vshCommandOptString(cmd, "path", &path) < 0)
        goto out;

    if (vshCommandOptUL(cmd, "bandwidth", &bandwidth) < 0)
        goto out;

    if (mode == VSH_CMD_BLOCK_JOB_ABORT)
        ret = virDomainBlockJobAbort(dom, path, 0);
    else if (mode == VSH_CMD_BLOCK_JOB_INFO)
        ret = virDomainGetBlockJobInfo(dom, path, info, 0);
    else if (mode == VSH_CMD_BLOCK_JOB_SPEED)
        ret = virDomainBlockJobSetSpeed(dom, path, bandwidth, 0);
    else if (mode == VSH_CMD_BLOCK_JOB_PULL)
        ret = virDomainBlockPull(dom, path, bandwidth, 0);

out:
    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")},
    {"bandwidth", VSH_OT_DATA, VSH_OFLAG_NONE, N_("Bandwidth limit in MB/s")},
    {NULL, 0, 0, NULL}
};

static bool
cmdBlockPull(vshControl *ctl, const vshCmd *cmd)
{
    if (blockJobImpl(ctl, cmd, NULL, VSH_CMD_BLOCK_JOB_PULL) != 0)
        return false;
    return true;
}

/*
 * "blockjobinfo" command
 */
static const vshCmdInfo info_block_job[] = {
    {"help", N_("Manage active block operations.")},
    {"desc", N_("Manage active block operations.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_block_job[] = {
    {"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")},
    {"abort", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("Abort the active job on the speficied disk")},
    {"info", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("Get active job information for the specified disk")},
    {"bandwidth", VSH_OT_DATA, VSH_OFLAG_NONE, N_("Set the Bandwidth limit in MB/s")},
    {NULL, 0, 0, NULL}
};

static bool
cmdBlockJob(vshControl *ctl, const vshCmd *cmd)
{
    int mode;
    virDomainBlockJobInfo info;
    const char *type;
    int ret;

    if (vshCommandOptBool (cmd, "abort")) {
        mode = VSH_CMD_BLOCK_JOB_ABORT;
    } else if (vshCommandOptBool (cmd, "info")) {
        mode = VSH_CMD_BLOCK_JOB_INFO;
    } else if (vshCommandOptBool (cmd, "bandwidth")) {
        mode = VSH_CMD_BLOCK_JOB_SPEED;
    } else {
        vshError(ctl, "%s",
                 _("One of --abort, --info, or --bandwidth is required"));
        return false;
    }

    ret = blockJobImpl(ctl, cmd, &info, mode);
    if (ret < 0)
        return false;

    if (ret == 0 || mode != VSH_CMD_BLOCK_JOB_INFO)
        return true;

    if (info.type == VIR_DOMAIN_BLOCK_JOB_TYPE_PULL)
        type = "Block Pull";
    else
        type = "Unknown job";

    print_job_progress(type, info.end - info.cur, info.end);
    if (info.bandwidth != 0)
        vshPrint(ctl, "    Bandwidth limit: %lu MB/s\n", info.bandwidth);
    return true;
}


5326 5327 5328
/*
 * "net-autostart" command
 */
5329
static const vshCmdInfo info_network_autostart[] = {
5330
    {"help", N_("autostart a network")},
5331
    {"desc",
5332
     N_("Configure a network to be automatically started at boot.")},
5333 5334 5335
    {NULL, NULL}
};

5336
static const vshCmdOptDef opts_network_autostart[] = {
5337 5338
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5339 5340 5341
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5342
static bool
5343
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
5344 5345
{
    virNetworkPtr network;
5346
    const char *name;
5347 5348
    int autostart;

5349
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5350
        return false;
5351

J
Jim Meyering 已提交
5352
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5353
        return false;
5354 5355 5356 5357

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
5358
        if (autostart)
5359
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
5360
        else
5361
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
5362
        virNetworkFree(network);
E
Eric Blake 已提交
5363
        return false;
5364 5365
    }

5366
    if (autostart)
5367
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
5368
    else
5369
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
5370

L
Laine Stump 已提交
5371
    virNetworkFree(network);
E
Eric Blake 已提交
5372
    return true;
5373
}
K
Karel Zak 已提交
5374

5375 5376 5377
/*
 * "net-create" command
 */
5378
static const vshCmdInfo info_network_create[] = {
5379 5380
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
5381 5382 5383
    {NULL, NULL}
};

5384
static const vshCmdOptDef opts_network_create[] = {
5385
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5386 5387 5388
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5389
static bool
5390
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
5391 5392
{
    virNetworkPtr network;
5393
    const char *from = NULL;
E
Eric Blake 已提交
5394
    bool ret = true;
5395
    char *buffer;
5396

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

5400
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5401
        return false;
5402

5403
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5404
        return false;
5405 5406

    network = virNetworkCreateXML(ctl->conn, buffer);
5407
    VIR_FREE(buffer);
5408

5409 5410 5411
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
5412
        virNetworkFree(network);
5413
    } else {
5414
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
5415
        ret = false;
5416 5417 5418 5419 5420 5421 5422 5423
    }
    return ret;
}


/*
 * "net-define" command
 */
5424
static const vshCmdInfo info_network_define[] = {
5425 5426
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
5427 5428 5429
    {NULL, NULL}
};

5430
static const vshCmdOptDef opts_network_define[] = {
5431
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5432 5433 5434
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5435
static bool
5436
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
5437 5438
{
    virNetworkPtr network;
5439
    const char *from = NULL;
E
Eric Blake 已提交
5440
    bool ret = true;
5441
    char *buffer;
5442

5443
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5444
        return false;
5445

5446
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5447
        return false;
5448

5449
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5450
        return false;
5451 5452

    network = virNetworkDefineXML(ctl->conn, buffer);
5453
    VIR_FREE(buffer);
5454

5455 5456 5457
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
5458
        virNetworkFree(network);
5459
    } else {
5460
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
5461
        ret = false;
5462 5463 5464 5465 5466 5467 5468 5469
    }
    return ret;
}


/*
 * "net-destroy" command
 */
5470
static const vshCmdInfo info_network_destroy[] = {
5471 5472
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
5473 5474 5475
    {NULL, NULL}
};

5476
static const vshCmdOptDef opts_network_destroy[] = {
5477
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5478 5479 5480
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5481
static bool
5482
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
5483 5484
{
    virNetworkPtr network;
E
Eric Blake 已提交
5485
    bool ret = true;
5486
    const char *name;
5487

5488
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5489
        return false;
5490

J
Jim Meyering 已提交
5491
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5492
        return false;
5493 5494 5495 5496

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

5501
    virNetworkFree(network);
5502 5503 5504 5505 5506 5507 5508
    return ret;
}


/*
 * "net-dumpxml" command
 */
5509
static const vshCmdInfo info_network_dumpxml[] = {
5510 5511
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
5512 5513 5514
    {NULL, NULL}
};

5515
static const vshCmdOptDef opts_network_dumpxml[] = {
5516
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5517 5518 5519
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5520
static bool
5521
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
5522 5523
{
    virNetworkPtr network;
E
Eric Blake 已提交
5524
    bool ret = true;
5525 5526
    char *dump;

5527
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5528
        return false;
5529

J
Jim Meyering 已提交
5530
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
5531
        return false;
5532 5533 5534

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
5535
        vshPrint(ctl, "%s", dump);
5536
        VIR_FREE(dump);
5537
    } else {
E
Eric Blake 已提交
5538
        ret = false;
5539 5540 5541 5542 5543 5544
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558
/*
 * "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 已提交
5559
static bool
O
Osier Yang 已提交
5560 5561 5562 5563 5564 5565 5566 5567 5568 5569
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 已提交
5570
        return false;
O
Osier Yang 已提交
5571 5572 5573

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5574
        return false;
O
Osier Yang 已提交
5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599

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

5600
    VIR_FREE(bridge);
O
Osier Yang 已提交
5601
    virNetworkFree(network);
E
Eric Blake 已提交
5602
    return true;
O
Osier Yang 已提交
5603
}
5604

5605 5606 5607 5608
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
5609 5610
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
5611 5612 5613 5614
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
5615
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5616 5617 5618
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5619
static bool
5620 5621
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5622
    bool ret = false;
5623 5624 5625 5626 5627
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
5628
    int flags = VIR_INTERFACE_XML_INACTIVE;
5629

5630
    if (!vshConnectionUsability(ctl, ctl->conn))
5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656
        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 已提交
5657
        ret = true;
5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669
        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)) {
5670 5671
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683
        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 已提交
5684
    ret = true;
5685 5686 5687 5688 5689

cleanup:
    if (iface)
        virInterfaceFree (iface);

5690 5691 5692
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
5693 5694 5695

    if (tmp) {
        unlink (tmp);
5696
        VIR_FREE(tmp);
5697 5698 5699 5700 5701
    }

    return ret;
}

5702 5703 5704
/*
 * "net-list" command
 */
5705
static const vshCmdInfo info_network_list[] = {
5706 5707
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
5708 5709 5710
    {NULL, NULL}
};

5711
static const vshCmdOptDef opts_network_list[] = {
5712 5713
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
5714 5715 5716
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5717
static bool
5718
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5719 5720 5721 5722 5723
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
5724
    char **activeNames = NULL, **inactiveNames = NULL;
5725 5726
    inactive |= all;

5727
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5728
        return false;
5729 5730

    if (active) {
5731 5732
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
5733
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
5734
            return false;
5735
        }
5736
        if (maxactive) {
5737
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
5738

5739
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
5740
                                                    maxactive)) < 0) {
5741
                vshError(ctl, "%s", _("Failed to list active networks"));
5742
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5743
                return false;
5744
            }
5745

5746
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
5747
        }
5748 5749
    }
    if (inactive) {
5750 5751
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
5752
            vshError(ctl, "%s", _("Failed to list inactive networks"));
5753
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5754
            return false;
5755
        }
5756 5757 5758
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5759 5760 5761
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
5762
                vshError(ctl, "%s", _("Failed to list inactive networks"));
5763 5764
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5765
                return false;
5766
            }
5767

5768 5769
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
5770
    }
5771 5772
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
5773
    vshPrintExtra(ctl, "-----------------------------------------\n");
5774 5775

    for (i = 0; i < maxactive; i++) {
5776 5777
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
5778 5779
        const char *autostartStr;
        int autostart = 0;
5780 5781 5782

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5783
            VIR_FREE(activeNames[i]);
5784
            continue;
5785
        }
5786

5787 5788 5789
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5790
            autostartStr = autostart ? _("yes") : _("no");
5791 5792 5793 5794 5795

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
5796
        virNetworkFree(network);
5797
        VIR_FREE(activeNames[i]);
5798 5799 5800
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
5801 5802
        const char *autostartStr;
        int autostart = 0;
5803 5804 5805

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5806
            VIR_FREE(inactiveNames[i]);
5807
            continue;
5808
        }
5809

5810 5811 5812
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5813
            autostartStr = autostart ? _("yes") : _("no");
5814

5815
        vshPrint(ctl, "%-20s %-10s %-10s\n",
5816 5817 5818
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
5819 5820

        virNetworkFree(network);
5821
        VIR_FREE(inactiveNames[i]);
5822
    }
5823 5824
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5825
    return true;
5826 5827 5828 5829 5830 5831
}


/*
 * "net-name" command
 */
5832
static const vshCmdInfo info_network_name[] = {
5833
    {"help", N_("convert a network UUID to network name")},
5834
    {"desc", ""},
5835 5836 5837
    {NULL, NULL}
};

5838
static const vshCmdOptDef opts_network_name[] = {
5839
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
5840 5841 5842
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5843
static bool
5844
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
5845 5846 5847
{
    virNetworkPtr network;

5848
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5849
        return false;
J
Jim Meyering 已提交
5850
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5851
                                           VSH_BYUUID)))
E
Eric Blake 已提交
5852
        return false;
5853 5854 5855

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
5856
    return true;
5857 5858 5859 5860 5861 5862
}


/*
 * "net-start" command
 */
5863
static const vshCmdInfo info_network_start[] = {
5864 5865
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
5866 5867 5868
    {NULL, NULL}
};

5869
static const vshCmdOptDef opts_network_start[] = {
5870
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
5871 5872 5873
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5874
static bool
5875
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
5876 5877
{
    virNetworkPtr network;
E
Eric Blake 已提交
5878
    bool ret = true;
5879

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

J
Jim Meyering 已提交
5883
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
5884
         return false;
5885 5886 5887

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
5888
                 virNetworkGetName(network));
5889
    } else {
5890
        vshError(ctl, _("Failed to start network %s"),
5891
                 virNetworkGetName(network));
E
Eric Blake 已提交
5892
        ret = false;
5893
    }
L
Laine Stump 已提交
5894
    virNetworkFree(network);
5895 5896 5897 5898 5899 5900 5901
    return ret;
}


/*
 * "net-undefine" command
 */
5902
static const vshCmdInfo info_network_undefine[] = {
5903 5904
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
5905 5906 5907
    {NULL, NULL}
};

5908
static const vshCmdOptDef opts_network_undefine[] = {
5909
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5910 5911 5912
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5913
static bool
5914
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
5915 5916
{
    virNetworkPtr network;
E
Eric Blake 已提交
5917
    bool ret = true;
5918
    const char *name;
5919

5920
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5921
        return false;
5922

J
Jim Meyering 已提交
5923
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5924
        return false;
5925 5926 5927 5928

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

L
Laine Stump 已提交
5933
    virNetworkFree(network);
5934 5935 5936 5937 5938 5939 5940
    return ret;
}


/*
 * "net-uuid" command
 */
5941
static const vshCmdInfo info_network_uuid[] = {
5942
    {"help", N_("convert a network name to network UUID")},
5943
    {"desc", ""},
5944 5945 5946
    {NULL, NULL}
};

5947
static const vshCmdOptDef opts_network_uuid[] = {
5948
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
5949 5950 5951
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5952
static bool
5953
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
5954 5955 5956 5957
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

5958
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5959
        return false;
5960

J
Jim Meyering 已提交
5961
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5962
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5963
        return false;
5964 5965 5966 5967

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

L
Laine Stump 已提交
5970
    virNetworkFree(network);
E
Eric Blake 已提交
5971
    return true;
5972 5973 5974
}


5975 5976 5977 5978 5979
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
5980 5981
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
5982 5983 5984 5985
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
5986 5987
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
5988 5989
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
5990
static bool
5991 5992 5993 5994 5995 5996 5997 5998 5999
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;

6000
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6001
        return false;
6002 6003 6004 6005

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
6006
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
6007
            return false;
6008 6009 6010 6011 6012 6013
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
6014
                vshError(ctl, "%s", _("Failed to list active interfaces"));
6015
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6016
                return false;
6017 6018 6019 6020 6021 6022 6023 6024
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
6025
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6026
            VIR_FREE(activeNames);
E
Eric Blake 已提交
6027
            return false;
6028 6029 6030 6031
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

6032 6033 6034
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
6035
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6036 6037
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6038
                return false;
6039 6040 6041 6042 6043
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
6044 6045
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
6046 6047 6048
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
6049 6050
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
6051 6052 6053

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6054
            VIR_FREE(activeNames[i]);
6055 6056 6057 6058 6059 6060 6061 6062
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6063
        VIR_FREE(activeNames[i]);
6064 6065
    }
    for (i = 0; i < maxinactive; i++) {
6066 6067
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
6068 6069 6070

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6071
            VIR_FREE(inactiveNames[i]);
6072 6073 6074 6075 6076 6077 6078 6079
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6080
        VIR_FREE(inactiveNames[i]);
6081
    }
6082 6083
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6084
    return true;
6085 6086 6087 6088 6089 6090 6091

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
6092
    {"help", N_("convert an interface MAC address to interface name")},
6093 6094 6095 6096 6097
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
6098
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
6099 6100 6101
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6102
static bool
6103 6104 6105 6106
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6107
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6108
        return false;
6109 6110
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
6111
        return false;
6112 6113 6114

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6115
    return true;
6116 6117 6118 6119 6120 6121
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
6122
    {"help", N_("convert an interface name to interface MAC address")},
6123 6124 6125 6126 6127
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
6128
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
6129 6130 6131
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6132
static bool
6133 6134 6135 6136
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6137
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6138
        return false;
6139 6140
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6141
        return false;
6142 6143 6144

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6145
    return true;
6146 6147 6148 6149 6150 6151
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
6152 6153
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
6154 6155 6156 6157
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
6158 6159
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
6160 6161 6162
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6163
static bool
6164 6165 6166
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6167
    bool ret = true;
6168
    char *dump;
6169 6170 6171 6172 6173
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
6174

6175
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6176
        return false;
6177 6178

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

6181
    dump = virInterfaceGetXMLDesc(iface, flags);
6182
    if (dump != NULL) {
6183
        vshPrint(ctl, "%s", dump);
6184
        VIR_FREE(dump);
6185
    } else {
E
Eric Blake 已提交
6186
        ret = false;
6187 6188 6189 6190 6191 6192 6193 6194 6195 6196
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
6197 6198
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
6199 6200 6201 6202
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
6203
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
6204 6205 6206
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6207
static bool
6208 6209
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
6210
    virInterfacePtr iface;
6211
    const char *from = NULL;
E
Eric Blake 已提交
6212
    bool ret = true;
6213 6214
    char *buffer;

6215
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6216
        return false;
6217

6218
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6219
        return false;
6220 6221

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

6224
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
6225
    VIR_FREE(buffer);
6226

6227
    if (iface != NULL) {
6228
        vshPrint(ctl, _("Interface %s defined from %s\n"),
6229
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
6230
        virInterfaceFree (iface);
6231
    } else {
6232
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
6233
        ret = false;
6234 6235 6236 6237 6238 6239 6240 6241
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
6242 6243
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
6244 6245 6246 6247
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
6248
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6249 6250 6251
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6252
static bool
6253 6254 6255
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6256
    bool ret = true;
6257
    const char *name;
6258

6259
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6260
        return false;
6261 6262

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6263
        return false;
6264 6265 6266 6267

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
6268
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
6269
        ret = false;
6270 6271 6272 6273 6274 6275 6276 6277 6278 6279
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
6280 6281
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
6282 6283 6284 6285
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
6286
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6287 6288 6289
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6290
static bool
6291 6292 6293
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6294
    bool ret = true;
6295
    const char *name;
6296

6297
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6298
        return false;
6299 6300

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6301
        return false;
6302 6303 6304 6305

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
6306
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
6307
        ret = false;
6308 6309 6310 6311 6312 6313 6314 6315 6316 6317
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
6318
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
6319
    {"desc", N_("forcefully stop a physical host interface.")},
6320 6321 6322 6323
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
6324
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6325 6326 6327
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6328
static bool
6329 6330 6331
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6332
    bool ret = true;
6333
    const char *name;
6334

6335
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6336
        return false;
6337 6338

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6339
        return false;
6340 6341 6342 6343

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
6344
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
6345
        ret = false;
6346 6347 6348 6349 6350 6351
    }

    virInterfaceFree(iface);
    return ret;
}

6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436
/*
 * "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;
}
6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451

/*
 * "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 已提交
6452
static bool
6453 6454 6455
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
6456
    const char *from = NULL;
E
Eric Blake 已提交
6457
    bool ret = true;
6458 6459
    char *buffer;

6460
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6461
        return false;
6462

6463
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6464
        return false;
6465 6466

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6467
        return false;
6468 6469 6470 6471 6472 6473 6474 6475 6476 6477

    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 已提交
6478
        ret = false;
6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497
    }
    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 已提交
6498
static bool
6499 6500 6501
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6502
    bool ret = true;
6503
    const char *name;
6504

6505
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6506
        return false;
6507 6508

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
6509
        return false;
6510 6511 6512 6513 6514

    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 已提交
6515
        ret = false;
6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536
    }

    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 已提交
6537
static bool
6538 6539 6540
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6541
    bool ret = true;
6542 6543
    char *dump;

6544
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6545
        return false;
6546 6547

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
6548
        return false;
6549 6550 6551

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
6552
        vshPrint(ctl, "%s", dump);
6553 6554
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
6555
        ret = false;
6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574
    }

    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 已提交
6575
static bool
6576 6577 6578 6579 6580 6581
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

6582
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6583
        return false;
6584 6585 6586 6587

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
6588
        return false;
6589 6590 6591 6592 6593 6594 6595 6596
    }

    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 已提交
6597
        return false;
6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624
    }

    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 已提交
6625
    return true;
6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642
}


/*
 * "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 已提交
6643
static bool
6644 6645
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6646
    bool ret = false;
6647 6648 6649 6650 6651 6652
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

6653
    if (!vshConnectionUsability(ctl, ctl->conn))
6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679
        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 已提交
6680
        ret = true;
6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706
        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 已提交
6707
    ret = true;
6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725

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


6726
/**************************************************************************/
6727
/*
6728
 * "pool-autostart" command
6729
 */
6730
static const vshCmdInfo info_pool_autostart[] = {
6731
    {"help", N_("autostart a pool")},
6732
    {"desc",
6733
     N_("Configure a pool to be automatically started at boot.")},
6734
    {NULL, NULL}
6735 6736
};

6737
static const vshCmdOptDef opts_pool_autostart[] = {
6738 6739
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6740 6741
    {NULL, 0, 0, NULL}
};
6742

E
Eric Blake 已提交
6743
static bool
6744
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
6745
{
6746
    virStoragePoolPtr pool;
6747
    const char *name;
6748
    int autostart;
6749

6750
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6751
        return false;
6752

6753
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6754
        return false;
6755

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

6758 6759
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
6760
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
6761
        else
6762
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
6763
        virStoragePoolFree(pool);
E
Eric Blake 已提交
6764
        return false;
6765 6766
    }

6767
    if (autostart)
6768
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
6769
    else
6770
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
6771

L
Laine Stump 已提交
6772
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6773
    return true;
6774 6775
}

6776
/*
6777
 * "pool-create" command
6778
 */
6779
static const vshCmdInfo info_pool_create[] = {
6780 6781
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
6782 6783 6784
    {NULL, NULL}
};

6785
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
6786
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
6787
     N_("file containing an XML pool description")},
6788 6789 6790
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6791
static bool
6792
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
6793
{
6794
    virStoragePoolPtr pool;
6795
    const char *from = NULL;
E
Eric Blake 已提交
6796
    bool ret = true;
6797
    char *buffer;
6798

6799
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6800
        return false;
6801

6802
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6803
        return false;
6804

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

6808
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
6809
    VIR_FREE(buffer);
6810 6811 6812 6813

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6814
        virStoragePoolFree(pool);
6815
    } else {
6816
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
6817
        ret = false;
6818 6819
    }
    return ret;
6820 6821
}

6822

6823 6824 6825 6826
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
6827
    {"help", N_("create a device defined "
6828
                          "by an XML file on the node")},
6829
    {"desc", N_("Create a device on the node.  Note that this "
6830 6831 6832 6833 6834 6835 6836
                          "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,
6837
     N_("file containing an XML description of the device")},
6838 6839 6840
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6841
static bool
6842 6843 6844
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
6845
    const char *from = NULL;
E
Eric Blake 已提交
6846
    bool ret = true;
6847 6848
    char *buffer;

6849
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6850
        return false;
6851

6852
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6853
        return false;
6854

6855
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6856
        return false;
6857 6858

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
6859
    VIR_FREE(buffer);
6860 6861 6862 6863

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
6864
        virNodeDeviceFree(dev);
6865
    } else {
6866
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
6867
        ret = false;
6868 6869 6870 6871 6872 6873 6874 6875 6876 6877
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
6878
    {"help", N_("destroy (stop) a device on the node")},
6879
    {"desc", N_("Destroy a device on the node.  Note that this "
6880
                "command destroys devices on the physical host")},
6881 6882 6883 6884 6885
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
6886
     N_("name of the device to be destroyed")},
6887 6888 6889
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6890
static bool
6891 6892 6893
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
6894
    bool ret = true;
6895
    const char *name = NULL;
6896

6897
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
6898
        return false;
6899 6900
    }

6901
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
6902
        return false;
6903 6904 6905 6906 6907 6908

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
6909
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
6910
        ret = false;
6911 6912 6913 6914 6915 6916 6917
    }

    virNodeDeviceFree(dev);
    return ret;
}


6918
/*
6919
 * XML Building helper for pool-define-as and pool-create-as
6920
 */
6921
static const vshCmdOptDef opts_pool_X_as[] = {
6922 6923 6924 6925 6926 6927 6928 6929
    {"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")},
6930
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
6931 6932 6933
    {NULL, 0, 0, NULL}
};

6934
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
6935

6936 6937
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
6938
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6939

6940
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6941
        goto cleanup;
6942
    if (vshCommandOptString(cmd, "type", &type) <= 0)
6943 6944
        goto cleanup;

6945 6946 6947 6948 6949
    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 ||
6950 6951
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
6952
        goto cleanup;
6953
    }
6954

6955 6956
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
6957
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
6958
        virBufferAddLit(&buf, "  <source>\n");
6959

6960
        if (srcHost)
6961
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
6962
        if (srcPath)
6963
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
6964
        if (srcDev)
6965
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
6966
        if (srcFormat)
6967
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
6968
        if (srcName)
6969
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
6970 6971

        virBufferAddLit(&buf, "  </source>\n");
6972 6973
    }
    if (target) {
6974
        virBufferAddLit(&buf, "  <target>\n");
6975
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
6976
        virBufferAddLit(&buf, "  </target>\n");
6977
    }
6978 6979 6980 6981
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
6982
        return false;
6983
    }
6984 6985 6986

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
6987
    return true;
6988 6989

cleanup:
6990
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6991
    return false;
6992 6993 6994 6995 6996 6997
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
6998 6999
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
7000 7001 7002
    {NULL, NULL}
};

E
Eric Blake 已提交
7003
static bool
7004 7005 7006
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
7007 7008
    const char *name;
    char *xml;
7009
    int printXML = vshCommandOptBool(cmd, "print-xml");
7010

7011
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7012
        return false;
7013 7014

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

7017
    if (printXML) {
7018
        vshPrint(ctl, "%s", xml);
7019
        VIR_FREE(xml);
7020
    } else {
7021
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
7022
        VIR_FREE(xml);
7023

7024 7025 7026 7027
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
7028
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
7029
            return false;
7030 7031
        }
    }
E
Eric Blake 已提交
7032
    return true;
7033 7034
}

7035

7036
/*
7037
 * "pool-define" command
7038
 */
7039
static const vshCmdInfo info_pool_define[] = {
7040 7041
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
7042 7043 7044
    {NULL, NULL}
};

7045
static const vshCmdOptDef opts_pool_define[] = {
7046
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
7047 7048 7049
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7050
static bool
7051
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
7052
{
7053
    virStoragePoolPtr pool;
7054
    const char *from = NULL;
E
Eric Blake 已提交
7055
    bool ret = true;
7056
    char *buffer;
7057

7058
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7059
        return false;
7060

7061
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7062
        return false;
7063

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

7067
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
7068
    VIR_FREE(buffer);
7069 7070 7071 7072

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7073
        virStoragePoolFree(pool);
7074
    } else {
7075
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
7076
        ret = false;
7077 7078
    }
    return ret;
7079 7080
}

7081

7082 7083 7084
/*
 * "pool-define-as" command
 */
7085
static const vshCmdInfo info_pool_define_as[] = {
7086 7087
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
7088 7089 7090
    {NULL, NULL}
};

E
Eric Blake 已提交
7091
static bool
7092
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
7093 7094
{
    virStoragePoolPtr pool;
7095 7096
    const char *name;
    char *xml;
7097
    int printXML = vshCommandOptBool(cmd, "print-xml");
7098

7099
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7100
        return false;
7101

7102
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
7103
        return false;
7104

7105
    if (printXML) {
7106
        vshPrint(ctl, "%s", xml);
7107
        VIR_FREE(xml);
7108
    } else {
7109
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
7110
        VIR_FREE(xml);
7111

7112 7113 7114 7115
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
7116
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
7117
            return false;
7118 7119
        }
    }
E
Eric Blake 已提交
7120
    return true;
7121 7122 7123
}


7124
/*
7125
 * "pool-build" command
7126
 */
7127
static const vshCmdInfo info_pool_build[] = {
7128 7129
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
7130 7131 7132
    {NULL, NULL}
};

7133
static const vshCmdOptDef opts_pool_build[] = {
7134
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7135 7136 7137
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7138
static bool
7139
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
7140
{
7141
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7142
    bool ret = true;
7143
    const char *name;
7144

7145
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7146
        return false;
7147

7148
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7149
        return false;
7150

7151
    if (virStoragePoolBuild(pool, 0) == 0) {
7152
        vshPrint(ctl, _("Pool %s built\n"), name);
7153
    } else {
7154
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
7155
        ret = false;
7156 7157
    }

7158 7159
    virStoragePoolFree(pool);

7160 7161 7162
    return ret;
}

7163

7164
/*
7165
 * "pool-destroy" command
7166
 */
7167
static const vshCmdInfo info_pool_destroy[] = {
7168 7169 7170
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
7171 7172 7173
    {NULL, NULL}
};

7174
static const vshCmdOptDef opts_pool_destroy[] = {
7175
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7176 7177 7178
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7179
static bool
7180
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
7181
{
7182
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7183
    bool ret = true;
7184
    const char *name;
7185

7186
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7187
        return false;
7188

7189
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7190
        return false;
7191

7192 7193 7194
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
7195
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
7196
        ret = false;
7197 7198
    }

7199
    virStoragePoolFree(pool);
7200 7201 7202
    return ret;
}

7203

7204
/*
7205 7206
 * "pool-delete" command
 */
7207
static const vshCmdInfo info_pool_delete[] = {
7208 7209
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
7210 7211 7212
    {NULL, NULL}
};

7213
static const vshCmdOptDef opts_pool_delete[] = {
7214
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7215 7216 7217
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7218
static bool
7219
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
7220 7221
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7222
    bool ret = true;
7223
    const char *name;
7224

7225
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7226
        return false;
7227 7228

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7229
        return false;
7230 7231

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
7232
        vshPrint(ctl, _("Pool %s deleted\n"), name);
7233
    } else {
7234
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
7235
        ret = false;
7236 7237
    }

L
Laine Stump 已提交
7238
    virStoragePoolFree(pool);
7239 7240 7241 7242 7243 7244 7245
    return ret;
}


/*
 * "pool-refresh" command
 */
7246
static const vshCmdInfo info_pool_refresh[] = {
7247 7248
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
7249 7250 7251
    {NULL, NULL}
};

7252
static const vshCmdOptDef opts_pool_refresh[] = {
7253
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7254 7255 7256
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7257
static bool
7258
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
7259 7260
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7261
    bool ret = true;
7262
    const char *name;
7263

7264
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7265
        return false;
7266 7267

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7268
        return false;
7269 7270 7271 7272

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
7273
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
7274
        ret = false;
7275 7276 7277 7278 7279 7280 7281 7282 7283 7284
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
7285
static const vshCmdInfo info_pool_dumpxml[] = {
7286 7287
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
7288 7289 7290
    {NULL, NULL}
};

7291
static const vshCmdOptDef opts_pool_dumpxml[] = {
7292
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7293 7294 7295
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7296
static bool
7297
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
7298 7299
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7300
    bool ret = true;
7301 7302
    char *dump;

7303
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7304
        return false;
7305 7306

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7307
        return false;
7308 7309 7310

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
7311
        vshPrint(ctl, "%s", dump);
7312
        VIR_FREE(dump);
7313
    } else {
E
Eric Blake 已提交
7314
        ret = false;
7315 7316 7317 7318 7319 7320 7321 7322 7323 7324
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
7325
static const vshCmdInfo info_pool_list[] = {
7326 7327
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
7328 7329 7330
    {NULL, NULL}
};

7331
static const vshCmdOptDef opts_pool_list[] = {
7332 7333
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
7334
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
7335 7336 7337
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7338
static bool
7339
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7340
{
7341 7342
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
7343 7344
    int i, ret;
    bool functionReturn;
7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360
    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 */
7361
    int all = vshCommandOptBool(cmd, "all");
7362 7363
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
7364 7365 7366
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

7367
    /* Check the connection to libvirtd daemon is still working */
7368
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7369
        return false;
7370

7371
    /* Retrieve the number of active storage pools */
7372
    if (active) {
7373 7374
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
7375
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
7376
            return false;
7377 7378
        }
    }
7379 7380

    /* Retrieve the number of inactive storage pools */
7381
    if (inactive) {
7382 7383
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
7384
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
7385
            return false;
7386
        }
7387
    }
7388

7389 7390
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
7391

7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403
    /* 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 已提交
7404
            return false;
7405 7406 7407
        }
    }

7408 7409 7410 7411 7412 7413 7414 7415
    /* 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 已提交
7416
            return false;
7417 7418
        }
    }
7419

7420 7421 7422 7423 7424 7425 7426 7427 7428 7429
    /* 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]);
7430
        if (!pool) {
7431
            VIR_FREE(poolNames[i]);
7432 7433 7434
            continue;
        }

7435
        /* Retrieve the autostart status of the pool */
7436
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
7437
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
7438
        else
7439 7440 7441 7442 7443 7444
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
7445 7446
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457
            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;
        }
7458

7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 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
        /* 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 */
7571 7572 7573
        virStoragePoolFree(pool);
    }

7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591
    /* 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);
7592 7593
        }

7594
        /* Cleanup and return */
E
Eric Blake 已提交
7595
        functionReturn = true;
7596 7597
        goto cleanup;
    }
7598

7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636
    /* 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. */
7637
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
7638
             (unsigned long) nameStrLength);
7639
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
7640
             (unsigned long) stateStrLength);
7641
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
7642
             (unsigned long) autostartStrLength);
7643
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
7644
             (unsigned long) persistStrLength);
7645
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
7646
             (unsigned long) capStrLength);
7647
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
7648
             (unsigned long) allocStrLength);
7649
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692
             (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 已提交
7693
    functionReturn = true;
7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707
    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 已提交
7708
    functionReturn = false;
7709

7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721
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]);
7722
    }
7723 7724 7725 7726 7727 7728 7729

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

    /* Return the desired value */
    return functionReturn;
7730 7731
}

7732 7733 7734 7735
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
7736 7737
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7738 7739 7740 7741 7742
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7743 7744 7745
     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")},
7746
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
7747 7748 7749
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7750
static bool
7751 7752
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7753
    const char *type = NULL, *host = NULL;
7754 7755
    char *srcSpec = NULL;
    char *srcList;
7756
    const char *initiator = NULL;
7757

7758 7759
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
7760 7761
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
7762
        return false;
7763
    }
7764

7765
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7766
        return false;
7767 7768

    if (host) {
7769
        const char *port = NULL;
7770
        virBuffer buf = VIR_BUFFER_INITIALIZER;
7771 7772 7773 7774

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7775
            return false;
7776
        }
7777
        virBufferAddLit(&buf, "<source>\n");
7778
        virBufferAsprintf(&buf, "  <host name='%s'", host);
7779
        if (port)
7780
            virBufferAsprintf(&buf, " port='%s'", port);
7781
        virBufferAddLit(&buf, "/>\n");
7782 7783
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
7784
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
7785 7786
            virBufferAddLit(&buf, "  </initiator>\n");
        }
7787 7788 7789
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
7790
            return false;
7791
        }
7792
        srcSpec = virBufferContentAndReset(&buf);
7793 7794 7795
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7796
    VIR_FREE(srcSpec);
7797
    if (srcList == NULL) {
7798
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7799
        return false;
7800 7801
    }
    vshPrint(ctl, "%s", srcList);
7802
    VIR_FREE(srcList);
7803

E
Eric Blake 已提交
7804
    return true;
7805 7806 7807 7808 7809 7810 7811
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
7812 7813
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7814 7815 7816 7817 7818
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7819
     N_("type of storage pool sources to discover")},
7820
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
7821
     N_("optional file of source xml to query for pools")},
7822 7823 7824
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7825
static bool
7826 7827
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7828
    const char *type = NULL, *srcSpecFile = NULL;
7829
    char *srcSpec = NULL, *srcList;
7830

7831
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
7832
        return false;
7833

7834 7835
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
7836
        return false;
7837
    }
7838

7839
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7840
        return false;
7841 7842

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
7843
        return false;
7844 7845

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7846
    VIR_FREE(srcSpec);
7847
    if (srcList == NULL) {
7848
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7849
        return false;
7850 7851
    }
    vshPrint(ctl, "%s", srcList);
7852
    VIR_FREE(srcList);
7853

E
Eric Blake 已提交
7854
    return true;
7855 7856 7857
}


7858 7859 7860
/*
 * "pool-info" command
 */
7861
static const vshCmdInfo info_pool_info[] = {
7862 7863
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
7864 7865 7866
    {NULL, NULL}
};

7867
static const vshCmdOptDef opts_pool_info[] = {
7868
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7869 7870 7871
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7872
static bool
7873
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
7874 7875 7876
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
7877 7878
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
7879
    bool ret = true;
7880 7881
    char uuid[VIR_UUID_STRING_BUFLEN];

7882
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7883
        return false;
7884 7885

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7886
        return false;
7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912

    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;
7913 7914 7915 7916
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
7917 7918
        }

7919 7920
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
7921 7922
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
7923 7924 7925 7926 7927 7928 7929
        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);
7930 7931
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
7932 7933 7934 7935 7936
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948
        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 已提交
7949
        ret = false;
7950 7951 7952 7953 7954 7955 7956 7957 7958 7959
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
7960
static const vshCmdInfo info_pool_name[] = {
7961
    {"help", N_("convert a pool UUID to pool name")},
7962
    {"desc", ""},
7963 7964 7965
    {NULL, NULL}
};

7966
static const vshCmdOptDef opts_pool_name[] = {
7967
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
7968 7969 7970
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7971
static bool
7972
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
7973 7974 7975
{
    virStoragePoolPtr pool;

7976
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7977
        return false;
7978
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7979
                                           VSH_BYUUID)))
E
Eric Blake 已提交
7980
        return false;
7981 7982 7983

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7984
    return true;
7985 7986 7987 7988 7989 7990
}


/*
 * "pool-start" command
 */
7991
static const vshCmdInfo info_pool_start[] = {
7992 7993
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
7994 7995 7996
    {NULL, NULL}
};

7997
static const vshCmdOptDef opts_pool_start[] = {
7998
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
7999 8000 8001
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8002
static bool
8003
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
8004 8005
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8006
    bool ret = true;
8007

8008
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8009
        return false;
8010

8011
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
8012
         return false;
8013 8014 8015 8016 8017

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
8018
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
8019
        ret = false;
8020
    }
L
Laine Stump 已提交
8021 8022

    virStoragePoolFree(pool);
8023 8024 8025 8026
    return ret;
}


8027 8028 8029
/*
 * "vol-create-as" command
 */
8030
static const vshCmdInfo info_vol_create_as[] = {
8031 8032
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
8033 8034 8035
    {NULL, NULL}
};

8036
static const vshCmdOptDef opts_vol_create_as[] = {
8037 8038 8039 8040 8041
    {"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")},
8042 8043
    {"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")},
8044 8045 8046 8047 8048 8049 8050 8051 8052 8053
    {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 已提交
8054
        /* Deliberate fallthrough cases here :-) */
8055 8056 8057
        switch (*end) {
        case 'T':
            *val *= 1024;
8058
            /* fallthrough */
8059 8060
        case 'G':
            *val *= 1024;
8061
            /* fallthrough */
8062 8063
        case 'M':
            *val *= 1024;
8064
            /* fallthrough */
8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
8078
static bool
8079
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
8080 8081 8082
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8083
    char *xml;
8084 8085
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
8086
    unsigned long long capacity, allocation = 0;
8087
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8088

8089
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8090
        return false;
8091 8092 8093

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

8096
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8097 8098
        goto cleanup;

8099
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
8100 8101
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
8102
        vshError(ctl, _("Malformed size %s"), capacityStr);
8103

8104 8105
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
8106
        vshError(ctl, _("Malformed size %s"), allocationStr);
8107

8108 8109 8110 8111 8112 8113 8114
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

8115

8116
    virBufferAddLit(&buf, "<volume>\n");
8117 8118
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
8119
    if (allocationStr)
8120
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
8121 8122

    if (format) {
8123
        virBufferAddLit(&buf, "  <target>\n");
8124
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
8125
        virBufferAddLit(&buf, "  </target>\n");
8126
    }
8127

8128 8129 8130 8131
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
8132 8133
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
8134 8135 8136
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
8137 8138
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
8139 8140 8141 8142 8143
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
8144 8145
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
8146 8147 8148
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
8149 8150
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
8151 8152 8153 8154 8155
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
8156 8157
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
8158 8159 8160
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
8161 8162
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
8163 8164 8165 8166
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
E
Eric Blake 已提交
8167
            return false;
8168 8169 8170 8171 8172
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
8173
            return false;
8174 8175 8176 8177
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
8178
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
8179
        if (snapshotStrFormat)
8180
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
8181 8182 8183 8184 8185 8186 8187 8188
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

8190 8191
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
8192
        return false;
8193 8194 8195
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
8196
    VIR_FREE(xml);
8197 8198 8199 8200 8201
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
8202
        return true;
8203
    } else {
8204
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
8205
        return false;
8206 8207 8208
    }

 cleanup:
8209
    virBufferFreeAndReset(&buf);
8210
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8211
    return false;
8212 8213 8214
}


8215 8216 8217
/*
 * "pool-undefine" command
 */
8218
static const vshCmdInfo info_pool_undefine[] = {
8219 8220
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
8221 8222 8223
    {NULL, NULL}
};

8224
static const vshCmdOptDef opts_pool_undefine[] = {
8225
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8226 8227 8228
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8229
static bool
8230
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
8231 8232
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8233
    bool ret = true;
8234
    const char *name;
8235

8236
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8237
        return false;
8238 8239

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8240
        return false;
8241 8242 8243 8244

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

L
Laine Stump 已提交
8249
    virStoragePoolFree(pool);
8250 8251 8252 8253 8254 8255 8256
    return ret;
}


/*
 * "pool-uuid" command
 */
8257
static const vshCmdInfo info_pool_uuid[] = {
8258
    {"help", N_("convert a pool name to pool UUID")},
8259
    {"desc", ""},
8260 8261 8262
    {NULL, NULL}
};

8263
static const vshCmdOptDef opts_pool_uuid[] = {
8264
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
8265 8266 8267
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8268
static bool
8269
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
8270 8271 8272 8273
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

8274
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8275
        return false;
8276 8277

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8278
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8279
        return false;
8280 8281 8282 8283

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

L
Laine Stump 已提交
8286
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8287
    return true;
8288 8289 8290 8291 8292 8293
}


/*
 * "vol-create" command
 */
8294
static const vshCmdInfo info_vol_create[] = {
8295 8296
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
8297 8298 8299
    {NULL, NULL}
};

8300
static const vshCmdOptDef opts_vol_create[] = {
8301 8302
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
8303 8304 8305
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8306
static bool
8307
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
8308 8309 8310
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8311
    const char *from = NULL;
E
Eric Blake 已提交
8312
    bool ret = true;
8313 8314
    char *buffer;

8315
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8316
        return false;
8317 8318

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

8322
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8323
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8324
        return false;
8325 8326 8327
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8328
        virshReportError(ctl);
8329
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8330
        return false;
8331 8332 8333
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
8334
    VIR_FREE(buffer);
8335 8336 8337 8338 8339 8340 8341
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
8342
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
8343
        ret = false;
8344 8345 8346 8347
    }
    return ret;
}

8348 8349 8350 8351
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
8352 8353
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
8354 8355 8356 8357
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
8358 8359 8360
    {"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 已提交
8361
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
8362 8363 8364
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8365
static bool
8366 8367 8368 8369
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
8370
    const char *from = NULL;
E
Eric Blake 已提交
8371
    bool ret = false;
8372 8373
    char *buffer = NULL;

8374
    if (!vshConnectionUsability(ctl, ctl->conn))
8375 8376 8377 8378 8379
        goto cleanup;

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

8380
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8381 8382 8383 8384 8385 8386 8387
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8388
        virshReportError(ctl);
8389 8390 8391 8392 8393 8394 8395 8396 8397
        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 {
8398
        vshError(ctl, _("Failed to create vol from %s"), from);
8399 8400 8401
        goto cleanup;
    }

E
Eric Blake 已提交
8402
    ret = true;
8403
cleanup:
8404
    VIR_FREE(buffer);
8405 8406 8407 8408
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
8409 8410
    if (newvol)
        virStorageVolFree(newvol);
8411 8412 8413 8414
    return ret;
}

static xmlChar *
8415
makeCloneXML(const char *origxml, const char *newname) {
8416

8417 8418 8419
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
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
    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[] = {
8450 8451
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
8452 8453 8454 8455
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
8456 8457
    {"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 已提交
8458
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8459 8460 8461
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8462
static bool
8463 8464 8465 8466
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
8467
    const char *name = NULL;
8468
    char *origxml = NULL;
8469
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
8470
    bool ret = false;
8471

8472
    if (!vshConnectionUsability(ctl, ctl->conn))
8473 8474 8475 8476 8477 8478 8479
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
8480
        vshError(ctl, "%s", _("failed to get parent pool"));
8481 8482 8483
        goto cleanup;
    }

8484
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502
        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 {
8503
        vshError(ctl, _("Failed to clone vol from %s"),
8504 8505 8506 8507
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
8508
    ret = true;
8509 8510

cleanup:
8511
    VIR_FREE(origxml);
8512 8513 8514
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
8515 8516
    if (newvol)
        virStorageVolFree(newvol);
8517 8518 8519 8520 8521
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534

/*
 * "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 已提交
8535
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549
    {"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 已提交
8550
static bool
8551 8552 8553 8554
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8555
    bool ret = false;
8556 8557 8558 8559 8560 8561 8562 8563 8564 8565
    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 已提交
8566
        return false;
8567 8568 8569 8570
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8571
        return false;
8572 8573 8574
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8575
        return false;
8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609
    }

    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 已提交
8610
    ret = true;
8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634

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 已提交
8635
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8636 8637 8638 8639 8640
    {"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 已提交
8641
static bool
8642 8643 8644 8645
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8646
    bool ret = false;
8647 8648 8649 8650
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
8651
    bool created = false;
8652 8653

    if (!vshConnectionUsability(ctl, ctl->conn))
8654
        return false;
8655 8656 8657

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8658
        return false;
8659 8660 8661 8662
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8663
        return false;
8664 8665 8666
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
8667
        return false;
8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679

    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;
        }
8680 8681
    } else {
        created = true;
8682 8683 8684 8685 8686 8687 8688 8689
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

8690
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705
        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 已提交
8706
    ret = true;
8707 8708

cleanup:
8709
    VIR_FORCE_CLOSE(fd);
8710
    if (!ret && created)
8711 8712 8713 8714 8715 8716 8717 8718 8719
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


8720 8721 8722
/*
 * "vol-delete" command
 */
8723
static const vshCmdInfo info_vol_delete[] = {
8724 8725
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
8726 8727 8728
    {NULL, NULL}
};

8729
static const vshCmdOptDef opts_vol_delete[] = {
8730
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8731
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8732 8733 8734
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8735
static bool
8736
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
8737 8738
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8739
    bool ret = true;
8740
    const char *name;
8741

8742
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8743
        return false;
8744 8745

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8746
        return false;
8747 8748 8749
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
8750
        vshPrint(ctl, _("Vol %s deleted\n"), name);
8751
    } else {
8752
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
8753
        ret = false;
8754 8755
    }

L
Laine Stump 已提交
8756
    virStorageVolFree(vol);
8757 8758 8759 8760
    return ret;
}


D
David Allan 已提交
8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771
/*
 * "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 已提交
8772
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
8773 8774 8775
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8776
static bool
D
David Allan 已提交
8777 8778 8779
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8780
    bool ret = true;
8781
    const char *name;
D
David Allan 已提交
8782

8783
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8784
        return false;
D
David Allan 已提交
8785 8786

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8787
        return false;
D
David Allan 已提交
8788 8789 8790 8791 8792 8793
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
8794
        ret = false;
D
David Allan 已提交
8795 8796 8797 8798 8799 8800 8801
    }

    virStorageVolFree(vol);
    return ret;
}


8802 8803 8804
/*
 * "vol-info" command
 */
8805
static const vshCmdInfo info_vol_info[] = {
8806 8807
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
8808 8809 8810
    {NULL, NULL}
};

8811
static const vshCmdOptDef opts_vol_info[] = {
8812
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8813
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8814 8815 8816
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8817
static bool
8818
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
8819 8820 8821
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
8822
    bool ret = true;
8823

8824
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8825
        return false;
8826 8827

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8828
        return false;
8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844

    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 已提交
8845
        ret = false;
8846 8847 8848 8849 8850 8851 8852 8853 8854 8855
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
8856
static const vshCmdInfo info_vol_dumpxml[] = {
8857 8858
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
8859 8860 8861
    {NULL, NULL}
};

8862
static const vshCmdOptDef opts_vol_dumpxml[] = {
8863
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8864
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8865 8866 8867
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8868
static bool
8869
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
8870 8871
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8872
    bool ret = true;
8873 8874
    char *dump;

8875
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8876
        return false;
8877 8878

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8879
        return false;
8880 8881 8882

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
8883
        vshPrint(ctl, "%s", dump);
8884
        VIR_FREE(dump);
8885
    } else {
E
Eric Blake 已提交
8886
        ret = false;
8887 8888 8889 8890 8891 8892 8893 8894 8895 8896
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
8897
static const vshCmdInfo info_vol_list[] = {
8898 8899
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
8900 8901 8902
    {NULL, NULL}
};

8903
static const vshCmdOptDef opts_vol_list[] = {
8904
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8905
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
8906 8907 8908
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8909
static bool
8910
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8911
{
8912
    virStorageVolInfo volumeInfo;
8913 8914
    virStoragePoolPtr pool;
    char **activeNames = NULL;
8915 8916 8917 8918 8919
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
8920 8921
    int ret;
    bool functionReturn;
8922 8923 8924 8925 8926 8927 8928 8929 8930 8931 8932
    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;
8933

8934
    /* Check the connection to libvirtd daemon is still working */
8935
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8936
        return false;
8937

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

8942 8943
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
8944

8945 8946 8947
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8948
        return false;
8949 8950
    }

8951 8952 8953 8954 8955
    /* 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) {
8956
            vshError(ctl, "%s", _("Failed to list active vols"));
8957
            VIR_FREE(activeNames);
8958
            virStoragePoolFree(pool);
E
Eric Blake 已提交
8959
            return false;
8960 8961
        }

8962 8963 8964 8965 8966
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

8969 8970 8971 8972 8973
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
8974

8975 8976 8977 8978
        /* 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"));
8979 8980
        }

8981 8982 8983 8984 8985 8986 8987 8988 8989
        /* 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 */
8990

8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045
                /* 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;
        }
9046

9047
        /* Cleanup memory allocation */
9048
        virStorageVolFree(vol);
9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066
    }

    /* 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 已提交
9067
        functionReturn = true;
9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097 9098
        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 */
9099 9100 9101 9102 9103 9104 9105 9106 9107 9108
    vshDebug(ctl, VSH_ERR_DEBUG,
             "Longest name string = %zu chars\n", nameStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG,
             "Longest path string = %zu chars\n", pathStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG,
             "Longest type string = %zu chars\n", typeStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG,
             "Longest capacity string = %zu chars\n", capStrLength);
    vshDebug(ctl, VSH_ERR_DEBUG,
             "Longest allocation string = %zu chars\n", allocStrLength);
9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142

    /* 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 已提交
9143
    functionReturn = true;
9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157
    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 已提交
9158
    functionReturn = false;
9159 9160 9161 9162 9163 9164 9165 9166 9167 9168

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);
9169
        VIR_FREE(activeNames[i]);
9170
    }
9171 9172 9173 9174

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
9175
    VIR_FREE(activeNames);
9176
    virStoragePoolFree(pool);
9177 9178 9179

    /* Return the desired value */
    return functionReturn;
9180 9181 9182 9183 9184 9185
}


/*
 * "vol-name" command
 */
9186
static const vshCmdInfo info_vol_name[] = {
9187
    {"help", N_("returns the volume name for a given volume key or path")},
9188
    {"desc", ""},
9189 9190 9191
    {NULL, NULL}
};

9192
static const vshCmdOptDef opts_vol_name[] = {
9193
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
9194 9195 9196
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9197
static bool
9198
cmdVolName(vshControl *ctl, const vshCmd *cmd)
9199 9200 9201
{
    virStorageVolPtr vol;

9202
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9203
        return false;
9204

9205
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
9206
                                   VSH_BYUUID)))
E
Eric Blake 已提交
9207
        return false;
9208 9209 9210

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9211
    return true;
9212 9213 9214
}


J
Justin Clift 已提交
9215 9216 9217 9218 9219 9220 9221 9222 9223 9224
/*
 * "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[] = {
9225
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
9226 9227 9228 9229
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9230
static bool
J
Justin Clift 已提交
9231 9232 9233 9234
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9235
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
9236 9237

    /* Check the connection to libvirtd daemon is still working */
9238
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9239
        return false;
J
Justin Clift 已提交
9240 9241

    /* Use the supplied string to locate the volume */
9242
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
9243
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
9244
        return false;
J
Justin Clift 已提交
9245 9246 9247 9248 9249 9250 9251
    }

    /* 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 已提交
9252
        return false;
J
Justin Clift 已提交
9253 9254
    }

9255 9256 9257 9258 9259 9260 9261 9262 9263
    /* 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 已提交
9264 9265 9266 9267

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9268
    return true;
J
Justin Clift 已提交
9269 9270
}

9271 9272 9273 9274

/*
 * "vol-key" command
 */
9275
static const vshCmdInfo info_vol_key[] = {
9276
    {"help", N_("returns the volume key for a given volume name or path")},
9277
    {"desc", ""},
9278 9279 9280
    {NULL, NULL}
};

9281
static const vshCmdOptDef opts_vol_key[] = {
9282
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
9283
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9284 9285 9286
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9287
static bool
9288
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
9289 9290 9291
{
    virStorageVolPtr vol;

9292
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9293
        return false;
9294

9295
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9296
        return false;
9297 9298 9299

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9300
    return true;
9301 9302 9303 9304 9305 9306 9307
}



/*
 * "vol-path" command
 */
9308
static const vshCmdInfo info_vol_path[] = {
9309
    {"help", N_("returns the volume path for a given volume name or key")},
9310
    {"desc", ""},
9311 9312 9313
    {NULL, NULL}
};

9314
static const vshCmdOptDef opts_vol_path[] = {
9315
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
9316
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9317 9318 9319
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9320
static bool
9321
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
9322 9323
{
    virStorageVolPtr vol;
9324
    const char *name = NULL;
9325
    char * StorageVolPath;
9326

9327
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9328
        return false;
9329 9330

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9331
        return false;
9332
    }
9333

9334 9335 9336 9337 9338 9339 9340
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
9341
    virStorageVolFree(vol);
E
Eric Blake 已提交
9342
    return true;
9343 9344 9345
}


9346 9347 9348 9349
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
9350 9351
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
9352 9353
    {NULL, NULL}
};
9354

9355
static const vshCmdOptDef opts_secret_define[] = {
9356
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
9357 9358
    {NULL, 0, 0, NULL}
};
9359

E
Eric Blake 已提交
9360
static bool
9361 9362
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
9363
    const char *from = NULL;
9364
    char *buffer;
9365
    virSecretPtr res;
9366
    char uuid[VIR_UUID_STRING_BUFLEN];
9367

9368
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9369
        return false;
9370

9371
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9372
        return false;
9373 9374

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
9378
    VIR_FREE(buffer);
9379 9380

    if (res == NULL) {
9381
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
9382
        return false;
9383
    }
9384
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
9385
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
9386
        virSecretFree(res);
E
Eric Blake 已提交
9387
        return false;
9388 9389 9390
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
9391
    return true;
9392 9393 9394 9395 9396 9397
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
9398 9399
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
9400 9401 9402 9403
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
9404
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9405 9406 9407
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9408
static bool
9409 9410 9411
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9412
    bool ret = false;
9413 9414
    char *xml;

9415
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9416
        return false;
9417 9418 9419

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9420
        return false;
9421 9422 9423 9424

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
9425
    vshPrint(ctl, "%s", xml);
9426
    VIR_FREE(xml);
E
Eric Blake 已提交
9427
    ret = true;
9428 9429 9430 9431 9432 9433 9434 9435 9436 9437

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
9438 9439
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
9440 9441 9442 9443
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
9444 9445
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
9446 9447 9448
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9449
static bool
9450 9451 9452 9453
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
9454
    const char *base64 = NULL;
9455
    char *value;
E
Eric Blake 已提交
9456 9457
    int res;
    bool ret = false;
9458

9459
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9460
        return false;
9461 9462 9463

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

9466
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
9467 9468 9469
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
9470
        vshError(ctl, "%s", _("Invalid base64 data"));
9471 9472 9473
        goto cleanup;
    }
    if (value == NULL) {
9474
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
9475
        return false;
9476 9477 9478 9479
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
9480
    VIR_FREE(value);
9481 9482

    if (res != 0) {
9483
        vshError(ctl, "%s", _("Failed to set secret value"));
9484 9485 9486
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
9487
    ret = true;
9488 9489 9490 9491 9492 9493 9494 9495 9496 9497

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
9498 9499
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
9500 9501 9502 9503
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
9504
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9505 9506 9507
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9508
static bool
9509 9510 9511 9512 9513 9514
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
9515
    bool ret = false;
9516

9517
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9518
        return false;
9519 9520 9521

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9522
        return false;
9523 9524 9525 9526 9527 9528 9529

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
9530
    VIR_FREE(value);
9531 9532

    if (base64 == NULL) {
9533
        vshError(ctl, "%s", _("Failed to allocate memory"));
9534 9535
        goto cleanup;
    }
9536
    vshPrint(ctl, "%s", base64);
9537
    memset(base64, 0, strlen(base64));
9538
    VIR_FREE(base64);
E
Eric Blake 已提交
9539
    ret = true;
9540 9541 9542 9543 9544 9545 9546 9547 9548 9549

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
9550 9551
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
9552 9553 9554 9555
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
9556
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9557 9558 9559
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9560
static bool
9561 9562 9563
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9564
    bool ret = false;
9565
    const char *uuid;
9566

9567
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9568
        return false;
9569 9570 9571

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
9572
        return false;
9573 9574

    if (virSecretUndefine(secret) < 0) {
9575
        vshError(ctl, _("Failed to delete secret %s"), uuid);
9576 9577 9578
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
9579
    ret = true;
9580 9581 9582 9583 9584 9585 9586 9587 9588 9589

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
9590 9591
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
9592 9593 9594
    {NULL, NULL}
};

E
Eric Blake 已提交
9595
static bool
9596 9597 9598 9599 9600
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

9601
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9602
        return false;
9603 9604 9605

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
9606
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
9607
        return false;
9608 9609 9610 9611 9612
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
9613
        vshError(ctl, "%s", _("Failed to list secrets"));
9614
        VIR_FREE(uuids);
E
Eric Blake 已提交
9615
        return false;
9616 9617 9618 9619
    }

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

9620 9621
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
9622 9623

    for (i = 0; i < maxuuids; i++) {
9624 9625 9626 9627
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
9628
            VIR_FREE(uuids[i]);
9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646
            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);
9647
        VIR_FREE(uuids[i]);
9648
    }
9649
    VIR_FREE(uuids);
E
Eric Blake 已提交
9650
    return true;
9651
}
9652 9653 9654 9655 9656


/*
 * "version" command
 */
9657
static const vshCmdInfo info_version[] = {
9658 9659
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
9660 9661 9662
    {NULL, NULL}
};

9663 9664 9665 9666
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
9667

E
Eric Blake 已提交
9668
static bool
9669
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9670 9671 9672 9673 9674 9675
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
9676
    unsigned long daemonVersion;
9677 9678 9679 9680 9681
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

9682
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9683
        return false;
9684 9685 9686

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
9687
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
9688
        return false;
9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700
    }

    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) {
9701
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
9702
        return false;
9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719
    }
    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) {
9720
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
9721
        return false;
9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734
    }
    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);
    }
9735 9736 9737 9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749

    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 已提交
9750
    return true;
9751 9752
}

9753 9754 9755 9756
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
9757
    {"help", N_("enumerate devices on this host")},
9758
    {"desc", ""},
9759 9760 9761 9762
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
9763 9764
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
9765 9766 9767
    {NULL, 0, 0, NULL}
};

9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789
#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] = '-';
9790 9791
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
9792 9793 9794
    }

    /* Print this device */
9795
    vshPrint(ctl, "%s", indentBuf);
9796 9797 9798 9799 9800 9801 9802 9803 9804 9805 9806 9807 9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818
    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) {
9819
        vshPrint(ctl, "%s", indentBuf);
9820
        vshPrint(ctl, " |\n");
9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842
    }

    /* 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) {
9843
        vshPrint(ctl, "%s", indentBuf);
9844 9845 9846 9847
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
9848
static bool
9849 9850
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
9851
    const char *cap = NULL;
9852
    char **devices;
9853
    int num_devices, i;
9854
    int tree = vshCommandOptBool(cmd, "tree");
9855

9856
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9857
        return false;
9858

9859
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
9860 9861 9862 9863
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
9864
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
9865
        return false;
9866
    } else if (num_devices == 0) {
E
Eric Blake 已提交
9867
        return true;
9868 9869 9870 9871 9872 9873
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
9874
        vshError(ctl, "%s", _("Failed to list node devices"));
9875
        VIR_FREE(devices);
E
Eric Blake 已提交
9876
        return false;
9877
    }
9878
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
9879 9880 9881 9882 9883 9884 9885
    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 已提交
9886
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 9904 9905
            } 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++) {
9906 9907
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
9908
        }
9909
        VIR_FREE(parents);
9910 9911 9912
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
9913
            VIR_FREE(devices[i]);
9914
        }
9915
    }
9916
    VIR_FREE(devices);
E
Eric Blake 已提交
9917
    return true;
9918 9919 9920 9921 9922 9923
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
9924 9925
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
9926 9927 9928 9929 9930
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
9931
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9932 9933 9934
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9935
static bool
9936 9937
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
9938
    const char *name = NULL;
9939
    virNodeDevicePtr device;
L
Laine Stump 已提交
9940
    char *xml;
9941

9942
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9943
        return false;
9944
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9945
        return false;
9946
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9947
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9948
        return false;
9949 9950
    }

L
Laine Stump 已提交
9951 9952 9953
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
9954
        return false;
L
Laine Stump 已提交
9955 9956 9957
    }

    vshPrint(ctl, "%s\n", xml);
9958
    VIR_FREE(xml);
9959
    virNodeDeviceFree(device);
E
Eric Blake 已提交
9960
    return true;
9961 9962
}

9963 9964 9965 9966
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
9967 9968
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
9969 9970 9971 9972 9973
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
9974
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9975 9976 9977
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9978
static bool
9979 9980
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
9981
    const char *name = NULL;
9982
    virNodeDevicePtr device;
E
Eric Blake 已提交
9983
    bool ret = true;
9984

9985
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9986
        return false;
9987
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9988
        return false;
9989
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9990
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9991
        return false;
9992 9993 9994 9995 9996
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
9997
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
9998
        ret = false;
9999 10000 10001 10002 10003 10004 10005 10006 10007
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
10008 10009
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
10010 10011 10012 10013 10014
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
10015
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10016 10017 10018
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10019
static bool
10020 10021
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
10022
    const char *name = NULL;
10023
    virNodeDevicePtr device;
E
Eric Blake 已提交
10024
    bool ret = true;
10025

10026
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10027
        return false;
10028
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10029
        return false;
10030
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10031
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10032
        return false;
10033 10034 10035 10036 10037
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
10038
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
10039
        ret = false;
10040 10041 10042 10043 10044 10045 10046 10047 10048
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
10049 10050
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
10051 10052 10053 10054 10055
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
10056
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10057 10058 10059
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10060
static bool
10061 10062
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
10063
    const char *name = NULL;
10064
    virNodeDevicePtr device;
E
Eric Blake 已提交
10065
    bool ret = true;
10066

10067
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10068
        return false;
10069
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10070
        return false;
10071
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10072
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10073
        return false;
10074 10075 10076 10077 10078
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
10079
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
10080
        ret = false;
10081 10082 10083 10084 10085
    }
    virNodeDeviceFree(device);
    return ret;
}

10086
/*
E
Eric Blake 已提交
10087
 * "hostname" command
10088
 */
10089
static const vshCmdInfo info_hostname[] = {
10090
    {"help", N_("print the hypervisor hostname")},
10091
    {"desc", ""},
10092 10093 10094
    {NULL, NULL}
};

E
Eric Blake 已提交
10095
static bool
10096
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10097 10098 10099
{
    char *hostname;

10100
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10101
        return false;
10102 10103 10104

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
10105
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
10106
        return false;
10107 10108 10109
    }

    vshPrint (ctl, "%s\n", hostname);
10110
    VIR_FREE(hostname);
10111

E
Eric Blake 已提交
10112
    return true;
10113 10114 10115 10116 10117
}

/*
 * "uri" command
 */
10118
static const vshCmdInfo info_uri[] = {
10119
    {"help", N_("print the hypervisor canonical URI")},
10120
    {"desc", ""},
10121 10122 10123
    {NULL, NULL}
};

E
Eric Blake 已提交
10124
static bool
10125
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10126 10127 10128
{
    char *uri;

10129
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10130
        return false;
10131 10132 10133

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
10134
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
10135
        return false;
10136 10137 10138
    }

    vshPrint (ctl, "%s\n", uri);
10139
    VIR_FREE(uri);
10140

E
Eric Blake 已提交
10141
    return true;
10142 10143
}

E
Eric Blake 已提交
10144 10145 10146 10147 10148 10149 10150 10151 10152 10153
/*
 * "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 已提交
10154
static bool
E
Eric Blake 已提交
10155 10156 10157 10158 10159
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10160
        return false;
E
Eric Blake 已提交
10161 10162 10163 10164

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
10165
        return false;
E
Eric Blake 已提交
10166 10167 10168 10169 10170
    }

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

E
Eric Blake 已提交
10171
    return true;
E
Eric Blake 已提交
10172 10173
}

10174 10175 10176
/*
 * "vncdisplay" command
 */
10177
static const vshCmdInfo info_vncdisplay[] = {
10178 10179
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
10180 10181 10182
    {NULL, NULL}
};

10183
static const vshCmdOptDef opts_vncdisplay[] = {
10184
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10185 10186 10187
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10188
static bool
10189
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
10190 10191 10192 10193 10194
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10195
    bool ret = false;
10196 10197 10198
    int port = 0;
    char *doc;

10199
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10200
        return false;
10201

J
Jim Meyering 已提交
10202
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10203
        return false;
10204 10205 10206 10207 10208 10209 10210 10211

    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);
10212
    VIR_FREE(doc);
10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230
    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) ||
10231
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
10232 10233 10234 10235 10236 10237
        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 已提交
10238
    ret = true;
10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251

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

/*
 * "ttyconsole" command
 */
10252
static const vshCmdInfo info_ttyconsole[] = {
10253 10254
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
10255 10256 10257
    {NULL, NULL}
};

10258
static const vshCmdOptDef opts_ttyconsole[] = {
10259
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10260 10261 10262
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10263
static bool
10264
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
10265 10266 10267 10268 10269
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10270
    bool ret = false;
10271 10272
    char *doc;

10273
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10274
        return false;
10275

J
Jim Meyering 已提交
10276
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10277
        return false;
10278 10279 10280 10281 10282 10283 10284 10285

    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);
10286
    VIR_FREE(doc);
10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298
    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 已提交
10299
    ret = true;
10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311

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

/*
 * "attach-device" command
10312
 */
10313
static const vshCmdInfo info_attach_device[] = {
10314 10315
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
10316 10317 10318
    {NULL, NULL}
};

10319
static const vshCmdOptDef opts_attach_device[] = {
10320 10321 10322
    {"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")},
10323 10324 10325
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10326
static bool
10327
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
10328 10329
{
    virDomainPtr dom;
10330
    const char *from = NULL;
10331
    char *buffer;
W
Wen Congyang 已提交
10332
    int ret;
J
Jim Fehlig 已提交
10333
    unsigned int flags;
10334

10335
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10336
        return false;
10337

J
Jim Meyering 已提交
10338
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10339
        return false;
10340

10341
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10342
        virDomainFree(dom);
E
Eric Blake 已提交
10343
        return false;
10344 10345
    }

10346
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10347
        virshReportError(ctl);
10348
        virDomainFree(dom);
E
Eric Blake 已提交
10349
        return false;
10350
    }
10351

J
Jim Fehlig 已提交
10352
    if (vshCommandOptBool(cmd, "persistent")) {
10353
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10354
        if (virDomainIsActive(dom) == 1)
10355
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10356 10357 10358 10359
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
10360
    VIR_FREE(buffer);
10361 10362

    if (ret < 0) {
10363
        vshError(ctl, _("Failed to attach device from %s"), from);
10364
        virDomainFree(dom);
E
Eric Blake 已提交
10365
        return false;
10366
    } else {
J
Jim Meyering 已提交
10367
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
10368 10369 10370
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10371
    return true;
10372 10373 10374 10375 10376 10377
}


/*
 * "detach-device" command
 */
10378
static const vshCmdInfo info_detach_device[] = {
10379 10380
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
10381 10382 10383
    {NULL, NULL}
};

10384
static const vshCmdOptDef opts_detach_device[] = {
10385 10386 10387
    {"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")},
10388 10389 10390
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10391
static bool
10392
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
10393 10394
{
    virDomainPtr dom;
10395
    const char *from = NULL;
10396
    char *buffer;
W
Wen Congyang 已提交
10397
    int ret;
J
Jim Fehlig 已提交
10398
    unsigned int flags;
10399

10400
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10401
        return false;
10402

J
Jim Meyering 已提交
10403
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10404
        return false;
10405

10406
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10407
        virDomainFree(dom);
E
Eric Blake 已提交
10408
        return false;
10409 10410
    }

10411
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10412
        virshReportError(ctl);
10413
        virDomainFree(dom);
E
Eric Blake 已提交
10414
        return false;
10415
    }
10416

J
Jim Fehlig 已提交
10417
    if (vshCommandOptBool(cmd, "persistent")) {
10418
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10419
        if (virDomainIsActive(dom) == 1)
10420
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10421 10422 10423 10424
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
10425
    VIR_FREE(buffer);
10426 10427

    if (ret < 0) {
10428
        vshError(ctl, _("Failed to detach device from %s"), from);
10429
        virDomainFree(dom);
E
Eric Blake 已提交
10430
        return false;
10431
    } else {
J
Jim Meyering 已提交
10432
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
10433 10434 10435
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10436
    return true;
10437 10438
}

10439

10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452
/*
 * "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")},
10453
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
10454 10455 10456
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10457
static bool
10458 10459 10460
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
10461
    const char *from = NULL;
10462
    char *buffer;
W
Wen Congyang 已提交
10463
    int ret;
10464 10465
    unsigned int flags;

10466
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10467
        return false;
10468 10469

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

10472
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10473
        virDomainFree(dom);
E
Eric Blake 已提交
10474
        return false;
10475 10476 10477
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10478
        virshReportError(ctl);
10479
        virDomainFree(dom);
E
Eric Blake 已提交
10480
        return false;
10481 10482 10483
    }

    if (vshCommandOptBool(cmd, "persistent")) {
10484
        flags = VIR_DOMAIN_AFFECT_CONFIG;
10485
        if (virDomainIsActive(dom) == 1)
10486
           flags |= VIR_DOMAIN_AFFECT_LIVE;
10487
    } else {
10488
        flags = VIR_DOMAIN_AFFECT_LIVE;
10489
    }
10490 10491 10492 10493

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

10494 10495 10496 10497 10498 10499
    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 已提交
10500
        return false;
10501 10502 10503 10504 10505
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10506
    return true;
10507 10508 10509
}


10510 10511 10512
/*
 * "attach-interface" command
 */
10513
static const vshCmdInfo info_attach_interface[] = {
10514 10515
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
10516 10517 10518
    {NULL, NULL}
};

10519
static const vshCmdOptDef opts_attach_interface[] = {
10520 10521 10522 10523 10524 10525
    {"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")},
10526
    {"model", VSH_OT_DATA, 0, N_("model type")},
10527
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
10528 10529 10530
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10531
static bool
10532
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
10533 10534
{
    virDomainPtr dom = NULL;
10535 10536
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
10537
    int typ;
W
Wen Congyang 已提交
10538 10539
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
10540
    unsigned int flags;
10541 10542
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10543

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

J
Jim Meyering 已提交
10547
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10548 10549
        goto cleanup;

10550
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10551 10552
        goto cleanup;

10553 10554 10555 10556
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
10557 10558
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
10559
        goto cleanup;
10560
    }
10561 10562

    /* check interface type */
10563
    if (STREQ(type, "network")) {
10564
        typ = 1;
10565
    } else if (STREQ(type, "bridge")) {
10566 10567
        typ = 2;
    } else {
E
Eric Blake 已提交
10568 10569
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
10570 10571 10572 10573
        goto cleanup;
    }

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

10576
    if (typ == 1)
10577
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
10578
    else if (typ == 2)
10579
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
10580

10581
    if (target != NULL)
10582
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10583
    if (mac != NULL)
10584
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
10585
    if (script != NULL)
10586
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
10587
    if (model != NULL)
10588
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
10589

10590
    virBufferAddLit(&buf, "</interface>\n");
10591

10592 10593
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
10594
        goto cleanup;
10595 10596
    }

10597
    xml = virBufferContentAndReset(&buf);
10598

J
Jim Fehlig 已提交
10599
    if (vshCommandOptBool(cmd, "persistent")) {
10600
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10601
        if (virDomainIsActive(dom) == 1)
10602
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10603
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
10604
    } else {
10605
        ret = virDomainAttachDevice(dom, xml);
10606
    }
10607

10608 10609
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10610
    if (ret != 0) {
L
Laine Stump 已提交
10611
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
10612 10613
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
10614
        functionReturn = true;
J
Jim Fehlig 已提交
10615
    }
10616 10617 10618 10619

 cleanup:
    if (dom)
        virDomainFree(dom);
10620
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10621
    return functionReturn;
10622 10623 10624 10625 10626
}

/*
 * "detach-interface" command
 */
10627
static const vshCmdInfo info_detach_interface[] = {
10628 10629
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
10630 10631 10632
    {NULL, NULL}
};

10633
static const vshCmdOptDef opts_detach_interface[] = {
10634 10635 10636 10637
    {"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")},
10638 10639 10640
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10641
static bool
10642
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
10643 10644 10645 10646 10647 10648 10649
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
10650
    const char *mac =NULL, *type = NULL;
10651
    char *doc;
10652
    char buf[64];
E
Eric Blake 已提交
10653
    int i = 0, diff_mac;
W
Wen Congyang 已提交
10654 10655
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
10656
    unsigned int flags;
10657

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

J
Jim Meyering 已提交
10661
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10662 10663
        goto cleanup;

10664
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10665 10666
        goto cleanup;

10667 10668
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
10669
        goto cleanup;
10670
    }
10671 10672 10673 10674 10675 10676 10677 10678

    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);
10679
    VIR_FREE(doc);
10680
    if (!xml) {
10681
        vshError(ctl, "%s", _("Failed to get interface information"));
10682 10683 10684 10685
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
10686
        vshError(ctl, "%s", _("Failed to get interface information"));
10687 10688 10689
        goto cleanup;
    }

E
Eric Blake 已提交
10690
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
10691 10692 10693
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10694
        vshError(ctl, _("No found interface whose type is %s"), type);
10695 10696 10697
        goto cleanup;
    }

10698 10699 10700 10701 10702 10703
    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;
    }

10704 10705 10706 10707 10708 10709 10710
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10711 10712 10713 10714 10715
            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);
10716 10717 10718 10719 10720 10721 10722
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10723
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
10724 10725 10726 10727 10728
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10729
        vshError(ctl, "%s", _("Failed to allocate memory"));
10730 10731 10732
        goto cleanup;
    }

10733
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
10734
        vshError(ctl, "%s", _("Failed to create XML"));
10735 10736 10737
        goto cleanup;
    }

J
Jim Fehlig 已提交
10738
    if (vshCommandOptBool(cmd, "persistent")) {
10739
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10740
        if (virDomainIsActive(dom) == 1)
10741
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10742 10743 10744 10745 10746 10747 10748 10749
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10750
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
10751
    } else {
J
Jim Meyering 已提交
10752
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
10753
        functionReturn = true;
10754
    }
10755 10756 10757 10758

 cleanup:
    if (dom)
        virDomainFree(dom);
10759
    xmlXPathFreeObject(obj);
10760
    xmlXPathFreeContext(ctxt);
10761 10762 10763 10764
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
10765
    return functionReturn;
10766 10767 10768 10769 10770
}

/*
 * "attach-disk" command
 */
10771
static const vshCmdInfo info_attach_disk[] = {
10772 10773
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
10774 10775 10776
    {NULL, NULL}
};

10777
static const vshCmdOptDef opts_attach_disk[] = {
10778 10779 10780 10781 10782
    {"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")},
10783
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
10784 10785 10786
    {"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")},
10787
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
10788 10789 10790
    {"serial", VSH_OT_STRING, 0, N_("serial of disk device")},
    {"shareable", VSH_OT_BOOL, 0, N_("shareable between domains")},
    {"address", VSH_OT_STRING, 0, N_("address of disk device")},
10791 10792 10793
    {NULL, 0, 0, NULL}
};

10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 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 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940
enum {
    DISK_ADDR_TYPE_INVALID,
    DISK_ADDR_TYPE_PCI,
    DISK_ADDR_TYPE_SCSI,
    DISK_ADDR_TYPE_IDE,
};

struct PCIAddress {
    unsigned int domain;
    unsigned int bus;
    unsigned int slot;
    unsigned int function;
};

struct SCSIAddress {
    unsigned int controller;
    unsigned int bus;
    unsigned int unit;
};

struct IDEAddress {
    unsigned int controller;
    unsigned int bus;
    unsigned int unit;
};

struct DiskAddress {
    int type;
    union {
        struct PCIAddress pci;
        struct SCSIAddress scsi;
        struct IDEAddress ide;
    } addr;
};

static int str2PCIAddress(const char *str, struct PCIAddress *pciAddr)
{
    char *domain, *bus, *slot, *function;

    if (!pciAddr)
        return -1;
    if (!str)
        return -1;

    domain = (char *)str;

    if (virStrToLong_ui(domain, &bus, 0, &pciAddr->domain) != 0)
        return -1;

    bus++;
    if (virStrToLong_ui(bus, &slot, 0, &pciAddr->bus) != 0)
        return -1;

    slot++;
    if (virStrToLong_ui(slot, &function, 0, &pciAddr->slot) != 0)
        return -1;

    function++;
    if (virStrToLong_ui(function, NULL, 0, &pciAddr->function) != 0)
        return -1;

    return 0;
}

static int str2SCSIAddress(const char *str, struct SCSIAddress *scsiAddr)
{
    char *controller, *bus, *unit;

    if (!scsiAddr)
        return -1;
    if (!str)
        return -1;

    controller = (char *)str;

    if (virStrToLong_ui(controller, &bus, 0, &scsiAddr->controller) != 0)
        return -1;

    bus++;
    if (virStrToLong_ui(bus, &unit, 0, &scsiAddr->bus) != 0)
        return -1;

    unit++;
    if (virStrToLong_ui(unit, NULL, 0, &scsiAddr->unit) != 0)
        return -1;

    return 0;
}

static int str2IDEAddress(const char *str, struct IDEAddress *ideAddr)
{
    char *controller, *bus, *unit;

    if (!ideAddr)
        return -1;
    if (!str)
        return -1;

    controller = (char *)str;

    if (virStrToLong_ui(controller, &bus, 0, &ideAddr->controller) != 0)
        return -1;

    bus++;
    if (virStrToLong_ui(bus, &unit, 0, &ideAddr->bus) != 0)
        return -1;

    unit++;
    if (virStrToLong_ui(unit, NULL, 0, &ideAddr->unit) != 0)
        return -1;

    return 0;
}

/* pci address pci:0000.00.0x0a.0 (domain:bus:slot:function)
 * ide disk address: ide:00.00.0 (controller:bus:unit)
 * scsi disk address: scsi:00.00.0 (controller:bus:unit)
 */

static int str2DiskAddress(const char *str, struct DiskAddress *diskAddr)
{
    char *type, *addr;

    if (!diskAddr)
        return -1;
    if (!str)
        return -1;

    type = (char *)str;
    addr = strchr(type, ':');
    if (!addr)
        return -1;

    if (STREQLEN(type, "pci", addr - type)) {
        diskAddr->type = DISK_ADDR_TYPE_PCI;
        return str2PCIAddress(addr + 1, &diskAddr->addr.pci);
    } else if (STREQLEN(type, "scsi", addr - type)) {
        diskAddr->type = DISK_ADDR_TYPE_SCSI;
        return str2SCSIAddress(addr + 1, &diskAddr->addr.scsi);
    } else if (STREQLEN(type, "ide", addr - type)) {
        diskAddr->type = DISK_ADDR_TYPE_IDE;
        return str2IDEAddress(addr + 1, &diskAddr->addr.ide);
    }

    return -1;
}

E
Eric Blake 已提交
10941
static bool
10942
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
10943 10944
{
    virDomainPtr dom = NULL;
10945
    const char *source = NULL, *target = NULL, *driver = NULL,
10946 10947 10948
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
10949 10950
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
10951
    unsigned int flags;
10952
    const char *stype = NULL;
10953 10954
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10955

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

J
Jim Meyering 已提交
10959
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10960 10961
        goto cleanup;

10962
    if (vshCommandOptString(cmd, "source", &source) <= 0)
10963 10964
        goto cleanup;

10965
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10966 10967
        goto cleanup;

10968 10969 10970 10971
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
10972 10973 10974
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
10975
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
10976
        vshError(ctl, "%s", _("missing option"));
10977 10978
        goto cleanup;
    }
10979

10980 10981
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
10982
            isFile = true;
10983
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
10984
        isFile = true;
10985 10986 10987
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
10988 10989 10990
    }

    if (mode) {
10991
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
10992 10993
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
10994 10995 10996 10997 10998
            goto cleanup;
        }
    }

    /* Make XML of disk */
10999
    virBufferAsprintf(&buf, "<disk type='%s'",
11000 11001
                      (isFile) ? "file" : "block");
    if (type)
11002
        virBufferAsprintf(&buf, " device='%s'", type);
11003 11004
    virBufferAddLit(&buf, ">\n");

11005
    if (driver || subdriver)
11006
        virBufferAsprintf(&buf, "  <driver");
11007 11008

    if (driver)
11009
        virBufferAsprintf(&buf, " name='%s'", driver);
11010
    if (subdriver)
11011
        virBufferAsprintf(&buf, " type='%s'", subdriver);
11012 11013
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
11014

11015
    if (driver || subdriver || cache)
11016
        virBufferAddLit(&buf, "/>\n");
11017

11018
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
11019 11020
                      (isFile) ? "file" : "dev",
                      source);
11021
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11022
    if (mode)
11023
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
11024

11025 11026 11027 11028 11029 11030 11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072
    if (serial)
        virBufferAsprintf(&buf, "  <serial>%s</serial>\n", serial);

    if (vshCommandOptBool(cmd, "shareable"))
        virBufferAsprintf(&buf, "  <shareable/>\n");

    if (straddr) {
        if (str2DiskAddress(straddr, &diskAddr) != 0) {
            vshError(ctl, _("Invalid address."));
            goto cleanup;
        }

        if (STRPREFIX((const char *)target, "vd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_PCI) {
                virBufferAsprintf(&buf,
                                  "  <address type='pci' domain='0x%04x'"
                                  " bus ='0x%02x' slot='0x%02x' function='0x%0x' />\n",
                                  diskAddr.addr.pci.domain, diskAddr.addr.pci.bus,
                                  diskAddr.addr.pci.slot, diskAddr.addr.pci.function);
            } else {
                vshError(ctl, "%s", _("expecting a pci:0000.00.00.00 address."));
                goto cleanup;
            }
        } else if (STRPREFIX((const char *)target, "sd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_SCSI) {
                virBufferAsprintf(&buf,
                                  "  <address type='drive' controller='%d'"
                                  " bus='%d' unit='%d' />\n",
                                  diskAddr.addr.scsi.controller, diskAddr.addr.scsi.bus,
                                  diskAddr.addr.scsi.unit);
            } else {
                vshError(ctl, "%s", _("expecting a scsi:00.00.00 address."));
                goto cleanup;
            }
        } else if (STRPREFIX((const char *)target, "hd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_IDE) {
                virBufferAsprintf(&buf,
                                  "  <address type='drive' controller='%d'"
                                  " bus='%d' unit='%d' />\n",
                                  diskAddr.addr.ide.controller, diskAddr.addr.ide.bus,
                                  diskAddr.addr.ide.unit);
            } else {
                vshError(ctl, "%s", _("expecting an ide:00.00.00 address."));
                goto cleanup;
            }
        }
    }

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

11075 11076
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
11077
        return false;
11078 11079
    }

11080
    xml = virBufferContentAndReset(&buf);
11081

J
Jim Fehlig 已提交
11082
    if (vshCommandOptBool(cmd, "persistent")) {
11083
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11084
        if (virDomainIsActive(dom) == 1)
11085
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11086
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
11087
    } else {
11088
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
11089
    }
11090

11091 11092
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11093
    if (ret != 0) {
L
Laine Stump 已提交
11094
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
11095 11096
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
11097
        functionReturn = true;
J
Jim Fehlig 已提交
11098
    }
11099 11100 11101 11102

 cleanup:
    if (dom)
        virDomainFree(dom);
11103
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11104
    return functionReturn;
11105 11106 11107 11108 11109
}

/*
 * "detach-disk" command
 */
11110
static const vshCmdInfo info_detach_disk[] = {
11111 11112
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
11113 11114 11115
    {NULL, NULL}
};

11116
static const vshCmdOptDef opts_detach_disk[] = {
11117 11118 11119
    {"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")},
11120 11121 11122
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11123
static bool
11124
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
11125 11126 11127 11128 11129 11130 11131
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
11132
    const char *target = NULL;
11133
    char *doc;
E
Eric Blake 已提交
11134
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
11135 11136
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11137
    unsigned int flags;
11138

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

J
Jim Meyering 已提交
11142
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11143 11144
        goto cleanup;

11145
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11146 11147 11148 11149 11150 11151 11152 11153 11154
        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);
11155
    VIR_FREE(doc);
11156
    if (!xml) {
11157
        vshError(ctl, "%s", _("Failed to get disk information"));
11158 11159 11160 11161
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
11162
        vshError(ctl, "%s", _("Failed to get disk information"));
11163 11164 11165 11166 11167 11168
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11169
        vshError(ctl, "%s", _("Failed to get disk information"));
11170 11171 11172 11173 11174 11175 11176
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11177 11178 11179 11180 11181
            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);
11182 11183 11184 11185 11186 11187 11188
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11189
    vshError(ctl, _("No found disk whose target is %s"), target);
11190 11191 11192 11193 11194
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11195
        vshError(ctl, "%s", _("Failed to allocate memory"));
11196 11197 11198
        goto cleanup;
    }

11199
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
11200
        vshError(ctl, "%s", _("Failed to create XML"));
11201 11202 11203
        goto cleanup;
    }

J
Jim Fehlig 已提交
11204
    if (vshCommandOptBool(cmd, "persistent")) {
11205
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11206
        if (virDomainIsActive(dom) == 1)
11207
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11208 11209 11210 11211 11212 11213 11214 11215
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11216
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
11217
    } else {
J
Jim Meyering 已提交
11218
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
11219
        functionReturn = true;
11220
    }
11221 11222

 cleanup:
11223
    xmlXPathFreeObject(obj);
11224
    xmlXPathFreeContext(ctxt);
11225 11226 11227 11228 11229 11230
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
11231
    return functionReturn;
11232 11233
}

11234 11235 11236 11237
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
11238 11239
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
11240 11241 11242 11243
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
11244
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
11245 11246 11247
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11248
static bool
11249 11250
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
11251
    const char *from = NULL;
E
Eric Blake 已提交
11252
    bool ret = true;
11253 11254 11255
    char *buffer;
    int result;

11256
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11257
        return false;
11258

11259
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11260
        return false;
11261 11262

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
11266
    VIR_FREE(buffer);
11267 11268 11269 11270 11271

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
11272
        ret = false;
11273 11274 11275 11276 11277
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
11278
        ret = true;
11279 11280 11281 11282 11283
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
11284
        ret = true;
11285 11286 11287 11288 11289
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
11290
        ret = false;
11291 11292 11293 11294 11295
    }

    return ret;
}

11296 11297 11298 11299
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
11300 11301
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
11302 11303 11304 11305
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
11306
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
11307 11308 11309
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11310
static bool
11311 11312
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
11313
    const char *from = NULL;
E
Eric Blake 已提交
11314
    bool ret = true;
11315 11316 11317 11318 11319
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
11320
    xmlNodePtr node_list;
11321 11322 11323 11324 11325 11326
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

11327
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11328
        return false;
11329

11330
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11331
        return false;
11332 11333

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
11334
        return false;
11335 11336 11337 11338 11339

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

L
Laine Stump 已提交
11340 11341
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
11342 11343
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
11344
        ret = false;
11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380
        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 已提交
11381
        ret = false;
11382 11383 11384 11385 11386 11387 11388 11389
        goto cleanup;
    }

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

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
11390
        ret = false;
11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407

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 已提交
11408
    ret = false;
11409
    goto cleanup;
11410 11411
}

11412 11413 11414 11415 11416 11417 11418 11419
/* 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;

11420
    ret = vshMalloc(ctl, PATH_MAX);
11421 11422 11423

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
11424 11425
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
11426
    if (fd == -1) {
11427
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
11428
                 strerror(errno));
11429
        VIR_FREE(ret);
11430 11431 11432 11433
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
11434 11435
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
11436
        VIR_FORCE_CLOSE(fd);
11437
        unlink (ret);
11438
        VIR_FREE(ret);
11439 11440
        return NULL;
    }
S
Stefan Berger 已提交
11441
    if (VIR_CLOSE(fd) < 0) {
11442 11443
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
11444
        unlink (ret);
11445
        VIR_FREE(ret);
11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460
        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 已提交
11461 11462 11463 11464
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
11465

11466
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
11467 11468 11469 11470
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
11471

11472 11473 11474 11475 11476
    /* 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 已提交
11477 11478
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
11479
     */
E
Eric Blake 已提交
11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491
    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);
11492 11493
    }

E
Eric Blake 已提交
11494 11495 11496 11497 11498 11499 11500
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
11501
    }
E
Eric Blake 已提交
11502
    ret = 0;
11503

E
Eric Blake 已提交
11504 11505 11506
cleanup:
    virCommandFree(cmd);
    return ret;
11507 11508 11509 11510 11511 11512 11513 11514
}

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

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
11515
        vshError(ctl,
11516
                 _("%s: failed to read temporary file: %s"),
11517
                 filename, strerror(errno));
11518 11519 11520 11521 11522
        return NULL;
    }
    return ret;
}

11523

P
Paolo Bonzini 已提交
11524 11525 11526 11527
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
11528 11529
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
11530 11531 11532 11533
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11538
static bool
11539
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
11540
{
11541
    const char *dir = NULL;
11542
    char *dir_malloced = NULL;
E
Eric Blake 已提交
11543
    bool ret = true;
P
Paolo Bonzini 已提交
11544 11545

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

11550
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
11551
        uid_t uid = geteuid();
11552
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
11553 11554 11555 11556
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
11557
    if (chdir(dir) == -1) {
11558
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
11559
        ret = false;
P
Paolo Bonzini 已提交
11560 11561
    }

11562
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
11563
    return ret;
P
Paolo Bonzini 已提交
11564 11565 11566 11567 11568 11569
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
11570 11571
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
11572 11573 11574
    {NULL, NULL}
};

E
Eric Blake 已提交
11575
static bool
P
Paolo Bonzini 已提交
11576 11577 11578
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
11579
    bool ret = true;
P
Paolo Bonzini 已提交
11580

11581 11582
    cwd = getcwd(NULL, 0);
    if (!cwd) {
11583 11584
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
11585 11586
        ret = false;
    } else {
P
Paolo Bonzini 已提交
11587
        vshPrint (ctl, _("%s\n"), cwd);
11588 11589
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
11590

11591
    return ret;
P
Paolo Bonzini 已提交
11592 11593
}

E
Eric Blake 已提交
11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605
/*
 * "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")},
11606
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
11607 11608 11609 11610 11611 11612
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
11613
static bool
E
Eric Blake 已提交
11614 11615 11616 11617 11618
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
11619
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
11620 11621 11622 11623 11624 11625 11626 11627
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

11628
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
11629 11630 11631
        bool close_quote = false;
        char *q;

11632
        arg = opt->data;
E
Eric Blake 已提交
11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660
        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 已提交
11661
        return false;
E
Eric Blake 已提交
11662 11663 11664 11665 11666
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
11667
    return true;
E
Eric Blake 已提交
11668 11669
}

11670 11671 11672 11673
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
11674 11675
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
11676 11677 11678 11679
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
11680
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11681 11682 11683 11684 11685 11686
    {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 已提交
11687
static bool
11688 11689
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
11690
    bool ret = false;
11691 11692 11693 11694 11695
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
11696
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
11697

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

J
Jim Meyering 已提交
11701
    dom = vshCommandOptDomain (ctl, cmd, NULL);
11702 11703 11704 11705
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
11706
    doc = virDomainGetXMLDesc (dom, flags);
11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 11723 11724
    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 已提交
11725
        ret = true;
11726 11727 11728 11729 11730 11731 11732
        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.
     */
11733
    doc_reread = virDomainGetXMLDesc (dom, flags);
11734 11735 11736 11737
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
11738 11739
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
11740 11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751
        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 已提交
11752
    ret = true;
11753 11754 11755 11756 11757

 cleanup:
    if (dom)
        virDomainFree (dom);

11758 11759 11760
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
11761 11762 11763

    if (tmp) {
        unlink (tmp);
11764
        VIR_FREE(tmp);
11765 11766 11767 11768 11769
    }

    return ret;
}

11770

11771 11772 11773 11774
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
11775 11776
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
11777 11778 11779 11780
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
11781
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
11782 11783 11784 11785 11786 11787 11788 11789 11790 11791
    {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[] = {
11792 11793
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
11794 11795 11796 11797
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
11798
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
11799 11800 11801 11802 11803 11804
    {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 已提交
11805 11806 11807
/*
 * "quit" command
 */
11808
static const vshCmdInfo info_quit[] = {
11809
    {"help", N_("quit this interactive terminal")},
11810
    {"desc", ""},
11811
    {NULL, NULL}
K
Karel Zak 已提交
11812 11813
};

E
Eric Blake 已提交
11814
static bool
11815
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11816
{
E
Eric Blake 已提交
11817 11818
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
11819 11820
}

11821 11822 11823 11824
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
11825 11826
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
11827 11828 11829 11830 11831 11832 11833 11834 11835
    {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 已提交
11836
static bool
11837 11838 11839
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11840
    bool ret = false;
11841
    const char *from = NULL;
11842 11843 11844 11845 11846 11847 11848
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

11849
    if (!vshConnectionUsability(ctl, ctl->conn))
11850 11851 11852 11853 11854 11855
        goto cleanup;

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

11856
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
11857
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901
    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 已提交
11902
    ret = true;
11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918

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

11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931
/*
 * "snapshot-create-as" command
 */
static const vshCmdInfo info_snapshot_create_as[] = {
    {"help", N_("Create a snapshot from a set of args")},
    {"desc", N_("Create a snapshot (disk and RAM) from arguments")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_create_as[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"name", VSH_OT_DATA, 0, N_("name of snapshot")},
    {"description", VSH_OT_DATA, 0, N_("description of snapshot")},
E
Eric Blake 已提交
11932
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    const char *name = NULL;
    const char *desc = NULL;
    char *parsed_name = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

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

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

    if (vshCommandOptString(cmd, "name", &name) < 0 ||
        vshCommandOptString(cmd, "description", &desc) < 0) {
        vshError(ctl, _("argument must not be empty"));
        goto cleanup;
    }

    virBufferAddLit(&buf, "<domainsnapshot>\n");
    if (name)
11966
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
11967
    if (desc)
11968
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
11969 11970 11971 11972 11973 11974 11975 11976
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
11977 11978 11979 11980 11981 11982
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025
    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;

    parsed_name = virXPathString("string(/domainsnapshot/name)", ctxt);
    if (!parsed_name) {
        vshError(ctl, "%s",
                 _("Could not find 'name' element in domain snapshot XML"));
        goto cleanup;
    }

    vshPrint(ctl, _("Domain snapshot %s created\n"), name ? name : parsed_name);

    ret = true;

cleanup:
    VIR_FREE(parsed_name);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036
/*
 * "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")},
12037
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
12038 12039 12040
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12041
static bool
12042 12043 12044
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12045
    bool ret = false;
12046 12047
    int current;
    virDomainSnapshotPtr snapshot = NULL;
12048
    char *xml = NULL;
12049

12050
    if (!vshConnectionUsability(ctl, ctl->conn))
12051 12052 12053 12054 12055 12056 12057 12058 12059 12060
        goto cleanup;

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

    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
12061
        char *name = NULL;
12062 12063 12064 12065 12066 12067 12068 12069

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

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

12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093
        if (vshCommandOptBool(cmd, "name")) {
            xmlDocPtr xmldoc = NULL;
            xmlXPathContextPtr ctxt = NULL;

            xmldoc = xmlReadDoc((const xmlChar *) xml, "domainsnapshot.xml",
                                NULL, XML_PARSE_NOENT | XML_PARSE_NONET |
                                XML_PARSE_NOWARNING);
            if (!xmldoc)
                goto cleanup;
            ctxt = xmlXPathNewContext(xmldoc);
            if (!ctxt) {
                xmlFreeDoc(xmldoc);
                goto cleanup;
            }

            name = virXPathString("string(/domainsnapshot/name)", ctxt);
            xmlXPathFreeContext(ctxt);
            xmlFreeDoc(xmldoc);
            if (!name)
                goto cleanup;
        }

        vshPrint(ctl, "%s", name ? name : xml);
        VIR_FREE(name);
12094 12095
    }

E
Eric Blake 已提交
12096
    ret = true;
12097 12098

cleanup:
12099
    VIR_FREE(xml);
12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121
    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 已提交
12122
static bool
12123 12124 12125
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12126
    bool ret = false;
12127 12128
    int numsnaps;
    char **names = NULL;
12129
    int actual = 0;
12130 12131 12132 12133 12134 12135
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
12136 12137
    long long creation_longlong;
    time_t creation_time_t;
12138 12139 12140
    char timestr[100];
    struct tm time_info;

12141
    if (!vshConnectionUsability(ctl, ctl->conn))
12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152
        goto cleanup;

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

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

12153 12154
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
12155 12156 12157 12158 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 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195

    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;
12196 12197
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
12198
                continue;
12199 12200 12201 12202 12203 12204
            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);
12205
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
12206 12207 12208 12209 12210

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

E
Eric Blake 已提交
12211
    ret = true;
12212 12213 12214 12215 12216 12217 12218 12219 12220 12221

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);
12222 12223
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245
    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 已提交
12246
static bool
12247 12248 12249
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12250
    bool ret = false;
12251
    const char *name = NULL;
12252 12253 12254
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

12255
    if (!vshConnectionUsability(ctl, ctl->conn))
12256 12257 12258 12259 12260 12261
        goto cleanup;

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

12262
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12263 12264 12265 12266 12267 12268 12269 12270 12271 12272
        goto cleanup;

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

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

12273
    vshPrint(ctl, "%s", xml);
12274

E
Eric Blake 已提交
12275
    ret = true;
12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287

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

    return ret;
}

/*
12288
 * "snapshot-revert" command
12289
 */
12290
static const vshCmdInfo info_snapshot_revert[] = {
12291 12292 12293 12294 12295
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

12296
static const vshCmdOptDef opts_snapshot_revert[] = {
12297 12298 12299 12300 12301
    {"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 已提交
12302
static bool
12303
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
12304 12305
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12306
    bool ret = false;
12307
    const char *name = NULL;
12308 12309
    virDomainSnapshotPtr snapshot = NULL;

12310
    if (!vshConnectionUsability(ctl, ctl->conn))
12311 12312 12313 12314 12315 12316
        goto cleanup;

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

12317
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12318 12319 12320 12321 12322 12323 12324 12325 12326
        goto cleanup;

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

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

E
Eric Blake 已提交
12327
    ret = true;
12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353

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 已提交
12354
static bool
12355 12356 12357
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12358
    bool ret = false;
12359
    const char *name = NULL;
12360 12361 12362
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

12363
    if (!vshConnectionUsability(ctl, ctl->conn))
12364 12365 12366 12367 12368 12369
        goto cleanup;

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

12370
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12371 12372 12373 12374 12375 12376 12377 12378 12379
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;

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

12380 12381 12382 12383
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
        vshPrint(ctl, _("Domain snapshot %s deleted\n"), name);
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
12384
        goto cleanup;
12385
    }
12386

E
Eric Blake 已提交
12387
    ret = true;
12388 12389 12390 12391 12392 12393 12394 12395 12396 12397

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

    return ret;
}

12398 12399 12400 12401
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
12402 12403
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
12404 12405 12406 12407 12408 12409
    {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")},
12410
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
12411 12412 12413
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12414
static bool
12415 12416 12417
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12418
    bool ret = false;
12419
    const char *monitor_cmd = NULL;
12420
    char *result = NULL;
12421
    unsigned int flags = 0;
12422 12423 12424 12425 12426 12427 12428 12429

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

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

12430
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
12431 12432 12433 12434
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

12435 12436 12437 12438
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
12439 12440 12441 12442
        goto cleanup;

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

E
Eric Blake 已提交
12443
    ret = true;
12444 12445 12446 12447 12448 12449 12450 12451 12452

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

    return ret;
}

12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498
/*
 * "qemu-attach" command
 */
static const vshCmdInfo info_qemu_attach[] = {
    {"help", N_("QEMU Attach")},
    {"desc", N_("QEMU Attach")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_attach[] = {
    {"pid", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pid")},
    {NULL, 0, 0, NULL}
};

static bool
cmdQemuAttach(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    unsigned int flags = 0;
    unsigned int pid;

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

    if (vshCommandOptUInt(cmd, "pid", &pid) <= 0) {
        vshError(ctl, "%s", _("missing pid value"));
        goto cleanup;
    }

    if (!(dom = virDomainQemuAttach(ctl->conn, pid, flags)))
        goto cleanup;

    if (dom != NULL) {
        vshPrint(ctl, _("Domain %s attached to pid %u\n"),
                 virDomainGetName(dom), pid);
        virDomainFree(dom);
        ret = true;
    } else {
        vshError(ctl, _("Failed to attach to pid %u"), pid);
    }

cleanup:
    return ret;
}

12499
static const vshCmdDef domManagementCmds[] = {
12500 12501 12502 12503 12504 12505 12506 12507
    {"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},
12508 12509
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
12510
#ifndef WIN32
12511
    {"console", cmdConsole, opts_console, info_console, 0},
12512
#endif
12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535
    {"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},
12536
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
12537 12538 12539 12540 12541 12542 12543 12544
    {"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},
12545 12546
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
12547 12548 12549 12550
    {"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},
12551 12552 12553 12554 12555 12556
    {"save-image-define", cmdSaveImageDefine, opts_save_image_define,
     info_save_image_define, 0},
    {"save-image-dumpxml", cmdSaveImageDumpxml, opts_save_image_dumpxml,
     info_save_image_dumpxml, 0},
    {"save-image-edit", cmdSaveImageEdit, opts_save_image_edit,
     info_save_image_edit, 0},
12557
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
12558
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570
    {"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},
E
Eric Blake 已提交
12571
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
12572
    {"version", cmdVersion, opts_version, info_version, 0},
12573 12574
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
12575 12576 12577
};

static const vshCmdDef domMonitoringCmds[] = {
12578 12579
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
12580
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
12581 12582 12583 12584 12585 12586
    {"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}
12587 12588 12589
};

static const vshCmdDef storagePoolCmds[] = {
12590
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
12591
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
12592
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613
     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}
12614 12615 12616
};

static const vshCmdDef storageVolCmds[] = {
12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634
    {"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}
12635
};
12636

12637
static const vshCmdDef networkCmds[] = {
12638 12639 12640 12641 12642 12643 12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656
    {"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}
12657
};
12658

12659
static const vshCmdDef nodedevCmds[] = {
12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674
    {"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}
12675 12676 12677
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
12678 12679 12680 12681
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695
    {"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 已提交
12696 12697
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
12698 12699 12700 12701 12702
    {"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}
12703
};
12704

12705
static const vshCmdDef nwfilterCmds[] = {
12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716
    {"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}
12717
};
12718

12719
static const vshCmdDef secretCmds[] = {
12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731
    {"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}
12732
};
12733

12734
static const vshCmdDef virshCmds[] = {
12735 12736 12737 12738 12739 12740 12741
    {"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}
12742
};
12743

12744
static const vshCmdDef snapshotCmds[] = {
12745 12746
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
12747 12748
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759
    {"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}
12760
};
12761

12762
static const vshCmdDef hostAndHypervisorCmds[] = {
12763 12764 12765 12766 12767
    {"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},
12768
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
12769
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
12770
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
12771
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
12772 12773 12774 12775 12776
    {"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 已提交
12777 12778
};

12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795
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 已提交
12796 12797 12798 12799
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
12800
static const char *
12801
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
12802
{
12803
    const vshCmdInfo *info;
12804

K
Karel Zak 已提交
12805
    for (info = cmd->info; info && info->name; info++) {
12806
        if (STREQ(info->name, name))
K
Karel Zak 已提交
12807 12808 12809 12810 12811
            return info->data;
    }
    return NULL;
}

12812
static int
E
Eric Blake 已提交
12813
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
12814 12815 12816 12817 12818
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
12819 12820 12821
    *opts_need_arg = 0;
    *opts_required = 0;

12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834
    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 已提交
12835 12836 12837 12838 12839 12840
        if (opt->flag & VSH_OFLAG_REQ_OPT) {
            if (opt->flag & VSH_OFLAG_REQ)
                *opts_required |= 1 << i;
            continue;
        }

12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852
        *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;
}

12853
static const vshCmdOptDef *
12854 12855
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
12856
{
12857 12858 12859 12860
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
12861

12862 12863 12864 12865 12866
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
12867 12868 12869 12870 12871
            if (opt->type == VSH_OT_ARGV) {
                vshError(ctl, _("variable argument <%s> "
                         "should not be used with --<%s>"), name, name);
                return NULL;
            }
12872
            *opts_seen |= 1 << i;
K
Karel Zak 已提交
12873
            return opt;
12874 12875 12876 12877 12878
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
12879 12880 12881
    return NULL;
}

12882
static const vshCmdOptDef *
12883 12884
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
12885
{
12886
    int i;
12887
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
12888

12889 12890 12891 12892
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
12893
    i = ffs(*opts_need_arg) - 1;
12894 12895 12896 12897 12898
    opt = &cmd->opts[i];
    if (opt->type != VSH_OT_ARGV)
        *opts_need_arg &= ~(1 << i);
    *opts_seen |= 1 << i;
    return opt;
K
Karel Zak 已提交
12899 12900
}

12901 12902 12903
/*
 * Checks for required options
 */
12904
static int
12905 12906
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
12907
{
12908
    const vshCmdDef *def = cmd->def;
12909 12910 12911 12912 12913 12914 12915 12916 12917
    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];
12918

12919
            vshError(ctl,
12920
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
12921 12922 12923
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
12924 12925
        }
    }
12926
    return -1;
12927 12928
}

12929
static const vshCmdDef *
12930 12931
vshCmddefSearch(const char *cmdname)
{
12932
    const vshCmdGrp *g;
12933
    const vshCmdDef *c;
12934

12935 12936
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
12937
            if (STREQ(c->name, cmdname))
12938 12939 12940 12941
                return c;
        }
    }

K
Karel Zak 已提交
12942 12943 12944
    return NULL;
}

12945 12946 12947 12948 12949 12950
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
12951
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
12952 12953 12954 12955 12956 12957
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
12958
static bool
12959 12960 12961 12962 12963 12964 12965
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 已提交
12966
        return false;
12967 12968 12969 12970 12971 12972 12973 12974 12975 12976
    } 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 已提交
12977
    return true;
12978 12979
}

E
Eric Blake 已提交
12980
static bool
12981
vshCmddefHelp(vshControl *ctl, const char *cmdname)
12982
{
12983
    const vshCmdDef *def = vshCmddefSearch(cmdname);
12984

K
Karel Zak 已提交
12985
    if (!def) {
12986
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
12987
        return false;
12988
    } else {
E
Eric Blake 已提交
12989 12990
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
12991
        const char *help = _(vshCmddefGetInfo(def, "help"));
12992
        char buf[256];
12993 12994 12995 12996 12997 12998
        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 已提交
12999
            return false;
13000
        }
K
Karel Zak 已提交
13001

13002
        fputs(_("  NAME\n"), stdout);
13003 13004
        fprintf(stdout, "    %s - %s\n", def->name, help);

13005 13006 13007 13008 13009
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
13010
                const char *fmt = "%s";
13011 13012
                switch (opt->type) {
                case VSH_OT_BOOL:
13013
                    fmt = "[--%s]";
13014 13015
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
13016
                    /* xgettext:c-format */
13017 13018
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
13019 13020
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
13021 13022
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
13023 13024
                    break;
                case VSH_OT_DATA:
13025
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
13026 13027 13028
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
13029 13030
                    fmt = (opt->flag & VSH_OFLAG_REQ) ? _("<%s>...")
                           : _("[<%s>]...");
13031 13032
                    break;
                default:
13033
                    assert(0);
13034
                }
13035
                fputc(' ', stdout);
E
Eric Blake 已提交
13036
                fprintf(stdout, fmt, opt->name);
13037
            }
K
Karel Zak 已提交
13038
        }
13039 13040 13041
        fputc('\n', stdout);

        if (desc[0]) {
13042
            /* Print the description only if it's not empty.  */
13043
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
13044
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
13045
        }
13046

K
Karel Zak 已提交
13047
        if (def->opts) {
13048
            const vshCmdOptDef *opt;
13049
            fputs(_("\n  OPTIONS\n"), stdout);
13050
            for (opt = def->opts; opt->name; opt++) {
13051 13052
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
13053
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
13054 13055
                    break;
                case VSH_OT_INT:
13056 13057 13058
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
13059 13060
                    break;
                case VSH_OT_STRING:
13061
                    /* OT_STRING should never be VSH_OFLAG_REQ */
13062
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
13063 13064
                    break;
                case VSH_OT_DATA:
13065 13066
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
13067 13068 13069
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
13070 13071
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
13072 13073 13074
                default:
                    assert(0);
                }
13075

E
Eric Blake 已提交
13076
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
13077
            }
K
Karel Zak 已提交
13078 13079 13080
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
13081
    return true;
K
Karel Zak 已提交
13082 13083 13084 13085 13086 13087
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
13088 13089 13090
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
13091 13092
    vshCmdOpt *a = arg;

13093
    while (a) {
K
Karel Zak 已提交
13094
        vshCmdOpt *tmp = a;
13095

K
Karel Zak 已提交
13096 13097
        a = a->next;

13098 13099
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
13100 13101 13102 13103
    }
}

static void
13104
vshCommandFree(vshCmd *cmd)
13105
{
K
Karel Zak 已提交
13106 13107
    vshCmd *c = cmd;

13108
    while (c) {
K
Karel Zak 已提交
13109
        vshCmd *tmp = c;
13110

K
Karel Zak 已提交
13111 13112 13113 13114
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
13115
        VIR_FREE(tmp);
K
Karel Zak 已提交
13116 13117 13118
    }
}

E
Eric Blake 已提交
13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129
/**
 * vshCommandOpt:
 * @cmd: parsed command line to search
 * @name: option name to search for
 * @opt: result of the search
 *
 * Look up an option passed to CMD by NAME.  Returns 1 with *OPT set
 * to the option if found, 0 with *OPT set to NULL if the name is
 * valid and the option is not required, -1 with *OPT set to NULL if
 * the option is required but not present, and -2 if NAME is not valid
 * (-2 indicates a programming error).  No error messages are issued.
K
Karel Zak 已提交
13130
 */
E
Eric Blake 已提交
13131 13132
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
13133
{
E
Eric Blake 已提交
13134 13135
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
13136

E
Eric Blake 已提交
13137 13138 13139 13140 13141 13142 13143
    /* See if option is present on command line.  */
    while (candidate) {
        if (STREQ(candidate->def->name, name)) {
            *opt = candidate;
            return 1;
        }
        candidate = candidate->next;
K
Karel Zak 已提交
13144
    }
E
Eric Blake 已提交
13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
            return (valid->flag & VSH_OFLAG_REQ) == 0 ? 0 : -1;
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
13157 13158
}

E
Eric Blake 已提交
13159 13160
/**
 * vshCommandOptInt:
13161 13162 13163 13164 13165 13166 13167
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Convert option to int
 * Return value:
 * >0 if option found and valid (@value updated)
E
Eric Blake 已提交
13168
 * 0 if option not found and not required (@value untouched)
13169
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
13170 13171
 */
static int
13172
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
13173
{
E
Eric Blake 已提交
13174 13175 13176
    vshCmdOpt *arg;
    int ret;
    int num;
13177
    char *end_p = NULL;
13178

E
Eric Blake 已提交
13179 13180 13181 13182 13183 13184 13185
    ret = vshCommandOpt(cmd, name, &arg);
    if (ret <= 0)
        return ret;
    if (!arg->data) {
        /* only possible on bool, but if name is bool, this is a
         * programming bug */
        return -2;
13186
    }
E
Eric Blake 已提交
13187 13188 13189 13190 13191 13192 13193

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
13194 13195
}

13196

E
Eric Blake 已提交
13197 13198 13199 13200 13201 13202
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
13203 13204 13205 13206 13207 13208
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
13209 13210 13211
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
13212 13213
    char *end_p = NULL;

E
Eric Blake 已提交
13214 13215 13216 13217 13218 13219 13220
    ret = vshCommandOpt(cmd, name, &arg);
    if (ret <= 0)
        return ret;
    if (!arg->data) {
        /* only possible on bool, but if name is bool, this is a
         * programming bug */
        return -2;
13221
    }
E
Eric Blake 已提交
13222 13223 13224 13225 13226 13227 13228

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13229 13230 13231
}


13232
/*
E
Eric Blake 已提交
13233 13234 13235 13236 13237
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
13238 13239 13240 13241 13242
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
13243
{
E
Eric Blake 已提交
13244 13245
    vshCmdOpt *arg;
    int ret;
13246
    unsigned long num;
13247 13248
    char *end_p = NULL;

E
Eric Blake 已提交
13249 13250 13251 13252 13253 13254 13255
    ret = vshCommandOpt(cmd, name, &arg);
    if (ret <= 0)
        return ret;
    if (!arg->data) {
        /* only possible on bool, but if name is bool, this is a
         * programming bug */
        return -2;
13256
    }
E
Eric Blake 已提交
13257 13258 13259 13260 13261 13262 13263

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13264 13265
}

E
Eric Blake 已提交
13266 13267 13268 13269 13270 13271
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
13272
 * Returns option as STRING
E
Eric Blake 已提交
13273 13274 13275 13276
 * Return value:
 * >0 if option found and valid (@value updated)
 * 0 if option not found and not required (@value untouched)
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
13277
 */
13278 13279
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
13280
{
E
Eric Blake 已提交
13281 13282 13283 13284 13285 13286 13287 13288 13289 13290
    vshCmdOpt *arg;
    int ret;

    ret = vshCommandOpt(cmd, name, &arg);
    if (ret <= 0)
        return ret;
    if (!arg->data) {
        /* only possible on bool, but if name is bool, this is a
         * programming bug */
        return -2;
13291
    }
13292

E
Eric Blake 已提交
13293 13294 13295 13296 13297
    if (!*arg->data && !(arg->def->flag & VSH_OFLAG_EMPTY_OK)) {
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
13298 13299
}

E
Eric Blake 已提交
13300 13301 13302 13303 13304 13305
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
13306
 * Returns option as long long
13307
 * See vshCommandOptInt()
13308
 */
13309 13310 13311
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
13312
{
E
Eric Blake 已提交
13313 13314
    vshCmdOpt *arg;
    int ret;
13315
    long long num;
13316 13317
    char *end_p = NULL;

E
Eric Blake 已提交
13318 13319 13320 13321 13322 13323 13324
    ret = vshCommandOpt(cmd, name, &arg);
    if (ret <= 0)
        return ret;
    if (!arg->data) {
        /* only possible on bool, but if name is bool, this is a
         * programming bug */
        return -2;
13325
    }
E
Eric Blake 已提交
13326 13327 13328 13329 13330 13331 13332

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13333 13334
}

E
Eric Blake 已提交
13335 13336 13337 13338 13339 13340 13341 13342 13343
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
13344 13345 13346 13347
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
13348 13349
    vshCmdOpt *arg;
    int ret;
13350 13351 13352
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
13353 13354 13355 13356 13357 13358 13359
    ret = vshCommandOpt(cmd, name, &arg);
    if (ret <= 0)
        return ret;
    if (!arg->data) {
        /* only possible on bool, but if name is bool, this is a
         * programming bug */
        return -2;
13360
    }
E
Eric Blake 已提交
13361 13362 13363 13364 13365 13366 13367

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13368 13369 13370
}


E
Eric Blake 已提交
13371 13372 13373 13374 13375 13376 13377 13378 13379
/**
 * vshCommandOptBool:
 * @cmd command reference
 * @name option name
 *
 * Returns true/false if the option exists.  Note that this does NOT
 * validate whether the option is actually boolean, or even whether
 * name is legal; so that this can be used to probe whether a data
 * option is present without actually using that data.
K
Karel Zak 已提交
13380
 */
E
Eric Blake 已提交
13381
static bool
13382
vshCommandOptBool(const vshCmd *cmd, const char *name)
13383
{
E
Eric Blake 已提交
13384 13385 13386
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
13387 13388
}

E
Eric Blake 已提交
13389 13390 13391 13392 13393
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
13394 13395
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
13396
 *
13397
 * Requires that a VSH_OT_ARGV option be last in the
13398 13399
 * list of supported options in CMD->def->opts.
 */
13400 13401
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
13402
{
13403
    opt = opt ? opt->next : cmd->opts;
13404 13405

    while (opt) {
E
Eric Blake 已提交
13406
        if (opt->def->type == VSH_OT_ARGV) {
13407
            return opt;
13408 13409 13410 13411 13412 13413
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
13414 13415 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431
/* 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)
13432
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
13433 13434 13435
                 cmd->def->name, optname);
    return found;
}
13436

K
Karel Zak 已提交
13437
static virDomainPtr
J
Jim Meyering 已提交
13438
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
13439
                      const char **name, int flag)
13440
{
K
Karel Zak 已提交
13441
    virDomainPtr dom = NULL;
13442
    const char *n = NULL;
K
Karel Zak 已提交
13443
    int id;
J
Jim Meyering 已提交
13444 13445 13446
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
13447

13448
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13449 13450
        return NULL;

13451
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13452 13453
             cmd->def->name, optname, n);

K
Karel Zak 已提交
13454 13455
    if (name)
        *name = n;
13456

K
Karel Zak 已提交
13457
    /* try it by ID */
13458
    if (flag & VSH_BYID) {
13459
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
13460 13461
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
13462 13463 13464
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
13465
    }
K
Karel Zak 已提交
13466
    /* try it by UUID */
13467
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
13468
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
13469
                 cmd->def->name, optname);
K
Karel Zak 已提交
13470
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
13471
    }
K
Karel Zak 已提交
13472
    /* try it by NAME */
13473
    if (dom==NULL && (flag & VSH_BYNAME)) {
13474
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
13475
                 cmd->def->name, optname);
K
Karel Zak 已提交
13476
        dom = virDomainLookupByName(ctl->conn, n);
13477
    }
K
Karel Zak 已提交
13478

13479
    if (!dom)
13480
        vshError(ctl, _("failed to get domain '%s'"), n);
13481

K
Karel Zak 已提交
13482 13483 13484
    return dom;
}

13485
static virNetworkPtr
J
Jim Meyering 已提交
13486
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
13487
                       const char **name, int flag)
13488 13489
{
    virNetworkPtr network = NULL;
13490
    const char *n = NULL;
J
Jim Meyering 已提交
13491 13492 13493
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
13494

13495
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13496 13497
        return NULL;

13498
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13499 13500 13501 13502 13503 13504
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
13505
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13506
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
13507
                 cmd->def->name, optname);
13508 13509 13510 13511
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
13512
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
13513 13514 13515 13516 13517
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
13518
        vshError(ctl, _("failed to get network '%s'"), n);
13519 13520 13521 13522

    return network;
}

13523 13524 13525

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
13526
                        const char **name, int flag)
13527 13528
{
    virNWFilterPtr nwfilter = NULL;
13529
    const char *n = NULL;
13530 13531 13532 13533
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13534
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13535 13536
        return NULL;

13537
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13538 13539 13540 13541 13542 13543 13544
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13545
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
13546 13547 13548 13549 13550
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
13551
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
13552 13553 13554 13555 13556 13557 13558 13559 13560 13561
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

13562 13563
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
13564
                         const char **name, int flag)
13565 13566
{
    virInterfacePtr iface = NULL;
13567
    const char *n = NULL;
13568 13569 13570 13571
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13572
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13573 13574
        return NULL;

13575
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13576 13577 13578 13579 13580 13581
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
13582
    if ((flag & VSH_BYNAME)) {
13583
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
13584 13585 13586 13587 13588
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
13589
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
13590 13591 13592 13593 13594
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
13595
        vshError(ctl, _("failed to get interface '%s'"), n);
13596 13597 13598 13599

    return iface;
}

13600
static virStoragePoolPtr
13601
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
13602
                    const char **name, int flag)
13603 13604
{
    virStoragePoolPtr pool = NULL;
13605
    const char *n = NULL;
13606

13607
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13608 13609
        return NULL;

13610
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13611 13612 13613 13614 13615 13616
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
13617
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13618
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
13619
                 cmd->def->name, optname);
13620 13621 13622
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
13623
    if (pool == NULL && (flag & VSH_BYNAME)) {
13624
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
13625 13626 13627 13628 13629
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
13630
        vshError(ctl, _("failed to get pool '%s'"), n);
13631 13632 13633 13634 13635

    return pool;
}

static virStorageVolPtr
13636
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
13637 13638
                   const char *optname,
                   const char *pooloptname,
13639
                   const char **name, int flag)
13640 13641 13642
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
13643
    const char *n = NULL, *p = NULL;
13644

13645
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13646 13647
        return NULL;

13648
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
13649
        vshError(ctl, "%s", _("missing option"));
13650
        return NULL;
13651
    }
13652 13653 13654 13655

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

13656
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
13657 13658 13659 13660 13661
             cmd->def->name, optname, n);

    if (name)
        *name = n;

13662
    /* try it by name */
13663
    if (pool && (flag & VSH_BYNAME)) {
13664
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
13665 13666 13667
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
13668
    /* try it by key */
13669
    if (vol == NULL && (flag & VSH_BYUUID)) {
13670
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
13671 13672 13673
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
13674
    /* try it by path */
13675
    if (vol == NULL && (flag & VSH_BYUUID)) {
13676
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
13677 13678 13679 13680 13681
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
13682
        vshError(ctl, _("failed to get vol '%s'"), n);
13683 13684 13685 13686 13687 13688 13689

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

13690
static virSecretPtr
13691
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
13692 13693
{
    virSecretPtr secret = NULL;
13694
    const char *n = NULL;
13695 13696 13697 13698 13699
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13700
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13701 13702
        return NULL;

13703 13704
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
13705 13706 13707 13708 13709 13710 13711

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
13712
        vshError(ctl, _("failed to get secret '%s'"), n);
13713 13714 13715 13716

    return secret;
}

K
Karel Zak 已提交
13717 13718 13719
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
13720
static bool
13721
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
13722
{
E
Eric Blake 已提交
13723
    bool ret = true;
13724 13725

    while (cmd) {
K
Karel Zak 已提交
13726
        struct timeval before, after;
13727
        bool enable_timing = ctl->timing;
13728

13729 13730
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
13731 13732
            vshReconnect(ctl);

13733
        if (enable_timing)
K
Karel Zak 已提交
13734
            GETTIMEOFDAY(&before);
13735

K
Karel Zak 已提交
13736 13737
        ret = cmd->def->handler(ctl, cmd);

13738
        if (enable_timing)
K
Karel Zak 已提交
13739
            GETTIMEOFDAY(&after);
13740

13741
        if (!ret)
J
John Levon 已提交
13742 13743
            virshReportError(ctl);

13744
        /* try to automatically catch disconnections */
13745
        if (!ret &&
13746 13747 13748 13749 13750 13751 13752 13753 13754
            ((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);

13755
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
13756 13757
            return ret;

13758
        if (enable_timing)
13759
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
13760 13761
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
13762
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
13763 13764 13765 13766 13767 13768
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
13769
 * Command parsing
K
Karel Zak 已提交
13770 13771 13772
 * ---------------
 */

13773 13774 13775 13776 13777 13778 13779 13780 13781 13782
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 已提交
13783
    /* vshCommandStringGetArg() */
13784
    char *pos;
L
Lai Jiangshan 已提交
13785 13786 13787
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
13788 13789
} vshCommandParser;

E
Eric Blake 已提交
13790
static bool
13791
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
13792
{
K
Karel Zak 已提交
13793 13794 13795
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
13796

K
Karel Zak 已提交
13797 13798 13799 13800
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
13801

13802
    while (1) {
K
Karel Zak 已提交
13803
        vshCmdOpt *last = NULL;
13804
        const vshCmdDef *cmd = NULL;
13805
        vshCommandToken tk;
L
Lai Jiangshan 已提交
13806
        bool data_only = false;
13807 13808 13809
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
13810

K
Karel Zak 已提交
13811
        first = NULL;
13812

13813
        while (1) {
13814
            const vshCmdOptDef *opt = NULL;
13815

K
Karel Zak 已提交
13816
            tkdata = NULL;
13817
            tk = parser->getNextArg(ctl, parser, &tkdata);
13818 13819

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
13820
                goto syntaxError;
H
Hu Tao 已提交
13821 13822
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
13823
                break;
H
Hu Tao 已提交
13824
            }
13825 13826

            if (cmd == NULL) {
K
Karel Zak 已提交
13827 13828
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
13829
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
13830
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
13831
                }
13832 13833 13834 13835 13836 13837 13838
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
13839
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
13840 13841 13842 13843
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
13844 13845 13846 13847 13848
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
13849 13850
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
13851
                    VIR_FREE(optstr);
K
Karel Zak 已提交
13852 13853
                    goto syntaxError;
                }
13854
                VIR_FREE(tkdata);
K
Karel Zak 已提交
13855 13856 13857

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
13858 13859 13860
                    if (optstr)
                        tkdata = optstr;
                    else
13861
                        tk = parser->getNextArg(ctl, parser, &tkdata);
13862
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
13863
                        goto syntaxError;
13864
                    if (tk != VSH_TK_ARG) {
13865
                        vshError(ctl,
13866
                                 _("expected syntax: --%s <%s>"),
13867 13868
                                 opt->name,
                                 opt->type ==
13869
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
13870 13871
                        goto syntaxError;
                    }
13872
                    opts_need_arg &= ~opts_seen;
13873 13874 13875 13876 13877 13878 13879 13880
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
13881
                }
L
Lai Jiangshan 已提交
13882 13883 13884 13885
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
13886
            } else {
L
Lai Jiangshan 已提交
13887
get_data:
13888 13889
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
13890
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
13891 13892 13893 13894 13895
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
13896
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
13897

K
Karel Zak 已提交
13898 13899 13900 13901
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
13902

K
Karel Zak 已提交
13903 13904 13905 13906 13907
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
13908

13909
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
13910 13911
                         cmd->name,
                         opt->name,
13912 13913
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
13914 13915
            }
        }
13916

D
Daniel Veillard 已提交
13917
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
13918
        if (cmd) {
13919
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
13920

K
Karel Zak 已提交
13921 13922 13923 13924
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

13925
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
13926
                VIR_FREE(c);
13927
                goto syntaxError;
13928
            }
13929

K
Karel Zak 已提交
13930 13931 13932 13933 13934 13935
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
13936 13937 13938

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
13939
    }
13940

E
Eric Blake 已提交
13941
    return true;
K
Karel Zak 已提交
13942

13943
 syntaxError:
13944
    if (ctl->cmd) {
K
Karel Zak 已提交
13945
        vshCommandFree(ctl->cmd);
13946 13947
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
13948 13949
    if (first)
        vshCommandOptFree(first);
13950
    VIR_FREE(tkdata);
E
Eric Blake 已提交
13951
    return false;
K
Karel Zak 已提交
13952 13953
}

13954 13955 13956 13957 13958 13959 13960 13961 13962 13963 13964 13965 13966 13967 13968 13969 13970 13971
/* --------------------
 * 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 已提交
13972 13973
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
13974 13975 13976 13977
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
13978
        return false;
13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050

    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 已提交
14051 14052
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
14053 14054 14055 14056
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
14057
        return false;
14058 14059 14060 14061 14062 14063

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
14064
/* ---------------
14065
 * Misc utils
K
Karel Zak 已提交
14066 14067
 * ---------------
 */
14068 14069 14070 14071 14072 14073 14074 14075 14076 14077 14078 14079 14080 14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095
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 已提交
14096
static const char *
14097 14098
vshDomainStateToString(int state)
{
14099
    switch ((virDomainState) state) {
14100
    case VIR_DOMAIN_RUNNING:
14101
        return N_("running");
14102
    case VIR_DOMAIN_BLOCKED:
14103
        return N_("idle");
14104
    case VIR_DOMAIN_PAUSED:
14105
        return N_("paused");
14106
    case VIR_DOMAIN_SHUTDOWN:
14107
        return N_("in shutdown");
14108
    case VIR_DOMAIN_SHUTOFF:
14109
        return N_("shut off");
14110
    case VIR_DOMAIN_CRASHED:
14111
        return N_("crashed");
14112
    case VIR_DOMAIN_NOSTATE:
14113
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
14114
    }
14115
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
14116 14117
}

14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196 14197 14198 14199 14200 14201 14202 14203 14204 14205 14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218
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");
}

14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235
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");
}

14236 14237 14238 14239
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
14240
    case VIR_VCPU_OFFLINE:
14241
        return N_("offline");
14242
    case VIR_VCPU_BLOCKED:
14243
        return N_("idle");
14244
    case VIR_VCPU_RUNNING:
14245
        return N_("running");
14246
    default:
14247
        ;/*FALLTHROUGH*/
14248
    }
14249
    return N_("no state");
14250 14251
}

E
Eric Blake 已提交
14252
static bool
14253
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
14254
{
14255 14256
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
14257 14258
     */
    if (!conn) {
14259
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
14260
        return false;
K
Karel Zak 已提交
14261
    }
E
Eric Blake 已提交
14262
    return true;
K
Karel Zak 已提交
14263 14264
}

K
Karel Zak 已提交
14265
static void
14266
vshDebug(vshControl *ctl, int level, const char *format, ...)
14267
{
K
Karel Zak 已提交
14268
    va_list ap;
14269
    char *str;
K
Karel Zak 已提交
14270

14271 14272 14273 14274 14275 14276 14277
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

14278
    va_start(ap, format);
14279
    vshOutputLogFile(ctl, level, format, ap);
14280 14281
    va_end(ap);

K
Karel Zak 已提交
14282
    va_start(ap, format);
14283 14284 14285 14286 14287
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
14288
    va_end(ap);
14289 14290
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
14291 14292 14293
}

static void
14294
vshPrintExtra(vshControl *ctl, const char *format, ...)
14295
{
K
Karel Zak 已提交
14296
    va_list ap;
14297
    char *str;
14298

14299
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
14300
        return;
14301

K
Karel Zak 已提交
14302
    va_start(ap, format);
14303 14304 14305 14306 14307
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
14308
    va_end(ap);
14309
    fputs(str, stdout);
14310
    VIR_FREE(str);
K
Karel Zak 已提交
14311 14312
}

K
Karel Zak 已提交
14313

K
Karel Zak 已提交
14314
static void
14315
vshError(vshControl *ctl, const char *format, ...)
14316
{
K
Karel Zak 已提交
14317
    va_list ap;
14318
    char *str;
14319

14320 14321 14322 14323 14324
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
14325

14326
    fputs(_("error: "), stderr);
14327

K
Karel Zak 已提交
14328
    va_start(ap, format);
14329 14330 14331
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
14332 14333
    va_end(ap);

14334 14335
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
14336 14337
}

14338

K
Karel Zak 已提交
14339
/*
14340
 * Initialize connection.
K
Karel Zak 已提交
14341
 */
E
Eric Blake 已提交
14342
static bool
14343
vshInit(vshControl *ctl)
14344
{
14345 14346
    char *debugEnv;

K
Karel Zak 已提交
14347
    if (ctl->conn)
E
Eric Blake 已提交
14348
        return false;
K
Karel Zak 已提交
14349

J
Jiri Denemark 已提交
14350
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
14351 14352 14353
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
14354 14355 14356
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
14357 14358
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
14359 14360
            } else {
                ctl->debug = debug;
14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

14373 14374
    vshOpenLogFile(ctl);

14375 14376
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
14377

14378 14379 14380
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

14381
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
14382
        return false;
14383

14384 14385 14386 14387
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
14388

14389 14390 14391 14392 14393 14394 14395 14396 14397 14398 14399
        /* 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;
        }
14400
    }
K
Karel Zak 已提交
14401

E
Eric Blake 已提交
14402
    return true;
K
Karel Zak 已提交
14403 14404
}

14405 14406
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

14407 14408 14409 14410 14411 14412 14413 14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425
/**
 * 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:
14426
                vshError(ctl, "%s",
J
Jim Meyering 已提交
14427
                         _("failed to get the log file information"));
14428
                exit(EXIT_FAILURE);
14429 14430 14431
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
14432 14433
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
14434 14435 14436 14437
        }
    }

    /* log file open */
14438
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
14439
        vshError(ctl, "%s",
J
Jim Meyering 已提交
14440
                 _("failed to open the log file. check the log file path"));
14441
        exit(EXIT_FAILURE);
14442 14443 14444 14445 14446 14447 14448 14449 14450
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
14451 14452
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
14453
{
14454 14455 14456
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
14457 14458 14459 14460 14461 14462 14463 14464 14465 14466 14467 14468 14469 14470
    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);
14471
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
14472 14473 14474 14475 14476 14477
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
14478 14479
                      SIGN_NAME,
                      (int) getpid());
14480 14481 14482 14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499
    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;
    }
14500 14501 14502
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
14503

14504 14505
    if (virBufferError(&buf))
        goto error;
14506

14507 14508 14509 14510 14511
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
14512
    }
14513

14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524
    /* 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);
14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
14536 14537 14538
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
14539 14540 14541
    }

    if (ctl->logfile) {
14542
        VIR_FREE(ctl->logfile);
14543 14544 14545 14546
        ctl->logfile = NULL;
    }
}

14547
#ifdef USE_READLINE
14548

K
Karel Zak 已提交
14549 14550 14551 14552 14553
/* -----------------
 * Readline stuff
 * -----------------
 */

14554
/*
K
Karel Zak 已提交
14555 14556
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
14557
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
14558 14559
 */
static char *
14560 14561
vshReadlineCommandGenerator(const char *text, int state)
{
14562
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
14563
    const char *name;
14564 14565
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
14566 14567

    if (!state) {
14568 14569
        grp_list_index = 0;
        cmd_list_index = 0;
14570
        len = strlen(text);
K
Karel Zak 已提交
14571 14572
    }

14573 14574
    grp = cmdGroups;

K
Karel Zak 已提交
14575
    /* Return the next name which partially matches from the
14576
     * command list.
K
Karel Zak 已提交
14577
     */
14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591
    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 已提交
14592 14593 14594 14595 14596 14597 14598
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
14599 14600
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
14601
    static int list_index, len;
14602
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
14603
    const char *name;
K
Karel Zak 已提交
14604 14605 14606 14607 14608 14609 14610 14611 14612

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

14613
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
14614
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
14615 14616 14617

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
14618
        len = strlen(text);
14619
        VIR_FREE(cmdname);
K
Karel Zak 已提交
14620 14621 14622 14623
    }

    if (!cmd)
        return NULL;
14624

14625 14626 14627
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
14628
    while ((name = cmd->opts[list_index].name)) {
14629
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
14630
        char *res;
14631

K
Karel Zak 已提交
14632
        list_index++;
14633

14634
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
14635 14636
            /* ignore non --option */
            continue;
14637

K
Karel Zak 已提交
14638
        if (len > 2) {
14639
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
14640 14641
                continue;
        }
14642
        res = vshMalloc(NULL, strlen(name) + 3);
14643
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
14644 14645 14646 14647 14648 14649 14650 14651
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
14652 14653 14654
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
14655 14656
    char **matches = (char **) NULL;

14657
    if (start == 0)
K
Karel Zak 已提交
14658
        /* command name generator */
14659
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
14660 14661
    else
        /* commands options */
14662
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
14663 14664 14665 14666
    return matches;
}


14667 14668
static int
vshReadlineInit(vshControl *ctl)
14669
{
14670 14671
    char *userdir = NULL;

K
Karel Zak 已提交
14672 14673 14674 14675 14676
    /* 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;
14677 14678 14679

    /* Limit the total size of the history buffer */
    stifle_history(500);
14680 14681

    /* Prepare to read/write history from/to the ~/.virsh/history file */
14682
    userdir = virGetUserDirectory(getuid());
14683

14684 14685
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
14686
        return -1;
14687
    }
14688 14689 14690

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
14691
        VIR_FREE(userdir);
14692 14693 14694 14695 14696
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
14697
        VIR_FREE(userdir);
14698 14699 14700
        return -1;
    }

14701
    VIR_FREE(userdir);
14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719

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

14720 14721
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
14722 14723
}

14724 14725 14726 14727 14728 14729
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

14730
#else /* !USE_READLINE */
14731

14732 14733 14734 14735 14736 14737 14738
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

14739
static void
14740
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763
{
    /* 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);
}

14764
#endif /* !USE_READLINE */
14765

K
Karel Zak 已提交
14766
/*
J
Jim Meyering 已提交
14767
 * Deinitialize virsh
K
Karel Zak 已提交
14768
 */
E
Eric Blake 已提交
14769
static bool
14770
vshDeinit(vshControl *ctl)
14771
{
14772
    vshReadlineDeinit(ctl);
14773
    vshCloseLogFile(ctl);
14774
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
14775
    if (ctl->conn) {
14776 14777 14778
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
14779 14780
        }
    }
D
Daniel P. Berrange 已提交
14781 14782
    virResetLastError();

E
Eric Blake 已提交
14783
    return true;
K
Karel Zak 已提交
14784
}
14785

K
Karel Zak 已提交
14786 14787 14788 14789
/*
 * Print usage
 */
static void
14790
vshUsage(void)
14791
{
14792
    const vshCmdGrp *grp;
14793
    const vshCmdDef *cmd;
14794

L
Lai Jiangshan 已提交
14795 14796
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
14797 14798 14799
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
14800
                      "    -d | --debug <num>      debug level [0-4]\n"
14801 14802 14803 14804
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
14805
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
14806
                      "    -V | --version=long     version and full options\n\n"
14807
                      "  commands (non interactive mode):\n\n"), progname, progname);
14808

14809 14810
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
14811

14812 14813 14814 14815 14816 14817 14818 14819 14820
        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"));
14821 14822 14823
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
14824 14825
}

14826 14827 14828 14829 14830 14831 14832 14833 14834 14835
/*
 * 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 已提交
14836 14837
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872
#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 已提交
14873
    vshPrint(ctl, "%s", _(" Networking:"));
14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899
#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 已提交
14900
    vshPrint(ctl, "%s", _(" Storage:"));
14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923
#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 已提交
14924
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
14925
#ifdef WITH_SECDRIVER_APPARMOR
14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947 14948
    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 已提交
14949 14950 14951 14952
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
14953
static bool
14954
vshParseArgv(vshControl *ctl, int argc, char **argv)
14955
{
14956 14957
    bool help = false;
    int arg;
K
Karel Zak 已提交
14958
    struct option opt[] = {
E
Eric Blake 已提交
14959 14960 14961 14962 14963 14964 14965 14966 14967
        {"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}
14968 14969
    };

14970 14971 14972
    /* 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. */
14973
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
14974
        switch (arg) {
14975
        case 'd':
D
Daniel Veillard 已提交
14976
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
14977
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
14978 14979
                exit(EXIT_FAILURE);
            }
14980 14981
            break;
        case 'h':
14982
            help = true;
14983 14984
            break;
        case 'q':
E
Eric Blake 已提交
14985
            ctl->quiet = true;
14986 14987
            break;
        case 't':
E
Eric Blake 已提交
14988
            ctl->timing = true;
14989 14990 14991 14992
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
14993 14994 14995 14996 14997 14998
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
14999 15000 15001
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
15002
        case 'r':
E
Eric Blake 已提交
15003
            ctl->readonly = true;
15004
            break;
15005 15006 15007
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
15008
        default:
15009 15010
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
15011 15012 15013 15014
        }
    }

    if (help) {
15015 15016
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
15017 15018
            exit(EXIT_FAILURE);
        }
15019 15020 15021

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
15022
        exit(EXIT_SUCCESS);
15023 15024
    }

15025
    if (argc > optind) {
K
Karel Zak 已提交
15026
        /* parse command */
E
Eric Blake 已提交
15027
        ctl->imode = false;
15028
        if (argc - optind == 1) {
15029
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
15030
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
15031
        } else {
15032
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
15033 15034
        }
    }
E
Eric Blake 已提交
15035
    return true;
K
Karel Zak 已提交
15036 15037
}

15038 15039 15040 15041
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
15042
    char *defaultConn;
E
Eric Blake 已提交
15043
    bool ret = true;
K
Karel Zak 已提交
15044

15045 15046 15047
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
15048
    ctl->debug = VSH_DEBUG_DEFAULT;
15049

15050 15051
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
15052
        /* failure to setup locale is not fatal */
15053
    }
15054
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
15055
        perror("bindtextdomain");
E
Eric Blake 已提交
15056
        return EXIT_FAILURE;
15057
    }
15058
    if (!textdomain(PACKAGE)) {
15059
        perror("textdomain");
E
Eric Blake 已提交
15060
        return EXIT_FAILURE;
15061 15062
    }

15063 15064 15065 15066 15067
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

15068
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
15069 15070 15071
        progname = argv[0];
    else
        progname++;
15072

15073
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
15074
        ctl->name = vshStrdup(ctl, defaultConn);
15075 15076
    }

D
Daniel P. Berrange 已提交
15077 15078
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
15079
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
15080
    }
15081

D
Daniel P. Berrange 已提交
15082 15083
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
15084
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
15085
    }
15086

K
Karel Zak 已提交
15087
    if (!ctl->imode) {
15088
        ret = vshCommandRun(ctl, ctl->cmd);
15089
    } else {
K
Karel Zak 已提交
15090 15091
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
15092
            vshPrint(ctl,
15093
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
15094
                     progname);
J
Jim Meyering 已提交
15095
            vshPrint(ctl, "%s",
15096
                     _("Type:  'help' for help with commands\n"
15097
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
15098
        }
15099 15100 15101 15102 15103 15104

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
15105
        do {
15106
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
15107
            ctl->cmdstr =
15108
                vshReadline(ctl, prompt);
15109 15110
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
15111
            if (*ctl->cmdstr) {
15112
#if USE_READLINE
K
Karel Zak 已提交
15113
                add_history(ctl->cmdstr);
15114
#endif
15115
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
15116 15117
                    vshCommandRun(ctl, ctl->cmd);
            }
15118
            VIR_FREE(ctl->cmdstr);
15119
        } while (ctl->imode);
K
Karel Zak 已提交
15120

15121 15122
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
15123
    }
15124

K
Karel Zak 已提交
15125 15126
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
15127
}