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

13
#include <config.h>
14

15
#include <stdio.h>
K
Karel Zak 已提交
16 17 18
#include <stdlib.h>
#include <string.h>
#include <stdarg.h>
19
#include <unistd.h>
20
#include <errno.h>
K
Karel Zak 已提交
21
#include <getopt.h>
22
#include <sys/types.h>
K
Karel Zak 已提交
23
#include <sys/time.h>
E
Eric Blake 已提交
24
#include <sys/wait.h>
J
Jim Meyering 已提交
25
#include "c-ctype.h"
26
#include <fcntl.h>
27
#include <locale.h>
28
#include <time.h>
29
#include <limits.h>
30
#include <assert.h>
31
#include <sys/stat.h>
32
#include <inttypes.h>
33
#include <signal.h>
34
#include <poll.h>
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 4007
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
    unsigned int i = 0;
4008
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4009
    bool ret = false;
H
Hu Tao 已提交
4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026
    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;
    }
4027 4028

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4032
        return false;
4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

4208 4209 4210
    if (min_guarantee)
        nparams++;

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

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

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

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

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

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

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

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

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

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

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

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

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

4352 4353 4354 4355 4356
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
4357
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
4358 4359 4360 4361 4362 4363 4364 4365 4366 4367
    {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
4368
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
4369 4370 4371 4372
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
4373 4374
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
4375 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
    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;

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

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499
/*
 * "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;
4500 4501
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
4502 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
    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;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    return ret;
}

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

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

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

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

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

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

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

    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

4823
static const vshCmdOptDef opts_migrate[] = {
4824 4825 4826 4827 4828 4829 4830
    {"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")},
4831 4832
    {"copy-storage-all", VSH_OT_BOOL, 0, N_("migration with non-shared storage with full disk copy")},
    {"copy-storage-inc", VSH_OT_BOOL, 0, N_("migration with non-shared storage with incremental copy (same base image shared between source and destination)")},
W
Wen Congyang 已提交
4833
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
4834
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4835
    {"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)")},
4836 4837
    {"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 已提交
4838
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
4839
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
4840 4841 4842
    {NULL, 0, 0, NULL}
};

4843 4844 4845 4846 4847 4848 4849 4850
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

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

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

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

J
Jim Meyering 已提交
4873
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
4874
        goto out;
4875

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

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

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

C
Chris Lalancette 已提交
4895 4896 4897 4898 4899
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

4900 4901 4902
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

4903 4904 4905 4906 4907 4908
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

4909 4910 4911 4912 4913 4914

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


4915 4916 4917 4918
    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. */
4919

4920
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
4921
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
4922
            goto out;
4923
        }
4924

4925
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
4926
            ret = '0';
4927 4928 4929 4930 4931 4932
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
4933
        if (!dconn) goto out;
4934

4935
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
4936 4937
        if (ddom) {
            virDomainFree(ddom);
4938
            ret = '0';
4939 4940 4941
        }
        virConnectClose (dconn);
    }
4942

4943 4944 4945
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
4946
    if (dom) virDomainFree (dom);
4947
    VIR_FREE(xml);
4948 4949 4950
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

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

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

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

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
4998 4999

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

W
Wen Congyang 已提交
5002 5003 5004
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

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

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

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
5075
            functionReturn = false;
W
Wen Congyang 已提交
5076 5077 5078
            break;
        }

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

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

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
5107
    return functionReturn;
5108 5109
}

5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120
/*
 * "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")},
5121
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
5122 5123 5124
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5125
static bool
5126 5127 5128
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
5129
    long long downtime = 0;
E
Eric Blake 已提交
5130
    bool ret = false;
5131

5132
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5133
        return false;
5134 5135

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

5138 5139
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
5140 5141 5142 5143 5144 5145 5146
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
5147
    ret = true;
5148 5149 5150 5151 5152 5153

done:
    virDomainFree(dom);
    return ret;
}

5154 5155 5156 5157 5158 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
/*
 * "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;
}

5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 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
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;
}


5321 5322 5323
/*
 * "net-autostart" command
 */
5324
static const vshCmdInfo info_network_autostart[] = {
5325
    {"help", N_("autostart a network")},
5326
    {"desc",
5327
     N_("Configure a network to be automatically started at boot.")},
5328 5329 5330
    {NULL, NULL}
};

5331
static const vshCmdOptDef opts_network_autostart[] = {
5332 5333
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5334 5335 5336
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5337
static bool
5338
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
5339 5340
{
    virNetworkPtr network;
5341
    const char *name;
5342 5343
    int autostart;

5344
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5345
        return false;
5346

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

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
5353
        if (autostart)
5354
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
5355
        else
5356
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
5357
        virNetworkFree(network);
E
Eric Blake 已提交
5358
        return false;
5359 5360
    }

5361
    if (autostart)
5362
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
5363
    else
5364
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
5365

L
Laine Stump 已提交
5366
    virNetworkFree(network);
E
Eric Blake 已提交
5367
    return true;
5368
}
K
Karel Zak 已提交
5369

5370 5371 5372
/*
 * "net-create" command
 */
5373
static const vshCmdInfo info_network_create[] = {
5374 5375
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
5376 5377 5378
    {NULL, NULL}
};

5379
static const vshCmdOptDef opts_network_create[] = {
5380
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5381 5382 5383
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5384
static bool
5385
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
5386 5387
{
    virNetworkPtr network;
5388
    const char *from = NULL;
E
Eric Blake 已提交
5389
    bool ret = true;
5390
    char *buffer;
5391

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

5395
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5396
        return false;
5397

5398
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5399
        return false;
5400 5401

    network = virNetworkCreateXML(ctl->conn, buffer);
5402
    VIR_FREE(buffer);
5403

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


/*
 * "net-define" command
 */
5419
static const vshCmdInfo info_network_define[] = {
5420 5421
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
5422 5423 5424
    {NULL, NULL}
};

5425
static const vshCmdOptDef opts_network_define[] = {
5426
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5427 5428 5429
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5430
static bool
5431
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
5432 5433
{
    virNetworkPtr network;
5434
    const char *from = NULL;
E
Eric Blake 已提交
5435
    bool ret = true;
5436
    char *buffer;
5437

5438
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5439
        return false;
5440

5441
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5442
        return false;
5443

5444
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5445
        return false;
5446 5447

    network = virNetworkDefineXML(ctl->conn, buffer);
5448
    VIR_FREE(buffer);
5449

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


/*
 * "net-destroy" command
 */
5465
static const vshCmdInfo info_network_destroy[] = {
5466 5467
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
5468 5469 5470
    {NULL, NULL}
};

5471
static const vshCmdOptDef opts_network_destroy[] = {
5472
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5473 5474 5475
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5476
static bool
5477
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
5478 5479
{
    virNetworkPtr network;
E
Eric Blake 已提交
5480
    bool ret = true;
5481
    const char *name;
5482

5483
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5484
        return false;
5485

J
Jim Meyering 已提交
5486
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5487
        return false;
5488 5489 5490 5491

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

5496
    virNetworkFree(network);
5497 5498 5499 5500 5501 5502 5503
    return ret;
}


/*
 * "net-dumpxml" command
 */
5504
static const vshCmdInfo info_network_dumpxml[] = {
5505 5506
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
5507 5508 5509
    {NULL, NULL}
};

5510
static const vshCmdOptDef opts_network_dumpxml[] = {
5511
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5512 5513 5514
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5515
static bool
5516
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
5517 5518
{
    virNetworkPtr network;
E
Eric Blake 已提交
5519
    bool ret = true;
5520 5521
    char *dump;

5522
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5523
        return false;
5524

J
Jim Meyering 已提交
5525
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
5526
        return false;
5527 5528 5529

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
5530
        vshPrint(ctl, "%s", dump);
5531
        VIR_FREE(dump);
5532
    } else {
E
Eric Blake 已提交
5533
        ret = false;
5534 5535 5536 5537 5538 5539
    }

    virNetworkFree(network);
    return ret;
}

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

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

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

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

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

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

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

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

    virNetworkFree(network);
E
Eric Blake 已提交
5596
    return true;
O
Osier Yang 已提交
5597
}
5598

5599 5600 5601 5602
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
5603 5604
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
5605 5606 5607 5608
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
5609
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5610 5611 5612
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5613
static bool
5614 5615
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5616
    bool ret = false;
5617 5618 5619 5620 5621
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
5622
    int flags = VIR_INTERFACE_XML_INACTIVE;
5623

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

cleanup:
    if (iface)
        virInterfaceFree (iface);

5684 5685 5686
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
5687 5688 5689

    if (tmp) {
        unlink (tmp);
5690
        VIR_FREE(tmp);
5691 5692 5693 5694 5695
    }

    return ret;
}

5696 5697 5698
/*
 * "net-list" command
 */
5699
static const vshCmdInfo info_network_list[] = {
5700 5701
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
5702 5703 5704
    {NULL, NULL}
};

5705
static const vshCmdOptDef opts_network_list[] = {
5706 5707
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
5708 5709 5710
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5711
static bool
5712
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5713 5714 5715 5716 5717
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
5718
    char **activeNames = NULL, **inactiveNames = NULL;
5719 5720
    inactive |= all;

5721
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5722
        return false;
5723 5724

    if (active) {
5725 5726
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
5727
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
5728
            return false;
5729
        }
5730
        if (maxactive) {
5731
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
5732

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

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

5753 5754 5755
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
5756
                vshError(ctl, "%s", _("Failed to list inactive networks"));
5757 5758
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5759
                return false;
5760
            }
5761

5762 5763
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
5764
    }
5765 5766
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
5767
    vshPrintExtra(ctl, "-----------------------------------------\n");
5768 5769

    for (i = 0; i < maxactive; i++) {
5770 5771
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
5772 5773
        const char *autostartStr;
        int autostart = 0;
5774 5775 5776

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5777
            VIR_FREE(activeNames[i]);
5778
            continue;
5779
        }
5780

5781 5782 5783
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5784
            autostartStr = autostart ? _("yes") : _("no");
5785 5786 5787 5788 5789

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
5790
        virNetworkFree(network);
5791
        VIR_FREE(activeNames[i]);
5792 5793 5794
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
5795 5796
        const char *autostartStr;
        int autostart = 0;
5797 5798 5799

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5800
            VIR_FREE(inactiveNames[i]);
5801
            continue;
5802
        }
5803

5804 5805 5806
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5807
            autostartStr = autostart ? _("yes") : _("no");
5808

5809
        vshPrint(ctl, "%-20s %-10s %-10s\n",
5810 5811 5812
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
5813 5814

        virNetworkFree(network);
5815
        VIR_FREE(inactiveNames[i]);
5816
    }
5817 5818
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5819
    return true;
5820 5821 5822 5823 5824 5825
}


/*
 * "net-name" command
 */
5826
static const vshCmdInfo info_network_name[] = {
5827
    {"help", N_("convert a network UUID to network name")},
5828
    {"desc", ""},
5829 5830 5831
    {NULL, NULL}
};

5832
static const vshCmdOptDef opts_network_name[] = {
5833
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
5834 5835 5836
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5837
static bool
5838
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
5839 5840 5841
{
    virNetworkPtr network;

5842
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5843
        return false;
J
Jim Meyering 已提交
5844
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5845
                                           VSH_BYUUID)))
E
Eric Blake 已提交
5846
        return false;
5847 5848 5849

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
5850
    return true;
5851 5852 5853 5854 5855 5856
}


/*
 * "net-start" command
 */
5857
static const vshCmdInfo info_network_start[] = {
5858 5859
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
5860 5861 5862
    {NULL, NULL}
};

5863
static const vshCmdOptDef opts_network_start[] = {
5864
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
5865 5866 5867
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5868
static bool
5869
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
5870 5871
{
    virNetworkPtr network;
E
Eric Blake 已提交
5872
    bool ret = true;
5873

5874
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5875
        return false;
5876

J
Jim Meyering 已提交
5877
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
5878
         return false;
5879 5880 5881

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


/*
 * "net-undefine" command
 */
5896
static const vshCmdInfo info_network_undefine[] = {
5897 5898
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
5899 5900 5901
    {NULL, NULL}
};

5902
static const vshCmdOptDef opts_network_undefine[] = {
5903
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5904 5905 5906
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5907
static bool
5908
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
5909 5910
{
    virNetworkPtr network;
E
Eric Blake 已提交
5911
    bool ret = true;
5912
    const char *name;
5913

5914
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5915
        return false;
5916

J
Jim Meyering 已提交
5917
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5918
        return false;
5919 5920 5921 5922

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

L
Laine Stump 已提交
5927
    virNetworkFree(network);
5928 5929 5930 5931 5932 5933 5934
    return ret;
}


/*
 * "net-uuid" command
 */
5935
static const vshCmdInfo info_network_uuid[] = {
5936
    {"help", N_("convert a network name to network UUID")},
5937
    {"desc", ""},
5938 5939 5940
    {NULL, NULL}
};

5941
static const vshCmdOptDef opts_network_uuid[] = {
5942
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
5943 5944 5945
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5946
static bool
5947
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
5948 5949 5950 5951
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

5952
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5953
        return false;
5954

J
Jim Meyering 已提交
5955
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5956
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5957
        return false;
5958 5959 5960 5961

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

L
Laine Stump 已提交
5964
    virNetworkFree(network);
E
Eric Blake 已提交
5965
    return true;
5966 5967 5968
}


5969 5970 5971 5972 5973
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
5974 5975
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
5976 5977 5978 5979
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
5980 5981
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
5982 5983
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
5984
static bool
5985 5986 5987 5988 5989 5990 5991 5992 5993
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;

5994
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5995
        return false;
5996 5997 5998 5999

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
6000
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
6001
            return false;
6002 6003 6004 6005 6006 6007
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
6008
                vshError(ctl, "%s", _("Failed to list active interfaces"));
6009
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6010
                return false;
6011 6012 6013 6014 6015 6016 6017 6018
            }

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

6026 6027 6028
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
6029
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6030 6031
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6032
                return false;
6033 6034 6035 6036 6037
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
6038 6039
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
6040 6041 6042
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
6043 6044
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
6045 6046 6047

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6048
            VIR_FREE(activeNames[i]);
6049 6050 6051 6052 6053 6054 6055 6056
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6057
        VIR_FREE(activeNames[i]);
6058 6059
    }
    for (i = 0; i < maxinactive; i++) {
6060 6061
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
6062 6063 6064

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6065
            VIR_FREE(inactiveNames[i]);
6066 6067 6068 6069 6070 6071 6072 6073
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6074
        VIR_FREE(inactiveNames[i]);
6075
    }
6076 6077
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6078
    return true;
6079 6080 6081 6082 6083 6084 6085

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
6086
    {"help", N_("convert an interface MAC address to interface name")},
6087 6088 6089 6090 6091
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
6092
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
6093 6094 6095
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6096
static bool
6097 6098 6099 6100
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6101
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6102
        return false;
6103 6104
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
6105
        return false;
6106 6107 6108

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6109
    return true;
6110 6111 6112 6113 6114 6115
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
6116
    {"help", N_("convert an interface name to interface MAC address")},
6117 6118 6119 6120 6121
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
6122
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
6123 6124 6125
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6126
static bool
6127 6128 6129 6130
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6131
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6132
        return false;
6133 6134
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6135
        return false;
6136 6137 6138

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6139
    return true;
6140 6141 6142 6143 6144 6145
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
6146 6147
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
6148 6149 6150 6151
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
6152 6153
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
6154 6155 6156
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6157
static bool
6158 6159 6160
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6161
    bool ret = true;
6162
    char *dump;
6163 6164 6165 6166 6167
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
6168

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

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

6175
    dump = virInterfaceGetXMLDesc(iface, flags);
6176
    if (dump != NULL) {
6177
        vshPrint(ctl, "%s", dump);
6178
        VIR_FREE(dump);
6179
    } else {
E
Eric Blake 已提交
6180
        ret = false;
6181 6182 6183 6184 6185 6186 6187 6188 6189 6190
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
6191 6192
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
6193 6194 6195 6196
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
6197
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
6198 6199 6200
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6201
static bool
6202 6203
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
6204
    virInterfacePtr iface;
6205
    const char *from = NULL;
E
Eric Blake 已提交
6206
    bool ret = true;
6207 6208
    char *buffer;

6209
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6210
        return false;
6211

6212
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6213
        return false;
6214 6215

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

6218
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
6219
    VIR_FREE(buffer);
6220

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

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
6236 6237
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
6238 6239 6240 6241
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
6242
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6243 6244 6245
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6246
static bool
6247 6248 6249
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6250
    bool ret = true;
6251
    const char *name;
6252

6253
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6254
        return false;
6255 6256

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6257
        return false;
6258 6259 6260 6261

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
6262
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
6263
        ret = false;
6264 6265 6266 6267 6268 6269 6270 6271 6272 6273
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
6274 6275
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
6276 6277 6278 6279
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
6280
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6281 6282 6283
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6284
static bool
6285 6286 6287
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6288
    bool ret = true;
6289
    const char *name;
6290

6291
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6292
        return false;
6293 6294

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6295
        return false;
6296 6297 6298 6299

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
6300
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
6301
        ret = false;
6302 6303 6304 6305 6306 6307 6308 6309 6310 6311
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
6312
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
6313
    {"desc", N_("forcefully stop a physical host interface.")},
6314 6315 6316 6317
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
6318
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6319 6320 6321
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6322
static bool
6323 6324 6325
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6326
    bool ret = true;
6327
    const char *name;
6328

6329
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6330
        return false;
6331 6332

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6333
        return false;
6334 6335 6336 6337

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
6338
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
6339
        ret = false;
6340 6341 6342 6343 6344 6345
    }

    virInterfaceFree(iface);
    return ret;
}

6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 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
/*
 * "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;
}
6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445

/*
 * "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 已提交
6446
static bool
6447 6448 6449
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
6450
    const char *from = NULL;
E
Eric Blake 已提交
6451
    bool ret = true;
6452 6453
    char *buffer;

6454
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6455
        return false;
6456

6457
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6458
        return false;
6459 6460

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6461
        return false;
6462 6463 6464 6465 6466 6467 6468 6469 6470 6471

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

6499
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6500
        return false;
6501 6502

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
6503
        return false;
6504 6505 6506 6507 6508

    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 已提交
6509
        ret = false;
6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530
    }

    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 已提交
6531
static bool
6532 6533 6534
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
6535
    bool ret = true;
6536 6537
    char *dump;

6538
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6539
        return false;
6540 6541

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
6542
        return false;
6543 6544 6545

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
6546
        vshPrint(ctl, "%s", dump);
6547 6548
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
6549
        ret = false;
6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568
    }

    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 已提交
6569
static bool
6570 6571 6572 6573 6574 6575
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

6576
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6577
        return false;
6578 6579 6580 6581

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
6582
        return false;
6583 6584 6585 6586 6587 6588 6589 6590
    }

    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 已提交
6591
        return false;
6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618
    }

    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 已提交
6619
    return true;
6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636
}


/*
 * "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 已提交
6637
static bool
6638 6639
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6640
    bool ret = false;
6641 6642 6643 6644 6645 6646
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

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

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


6720
/**************************************************************************/
6721
/*
6722
 * "pool-autostart" command
6723
 */
6724
static const vshCmdInfo info_pool_autostart[] = {
6725
    {"help", N_("autostart a pool")},
6726
    {"desc",
6727
     N_("Configure a pool to be automatically started at boot.")},
6728
    {NULL, NULL}
6729 6730
};

6731
static const vshCmdOptDef opts_pool_autostart[] = {
6732 6733
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6734 6735
    {NULL, 0, 0, NULL}
};
6736

E
Eric Blake 已提交
6737
static bool
6738
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
6739
{
6740
    virStoragePoolPtr pool;
6741
    const char *name;
6742
    int autostart;
6743

6744
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6745
        return false;
6746

6747
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6748
        return false;
6749

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

6752 6753
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
6754
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
6755
        else
6756
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
6757
        virStoragePoolFree(pool);
E
Eric Blake 已提交
6758
        return false;
6759 6760
    }

6761
    if (autostart)
6762
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
6763
    else
6764
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
6765

L
Laine Stump 已提交
6766
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6767
    return true;
6768 6769
}

6770
/*
6771
 * "pool-create" command
6772
 */
6773
static const vshCmdInfo info_pool_create[] = {
6774 6775
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
6776 6777 6778
    {NULL, NULL}
};

6779
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
6780
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
6781
     N_("file containing an XML pool description")},
6782 6783 6784
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6785
static bool
6786
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
6787
{
6788
    virStoragePoolPtr pool;
6789
    const char *from = NULL;
E
Eric Blake 已提交
6790
    bool ret = true;
6791
    char *buffer;
6792

6793
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6794
        return false;
6795

6796
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6797
        return false;
6798

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

6802
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
6803
    VIR_FREE(buffer);
6804 6805 6806 6807

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6808
        virStoragePoolFree(pool);
6809
    } else {
6810
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
6811
        ret = false;
6812 6813
    }
    return ret;
6814 6815
}

6816

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

E
Eric Blake 已提交
6835
static bool
6836 6837 6838
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
6839
    const char *from = NULL;
E
Eric Blake 已提交
6840
    bool ret = true;
6841 6842
    char *buffer;

6843
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6844
        return false;
6845

6846
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6847
        return false;
6848

6849
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6850
        return false;
6851 6852

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
6853
    VIR_FREE(buffer);
6854 6855 6856 6857

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

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
6872
    {"help", N_("destroy (stop) a device on the node")},
6873
    {"desc", N_("Destroy a device on the node.  Note that this "
6874
                "command destroys devices on the physical host")},
6875 6876 6877 6878 6879
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
6880
     N_("name of the device to be destroyed")},
6881 6882 6883
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6884
static bool
6885 6886 6887
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
6888
    bool ret = true;
6889
    const char *name = NULL;
6890

6891
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
6892
        return false;
6893 6894
    }

6895
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
6896
        return false;
6897 6898 6899 6900 6901 6902

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
6903
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
6904
        ret = false;
6905 6906 6907 6908 6909 6910 6911
    }

    virNodeDeviceFree(dev);
    return ret;
}


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

6928
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
6929

6930 6931
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
6932
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6933

6934
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6935
        goto cleanup;
6936
    if (vshCommandOptString(cmd, "type", &type) <= 0)
6937 6938
        goto cleanup;

6939 6940 6941 6942 6943
    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 ||
6944 6945
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
6946
        goto cleanup;
6947
    }
6948

6949 6950
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
6951
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
6952
        virBufferAddLit(&buf, "  <source>\n");
6953

6954
        if (srcHost)
6955
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
6956
        if (srcPath)
6957
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
6958
        if (srcDev)
6959
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
6960
        if (srcFormat)
6961
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
6962
        if (srcName)
6963
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
6964 6965

        virBufferAddLit(&buf, "  </source>\n");
6966 6967
    }
    if (target) {
6968
        virBufferAddLit(&buf, "  <target>\n");
6969
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
6970
        virBufferAddLit(&buf, "  </target>\n");
6971
    }
6972 6973 6974 6975
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
6976
        return false;
6977
    }
6978 6979 6980

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
6981
    return true;
6982 6983

cleanup:
6984
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6985
    return false;
6986 6987 6988 6989 6990 6991
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
6992 6993
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
6994 6995 6996
    {NULL, NULL}
};

E
Eric Blake 已提交
6997
static bool
6998 6999 7000
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
7001 7002
    const char *name;
    char *xml;
7003
    int printXML = vshCommandOptBool(cmd, "print-xml");
7004

7005
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7006
        return false;
7007 7008

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

7011
    if (printXML) {
7012
        vshPrint(ctl, "%s", xml);
7013
        VIR_FREE(xml);
7014
    } else {
7015
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
7016
        VIR_FREE(xml);
7017

7018 7019 7020 7021
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
7022
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
7023
            return false;
7024 7025
        }
    }
E
Eric Blake 已提交
7026
    return true;
7027 7028
}

7029

7030
/*
7031
 * "pool-define" command
7032
 */
7033
static const vshCmdInfo info_pool_define[] = {
7034 7035
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
7036 7037 7038
    {NULL, NULL}
};

7039
static const vshCmdOptDef opts_pool_define[] = {
7040
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
7041 7042 7043
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7044
static bool
7045
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
7046
{
7047
    virStoragePoolPtr pool;
7048
    const char *from = NULL;
E
Eric Blake 已提交
7049
    bool ret = true;
7050
    char *buffer;
7051

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

7055
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7056
        return false;
7057

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

7061
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
7062
    VIR_FREE(buffer);
7063 7064 7065 7066

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7067
        virStoragePoolFree(pool);
7068
    } else {
7069
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
7070
        ret = false;
7071 7072
    }
    return ret;
7073 7074
}

7075

7076 7077 7078
/*
 * "pool-define-as" command
 */
7079
static const vshCmdInfo info_pool_define_as[] = {
7080 7081
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
7082 7083 7084
    {NULL, NULL}
};

E
Eric Blake 已提交
7085
static bool
7086
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
7087 7088
{
    virStoragePoolPtr pool;
7089 7090
    const char *name;
    char *xml;
7091
    int printXML = vshCommandOptBool(cmd, "print-xml");
7092

7093
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7094
        return false;
7095

7096
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
7097
        return false;
7098

7099
    if (printXML) {
7100
        vshPrint(ctl, "%s", xml);
7101
        VIR_FREE(xml);
7102
    } else {
7103
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
7104
        VIR_FREE(xml);
7105

7106 7107 7108 7109
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
7110
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
7111
            return false;
7112 7113
        }
    }
E
Eric Blake 已提交
7114
    return true;
7115 7116 7117
}


7118
/*
7119
 * "pool-build" command
7120
 */
7121
static const vshCmdInfo info_pool_build[] = {
7122 7123
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
7124 7125 7126
    {NULL, NULL}
};

7127
static const vshCmdOptDef opts_pool_build[] = {
7128
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7129 7130 7131
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7132
static bool
7133
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
7134
{
7135
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7136
    bool ret = true;
7137
    const char *name;
7138

7139
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7140
        return false;
7141

7142
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7143
        return false;
7144

7145
    if (virStoragePoolBuild(pool, 0) == 0) {
7146
        vshPrint(ctl, _("Pool %s built\n"), name);
7147
    } else {
7148
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
7149
        ret = false;
7150 7151
    }

7152 7153
    virStoragePoolFree(pool);

7154 7155 7156
    return ret;
}

7157

7158
/*
7159
 * "pool-destroy" command
7160
 */
7161
static const vshCmdInfo info_pool_destroy[] = {
7162 7163 7164
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
7165 7166 7167
    {NULL, NULL}
};

7168
static const vshCmdOptDef opts_pool_destroy[] = {
7169
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7170 7171 7172
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7173
static bool
7174
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
7175
{
7176
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7177
    bool ret = true;
7178
    const char *name;
7179

7180
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7181
        return false;
7182

7183
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7184
        return false;
7185

7186 7187 7188
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
7189
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
7190
        ret = false;
7191 7192
    }

7193
    virStoragePoolFree(pool);
7194 7195 7196
    return ret;
}

7197

7198
/*
7199 7200
 * "pool-delete" command
 */
7201
static const vshCmdInfo info_pool_delete[] = {
7202 7203
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
7204 7205 7206
    {NULL, NULL}
};

7207
static const vshCmdOptDef opts_pool_delete[] = {
7208
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7209 7210 7211
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7212
static bool
7213
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
7214 7215
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7216
    bool ret = true;
7217
    const char *name;
7218

7219
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7220
        return false;
7221 7222

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7223
        return false;
7224 7225

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
7226
        vshPrint(ctl, _("Pool %s deleted\n"), name);
7227
    } else {
7228
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
7229
        ret = false;
7230 7231
    }

L
Laine Stump 已提交
7232
    virStoragePoolFree(pool);
7233 7234 7235 7236 7237 7238 7239
    return ret;
}


/*
 * "pool-refresh" command
 */
7240
static const vshCmdInfo info_pool_refresh[] = {
7241 7242
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
7243 7244 7245
    {NULL, NULL}
};

7246
static const vshCmdOptDef opts_pool_refresh[] = {
7247
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7248 7249 7250
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7251
static bool
7252
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
7253 7254
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7255
    bool ret = true;
7256
    const char *name;
7257

7258
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7259
        return false;
7260 7261

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7262
        return false;
7263 7264 7265 7266

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
7267
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
7268
        ret = false;
7269 7270 7271 7272 7273 7274 7275 7276 7277 7278
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
7279
static const vshCmdInfo info_pool_dumpxml[] = {
7280 7281
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
7282 7283 7284
    {NULL, NULL}
};

7285
static const vshCmdOptDef opts_pool_dumpxml[] = {
7286
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7287 7288 7289
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7290
static bool
7291
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
7292 7293
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7294
    bool ret = true;
7295 7296
    char *dump;

7297
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7298
        return false;
7299 7300

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7301
        return false;
7302 7303 7304

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
7305
        vshPrint(ctl, "%s", dump);
7306
        VIR_FREE(dump);
7307
    } else {
E
Eric Blake 已提交
7308
        ret = false;
7309 7310 7311 7312 7313 7314 7315 7316 7317 7318
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
7319
static const vshCmdInfo info_pool_list[] = {
7320 7321
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
7322 7323 7324
    {NULL, NULL}
};

7325
static const vshCmdOptDef opts_pool_list[] = {
7326 7327
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
7328
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
7329 7330 7331
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7332
static bool
7333
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7334
{
7335 7336
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
7337 7338
    int i, ret;
    bool functionReturn;
7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354
    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 */
7355
    int all = vshCommandOptBool(cmd, "all");
7356 7357
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
7358 7359 7360
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

7361
    /* Check the connection to libvirtd daemon is still working */
7362
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7363
        return false;
7364

7365
    /* Retrieve the number of active storage pools */
7366
    if (active) {
7367 7368
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
7369
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
7370
            return false;
7371 7372
        }
    }
7373 7374

    /* Retrieve the number of inactive storage pools */
7375
    if (inactive) {
7376 7377
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
7378
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
7379
            return false;
7380
        }
7381
    }
7382

7383 7384
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
7385

7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397
    /* 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 已提交
7398
            return false;
7399 7400 7401
        }
    }

7402 7403 7404 7405 7406 7407 7408 7409
    /* 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 已提交
7410
            return false;
7411 7412
        }
    }
7413

7414 7415 7416 7417 7418 7419 7420 7421 7422 7423
    /* 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]);
7424
        if (!pool) {
7425
            VIR_FREE(poolNames[i]);
7426 7427 7428
            continue;
        }

7429
        /* Retrieve the autostart status of the pool */
7430
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
7431
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
7432
        else
7433 7434 7435 7436 7437 7438
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
7439 7440
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451
            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;
        }
7452

7453 7454 7455 7456 7457 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
        /* 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 */
7565 7566 7567
        virStoragePoolFree(pool);
    }

7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585
    /* 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);
7586 7587
        }

7588
        /* Cleanup and return */
E
Eric Blake 已提交
7589
        functionReturn = true;
7590 7591
        goto cleanup;
    }
7592

7593 7594 7595 7596 7597 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
    /* 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. */
7631
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
7632
             (unsigned long) nameStrLength);
7633
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
7634
             (unsigned long) stateStrLength);
7635
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
7636
             (unsigned long) autostartStrLength);
7637
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
7638
             (unsigned long) persistStrLength);
7639
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
7640
             (unsigned long) capStrLength);
7641
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
7642
             (unsigned long) allocStrLength);
7643
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
7644 7645 7646 7647 7648 7649 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
             (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 已提交
7687
    functionReturn = true;
7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701
    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 已提交
7702
    functionReturn = false;
7703

7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715
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]);
7716
    }
7717 7718 7719 7720 7721 7722 7723

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

    /* Return the desired value */
    return functionReturn;
7724 7725
}

7726 7727 7728 7729
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
7730 7731
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7732 7733 7734 7735 7736
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7737 7738 7739
     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")},
7740
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
7741 7742 7743
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7744
static bool
7745 7746
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7747
    const char *type = NULL, *host = NULL;
7748 7749
    char *srcSpec = NULL;
    char *srcList;
7750
    const char *initiator = NULL;
7751

7752 7753
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
7754 7755
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
7756
        return false;
7757
    }
7758

7759
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7760
        return false;
7761 7762

    if (host) {
7763
        const char *port = NULL;
7764
        virBuffer buf = VIR_BUFFER_INITIALIZER;
7765 7766 7767 7768

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7769
            return false;
7770
        }
7771
        virBufferAddLit(&buf, "<source>\n");
7772
        virBufferAsprintf(&buf, "  <host name='%s'", host);
7773
        if (port)
7774
            virBufferAsprintf(&buf, " port='%s'", port);
7775
        virBufferAddLit(&buf, "/>\n");
7776 7777
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
7778
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
7779 7780
            virBufferAddLit(&buf, "  </initiator>\n");
        }
7781 7782 7783
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
7784
            return false;
7785
        }
7786
        srcSpec = virBufferContentAndReset(&buf);
7787 7788 7789
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7790
    VIR_FREE(srcSpec);
7791
    if (srcList == NULL) {
7792
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7793
        return false;
7794 7795
    }
    vshPrint(ctl, "%s", srcList);
7796
    VIR_FREE(srcList);
7797

E
Eric Blake 已提交
7798
    return true;
7799 7800 7801 7802 7803 7804 7805
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
7806 7807
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7808 7809 7810 7811 7812
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7813
     N_("type of storage pool sources to discover")},
7814
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
7815
     N_("optional file of source xml to query for pools")},
7816 7817 7818
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7819
static bool
7820 7821
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7822
    const char *type = NULL, *srcSpecFile = NULL;
7823
    char *srcSpec = NULL, *srcList;
7824

7825
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
7826
        return false;
7827

7828 7829
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
7830
        return false;
7831
    }
7832

7833
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7834
        return false;
7835 7836

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
7837
        return false;
7838 7839

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7840
    VIR_FREE(srcSpec);
7841
    if (srcList == NULL) {
7842
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7843
        return false;
7844 7845
    }
    vshPrint(ctl, "%s", srcList);
7846
    VIR_FREE(srcList);
7847

E
Eric Blake 已提交
7848
    return true;
7849 7850 7851
}


7852 7853 7854
/*
 * "pool-info" command
 */
7855
static const vshCmdInfo info_pool_info[] = {
7856 7857
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
7858 7859 7860
    {NULL, NULL}
};

7861
static const vshCmdOptDef opts_pool_info[] = {
7862
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7863 7864 7865
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7866
static bool
7867
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
7868 7869 7870
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
7871 7872
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
7873
    bool ret = true;
7874 7875
    char uuid[VIR_UUID_STRING_BUFLEN];

7876
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7877
        return false;
7878 7879

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7880
        return false;
7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906

    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;
7907 7908 7909 7910
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
7911 7912
        }

7913 7914
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
7915 7916
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
7917 7918 7919 7920 7921 7922 7923
        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);
7924 7925
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
7926 7927 7928 7929 7930
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942
        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 已提交
7943
        ret = false;
7944 7945 7946 7947 7948 7949 7950 7951 7952 7953
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
7954
static const vshCmdInfo info_pool_name[] = {
7955
    {"help", N_("convert a pool UUID to pool name")},
7956
    {"desc", ""},
7957 7958 7959
    {NULL, NULL}
};

7960
static const vshCmdOptDef opts_pool_name[] = {
7961
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
7962 7963 7964
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7965
static bool
7966
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
7967 7968 7969
{
    virStoragePoolPtr pool;

7970
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7971
        return false;
7972
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7973
                                           VSH_BYUUID)))
E
Eric Blake 已提交
7974
        return false;
7975 7976 7977

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7978
    return true;
7979 7980 7981 7982 7983 7984
}


/*
 * "pool-start" command
 */
7985
static const vshCmdInfo info_pool_start[] = {
7986 7987
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
7988 7989 7990
    {NULL, NULL}
};

7991
static const vshCmdOptDef opts_pool_start[] = {
7992
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
7993 7994 7995
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7996
static bool
7997
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
7998 7999
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8000
    bool ret = true;
8001

8002
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8003
        return false;
8004

8005
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
8006
         return false;
8007 8008 8009 8010 8011

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
8012
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
8013
        ret = false;
8014
    }
L
Laine Stump 已提交
8015 8016

    virStoragePoolFree(pool);
8017 8018 8019 8020
    return ret;
}


8021 8022 8023
/*
 * "vol-create-as" command
 */
8024
static const vshCmdInfo info_vol_create_as[] = {
8025 8026
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
8027 8028 8029
    {NULL, NULL}
};

8030
static const vshCmdOptDef opts_vol_create_as[] = {
8031 8032 8033 8034 8035
    {"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")},
8036 8037
    {"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")},
8038 8039 8040 8041 8042 8043 8044 8045 8046 8047
    {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 已提交
8048
        /* Deliberate fallthrough cases here :-) */
8049 8050 8051
        switch (*end) {
        case 'T':
            *val *= 1024;
8052
            /* fallthrough */
8053 8054
        case 'G':
            *val *= 1024;
8055
            /* fallthrough */
8056 8057
        case 'M':
            *val *= 1024;
8058
            /* fallthrough */
8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
8072
static bool
8073
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
8074 8075 8076
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8077
    char *xml;
8078 8079
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
8080
    unsigned long long capacity, allocation = 0;
8081
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8082

8083
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8084
        return false;
8085 8086 8087

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

8090
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8091 8092
        goto cleanup;

8093
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
8094 8095
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
8096
        vshError(ctl, _("Malformed size %s"), capacityStr);
8097

8098 8099
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
8100
        vshError(ctl, _("Malformed size %s"), allocationStr);
8101

8102 8103 8104 8105 8106 8107 8108
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

8109

8110
    virBufferAddLit(&buf, "<volume>\n");
8111 8112
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
8113
    if (allocationStr)
8114
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
8115 8116

    if (format) {
8117
        virBufferAddLit(&buf, "  <target>\n");
8118
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
8119
        virBufferAddLit(&buf, "  </target>\n");
8120
    }
8121

8122 8123 8124 8125
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
8126 8127
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
8128 8129 8130
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
8131 8132
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
8133 8134 8135 8136 8137
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
8138 8139
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
8140 8141 8142
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
8143 8144
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
8145 8146 8147 8148 8149
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
8150 8151
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
8152 8153 8154
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
8155 8156
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
8157 8158 8159 8160
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
E
Eric Blake 已提交
8161
            return false;
8162 8163 8164 8165 8166
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
8167
            return false;
8168 8169 8170 8171
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
8172
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
8173
        if (snapshotStrFormat)
8174
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
8175 8176 8177 8178 8179 8180 8181 8182
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

8184 8185
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
8186
        return false;
8187 8188 8189
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
8190
    VIR_FREE(xml);
8191 8192 8193 8194 8195
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
8196
        return true;
8197
    } else {
8198
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
8199
        return false;
8200 8201 8202
    }

 cleanup:
8203
    virBufferFreeAndReset(&buf);
8204
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8205
    return false;
8206 8207 8208
}


8209 8210 8211
/*
 * "pool-undefine" command
 */
8212
static const vshCmdInfo info_pool_undefine[] = {
8213 8214
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
8215 8216 8217
    {NULL, NULL}
};

8218
static const vshCmdOptDef opts_pool_undefine[] = {
8219
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8220 8221 8222
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8223
static bool
8224
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
8225 8226
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8227
    bool ret = true;
8228
    const char *name;
8229

8230
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8231
        return false;
8232 8233

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8234
        return false;
8235 8236 8237 8238

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

L
Laine Stump 已提交
8243
    virStoragePoolFree(pool);
8244 8245 8246 8247 8248 8249 8250
    return ret;
}


/*
 * "pool-uuid" command
 */
8251
static const vshCmdInfo info_pool_uuid[] = {
8252
    {"help", N_("convert a pool name to pool UUID")},
8253
    {"desc", ""},
8254 8255 8256
    {NULL, NULL}
};

8257
static const vshCmdOptDef opts_pool_uuid[] = {
8258
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
8259 8260 8261
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8262
static bool
8263
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
8264 8265 8266 8267
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8272
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8273
        return false;
8274 8275 8276 8277

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

L
Laine Stump 已提交
8280
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8281
    return true;
8282 8283 8284 8285 8286 8287
}


/*
 * "vol-create" command
 */
8288
static const vshCmdInfo info_vol_create[] = {
8289 8290
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
8291 8292 8293
    {NULL, NULL}
};

8294
static const vshCmdOptDef opts_vol_create[] = {
8295 8296
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
8297 8298 8299
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8300
static bool
8301
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
8302 8303 8304
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8305
    const char *from = NULL;
E
Eric Blake 已提交
8306
    bool ret = true;
8307 8308
    char *buffer;

8309
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8310
        return false;
8311 8312

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

8316
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8317
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8318
        return false;
8319 8320 8321
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8322
        virshReportError(ctl);
8323
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8324
        return false;
8325 8326 8327
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
8328
    VIR_FREE(buffer);
8329 8330 8331 8332 8333 8334 8335
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
8336
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
8337
        ret = false;
8338 8339 8340 8341
    }
    return ret;
}

8342 8343 8344 8345
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
8346 8347
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
8348 8349 8350 8351
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
8352 8353 8354
    {"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 已提交
8355
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
8356 8357 8358
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8359
static bool
8360 8361 8362 8363
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
8364
    const char *from = NULL;
E
Eric Blake 已提交
8365
    bool ret = false;
8366 8367
    char *buffer = NULL;

8368
    if (!vshConnectionUsability(ctl, ctl->conn))
8369 8370 8371 8372 8373
        goto cleanup;

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

8374
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8375 8376 8377 8378 8379 8380 8381
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8382
        virshReportError(ctl);
8383 8384 8385 8386 8387 8388 8389 8390 8391
        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 {
8392
        vshError(ctl, _("Failed to create vol from %s"), from);
8393 8394 8395
        goto cleanup;
    }

E
Eric Blake 已提交
8396
    ret = true;
8397
cleanup:
8398
    VIR_FREE(buffer);
8399 8400 8401 8402
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
8403 8404
    if (newvol)
        virStorageVolFree(newvol);
8405 8406 8407 8408
    return ret;
}

static xmlChar *
8409
makeCloneXML(const char *origxml, const char *newname) {
8410

8411 8412 8413
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443
    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[] = {
8444 8445
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
8446 8447 8448 8449
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
8450 8451
    {"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 已提交
8452
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8453 8454 8455
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8456
static bool
8457 8458 8459 8460
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
8461
    const char *name = NULL;
8462
    char *origxml = NULL;
8463
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
8464
    bool ret = false;
8465

8466
    if (!vshConnectionUsability(ctl, ctl->conn))
8467 8468 8469 8470 8471 8472 8473
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
8474
        vshError(ctl, "%s", _("failed to get parent pool"));
8475 8476 8477
        goto cleanup;
    }

8478
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496
        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 {
8497
        vshError(ctl, _("Failed to clone vol from %s"),
8498 8499 8500 8501
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
8502
    ret = true;
8503 8504

cleanup:
8505
    VIR_FREE(origxml);
8506 8507 8508
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
8509 8510
    if (newvol)
        virStorageVolFree(newvol);
8511 8512 8513 8514 8515
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528

/*
 * "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 已提交
8529
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543
    {"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 已提交
8544
static bool
8545 8546 8547 8548
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8549
    bool ret = false;
8550 8551 8552 8553 8554 8555 8556 8557 8558 8559
    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 已提交
8560
        return false;
8561 8562 8563 8564
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8565
        return false;
8566 8567 8568
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8569
        return false;
8570 8571 8572 8573 8574 8575 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
    }

    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 已提交
8604
    ret = true;
8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628

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 已提交
8629
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8630 8631 8632 8633 8634
    {"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 已提交
8635
static bool
8636 8637 8638 8639
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8640
    bool ret = false;
8641 8642 8643 8644
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
8645
    bool created = false;
8646 8647

    if (!vshConnectionUsability(ctl, ctl->conn))
8648
        return false;
8649 8650 8651

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8652
        return false;
8653 8654 8655 8656
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8657
        return false;
8658 8659 8660
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
8661
        return false;
8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673

    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;
        }
8674 8675
    } else {
        created = true;
8676 8677 8678 8679 8680 8681 8682 8683
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

8684
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699
        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 已提交
8700
    ret = true;
8701 8702

cleanup:
8703
    VIR_FORCE_CLOSE(fd);
8704
    if (!ret && created)
8705 8706 8707 8708 8709 8710 8711 8712 8713
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


8714 8715 8716
/*
 * "vol-delete" command
 */
8717
static const vshCmdInfo info_vol_delete[] = {
8718 8719
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
8720 8721 8722
    {NULL, NULL}
};

8723
static const vshCmdOptDef opts_vol_delete[] = {
8724
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8725
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8726 8727 8728
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8729
static bool
8730
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
8731 8732
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8733
    bool ret = true;
8734
    const char *name;
8735

8736
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8737
        return false;
8738 8739

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8740
        return false;
8741 8742 8743
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
8744
        vshPrint(ctl, _("Vol %s deleted\n"), name);
8745
    } else {
8746
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
8747
        ret = false;
8748 8749
    }

L
Laine Stump 已提交
8750
    virStorageVolFree(vol);
8751 8752 8753 8754
    return ret;
}


D
David Allan 已提交
8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765
/*
 * "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 已提交
8766
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
8767 8768 8769
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8770
static bool
D
David Allan 已提交
8771 8772 8773
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8774
    bool ret = true;
8775
    const char *name;
D
David Allan 已提交
8776

8777
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8778
        return false;
D
David Allan 已提交
8779 8780

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8781
        return false;
D
David Allan 已提交
8782 8783 8784 8785 8786 8787
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
8788
        ret = false;
D
David Allan 已提交
8789 8790 8791 8792 8793 8794 8795
    }

    virStorageVolFree(vol);
    return ret;
}


8796 8797 8798
/*
 * "vol-info" command
 */
8799
static const vshCmdInfo info_vol_info[] = {
8800 8801
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
8802 8803 8804
    {NULL, NULL}
};

8805
static const vshCmdOptDef opts_vol_info[] = {
8806
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8807
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8808 8809 8810
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8811
static bool
8812
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
8813 8814 8815
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
8816
    bool ret = true;
8817

8818
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8819
        return false;
8820 8821

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8822
        return false;
8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838

    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 已提交
8839
        ret = false;
8840 8841 8842 8843 8844 8845 8846 8847 8848 8849
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
8850
static const vshCmdInfo info_vol_dumpxml[] = {
8851 8852
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
8853 8854 8855
    {NULL, NULL}
};

8856
static const vshCmdOptDef opts_vol_dumpxml[] = {
8857
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8858
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8859 8860 8861
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8862
static bool
8863
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
8864 8865
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8866
    bool ret = true;
8867 8868
    char *dump;

8869
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8870
        return false;
8871 8872

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8873
        return false;
8874 8875 8876

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
8877
        vshPrint(ctl, "%s", dump);
8878
        VIR_FREE(dump);
8879
    } else {
E
Eric Blake 已提交
8880
        ret = false;
8881 8882 8883 8884 8885 8886 8887 8888 8889 8890
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
8891
static const vshCmdInfo info_vol_list[] = {
8892 8893
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
8894 8895 8896
    {NULL, NULL}
};

8897
static const vshCmdOptDef opts_vol_list[] = {
8898
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8899
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
8900 8901 8902
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8903
static bool
8904
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8905
{
8906
    virStorageVolInfo volumeInfo;
8907 8908
    virStoragePoolPtr pool;
    char **activeNames = NULL;
8909 8910 8911 8912 8913
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
8914 8915
    int ret;
    bool functionReturn;
8916 8917 8918 8919 8920 8921 8922 8923 8924 8925 8926
    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;
8927

8928
    /* Check the connection to libvirtd daemon is still working */
8929
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8930
        return false;
8931

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

8936 8937
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
8938

8939 8940 8941
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8942
        return false;
8943 8944
    }

8945 8946 8947 8948 8949
    /* 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) {
8950
            vshError(ctl, "%s", _("Failed to list active vols"));
8951
            VIR_FREE(activeNames);
8952
            virStoragePoolFree(pool);
E
Eric Blake 已提交
8953
            return false;
8954 8955
        }

8956 8957 8958 8959 8960
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

8963 8964 8965 8966 8967
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
8968

8969 8970 8971 8972
        /* 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"));
8973 8974
        }

8975 8976 8977 8978 8979 8980 8981 8982 8983
        /* 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 */
8984

8985 8986 8987 8988 8989 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
                /* 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;
        }
9040

9041
        /* Cleanup memory allocation */
9042
        virStorageVolFree(vol);
9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060
    }

    /* 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 已提交
9061
        functionReturn = true;
9062 9063 9064 9065 9066 9067 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
        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 */
9093 9094 9095 9096 9097 9098 9099 9100 9101 9102
    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);
9103 9104 9105 9106 9107 9108 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

    /* 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 已提交
9137
    functionReturn = true;
9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151
    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 已提交
9152
    functionReturn = false;
9153 9154 9155 9156 9157 9158 9159 9160 9161 9162

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);
9163
        VIR_FREE(activeNames[i]);
9164
    }
9165 9166 9167 9168

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
9169
    VIR_FREE(activeNames);
9170
    virStoragePoolFree(pool);
9171 9172 9173

    /* Return the desired value */
    return functionReturn;
9174 9175 9176 9177 9178 9179
}


/*
 * "vol-name" command
 */
9180
static const vshCmdInfo info_vol_name[] = {
9181
    {"help", N_("returns the volume name for a given volume key or path")},
9182
    {"desc", ""},
9183 9184 9185
    {NULL, NULL}
};

9186
static const vshCmdOptDef opts_vol_name[] = {
9187
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
9188 9189 9190
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9191
static bool
9192
cmdVolName(vshControl *ctl, const vshCmd *cmd)
9193 9194 9195
{
    virStorageVolPtr vol;

9196
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9197
        return false;
9198 9199 9200

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
E
Eric Blake 已提交
9201
        return false;
9202 9203 9204

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9205
    return true;
9206 9207 9208
}


J
Justin Clift 已提交
9209 9210 9211 9212 9213 9214 9215 9216 9217 9218
/*
 * "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[] = {
9219
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
9220 9221 9222 9223
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9224
static bool
J
Justin Clift 已提交
9225 9226 9227 9228
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9229
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
9230 9231

    /* Check the connection to libvirtd daemon is still working */
9232
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9233
        return false;
J
Justin Clift 已提交
9234 9235 9236 9237

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
9238
        return false;
J
Justin Clift 已提交
9239 9240 9241 9242 9243 9244 9245
    }

    /* 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 已提交
9246
        return false;
J
Justin Clift 已提交
9247 9248
    }

9249 9250 9251 9252 9253 9254 9255 9256 9257
    /* 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 已提交
9258 9259 9260 9261

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9262
    return true;
J
Justin Clift 已提交
9263 9264
}

9265 9266 9267 9268

/*
 * "vol-key" command
 */
9269
static const vshCmdInfo info_vol_key[] = {
9270
    {"help", N_("returns the volume key for a given volume name or path")},
9271
    {"desc", ""},
9272 9273 9274
    {NULL, NULL}
};

9275
static const vshCmdOptDef opts_vol_key[] = {
9276
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
9277
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9278 9279 9280
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9281
static bool
9282
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
9283 9284 9285
{
    virStorageVolPtr vol;

9286
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9287
        return false;
9288

9289
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9290
        return false;
9291 9292 9293

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9294
    return true;
9295 9296 9297 9298 9299 9300 9301
}



/*
 * "vol-path" command
 */
9302
static const vshCmdInfo info_vol_path[] = {
9303
    {"help", N_("returns the volume path for a given volume name or key")},
9304
    {"desc", ""},
9305 9306 9307
    {NULL, NULL}
};

9308
static const vshCmdOptDef opts_vol_path[] = {
9309
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
9310
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9311 9312 9313
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9314
static bool
9315
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
9316 9317
{
    virStorageVolPtr vol;
9318
    const char *name = NULL;
9319

9320
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9321
        return false;
9322 9323

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9324
        return false;
9325
    }
9326 9327 9328

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9329
    return true;
9330 9331 9332
}


9333 9334 9335 9336
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
9337 9338
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
9339 9340
    {NULL, NULL}
};
9341

9342
static const vshCmdOptDef opts_secret_define[] = {
9343
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
9344 9345
    {NULL, 0, 0, NULL}
};
9346

E
Eric Blake 已提交
9347
static bool
9348 9349
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
9350
    const char *from = NULL;
9351
    char *buffer;
9352
    virSecretPtr res;
9353
    char uuid[VIR_UUID_STRING_BUFLEN];
9354

9355
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9356
        return false;
9357

9358
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9359
        return false;
9360 9361

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
9365
    VIR_FREE(buffer);
9366 9367

    if (res == NULL) {
9368
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
9369
        return false;
9370
    }
9371
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
9372
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
9373
        virSecretFree(res);
E
Eric Blake 已提交
9374
        return false;
9375 9376 9377
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
9378
    return true;
9379 9380 9381 9382 9383 9384
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
9385 9386
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
9387 9388 9389 9390
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
9391
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9392 9393 9394
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9395
static bool
9396 9397 9398
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9399
    bool ret = false;
9400 9401
    char *xml;

9402
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9403
        return false;
9404 9405 9406

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9407
        return false;
9408 9409 9410 9411

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
9412
    vshPrint(ctl, "%s", xml);
9413
    VIR_FREE(xml);
E
Eric Blake 已提交
9414
    ret = true;
9415 9416 9417 9418 9419 9420 9421 9422 9423 9424

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
9425 9426
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
9427 9428 9429 9430
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
9431 9432
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
9433 9434 9435
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9436
static bool
9437 9438 9439 9440
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
9441
    const char *base64 = NULL;
9442
    char *value;
E
Eric Blake 已提交
9443 9444
    int res;
    bool ret = false;
9445

9446
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9447
        return false;
9448 9449 9450

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

9453
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
9454 9455 9456
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
9457
        vshError(ctl, "%s", _("Invalid base64 data"));
9458 9459 9460
        goto cleanup;
    }
    if (value == NULL) {
9461
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
9462
        return false;
9463 9464 9465 9466
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
9467
    VIR_FREE(value);
9468 9469

    if (res != 0) {
9470
        vshError(ctl, "%s", _("Failed to set secret value"));
9471 9472 9473
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
9474
    ret = true;
9475 9476 9477 9478 9479 9480 9481 9482 9483 9484

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
9485 9486
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
9487 9488 9489 9490
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
9491
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9492 9493 9494
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9495
static bool
9496 9497 9498 9499 9500 9501
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
9502
    bool ret = false;
9503

9504
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9505
        return false;
9506 9507 9508

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
9509
        return false;
9510 9511 9512 9513 9514 9515 9516

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
9517
    VIR_FREE(value);
9518 9519

    if (base64 == NULL) {
9520
        vshError(ctl, "%s", _("Failed to allocate memory"));
9521 9522
        goto cleanup;
    }
9523
    vshPrint(ctl, "%s", base64);
9524
    memset(base64, 0, strlen(base64));
9525
    VIR_FREE(base64);
E
Eric Blake 已提交
9526
    ret = true;
9527 9528 9529 9530 9531 9532 9533 9534 9535 9536

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
9537 9538
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
9539 9540 9541 9542
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
9543
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
9544 9545 9546
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9547
static bool
9548 9549 9550
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9551
    bool ret = false;
9552
    const char *uuid;
9553

9554
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9555
        return false;
9556 9557 9558

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
9559
        return false;
9560 9561

    if (virSecretUndefine(secret) < 0) {
9562
        vshError(ctl, _("Failed to delete secret %s"), uuid);
9563 9564 9565
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
9566
    ret = true;
9567 9568 9569 9570 9571 9572 9573 9574 9575 9576

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
9577 9578
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
9579 9580 9581
    {NULL, NULL}
};

E
Eric Blake 已提交
9582
static bool
9583 9584 9585 9586 9587
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

9588
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9589
        return false;
9590 9591 9592

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
9593
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
9594
        return false;
9595 9596 9597 9598 9599
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
9600
        vshError(ctl, "%s", _("Failed to list secrets"));
9601
        VIR_FREE(uuids);
E
Eric Blake 已提交
9602
        return false;
9603 9604 9605 9606
    }

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

9607 9608
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
9609 9610

    for (i = 0; i < maxuuids; i++) {
9611 9612 9613 9614
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
9615
            VIR_FREE(uuids[i]);
9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626 9627 9628 9629 9630 9631 9632 9633
            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);
9634
        VIR_FREE(uuids[i]);
9635
    }
9636
    VIR_FREE(uuids);
E
Eric Blake 已提交
9637
    return true;
9638
}
9639 9640 9641 9642 9643


/*
 * "version" command
 */
9644
static const vshCmdInfo info_version[] = {
9645 9646
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
9647 9648 9649
    {NULL, NULL}
};

9650 9651 9652 9653
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
9654

E
Eric Blake 已提交
9655
static bool
9656
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9657 9658 9659 9660 9661 9662
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
9663
    unsigned long daemonVersion;
9664 9665 9666 9667 9668
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

9669
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9670
        return false;
9671 9672 9673

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
9674
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
9675
        return false;
9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687
    }

    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) {
9688
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
9689
        return false;
9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706
    }
    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) {
9707
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
9708
        return false;
9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721
    }
    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);
    }
9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 9733 9734 9735 9736

    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 已提交
9737
    return true;
9738 9739
}

9740 9741 9742 9743
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
9744
    {"help", N_("enumerate devices on this host")},
9745
    {"desc", ""},
9746 9747 9748 9749
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
9750 9751
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
9752 9753 9754
    {NULL, 0, 0, NULL}
};

9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776
#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] = '-';
9777 9778
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
9779 9780 9781
    }

    /* Print this device */
9782
    vshPrint(ctl, "%s", indentBuf);
9783 9784 9785 9786 9787 9788 9789 9790 9791 9792 9793 9794 9795 9796 9797 9798 9799 9800 9801 9802 9803 9804 9805
    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) {
9806
        vshPrint(ctl, "%s", indentBuf);
9807
        vshPrint(ctl, " |\n");
9808 9809 9810 9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829
    }

    /* 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) {
9830
        vshPrint(ctl, "%s", indentBuf);
9831 9832 9833 9834
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
9835
static bool
9836 9837
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
9838
    const char *cap = NULL;
9839
    char **devices;
9840
    int num_devices, i;
9841
    int tree = vshCommandOptBool(cmd, "tree");
9842

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

9846
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
9847 9848 9849 9850
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
9851
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
9852
        return false;
9853
    } else if (num_devices == 0) {
E
Eric Blake 已提交
9854
        return true;
9855 9856 9857 9858 9859 9860
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
9861
        vshError(ctl, "%s", _("Failed to list node devices"));
9862
        VIR_FREE(devices);
E
Eric Blake 已提交
9863
        return false;
9864
    }
9865
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
9866 9867 9868 9869 9870 9871 9872
    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 已提交
9873
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892
            } 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++) {
9893 9894
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
9895
        }
9896
        VIR_FREE(parents);
9897 9898 9899
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
9900
            VIR_FREE(devices[i]);
9901
        }
9902
    }
9903
    VIR_FREE(devices);
E
Eric Blake 已提交
9904
    return true;
9905 9906 9907 9908 9909 9910
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
9911 9912
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
9913 9914 9915 9916 9917
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
9918
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9919 9920 9921
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9922
static bool
9923 9924
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
9925
    const char *name = NULL;
9926
    virNodeDevicePtr device;
L
Laine Stump 已提交
9927
    char *xml;
9928

9929
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9930
        return false;
9931
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9932
        return false;
9933
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9934
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9935
        return false;
9936 9937
    }

L
Laine Stump 已提交
9938 9939 9940
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
9941
        return false;
L
Laine Stump 已提交
9942 9943 9944
    }

    vshPrint(ctl, "%s\n", xml);
9945
    VIR_FREE(xml);
9946
    virNodeDeviceFree(device);
E
Eric Blake 已提交
9947
    return true;
9948 9949
}

9950 9951 9952 9953
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
9954 9955
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
9956 9957 9958 9959 9960
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
9961
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9962 9963 9964
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9965
static bool
9966 9967
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
9968
    const char *name = NULL;
9969
    virNodeDevicePtr device;
E
Eric Blake 已提交
9970
    bool ret = true;
9971

9972
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9973
        return false;
9974
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9975
        return false;
9976
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9977
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9978
        return false;
9979 9980 9981 9982 9983
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
9984
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
9985
        ret = false;
9986 9987 9988 9989 9990 9991 9992 9993 9994
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
9995 9996
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
9997 9998 9999 10000 10001
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
10002
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10003 10004 10005
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10006
static bool
10007 10008
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
10009
    const char *name = NULL;
10010
    virNodeDevicePtr device;
E
Eric Blake 已提交
10011
    bool ret = true;
10012

10013
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10014
        return false;
10015
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10016
        return false;
10017
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10018
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10019
        return false;
10020 10021 10022 10023 10024
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
10025
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
10026
        ret = false;
10027 10028 10029 10030 10031 10032 10033 10034 10035
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
10036 10037
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
10038 10039 10040 10041 10042
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
10043
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10044 10045 10046
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10047
static bool
10048 10049
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
10050
    const char *name = NULL;
10051
    virNodeDevicePtr device;
E
Eric Blake 已提交
10052
    bool ret = true;
10053

10054
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10055
        return false;
10056
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10057
        return false;
10058
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10059
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10060
        return false;
10061 10062 10063 10064 10065
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
10066
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
10067
        ret = false;
10068 10069 10070 10071 10072
    }
    virNodeDeviceFree(device);
    return ret;
}

10073
/*
E
Eric Blake 已提交
10074
 * "hostname" command
10075
 */
10076
static const vshCmdInfo info_hostname[] = {
10077
    {"help", N_("print the hypervisor hostname")},
10078
    {"desc", ""},
10079 10080 10081
    {NULL, NULL}
};

E
Eric Blake 已提交
10082
static bool
10083
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10084 10085 10086
{
    char *hostname;

10087
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10088
        return false;
10089 10090 10091

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
10092
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
10093
        return false;
10094 10095 10096
    }

    vshPrint (ctl, "%s\n", hostname);
10097
    VIR_FREE(hostname);
10098

E
Eric Blake 已提交
10099
    return true;
10100 10101 10102 10103 10104
}

/*
 * "uri" command
 */
10105
static const vshCmdInfo info_uri[] = {
10106
    {"help", N_("print the hypervisor canonical URI")},
10107
    {"desc", ""},
10108 10109 10110
    {NULL, NULL}
};

E
Eric Blake 已提交
10111
static bool
10112
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10113 10114 10115
{
    char *uri;

10116
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10117
        return false;
10118 10119 10120

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
10121
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
10122
        return false;
10123 10124 10125
    }

    vshPrint (ctl, "%s\n", uri);
10126
    VIR_FREE(uri);
10127

E
Eric Blake 已提交
10128
    return true;
10129 10130
}

E
Eric Blake 已提交
10131 10132 10133 10134 10135 10136 10137 10138 10139 10140
/*
 * "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 已提交
10141
static bool
E
Eric Blake 已提交
10142 10143 10144 10145 10146
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10147
        return false;
E
Eric Blake 已提交
10148 10149 10150 10151

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
10152
        return false;
E
Eric Blake 已提交
10153 10154 10155 10156 10157
    }

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

E
Eric Blake 已提交
10158
    return true;
E
Eric Blake 已提交
10159 10160
}

10161 10162 10163
/*
 * "vncdisplay" command
 */
10164
static const vshCmdInfo info_vncdisplay[] = {
10165 10166
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
10167 10168 10169
    {NULL, NULL}
};

10170
static const vshCmdOptDef opts_vncdisplay[] = {
10171
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10172 10173 10174
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10175
static bool
10176
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
10177 10178 10179 10180 10181
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10182
    bool ret = false;
10183 10184 10185
    int port = 0;
    char *doc;

10186
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10187
        return false;
10188

J
Jim Meyering 已提交
10189
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10190
        return false;
10191 10192 10193 10194 10195 10196 10197 10198

    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);
10199
    VIR_FREE(doc);
10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217
    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) ||
10218
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
10219 10220 10221 10222 10223 10224
        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 已提交
10225
    ret = true;
10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 10237 10238

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

/*
 * "ttyconsole" command
 */
10239
static const vshCmdInfo info_ttyconsole[] = {
10240 10241
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
10242 10243 10244
    {NULL, NULL}
};

10245
static const vshCmdOptDef opts_ttyconsole[] = {
10246
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10247 10248 10249
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10250
static bool
10251
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
10252 10253 10254 10255 10256
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10257
    bool ret = false;
10258 10259
    char *doc;

10260
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10261
        return false;
10262

J
Jim Meyering 已提交
10263
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10264
        return false;
10265 10266 10267 10268 10269 10270 10271 10272

    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);
10273
    VIR_FREE(doc);
10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285
    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 已提交
10286
    ret = true;
10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298

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

/*
 * "attach-device" command
10299
 */
10300
static const vshCmdInfo info_attach_device[] = {
10301 10302
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
10303 10304 10305
    {NULL, NULL}
};

10306
static const vshCmdOptDef opts_attach_device[] = {
10307 10308 10309
    {"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")},
10310 10311 10312
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10313
static bool
10314
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
10315 10316
{
    virDomainPtr dom;
10317
    const char *from = NULL;
10318
    char *buffer;
W
Wen Congyang 已提交
10319
    int ret;
J
Jim Fehlig 已提交
10320
    unsigned int flags;
10321

10322
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10323
        return false;
10324

J
Jim Meyering 已提交
10325
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10326
        return false;
10327

10328
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10329
        virDomainFree(dom);
E
Eric Blake 已提交
10330
        return false;
10331 10332
    }

10333
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10334
        virshReportError(ctl);
10335
        virDomainFree(dom);
E
Eric Blake 已提交
10336
        return false;
10337
    }
10338

J
Jim Fehlig 已提交
10339
    if (vshCommandOptBool(cmd, "persistent")) {
10340
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10341
        if (virDomainIsActive(dom) == 1)
10342
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10343 10344 10345 10346
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
10347
    VIR_FREE(buffer);
10348 10349

    if (ret < 0) {
10350
        vshError(ctl, _("Failed to attach device from %s"), from);
10351
        virDomainFree(dom);
E
Eric Blake 已提交
10352
        return false;
10353
    } else {
J
Jim Meyering 已提交
10354
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
10355 10356 10357
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10358
    return true;
10359 10360 10361 10362 10363 10364
}


/*
 * "detach-device" command
 */
10365
static const vshCmdInfo info_detach_device[] = {
10366 10367
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
10368 10369 10370
    {NULL, NULL}
};

10371
static const vshCmdOptDef opts_detach_device[] = {
10372 10373 10374
    {"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")},
10375 10376 10377
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10378
static bool
10379
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
10380 10381
{
    virDomainPtr dom;
10382
    const char *from = NULL;
10383
    char *buffer;
W
Wen Congyang 已提交
10384
    int ret;
J
Jim Fehlig 已提交
10385
    unsigned int flags;
10386

10387
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10388
        return false;
10389

J
Jim Meyering 已提交
10390
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10391
        return false;
10392

10393
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10394
        virDomainFree(dom);
E
Eric Blake 已提交
10395
        return false;
10396 10397
    }

10398
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10399
        virshReportError(ctl);
10400
        virDomainFree(dom);
E
Eric Blake 已提交
10401
        return false;
10402
    }
10403

J
Jim Fehlig 已提交
10404
    if (vshCommandOptBool(cmd, "persistent")) {
10405
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10406
        if (virDomainIsActive(dom) == 1)
10407
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10408 10409 10410 10411
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
10412
    VIR_FREE(buffer);
10413 10414

    if (ret < 0) {
10415
        vshError(ctl, _("Failed to detach device from %s"), from);
10416
        virDomainFree(dom);
E
Eric Blake 已提交
10417
        return false;
10418
    } else {
J
Jim Meyering 已提交
10419
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
10420 10421 10422
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10423
    return true;
10424 10425
}

10426

10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439
/*
 * "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")},
10440
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
10441 10442 10443
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10444
static bool
10445 10446 10447
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
10448
    const char *from = NULL;
10449
    char *buffer;
W
Wen Congyang 已提交
10450
    int ret;
10451 10452
    unsigned int flags;

10453
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10454
        return false;
10455 10456

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

10459
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10460
        virDomainFree(dom);
E
Eric Blake 已提交
10461
        return false;
10462 10463 10464
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10465
        virshReportError(ctl);
10466
        virDomainFree(dom);
E
Eric Blake 已提交
10467
        return false;
10468 10469 10470
    }

    if (vshCommandOptBool(cmd, "persistent")) {
10471
        flags = VIR_DOMAIN_AFFECT_CONFIG;
10472
        if (virDomainIsActive(dom) == 1)
10473
           flags |= VIR_DOMAIN_AFFECT_LIVE;
10474
    } else {
10475
        flags = VIR_DOMAIN_AFFECT_LIVE;
10476
    }
10477 10478 10479 10480

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

10481 10482 10483 10484 10485 10486
    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 已提交
10487
        return false;
10488 10489 10490 10491 10492
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10493
    return true;
10494 10495 10496
}


10497 10498 10499
/*
 * "attach-interface" command
 */
10500
static const vshCmdInfo info_attach_interface[] = {
10501 10502
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
10503 10504 10505
    {NULL, NULL}
};

10506
static const vshCmdOptDef opts_attach_interface[] = {
10507 10508 10509 10510 10511 10512
    {"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")},
10513
    {"model", VSH_OT_DATA, 0, N_("model type")},
10514
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
10515 10516 10517
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10518
static bool
10519
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
10520 10521
{
    virDomainPtr dom = NULL;
10522 10523
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
10524
    int typ;
W
Wen Congyang 已提交
10525 10526
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
10527
    unsigned int flags;
10528 10529
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10530

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

J
Jim Meyering 已提交
10534
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10535 10536
        goto cleanup;

10537
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10538 10539
        goto cleanup;

10540 10541 10542 10543
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
10544 10545
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
10546
        goto cleanup;
10547
    }
10548 10549

    /* check interface type */
10550
    if (STREQ(type, "network")) {
10551
        typ = 1;
10552
    } else if (STREQ(type, "bridge")) {
10553 10554
        typ = 2;
    } else {
E
Eric Blake 已提交
10555 10556
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
10557 10558 10559 10560
        goto cleanup;
    }

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

10563
    if (typ == 1)
10564
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
10565
    else if (typ == 2)
10566
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
10567

10568
    if (target != NULL)
10569
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10570
    if (mac != NULL)
10571
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
10572
    if (script != NULL)
10573
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
10574
    if (model != NULL)
10575
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
10576

10577
    virBufferAddLit(&buf, "</interface>\n");
10578

10579 10580
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
10581
        goto cleanup;
10582 10583
    }

10584
    xml = virBufferContentAndReset(&buf);
10585

J
Jim Fehlig 已提交
10586
    if (vshCommandOptBool(cmd, "persistent")) {
10587
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10588
        if (virDomainIsActive(dom) == 1)
10589
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10590
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
10591
    } else {
10592
        ret = virDomainAttachDevice(dom, xml);
10593
    }
10594

10595 10596
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10597
    if (ret != 0) {
L
Laine Stump 已提交
10598
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
10599 10600
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
10601
        functionReturn = true;
J
Jim Fehlig 已提交
10602
    }
10603 10604 10605 10606

 cleanup:
    if (dom)
        virDomainFree(dom);
10607
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10608
    return functionReturn;
10609 10610 10611 10612 10613
}

/*
 * "detach-interface" command
 */
10614
static const vshCmdInfo info_detach_interface[] = {
10615 10616
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
10617 10618 10619
    {NULL, NULL}
};

10620
static const vshCmdOptDef opts_detach_interface[] = {
10621 10622 10623 10624
    {"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")},
10625 10626 10627
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10628
static bool
10629
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
10630 10631 10632 10633 10634 10635 10636
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
10637
    const char *mac =NULL, *type = NULL;
10638
    char *doc;
10639
    char buf[64];
E
Eric Blake 已提交
10640
    int i = 0, diff_mac;
W
Wen Congyang 已提交
10641 10642
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
10643
    unsigned int flags;
10644

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

J
Jim Meyering 已提交
10648
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10649 10650
        goto cleanup;

10651
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10652 10653
        goto cleanup;

10654 10655
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
10656
        goto cleanup;
10657
    }
10658 10659 10660 10661 10662 10663 10664 10665

    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);
10666
    VIR_FREE(doc);
10667
    if (!xml) {
10668
        vshError(ctl, "%s", _("Failed to get interface information"));
10669 10670 10671 10672
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
10673
        vshError(ctl, "%s", _("Failed to get interface information"));
10674 10675 10676
        goto cleanup;
    }

E
Eric Blake 已提交
10677
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
10678 10679 10680
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10681
        vshError(ctl, _("No found interface whose type is %s"), type);
10682 10683 10684
        goto cleanup;
    }

10685 10686 10687 10688 10689 10690
    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;
    }

10691 10692 10693 10694 10695 10696 10697
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10698 10699 10700 10701 10702
            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);
10703 10704 10705 10706 10707 10708 10709
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10710
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
10711 10712 10713 10714 10715
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10716
        vshError(ctl, "%s", _("Failed to allocate memory"));
10717 10718 10719
        goto cleanup;
    }

10720
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
10721
        vshError(ctl, "%s", _("Failed to create XML"));
10722 10723 10724
        goto cleanup;
    }

J
Jim Fehlig 已提交
10725
    if (vshCommandOptBool(cmd, "persistent")) {
10726
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10727
        if (virDomainIsActive(dom) == 1)
10728
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10729 10730 10731 10732 10733 10734 10735 10736
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10737
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
10738
    } else {
J
Jim Meyering 已提交
10739
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
10740
        functionReturn = true;
10741
    }
10742 10743 10744 10745

 cleanup:
    if (dom)
        virDomainFree(dom);
10746
    xmlXPathFreeObject(obj);
10747
    xmlXPathFreeContext(ctxt);
10748 10749 10750 10751
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
10752
    return functionReturn;
10753 10754 10755 10756 10757
}

/*
 * "attach-disk" command
 */
10758
static const vshCmdInfo info_attach_disk[] = {
10759 10760
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
10761 10762 10763
    {NULL, NULL}
};

10764
static const vshCmdOptDef opts_attach_disk[] = {
10765 10766 10767 10768 10769
    {"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")},
10770
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
10771 10772 10773
    {"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")},
10774
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
10775 10776 10777
    {"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")},
10778 10779 10780
    {NULL, 0, 0, NULL}
};

10781 10782 10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 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
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 已提交
10928
static bool
10929
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
10930 10931
{
    virDomainPtr dom = NULL;
10932
    const char *source = NULL, *target = NULL, *driver = NULL,
10933 10934 10935
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
10936 10937
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
10938
    unsigned int flags;
10939
    const char *stype = NULL;
10940 10941
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10942

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

J
Jim Meyering 已提交
10946
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10947 10948
        goto cleanup;

10949
    if (vshCommandOptString(cmd, "source", &source) <= 0)
10950 10951
        goto cleanup;

10952
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10953 10954
        goto cleanup;

10955 10956 10957 10958
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
10959 10960 10961
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
10962
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
10963
        vshError(ctl, "%s", _("missing option"));
10964 10965
        goto cleanup;
    }
10966

10967 10968
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
10969
            isFile = true;
10970
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
10971
        isFile = true;
10972 10973 10974
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
10975 10976 10977
    }

    if (mode) {
10978
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
10979 10980
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
10981 10982 10983 10984 10985
            goto cleanup;
        }
    }

    /* Make XML of disk */
10986
    virBufferAsprintf(&buf, "<disk type='%s'",
10987 10988
                      (isFile) ? "file" : "block");
    if (type)
10989
        virBufferAsprintf(&buf, " device='%s'", type);
10990 10991
    virBufferAddLit(&buf, ">\n");

10992
    if (driver || subdriver)
10993
        virBufferAsprintf(&buf, "  <driver");
10994 10995

    if (driver)
10996
        virBufferAsprintf(&buf, " name='%s'", driver);
10997
    if (subdriver)
10998
        virBufferAsprintf(&buf, " type='%s'", subdriver);
10999 11000
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
11001

11002
    if (driver || subdriver || cache)
11003
        virBufferAddLit(&buf, "/>\n");
11004

11005
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
11006 11007
                      (isFile) ? "file" : "dev",
                      source);
11008
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11009
    if (mode)
11010
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
11011

11012 11013 11014 11015 11016 11017 11018 11019 11020 11021 11022 11023 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
    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;
            }
        }
    }

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

11062 11063
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
11064
        return false;
11065 11066
    }

11067
    xml = virBufferContentAndReset(&buf);
11068

J
Jim Fehlig 已提交
11069
    if (vshCommandOptBool(cmd, "persistent")) {
11070
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11071
        if (virDomainIsActive(dom) == 1)
11072
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11073
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
11074
    } else {
11075
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
11076
    }
11077

11078 11079
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11080
    if (ret != 0) {
L
Laine Stump 已提交
11081
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
11082 11083
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
11084
        functionReturn = true;
J
Jim Fehlig 已提交
11085
    }
11086 11087 11088 11089

 cleanup:
    if (dom)
        virDomainFree(dom);
11090
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11091
    return functionReturn;
11092 11093 11094 11095 11096
}

/*
 * "detach-disk" command
 */
11097
static const vshCmdInfo info_detach_disk[] = {
11098 11099
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
11100 11101 11102
    {NULL, NULL}
};

11103
static const vshCmdOptDef opts_detach_disk[] = {
11104 11105 11106
    {"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")},
11107 11108 11109
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11110
static bool
11111
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
11112 11113 11114 11115 11116 11117 11118
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
11119
    const char *target = NULL;
11120
    char *doc;
E
Eric Blake 已提交
11121
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
11122 11123
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11124
    unsigned int flags;
11125

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

J
Jim Meyering 已提交
11129
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11130 11131
        goto cleanup;

11132
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11133 11134 11135 11136 11137 11138 11139 11140 11141
        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);
11142
    VIR_FREE(doc);
11143
    if (!xml) {
11144
        vshError(ctl, "%s", _("Failed to get disk information"));
11145 11146 11147 11148
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
11149
        vshError(ctl, "%s", _("Failed to get disk information"));
11150 11151 11152 11153 11154 11155
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11156
        vshError(ctl, "%s", _("Failed to get disk information"));
11157 11158 11159 11160 11161 11162 11163
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11164 11165 11166 11167 11168
            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);
11169 11170 11171 11172 11173 11174 11175
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11176
    vshError(ctl, _("No found disk whose target is %s"), target);
11177 11178 11179 11180 11181
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11182
        vshError(ctl, "%s", _("Failed to allocate memory"));
11183 11184 11185
        goto cleanup;
    }

11186
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
11187
        vshError(ctl, "%s", _("Failed to create XML"));
11188 11189 11190
        goto cleanup;
    }

J
Jim Fehlig 已提交
11191
    if (vshCommandOptBool(cmd, "persistent")) {
11192
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11193
        if (virDomainIsActive(dom) == 1)
11194
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11195 11196 11197 11198 11199 11200 11201 11202
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11203
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
11204
    } else {
J
Jim Meyering 已提交
11205
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
11206
        functionReturn = true;
11207
    }
11208 11209

 cleanup:
11210
    xmlXPathFreeObject(obj);
11211
    xmlXPathFreeContext(ctxt);
11212 11213 11214 11215 11216 11217
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
11218
    return functionReturn;
11219 11220
}

11221 11222 11223 11224
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
11225 11226
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
11227 11228 11229 11230
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
11231
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
11232 11233 11234
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11235
static bool
11236 11237
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
11238
    const char *from = NULL;
E
Eric Blake 已提交
11239
    bool ret = true;
11240 11241 11242
    char *buffer;
    int result;

11243
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11244
        return false;
11245

11246
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11247
        return false;
11248 11249

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
11253
    VIR_FREE(buffer);
11254 11255 11256 11257 11258

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
11259
        ret = false;
11260 11261 11262 11263 11264
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
11265
        ret = true;
11266 11267 11268 11269 11270
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
11271
        ret = true;
11272 11273 11274 11275 11276
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
11277
        ret = false;
11278 11279 11280 11281 11282
    }

    return ret;
}

11283 11284 11285 11286
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
11287 11288
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
11289 11290 11291 11292
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
11293
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
11294 11295 11296
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11297
static bool
11298 11299
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
11300
    const char *from = NULL;
E
Eric Blake 已提交
11301
    bool ret = true;
11302 11303 11304 11305 11306
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
11307
    xmlNodePtr node_list;
11308 11309 11310 11311 11312 11313
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

11314
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11315
        return false;
11316

11317
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11318
        return false;
11319 11320

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
11321
        return false;
11322 11323 11324 11325 11326

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

L
Laine Stump 已提交
11327 11328
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
11329 11330
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
11331
        ret = false;
11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367
        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 已提交
11368
        ret = false;
11369 11370 11371 11372 11373 11374 11375 11376
        goto cleanup;
    }

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

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
11377
        ret = false;
11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394

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 已提交
11395
    ret = false;
11396
    goto cleanup;
11397 11398
}

11399 11400 11401 11402 11403 11404 11405 11406
/* 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;

11407
    ret = vshMalloc(ctl, PATH_MAX);
11408 11409 11410

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
11411 11412
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
11413
    if (fd == -1) {
11414
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
11415
                 strerror(errno));
11416
        VIR_FREE(ret);
11417 11418 11419 11420
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
11421 11422
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
11423
        VIR_FORCE_CLOSE(fd);
11424
        unlink (ret);
11425
        VIR_FREE(ret);
11426 11427
        return NULL;
    }
S
Stefan Berger 已提交
11428
    if (VIR_CLOSE(fd) < 0) {
11429 11430
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
11431
        unlink (ret);
11432
        VIR_FREE(ret);
11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447
        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 已提交
11448 11449 11450 11451
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
11452

11453
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
11454 11455 11456 11457
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
11458

11459 11460 11461 11462 11463
    /* 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 已提交
11464 11465
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
11466
     */
E
Eric Blake 已提交
11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478
    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);
11479 11480
    }

E
Eric Blake 已提交
11481 11482 11483 11484 11485 11486 11487
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
11488
    }
E
Eric Blake 已提交
11489
    ret = 0;
11490

E
Eric Blake 已提交
11491 11492 11493
cleanup:
    virCommandFree(cmd);
    return ret;
11494 11495 11496 11497 11498 11499 11500 11501
}

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

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
11502
        vshError(ctl,
11503
                 _("%s: failed to read temporary file: %s"),
11504
                 filename, strerror(errno));
11505 11506 11507 11508 11509
        return NULL;
    }
    return ret;
}

11510

P
Paolo Bonzini 已提交
11511 11512 11513 11514
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
11515 11516
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
11517 11518 11519 11520
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11525
static bool
11526
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
11527
{
11528
    const char *dir = NULL;
11529
    char *dir_malloced = NULL;
E
Eric Blake 已提交
11530
    bool ret = true;
P
Paolo Bonzini 已提交
11531 11532

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

11537
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
11538
        uid_t uid = geteuid();
11539
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
11540 11541 11542 11543
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
11544
    if (chdir(dir) == -1) {
11545
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
11546
        ret = false;
P
Paolo Bonzini 已提交
11547 11548
    }

11549
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
11550
    return ret;
P
Paolo Bonzini 已提交
11551 11552 11553 11554 11555 11556
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
11557 11558
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
11559 11560 11561
    {NULL, NULL}
};

E
Eric Blake 已提交
11562
static bool
P
Paolo Bonzini 已提交
11563 11564 11565
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
11566
    bool ret = true;
P
Paolo Bonzini 已提交
11567

11568 11569
    cwd = getcwd(NULL, 0);
    if (!cwd) {
11570 11571
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
11572 11573
        ret = false;
    } else {
P
Paolo Bonzini 已提交
11574
        vshPrint (ctl, _("%s\n"), cwd);
11575 11576
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
11577

11578
    return ret;
P
Paolo Bonzini 已提交
11579 11580
}

E
Eric Blake 已提交
11581 11582 11583 11584 11585 11586 11587 11588 11589 11590 11591 11592
/*
 * "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")},
11593
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
11594 11595 11596 11597 11598 11599
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
11600
static bool
E
Eric Blake 已提交
11601 11602 11603 11604 11605
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
11606
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
11607 11608 11609 11610 11611 11612 11613 11614
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

11615
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
11616 11617 11618
        bool close_quote = false;
        char *q;

11619
        arg = opt->data;
E
Eric Blake 已提交
11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647
        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 已提交
11648
        return false;
E
Eric Blake 已提交
11649 11650 11651 11652 11653
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
11654
    return true;
E
Eric Blake 已提交
11655 11656
}

11657 11658 11659 11660
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
11661 11662
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
11663 11664 11665 11666
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
11667
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11668 11669 11670 11671 11672 11673
    {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 已提交
11674
static bool
11675 11676
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
11677
    bool ret = false;
11678 11679 11680 11681 11682
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
11683
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
11684

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

J
Jim Meyering 已提交
11688
    dom = vshCommandOptDomain (ctl, cmd, NULL);
11689 11690 11691 11692
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
11693
    doc = virDomainGetXMLDesc (dom, flags);
11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711
    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 已提交
11712
        ret = true;
11713 11714 11715 11716 11717 11718 11719
        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.
     */
11720
    doc_reread = virDomainGetXMLDesc (dom, flags);
11721 11722 11723 11724
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
11725 11726
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738
        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 已提交
11739
    ret = true;
11740 11741 11742 11743 11744

 cleanup:
    if (dom)
        virDomainFree (dom);

11745 11746 11747
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
11748 11749 11750

    if (tmp) {
        unlink (tmp);
11751
        VIR_FREE(tmp);
11752 11753 11754 11755 11756
    }

    return ret;
}

11757

11758 11759 11760 11761
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
11762 11763
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
11764 11765 11766 11767
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
11768
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
11769 11770 11771 11772 11773 11774 11775 11776 11777 11778
    {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[] = {
11779 11780
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
11781 11782 11783 11784
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
11785
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
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-pool-edit.c"

K
Karel Zak 已提交
11792 11793 11794
/*
 * "quit" command
 */
11795
static const vshCmdInfo info_quit[] = {
11796
    {"help", N_("quit this interactive terminal")},
11797
    {"desc", ""},
11798
    {NULL, NULL}
K
Karel Zak 已提交
11799 11800
};

E
Eric Blake 已提交
11801
static bool
11802
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11803
{
E
Eric Blake 已提交
11804 11805
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
11806 11807
}

11808 11809 11810 11811
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
11812 11813
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
11814 11815 11816 11817 11818 11819 11820 11821 11822
    {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 已提交
11823
static bool
11824 11825 11826
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11827
    bool ret = false;
11828
    const char *from = NULL;
11829 11830 11831 11832 11833 11834 11835
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

11836
    if (!vshConnectionUsability(ctl, ctl->conn))
11837 11838 11839 11840 11841 11842
        goto cleanup;

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

11843
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
11844
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 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
    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 已提交
11889
    ret = true;
11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905

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

11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918
/*
 * "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 已提交
11919
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 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
    {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)
        virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    if (desc)
        virBufferAsprintf(&buf, "  <description>%s</description>\n", desc);
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
11964 11965 11966 11967 11968 11969
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 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
    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;
}

12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
    {"help", N_("Get the current snapshot")},
    {"desc", N_("Get the current snapshot")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
12027
static bool
12028 12029 12030
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12031
    bool ret = false;
12032 12033 12034
    int current;
    virDomainSnapshotPtr snapshot = NULL;

12035
    if (!vshConnectionUsability(ctl, ctl->conn))
12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058
        goto cleanup;

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

    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
        char *xml;

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

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

        vshPrint(ctl, "%s", xml);
        VIR_FREE(xml);
    }

E
Eric Blake 已提交
12059
    ret = true;
12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083

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

    return ret;
}

/*
 * "snapshot-list" command
 */
static const vshCmdInfo info_snapshot_list[] = {
    {"help", N_("List snapshots for a domain")},
    {"desc", N_("Snapshot List")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
12084
static bool
12085 12086 12087
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12088
    bool ret = false;
12089 12090
    int numsnaps;
    char **names = NULL;
12091
    int actual = 0;
12092 12093 12094 12095 12096 12097
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
12098 12099
    long long creation_longlong;
    time_t creation_time_t;
12100 12101 12102
    char timestr[100];
    struct tm time_info;

12103
    if (!vshConnectionUsability(ctl, ctl->conn))
12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114
        goto cleanup;

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

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

12115 12116
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157

    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;
12158 12159
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
12160
                continue;
12161 12162 12163 12164 12165 12166
            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);
12167
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
12168 12169 12170 12171 12172

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

E
Eric Blake 已提交
12173
    ret = true;
12174 12175 12176 12177 12178 12179 12180 12181 12182 12183

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);
12184 12185
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207
    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 已提交
12208
static bool
12209 12210 12211
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12212
    bool ret = false;
12213
    const char *name = NULL;
12214 12215 12216
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

12217
    if (!vshConnectionUsability(ctl, ctl->conn))
12218 12219 12220 12221 12222 12223
        goto cleanup;

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

12224
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12225 12226 12227 12228 12229 12230 12231 12232 12233 12234
        goto cleanup;

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

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

12235
    vshPrint(ctl, "%s", xml);
12236

E
Eric Blake 已提交
12237
    ret = true;
12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249

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

    return ret;
}

/*
12250
 * "snapshot-revert" command
12251
 */
12252
static const vshCmdInfo info_snapshot_revert[] = {
12253 12254 12255 12256 12257
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

12258
static const vshCmdOptDef opts_snapshot_revert[] = {
12259 12260 12261 12262 12263
    {"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 已提交
12264
static bool
12265
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
12266 12267
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12268
    bool ret = false;
12269
    const char *name = NULL;
12270 12271
    virDomainSnapshotPtr snapshot = NULL;

12272
    if (!vshConnectionUsability(ctl, ctl->conn))
12273 12274 12275 12276 12277 12278
        goto cleanup;

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

12279
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12280 12281 12282 12283 12284 12285 12286 12287 12288
        goto cleanup;

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

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

E
Eric Blake 已提交
12289
    ret = true;
12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315

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 已提交
12316
static bool
12317 12318 12319
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12320
    bool ret = false;
12321
    const char *name = NULL;
12322 12323 12324
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

12325
    if (!vshConnectionUsability(ctl, ctl->conn))
12326 12327 12328 12329 12330 12331
        goto cleanup;

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

12332
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
12333 12334 12335 12336 12337 12338 12339 12340 12341
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;

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

12342 12343 12344 12345
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
        vshPrint(ctl, _("Domain snapshot %s deleted\n"), name);
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
12346
        goto cleanup;
12347
    }
12348

E
Eric Blake 已提交
12349
    ret = true;
12350 12351 12352 12353 12354 12355 12356 12357 12358 12359

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

    return ret;
}

12360 12361 12362 12363
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
12364 12365
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
12366 12367 12368 12369 12370 12371
    {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")},
12372
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
12373 12374 12375
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12376
static bool
12377 12378 12379
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12380
    bool ret = false;
12381
    const char *monitor_cmd = NULL;
12382
    char *result = NULL;
12383
    unsigned int flags = 0;
12384 12385 12386 12387 12388 12389 12390 12391

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

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

12392
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
12393 12394 12395 12396
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

12397 12398 12399 12400
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
12401 12402 12403 12404
        goto cleanup;

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

E
Eric Blake 已提交
12405
    ret = true;
12406 12407 12408 12409 12410 12411 12412 12413 12414

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

    return ret;
}

12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460
/*
 * "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;
}

12461
static const vshCmdDef domManagementCmds[] = {
12462 12463 12464 12465 12466 12467 12468 12469
    {"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},
12470 12471
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
12472
#ifndef WIN32
12473
    {"console", cmdConsole, opts_console, info_console, 0},
12474
#endif
12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497
    {"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},
12498
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
12499 12500 12501 12502 12503 12504 12505 12506
    {"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},
12507 12508
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
12509 12510 12511 12512
    {"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},
12513 12514 12515 12516 12517 12518
    {"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},
12519
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
12520
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
12521 12522 12523 12524 12525 12526 12527 12528 12529 12530 12531 12532
    {"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 已提交
12533
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
12534
    {"version", cmdVersion, opts_version, info_version, 0},
12535 12536
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
12537 12538 12539
};

static const vshCmdDef domMonitoringCmds[] = {
12540 12541
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
12542
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
12543 12544 12545 12546 12547 12548
    {"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}
12549 12550 12551
};

static const vshCmdDef storagePoolCmds[] = {
12552
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
12553
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
12554
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
12555 12556 12557 12558 12559 12560 12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575
     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}
12576 12577 12578
};

static const vshCmdDef storageVolCmds[] = {
12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596
    {"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}
12597
};
12598

12599
static const vshCmdDef networkCmds[] = {
12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618
    {"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}
12619
};
12620

12621
static const vshCmdDef nodedevCmds[] = {
12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633 12634 12635 12636
    {"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}
12637 12638 12639
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
12640 12641 12642 12643
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
12644 12645 12646 12647 12648 12649 12650 12651 12652 12653 12654 12655 12656 12657
    {"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 已提交
12658 12659
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
12660 12661 12662 12663 12664
    {"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}
12665
};
12666

12667
static const vshCmdDef nwfilterCmds[] = {
12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678
    {"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}
12679
};
12680

12681
static const vshCmdDef secretCmds[] = {
12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693
    {"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}
12694
};
12695

12696
static const vshCmdDef virshCmds[] = {
12697 12698 12699 12700 12701 12702 12703
    {"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}
12704
};
12705

12706
static const vshCmdDef snapshotCmds[] = {
12707 12708
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
12709 12710
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721
    {"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}
12722
};
12723

12724
static const vshCmdDef hostAndHypervisorCmds[] = {
12725 12726 12727 12728 12729
    {"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},
12730
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
12731
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
12732
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
12733
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
12734 12735 12736 12737 12738
    {"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 已提交
12739 12740
};

12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757
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 已提交
12758 12759 12760 12761
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
12762
static const char *
12763
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
12764
{
12765
    const vshCmdInfo *info;
12766

K
Karel Zak 已提交
12767
    for (info = cmd->info; info && info->name; info++) {
12768
        if (STREQ(info->name, name))
K
Karel Zak 已提交
12769 12770 12771 12772 12773
            return info->data;
    }
    return NULL;
}

12774
static int
E
Eric Blake 已提交
12775
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
12776 12777 12778 12779 12780
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
12781 12782 12783
    *opts_need_arg = 0;
    *opts_required = 0;

12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796
    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 已提交
12797 12798 12799 12800 12801 12802
        if (opt->flag & VSH_OFLAG_REQ_OPT) {
            if (opt->flag & VSH_OFLAG_REQ)
                *opts_required |= 1 << i;
            continue;
        }

12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814
        *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;
}

12815
static const vshCmdOptDef *
12816 12817
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
12818
{
12819 12820 12821 12822
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
12823

12824 12825 12826 12827 12828
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
12829 12830 12831 12832 12833
            if (opt->type == VSH_OT_ARGV) {
                vshError(ctl, _("variable argument <%s> "
                         "should not be used with --<%s>"), name, name);
                return NULL;
            }
12834
            *opts_seen |= 1 << i;
K
Karel Zak 已提交
12835
            return opt;
12836 12837 12838 12839 12840
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
12841 12842 12843
    return NULL;
}

12844
static const vshCmdOptDef *
12845 12846
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
12847
{
12848
    int i;
12849
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
12850

12851 12852 12853 12854
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
12855
    i = ffs(*opts_need_arg) - 1;
12856 12857 12858 12859 12860
    opt = &cmd->opts[i];
    if (opt->type != VSH_OT_ARGV)
        *opts_need_arg &= ~(1 << i);
    *opts_seen |= 1 << i;
    return opt;
K
Karel Zak 已提交
12861 12862
}

12863 12864 12865
/*
 * Checks for required options
 */
12866
static int
12867 12868
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
12869
{
12870
    const vshCmdDef *def = cmd->def;
12871 12872 12873 12874 12875 12876 12877 12878 12879
    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];
12880

12881
            vshError(ctl,
12882
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
12883 12884 12885
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
12886 12887
        }
    }
12888
    return -1;
12889 12890
}

12891
static const vshCmdDef *
12892 12893
vshCmddefSearch(const char *cmdname)
{
12894
    const vshCmdGrp *g;
12895
    const vshCmdDef *c;
12896

12897 12898
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
12899
            if (STREQ(c->name, cmdname))
12900 12901 12902 12903
                return c;
        }
    }

K
Karel Zak 已提交
12904 12905 12906
    return NULL;
}

12907 12908 12909 12910 12911 12912
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
12913
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
12914 12915 12916 12917 12918 12919
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
12920
static bool
12921 12922 12923 12924 12925 12926 12927
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 已提交
12928
        return false;
12929 12930 12931 12932 12933 12934 12935 12936 12937 12938
    } 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 已提交
12939
    return true;
12940 12941
}

E
Eric Blake 已提交
12942
static bool
12943
vshCmddefHelp(vshControl *ctl, const char *cmdname)
12944
{
12945
    const vshCmdDef *def = vshCmddefSearch(cmdname);
12946

K
Karel Zak 已提交
12947
    if (!def) {
12948
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
12949
        return false;
12950
    } else {
E
Eric Blake 已提交
12951 12952
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
12953
        const char *help = _(vshCmddefGetInfo(def, "help"));
12954
        char buf[256];
12955 12956 12957 12958 12959 12960
        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 已提交
12961
            return false;
12962
        }
K
Karel Zak 已提交
12963

12964
        fputs(_("  NAME\n"), stdout);
12965 12966
        fprintf(stdout, "    %s - %s\n", def->name, help);

12967 12968 12969 12970 12971
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
12972
                const char *fmt = "%s";
12973 12974
                switch (opt->type) {
                case VSH_OT_BOOL:
12975
                    fmt = "[--%s]";
12976 12977
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
12978
                    /* xgettext:c-format */
12979 12980
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
12981 12982
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
12983 12984
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
12985 12986
                    break;
                case VSH_OT_DATA:
12987
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
12988 12989 12990
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
12991 12992
                    fmt = (opt->flag & VSH_OFLAG_REQ) ? _("<%s>...")
                           : _("[<%s>]...");
12993 12994
                    break;
                default:
12995
                    assert(0);
12996
                }
12997
                fputc(' ', stdout);
E
Eric Blake 已提交
12998
                fprintf(stdout, fmt, opt->name);
12999
            }
K
Karel Zak 已提交
13000
        }
13001 13002 13003
        fputc('\n', stdout);

        if (desc[0]) {
13004
            /* Print the description only if it's not empty.  */
13005
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
13006
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
13007
        }
13008

K
Karel Zak 已提交
13009
        if (def->opts) {
13010
            const vshCmdOptDef *opt;
13011
            fputs(_("\n  OPTIONS\n"), stdout);
13012
            for (opt = def->opts; opt->name; opt++) {
13013 13014
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
13015
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
13016 13017
                    break;
                case VSH_OT_INT:
13018 13019 13020
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
13021 13022
                    break;
                case VSH_OT_STRING:
13023
                    /* OT_STRING should never be VSH_OFLAG_REQ */
13024
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
13025 13026
                    break;
                case VSH_OT_DATA:
13027 13028
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
13029 13030 13031
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
13032 13033
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
13034 13035 13036
                default:
                    assert(0);
                }
13037

E
Eric Blake 已提交
13038
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
13039
            }
K
Karel Zak 已提交
13040 13041 13042
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
13043
    return true;
K
Karel Zak 已提交
13044 13045 13046 13047 13048 13049
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
13050 13051 13052
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
13053 13054
    vshCmdOpt *a = arg;

13055
    while (a) {
K
Karel Zak 已提交
13056
        vshCmdOpt *tmp = a;
13057

K
Karel Zak 已提交
13058 13059
        a = a->next;

13060 13061
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
13062 13063 13064 13065
    }
}

static void
13066
vshCommandFree(vshCmd *cmd)
13067
{
K
Karel Zak 已提交
13068 13069
    vshCmd *c = cmd;

13070
    while (c) {
K
Karel Zak 已提交
13071
        vshCmd *tmp = c;
13072

K
Karel Zak 已提交
13073 13074 13075 13076
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
13077
        VIR_FREE(tmp);
K
Karel Zak 已提交
13078 13079 13080
    }
}

E
Eric Blake 已提交
13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091
/**
 * 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 已提交
13092
 */
E
Eric Blake 已提交
13093 13094
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
13095
{
E
Eric Blake 已提交
13096 13097
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
13098

E
Eric Blake 已提交
13099 13100 13101 13102 13103 13104 13105
    /* 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 已提交
13106
    }
E
Eric Blake 已提交
13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118

    /* 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 已提交
13119 13120
}

E
Eric Blake 已提交
13121 13122
/**
 * vshCommandOptInt:
13123 13124 13125 13126 13127 13128 13129
 * @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 已提交
13130
 * 0 if option not found and not required (@value untouched)
13131
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
13132 13133
 */
static int
13134
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
13135
{
E
Eric Blake 已提交
13136 13137 13138
    vshCmdOpt *arg;
    int ret;
    int num;
13139
    char *end_p = NULL;
13140

E
Eric Blake 已提交
13141 13142 13143 13144 13145 13146 13147
    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;
13148
    }
E
Eric Blake 已提交
13149 13150 13151 13152 13153 13154 13155

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
13156 13157
}

13158

E
Eric Blake 已提交
13159 13160 13161 13162 13163 13164
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
13165 13166 13167 13168 13169 13170
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
13171 13172 13173
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
13174 13175
    char *end_p = NULL;

E
Eric Blake 已提交
13176 13177 13178 13179 13180 13181 13182
    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;
13183
    }
E
Eric Blake 已提交
13184 13185 13186 13187 13188 13189 13190

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13191 13192 13193
}


13194
/*
E
Eric Blake 已提交
13195 13196 13197 13198 13199
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
13200 13201 13202 13203 13204
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
13205
{
E
Eric Blake 已提交
13206 13207
    vshCmdOpt *arg;
    int ret;
13208
    unsigned long num;
13209 13210
    char *end_p = NULL;

E
Eric Blake 已提交
13211 13212 13213 13214 13215 13216 13217
    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;
13218
    }
E
Eric Blake 已提交
13219 13220 13221 13222 13223 13224 13225

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13226 13227
}

E
Eric Blake 已提交
13228 13229 13230 13231 13232 13233
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
13234
 * Returns option as STRING
E
Eric Blake 已提交
13235 13236 13237 13238
 * 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 已提交
13239
 */
13240 13241
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
13242
{
E
Eric Blake 已提交
13243 13244 13245 13246 13247 13248 13249 13250 13251 13252
    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;
13253
    }
13254

E
Eric Blake 已提交
13255 13256 13257 13258 13259
    if (!*arg->data && !(arg->def->flag & VSH_OFLAG_EMPTY_OK)) {
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
13260 13261
}

E
Eric Blake 已提交
13262 13263 13264 13265 13266 13267
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
13268
 * Returns option as long long
13269
 * See vshCommandOptInt()
13270
 */
13271 13272 13273
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
13274
{
E
Eric Blake 已提交
13275 13276
    vshCmdOpt *arg;
    int ret;
13277
    long long num;
13278 13279
    char *end_p = NULL;

E
Eric Blake 已提交
13280 13281 13282 13283 13284 13285 13286
    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;
13287
    }
E
Eric Blake 已提交
13288 13289 13290 13291 13292 13293 13294

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13295 13296
}

E
Eric Blake 已提交
13297 13298 13299 13300 13301 13302 13303 13304 13305
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
13306 13307 13308 13309
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
13310 13311
    vshCmdOpt *arg;
    int ret;
13312 13313 13314
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
13315 13316 13317 13318 13319 13320 13321
    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;
13322
    }
E
Eric Blake 已提交
13323 13324 13325 13326 13327 13328 13329

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
13330 13331 13332
}


E
Eric Blake 已提交
13333 13334 13335 13336 13337 13338 13339 13340 13341
/**
 * 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 已提交
13342
 */
E
Eric Blake 已提交
13343
static bool
13344
vshCommandOptBool(const vshCmd *cmd, const char *name)
13345
{
E
Eric Blake 已提交
13346 13347 13348
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
13349 13350
}

E
Eric Blake 已提交
13351 13352 13353 13354 13355
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
13356 13357
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
13358
 *
13359
 * Requires that a VSH_OT_ARGV option be last in the
13360 13361
 * list of supported options in CMD->def->opts.
 */
13362 13363
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
13364
{
13365
    opt = opt ? opt->next : cmd->opts;
13366 13367

    while (opt) {
E
Eric Blake 已提交
13368
        if (opt->def->type == VSH_OT_ARGV) {
13369
            return opt;
13370 13371 13372 13373 13374 13375
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
13376 13377 13378 13379 13380 13381 13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392 13393
/* 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)
13394
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
13395 13396 13397
                 cmd->def->name, optname);
    return found;
}
13398

K
Karel Zak 已提交
13399
static virDomainPtr
J
Jim Meyering 已提交
13400
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
13401
                      const char **name, int flag)
13402
{
K
Karel Zak 已提交
13403
    virDomainPtr dom = NULL;
13404
    const char *n = NULL;
K
Karel Zak 已提交
13405
    int id;
J
Jim Meyering 已提交
13406 13407 13408
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
13409

13410
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13411 13412
        return NULL;

13413
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13414 13415
             cmd->def->name, optname, n);

K
Karel Zak 已提交
13416 13417
    if (name)
        *name = n;
13418

K
Karel Zak 已提交
13419
    /* try it by ID */
13420
    if (flag & VSH_BYID) {
13421
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
13422 13423
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
13424 13425 13426
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
13427
    }
K
Karel Zak 已提交
13428
    /* try it by UUID */
13429
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
13430
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
13431
                 cmd->def->name, optname);
K
Karel Zak 已提交
13432
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
13433
    }
K
Karel Zak 已提交
13434
    /* try it by NAME */
13435
    if (dom==NULL && (flag & VSH_BYNAME)) {
13436
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
13437
                 cmd->def->name, optname);
K
Karel Zak 已提交
13438
        dom = virDomainLookupByName(ctl->conn, n);
13439
    }
K
Karel Zak 已提交
13440

13441
    if (!dom)
13442
        vshError(ctl, _("failed to get domain '%s'"), n);
13443

K
Karel Zak 已提交
13444 13445 13446
    return dom;
}

13447
static virNetworkPtr
J
Jim Meyering 已提交
13448
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
13449
                       const char **name, int flag)
13450 13451
{
    virNetworkPtr network = NULL;
13452
    const char *n = NULL;
J
Jim Meyering 已提交
13453 13454 13455
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
13456

13457
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13458 13459
        return NULL;

13460
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13461 13462 13463 13464 13465 13466
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
13467
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13468
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
13469
                 cmd->def->name, optname);
13470 13471 13472 13473
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
13474
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
13475 13476 13477 13478 13479
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
13480
        vshError(ctl, _("failed to get network '%s'"), n);
13481 13482 13483 13484

    return network;
}

13485 13486 13487

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
13488
                        const char **name, int flag)
13489 13490
{
    virNWFilterPtr nwfilter = NULL;
13491
    const char *n = NULL;
13492 13493 13494 13495
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13496
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13497 13498
        return NULL;

13499
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13500 13501 13502 13503 13504 13505 13506
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13507
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
13508 13509 13510 13511 13512
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
13513
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
13514 13515 13516 13517 13518 13519 13520 13521 13522 13523
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

13524 13525
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
13526
                         const char **name, int flag)
13527 13528
{
    virInterfacePtr iface = NULL;
13529
    const char *n = NULL;
13530 13531 13532 13533
    const char *optname = "interface";
    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
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
13544
    if ((flag & VSH_BYNAME)) {
13545
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
13546 13547 13548 13549 13550
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
13551
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
13552 13553 13554 13555 13556
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
13557
        vshError(ctl, _("failed to get interface '%s'"), n);
13558 13559 13560 13561

    return iface;
}

13562
static virStoragePoolPtr
13563
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
13564
                    const char **name, int flag)
13565 13566
{
    virStoragePoolPtr pool = NULL;
13567
    const char *n = NULL;
13568

13569
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13570 13571
        return NULL;

13572
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13573 13574 13575 13576 13577 13578
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
13579
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13580
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
13581
                 cmd->def->name, optname);
13582 13583 13584
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
13585
    if (pool == NULL && (flag & VSH_BYNAME)) {
13586
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
13587 13588 13589 13590 13591
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
13592
        vshError(ctl, _("failed to get pool '%s'"), n);
13593 13594 13595 13596 13597

    return pool;
}

static virStorageVolPtr
13598
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
13599 13600
                   const char *optname,
                   const char *pooloptname,
13601
                   const char **name, int flag)
13602 13603 13604
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
13605
    const char *n = NULL, *p = NULL;
13606

13607
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13608 13609
        return NULL;

13610 13611
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
13612
        return NULL;
13613
    }
13614 13615 13616 13617

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

13618
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
13619 13620 13621 13622 13623
             cmd->def->name, optname, n);

    if (name)
        *name = n;

13624
    /* try it by name */
13625
    if (pool && (flag & VSH_BYNAME)) {
13626
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
13627 13628 13629
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
13630
    /* try it by key */
13631
    if (vol == NULL && (flag & VSH_BYUUID)) {
13632
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
13633 13634 13635
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
13636
    /* try it by path */
13637
    if (vol == NULL && (flag & VSH_BYUUID)) {
13638
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
13639 13640 13641 13642 13643
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
13644
        vshError(ctl, _("failed to get vol '%s'"), n);
13645 13646 13647 13648 13649 13650 13651

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

13652
static virSecretPtr
13653
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
13654 13655
{
    virSecretPtr secret = NULL;
13656
    const char *n = NULL;
13657 13658 13659 13660 13661
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13662
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13663 13664
        return NULL;

13665 13666
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
13667 13668 13669 13670 13671 13672 13673

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
13674
        vshError(ctl, _("failed to get secret '%s'"), n);
13675 13676 13677 13678

    return secret;
}

K
Karel Zak 已提交
13679 13680 13681
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
13682
static bool
13683
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
13684
{
E
Eric Blake 已提交
13685
    bool ret = true;
13686 13687

    while (cmd) {
K
Karel Zak 已提交
13688
        struct timeval before, after;
13689
        bool enable_timing = ctl->timing;
13690

13691 13692
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
13693 13694
            vshReconnect(ctl);

13695
        if (enable_timing)
K
Karel Zak 已提交
13696
            GETTIMEOFDAY(&before);
13697

K
Karel Zak 已提交
13698 13699
        ret = cmd->def->handler(ctl, cmd);

13700
        if (enable_timing)
K
Karel Zak 已提交
13701
            GETTIMEOFDAY(&after);
13702

13703
        if (!ret)
J
John Levon 已提交
13704 13705
            virshReportError(ctl);

13706
        /* try to automatically catch disconnections */
13707
        if (!ret &&
13708 13709 13710 13711 13712 13713 13714 13715 13716
            ((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);

13717
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
13718 13719
            return ret;

13720
        if (enable_timing)
13721
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
13722 13723
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
13724
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
13725 13726 13727 13728 13729 13730
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
13731
 * Command parsing
K
Karel Zak 已提交
13732 13733 13734
 * ---------------
 */

13735 13736 13737 13738 13739 13740 13741 13742 13743 13744
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 已提交
13745
    /* vshCommandStringGetArg() */
13746
    char *pos;
L
Lai Jiangshan 已提交
13747 13748 13749
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
13750 13751
} vshCommandParser;

E
Eric Blake 已提交
13752
static bool
13753
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
13754
{
K
Karel Zak 已提交
13755 13756 13757
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
13758

K
Karel Zak 已提交
13759 13760 13761 13762
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
13763

13764
    while (1) {
K
Karel Zak 已提交
13765
        vshCmdOpt *last = NULL;
13766
        const vshCmdDef *cmd = NULL;
13767
        vshCommandToken tk;
L
Lai Jiangshan 已提交
13768
        bool data_only = false;
13769 13770 13771
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
13772

K
Karel Zak 已提交
13773
        first = NULL;
13774

13775
        while (1) {
13776
            const vshCmdOptDef *opt = NULL;
13777

K
Karel Zak 已提交
13778
            tkdata = NULL;
13779
            tk = parser->getNextArg(ctl, parser, &tkdata);
13780 13781

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
13782
                goto syntaxError;
H
Hu Tao 已提交
13783 13784
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
13785
                break;
H
Hu Tao 已提交
13786
            }
13787 13788

            if (cmd == NULL) {
K
Karel Zak 已提交
13789 13790
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
13791
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
13792
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
13793
                }
13794 13795 13796 13797 13798 13799 13800
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
13801
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
13802 13803 13804 13805
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
13806 13807 13808 13809 13810
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
13811 13812
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
13813
                    VIR_FREE(optstr);
K
Karel Zak 已提交
13814 13815
                    goto syntaxError;
                }
13816
                VIR_FREE(tkdata);
K
Karel Zak 已提交
13817 13818 13819

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
13820 13821 13822
                    if (optstr)
                        tkdata = optstr;
                    else
13823
                        tk = parser->getNextArg(ctl, parser, &tkdata);
13824
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
13825
                        goto syntaxError;
13826
                    if (tk != VSH_TK_ARG) {
13827
                        vshError(ctl,
13828
                                 _("expected syntax: --%s <%s>"),
13829 13830
                                 opt->name,
                                 opt->type ==
13831
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
13832 13833
                        goto syntaxError;
                    }
13834
                    opts_need_arg &= ~opts_seen;
13835 13836 13837 13838 13839 13840 13841 13842
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
13843
                }
L
Lai Jiangshan 已提交
13844 13845 13846 13847
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
13848
            } else {
L
Lai Jiangshan 已提交
13849
get_data:
13850 13851
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
13852
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
13853 13854 13855 13856 13857
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
13858
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
13859

K
Karel Zak 已提交
13860 13861 13862 13863
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
13864

K
Karel Zak 已提交
13865 13866 13867 13868 13869
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
13870

13871
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
13872 13873
                         cmd->name,
                         opt->name,
13874 13875
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
13876 13877
            }
        }
13878

D
Daniel Veillard 已提交
13879
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
13880
        if (cmd) {
13881
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
13882

K
Karel Zak 已提交
13883 13884 13885 13886
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

13887
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
13888
                VIR_FREE(c);
13889
                goto syntaxError;
13890
            }
13891

K
Karel Zak 已提交
13892 13893 13894 13895 13896 13897
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
13898 13899 13900

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
13901
    }
13902

E
Eric Blake 已提交
13903
    return true;
K
Karel Zak 已提交
13904

13905
 syntaxError:
13906
    if (ctl->cmd) {
K
Karel Zak 已提交
13907
        vshCommandFree(ctl->cmd);
13908 13909
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
13910 13911
    if (first)
        vshCommandOptFree(first);
13912
    VIR_FREE(tkdata);
E
Eric Blake 已提交
13913
    return false;
K
Karel Zak 已提交
13914 13915
}

13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933
/* --------------------
 * 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 已提交
13934 13935
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
13936 13937 13938 13939
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
13940
        return false;
13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962 13963 13964 13965 13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976 13977 13978 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

    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 已提交
14013 14014
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
14015 14016 14017 14018
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
14019
        return false;
14020 14021 14022 14023 14024 14025

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
14026
/* ---------------
14027
 * Misc utils
K
Karel Zak 已提交
14028 14029
 * ---------------
 */
14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057
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 已提交
14058
static const char *
14059 14060
vshDomainStateToString(int state)
{
14061
    switch ((virDomainState) state) {
14062
    case VIR_DOMAIN_RUNNING:
14063
        return N_("running");
14064
    case VIR_DOMAIN_BLOCKED:
14065
        return N_("idle");
14066
    case VIR_DOMAIN_PAUSED:
14067
        return N_("paused");
14068
    case VIR_DOMAIN_SHUTDOWN:
14069
        return N_("in shutdown");
14070
    case VIR_DOMAIN_SHUTOFF:
14071
        return N_("shut off");
14072
    case VIR_DOMAIN_CRASHED:
14073
        return N_("crashed");
14074
    case VIR_DOMAIN_NOSTATE:
14075
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
14076
    }
14077
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
14078 14079
}

14080 14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 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
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");
}

14181 14182 14183 14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195 14196 14197
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");
}

14198 14199 14200 14201
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
14202
    case VIR_VCPU_OFFLINE:
14203
        return N_("offline");
14204
    case VIR_VCPU_BLOCKED:
14205
        return N_("idle");
14206
    case VIR_VCPU_RUNNING:
14207
        return N_("running");
14208
    default:
14209
        ;/*FALLTHROUGH*/
14210
    }
14211
    return N_("no state");
14212 14213
}

E
Eric Blake 已提交
14214
static bool
14215
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
14216
{
14217 14218
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
14219 14220
     */
    if (!conn) {
14221
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
14222
        return false;
K
Karel Zak 已提交
14223
    }
E
Eric Blake 已提交
14224
    return true;
K
Karel Zak 已提交
14225 14226
}

K
Karel Zak 已提交
14227
static void
14228
vshDebug(vshControl *ctl, int level, const char *format, ...)
14229
{
K
Karel Zak 已提交
14230
    va_list ap;
14231
    char *str;
K
Karel Zak 已提交
14232

14233 14234 14235 14236 14237 14238 14239
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

14240
    va_start(ap, format);
14241
    vshOutputLogFile(ctl, level, format, ap);
14242 14243
    va_end(ap);

K
Karel Zak 已提交
14244
    va_start(ap, format);
14245 14246 14247 14248 14249
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
14250
    va_end(ap);
14251 14252
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
14253 14254 14255
}

static void
14256
vshPrintExtra(vshControl *ctl, const char *format, ...)
14257
{
K
Karel Zak 已提交
14258
    va_list ap;
14259
    char *str;
14260

14261
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
14262
        return;
14263

K
Karel Zak 已提交
14264
    va_start(ap, format);
14265 14266 14267 14268 14269
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
14270
    va_end(ap);
14271
    fputs(str, stdout);
14272
    VIR_FREE(str);
K
Karel Zak 已提交
14273 14274
}

K
Karel Zak 已提交
14275

K
Karel Zak 已提交
14276
static void
14277
vshError(vshControl *ctl, const char *format, ...)
14278
{
K
Karel Zak 已提交
14279
    va_list ap;
14280
    char *str;
14281

14282 14283 14284 14285 14286
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
14287

14288
    fputs(_("error: "), stderr);
14289

K
Karel Zak 已提交
14290
    va_start(ap, format);
14291 14292 14293
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
14294 14295
    va_end(ap);

14296 14297
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
14298 14299
}

14300

K
Karel Zak 已提交
14301
/*
14302
 * Initialize connection.
K
Karel Zak 已提交
14303
 */
E
Eric Blake 已提交
14304
static bool
14305
vshInit(vshControl *ctl)
14306
{
14307 14308
    char *debugEnv;

K
Karel Zak 已提交
14309
    if (ctl->conn)
E
Eric Blake 已提交
14310
        return false;
K
Karel Zak 已提交
14311

J
Jiri Denemark 已提交
14312
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
14313 14314 14315
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
14316 14317 14318
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
14319 14320
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
14321 14322
            } else {
                ctl->debug = debug;
14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

14335 14336
    vshOpenLogFile(ctl);

14337 14338
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
14339

14340 14341 14342
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

14343
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
14344
        return false;
14345

14346 14347 14348 14349
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
14350

14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361
        /* 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;
        }
14362
    }
K
Karel Zak 已提交
14363

E
Eric Blake 已提交
14364
    return true;
K
Karel Zak 已提交
14365 14366
}

14367 14368
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387
/**
 * 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:
14388
                vshError(ctl, "%s",
J
Jim Meyering 已提交
14389
                         _("failed to get the log file information"));
14390
                exit(EXIT_FAILURE);
14391 14392 14393
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
14394 14395
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
14396 14397 14398 14399
        }
    }

    /* log file open */
14400
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
14401
        vshError(ctl, "%s",
J
Jim Meyering 已提交
14402
                 _("failed to open the log file. check the log file path"));
14403
        exit(EXIT_FAILURE);
14404 14405 14406 14407 14408 14409 14410 14411 14412
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
14413 14414
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
14415
{
14416 14417 14418
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431 14432
    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);
14433
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
14434 14435 14436 14437 14438 14439
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
14440 14441
                      SIGN_NAME,
                      (int) getpid());
14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 14452 14453 14454 14455 14456 14457 14458 14459 14460 14461
    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;
    }
14462 14463 14464
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
14465

14466 14467
    if (virBufferError(&buf))
        goto error;
14468

14469 14470 14471 14472 14473
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
14474
    }
14475

14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486
    /* 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);
14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
14498 14499 14500
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
14501 14502 14503
    }

    if (ctl->logfile) {
14504
        VIR_FREE(ctl->logfile);
14505 14506 14507 14508
        ctl->logfile = NULL;
    }
}

14509
#ifdef USE_READLINE
14510

K
Karel Zak 已提交
14511 14512 14513 14514 14515
/* -----------------
 * Readline stuff
 * -----------------
 */

14516
/*
K
Karel Zak 已提交
14517 14518
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
14519
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
14520 14521
 */
static char *
14522 14523
vshReadlineCommandGenerator(const char *text, int state)
{
14524
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
14525
    const char *name;
14526 14527
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
14528 14529

    if (!state) {
14530 14531
        grp_list_index = 0;
        cmd_list_index = 0;
14532
        len = strlen(text);
K
Karel Zak 已提交
14533 14534
    }

14535 14536
    grp = cmdGroups;

K
Karel Zak 已提交
14537
    /* Return the next name which partially matches from the
14538
     * command list.
K
Karel Zak 已提交
14539
     */
14540 14541 14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553
    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 已提交
14554 14555 14556 14557 14558 14559 14560
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
14561 14562
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
14563
    static int list_index, len;
14564
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
14565
    const char *name;
K
Karel Zak 已提交
14566 14567 14568 14569 14570 14571 14572 14573 14574

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

14575
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
14576
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
14577 14578 14579

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
14580
        len = strlen(text);
14581
        VIR_FREE(cmdname);
K
Karel Zak 已提交
14582 14583 14584 14585
    }

    if (!cmd)
        return NULL;
14586

14587 14588 14589
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
14590
    while ((name = cmd->opts[list_index].name)) {
14591
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
14592
        char *res;
14593

K
Karel Zak 已提交
14594
        list_index++;
14595

14596
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
14597 14598
            /* ignore non --option */
            continue;
14599

K
Karel Zak 已提交
14600
        if (len > 2) {
14601
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
14602 14603
                continue;
        }
14604
        res = vshMalloc(NULL, strlen(name) + 3);
14605
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
14606 14607 14608 14609 14610 14611 14612 14613
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
14614 14615 14616
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
14617 14618
    char **matches = (char **) NULL;

14619
    if (start == 0)
K
Karel Zak 已提交
14620
        /* command name generator */
14621
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
14622 14623
    else
        /* commands options */
14624
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
14625 14626 14627 14628
    return matches;
}


14629 14630
static int
vshReadlineInit(vshControl *ctl)
14631
{
14632 14633
    char *userdir = NULL;

K
Karel Zak 已提交
14634 14635 14636 14637 14638
    /* 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;
14639 14640 14641

    /* Limit the total size of the history buffer */
    stifle_history(500);
14642 14643

    /* Prepare to read/write history from/to the ~/.virsh/history file */
14644
    userdir = virGetUserDirectory(getuid());
14645

14646 14647
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
14648
        return -1;
14649
    }
14650 14651 14652

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
14653
        VIR_FREE(userdir);
14654 14655 14656 14657 14658
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
14659
        VIR_FREE(userdir);
14660 14661 14662
        return -1;
    }

14663
    VIR_FREE(userdir);
14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681

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

14682 14683
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
14684 14685
}

14686 14687 14688 14689 14690 14691
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

14692
#else /* !USE_READLINE */
14693

14694 14695 14696 14697 14698 14699 14700
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

14701
static void
14702
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725
{
    /* 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);
}

14726
#endif /* !USE_READLINE */
14727

K
Karel Zak 已提交
14728
/*
J
Jim Meyering 已提交
14729
 * Deinitialize virsh
K
Karel Zak 已提交
14730
 */
E
Eric Blake 已提交
14731
static bool
14732
vshDeinit(vshControl *ctl)
14733
{
14734
    vshReadlineDeinit(ctl);
14735
    vshCloseLogFile(ctl);
14736
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
14737
    if (ctl->conn) {
14738 14739 14740
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
14741 14742
        }
    }
D
Daniel P. Berrange 已提交
14743 14744
    virResetLastError();

E
Eric Blake 已提交
14745
    return true;
K
Karel Zak 已提交
14746
}
14747

K
Karel Zak 已提交
14748 14749 14750 14751
/*
 * Print usage
 */
static void
14752
vshUsage(void)
14753
{
14754
    const vshCmdGrp *grp;
14755
    const vshCmdDef *cmd;
14756

L
Lai Jiangshan 已提交
14757 14758
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
14759 14760 14761
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
14762
                      "    -d | --debug <num>      debug level [0-4]\n"
14763 14764 14765 14766
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
14767
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
14768
                      "    -V | --version=long     version and full options\n\n"
14769
                      "  commands (non interactive mode):\n\n"), progname, progname);
14770

14771 14772
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
14773

14774 14775 14776 14777 14778 14779 14780 14781 14782
        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"));
14783 14784 14785
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
14786 14787
}

14788 14789 14790 14791 14792 14793 14794 14795 14796 14797
/*
 * 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 已提交
14798 14799
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834
#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 已提交
14835
    vshPrint(ctl, "%s", _(" Networking:"));
14836 14837 14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861
#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 已提交
14862
    vshPrint(ctl, "%s", _(" Storage:"));
14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885
#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 已提交
14886
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
14887
#ifdef WITH_SECDRIVER_APPARMOR
14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910
    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 已提交
14911 14912 14913 14914
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
14915
static bool
14916
vshParseArgv(vshControl *ctl, int argc, char **argv)
14917
{
14918 14919
    bool help = false;
    int arg;
K
Karel Zak 已提交
14920
    struct option opt[] = {
E
Eric Blake 已提交
14921 14922 14923 14924 14925 14926 14927 14928 14929
        {"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}
14930 14931
    };

14932 14933 14934
    /* 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. */
14935
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
14936
        switch (arg) {
14937
        case 'd':
D
Daniel Veillard 已提交
14938
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
14939
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
14940 14941
                exit(EXIT_FAILURE);
            }
14942 14943
            break;
        case 'h':
14944
            help = true;
14945 14946
            break;
        case 'q':
E
Eric Blake 已提交
14947
            ctl->quiet = true;
14948 14949
            break;
        case 't':
E
Eric Blake 已提交
14950
            ctl->timing = true;
14951 14952 14953 14954
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
14955 14956 14957 14958 14959 14960
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
14961 14962 14963
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
14964
        case 'r':
E
Eric Blake 已提交
14965
            ctl->readonly = true;
14966
            break;
14967 14968 14969
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
14970
        default:
14971 14972
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
14973 14974 14975 14976
        }
    }

    if (help) {
14977 14978
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
14979 14980
            exit(EXIT_FAILURE);
        }
14981 14982 14983

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
14984
        exit(EXIT_SUCCESS);
14985 14986
    }

14987
    if (argc > optind) {
K
Karel Zak 已提交
14988
        /* parse command */
E
Eric Blake 已提交
14989
        ctl->imode = false;
14990
        if (argc - optind == 1) {
14991
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
14992
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
14993
        } else {
14994
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
14995 14996
        }
    }
E
Eric Blake 已提交
14997
    return true;
K
Karel Zak 已提交
14998 14999
}

15000 15001 15002 15003
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
15004
    char *defaultConn;
E
Eric Blake 已提交
15005
    bool ret = true;
K
Karel Zak 已提交
15006

15007 15008 15009
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
15010
    ctl->debug = VSH_DEBUG_DEFAULT;
15011

15012 15013
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
15014
        /* failure to setup locale is not fatal */
15015
    }
15016
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
15017
        perror("bindtextdomain");
E
Eric Blake 已提交
15018
        return EXIT_FAILURE;
15019
    }
15020
    if (!textdomain(PACKAGE)) {
15021
        perror("textdomain");
E
Eric Blake 已提交
15022
        return EXIT_FAILURE;
15023 15024
    }

15025 15026 15027 15028 15029
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

15030
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
15031 15032 15033
        progname = argv[0];
    else
        progname++;
15034

15035
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
15036
        ctl->name = vshStrdup(ctl, defaultConn);
15037 15038
    }

D
Daniel P. Berrange 已提交
15039 15040
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
15041
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
15042
    }
15043

D
Daniel P. Berrange 已提交
15044 15045
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
15046
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
15047
    }
15048

K
Karel Zak 已提交
15049
    if (!ctl->imode) {
15050
        ret = vshCommandRun(ctl, ctl->cmd);
15051
    } else {
K
Karel Zak 已提交
15052 15053
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
15054
            vshPrint(ctl,
15055
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
15056
                     progname);
J
Jim Meyering 已提交
15057
            vshPrint(ctl, "%s",
15058
                     _("Type:  'help' for help with commands\n"
15059
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
15060
        }
15061 15062 15063 15064 15065 15066

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
15067
        do {
15068
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
15069
            ctl->cmdstr =
15070
                vshReadline(ctl, prompt);
15071 15072
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
15073
            if (*ctl->cmdstr) {
15074
#if USE_READLINE
K
Karel Zak 已提交
15075
                add_history(ctl->cmdstr);
15076
#endif
15077
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
15078 15079
                    vshCommandRun(ctl, ctl->cmd);
            }
15080
            VIR_FREE(ctl->cmdstr);
15081
        } while (ctl->imode);
K
Karel Zak 已提交
15082

15083 15084
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
15085
    }
15086

K
Karel Zak 已提交
15087 15088
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
15089
}