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

13
#include <config.h>
14

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

70 71
#define VIR_FROM_THIS VIR_FROM_NONE

K
Karel Zak 已提交
72 73 74 75 76
#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)

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

J
Jiri Denemark 已提交
104 105
#define VSH_DEBUG_DEFAULT VSH_ERR_ERROR

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

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

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

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

/*
E
Eric Blake 已提交
168 169 170 171 172
 * 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 已提交
173
 */
174
typedef struct {
E
Eric Blake 已提交
175 176
    const char *name;           /* name of information, or NULL for list end */
    const char *data;           /* non-NULL information */
K
Karel Zak 已提交
177 178 179 180 181
} vshCmdInfo;

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

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

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

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

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

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

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

257
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
258

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

E
Eric Blake 已提交
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 447 448
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
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463

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;

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

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

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

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

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

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

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

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

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

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

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

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

K
Karel Zak 已提交
614 615 616 617 618 619
/* ---------------
 * Commands
 * ---------------
 */

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

627
    {NULL, NULL}
K
Karel Zak 已提交
628 629
};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

770 771
#ifndef WIN32

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

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

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

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

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

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

 cleanup:
810

811 812 813
    return ret;
}

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

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

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

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

832
    ret = cmdRunConsole(ctl, dom, name);
833

834
cleanup:
835 836 837 838
    virDomainFree(dom);
    return ret;
}

839 840 841
#endif /* WIN32 */


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

851
static const vshCmdOptDef opts_list[] = {
852 853
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
E
Eric Blake 已提交
854 855
    {"managed-save", VSH_OT_BOOL, 0,
     N_("mark domains with managed save state")},
856 857 858
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
859

E
Eric Blake 已提交
860
static bool
861
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
862
{
863 864 865 866
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
867
    char **names = NULL;
868
    int maxname = 0;
E
Eric Blake 已提交
869 870 871
    bool managed = vshCommandOptBool(cmd, "managed-save");
    int state;

872
    inactive |= all;
K
Karel Zak 已提交
873

874
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
875
        return false;
876

877
    if (active) {
878 879
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
880
            vshError(ctl, "%s", _("Failed to list active domains"));
E
Eric Blake 已提交
881
            return false;
882 883 884 885 886
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
887
                vshError(ctl, "%s", _("Failed to list active domains"));
888
                VIR_FREE(ids);
E
Eric Blake 已提交
889
                return false;
890 891
            }

892
            qsort(&ids[0], maxid, sizeof(int), idsorter);
893
        }
894 895
    }
    if (inactive) {
896 897
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
898
            vshError(ctl, "%s", _("Failed to list inactive domains"));
899
            VIR_FREE(ids);
E
Eric Blake 已提交
900
            return false;
901
        }
902 903 904 905
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
906
                vshError(ctl, "%s", _("Failed to list inactive domains"));
907 908
                VIR_FREE(ids);
                VIR_FREE(names);
E
Eric Blake 已提交
909
                return false;
910
            }
911

912
            qsort(&names[0], maxname, sizeof(char*), namesorter);
913
        }
914
    }
915
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
916
    vshPrintExtra(ctl, "----------------------------------\n");
917 918

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

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

K
Karel Zak 已提交
925
        vshPrint(ctl, "%3d %-20s %s\n",
926 927
                 virDomainGetID(dom),
                 virDomainGetName(dom),
E
Eric Blake 已提交
928
                 _(vshDomainStateToString(vshDomainState(ctl, dom, NULL))));
929
        virDomainFree(dom);
K
Karel Zak 已提交
930
    }
931 932 933 934
    for (i = 0; i < maxname; i++) {
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);

        /* this kind of work with domains is not atomic operation */
935
        if (!dom) {
936
            VIR_FREE(names[i]);
937
            continue;
938
        }
939

E
Eric Blake 已提交
940 941 942 943 944
        state = vshDomainState(ctl, dom, NULL);
        if (managed && state == VIR_DOMAIN_SHUTOFF &&
            virDomainHasManagedSaveImage(dom, 0) > 0)
            state = -2;

945 946 947
        vshPrint(ctl, "%3s %-20s %s\n",
                 "-",
                 names[i],
E
Eric Blake 已提交
948
                 state == -2 ? _("saved") : _(vshDomainStateToString(state)));
949

950
        virDomainFree(dom);
951
        VIR_FREE(names[i]);
952
    }
953 954
    VIR_FREE(ids);
    VIR_FREE(names);
E
Eric Blake 已提交
955
    return true;
K
Karel Zak 已提交
956 957 958
}

/*
K
Karel Zak 已提交
959
 * "domstate" command
K
Karel Zak 已提交
960
 */
961
static const vshCmdInfo info_domstate[] = {
962 963
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
964
    {NULL, NULL}
K
Karel Zak 已提交
965 966
};

967
static const vshCmdOptDef opts_domstate[] = {
968
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
969
    {"reason", VSH_OT_BOOL, 0, N_("also print reason for the state")},
970
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
971 972
};

E
Eric Blake 已提交
973
static bool
974
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
975
{
K
Karel Zak 已提交
976
    virDomainPtr dom;
E
Eric Blake 已提交
977
    bool ret = true;
978 979
    int showReason = vshCommandOptBool(cmd, "reason");
    int state, reason;
980

981
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
982
        return false;
983

J
Jim Meyering 已提交
984
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
985
        return false;
986

987
    if ((state = vshDomainState(ctl, dom, &reason)) < 0) {
E
Eric Blake 已提交
988
        ret = false;
989 990 991 992 993 994 995 996 997 998 999
        goto cleanup;
    }

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

1001
cleanup:
1002 1003 1004 1005
    virDomainFree(dom);
    return ret;
}

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 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
/*
 * "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;
}

1053 1054
/* "domblkstat" command
 */
1055
static const vshCmdInfo info_domblkstat[] = {
1056 1057
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
1058 1059 1060
    {NULL,NULL}
};

1061
static const vshCmdOptDef opts_domblkstat[] = {
1062 1063
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
1064 1065 1066
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1067
static bool
1068
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
1069 1070
{
    virDomainPtr dom;
1071
    const char *name = NULL, *device = NULL;
1072
    struct _virDomainBlockStats stats;
1073 1074 1075
    virTypedParameterPtr params = NULL;
    int rc, nparams = 0;
    bool ret = false;
1076

1077
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1078
        return false;
1079

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

1083 1084
    if (vshCommandOptString (cmd, "device", &device) <= 0)
        goto cleanup;
1085

1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111
    rc = virDomainBlockStatsFlags(dom, device, NULL, &nparams, 0);

    /* It might fail when virDomainBlockStatsFlags is not
     * supported on older libvirt, fallback to use virDomainBlockStats
     * then.
     */
    if (rc < 0) {
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virshReportError(ctl);
            goto cleanup;
        } else {
            virFreeError(last_error);
            last_error = NULL;

            if (virDomainBlockStats (dom, device, &stats,
                                     sizeof stats) == -1) {
                vshError(ctl, _("Failed to get block stats %s %s"),
                         name, device);
                goto cleanup;
            }

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

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

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

1119 1120 1121 1122 1123 1124
            if (stats.errs >= 0)
                vshPrint (ctl, "%s errs %lld\n", device, stats.errs);
        }
    } else {
        params = vshMalloc(ctl, sizeof(*params) * nparams);
        memset(params, 0, sizeof(*params) * nparams);
1125

1126 1127 1128 1129
        if (virDomainBlockStatsFlags (dom, device, params, &nparams, 0) < 0) {
            vshError(ctl, _("Failed to get block stats %s %s"), name, device);
            goto cleanup;
        }
1130

1131 1132 1133 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 1161
        int i;
        /* XXX: The output sequence will be different. */
        for (i = 0; i < nparams; i++) {
            switch(params[i].type) {
            case VIR_TYPED_PARAM_INT:
                vshPrint (ctl, "%s %s %d\n", device,
                          params[i].field, params[i].value.i);
                break;
            case VIR_TYPED_PARAM_UINT:
                vshPrint (ctl, "%s %s %u\n", device,
                          params[i].field, params[i].value.ui);
                break;
            case VIR_TYPED_PARAM_LLONG:
                vshPrint (ctl, "%s %s %lld\n", device,
                          params[i].field, params[i].value.l);
                break;
            case VIR_TYPED_PARAM_ULLONG:
                vshPrint (ctl, "%s %s %llu\n", device,
                          params[i].field, params[i].value.ul);
                break;
            case VIR_TYPED_PARAM_DOUBLE:
                vshPrint (ctl, "%s %s %f\n", device,
                          params[i].field, params[i].value.d);
                break;
            case VIR_TYPED_PARAM_BOOLEAN:
                vshPrint (ctl, "%s %s %s\n", device,
                          params[i].field, params[i].value.b ? _("yes") : _("no"));
                break;
            default:
                vshError(ctl, _("unimplemented block statistics parameter type"));
            }
1162

1163 1164 1165 1166 1167 1168 1169
        }
    }

    ret = true;

cleanup:
    VIR_FREE(params);
1170
    virDomainFree(dom);
1171
    return ret;
1172 1173 1174 1175
}

/* "domifstat" command
 */
1176
static const vshCmdInfo info_domifstat[] = {
1177 1178
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1179 1180 1181
    {NULL,NULL}
};

1182
static const vshCmdOptDef opts_domifstat[] = {
1183 1184
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1185 1186 1187
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1188
static bool
1189
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1190 1191
{
    virDomainPtr dom;
1192
    const char *name = NULL, *device = NULL;
1193 1194
    struct _virDomainInterfaceStats stats;

1195
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1196
        return false;
1197

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

1201
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1202
        virDomainFree(dom);
E
Eric Blake 已提交
1203
        return false;
L
Laine Stump 已提交
1204
    }
1205 1206

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1207
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1208
        virDomainFree(dom);
E
Eric Blake 已提交
1209
        return false;
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
    }

    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 已提交
1237
    return true;
1238 1239
}

1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 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 1515 1516 1517 1518 1519 1520 1521 1522 1523
/* "domif-setlink" command
 */
static const vshCmdInfo info_domif_setlink[] = {
    {"help", N_("set link state of a virtual interface")},
    {"desc", N_("Set link state of a domain's virtual interface. This command wraps usage of update-device command.")},
    {NULL,NULL}
};

static const vshCmdOptDef opts_domif_setlink[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device (MAC Address)")},
    {"state", VSH_OT_DATA, VSH_OFLAG_REQ, N_("new state of the device")},
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface state")},
    {NULL, 0, 0, NULL}
};

static bool
cmdDomIfSetLink (vshControl *ctl, const vshCmd *cmd)
{

    virDomainPtr dom;
    const char *interface;
    const char *state;
    const char *mac;
    const char *desc;
    bool persistent;
    bool ret = false;
    unsigned int flags = 0;
    int i;

    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;


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

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

    if (vshCommandOptString(cmd, "interface", &interface) <= 0)
        goto cleanup;

    if (vshCommandOptString(cmd, "state", &state) <= 0)
        goto cleanup;

    persistent = vshCommandOptBool(cmd, "persistent");

    if (STRNEQ(state, "up") && STRNEQ(state, "down")) {
        vshError(ctl, _("invalid link state '%s'"), state);
        goto cleanup;
    }

    /* get persistent or live description of network device */
    desc = virDomainGetXMLDesc(dom, persistent?VIR_DOMAIN_XML_INACTIVE:0);
    if (desc == NULL) {
        vshError(ctl, _("Failed to get domain description xml"));
        goto cleanup;
    }

    if (persistent)
        flags = VIR_DOMAIN_AFFECT_CONFIG;
    else
        flags = VIR_DOMAIN_AFFECT_LIVE;

    if (virDomainIsActive(dom) == 0)
        flags = VIR_DOMAIN_AFFECT_CONFIG;

    /* extract current network device description */
    xml = virXMLParseStringCtxt(desc, "domain configuration", &ctxt);
    VIR_FREE(desc);
    if (!xml) {
        vshError(ctl, _("Failed to parse domain description xml"));
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/interface", ctxt);
    if (obj == NULL || obj->type != XPATH_NODESET ||
        obj->nodesetval == NULL || obj->nodesetval->nodeNr == 0) {
        vshError(ctl, _("Failed to extract interface information or no interfaces found"));
        goto cleanup;
    }

    /* find interface with matching mac addr */
    for (i = 0; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;

        while (cur) {
            if (cur->type == XML_ELEMENT_NODE &&
                xmlStrEqual(cur->name, BAD_CAST "mac")) {
                mac = virXMLPropString(cur, "address");

                if (STRCASEEQ(mac, interface)) {
                    VIR_FREE(mac);
                    goto hit;
                }
                VIR_FREE(mac);
            }
            cur = cur->next;
        }
    }

    vshError(ctl, _("interface with address '%s' not found"), interface);
    goto cleanup;

hit:
    /* find and modify/add link state node */
    /* try to find <link> element */
    cur = obj->nodesetval->nodeTab[i]->children;

    while (cur) {
        if (cur->type == XML_ELEMENT_NODE &&
            xmlStrEqual(cur->name, BAD_CAST "link")) {
            /* found, just modify the property */
            xmlSetProp(cur, BAD_CAST "state", BAD_CAST state);

            break;
        }
        cur = cur->next;
    }

    if (!cur) {
        /* element <link> not found, add one */
        cur = xmlNewChild(obj->nodesetval->nodeTab[i],
                          NULL,
                          BAD_CAST "link",
                          NULL);
        if (!cur)
            goto cleanup;

        if (xmlNewProp(cur, BAD_CAST "state", BAD_CAST state) == NULL)
            goto cleanup;
    }

    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
        vshError(ctl, _("Failed to allocate memory"));
        goto cleanup;
    }

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

    if (virDomainUpdateDeviceFlags(dom, (char *)xmlBufferContent(xml_buf), flags) < 0) {
        vshError(ctl, _("Failed to update interface link state"));
        goto cleanup;
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
        ret = true;
    }

cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);

    if (dom)
        virDomainFree(dom);

    return ret;
}

/* "domif-getlink" command
 */
static const vshCmdInfo info_domif_getlink[] = {
    {"help", N_("get link state of a virtual interface")},
    {"desc", N_("Get link state of a domain's virtual interface.")},
    {NULL,NULL}
};

static const vshCmdOptDef opts_domif_getlink[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device (MAC Address)")},
    {"persistent", VSH_OT_BOOL, 0, N_("Get persistent interface state")},
    {NULL, 0, 0, NULL}
};

static bool
cmdDomIfGetLink (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *interface = NULL;
    int flags = 0;
    char *state = NULL;
    char *mac = NULL;
    bool ret = false;
    int i;

    char *desc;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlXPathObjectPtr obj = NULL;

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

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

    if (vshCommandOptString (cmd, "interface", &interface) <= 0) {
        virDomainFree(dom);
        return false;
    }

    if (vshCommandOptBool(cmd, "persistent"))
        flags = VIR_DOMAIN_XML_INACTIVE;

    desc = virDomainGetXMLDesc(dom, flags);
    if (desc == NULL) {
        vshError(ctl, _("Failed to get domain description xml"));
        goto cleanup;
    }

    xml = virXMLParseStringCtxt(desc, "domain configuration", &ctxt);
    VIR_FREE(desc);
    if (!xml) {
        vshError(ctl, _("Failed to parse domain description xml"));
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/interface", ctxt);
    if (obj == NULL || obj->type != XPATH_NODESET ||
        obj->nodesetval == NULL || obj->nodesetval->nodeNr == 0) {
        vshError(ctl, _("Failed to extract interface information or no interfaces found"));
        goto cleanup;
    }

    /* find interface with matching mac addr */
    for (i = 0; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;

        while (cur) {
            if (cur->type == XML_ELEMENT_NODE &&
                xmlStrEqual(cur->name, BAD_CAST "mac")) {

                mac = virXMLPropString(cur, "address");

                if (STRCASEEQ(mac, interface)){
                    VIR_FREE(mac);
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }

    vshError(ctl, _("Interface with address '%s' not found."), interface);
    goto cleanup;

hit:
    cur = obj->nodesetval->nodeTab[i]->children;
    while (cur) {
        if (cur->type == XML_ELEMENT_NODE &&
            xmlStrEqual(cur->name, BAD_CAST "link")) {

            state = virXMLPropString(cur, "state");
            vshPrint(ctl, "%s %s", interface, state);
            VIR_FREE(state);

            goto cleanup;
        }
        cur = cur->next;
    }

    /* attribute not found */
    vshPrint(ctl, "%s default", interface);

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

    return ret;
}

1524 1525 1526
/*
 * "dommemstats" command
 */
1527
static const vshCmdInfo info_dommemstat[] = {
1528 1529
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1530 1531 1532
    {NULL,NULL}
};

1533
static const vshCmdOptDef opts_dommemstat[] = {
1534
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1535 1536 1537
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1538
static bool
1539
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1540 1541
{
    virDomainPtr dom;
1542
    const char *name;
1543 1544 1545
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1546
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1547
        return false;
1548 1549

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1550
        return false;
1551 1552 1553 1554 1555

    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 已提交
1556
        return false;
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571
    }

    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);
1572 1573
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON)
            vshPrint (ctl, "actual %llu\n", stats[i].val);
1574 1575 1576
    }

    virDomainFree(dom);
E
Eric Blake 已提交
1577
    return true;
1578 1579
}

1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594
/*
 * "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 已提交
1595
static bool
1596 1597 1598 1599
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1600
    bool ret = true;
1601
    const char *device = NULL;
1602

1603
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1604
        return false;
1605 1606

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

1609
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1610
        virDomainFree(dom);
E
Eric Blake 已提交
1611
        return false;
1612 1613 1614 1615
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1616
        return false;
1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
    }

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

1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 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
/*
 * "domblklist" command
 */
static const vshCmdInfo info_domblklist[] = {
    {"help", N_("list all domain blocks")},
    {"desc", N_("Get the names of block devices for a domain.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_domblklist[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"inactive", VSH_OT_BOOL, 0,
     N_("get inactive rather than running configuration")},
    {NULL, 0, 0, NULL}
};

static bool
cmdDomblklist(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = false;
    unsigned int flags = 0;
    char *xml = NULL;
    xmlDocPtr xmldoc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    int ndisks;
    xmlNodePtr *disks = NULL;
    int i;

    if (vshCommandOptBool(cmd, "inactive"))
        flags |= VIR_DOMAIN_XML_INACTIVE;

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

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

    xml = virDomainGetXMLDesc(dom, flags);
    if (!xml)
        goto cleanup;

    xmldoc = virXMLParseStringCtxt(xml, "domain.xml", &ctxt);
    if (!xmldoc)
        goto cleanup;

    ndisks = virXPathNodeSet("./devices/disk", ctxt, &disks);
    if (ndisks < 0)
        goto cleanup;

    vshPrint(ctl, "%-10s %s\n", _("Target"), _("Source"));
    vshPrint(ctl, "------------------------------------------------\n");

    for (i = 0; i < ndisks; i++) {
        char *target;
        char *source;

        ctxt->node = disks[i];
        target = virXPathString("string(./target/@dev)", ctxt);
        if (!target) {
            vshError(ctl, "unable to query block list");
            goto cleanup;
        }
        source = virXPathString("string(./source/@file"
                                "|./source/@dev"
                                "|./source/@dir"
                                "|./source/@name)", ctxt);
        vshPrint(ctl, "%-10s %s\n", target, source ? source : "-");
        VIR_FREE(target);
        VIR_FREE(source);
    }

    ret = 0;

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

1707 1708 1709
/*
 * "suspend" command
 */
1710
static const vshCmdInfo info_suspend[] = {
1711 1712
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1713
    {NULL, NULL}
1714 1715
};

1716
static const vshCmdOptDef opts_suspend[] = {
1717
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1718
    {NULL, 0, 0, NULL}
1719 1720
};

E
Eric Blake 已提交
1721
static bool
1722
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1723
{
1724
    virDomainPtr dom;
1725
    const char *name;
E
Eric Blake 已提交
1726
    bool ret = true;
1727

1728
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1729
        return false;
1730

J
Jim Meyering 已提交
1731
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1732
        return false;
1733 1734

    if (virDomainSuspend(dom) == 0) {
1735
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1736
    } else {
1737
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1738
        ret = false;
1739
    }
1740

1741 1742 1743 1744
    virDomainFree(dom);
    return ret;
}

1745 1746 1747
/*
 * "create" command
 */
1748
static const vshCmdInfo info_create[] = {
1749 1750
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1751 1752 1753
    {NULL, NULL}
};

1754
static const vshCmdOptDef opts_create[] = {
1755
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1756
#ifndef WIN32
1757
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1758
#endif
1759
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1760
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1761 1762 1763
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1764
static bool
1765
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1766 1767
{
    virDomainPtr dom;
1768
    const char *from = NULL;
E
Eric Blake 已提交
1769
    bool ret = true;
1770
    char *buffer;
1771
#ifndef WIN32
1772
    int console = vshCommandOptBool(cmd, "console");
1773
#endif
1774
    unsigned int flags = VIR_DOMAIN_NONE;
1775

1776
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1777
        return false;
1778

1779
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1780
        return false;
1781

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

1785 1786
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1787 1788
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1789 1790

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1791
    VIR_FREE(buffer);
1792

1793
    if (dom != NULL) {
1794
        vshPrint(ctl, _("Domain %s created from %s\n"),
1795
                 virDomainGetName(dom), from);
1796
#ifndef WIN32
1797
        if (console)
1798
            cmdRunConsole(ctl, dom, NULL);
1799
#endif
1800
        virDomainFree(dom);
1801
    } else {
1802
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1803
        ret = false;
1804 1805 1806 1807
    }
    return ret;
}

1808 1809 1810
/*
 * "define" command
 */
1811
static const vshCmdInfo info_define[] = {
1812 1813
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1814 1815 1816
    {NULL, NULL}
};

1817
static const vshCmdOptDef opts_define[] = {
1818
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1819 1820 1821
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1822
static bool
1823
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1824 1825
{
    virDomainPtr dom;
1826
    const char *from = NULL;
E
Eric Blake 已提交
1827
    bool ret = true;
1828
    char *buffer;
1829

1830
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1831
        return false;
1832

1833
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1834
        return false;
1835

1836
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1837
        return false;
1838 1839

    dom = virDomainDefineXML(ctl->conn, buffer);
1840
    VIR_FREE(buffer);
1841

1842
    if (dom != NULL) {
1843
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1844
                 virDomainGetName(dom), from);
1845
        virDomainFree(dom);
1846
    } else {
1847
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1848
        ret = false;
1849 1850 1851 1852 1853 1854 1855
    }
    return ret;
}

/*
 * "undefine" command
 */
1856
static const vshCmdInfo info_undefine[] = {
1857 1858
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1859 1860 1861
    {NULL, NULL}
};

1862
static const vshCmdOptDef opts_undefine[] = {
1863
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1864
    {"managed-save", VSH_OT_BOOL, 0, N_("remove domain managed state file")},
1865 1866
    {"snapshots-metadata", VSH_OT_BOOL, 0,
     N_("remove all domain snapshot metadata, if inactive")},
1867 1868 1869
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1870
static bool
1871
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1872 1873
{
    virDomainPtr dom;
1874
    bool ret = false;
1875
    const char *name = NULL;
1876
    /* Flags to attempt.  */
E
Eric Blake 已提交
1877
    unsigned int flags = 0;
1878 1879 1880 1881
    /* User-requested actions.  */
    bool managed_save = vshCommandOptBool(cmd, "managed-save");
    bool snapshots_metadata = vshCommandOptBool(cmd, "snapshots-metadata");
    /* Positive if these items exist.  */
1882
    int has_managed_save = 0;
1883 1884 1885 1886 1887
    int has_snapshots_metadata = 0;
    int has_snapshots = 0;
    /* True if undefine will not strand data, even on older servers.  */
    bool managed_save_safe = false;
    bool snapshots_safe = false;
1888
    int rc = -1;
1889
    int running;
1890

1891
    if (managed_save) {
1892
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
1893 1894 1895 1896 1897 1898
        managed_save_safe = true;
    }
    if (snapshots_metadata) {
        flags |= VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
1899

1900
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1901
        return false;
1902

1903
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1904
        return false;
1905

1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924
    /* Do some flag manipulation.  The goal here is to disable bits
     * from flags to reduce the likelihood of a server rejecting
     * unknown flag bits, as well as to track conditions which are
     * safe by default for the given hypervisor and server version.  */
    running = virDomainIsActive(dom);
    if (running < 0) {
        virshReportError(ctl);
        goto cleanup;
    }
    if (!running) {
        /* Undefine with snapshots only fails for inactive domains,
         * and managed save only exists on inactive domains; if
         * running, then we don't want to remove anything.  */
        has_managed_save = virDomainHasManagedSaveImage(dom, 0);
        if (has_managed_save < 0) {
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
                goto cleanup;
            }
1925 1926
            virFreeError(last_error);
            last_error = NULL;
1927
            has_managed_save = 0;
1928 1929
        }

1930 1931
        has_snapshots = virDomainSnapshotNum(dom, 0);
        if (has_snapshots < 0) {
1932 1933
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945
                goto cleanup;
            }
            virFreeError(last_error);
            last_error = NULL;
            has_snapshots = 0;
        }
        if (has_snapshots) {
            has_snapshots_metadata
                = virDomainSnapshotNum(dom, VIR_DOMAIN_SNAPSHOT_LIST_METADATA);
            if (has_snapshots_metadata < 0) {
                /* The server did not know the new flag, assume that all
                   snapshots have metadata.  */
1946 1947
                virFreeError(last_error);
                last_error = NULL;
1948 1949 1950 1951 1952
                has_snapshots_metadata = has_snapshots;
            } else {
                /* The server knew the new flag, all aspects of
                 * undefineFlags are safe.  */
                managed_save_safe = snapshots_safe = true;
1953
            }
1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966
        }
    }
    if (!has_managed_save) {
        flags &= ~VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
        managed_save_safe = true;
    }
    if (has_snapshots == 0) {
        snapshots_safe = true;
    }
    if (has_snapshots_metadata == 0) {
        flags &= ~VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
1967

1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981
    /* Generally we want to try the new API first.  However, while
     * virDomainUndefineFlags was introduced at the same time as
     * VIR_DOMAIN_UNDEFINE_MANAGED_SAVE in 0.9.4, the
     * VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA flag was not present
     * until 0.9.5; skip to piecewise emulation if we couldn't prove
     * above that the new API is safe.  */
    if (managed_save_safe && snapshots_safe) {
        rc = virDomainUndefineFlags(dom, flags);
        if (rc == 0 || (last_error->code != VIR_ERR_NO_SUPPORT &&
                        last_error->code != VIR_ERR_INVALID_ARG))
            goto out;
        virFreeError(last_error);
        last_error = NULL;
    }
1982

1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994
    /* The new API is unsupported or unsafe; fall back to doing things
     * piecewise.  */
    if (has_managed_save) {
        if (!managed_save) {
            vshError(ctl, "%s",
                     _("Refusing to undefine while domain managed save "
                       "image exists"));
            goto cleanup;
        }
        if (virDomainManagedSaveRemove(dom, 0) < 0) {
            virshReportError(ctl);
            goto cleanup;
1995 1996 1997
        }
    }

1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011
    /* No way to emulate deletion of just snapshot metadata
     * without support for the newer flags.  Oh well.  */
    if (has_snapshots_metadata) {
        vshError(ctl,
                 snapshots_metadata ?
                 _("Unable to remove metadata of %d snapshots") :
                 _("Refusing to undefine while %d snapshots exist"),
                 has_snapshots_metadata);
        goto cleanup;
    }

    rc = virDomainUndefine(dom);

out:
2012
    if (rc == 0) {
2013
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
2014
        ret = true;
2015
    } else {
2016
        vshError(ctl, _("Failed to undefine domain %s"), name);
2017 2018
    }

2019
cleanup:
2020
    virDomainFree(dom);
2021 2022 2023 2024 2025 2026 2027
    return ret;
}


/*
 * "start" command
 */
2028
static const vshCmdInfo info_start[] = {
2029
    {"help", N_("start a (previously defined) inactive domain")},
2030 2031 2032
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
2033 2034 2035
    {NULL, NULL}
};

2036
static const vshCmdOptDef opts_start[] = {
2037
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
2038
#ifndef WIN32
2039
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
2040
#endif
E
Eric Blake 已提交
2041
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
2042 2043
    {"autodestroy", VSH_OT_BOOL, 0,
     N_("automatically destroy the guest when virsh disconnects")},
2044 2045
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when loading")},
2046 2047
    {"force-boot", VSH_OT_BOOL, 0,
     N_("force fresh boot by discarding any managed save")},
2048 2049 2050
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2051
static bool
2052
cmdStart(vshControl *ctl, const vshCmd *cmd)
2053 2054
{
    virDomainPtr dom;
2055
    bool ret = false;
2056
#ifndef WIN32
2057
    int console = vshCommandOptBool(cmd, "console");
2058
#endif
E
Eric Blake 已提交
2059
    unsigned int flags = VIR_DOMAIN_NONE;
2060
    int rc;
2061

2062
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2063
        return false;
2064

2065 2066
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
2067
        return false;
2068 2069

    if (virDomainGetID(dom) != (unsigned int)-1) {
2070
        vshError(ctl, "%s", _("Domain is already active"));
2071
        virDomainFree(dom);
E
Eric Blake 已提交
2072
        return false;
2073 2074
    }

E
Eric Blake 已提交
2075 2076
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
2077 2078
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
2079 2080
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_START_BYPASS_CACHE;
2081 2082
    if (vshCommandOptBool(cmd, "force-boot"))
        flags |= VIR_DOMAIN_START_FORCE_BOOT;
E
Eric Blake 已提交
2083

2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108
    /* We can emulate force boot, even for older servers that reject it.  */
    if (flags & VIR_DOMAIN_START_FORCE_BOOT) {
        if (virDomainCreateWithFlags(dom, flags) == 0)
            goto started;
        if (last_error->code != VIR_ERR_NO_SUPPORT &&
            last_error->code != VIR_ERR_INVALID_ARG) {
            virshReportError(ctl);
            goto cleanup;
        }
        virFreeError(last_error);
        last_error = NULL;
        rc = virDomainHasManagedSaveImage(dom, 0);
        if (rc < 0) {
            /* No managed save image to remove */
            virFreeError(last_error);
            last_error = NULL;
        } else if (rc > 0) {
            if (virDomainManagedSaveRemove(dom, 0) < 0) {
                virshReportError(ctl);
                goto cleanup;
            }
        }
        flags &= ~VIR_DOMAIN_START_FORCE_BOOT;
    }

E
Eric Blake 已提交
2109 2110
    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
2111
         : virDomainCreate(dom)) < 0) {
2112
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
2113
        goto cleanup;
2114
    }
2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126

started:
    vshPrint(ctl, _("Domain %s started\n"),
             virDomainGetName(dom));
#ifndef WIN32
    if (console && !cmdRunConsole(ctl, dom, NULL))
        goto cleanup;
#endif

    ret = true;

cleanup:
2127
    virDomainFree(dom);
2128 2129 2130
    return ret;
}

2131 2132 2133
/*
 * "save" command
 */
2134
static const vshCmdInfo info_save[] = {
2135
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
2136
    {"desc", N_("Save the RAM state of a running domain.")},
2137
    {NULL, NULL}
2138 2139
};

2140
static const vshCmdOptDef opts_save[] = {
2141
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2142 2143
    {"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")},
2144 2145
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2146 2147
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on restore")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on restore")},
2148
    {NULL, 0, 0, NULL}
2149 2150
};

E
Eric Blake 已提交
2151
static bool
2152
cmdSave(vshControl *ctl, const vshCmd *cmd)
2153
{
2154
    virDomainPtr dom;
2155 2156
    const char *name = NULL;
    const char *to = NULL;
2157
    bool ret = false;
E
Eric Blake 已提交
2158
    unsigned int flags = 0;
2159 2160
    const char *xmlfile = NULL;
    char *xml = NULL;
2161

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

2165
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
2166
        return false;
2167

2168 2169
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2170 2171 2172 2173
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2174

2175 2176 2177 2178 2179
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

2183 2184 2185 2186 2187 2188
    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
        goto cleanup;

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
2189
         : virDomainSave(dom, to)) < 0) {
2190
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
2191
        goto cleanup;
2192
    }
2193

2194 2195 2196 2197
    vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
    ret = true;

cleanup:
2198
    VIR_FREE(xml);
2199 2200 2201 2202
    virDomainFree(dom);
    return ret;
}

2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223
/*
 * "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;
E
Eric Blake 已提交
2224
    unsigned int flags = 0;
2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260
    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")},
2261 2262
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on restore")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on restore")},
2263 2264 2265 2266 2267 2268 2269 2270 2271 2272
    {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;
2273 2274 2275 2276 2277 2278
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317

    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")},
2318 2319
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on restore")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on restore")},
2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330
    {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;
2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346
    unsigned int getxml_flags = VIR_DOMAIN_XML_SECURE;
    unsigned int define_flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        define_flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        define_flags |= VIR_DOMAIN_SAVE_PAUSED;

    /* Normally, we let the API reject mutually exclusive flags.
     * However, in the edit cycle, we let the user retry if the define
     * step fails, but the define step will always fail on invalid
     * flags, so we reject it up front to avoid looping.  */
    if (define_flags == (VIR_DOMAIN_SAVE_RUNNING | VIR_DOMAIN_SAVE_PAUSED)) {
        vshError(ctl, "%s", _("--running and --saved are mutually exclusive"));
        return false;
    }
2347 2348 2349 2350 2351 2352 2353 2354

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

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

    /* Get the XML configuration of the saved image.  */
2355
    doc = virDomainSaveImageGetXMLDesc(ctl->conn, file, getxml_flags);
2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372
    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;

2373 2374 2375
    /* Compare original XML with edited.  Short-circuit if it did not
     * change, and we do not have any flags.  */
    if (STREQ(doc, doc_edited) && !define_flags) {
2376 2377 2378 2379 2380 2381 2382
        vshPrint(ctl, _("Saved image %s XML configuration not changed.\n"),
                 file);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
2383 2384
    if (virDomainSaveImageDefineXML(ctl->conn, file, doc_edited,
                                    define_flags) < 0) {
2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401
        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;
}

2402 2403 2404 2405 2406
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
2407 2408 2409 2410
    {"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.")},
2411 2412 2413 2414
    {NULL, NULL}
};

static const vshCmdOptDef opts_managedsave[] = {
2415
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2416
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2417 2418
    {"running", VSH_OT_BOOL, 0, N_("set domain to be running on next start")},
    {"paused", VSH_OT_BOOL, 0, N_("set domain to be paused on next start")},
2419 2420 2421
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2422
static bool
2423 2424 2425
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
2426
    const char *name;
2427
    bool ret = false;
E
Eric Blake 已提交
2428
    unsigned int flags = 0;
2429

2430
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2431
        return false;
2432

2433 2434
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2435 2436 2437 2438
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2439

2440
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2441
        return false;
2442

2443
    if (virDomainManagedSave(dom, flags) < 0) {
2444
        vshError(ctl, _("Failed to save domain %s state"), name);
2445
        goto cleanup;
2446 2447
    }

2448 2449 2450 2451
    vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    ret = true;

cleanup:
2452 2453 2454 2455
    virDomainFree(dom);
    return ret;
}

2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469
/*
 * "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 已提交
2470
static bool
2471 2472 2473
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
2474
    const char *name;
E
Eric Blake 已提交
2475
    bool ret = false;
2476 2477
    int hassave;

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

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

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
2486
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502
        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 已提交
2503
    ret = true;
2504 2505 2506 2507 2508 2509

cleanup:
    virDomainFree(dom);
    return ret;
}

2510 2511 2512
/*
 * "schedinfo" command
 */
2513
static const vshCmdInfo info_schedinfo[] = {
2514 2515
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
2516 2517 2518
    {NULL, NULL}
};

2519
static const vshCmdOptDef opts_schedinfo[] = {
2520 2521 2522 2523
    {"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")},
2524 2525 2526
    {"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")},
2527 2528 2529
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
2530
static int
2531
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
2532
                   virTypedParameterPtr param)
2533
{
2534
    const char *data = NULL;
2535 2536 2537

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
2538
        param->type == VIR_TYPED_PARAM_UINT &&
2539 2540
        vshCommandOptBool(cmd, "weight")) {
        int val;
2541
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
2542
            vshError(ctl, "%s", _("Invalid value of weight"));
2543
            return -1;
2544
        } else {
2545
            param->value.ui = val;
2546
        }
2547
        return 1;
2548 2549
    }

2550 2551
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
2552
        param->type == VIR_TYPED_PARAM_UINT &&
2553 2554
        vshCommandOptBool(cmd, "cap")) {
        int val;
2555
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
2556
            vshError(ctl, "%s", _("Invalid value of cap"));
2557
            return -1;
2558
        } else {
2559
            param->value.ui = val;
2560
        }
2561
        return 1;
2562
    }
2563

2564
    if (vshCommandOptString(cmd, "set", &data) > 0) {
2565 2566 2567
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
2568
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
2569
            return -1;
2570
        }
2571 2572 2573 2574 2575 2576 2577 2578 2579
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
2580
        case VIR_TYPED_PARAM_INT:
2581
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
2582
                vshError(ctl, "%s",
2583 2584 2585 2586
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
2587
        case VIR_TYPED_PARAM_UINT:
2588
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
2589
                vshError(ctl, "%s",
2590 2591 2592 2593
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
2594
        case VIR_TYPED_PARAM_LLONG:
2595
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
2596
                vshError(ctl, "%s",
J
Jim Meyering 已提交
2597
                         _("Invalid value for parameter, expecting a long long"));
2598 2599 2600
                return -1;
            }
            break;
2601
        case VIR_TYPED_PARAM_ULLONG:
2602
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
2603
                vshError(ctl, "%s",
2604 2605 2606 2607
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
2608
        case VIR_TYPED_PARAM_DOUBLE:
2609
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
2610
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
2611 2612 2613
                return -1;
            }
            break;
2614
        case VIR_TYPED_PARAM_BOOLEAN:
2615
            param->value.b = STREQ(val, "0") ? 0 : 1;
2616
        }
2617
        return 1;
2618
    }
2619

2620 2621
    return 0;
}
2622

2623

E
Eric Blake 已提交
2624
static bool
2625 2626 2627 2628
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
2629
    virTypedParameterPtr params = NULL;
2630 2631 2632
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
2633
    bool ret_val = false;
2634 2635 2636 2637 2638 2639 2640 2641 2642 2643
    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;
        }
2644
        flags = VIR_DOMAIN_AFFECT_CURRENT;
2645 2646
    } else {
        if (config)
2647
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
2648
        if (live)
2649
            flags |= VIR_DOMAIN_AFFECT_LIVE;
2650
    }
2651

2652
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2653
        return false;
2654

2655
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2656
        return false;
2657 2658 2659

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
2660
    if (schedulertype != NULL) {
2661
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
2662
             schedulertype);
2663
        VIR_FREE(schedulertype);
2664
    } else {
2665
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
2666
        goto cleanup;
2667 2668
    }

2669
    if (nparams) {
2670
        params = vshMalloc(ctl, sizeof(*params) * nparams);
2671

2672
        memset(params, 0, sizeof(*params) * nparams);
2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683
        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);
        }
2684 2685 2686 2687
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
2688
        for (i = 0; i < nparams; i++) {
2689 2690 2691 2692 2693 2694 2695 2696 2697 2698
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
2699 2700 2701 2702 2703
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
2704 2705 2706
            if (ret == -1)
                goto cleanup;

2707 2708 2709 2710 2711 2712 2713
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
2714 2715
            if (ret == -1)
                goto cleanup;
2716 2717 2718 2719
        } 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.  */
2720 2721
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
2722 2723 2724 2725
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
2726 2727 2728 2729 2730 2731
            /* 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;
            }
2732 2733
        }

E
Eric Blake 已提交
2734
        ret_val = true;
2735
        for (i = 0; i < nparams; i++) {
2736
            switch (params[i].type) {
2737
            case VIR_TYPED_PARAM_INT:
2738
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
2739
                 break;
2740
            case VIR_TYPED_PARAM_UINT:
2741
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
2742
                 break;
2743
            case VIR_TYPED_PARAM_LLONG:
2744
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
2745
                 break;
2746
            case VIR_TYPED_PARAM_ULLONG:
2747
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
2748
                 break;
2749
            case VIR_TYPED_PARAM_DOUBLE:
2750
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
2751
                 break;
2752
            case VIR_TYPED_PARAM_BOOLEAN:
2753
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
2754 2755
                 break;
            default:
2756
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
2757 2758 2759
            }
        }
    }
2760

2761
 cleanup:
2762
    VIR_FREE(params);
2763
    virDomainFree(dom);
2764
    return ret_val;
2765 2766
}

2767 2768 2769
/*
 * "restore" command
 */
2770
static const vshCmdInfo info_restore[] = {
2771 2772
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
2773
    {NULL, NULL}
2774 2775
};

2776
static const vshCmdOptDef opts_restore[] = {
2777
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
2778 2779
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when restoring")},
2780 2781
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2782 2783
    {"running", VSH_OT_BOOL, 0, N_("restore domain into running state")},
    {"paused", VSH_OT_BOOL, 0, N_("restore domain into paused state")},
2784
    {NULL, 0, 0, NULL}
2785 2786
};

E
Eric Blake 已提交
2787
static bool
2788
cmdRestore(vshControl *ctl, const vshCmd *cmd)
2789
{
2790
    const char *from = NULL;
2791
    bool ret = false;
E
Eric Blake 已提交
2792
    unsigned int flags = 0;
2793 2794
    const char *xmlfile = NULL;
    char *xml = NULL;
2795

2796
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2797
        return false;
2798

2799
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2800
        return false;
2801

2802 2803
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2804 2805 2806 2807
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2808

2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819
    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)
2820
         : virDomainRestore(ctl->conn, from)) < 0) {
2821
        vshError(ctl, _("Failed to restore domain from %s"), from);
2822
        goto cleanup;
2823
    }
2824 2825 2826 2827 2828

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

cleanup:
2829
    VIR_FREE(xml);
2830 2831 2832
    return ret;
}

D
Daniel Veillard 已提交
2833 2834 2835
/*
 * "dump" command
 */
2836
static const vshCmdInfo info_dump[] = {
2837 2838
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
2839 2840 2841
    {NULL, NULL}
};

2842
static const vshCmdOptDef opts_dump[] = {
2843 2844
    {"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")},
2845 2846
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when saving")},
2847 2848
    {"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 已提交
2849 2850 2851
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2852
static bool
2853
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
2854 2855
{
    virDomainPtr dom;
2856 2857
    const char *name = NULL;
    const char *to = NULL;
2858
    bool ret = false;
E
Eric Blake 已提交
2859
    unsigned int flags = 0;
D
Daniel Veillard 已提交
2860

2861
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2862
        return false;
D
Daniel Veillard 已提交
2863

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

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

P
Paolo Bonzini 已提交
2870 2871
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
2872 2873
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;
2874 2875
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DUMP_BYPASS_CACHE;
2876

2877
    if (virDomainCoreDump(dom, to, flags) < 0) {
2878
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
2879
        goto cleanup;
D
Daniel Veillard 已提交
2880 2881
    }

2882 2883 2884 2885
    vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
    ret = true;

cleanup:
D
Daniel Veillard 已提交
2886 2887 2888 2889
    virDomainFree(dom);
    return ret;
}

2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036
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;
}

3037 3038 3039
/*
 * "resume" command
 */
3040
static const vshCmdInfo info_resume[] = {
3041 3042
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
3043
    {NULL, NULL}
3044 3045
};

3046
static const vshCmdOptDef opts_resume[] = {
3047
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3048
    {NULL, 0, 0, NULL}
3049 3050
};

E
Eric Blake 已提交
3051
static bool
3052
cmdResume(vshControl *ctl, const vshCmd *cmd)
3053
{
3054
    virDomainPtr dom;
E
Eric Blake 已提交
3055
    bool ret = true;
3056
    const char *name;
3057

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

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

    if (virDomainResume(dom) == 0) {
3065
        vshPrint(ctl, _("Domain %s resumed\n"), name);
3066
    } else {
3067
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
3068
        ret = false;
3069
    }
3070

3071 3072 3073 3074
    virDomainFree(dom);
    return ret;
}

3075 3076 3077
/*
 * "shutdown" command
 */
3078
static const vshCmdInfo info_shutdown[] = {
3079 3080
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
3081
    {NULL, NULL}
3082 3083
};

3084
static const vshCmdOptDef opts_shutdown[] = {
3085
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3086
    {NULL, 0, 0, NULL}
3087 3088
};

E
Eric Blake 已提交
3089
static bool
3090
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
3091
{
3092
    virDomainPtr dom;
E
Eric Blake 已提交
3093
    bool ret = true;
3094
    const char *name;
3095

3096
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3097
        return false;
3098

J
Jim Meyering 已提交
3099
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3100
        return false;
3101 3102

    if (virDomainShutdown(dom) == 0) {
3103
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
3104
    } else {
3105
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
3106
        ret = false;
3107
    }
3108

3109 3110 3111 3112
    virDomainFree(dom);
    return ret;
}

3113 3114 3115
/*
 * "reboot" command
 */
3116
static const vshCmdInfo info_reboot[] = {
3117 3118
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
3119 3120 3121
    {NULL, NULL}
};

3122
static const vshCmdOptDef opts_reboot[] = {
3123
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3124 3125 3126
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3127
static bool
3128
cmdReboot(vshControl *ctl, const vshCmd *cmd)
3129 3130
{
    virDomainPtr dom;
E
Eric Blake 已提交
3131
    bool ret = true;
3132
    const char *name;
3133

3134
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3135
        return false;
3136

J
Jim Meyering 已提交
3137
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3138
        return false;
3139 3140

    if (virDomainReboot(dom, 0) == 0) {
3141
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
3142
    } else {
3143
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
3144
        ret = false;
3145 3146 3147 3148 3149 3150
    }

    virDomainFree(dom);
    return ret;
}

3151 3152 3153
/*
 * "destroy" command
 */
3154
static const vshCmdInfo info_destroy[] = {
3155 3156 3157
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
3158
    {NULL, NULL}
3159 3160
};

3161
static const vshCmdOptDef opts_destroy[] = {
3162
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3163
    {NULL, 0, 0, NULL}
3164 3165
};

E
Eric Blake 已提交
3166
static bool
3167
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
3168
{
3169
    virDomainPtr dom;
E
Eric Blake 已提交
3170
    bool ret = true;
3171
    const char *name;
3172

3173
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3174
        return false;
3175

J
Jim Meyering 已提交
3176
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3177
        return false;
3178 3179

    if (virDomainDestroy(dom) == 0) {
3180
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
3181
    } else {
3182
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
3183
        ret = false;
3184
    }
3185

3186
    virDomainFree(dom);
K
Karel Zak 已提交
3187 3188 3189 3190
    return ret;
}

/*
3191
 * "dominfo" command
K
Karel Zak 已提交
3192
 */
3193
static const vshCmdInfo info_dominfo[] = {
3194 3195
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
3196
    {NULL, NULL}
K
Karel Zak 已提交
3197 3198
};

3199
static const vshCmdOptDef opts_dominfo[] = {
3200
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3201
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3202 3203
};

E
Eric Blake 已提交
3204
static bool
3205
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
3206
{
K
Karel Zak 已提交
3207 3208
    virDomainInfo info;
    virDomainPtr dom;
3209
    virSecurityModel secmodel;
3210
    virSecurityLabelPtr seclabel;
3211
    int persistent = 0;
E
Eric Blake 已提交
3212 3213
    bool ret = true;
    int autostart;
3214
    unsigned int id;
3215
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
3216
    int has_managed_save = 0;
3217

3218
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3219
        return false;
K
Karel Zak 已提交
3220

J
Jim Meyering 已提交
3221
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3222
        return false;
3223

3224 3225
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3226
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
3227
    else
3228
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
3229 3230
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
3231
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
3232
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
3233 3234

    if ((str = virDomainGetOSType(dom))) {
3235
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
3236
        VIR_FREE(str);
3237 3238 3239
    }

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

3243
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
3244 3245

        if (info.cpuTime != 0) {
3246
            double cpuUsed = info.cpuTime;
3247

3248
            cpuUsed /= 1000000000.0;
3249

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

3253 3254
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
3255
                 info.maxMem);
3256
        else
3257
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
3258 3259
                 _("no limit"));

3260
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
3261 3262
                 info.memory);

K
Karel Zak 已提交
3263
    } else {
E
Eric Blake 已提交
3264
        ret = false;
K
Karel Zak 已提交
3265
    }
3266

3267 3268
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
3269 3270
    vshDebug(ctl, VSH_ERR_DEBUG, "Domain persistent flag value: %d\n",
             persistent);
3271 3272 3273 3274 3275 3276
    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 */
3277
    if (!virDomainGetAutostart(dom, &autostart)) {
3278
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
3279 3280 3281
                 autostart ? _("enable") : _("disable") );
    }

3282 3283 3284 3285 3286 3287 3288
    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"));

3289 3290 3291
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
3292 3293
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
3294
            return false;
3295 3296 3297
        } else {
            virFreeError(last_error);
            last_error = NULL;
3298
        }
3299 3300 3301 3302 3303 3304 3305
    } 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 */
3306
            if (VIR_ALLOC(seclabel) < 0) {
3307
                virDomainFree(dom);
E
Eric Blake 已提交
3308
                return false;
3309 3310 3311 3312 3313
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
3314
                return false;
3315
            } else {
3316
                if (seclabel->label[0] != '\0')
3317
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
3318
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
3319
            }
3320 3321

            VIR_FREE(seclabel);
3322 3323
        }
    }
3324
    virDomainFree(dom);
K
Karel Zak 已提交
3325 3326 3327
    return ret;
}

3328 3329 3330 3331
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
3332 3333
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
3334 3335 3336 3337
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
3338
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3339 3340 3341 3342
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
3343
static bool
3344 3345 3346 3347
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
3348
    bool ret = true;
3349

3350
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3351
        return false;
3352 3353

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3354
        return false;
3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380

    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 已提交
3381
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
3382
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
3383
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
3384
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
3385
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
3386 3387 3388
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
3389
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
3390
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
3391
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
3392
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
3393
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
3394 3395 3396
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
3397
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
3398
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
3399
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
3400
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
3401
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
3402 3403
        }
    } else {
E
Eric Blake 已提交
3404
        ret = false;
3405 3406 3407 3408 3409 3410
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

3411 3412 3413 3414
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
3415 3416
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
3417 3418 3419 3420
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
3421
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3422 3423 3424
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3425
static bool
3426 3427 3428
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3429
    bool ret = true;
3430

3431
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3432
        return false;
3433 3434

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
3438
        ret = false;
3439 3440 3441 3442 3443

    virDomainFree(dom);
    return ret;
}

3444 3445 3446
/*
 * "freecell" command
 */
3447
static const vshCmdInfo info_freecell[] = {
3448 3449
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
3450 3451 3452
    {NULL, NULL}
};

3453
static const vshCmdOptDef opts_freecell[] = {
3454
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
3455
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
3456 3457 3458
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3459
static bool
3460
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
3461
{
W
Wen Congyang 已提交
3462
    bool func_ret = false;
3463
    int ret;
3464
    int cell = -1, cell_given;
3465
    unsigned long long memory;
3466 3467 3468 3469
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
3470
    int all_given;
3471 3472 3473 3474
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
3475

3476

3477
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3478
        return false;
3479

3480 3481 3482 3483
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
3484 3485 3486 3487 3488 3489 3490 3491 3492
    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) {
3493 3494 3495
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3496 3497 3498
            goto cleanup;
        }

3499
        xml = virXMLParseStringCtxt(cap_xml, "node.xml", &ctxt);
3500 3501
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3502 3503
            goto cleanup;
        }
3504 3505 3506 3507
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
3508
            vshError(ctl, "%s", _("could not get information about "
3509
                                  "NUMA topology"));
3510 3511 3512
            goto cleanup;
        }

3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533
        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;
            }
        }

3534
        memory = 0;
3535 3536 3537 3538
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
3539 3540 3541 3542
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
3543
    } else {
3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557
        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));
3558 3559
    }

E
Eric Blake 已提交
3560
    func_ret = true;
3561

3562
cleanup:
3563
    xmlXPathFreeContext(ctxt);
3564
    xmlFreeDoc(xml);
3565
    VIR_FREE(nodes);
3566 3567 3568
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
3569
    return func_ret;
3570 3571
}

E
Eric Blake 已提交
3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585
/*
 * "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 已提交
3586
static bool
E
Eric Blake 已提交
3587 3588
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
3589
    const char *type = NULL;
E
Eric Blake 已提交
3590 3591
    int vcpus;

3592 3593
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
3594
        return false;
3595
    }
E
Eric Blake 已提交
3596 3597

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

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

E
Eric Blake 已提交
3605
    return true;
E
Eric Blake 已提交
3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619
}

/*
 * "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")},
3620
    {"active", VSH_OT_BOOL, 0, N_("get number of currently active vcpus")},
E
Eric Blake 已提交
3621
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
3622 3623 3624
    {"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 已提交
3625 3626 3627
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3628
static bool
E
Eric Blake 已提交
3629 3630 3631
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3632
    bool ret = true;
E
Eric Blake 已提交
3633
    int maximum = vshCommandOptBool(cmd, "maximum");
3634
    int active = vshCommandOptBool(cmd, "active");
E
Eric Blake 已提交
3635 3636
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3637 3638
    int current = vshCommandOptBool(cmd, "current");
    bool all = maximum + active + current + config + live == 0;
E
Eric Blake 已提交
3639 3640
    int count;

3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655
    /* 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 已提交
3656
        return false;
E
Eric Blake 已提交
3657
    }
3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670

    /* 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 已提交
3671
        vshError(ctl, "%s",
3672
                 _("--maximum and --active cannot both be specified"));
E
Eric Blake 已提交
3673
        return false;
E
Eric Blake 已提交
3674
    }
3675 3676 3677
    if (current + config + live > 1) {
        vshError(ctl, "%s",
                 _("--config, --live, and --current are mutually exclusive"));
E
Eric Blake 已提交
3678
        return false;
E
Eric Blake 已提交
3679 3680 3681
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3682
        return false;
E
Eric Blake 已提交
3683 3684

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

    /* In all cases, try the new API first; if it fails because we are
3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701
     * 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 已提交
3702 3703
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
3704
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
3705 3706 3707 3708 3709 3710 3711 3712 3713
        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;
            }
3714 3715
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
3716 3717 3718 3719 3720
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
3721
            ret = false;
E
Eric Blake 已提交
3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733
        } 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 |
3734
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
3735 3736 3737 3738 3739 3740 3741
        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 已提交
3742
            ret = false;
E
Eric Blake 已提交
3743 3744 3745 3746 3747 3748 3749 3750 3751 3752
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3753
    if (all || (active && config)) {
3754
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778
        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 已提交
3779
            ret = false;
E
Eric Blake 已提交
3780 3781 3782 3783 3784 3785 3786 3787 3788 3789
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3790
    if (all || (active && live)) {
3791
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
3792 3793 3794 3795 3796 3797 3798 3799 3800
        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 已提交
3801
            ret = false;
E
Eric Blake 已提交
3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815
        } 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;
}

3816 3817 3818
/*
 * "vcpuinfo" command
 */
3819
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
3820
    {"help", N_("detailed domain vcpu information")},
3821
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
3822 3823 3824
    {NULL, NULL}
};

3825
static const vshCmdOptDef opts_vcpuinfo[] = {
3826
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3827 3828 3829
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3830
static bool
3831
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
3832 3833 3834 3835 3836
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
3837 3838
    unsigned char *cpumaps;
    int ncpus, maxcpu;
3839
    size_t cpumaplen;
E
Eric Blake 已提交
3840
    bool ret = true;
3841
    int n, m;
3842

3843
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3844
        return false;
3845

J
Jim Meyering 已提交
3846
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3847
        return false;
3848 3849 3850

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3851
        return false;
3852 3853 3854 3855
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3856
        return false;
3857 3858
    }

3859
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
3860 3861 3862
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
3863

3864 3865
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
3866
                                   cpumaps, cpumaplen)) >= 0) {
3867 3868 3869 3870
        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 已提交
3871
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
3872 3873 3874 3875 3876 3877 3878 3879
            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:"));
3880 3881
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
3882 3883 3884 3885 3886 3887
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
3888
    } else {
3889
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
3890
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3891 3892 3893
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
3894
            /* fallback plan to use virDomainGetVcpuPinInfo */
3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912

            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;
3913
        }
3914 3915
    }

3916
    VIR_FREE(cpumaps);
3917
    VIR_FREE(cpuinfo);
3918 3919 3920 3921 3922 3923 3924
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
3925
static const vshCmdInfo info_vcpupin[] = {
3926
    {"help", N_("control or query domain vcpu affinity")},
3927
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
3928 3929 3930
    {NULL, NULL}
};

3931
static const vshCmdOptDef opts_vcpupin[] = {
3932
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3933 3934 3935
    {"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")},
3936 3937 3938
    {"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")},
3939 3940 3941
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3942
static bool
E
Eric Blake 已提交
3943
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
3944 3945 3946 3947
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
3948
    int vcpu = -1;
3949
    const char *cpulist = NULL;
E
Eric Blake 已提交
3950
    bool ret = true;
3951 3952
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
3953
    size_t cpumaplen;
3954 3955
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
3956
    bool unuse = false;
3957
    const char *cur;
3958 3959 3960
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
3961
    bool query = false; /* Query mode if no cpulist */
E
Eric Blake 已提交
3962
    unsigned int flags = 0;
3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978

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

3980
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3981
        return false;
3982

J
Jim Meyering 已提交
3983
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3984
        return false;
3985

3986 3987
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
3988
        virDomainFree(dom);
E
Eric Blake 已提交
3989
        return false;
3990
    }
3991
    query = !cpulist;
3992

3993 3994 3995 3996
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
3997
        virDomainFree(dom);
E
Eric Blake 已提交
3998
        return false;
3999
    }
4000

4001 4002
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
4003
        return false;
4004 4005 4006
    }

    if (virDomainGetInfo(dom, &info) != 0) {
4007
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
4008
        virDomainFree(dom);
E
Eric Blake 已提交
4009
        return false;
4010 4011 4012
    }

    if (vcpu >= info.nrVirtCpu) {
4013
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
4014
        virDomainFree(dom);
E
Eric Blake 已提交
4015
        return false;
4016 4017
    }

4018 4019
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
4020

4021 4022 4023 4024 4025 4026 4027 4028
    /* 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 已提交
4029
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074
                                             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);
4075 4076
    /* Parse cpulist */
    cur = cpulist;
4077
    if (*cur == 0) {
4078
        goto parse_error;
4079 4080 4081
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
4082
        cur = "";
4083
    }
4084 4085 4086 4087 4088 4089 4090

    while (*cur != 0) {

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

4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104
        /* 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);
4105

4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132
        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);
        }
4133

4134 4135 4136 4137 4138 4139
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
4140
        } else {
4141
            goto parse_error;
4142
        }
4143
    }
4144

4145 4146 4147 4148 4149 4150 4151 4152
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
4153 4154
    }

4155
cleanup:
4156
    VIR_FREE(cpumap);
4157 4158
    virDomainFree(dom);
    return ret;
4159 4160 4161 4162 4163

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

4166 4167 4168
/*
 * "setvcpus" command
 */
4169
static const vshCmdInfo info_setvcpus[] = {
4170 4171
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
4172 4173 4174
    {NULL, NULL}
};

4175
static const vshCmdOptDef opts_setvcpus[] = {
4176
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4177
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
4178 4179 4180
    {"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")},
4181
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
4182 4183 4184
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4185
static bool
4186
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
4187 4188
{
    virDomainPtr dom;
4189
    int count = 0;
E
Eric Blake 已提交
4190
    bool ret = true;
E
Eric Blake 已提交
4191 4192 4193
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
4194
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4195
    unsigned int flags = 0;
4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211

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

4213
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4214
        return false;
4215

J
Jim Meyering 已提交
4216
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4217
        return false;
4218

4219 4220 4221 4222
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
4223

4224
    if (flags == -1) {
E
Eric Blake 已提交
4225
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
4226
            ret = false;
E
Eric Blake 已提交
4227 4228
        }
    } else {
4229 4230 4231
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
4232
            vshDebug(ctl, VSH_ERR_DEBUG, "--maximum flag was given\n");
4233

4234 4235
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

4236 4237 4238 4239 4240 4241 4242 4243
            /* 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 已提交
4244
                ret = false;
4245 4246 4247 4248 4249
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
4250
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
4251
            ret = false;
E
Eric Blake 已提交
4252
        }
4253 4254
    }

4255
  cleanup:
4256 4257 4258 4259
    virDomainFree(dom);
    return ret;
}

4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293
/*
 * "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;
}

4294 4295 4296 4297 4298
/*
 * "send-key" command
 */
static const vshCmdInfo info_send_key[] = {
    {"help", N_("Send keycodes to the guest")},
4299
    {"desc", N_("Send keycodes (integers or symbolic names) to the guest")},
4300 4301 4302 4303 4304
    {NULL, NULL}
};

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4305 4306
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT,
     N_("the codeset of keycodes, default:linux")},
4307
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
4308
     N_("the time (in millseconds) how long the keys will be held")},
4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380
    {"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;
}

4381 4382 4383
/*
 * "setmemory" command
 */
4384
static const vshCmdInfo info_setmem[] = {
4385 4386
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
4387 4388 4389
    {NULL, NULL}
};

4390
static const vshCmdOptDef opts_setmem[] = {
4391
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4392
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
4393 4394
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
4395
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
4396 4397 4398
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4399
static bool
4400
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
4401 4402
{
    virDomainPtr dom;
4403
    virDomainInfo info;
4404
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
4405
    bool ret = true;
4406 4407
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
4408
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4409
    unsigned int flags = 0;
4410

4411 4412 4413
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4414
            return false;
4415
        }
4416
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4417 4418
    } else {
        if (config)
4419
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4420
        if (live)
4421
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4422 4423 4424
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
4425
    }
4426

4427
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4428
        return false;
4429

J
Jim Meyering 已提交
4430
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4431
        return false;
4432

4433 4434
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4435
        return false;
4436 4437
    }

4438
    if (kilobytes <= 0) {
4439
        virDomainFree(dom);
4440
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
4441
        return false;
4442 4443
    }

4444 4445
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
4446
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
4447
        return false;
4448 4449 4450 4451
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
4452
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
4453
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
4454
        return false;
4455 4456
    }

4457
    if (flags == -1) {
4458
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
4459
            ret = false;
4460 4461 4462
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
4463
            ret = false;
4464
        }
4465 4466 4467 4468 4469 4470 4471 4472 4473
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
4474
static const vshCmdInfo info_setmaxmem[] = {
4475 4476
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
4477 4478 4479
    {NULL, NULL}
};

4480
static const vshCmdOptDef opts_setmaxmem[] = {
4481
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4482
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
4483 4484 4485
    {"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")},
4486 4487 4488
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4489
static bool
4490
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
4491 4492
{
    virDomainPtr dom;
4493
    int kilobytes = 0;
E
Eric Blake 已提交
4494
    bool ret = true;
4495 4496 4497
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4498
    unsigned int flags = VIR_DOMAIN_MEM_MAXIMUM;
4499 4500 4501 4502

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4503
            return false;
4504 4505 4506
        }
    } else {
        if (config)
4507
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4508
        if (live)
4509
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4510 4511 4512 4513
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
4514

4515
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4516
        return false;
4517

J
Jim Meyering 已提交
4518
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4519
        return false;
4520

4521 4522
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4523
        return false;
4524 4525
    }

4526
    if (kilobytes <= 0) {
4527
        virDomainFree(dom);
4528
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
4529
        return false;
4530 4531
    }

4532 4533 4534
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4535
            ret = false;
4536 4537 4538 4539
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4540
            ret = false;
4541
        }
4542 4543
    }

4544 4545 4546 4547
    virDomainFree(dom);
    return ret;
}

4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563
/*
 * "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 已提交
4564 4565 4566
    {"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")},
4567 4568 4569
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4570
static bool
4571 4572 4573 4574 4575
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
4576
    int rv = 0;
4577
    unsigned int i = 0;
4578
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4579
    bool ret = false;
H
Hu Tao 已提交
4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596
    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;
    }
4597 4598

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4599
        return false;
4600 4601

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

4604
    if ((rv = vshCommandOptInt(cmd, "weight", &weight)) < 0) {
4605 4606 4607 4608 4609
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

4610
    if (rv > 0) {
4611
        nparams++;
4612
        if (weight <= 0) {
4613 4614 4615 4616 4617 4618 4619
            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 已提交
4620
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
4621 4622 4623 4624 4625 4626 4627
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4628
            ret = true;
4629 4630 4631 4632 4633
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
4634
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
4635 4636 4637 4638 4639 4640
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4641
                case VIR_TYPED_PARAM_INT:
4642 4643 4644
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4645
                case VIR_TYPED_PARAM_UINT:
4646 4647 4648
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4649
                case VIR_TYPED_PARAM_LLONG:
4650 4651 4652
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4653
                case VIR_TYPED_PARAM_ULLONG:
4654 4655 4656
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
4657
                case VIR_TYPED_PARAM_DOUBLE:
4658 4659 4660
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4661
                case VIR_TYPED_PARAM_BOOLEAN:
4662 4663 4664 4665 4666 4667 4668 4669
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
4670
        ret = true;
4671 4672 4673 4674 4675 4676
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4677
            temp->type = VIR_TYPED_PARAM_UINT;
4678 4679 4680 4681 4682 4683 4684 4685

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
H
Hu Tao 已提交
4686
        if (virDomainSetBlkioParameters(dom, params, nparams, flags) != 0)
4687 4688
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
4689
            ret = true;
4690 4691 4692 4693 4694 4695 4696 4697
    }

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

4698 4699 4700 4701
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
4702 4703 4704
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
4705 4706 4707 4708 4709 4710 4711
                "    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")},
4712
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4713
     N_("Max memory in kilobytes")},
4714
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4715
     N_("Memory during contention in kilobytes")},
4716
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4717
     N_("Max memory plus swap in kilobytes")},
4718
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
4719
     N_("Min guaranteed memory in kilobytes")},
4720 4721 4722
    {"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")},
4723 4724 4725
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4726
static bool
4727 4728 4729
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
4730 4731
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
4732 4733
    int nparams = 0;
    unsigned int i = 0;
4734
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4735
    bool ret = false;
4736 4737 4738 4739 4740 4741 4742 4743 4744 4745
    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;
        }
4746
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4747 4748
    } else {
        if (config)
4749
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4750
        if (live)
4751
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4752
    }
4753 4754

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4755
        return false;
4756 4757

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

4760 4761 4762 4763 4764 4765 4766 4767 4768
    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;
    }

4769 4770 4771 4772 4773 4774 4775 4776 4777
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

4778 4779 4780
    if (min_guarantee)
        nparams++;

4781 4782
    if (nparams == 0) {
        /* get the number of memory parameters */
4783
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
4784 4785 4786 4787 4788
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

4789 4790
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4791
            ret = true;
4792 4793 4794
            goto cleanup;
        }

4795
        /* now go get all the memory parameters */
E
Eric Blake 已提交
4796
        params = vshCalloc(ctl, nparams, sizeof(*params));
4797
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
4798 4799 4800 4801 4802 4803
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4804
                case VIR_TYPED_PARAM_INT:
4805 4806 4807
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4808
                case VIR_TYPED_PARAM_UINT:
4809 4810 4811
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4812
                case VIR_TYPED_PARAM_LLONG:
4813 4814 4815
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4816
                case VIR_TYPED_PARAM_ULLONG:
4817 4818 4819 4820 4821
                    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);
4822
                    break;
4823
                case VIR_TYPED_PARAM_DOUBLE:
4824 4825 4826
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4827
                case VIR_TYPED_PARAM_BOOLEAN:
4828 4829 4830 4831
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
4832
                    vshPrint(ctl, "unimplemented memory parameter type\n");
4833 4834 4835
            }
        }

E
Eric Blake 已提交
4836
        ret = true;
4837 4838
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
4839
        params = vshCalloc(ctl, nparams, sizeof(*params));
4840 4841 4842

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4843
            temp->type = VIR_TYPED_PARAM_ULLONG;
4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862

            /*
             * 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;
4863
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
4864 4865
                        sizeof(temp->field));
                swap_hard_limit = 0;
4866 4867 4868 4869 4870
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
4871
            }
4872 4873 4874 4875

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
4876
        }
4877
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
4878
            vshError(ctl, "%s", _("Unable to change memory parameters"));
4879
        else
E
Eric Blake 已提交
4880
            ret = true;
4881 4882 4883
    }

  cleanup:
E
Eric Blake 已提交
4884
    VIR_FREE(params);
4885 4886 4887 4888
    virDomainFree(dom);
    return ret;
}

4889 4890 4891
/*
 * "nodeinfo" command
 */
4892
static const vshCmdInfo info_nodeinfo[] = {
4893 4894
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
4895 4896 4897
    {NULL, NULL}
};

E
Eric Blake 已提交
4898
static bool
4899
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4900 4901
{
    virNodeInfo info;
4902

4903
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4904
        return false;
4905 4906

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
4907
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
4908
        return false;
4909 4910 4911 4912 4913 4914 4915 4916 4917 4918
    }
    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 已提交
4919
    return true;
4920 4921
}

4922 4923 4924 4925 4926
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
4927
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
4928 4929 4930 4931 4932 4933 4934 4935 4936 4937
    {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
4938
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
4939 4940 4941 4942
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
4943 4944
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987
    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;

4988
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
4989
                cpu_stats[i].sys = value;
4990
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
4991
                cpu_stats[i].user = value;
4992
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
4993
                cpu_stats[i].idle = value;
4994
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
4995
                cpu_stats[i].iowait = value;
4996
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010
                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) {
5011
            vshPrint(ctl, "%-15s %20llu\n", _("user:"), cpu_stats[0].user);
5012
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
5013
            vshPrint(ctl, "%-15s %20llu\n", _("idle:"), cpu_stats[0].idle);
5014 5015 5016 5017 5018 5019 5020
            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);
5021
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle:"), 100 - usage);
5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033
        } 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",
5034
                     _("user:"), user_time / total_time * 100);
5035
            vshPrint(ctl, "%-15s %5.1lf%%\n",
5036
                     _("system:"), sys_time  / total_time * 100);
5037
            vshPrint(ctl, "%-15s %5.1lf%%\n",
5038
                     _("idle:"), idle_time     / total_time * 100);
5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069
/*
 * "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;
5070 5071
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111
    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;
}

5112 5113 5114
/*
 * "capabilities" command
 */
5115
static const vshCmdInfo info_capabilities[] = {
5116 5117
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
5118 5119 5120
    {NULL, NULL}
};

E
Eric Blake 已提交
5121
static bool
5122
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5123 5124 5125
{
    char *caps;

5126
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5127
        return false;
5128 5129

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
5130
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
5131
        return false;
5132 5133
    }
    vshPrint (ctl, "%s\n", caps);
5134
    VIR_FREE(caps);
5135

E
Eric Blake 已提交
5136
    return true;
5137 5138
}

5139 5140 5141
/*
 * "dumpxml" command
 */
5142
static const vshCmdInfo info_dumpxml[] = {
5143 5144
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
5145
    {NULL, NULL}
5146 5147
};

5148
static const vshCmdOptDef opts_dumpxml[] = {
5149 5150 5151
    {"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")},
5152
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
5153
    {NULL, 0, 0, NULL}
5154 5155
};

E
Eric Blake 已提交
5156
static bool
5157
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
5158
{
5159
    virDomainPtr dom;
E
Eric Blake 已提交
5160
    bool ret = true;
5161
    char *dump;
E
Eric Blake 已提交
5162
    unsigned int flags = 0;
5163 5164
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
5165
    int update = vshCommandOptBool(cmd, "update-cpu");
5166 5167 5168 5169 5170

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
5171 5172
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
5173

5174
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5175
        return false;
5176

J
Jim Meyering 已提交
5177
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
5178
        return false;
5179

5180
    dump = virDomainGetXMLDesc(dom, flags);
5181
    if (dump != NULL) {
5182
        vshPrint(ctl, "%s", dump);
5183
        VIR_FREE(dump);
5184
    } else {
E
Eric Blake 已提交
5185
        ret = false;
5186
    }
5187

5188 5189 5190 5191
    virDomainFree(dom);
    return ret;
}

5192 5193 5194 5195
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
5196 5197
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
5198 5199 5200 5201
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
5202 5203
    {"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")},
5204 5205 5206
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5207
static bool
5208 5209
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5210
    bool ret = true;
5211 5212
    const char *format = NULL;
    const char *configFile = NULL;
5213 5214
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
5215
    unsigned int flags = 0;
5216

5217
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5218
        return false;
5219

5220 5221
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
5222
        return false;
5223

5224
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
5225
        return false;
5226 5227 5228

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
5229
        vshPrint(ctl, "%s", xmlData);
5230
        VIR_FREE(xmlData);
5231
    } else {
E
Eric Blake 已提交
5232
        ret = false;
5233 5234 5235 5236 5237 5238 5239 5240 5241
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
5242 5243
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
5244 5245 5246 5247
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
5248 5249
    {"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")},
5250 5251 5252
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5253
static bool
5254 5255
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5256
    bool ret = true;
5257 5258
    const char *format = NULL;
    const char *xmlFile = NULL;
5259 5260
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
5261
    unsigned int flags = 0;
5262

5263
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5264
        return false;
5265

5266 5267
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
5268
        return false;
5269

5270
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
5271
        return false;
5272 5273 5274

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
5275
        vshPrint(ctl, "%s", configData);
5276
        VIR_FREE(configData);
5277
    } else {
E
Eric Blake 已提交
5278
        ret = false;
5279 5280 5281 5282 5283
    }

    return ret;
}

K
Karel Zak 已提交
5284
/*
K
Karel Zak 已提交
5285
 * "domname" command
K
Karel Zak 已提交
5286
 */
5287
static const vshCmdInfo info_domname[] = {
5288
    {"help", N_("convert a domain id or UUID to domain name")},
5289
    {"desc", ""},
5290
    {NULL, NULL}
K
Karel Zak 已提交
5291 5292
};

5293
static const vshCmdOptDef opts_domname[] = {
5294
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
5295
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5296 5297
};

E
Eric Blake 已提交
5298
static bool
5299
cmdDomname(vshControl *ctl, const vshCmd *cmd)
5300
{
K
Karel Zak 已提交
5301 5302
    virDomainPtr dom;

5303
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5304
        return false;
J
Jim Meyering 已提交
5305
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5306
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
5307
        return false;
5308

K
Karel Zak 已提交
5309 5310
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
5311
    return true;
K
Karel Zak 已提交
5312 5313 5314
}

/*
K
Karel Zak 已提交
5315
 * "domid" command
K
Karel Zak 已提交
5316
 */
5317
static const vshCmdInfo info_domid[] = {
5318
    {"help", N_("convert a domain name or UUID to domain id")},
5319
    {"desc", ""},
5320
    {NULL, NULL}
K
Karel Zak 已提交
5321 5322
};

5323
static const vshCmdOptDef opts_domid[] = {
5324
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
5325
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5326 5327
};

E
Eric Blake 已提交
5328
static bool
5329
cmdDomid(vshControl *ctl, const vshCmd *cmd)
5330
{
5331
    virDomainPtr dom;
5332
    unsigned int id;
K
Karel Zak 已提交
5333

5334
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5335
        return false;
J
Jim Meyering 已提交
5336
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5337
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
5338
        return false;
5339

5340 5341
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
5342
        vshPrint(ctl, "%s\n", "-");
5343
    else
5344
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
5345
    virDomainFree(dom);
E
Eric Blake 已提交
5346
    return true;
K
Karel Zak 已提交
5347
}
5348

K
Karel Zak 已提交
5349 5350 5351
/*
 * "domuuid" command
 */
5352
static const vshCmdInfo info_domuuid[] = {
5353
    {"help", N_("convert a domain name or id to domain UUID")},
5354
    {"desc", ""},
K
Karel Zak 已提交
5355 5356 5357
    {NULL, NULL}
};

5358
static const vshCmdOptDef opts_domuuid[] = {
5359
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
5360 5361 5362
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5363
static bool
5364
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
5365 5366
{
    virDomainPtr dom;
5367
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
5368

5369
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5370
        return false;
J
Jim Meyering 已提交
5371
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5372
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
5373
        return false;
5374

K
Karel Zak 已提交
5375 5376 5377
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
5378
        vshError(ctl, "%s", _("failed to get domain UUID"));
5379

5380
    virDomainFree(dom);
E
Eric Blake 已提交
5381
    return true;
K
Karel Zak 已提交
5382 5383
}

5384 5385 5386
/*
 * "migrate" command
 */
5387
static const vshCmdInfo info_migrate[] = {
5388 5389
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
5390 5391 5392
    {NULL, NULL}
};

5393
static const vshCmdOptDef opts_migrate[] = {
5394 5395 5396 5397 5398 5399 5400
    {"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")},
5401 5402
    {"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)")},
5403 5404
    {"change-protection", VSH_OT_BOOL, 0,
     N_("prevent any configuration changes to domain until migration ends)")},
W
Wen Congyang 已提交
5405
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
5406
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
5407
    {"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)")},
5408 5409
    {"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 已提交
5410
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
5411
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
5412 5413 5414
    {NULL, 0, 0, NULL}
};

5415 5416 5417 5418 5419 5420 5421 5422
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
5423
{
5424
    char ret = '1';
5425
    virDomainPtr dom = NULL;
5426 5427 5428
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
E
Eric Blake 已提交
5429
    unsigned int flags = 0;
5430 5431 5432
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
5433 5434
    const char *xmlfile = NULL;
    char *xml = NULL;
5435
    sigset_t sigmask, oldsigmask;
5436 5437 5438 5439 5440

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

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

J
Jim Meyering 已提交
5445
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
5446
        goto out;
5447

5448 5449
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
5450 5451
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
5452
        goto out;
5453
    }
5454

5455 5456 5457 5458 5459
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

5460 5461
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
5462 5463
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
5464
    if (vshCommandOptBool (cmd, "tunnelled"))
5465
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
5466

C
Chris Lalancette 已提交
5467 5468 5469 5470 5471
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

5472 5473 5474
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

5475 5476 5477 5478 5479 5480
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

5481 5482
    if (vshCommandOptBool (cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;
5483 5484 5485 5486 5487 5488

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


5489 5490 5491 5492
    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. */
5493

5494
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
5495
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
5496
            goto out;
5497
        }
5498

5499
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
5500
            ret = '0';
5501 5502 5503 5504 5505 5506
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
5507
        if (!dconn) goto out;
5508

5509
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
5510 5511
        if (ddom) {
            virDomainFree(ddom);
5512
            ret = '0';
5513 5514 5515
        }
        virConnectClose (dconn);
    }
5516

5517 5518 5519
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
5520
    if (dom) virDomainFree (dom);
5521
    VIR_FREE(xml);
5522 5523 5524
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
5525
static void
5526 5527
print_job_progress(const char *label, unsigned long long remaining,
                   unsigned long long total)
W
Wen Congyang 已提交
5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546
{
    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;
        }
    }

5547 5548
    /* see comments in vshError about why we must flush */
    fflush(stdout);
5549
    fprintf(stderr, "\r%s: [%3d %%]", label, progress);
5550
    fflush(stderr);
W
Wen Congyang 已提交
5551 5552
}

E
Eric Blake 已提交
5553
static bool
5554 5555 5556 5557 5558
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
5559
    bool functionReturn = false;
5560 5561 5562 5563 5564
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
5565 5566
    virDomainJobInfo jobinfo;
    bool verbose = false;
5567
    int timeout = 0;
W
Wen Congyang 已提交
5568 5569
    struct timeval start, curr;
    bool live_flag = false;
5570
    vshCtrlData data;
5571 5572 5573 5574
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
5575 5576

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

W
Wen Congyang 已提交
5579 5580 5581
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
5582
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
5583
        live_flag = true;
5584
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601
        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;
        }
    }

5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624
    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 已提交
5625
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
5626
    while (1) {
5627
repoll:
W
Wen Congyang 已提交
5628 5629 5630 5631
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
5632
                    functionReturn = true;
W
Wen Congyang 已提交
5633 5634
                    if (verbose) {
                        /* print [100 %] */
5635
                        print_job_progress("Migration", 0, 1);
W
Wen Congyang 已提交
5636 5637
                    }
                } else
W
Wen Congyang 已提交
5638
                    functionReturn = false;
5639
            } else
W
Wen Congyang 已提交
5640
                functionReturn = false;
W
Wen Congyang 已提交
5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
5652
            functionReturn = false;
W
Wen Congyang 已提交
5653 5654 5655
            break;
        }

W
Wen Congyang 已提交
5656 5657 5658 5659
        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. */
5660 5661
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "suspend the domain when migration timeouts\n");
W
Wen Congyang 已提交
5662 5663 5664 5665
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
5666 5667 5668 5669 5670
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
5671 5672
                print_job_progress("Migration", jobinfo.dataRemaining,
                                   jobinfo.dataTotal);
5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
5684
    return functionReturn;
5685 5686
}

5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697
/*
 * "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")},
5698
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
5699 5700 5701
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5702
static bool
5703 5704 5705
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
5706
    long long downtime = 0;
E
Eric Blake 已提交
5707
    bool ret = false;
5708

5709
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5710
        return false;
5711 5712

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

5715 5716
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
5717 5718 5719 5720 5721 5722 5723
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
5724
    ret = true;
5725 5726 5727 5728 5729 5730

done:
    virDomainFree(dom);
    return ret;
}

5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774
/*
 * "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;
}

5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813
/*
 * "migrate-getspeed" command
 */
static const vshCmdInfo info_migrate_getspeed[] = {
    {"help", N_("Get the maximum migration bandwidth")},
    {"desc", N_("Get the maximum migration bandwidth (in Mbps) for a domain.")},
    {NULL, NULL}
};

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

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

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

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

    if (virDomainMigrateGetMaxSpeed(dom, &bandwidth, 0) < 0)
        goto done;

    vshPrint(ctl, "%lu\n", bandwidth);

    ret = true;

done:
    virDomainFree(dom);
    return ret;
}

5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830
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))
5831
        goto cleanup;
5832 5833

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
5834
        goto cleanup;
5835 5836

    if (vshCommandOptString(cmd, "path", &path) < 0)
5837
        goto cleanup;
5838

5839 5840
    if (vshCommandOptUL(cmd, "bandwidth", &bandwidth) < 0) {
        vshError(ctl, "%s", _("bandwidth must be a number"));
5841
        goto cleanup;
5842
    }
5843 5844 5845 5846 5847 5848 5849 5850 5851 5852

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

5853
cleanup:
5854 5855
    if (dom)
        virDomainFree(dom);
5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939
    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;
}


5940 5941 5942
/*
 * "net-autostart" command
 */
5943
static const vshCmdInfo info_network_autostart[] = {
5944
    {"help", N_("autostart a network")},
5945
    {"desc",
5946
     N_("Configure a network to be automatically started at boot.")},
5947 5948 5949
    {NULL, NULL}
};

5950
static const vshCmdOptDef opts_network_autostart[] = {
5951 5952
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5953 5954 5955
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5956
static bool
5957
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
5958 5959
{
    virNetworkPtr network;
5960
    const char *name;
5961 5962
    int autostart;

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

J
Jim Meyering 已提交
5966
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5967
        return false;
5968 5969 5970 5971

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
5972
        if (autostart)
5973
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
5974
        else
5975
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
5976
        virNetworkFree(network);
E
Eric Blake 已提交
5977
        return false;
5978 5979
    }

5980
    if (autostart)
5981
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
5982
    else
5983
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
5984

L
Laine Stump 已提交
5985
    virNetworkFree(network);
E
Eric Blake 已提交
5986
    return true;
5987
}
K
Karel Zak 已提交
5988

5989 5990 5991
/*
 * "net-create" command
 */
5992
static const vshCmdInfo info_network_create[] = {
5993 5994
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
5995 5996 5997
    {NULL, NULL}
};

5998
static const vshCmdOptDef opts_network_create[] = {
5999
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
6000 6001 6002
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6003
static bool
6004
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
6005 6006
{
    virNetworkPtr network;
6007
    const char *from = NULL;
E
Eric Blake 已提交
6008
    bool ret = true;
6009
    char *buffer;
6010

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

6014
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6015
        return false;
6016

6017
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6018
        return false;
6019 6020

    network = virNetworkCreateXML(ctl->conn, buffer);
6021
    VIR_FREE(buffer);
6022

6023 6024 6025
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
6026
        virNetworkFree(network);
6027
    } else {
6028
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
6029
        ret = false;
6030 6031 6032 6033 6034 6035 6036 6037
    }
    return ret;
}


/*
 * "net-define" command
 */
6038
static const vshCmdInfo info_network_define[] = {
6039 6040
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
6041 6042 6043
    {NULL, NULL}
};

6044
static const vshCmdOptDef opts_network_define[] = {
6045
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
6046 6047 6048
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6049
static bool
6050
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
6051 6052
{
    virNetworkPtr network;
6053
    const char *from = NULL;
E
Eric Blake 已提交
6054
    bool ret = true;
6055
    char *buffer;
6056

6057
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6058
        return false;
6059

6060
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6061
        return false;
6062

6063
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6064
        return false;
6065 6066

    network = virNetworkDefineXML(ctl->conn, buffer);
6067
    VIR_FREE(buffer);
6068

6069 6070 6071
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
6072
        virNetworkFree(network);
6073
    } else {
6074
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
6075
        ret = false;
6076 6077 6078 6079 6080 6081 6082 6083
    }
    return ret;
}


/*
 * "net-destroy" command
 */
6084
static const vshCmdInfo info_network_destroy[] = {
6085 6086
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
6087 6088 6089
    {NULL, NULL}
};

6090
static const vshCmdOptDef opts_network_destroy[] = {
6091
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6092 6093 6094
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6095
static bool
6096
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
6097 6098
{
    virNetworkPtr network;
E
Eric Blake 已提交
6099
    bool ret = true;
6100
    const char *name;
6101

6102
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6103
        return false;
6104

J
Jim Meyering 已提交
6105
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6106
        return false;
6107 6108 6109 6110

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

6115
    virNetworkFree(network);
6116 6117 6118 6119 6120 6121 6122
    return ret;
}


/*
 * "net-dumpxml" command
 */
6123
static const vshCmdInfo info_network_dumpxml[] = {
6124 6125
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
6126 6127 6128
    {NULL, NULL}
};

6129
static const vshCmdOptDef opts_network_dumpxml[] = {
6130
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6131 6132 6133
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6134
static bool
6135
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
6136 6137
{
    virNetworkPtr network;
E
Eric Blake 已提交
6138
    bool ret = true;
6139 6140
    char *dump;

6141
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6142
        return false;
6143

J
Jim Meyering 已提交
6144
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
6145
        return false;
6146 6147 6148

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
6149
        vshPrint(ctl, "%s", dump);
6150
        VIR_FREE(dump);
6151
    } else {
E
Eric Blake 已提交
6152
        ret = false;
6153 6154 6155 6156 6157 6158
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172
/*
 * "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 已提交
6173
static bool
O
Osier Yang 已提交
6174 6175 6176 6177 6178 6179 6180 6181 6182 6183
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 已提交
6184
        return false;
O
Osier Yang 已提交
6185 6186 6187

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6188
        return false;
O
Osier Yang 已提交
6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213

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

6214
    VIR_FREE(bridge);
O
Osier Yang 已提交
6215
    virNetworkFree(network);
E
Eric Blake 已提交
6216
    return true;
O
Osier Yang 已提交
6217
}
6218

6219 6220 6221 6222
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
6223 6224
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
6225 6226 6227 6228
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
6229
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6230 6231 6232
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6233
static bool
6234 6235
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6236
    bool ret = false;
6237 6238 6239 6240 6241
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
6242
    unsigned int flags = VIR_INTERFACE_XML_INACTIVE;
6243

6244
    if (!vshConnectionUsability(ctl, ctl->conn))
6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270
        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 已提交
6271
        ret = true;
6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283
        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)) {
6284 6285
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297
        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 已提交
6298
    ret = true;
6299 6300 6301 6302 6303

cleanup:
    if (iface)
        virInterfaceFree (iface);

6304 6305 6306
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
6307 6308 6309

    if (tmp) {
        unlink (tmp);
6310
        VIR_FREE(tmp);
6311 6312 6313 6314 6315
    }

    return ret;
}

6316 6317 6318
/*
 * "net-list" command
 */
6319
static const vshCmdInfo info_network_list[] = {
6320 6321
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
6322 6323 6324
    {NULL, NULL}
};

6325
static const vshCmdOptDef opts_network_list[] = {
6326 6327
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
6328 6329 6330
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6331
static bool
6332
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6333 6334 6335 6336 6337
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
6338
    char **activeNames = NULL, **inactiveNames = NULL;
6339 6340
    inactive |= all;

6341
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6342
        return false;
6343 6344

    if (active) {
6345 6346
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
6347
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
6348
            return false;
6349
        }
6350
        if (maxactive) {
6351
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
6352

6353
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
6354
                                                    maxactive)) < 0) {
6355
                vshError(ctl, "%s", _("Failed to list active networks"));
6356
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6357
                return false;
6358
            }
6359

6360
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
6361
        }
6362 6363
    }
    if (inactive) {
6364 6365
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
6366
            vshError(ctl, "%s", _("Failed to list inactive networks"));
6367
            VIR_FREE(activeNames);
E
Eric Blake 已提交
6368
            return false;
6369
        }
6370 6371 6372
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

6373 6374 6375
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
6376
                vshError(ctl, "%s", _("Failed to list inactive networks"));
6377 6378
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6379
                return false;
6380
            }
6381

6382 6383
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
6384
    }
6385 6386
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
6387
    vshPrintExtra(ctl, "-----------------------------------------\n");
6388 6389

    for (i = 0; i < maxactive; i++) {
6390 6391
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
6392 6393
        const char *autostartStr;
        int autostart = 0;
6394 6395 6396

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6397
            VIR_FREE(activeNames[i]);
6398
            continue;
6399
        }
6400

6401 6402 6403
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6404
            autostartStr = autostart ? _("yes") : _("no");
6405 6406 6407 6408 6409

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
6410
        virNetworkFree(network);
6411
        VIR_FREE(activeNames[i]);
6412 6413 6414
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
6415 6416
        const char *autostartStr;
        int autostart = 0;
6417 6418 6419

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6420
            VIR_FREE(inactiveNames[i]);
6421
            continue;
6422
        }
6423

6424 6425 6426
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6427
            autostartStr = autostart ? _("yes") : _("no");
6428

6429
        vshPrint(ctl, "%-20s %-10s %-10s\n",
6430 6431 6432
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
6433 6434

        virNetworkFree(network);
6435
        VIR_FREE(inactiveNames[i]);
6436
    }
6437 6438
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6439
    return true;
6440 6441 6442 6443 6444 6445
}


/*
 * "net-name" command
 */
6446
static const vshCmdInfo info_network_name[] = {
6447
    {"help", N_("convert a network UUID to network name")},
6448
    {"desc", ""},
6449 6450 6451
    {NULL, NULL}
};

6452
static const vshCmdOptDef opts_network_name[] = {
6453
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
6454 6455 6456
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6457
static bool
6458
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
6459 6460 6461
{
    virNetworkPtr network;

6462
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6463
        return false;
J
Jim Meyering 已提交
6464
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
6465
                                           VSH_BYUUID)))
E
Eric Blake 已提交
6466
        return false;
6467 6468 6469

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
6470
    return true;
6471 6472 6473 6474 6475 6476
}


/*
 * "net-start" command
 */
6477
static const vshCmdInfo info_network_start[] = {
6478 6479
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
6480 6481 6482
    {NULL, NULL}
};

6483
static const vshCmdOptDef opts_network_start[] = {
6484
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
6485 6486 6487
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6488
static bool
6489
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
6490 6491
{
    virNetworkPtr network;
E
Eric Blake 已提交
6492
    bool ret = true;
6493

6494
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6495
        return false;
6496

J
Jim Meyering 已提交
6497
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
6498
         return false;
6499 6500 6501

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
6502
                 virNetworkGetName(network));
6503
    } else {
6504
        vshError(ctl, _("Failed to start network %s"),
6505
                 virNetworkGetName(network));
E
Eric Blake 已提交
6506
        ret = false;
6507
    }
L
Laine Stump 已提交
6508
    virNetworkFree(network);
6509 6510 6511 6512 6513 6514 6515
    return ret;
}


/*
 * "net-undefine" command
 */
6516
static const vshCmdInfo info_network_undefine[] = {
6517 6518
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
6519 6520 6521
    {NULL, NULL}
};

6522
static const vshCmdOptDef opts_network_undefine[] = {
6523
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6524 6525 6526
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6527
static bool
6528
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
6529 6530
{
    virNetworkPtr network;
E
Eric Blake 已提交
6531
    bool ret = true;
6532
    const char *name;
6533

6534
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6535
        return false;
6536

J
Jim Meyering 已提交
6537
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6538
        return false;
6539 6540 6541 6542

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

L
Laine Stump 已提交
6547
    virNetworkFree(network);
6548 6549 6550 6551 6552 6553 6554
    return ret;
}


/*
 * "net-uuid" command
 */
6555
static const vshCmdInfo info_network_uuid[] = {
6556
    {"help", N_("convert a network name to network UUID")},
6557
    {"desc", ""},
6558 6559 6560
    {NULL, NULL}
};

6561
static const vshCmdOptDef opts_network_uuid[] = {
6562
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
6563 6564 6565
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6566
static bool
6567
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
6568 6569 6570 6571
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

6572
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6573
        return false;
6574

J
Jim Meyering 已提交
6575
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
6576
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6577
        return false;
6578 6579 6580 6581

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

L
Laine Stump 已提交
6584
    virNetworkFree(network);
E
Eric Blake 已提交
6585
    return true;
6586 6587 6588
}


6589 6590 6591 6592 6593
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
6594 6595
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
6596 6597 6598 6599
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
6600 6601
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
6602 6603
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
6604
static bool
6605 6606 6607 6608 6609 6610 6611 6612 6613
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;

6614
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6615
        return false;
6616 6617 6618 6619

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
6620
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
6621
            return false;
6622 6623 6624 6625 6626 6627
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
6628
                vshError(ctl, "%s", _("Failed to list active interfaces"));
6629
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6630
                return false;
6631 6632 6633 6634 6635 6636 6637 6638
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
6639
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6640
            VIR_FREE(activeNames);
E
Eric Blake 已提交
6641
            return false;
6642 6643 6644 6645
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

6646 6647 6648
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
6649
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
6650 6651
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6652
                return false;
6653 6654 6655 6656 6657
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
6658 6659
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
6660 6661 6662
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
6663 6664
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
6665 6666 6667

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6668
            VIR_FREE(activeNames[i]);
6669 6670 6671 6672 6673 6674 6675 6676
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6677
        VIR_FREE(activeNames[i]);
6678 6679
    }
    for (i = 0; i < maxinactive; i++) {
6680 6681
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
6682 6683 6684

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6685
            VIR_FREE(inactiveNames[i]);
6686 6687 6688 6689 6690 6691 6692 6693
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
6694
        VIR_FREE(inactiveNames[i]);
6695
    }
6696 6697
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6698
    return true;
6699 6700 6701 6702 6703 6704 6705

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
6706
    {"help", N_("convert an interface MAC address to interface name")},
6707 6708 6709 6710 6711
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
6712
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
6713 6714 6715
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6716
static bool
6717 6718 6719 6720
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6721
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6722
        return false;
6723 6724
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
6725
        return false;
6726 6727 6728

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6729
    return true;
6730 6731 6732 6733 6734 6735
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
6736
    {"help", N_("convert an interface name to interface MAC address")},
6737 6738 6739 6740 6741
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
6742
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
6743 6744 6745
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6746
static bool
6747 6748 6749 6750
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6751
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6752
        return false;
6753 6754
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6755
        return false;
6756 6757 6758

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6759
    return true;
6760 6761 6762 6763 6764 6765
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
6766 6767
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
6768 6769 6770 6771
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
6772 6773
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
6774 6775 6776
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6777
static bool
6778 6779 6780
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6781
    bool ret = true;
6782
    char *dump;
E
Eric Blake 已提交
6783
    unsigned int flags = 0;
6784 6785 6786 6787
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
6788

6789
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6790
        return false;
6791 6792

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

6795
    dump = virInterfaceGetXMLDesc(iface, flags);
6796
    if (dump != NULL) {
6797
        vshPrint(ctl, "%s", dump);
6798
        VIR_FREE(dump);
6799
    } else {
E
Eric Blake 已提交
6800
        ret = false;
6801 6802 6803 6804 6805 6806 6807 6808 6809 6810
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
6811 6812
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
6813 6814 6815 6816
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
6817
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
6818 6819 6820
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6821
static bool
6822 6823
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
6824
    virInterfacePtr iface;
6825
    const char *from = NULL;
E
Eric Blake 已提交
6826
    bool ret = true;
6827 6828
    char *buffer;

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

6832
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6833
        return false;
6834 6835

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

6838
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
6839
    VIR_FREE(buffer);
6840

6841
    if (iface != NULL) {
6842
        vshPrint(ctl, _("Interface %s defined from %s\n"),
6843
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
6844
        virInterfaceFree (iface);
6845
    } else {
6846
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
6847
        ret = false;
6848 6849 6850 6851 6852 6853 6854 6855
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
6856 6857
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
6858 6859 6860 6861
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
6862
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6863 6864 6865
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6866
static bool
6867 6868 6869
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6870
    bool ret = true;
6871
    const char *name;
6872

6873
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6874
        return false;
6875 6876

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6877
        return false;
6878 6879 6880 6881

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
6882
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
6883
        ret = false;
6884 6885 6886 6887 6888 6889 6890 6891 6892 6893
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
6894 6895
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
6896 6897 6898 6899
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
6900
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6901 6902 6903
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6904
static bool
6905 6906 6907
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6908
    bool ret = true;
6909
    const char *name;
6910

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

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6915
        return false;
6916 6917 6918 6919

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
6920
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
6921
        ret = false;
6922 6923 6924 6925 6926 6927 6928 6929 6930 6931
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
6932
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
6933
    {"desc", N_("forcefully stop a physical host interface.")},
6934 6935 6936 6937
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
6938
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6939 6940 6941
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6942
static bool
6943 6944 6945
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6946
    bool ret = true;
6947
    const char *name;
6948

6949
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6950
        return false;
6951 6952

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6953
        return false;
6954 6955 6956 6957

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
6958
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
6959
        ret = false;
6960 6961 6962 6963 6964 6965
    }

    virInterfaceFree(iface);
    return ret;
}

6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050
/*
 * "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;
}
7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065

/*
 * "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 已提交
7066
static bool
7067 7068 7069
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
7070
    const char *from = NULL;
E
Eric Blake 已提交
7071
    bool ret = true;
7072 7073
    char *buffer;

7074
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7075
        return false;
7076

7077
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7078
        return false;
7079 7080

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
7081
        return false;
7082 7083 7084 7085 7086 7087 7088 7089 7090 7091

    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 已提交
7092
        ret = false;
7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111
    }
    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 已提交
7112
static bool
7113 7114 7115
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
7116
    bool ret = true;
7117
    const char *name;
7118

7119
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7120
        return false;
7121 7122

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
7123
        return false;
7124 7125 7126 7127 7128

    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 已提交
7129
        ret = false;
7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150
    }

    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 已提交
7151
static bool
7152 7153 7154
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
7155
    bool ret = true;
7156 7157
    char *dump;

7158
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7159
        return false;
7160 7161

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
7162
        return false;
7163 7164 7165

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
7166
        vshPrint(ctl, "%s", dump);
7167 7168
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
7169
        ret = false;
7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188
    }

    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 已提交
7189
static bool
7190 7191 7192 7193 7194 7195
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

7196
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7197
        return false;
7198 7199 7200 7201

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
7202
        return false;
7203 7204 7205 7206 7207 7208 7209 7210
    }

    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 已提交
7211
        return false;
7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238
    }

    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 已提交
7239
    return true;
7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256
}


/*
 * "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 已提交
7257
static bool
7258 7259
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
7260
    bool ret = false;
7261 7262 7263 7264 7265 7266
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

7267
    if (!vshConnectionUsability(ctl, ctl->conn))
7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293
        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 已提交
7294
        ret = true;
7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320
        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 已提交
7321
    ret = true;
7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339

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


7340
/**************************************************************************/
7341
/*
7342
 * "pool-autostart" command
7343
 */
7344
static const vshCmdInfo info_pool_autostart[] = {
7345
    {"help", N_("autostart a pool")},
7346
    {"desc",
7347
     N_("Configure a pool to be automatically started at boot.")},
7348
    {NULL, NULL}
7349 7350
};

7351
static const vshCmdOptDef opts_pool_autostart[] = {
7352 7353
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
7354 7355
    {NULL, 0, 0, NULL}
};
7356

E
Eric Blake 已提交
7357
static bool
7358
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
7359
{
7360
    virStoragePoolPtr pool;
7361
    const char *name;
7362
    int autostart;
7363

7364
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7365
        return false;
7366

7367
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7368
        return false;
7369

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

7372 7373
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
7374
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
7375
        else
7376
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
7377
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7378
        return false;
7379 7380
    }

7381
    if (autostart)
7382
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
7383
    else
7384
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
7385

L
Laine Stump 已提交
7386
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7387
    return true;
7388 7389
}

7390
/*
7391
 * "pool-create" command
7392
 */
7393
static const vshCmdInfo info_pool_create[] = {
7394 7395
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
7396 7397 7398
    {NULL, NULL}
};

7399
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
7400
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
7401
     N_("file containing an XML pool description")},
7402 7403 7404
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7405
static bool
7406
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
7407
{
7408
    virStoragePoolPtr pool;
7409
    const char *from = NULL;
E
Eric Blake 已提交
7410
    bool ret = true;
7411
    char *buffer;
7412

7413
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7414
        return false;
7415

7416
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7417
        return false;
7418

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

7422
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
7423
    VIR_FREE(buffer);
7424 7425 7426 7427

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7428
        virStoragePoolFree(pool);
7429
    } else {
7430
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
7431
        ret = false;
7432 7433
    }
    return ret;
7434 7435
}

7436

7437 7438 7439 7440
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
7441
    {"help", N_("create a device defined "
7442
                          "by an XML file on the node")},
7443
    {"desc", N_("Create a device on the node.  Note that this "
7444 7445 7446 7447 7448 7449 7450
                          "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,
7451
     N_("file containing an XML description of the device")},
7452 7453 7454
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7455
static bool
7456 7457 7458
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
7459
    const char *from = NULL;
E
Eric Blake 已提交
7460
    bool ret = true;
7461 7462
    char *buffer;

7463
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7464
        return false;
7465

7466
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7467
        return false;
7468

7469
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
7470
        return false;
7471 7472

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
7473
    VIR_FREE(buffer);
7474 7475 7476 7477

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
7478
        virNodeDeviceFree(dev);
7479
    } else {
7480
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
7481
        ret = false;
7482 7483 7484 7485 7486 7487 7488 7489 7490 7491
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
7492
    {"help", N_("destroy (stop) a device on the node")},
7493
    {"desc", N_("Destroy a device on the node.  Note that this "
7494
                "command destroys devices on the physical host")},
7495 7496 7497 7498 7499
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
7500
     N_("name of the device to be destroyed")},
7501 7502 7503
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7504
static bool
7505 7506 7507
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
7508
    bool ret = true;
7509
    const char *name = NULL;
7510

7511
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
7512
        return false;
7513 7514
    }

7515
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
7516
        return false;
7517 7518 7519 7520 7521 7522

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
7523
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
7524
        ret = false;
7525 7526 7527 7528 7529 7530 7531
    }

    virNodeDeviceFree(dev);
    return ret;
}


7532
/*
7533
 * XML Building helper for pool-define-as and pool-create-as
7534
 */
7535
static const vshCmdOptDef opts_pool_X_as[] = {
7536 7537 7538 7539 7540 7541 7542 7543
    {"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")},
7544
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
7545 7546 7547
    {NULL, 0, 0, NULL}
};

7548
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
7549

7550 7551
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
7552
    virBuffer buf = VIR_BUFFER_INITIALIZER;
7553

7554
    if (vshCommandOptString(cmd, "name", &name) <= 0)
7555
        goto cleanup;
7556
    if (vshCommandOptString(cmd, "type", &type) <= 0)
7557 7558
        goto cleanup;

7559 7560 7561 7562 7563
    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 ||
7564 7565
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
7566
        goto cleanup;
7567
    }
7568

7569 7570
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
7571
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
7572
        virBufferAddLit(&buf, "  <source>\n");
7573

7574
        if (srcHost)
7575
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
7576
        if (srcPath)
7577
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
7578
        if (srcDev)
7579
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
7580
        if (srcFormat)
7581
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
7582
        if (srcName)
7583
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
7584 7585

        virBufferAddLit(&buf, "  </source>\n");
7586 7587
    }
    if (target) {
7588
        virBufferAddLit(&buf, "  <target>\n");
7589
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
7590
        virBufferAddLit(&buf, "  </target>\n");
7591
    }
7592 7593 7594 7595
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7596
        return false;
7597
    }
7598 7599 7600

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
7601
    return true;
7602 7603

cleanup:
7604
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7605
    return false;
7606 7607 7608 7609 7610 7611
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
7612 7613
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
7614 7615 7616
    {NULL, NULL}
};

E
Eric Blake 已提交
7617
static bool
7618 7619 7620
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
7621 7622
    const char *name;
    char *xml;
7623
    int printXML = vshCommandOptBool(cmd, "print-xml");
7624

7625
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7626
        return false;
7627 7628

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

7631
    if (printXML) {
7632
        vshPrint(ctl, "%s", xml);
7633
        VIR_FREE(xml);
7634
    } else {
7635
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
7636
        VIR_FREE(xml);
7637

7638 7639 7640 7641
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
7642
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
7643
            return false;
7644 7645
        }
    }
E
Eric Blake 已提交
7646
    return true;
7647 7648
}

7649

7650
/*
7651
 * "pool-define" command
7652
 */
7653
static const vshCmdInfo info_pool_define[] = {
7654 7655
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
7656 7657 7658
    {NULL, NULL}
};

7659
static const vshCmdOptDef opts_pool_define[] = {
7660
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
7661 7662 7663
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7664
static bool
7665
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
7666
{
7667
    virStoragePoolPtr pool;
7668
    const char *from = NULL;
E
Eric Blake 已提交
7669
    bool ret = true;
7670
    char *buffer;
7671

7672
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7673
        return false;
7674

7675
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7676
        return false;
7677

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

7681
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
7682
    VIR_FREE(buffer);
7683 7684 7685 7686

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7687
        virStoragePoolFree(pool);
7688
    } else {
7689
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
7690
        ret = false;
7691 7692
    }
    return ret;
7693 7694
}

7695

7696 7697 7698
/*
 * "pool-define-as" command
 */
7699
static const vshCmdInfo info_pool_define_as[] = {
7700 7701
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
7702 7703 7704
    {NULL, NULL}
};

E
Eric Blake 已提交
7705
static bool
7706
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
7707 7708
{
    virStoragePoolPtr pool;
7709 7710
    const char *name;
    char *xml;
7711
    int printXML = vshCommandOptBool(cmd, "print-xml");
7712

7713
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7714
        return false;
7715

7716
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
7717
        return false;
7718

7719
    if (printXML) {
7720
        vshPrint(ctl, "%s", xml);
7721
        VIR_FREE(xml);
7722
    } else {
7723
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
7724
        VIR_FREE(xml);
7725

7726 7727 7728 7729
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
7730
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
7731
            return false;
7732 7733
        }
    }
E
Eric Blake 已提交
7734
    return true;
7735 7736 7737
}


7738
/*
7739
 * "pool-build" command
7740
 */
7741
static const vshCmdInfo info_pool_build[] = {
7742 7743
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
7744 7745 7746
    {NULL, NULL}
};

7747
static const vshCmdOptDef opts_pool_build[] = {
7748
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7749 7750
    {"no-overwrite", VSH_OT_BOOL, 0, N_("do not overwrite an existing pool of this type")},
    {"overwrite", VSH_OT_BOOL, 0, N_("overwrite any existing data")},
7751 7752 7753
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7754
static bool
7755
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
7756
{
7757
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7758
    bool ret = true;
7759
    const char *name;
7760
    unsigned int flags = 0;
7761

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

7765
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7766
        return false;
7767

7768 7769 7770 7771 7772 7773 7774 7775 7776
    if (vshCommandOptBool (cmd, "no-overwrite")) {
        flags |= VIR_STORAGE_POOL_BUILD_NO_OVERWRITE;
    }

    if (vshCommandOptBool (cmd, "overwrite")) {
        flags |= VIR_STORAGE_POOL_BUILD_OVERWRITE;
    }

    if (virStoragePoolBuild(pool, flags) == 0) {
7777
        vshPrint(ctl, _("Pool %s built\n"), name);
7778
    } else {
7779
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
7780
        ret = false;
7781 7782
    }

7783 7784
    virStoragePoolFree(pool);

7785 7786 7787
    return ret;
}

7788
/*
7789
 * "pool-destroy" command
7790
 */
7791
static const vshCmdInfo info_pool_destroy[] = {
7792 7793 7794
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
7795 7796 7797
    {NULL, NULL}
};

7798
static const vshCmdOptDef opts_pool_destroy[] = {
7799
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7800 7801 7802
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7803
static bool
7804
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
7805
{
7806
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7807
    bool ret = true;
7808
    const char *name;
7809

7810
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7811
        return false;
7812

7813
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7814
        return false;
7815

7816 7817 7818
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
7819
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
7820
        ret = false;
7821 7822
    }

7823
    virStoragePoolFree(pool);
7824 7825 7826
    return ret;
}

7827

7828
/*
7829 7830
 * "pool-delete" command
 */
7831
static const vshCmdInfo info_pool_delete[] = {
7832 7833
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
7834 7835 7836
    {NULL, NULL}
};

7837
static const vshCmdOptDef opts_pool_delete[] = {
7838
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7839 7840 7841
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7842
static bool
7843
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
7844 7845
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7846
    bool ret = true;
7847
    const char *name;
7848

7849
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7850
        return false;
7851 7852

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7853
        return false;
7854 7855

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
7856
        vshPrint(ctl, _("Pool %s deleted\n"), name);
7857
    } else {
7858
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
7859
        ret = false;
7860 7861
    }

L
Laine Stump 已提交
7862
    virStoragePoolFree(pool);
7863 7864 7865 7866 7867 7868 7869
    return ret;
}


/*
 * "pool-refresh" command
 */
7870
static const vshCmdInfo info_pool_refresh[] = {
7871 7872
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
7873 7874 7875
    {NULL, NULL}
};

7876
static const vshCmdOptDef opts_pool_refresh[] = {
7877
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7878 7879 7880
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7881
static bool
7882
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
7883 7884
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7885
    bool ret = true;
7886
    const char *name;
7887

7888
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7889
        return false;
7890 7891

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7892
        return false;
7893 7894 7895 7896

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
7897
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
7898
        ret = false;
7899 7900 7901 7902 7903 7904 7905 7906 7907 7908
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
7909
static const vshCmdInfo info_pool_dumpxml[] = {
7910 7911
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
7912 7913 7914
    {NULL, NULL}
};

7915
static const vshCmdOptDef opts_pool_dumpxml[] = {
7916
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7917 7918 7919
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7920
static bool
7921
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
7922 7923
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7924
    bool ret = true;
7925 7926
    char *dump;

7927
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7928
        return false;
7929 7930

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7931
        return false;
7932 7933 7934

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
7935
        vshPrint(ctl, "%s", dump);
7936
        VIR_FREE(dump);
7937
    } else {
E
Eric Blake 已提交
7938
        ret = false;
7939 7940 7941 7942 7943 7944 7945 7946 7947 7948
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
7949
static const vshCmdInfo info_pool_list[] = {
7950 7951
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
7952 7953 7954
    {NULL, NULL}
};

7955
static const vshCmdOptDef opts_pool_list[] = {
7956 7957
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
7958
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
7959 7960 7961
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7962
static bool
7963
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7964
{
7965 7966
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
7967 7968
    int i, ret;
    bool functionReturn;
7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984
    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 */
7985
    int all = vshCommandOptBool(cmd, "all");
7986 7987
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
7988 7989 7990
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

7991
    /* Check the connection to libvirtd daemon is still working */
7992
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7993
        return false;
7994

7995
    /* Retrieve the number of active storage pools */
7996
    if (active) {
7997 7998
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
7999
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
8000
            return false;
8001 8002
        }
    }
8003 8004

    /* Retrieve the number of inactive storage pools */
8005
    if (inactive) {
8006 8007
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
8008
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
8009
            return false;
8010
        }
8011
    }
8012

8013 8014
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
8015

8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027
    /* 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 已提交
8028
            return false;
8029 8030 8031
        }
    }

8032 8033 8034 8035 8036 8037 8038 8039
    /* 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 已提交
8040
            return false;
8041 8042
        }
    }
8043

8044 8045 8046 8047 8048 8049 8050 8051 8052 8053
    /* 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]);
8054
        if (!pool) {
8055
            VIR_FREE(poolNames[i]);
8056 8057 8058
            continue;
        }

8059
        /* Retrieve the autostart status of the pool */
8060
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
8061
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
8062
        else
8063 8064 8065 8066 8067 8068
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
8069 8070
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081
            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;
        }
8082

8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194
        /* 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 */
8195 8196 8197
        virStoragePoolFree(pool);
    }

8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215
    /* 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);
8216 8217
        }

8218
        /* Cleanup and return */
E
Eric Blake 已提交
8219
        functionReturn = true;
8220 8221
        goto cleanup;
    }
8222

8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260
    /* 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. */
8261
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
8262
             (unsigned long) nameStrLength);
8263
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
8264
             (unsigned long) stateStrLength);
8265
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
8266
             (unsigned long) autostartStrLength);
8267
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
8268
             (unsigned long) persistStrLength);
8269
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
8270
             (unsigned long) capStrLength);
8271
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
8272
             (unsigned long) allocStrLength);
8273
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316
             (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 已提交
8317
    functionReturn = true;
8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331
    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 已提交
8332
    functionReturn = false;
8333

8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345
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]);
8346
    }
8347 8348 8349 8350 8351 8352 8353

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

    /* Return the desired value */
    return functionReturn;
8354 8355
}

8356 8357 8358 8359
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
8360 8361
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
8362 8363 8364 8365 8366
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
8367 8368 8369
     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")},
8370
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
8371 8372 8373
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8374
static bool
8375 8376
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
8377
    const char *type = NULL, *host = NULL;
8378 8379
    char *srcSpec = NULL;
    char *srcList;
8380
    const char *initiator = NULL;
8381

8382 8383
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
8384 8385
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
8386
        return false;
8387
    }
8388

8389
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8390
        return false;
8391 8392

    if (host) {
8393
        const char *port = NULL;
8394
        virBuffer buf = VIR_BUFFER_INITIALIZER;
8395 8396 8397 8398

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
8399
            return false;
8400
        }
8401
        virBufferAddLit(&buf, "<source>\n");
8402
        virBufferAsprintf(&buf, "  <host name='%s'", host);
8403
        if (port)
8404
            virBufferAsprintf(&buf, " port='%s'", port);
8405
        virBufferAddLit(&buf, "/>\n");
8406 8407
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
8408
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
8409 8410
            virBufferAddLit(&buf, "  </initiator>\n");
        }
8411 8412 8413
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
8414
            return false;
8415
        }
8416
        srcSpec = virBufferContentAndReset(&buf);
8417 8418 8419
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
8420
    VIR_FREE(srcSpec);
8421
    if (srcList == NULL) {
8422
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
8423
        return false;
8424 8425
    }
    vshPrint(ctl, "%s", srcList);
8426
    VIR_FREE(srcList);
8427

E
Eric Blake 已提交
8428
    return true;
8429 8430 8431 8432 8433 8434 8435
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
8436 8437
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
8438 8439 8440 8441 8442
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
8443
     N_("type of storage pool sources to discover")},
8444
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
8445
     N_("optional file of source xml to query for pools")},
8446 8447 8448
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8449
static bool
8450 8451
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
8452
    const char *type = NULL, *srcSpecFile = NULL;
8453
    char *srcSpec = NULL, *srcList;
8454

8455
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
8456
        return false;
8457

8458 8459
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
8460
        return false;
8461
    }
8462

8463
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8464
        return false;
8465 8466

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
8467
        return false;
8468 8469

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
8470
    VIR_FREE(srcSpec);
8471
    if (srcList == NULL) {
8472
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
8473
        return false;
8474 8475
    }
    vshPrint(ctl, "%s", srcList);
8476
    VIR_FREE(srcList);
8477

E
Eric Blake 已提交
8478
    return true;
8479 8480 8481
}


8482 8483 8484
/*
 * "pool-info" command
 */
8485
static const vshCmdInfo info_pool_info[] = {
8486 8487
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
8488 8489 8490
    {NULL, NULL}
};

8491
static const vshCmdOptDef opts_pool_info[] = {
8492
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8493 8494 8495
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8496
static bool
8497
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
8498 8499 8500
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
8501 8502
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
8503
    bool ret = true;
8504 8505
    char uuid[VIR_UUID_STRING_BUFLEN];

8506
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8507
        return false;
8508 8509

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8510
        return false;
8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536

    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;
8537 8538 8539 8540
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
8541 8542
        }

8543 8544
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
8545 8546
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
8547 8548 8549 8550 8551 8552 8553
        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);
8554 8555
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
8556 8557 8558 8559 8560
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572
        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 已提交
8573
        ret = false;
8574 8575 8576 8577 8578 8579 8580 8581 8582 8583
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
8584
static const vshCmdInfo info_pool_name[] = {
8585
    {"help", N_("convert a pool UUID to pool name")},
8586
    {"desc", ""},
8587 8588 8589
    {NULL, NULL}
};

8590
static const vshCmdOptDef opts_pool_name[] = {
8591
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
8592 8593 8594
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8595
static bool
8596
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
8597 8598 8599
{
    virStoragePoolPtr pool;

8600
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8601
        return false;
8602
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8603
                                           VSH_BYUUID)))
E
Eric Blake 已提交
8604
        return false;
8605 8606 8607

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8608
    return true;
8609 8610 8611 8612 8613 8614
}


/*
 * "pool-start" command
 */
8615
static const vshCmdInfo info_pool_start[] = {
8616 8617
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
8618 8619 8620
    {NULL, NULL}
};

8621
static const vshCmdOptDef opts_pool_start[] = {
8622
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
8623 8624 8625
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8626
static bool
8627
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
8628 8629
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8630
    bool ret = true;
8631

8632
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8633
        return false;
8634

8635
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
8636
         return false;
8637 8638 8639 8640 8641

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
8642
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
8643
        ret = false;
8644
    }
L
Laine Stump 已提交
8645 8646

    virStoragePoolFree(pool);
8647 8648 8649 8650
    return ret;
}


8651 8652 8653
/*
 * "vol-create-as" command
 */
8654
static const vshCmdInfo info_vol_create_as[] = {
8655 8656
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
8657 8658 8659
    {NULL, NULL}
};

8660
static const vshCmdOptDef opts_vol_create_as[] = {
8661 8662 8663 8664 8665
    {"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")},
8666 8667
    {"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")},
8668 8669 8670 8671 8672 8673 8674 8675 8676 8677
    {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 已提交
8678
        /* Deliberate fallthrough cases here :-) */
8679 8680 8681
        switch (*end) {
        case 'T':
            *val *= 1024;
8682
            /* fallthrough */
8683 8684
        case 'G':
            *val *= 1024;
8685
            /* fallthrough */
8686 8687
        case 'M':
            *val *= 1024;
8688
            /* fallthrough */
8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
8702
static bool
8703
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
8704 8705 8706
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8707
    char *xml;
8708 8709
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
8710
    unsigned long long capacity, allocation = 0;
8711
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8712

8713
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8714
        return false;
8715 8716 8717

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

8720
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8721 8722
        goto cleanup;

8723
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
8724 8725
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
8726
        vshError(ctl, _("Malformed size %s"), capacityStr);
8727

8728 8729
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
8730
        vshError(ctl, _("Malformed size %s"), allocationStr);
8731

8732 8733 8734 8735 8736 8737 8738
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

8739

8740
    virBufferAddLit(&buf, "<volume>\n");
8741 8742
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
8743
    if (allocationStr)
8744
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
8745 8746

    if (format) {
8747
        virBufferAddLit(&buf, "  <target>\n");
8748
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
8749
        virBufferAddLit(&buf, "  </target>\n");
8750
    }
8751

8752 8753 8754 8755
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
8756 8757
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
8758 8759 8760
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
8761 8762
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
8763 8764 8765 8766 8767
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
8768 8769
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
8770 8771 8772
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
8773 8774
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
8775 8776 8777 8778 8779
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
8780 8781
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
8782 8783 8784
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
8785 8786
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
8787 8788 8789 8790
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
8791
            goto cleanup;
8792 8793 8794 8795 8796
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
8797
            goto cleanup;
8798 8799 8800 8801
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
8802
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
8803
        if (snapshotStrFormat)
8804
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
8805 8806 8807 8808 8809 8810 8811 8812
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

8814 8815
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
8816
        goto cleanup;
8817 8818 8819
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
8820
    VIR_FREE(xml);
8821 8822 8823 8824 8825
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
8826
        return true;
8827
    } else {
8828
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
8829
        return false;
8830 8831 8832
    }

 cleanup:
8833
    virBufferFreeAndReset(&buf);
8834
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8835
    return false;
8836 8837 8838
}


8839 8840 8841
/*
 * "pool-undefine" command
 */
8842
static const vshCmdInfo info_pool_undefine[] = {
8843 8844
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
8845 8846 8847
    {NULL, NULL}
};

8848
static const vshCmdOptDef opts_pool_undefine[] = {
8849
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8850 8851 8852
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8853
static bool
8854
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
8855 8856
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8857
    bool ret = true;
8858
    const char *name;
8859

8860
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8861
        return false;
8862 8863

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8864
        return false;
8865 8866 8867 8868

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

L
Laine Stump 已提交
8873
    virStoragePoolFree(pool);
8874 8875 8876 8877 8878 8879 8880
    return ret;
}


/*
 * "pool-uuid" command
 */
8881
static const vshCmdInfo info_pool_uuid[] = {
8882
    {"help", N_("convert a pool name to pool UUID")},
8883
    {"desc", ""},
8884 8885 8886
    {NULL, NULL}
};

8887
static const vshCmdOptDef opts_pool_uuid[] = {
8888
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
8889 8890 8891
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8892
static bool
8893
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
8894 8895 8896 8897
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

8898
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8899
        return false;
8900 8901

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8902
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8903
        return false;
8904 8905 8906 8907

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

L
Laine Stump 已提交
8910
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8911
    return true;
8912 8913 8914 8915 8916 8917
}


/*
 * "vol-create" command
 */
8918
static const vshCmdInfo info_vol_create[] = {
8919 8920
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
8921 8922 8923
    {NULL, NULL}
};

8924
static const vshCmdOptDef opts_vol_create[] = {
8925 8926
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
8927 8928 8929
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8930
static bool
8931
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
8932 8933 8934
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8935
    const char *from = NULL;
E
Eric Blake 已提交
8936
    bool ret = true;
8937 8938
    char *buffer;

8939
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8940
        return false;
8941 8942

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

8946
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8947
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8948
        return false;
8949 8950 8951
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8952
        virshReportError(ctl);
8953
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8954
        return false;
8955 8956 8957
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
8958
    VIR_FREE(buffer);
8959 8960 8961 8962 8963 8964 8965
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
8966
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
8967
        ret = false;
8968 8969 8970 8971
    }
    return ret;
}

8972 8973 8974 8975
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
8976 8977
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
8978 8979 8980 8981
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
8982 8983 8984
    {"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 已提交
8985
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
8986 8987 8988
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8989
static bool
8990 8991 8992 8993
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
8994
    const char *from = NULL;
E
Eric Blake 已提交
8995
    bool ret = false;
8996 8997
    char *buffer = NULL;

8998
    if (!vshConnectionUsability(ctl, ctl->conn))
8999 9000 9001 9002 9003
        goto cleanup;

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

9004
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9005 9006 9007 9008 9009 9010 9011
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9012
        virshReportError(ctl);
9013 9014 9015 9016 9017 9018 9019 9020 9021
        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 {
9022
        vshError(ctl, _("Failed to create vol from %s"), from);
9023 9024 9025
        goto cleanup;
    }

E
Eric Blake 已提交
9026
    ret = true;
9027
cleanup:
9028
    VIR_FREE(buffer);
9029 9030 9031 9032
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
9033 9034
    if (newvol)
        virStorageVolFree(newvol);
9035 9036 9037 9038
    return ret;
}

static xmlChar *
9039
makeCloneXML(const char *origxml, const char *newname) {
9040

9041 9042 9043
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
9044 9045 9046
    xmlChar *newxml = NULL;
    int size;

9047
    doc = virXMLParseStringCtxt(origxml, "domain.xml", &ctxt);
9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069
    if (!doc)
        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[] = {
9070 9071
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
9072 9073 9074 9075
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
9076 9077
    {"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 已提交
9078
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9079 9080 9081
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9082
static bool
9083 9084 9085 9086
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
9087
    const char *name = NULL;
9088
    char *origxml = NULL;
9089
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
9090
    bool ret = false;
9091

9092
    if (!vshConnectionUsability(ctl, ctl->conn))
9093 9094 9095 9096 9097 9098 9099
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
9100
        vshError(ctl, "%s", _("failed to get parent pool"));
9101 9102 9103
        goto cleanup;
    }

9104
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122
        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 {
9123
        vshError(ctl, _("Failed to clone vol from %s"),
9124 9125 9126 9127
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
9128
    ret = true;
9129 9130

cleanup:
9131
    VIR_FREE(origxml);
9132 9133 9134
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
9135 9136
    if (newvol)
        virStorageVolFree(newvol);
9137 9138 9139 9140 9141
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154

/*
 * "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 已提交
9155
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169
    {"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 已提交
9170
static bool
9171 9172 9173 9174
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
9175
    bool ret = false;
9176 9177 9178 9179 9180 9181 9182 9183 9184 9185
    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 已提交
9186
        return false;
9187 9188 9189 9190
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
9191
        return false;
9192 9193 9194
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9195
        return false;
9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229
    }

    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 已提交
9230
    ret = true;
9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254

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 已提交
9255
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9256 9257 9258 9259 9260
    {"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 已提交
9261
static bool
9262 9263 9264 9265
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
9266
    bool ret = false;
9267 9268 9269 9270
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
9271
    bool created = false;
9272 9273

    if (!vshConnectionUsability(ctl, ctl->conn))
9274
        return false;
9275 9276 9277

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
9278
        return false;
9279 9280 9281 9282
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
9283
        return false;
9284 9285 9286
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
9287
        return false;
9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299

    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;
        }
9300 9301
    } else {
        created = true;
9302 9303 9304 9305 9306 9307 9308 9309
    }

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

9310
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325
        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 已提交
9326
    ret = true;
9327 9328

cleanup:
9329
    VIR_FORCE_CLOSE(fd);
9330
    if (!ret && created)
9331 9332 9333 9334 9335 9336 9337 9338 9339
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


9340 9341 9342
/*
 * "vol-delete" command
 */
9343
static const vshCmdInfo info_vol_delete[] = {
9344 9345
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
9346 9347 9348
    {NULL, NULL}
};

9349
static const vshCmdOptDef opts_vol_delete[] = {
9350
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9351
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9352 9353 9354
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9355
static bool
9356
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
9357 9358
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9359
    bool ret = true;
9360
    const char *name;
9361

9362
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9363
        return false;
9364 9365

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9366
        return false;
9367 9368 9369
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
9370
        vshPrint(ctl, _("Vol %s deleted\n"), name);
9371
    } else {
9372
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
9373
        ret = false;
9374 9375
    }

L
Laine Stump 已提交
9376
    virStorageVolFree(vol);
9377 9378 9379 9380
    return ret;
}


D
David Allan 已提交
9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391
/*
 * "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 已提交
9392
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
9393 9394 9395
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9396
static bool
D
David Allan 已提交
9397 9398 9399
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9400
    bool ret = true;
9401
    const char *name;
D
David Allan 已提交
9402

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

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9407
        return false;
D
David Allan 已提交
9408 9409 9410 9411 9412 9413
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
9414
        ret = false;
D
David Allan 已提交
9415 9416 9417 9418 9419 9420 9421
    }

    virStorageVolFree(vol);
    return ret;
}


9422 9423 9424
/*
 * "vol-info" command
 */
9425
static const vshCmdInfo info_vol_info[] = {
9426 9427
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
9428 9429 9430
    {NULL, NULL}
};

9431
static const vshCmdOptDef opts_vol_info[] = {
9432
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9433
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9434 9435 9436
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9437
static bool
9438
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
9439 9440 9441
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
9442
    bool ret = true;
9443

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

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9448
        return false;
9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464

    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 已提交
9465
        ret = false;
9466 9467 9468 9469 9470 9471 9472 9473 9474 9475
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
9476
static const vshCmdInfo info_vol_dumpxml[] = {
9477 9478
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
9479 9480 9481
    {NULL, NULL}
};

9482
static const vshCmdOptDef opts_vol_dumpxml[] = {
9483
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9484
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9485 9486 9487
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9488
static bool
9489
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
9490 9491
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9492
    bool ret = true;
9493 9494
    char *dump;

9495
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9496
        return false;
9497 9498

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9499
        return false;
9500 9501 9502

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
9503
        vshPrint(ctl, "%s", dump);
9504
        VIR_FREE(dump);
9505
    } else {
E
Eric Blake 已提交
9506
        ret = false;
9507 9508 9509 9510 9511 9512 9513 9514 9515 9516
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
9517
static const vshCmdInfo info_vol_list[] = {
9518 9519
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
9520 9521 9522
    {NULL, NULL}
};

9523
static const vshCmdOptDef opts_vol_list[] = {
9524
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9525
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
9526 9527 9528
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9529
static bool
9530
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9531
{
9532
    virStorageVolInfo volumeInfo;
9533 9534
    virStoragePoolPtr pool;
    char **activeNames = NULL;
9535 9536 9537 9538 9539
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
9540 9541
    int ret;
    bool functionReturn;
9542 9543 9544 9545 9546 9547 9548 9549 9550 9551 9552
    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;
9553

9554
    /* Check the connection to libvirtd daemon is still working */
9555
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9556
        return false;
9557

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

9562 9563
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
9564

9565 9566 9567
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9568
        return false;
9569 9570
    }

9571 9572 9573 9574 9575
    /* 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) {
9576
            vshError(ctl, "%s", _("Failed to list active vols"));
9577
            VIR_FREE(activeNames);
9578
            virStoragePoolFree(pool);
E
Eric Blake 已提交
9579
            return false;
9580 9581
        }

9582 9583 9584 9585 9586
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

9589 9590 9591 9592 9593
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
9594

9595 9596 9597 9598
        /* 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"));
9599 9600
        }

9601 9602 9603 9604 9605 9606 9607 9608 9609
        /* 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 */
9610

9611
                /* Volume type */
9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624
                switch (volumeInfo.type) {
                        case VIR_STORAGE_VOL_FILE:
                            volInfoTexts[i].type = vshStrdup(ctl, _("file"));
                            break;
                        case VIR_STORAGE_VOL_BLOCK:
                            volInfoTexts[i].type = vshStrdup(ctl, _("block"));
                            break;
                        case VIR_STORAGE_VOL_DIR:
                            volInfoTexts[i].type = vshStrdup(ctl, _("dir"));
                            break;
                        default:
                            volInfoTexts[i].type = vshStrdup(ctl, _("unknown"));
                }
9625 9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674

                /* 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;
        }
9675

9676
        /* Cleanup memory allocation */
9677
        virStorageVolFree(vol);
9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695
    }

    /* 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 已提交
9696
        functionReturn = true;
9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727
        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 */
9728 9729 9730 9731 9732 9733 9734 9735 9736 9737
    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);
9738 9739 9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751 9752 9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771

    /* 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 已提交
9772
    functionReturn = true;
9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786
    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 已提交
9787
    functionReturn = false;
9788 9789 9790 9791 9792 9793 9794 9795 9796 9797

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);
9798
        VIR_FREE(activeNames[i]);
9799
    }
9800 9801 9802 9803

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
9804
    VIR_FREE(activeNames);
9805
    virStoragePoolFree(pool);
9806 9807 9808

    /* Return the desired value */
    return functionReturn;
9809 9810 9811 9812 9813 9814
}


/*
 * "vol-name" command
 */
9815
static const vshCmdInfo info_vol_name[] = {
9816
    {"help", N_("returns the volume name for a given volume key or path")},
9817
    {"desc", ""},
9818 9819 9820
    {NULL, NULL}
};

9821
static const vshCmdOptDef opts_vol_name[] = {
9822
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
9823 9824 9825
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9826
static bool
9827
cmdVolName(vshControl *ctl, const vshCmd *cmd)
9828 9829 9830
{
    virStorageVolPtr vol;

9831
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9832
        return false;
9833

9834
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
9835
                                   VSH_BYUUID)))
E
Eric Blake 已提交
9836
        return false;
9837 9838 9839

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9840
    return true;
9841 9842 9843
}


J
Justin Clift 已提交
9844 9845 9846 9847 9848 9849 9850 9851 9852 9853
/*
 * "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[] = {
9854
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
9855 9856 9857 9858
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9859
static bool
J
Justin Clift 已提交
9860 9861 9862 9863
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9864
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
9865 9866

    /* Check the connection to libvirtd daemon is still working */
9867
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9868
        return false;
J
Justin Clift 已提交
9869 9870

    /* Use the supplied string to locate the volume */
9871
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
9872
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
9873
        return false;
J
Justin Clift 已提交
9874 9875 9876 9877 9878 9879 9880
    }

    /* 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 已提交
9881
        return false;
J
Justin Clift 已提交
9882 9883
    }

9884 9885 9886 9887 9888 9889 9890 9891 9892
    /* 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 已提交
9893 9894 9895 9896

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9897
    return true;
J
Justin Clift 已提交
9898 9899
}

9900 9901 9902 9903

/*
 * "vol-key" command
 */
9904
static const vshCmdInfo info_vol_key[] = {
9905
    {"help", N_("returns the volume key for a given volume name or path")},
9906
    {"desc", ""},
9907 9908 9909
    {NULL, NULL}
};

9910
static const vshCmdOptDef opts_vol_key[] = {
9911
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
9912
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9913 9914 9915
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9916
static bool
9917
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
9918 9919 9920
{
    virStorageVolPtr vol;

9921
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9922
        return false;
9923

9924
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9925
        return false;
9926 9927 9928

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9929
    return true;
9930 9931 9932 9933 9934 9935 9936
}



/*
 * "vol-path" command
 */
9937
static const vshCmdInfo info_vol_path[] = {
9938
    {"help", N_("returns the volume path for a given volume name or key")},
9939
    {"desc", ""},
9940 9941 9942
    {NULL, NULL}
};

9943
static const vshCmdOptDef opts_vol_path[] = {
9944
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
9945
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9946 9947 9948
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9949
static bool
9950
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
9951 9952
{
    virStorageVolPtr vol;
9953
    const char *name = NULL;
9954
    char * StorageVolPath;
9955

9956
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9957
        return false;
9958 9959

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9960
        return false;
9961
    }
9962

9963 9964 9965 9966 9967 9968 9969
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
9970
    virStorageVolFree(vol);
E
Eric Blake 已提交
9971
    return true;
9972 9973 9974
}


9975 9976 9977 9978
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
9979 9980
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
9981 9982
    {NULL, NULL}
};
9983

9984
static const vshCmdOptDef opts_secret_define[] = {
9985
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
9986 9987
    {NULL, 0, 0, NULL}
};
9988

E
Eric Blake 已提交
9989
static bool
9990 9991
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
9992
    const char *from = NULL;
9993
    char *buffer;
9994
    virSecretPtr res;
9995
    char uuid[VIR_UUID_STRING_BUFLEN];
9996

9997
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9998
        return false;
9999

10000
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10001
        return false;
10002 10003

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
10007
    VIR_FREE(buffer);
10008 10009

    if (res == NULL) {
10010
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
10011
        return false;
10012
    }
10013
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
10014
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
10015
        virSecretFree(res);
E
Eric Blake 已提交
10016
        return false;
10017 10018 10019
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
10020
    return true;
10021 10022 10023 10024 10025 10026
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
10027 10028
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
10029 10030 10031 10032
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
10033
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10034 10035 10036
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10037
static bool
10038 10039 10040
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
10041
    bool ret = false;
10042 10043
    char *xml;

10044
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10045
        return false;
10046 10047 10048

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
10049
        return false;
10050 10051 10052 10053

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
10054
    vshPrint(ctl, "%s", xml);
10055
    VIR_FREE(xml);
E
Eric Blake 已提交
10056
    ret = true;
10057 10058 10059 10060 10061 10062 10063 10064 10065 10066

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
10067 10068
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
10069 10070 10071 10072
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
10073 10074
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
10075 10076 10077
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10078
static bool
10079 10080 10081 10082
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
10083
    const char *base64 = NULL;
10084
    char *value;
E
Eric Blake 已提交
10085 10086
    int res;
    bool ret = false;
10087

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

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

10095
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
10096 10097 10098
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
10099
        vshError(ctl, "%s", _("Invalid base64 data"));
10100 10101 10102
        goto cleanup;
    }
    if (value == NULL) {
10103
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
10104
        return false;
10105 10106 10107 10108
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
10109
    VIR_FREE(value);
10110 10111

    if (res != 0) {
10112
        vshError(ctl, "%s", _("Failed to set secret value"));
10113 10114 10115
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
10116
    ret = true;
10117 10118 10119 10120 10121 10122 10123 10124 10125 10126

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
10127 10128
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
10129 10130 10131 10132
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
10133
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10134 10135 10136
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10137
static bool
10138 10139 10140 10141 10142 10143
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
10144
    bool ret = false;
10145

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

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
10151
        return false;
10152 10153 10154 10155 10156 10157 10158

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
10159
    VIR_FREE(value);
10160 10161

    if (base64 == NULL) {
10162
        vshError(ctl, "%s", _("Failed to allocate memory"));
10163 10164
        goto cleanup;
    }
10165
    vshPrint(ctl, "%s", base64);
10166
    memset(base64, 0, strlen(base64));
10167
    VIR_FREE(base64);
E
Eric Blake 已提交
10168
    ret = true;
10169 10170 10171 10172 10173 10174 10175 10176 10177 10178

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
10179 10180
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
10181 10182 10183 10184
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
10185
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10186 10187 10188
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10189
static bool
10190 10191 10192
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
10193
    bool ret = false;
10194
    const char *uuid;
10195

10196
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10197
        return false;
10198 10199 10200

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
10201
        return false;
10202 10203

    if (virSecretUndefine(secret) < 0) {
10204
        vshError(ctl, _("Failed to delete secret %s"), uuid);
10205 10206 10207
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
10208
    ret = true;
10209 10210 10211 10212 10213 10214 10215 10216 10217 10218

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
10219 10220
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
10221 10222 10223
    {NULL, NULL}
};

E
Eric Blake 已提交
10224
static bool
10225 10226 10227 10228 10229
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

10230
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10231
        return false;
10232 10233 10234

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
10235
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
10236
        return false;
10237 10238 10239 10240 10241
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
10242
        vshError(ctl, "%s", _("Failed to list secrets"));
10243
        VIR_FREE(uuids);
E
Eric Blake 已提交
10244
        return false;
10245 10246 10247 10248
    }

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

10249 10250
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
10251 10252

    for (i = 0; i < maxuuids; i++) {
10253 10254 10255 10256
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
10257
            VIR_FREE(uuids[i]);
10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275
            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);
10276
        VIR_FREE(uuids[i]);
10277
    }
10278
    VIR_FREE(uuids);
E
Eric Blake 已提交
10279
    return true;
10280
}
10281 10282 10283 10284 10285


/*
 * "version" command
 */
10286
static const vshCmdInfo info_version[] = {
10287 10288
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
10289 10290 10291
    {NULL, NULL}
};

10292 10293 10294 10295
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
10296

E
Eric Blake 已提交
10297
static bool
10298
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10299 10300 10301 10302 10303 10304
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
10305
    unsigned long daemonVersion;
10306 10307 10308 10309 10310
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

10311
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10312
        return false;
10313 10314 10315

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
10316
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
10317
        return false;
10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329
    }

    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) {
10330
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
10331
        return false;
10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348
    }
    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) {
10349
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
10350
        return false;
10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363
    }
    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);
    }
10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378

    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 已提交
10379
    return true;
10380 10381
}

10382 10383 10384 10385
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
10386
    {"help", N_("enumerate devices on this host")},
10387
    {"desc", ""},
10388 10389 10390 10391
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
10392 10393
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
10394 10395 10396
    {NULL, 0, 0, NULL}
};

10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414 10415 10416 10417 10418
#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] = '-';
10419 10420
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
10421 10422 10423
    }

    /* Print this device */
10424
    vshPrint(ctl, "%s", indentBuf);
10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447
    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) {
10448
        vshPrint(ctl, "%s", indentBuf);
10449
        vshPrint(ctl, " |\n");
10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471
    }

    /* 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) {
10472
        vshPrint(ctl, "%s", indentBuf);
10473 10474 10475 10476
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
10477
static bool
10478 10479
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
10480
    const char *cap = NULL;
10481
    char **devices;
10482
    int num_devices, i;
10483
    int tree = vshCommandOptBool(cmd, "tree");
10484

10485
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10486
        return false;
10487

10488
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
10489 10490 10491 10492
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
10493
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
10494
        return false;
10495
    } else if (num_devices == 0) {
E
Eric Blake 已提交
10496
        return true;
10497 10498 10499 10500 10501 10502
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
10503
        vshError(ctl, "%s", _("Failed to list node devices"));
10504
        VIR_FREE(devices);
E
Eric Blake 已提交
10505
        return false;
10506
    }
10507
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
10508 10509 10510 10511 10512 10513 10514
    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 已提交
10515
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534
            } 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++) {
10535 10536
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
10537
        }
10538
        VIR_FREE(parents);
10539 10540 10541
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
10542
            VIR_FREE(devices[i]);
10543
        }
10544
    }
10545
    VIR_FREE(devices);
E
Eric Blake 已提交
10546
    return true;
10547 10548 10549 10550 10551 10552
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
10553 10554
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
10555 10556 10557 10558 10559
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
10560
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10561 10562 10563
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10564
static bool
10565 10566
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
10567
    const char *name = NULL;
10568
    virNodeDevicePtr device;
L
Laine Stump 已提交
10569
    char *xml;
10570

10571
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10572
        return false;
10573
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10574
        return false;
10575
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10576
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10577
        return false;
10578 10579
    }

L
Laine Stump 已提交
10580 10581 10582
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
10583
        return false;
L
Laine Stump 已提交
10584 10585 10586
    }

    vshPrint(ctl, "%s\n", xml);
10587
    VIR_FREE(xml);
10588
    virNodeDeviceFree(device);
E
Eric Blake 已提交
10589
    return true;
10590 10591
}

10592 10593 10594 10595
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
10596 10597
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
10598 10599 10600 10601 10602
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
10603
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10604 10605 10606
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10607
static bool
10608 10609
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
10610
    const char *name = NULL;
10611
    virNodeDevicePtr device;
E
Eric Blake 已提交
10612
    bool ret = true;
10613

10614
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10615
        return false;
10616
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10617
        return false;
10618
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10619
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10620
        return false;
10621 10622 10623 10624 10625
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
10626
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
10627
        ret = false;
10628 10629 10630 10631 10632 10633 10634 10635 10636
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
10637 10638
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
10639 10640 10641 10642 10643
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
10644
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10645 10646 10647
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10648
static bool
10649 10650
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
10651
    const char *name = NULL;
10652
    virNodeDevicePtr device;
E
Eric Blake 已提交
10653
    bool ret = true;
10654

10655
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10656
        return false;
10657
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10658
        return false;
10659
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10660
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10661
        return false;
10662 10663 10664 10665 10666
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
10667
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
10668
        ret = false;
10669 10670 10671 10672 10673 10674 10675 10676 10677
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
10678 10679
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
10680 10681 10682 10683 10684
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
10685
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10686 10687 10688
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10689
static bool
10690 10691
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
10692
    const char *name = NULL;
10693
    virNodeDevicePtr device;
E
Eric Blake 已提交
10694
    bool ret = true;
10695

10696
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10697
        return false;
10698
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10699
        return false;
10700
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10701
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10702
        return false;
10703 10704 10705 10706 10707
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
10708
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
10709
        ret = false;
10710 10711 10712 10713 10714
    }
    virNodeDeviceFree(device);
    return ret;
}

10715
/*
E
Eric Blake 已提交
10716
 * "hostname" command
10717
 */
10718
static const vshCmdInfo info_hostname[] = {
10719
    {"help", N_("print the hypervisor hostname")},
10720
    {"desc", ""},
10721 10722 10723
    {NULL, NULL}
};

E
Eric Blake 已提交
10724
static bool
10725
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10726 10727 10728
{
    char *hostname;

10729
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10730
        return false;
10731 10732 10733

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
10734
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
10735
        return false;
10736 10737 10738
    }

    vshPrint (ctl, "%s\n", hostname);
10739
    VIR_FREE(hostname);
10740

E
Eric Blake 已提交
10741
    return true;
10742 10743 10744 10745 10746
}

/*
 * "uri" command
 */
10747
static const vshCmdInfo info_uri[] = {
10748
    {"help", N_("print the hypervisor canonical URI")},
10749
    {"desc", ""},
10750 10751 10752
    {NULL, NULL}
};

E
Eric Blake 已提交
10753
static bool
10754
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10755 10756 10757
{
    char *uri;

10758
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10759
        return false;
10760 10761 10762

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
10763
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
10764
        return false;
10765 10766 10767
    }

    vshPrint (ctl, "%s\n", uri);
10768
    VIR_FREE(uri);
10769

E
Eric Blake 已提交
10770
    return true;
10771 10772
}

E
Eric Blake 已提交
10773 10774 10775 10776 10777 10778 10779 10780 10781 10782
/*
 * "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 已提交
10783
static bool
E
Eric Blake 已提交
10784 10785 10786 10787 10788
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10789
        return false;
E
Eric Blake 已提交
10790 10791 10792 10793

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
10794
        return false;
E
Eric Blake 已提交
10795 10796 10797 10798 10799
    }

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

E
Eric Blake 已提交
10800
    return true;
E
Eric Blake 已提交
10801 10802
}

10803 10804 10805
/*
 * "vncdisplay" command
 */
10806
static const vshCmdInfo info_vncdisplay[] = {
10807 10808
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
10809 10810 10811
    {NULL, NULL}
};

10812
static const vshCmdOptDef opts_vncdisplay[] = {
10813
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10814 10815 10816
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10817
static bool
10818
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
10819 10820 10821 10822 10823
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10824
    bool ret = false;
10825 10826 10827
    int port = 0;
    char *doc;

10828
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10829
        return false;
10830

J
Jim Meyering 已提交
10831
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10832
        return false;
10833 10834 10835 10836 10837

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10838
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10839
    VIR_FREE(doc);
10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854
    if (!xml)
        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) ||
10855
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
10856 10857 10858 10859 10860 10861
        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 已提交
10862
    ret = true;
10863 10864 10865 10866

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10867
    xmlFreeDoc(xml);
10868 10869 10870 10871 10872 10873 10874
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
10875
static const vshCmdInfo info_ttyconsole[] = {
10876 10877
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
10878 10879 10880
    {NULL, NULL}
};

10881
static const vshCmdOptDef opts_ttyconsole[] = {
10882
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10883 10884 10885
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10886
static bool
10887
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
10888 10889 10890 10891 10892
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10893
    bool ret = false;
10894 10895
    char *doc;

10896
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10897
        return false;
10898

J
Jim Meyering 已提交
10899
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10900
        return false;
10901 10902 10903 10904 10905

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10906
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10907
    VIR_FREE(doc);
10908 10909 10910 10911 10912 10913 10914 10915 10916
    if (!xml)
        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 已提交
10917
    ret = true;
10918 10919 10920 10921

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10922
    xmlFreeDoc(xml);
10923 10924 10925 10926 10927 10928
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
10929
 */
10930
static const vshCmdInfo info_attach_device[] = {
10931 10932
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
10933 10934 10935
    {NULL, NULL}
};

10936
static const vshCmdOptDef opts_attach_device[] = {
10937 10938 10939
    {"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")},
10940 10941 10942
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10943
static bool
10944
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
10945 10946
{
    virDomainPtr dom;
10947
    const char *from = NULL;
10948
    char *buffer;
W
Wen Congyang 已提交
10949
    int ret;
J
Jim Fehlig 已提交
10950
    unsigned int flags;
10951

10952
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10953
        return false;
10954

J
Jim Meyering 已提交
10955
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10956
        return false;
10957

10958
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10959
        virDomainFree(dom);
E
Eric Blake 已提交
10960
        return false;
10961 10962
    }

10963
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10964
        virshReportError(ctl);
10965
        virDomainFree(dom);
E
Eric Blake 已提交
10966
        return false;
10967
    }
10968

J
Jim Fehlig 已提交
10969
    if (vshCommandOptBool(cmd, "persistent")) {
10970
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10971
        if (virDomainIsActive(dom) == 1)
10972
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10973 10974 10975 10976
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
10977
    VIR_FREE(buffer);
10978 10979

    if (ret < 0) {
10980
        vshError(ctl, _("Failed to attach device from %s"), from);
10981
        virDomainFree(dom);
E
Eric Blake 已提交
10982
        return false;
10983
    } else {
J
Jim Meyering 已提交
10984
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
10985 10986 10987
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10988
    return true;
10989 10990 10991 10992 10993 10994
}


/*
 * "detach-device" command
 */
10995
static const vshCmdInfo info_detach_device[] = {
10996 10997
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
10998 10999 11000
    {NULL, NULL}
};

11001
static const vshCmdOptDef opts_detach_device[] = {
11002 11003 11004
    {"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")},
11005 11006 11007
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11008
static bool
11009
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
11010 11011
{
    virDomainPtr dom;
11012
    const char *from = NULL;
11013
    char *buffer;
W
Wen Congyang 已提交
11014
    int ret;
J
Jim Fehlig 已提交
11015
    unsigned int flags;
11016

11017
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11018
        return false;
11019

J
Jim Meyering 已提交
11020
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
11021
        return false;
11022

11023
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11024
        virDomainFree(dom);
E
Eric Blake 已提交
11025
        return false;
11026 11027
    }

11028
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11029
        virshReportError(ctl);
11030
        virDomainFree(dom);
E
Eric Blake 已提交
11031
        return false;
11032
    }
11033

J
Jim Fehlig 已提交
11034
    if (vshCommandOptBool(cmd, "persistent")) {
11035
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11036
        if (virDomainIsActive(dom) == 1)
11037
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11038 11039 11040 11041
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
11042
    VIR_FREE(buffer);
11043 11044

    if (ret < 0) {
11045
        vshError(ctl, _("Failed to detach device from %s"), from);
11046
        virDomainFree(dom);
E
Eric Blake 已提交
11047
        return false;
11048
    } else {
J
Jim Meyering 已提交
11049
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
11050 11051 11052
    }

    virDomainFree(dom);
E
Eric Blake 已提交
11053
    return true;
11054 11055
}

11056

11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069
/*
 * "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")},
11070
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
11071 11072 11073
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11074
static bool
11075 11076 11077
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
11078
    const char *from = NULL;
11079
    char *buffer;
W
Wen Congyang 已提交
11080
    int ret;
11081 11082
    unsigned int flags;

11083
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11084
        return false;
11085 11086

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

11089
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11090
        virDomainFree(dom);
E
Eric Blake 已提交
11091
        return false;
11092 11093 11094
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11095
        virshReportError(ctl);
11096
        virDomainFree(dom);
E
Eric Blake 已提交
11097
        return false;
11098 11099 11100
    }

    if (vshCommandOptBool(cmd, "persistent")) {
11101
        flags = VIR_DOMAIN_AFFECT_CONFIG;
11102
        if (virDomainIsActive(dom) == 1)
11103
           flags |= VIR_DOMAIN_AFFECT_LIVE;
11104
    } else {
11105
        flags = VIR_DOMAIN_AFFECT_LIVE;
11106
    }
11107 11108 11109 11110

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

11111 11112 11113 11114 11115 11116
    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 已提交
11117
        return false;
11118 11119 11120 11121 11122
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
11123
    return true;
11124 11125 11126
}


11127 11128 11129
/*
 * "attach-interface" command
 */
11130
static const vshCmdInfo info_attach_interface[] = {
11131 11132
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
11133 11134 11135
    {NULL, NULL}
};

11136
static const vshCmdOptDef opts_attach_interface[] = {
11137 11138 11139 11140 11141 11142
    {"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")},
11143
    {"model", VSH_OT_DATA, 0, N_("model type")},
11144
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
11145 11146 11147
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11148
static bool
11149
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
11150 11151
{
    virDomainPtr dom = NULL;
11152 11153
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
11154
    int typ;
W
Wen Congyang 已提交
11155 11156
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11157
    unsigned int flags;
11158 11159
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
11160

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

J
Jim Meyering 已提交
11164
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11165 11166
        goto cleanup;

11167
    if (vshCommandOptString(cmd, "type", &type) <= 0)
11168 11169
        goto cleanup;

11170 11171 11172 11173
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
11174 11175
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
11176
        goto cleanup;
11177
    }
11178 11179

    /* check interface type */
11180
    if (STREQ(type, "network")) {
11181
        typ = 1;
11182
    } else if (STREQ(type, "bridge")) {
11183 11184
        typ = 2;
    } else {
E
Eric Blake 已提交
11185 11186
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
11187 11188 11189 11190
        goto cleanup;
    }

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

11193
    if (typ == 1)
11194
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
11195
    else if (typ == 2)
11196
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
11197

11198
    if (target != NULL)
11199
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11200
    if (mac != NULL)
11201
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
11202
    if (script != NULL)
11203
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
11204
    if (model != NULL)
11205
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
11206

11207
    virBufferAddLit(&buf, "</interface>\n");
11208

11209 11210
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
11211
        goto cleanup;
11212 11213
    }

11214
    xml = virBufferContentAndReset(&buf);
11215

J
Jim Fehlig 已提交
11216
    if (vshCommandOptBool(cmd, "persistent")) {
11217
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11218
        if (virDomainIsActive(dom) == 1)
11219
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11220
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
11221
    } else {
11222
        ret = virDomainAttachDevice(dom, xml);
11223
    }
11224

11225 11226
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11227
    if (ret != 0) {
L
Laine Stump 已提交
11228
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
11229 11230
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
11231
        functionReturn = true;
J
Jim Fehlig 已提交
11232
    }
11233 11234 11235 11236

 cleanup:
    if (dom)
        virDomainFree(dom);
11237
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11238
    return functionReturn;
11239 11240 11241 11242 11243
}

/*
 * "detach-interface" command
 */
11244
static const vshCmdInfo info_detach_interface[] = {
11245 11246
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
11247 11248 11249
    {NULL, NULL}
};

11250
static const vshCmdOptDef opts_detach_interface[] = {
11251 11252 11253 11254
    {"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")},
11255 11256 11257
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11258
static bool
11259
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
11260 11261 11262 11263 11264 11265 11266
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
11267
    const char *mac =NULL, *type = NULL;
11268
    char *doc;
11269
    char buf[64];
E
Eric Blake 已提交
11270
    int i = 0, diff_mac;
W
Wen Congyang 已提交
11271 11272
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
11273
    unsigned int flags;
11274

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

J
Jim Meyering 已提交
11278
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11279 11280
        goto cleanup;

11281
    if (vshCommandOptString(cmd, "type", &type) <= 0)
11282 11283
        goto cleanup;

11284 11285
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
11286
        goto cleanup;
11287
    }
11288 11289 11290 11291 11292

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11293
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
11294
    VIR_FREE(doc);
11295
    if (!xml) {
11296
        vshError(ctl, "%s", _("Failed to get interface information"));
11297 11298 11299
        goto cleanup;
    }

E
Eric Blake 已提交
11300
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
11301 11302 11303
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11304
        vshError(ctl, _("No found interface whose type is %s"), type);
11305 11306 11307
        goto cleanup;
    }

11308 11309 11310 11311 11312 11313
    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;
    }

11314 11315 11316 11317 11318 11319 11320
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11321 11322 11323 11324 11325
            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);
11326 11327 11328 11329 11330 11331 11332
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11333
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
11334 11335 11336 11337 11338
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11339
        vshError(ctl, "%s", _("Failed to allocate memory"));
11340 11341 11342
        goto cleanup;
    }

11343
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
11344
        vshError(ctl, "%s", _("Failed to create XML"));
11345 11346 11347
        goto cleanup;
    }

J
Jim Fehlig 已提交
11348
    if (vshCommandOptBool(cmd, "persistent")) {
11349
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11350
        if (virDomainIsActive(dom) == 1)
11351
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11352 11353 11354 11355 11356 11357 11358 11359
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11360
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
11361
    } else {
J
Jim Meyering 已提交
11362
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
11363
        functionReturn = true;
11364
    }
11365 11366 11367 11368

 cleanup:
    if (dom)
        virDomainFree(dom);
11369
    xmlXPathFreeObject(obj);
11370
    xmlXPathFreeContext(ctxt);
11371 11372
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
11373
    return functionReturn;
11374 11375 11376 11377 11378
}

/*
 * "attach-disk" command
 */
11379
static const vshCmdInfo info_attach_disk[] = {
11380 11381
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
11382 11383 11384
    {NULL, NULL}
};

11385
static const vshCmdOptDef opts_attach_disk[] = {
11386 11387 11388 11389 11390
    {"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")},
11391
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
11392 11393 11394
    {"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")},
11395
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
11396 11397 11398
    {"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")},
11399 11400 11401
    {NULL, 0, 0, NULL}
};

11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548
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 已提交
11549
static bool
11550
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
11551 11552
{
    virDomainPtr dom = NULL;
11553
    const char *source = NULL, *target = NULL, *driver = NULL,
11554 11555 11556
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
11557 11558
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
11559
    unsigned int flags;
11560
    const char *stype = NULL;
11561 11562
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
11563

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

J
Jim Meyering 已提交
11567
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11568 11569
        goto cleanup;

11570
    if (vshCommandOptString(cmd, "source", &source) <= 0)
11571 11572
        goto cleanup;

11573
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11574 11575
        goto cleanup;

11576 11577 11578 11579
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
11580 11581 11582
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
11583
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
11584
        vshError(ctl, "%s", _("missing option"));
11585 11586
        goto cleanup;
    }
11587

11588 11589
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
11590
            isFile = true;
11591
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
11592
        isFile = true;
11593 11594 11595
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
11596 11597 11598
    }

    if (mode) {
11599
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
11600 11601
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
11602 11603 11604 11605 11606
            goto cleanup;
        }
    }

    /* Make XML of disk */
11607
    virBufferAsprintf(&buf, "<disk type='%s'",
11608 11609
                      (isFile) ? "file" : "block");
    if (type)
11610
        virBufferAsprintf(&buf, " device='%s'", type);
11611 11612
    virBufferAddLit(&buf, ">\n");

11613
    if (driver || subdriver)
11614
        virBufferAsprintf(&buf, "  <driver");
11615 11616

    if (driver)
11617
        virBufferAsprintf(&buf, " name='%s'", driver);
11618
    if (subdriver)
11619
        virBufferAsprintf(&buf, " type='%s'", subdriver);
11620 11621
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
11622

11623
    if (driver || subdriver || cache)
11624
        virBufferAddLit(&buf, "/>\n");
11625

11626
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
11627 11628
                      (isFile) ? "file" : "dev",
                      source);
11629
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11630
    if (mode)
11631
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
11632

11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680
    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;
            }
        }
    }

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

11683 11684
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
11685
        return false;
11686 11687
    }

11688
    xml = virBufferContentAndReset(&buf);
11689

J
Jim Fehlig 已提交
11690
    if (vshCommandOptBool(cmd, "persistent")) {
11691
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11692
        if (virDomainIsActive(dom) == 1)
11693
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11694
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
11695
    } else {
11696
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
11697
    }
11698

11699 11700
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11701
    if (ret != 0) {
L
Laine Stump 已提交
11702
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
11703 11704
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
11705
        functionReturn = true;
J
Jim Fehlig 已提交
11706
    }
11707 11708 11709 11710

 cleanup:
    if (dom)
        virDomainFree(dom);
11711
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11712
    return functionReturn;
11713 11714 11715 11716 11717
}

/*
 * "detach-disk" command
 */
11718
static const vshCmdInfo info_detach_disk[] = {
11719 11720
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
11721 11722 11723
    {NULL, NULL}
};

11724
static const vshCmdOptDef opts_detach_disk[] = {
11725 11726 11727
    {"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")},
11728 11729 11730
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11731
static bool
11732
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
11733 11734 11735 11736 11737 11738 11739
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
11740
    const char *target = NULL;
11741
    char *doc;
E
Eric Blake 已提交
11742
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
11743 11744
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11745
    unsigned int flags;
11746

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

J
Jim Meyering 已提交
11750
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11751 11752
        goto cleanup;

11753
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11754 11755 11756 11757 11758 11759
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11760
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
11761
    VIR_FREE(doc);
11762
    if (!xml) {
11763
        vshError(ctl, "%s", _("Failed to get disk information"));
11764 11765 11766 11767 11768 11769
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11770
        vshError(ctl, "%s", _("Failed to get disk information"));
11771 11772 11773 11774 11775 11776 11777
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11778 11779 11780 11781 11782
            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);
11783 11784 11785 11786 11787 11788 11789
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11790
    vshError(ctl, _("No found disk whose target is %s"), target);
11791 11792 11793 11794 11795
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11796
        vshError(ctl, "%s", _("Failed to allocate memory"));
11797 11798 11799
        goto cleanup;
    }

11800
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
11801
        vshError(ctl, "%s", _("Failed to create XML"));
11802 11803 11804
        goto cleanup;
    }

J
Jim Fehlig 已提交
11805
    if (vshCommandOptBool(cmd, "persistent")) {
11806
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11807
        if (virDomainIsActive(dom) == 1)
11808
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11809 11810 11811 11812 11813 11814 11815 11816
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11817
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
11818
    } else {
J
Jim Meyering 已提交
11819
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
11820
        functionReturn = true;
11821
    }
11822 11823

 cleanup:
11824
    xmlXPathFreeObject(obj);
11825
    xmlXPathFreeContext(ctxt);
11826 11827
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
11828 11829
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
11830
    return functionReturn;
11831 11832
}

11833 11834 11835 11836
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
11837 11838
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
11839 11840 11841 11842
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
11843
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
11844 11845 11846
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11847
static bool
11848 11849
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
11850
    const char *from = NULL;
E
Eric Blake 已提交
11851
    bool ret = true;
11852 11853 11854
    char *buffer;
    int result;

11855
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11856
        return false;
11857

11858
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11859
        return false;
11860 11861

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
11865
    VIR_FREE(buffer);
11866 11867 11868 11869 11870

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
11871
        ret = false;
11872 11873 11874 11875 11876
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
11877
        ret = true;
11878 11879 11880 11881 11882
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
11883
        ret = true;
11884 11885 11886 11887 11888
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
11889
        ret = false;
11890 11891 11892 11893 11894
    }

    return ret;
}

11895 11896 11897 11898
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
11899 11900
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
11901 11902 11903 11904
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
11905
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
11906 11907 11908
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11909
static bool
11910 11911
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
11912
    const char *from = NULL;
E
Eric Blake 已提交
11913
    bool ret = true;
11914 11915 11916 11917 11918
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
11919
    xmlNodePtr node_list;
11920 11921 11922 11923 11924 11925
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

11926
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11927
        return false;
11928

11929
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11930
        return false;
11931 11932

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
11933
        return false;
11934 11935 11936 11937 11938

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

L
Laine Stump 已提交
11939 11940
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
11941 11942
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
11943
        ret = false;
11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979
        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 已提交
11980
        ret = false;
11981 11982 11983 11984 11985 11986 11987 11988
        goto cleanup;
    }

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

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
11989
        ret = false;
11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006

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 已提交
12007
    ret = false;
12008
    goto cleanup;
12009 12010
}

12011 12012 12013 12014 12015 12016 12017 12018
/* 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;

12019
    ret = vshMalloc(ctl, PATH_MAX);
12020 12021 12022

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
12023 12024
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
12025
    if (fd == -1) {
12026
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
12027
                 strerror(errno));
12028
        VIR_FREE(ret);
12029 12030 12031 12032
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
12033 12034
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
12035
        VIR_FORCE_CLOSE(fd);
12036
        unlink (ret);
12037
        VIR_FREE(ret);
12038 12039
        return NULL;
    }
S
Stefan Berger 已提交
12040
    if (VIR_CLOSE(fd) < 0) {
12041 12042
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
12043
        unlink (ret);
12044
        VIR_FREE(ret);
12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059
        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 已提交
12060 12061 12062 12063
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
12064

12065
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
12066 12067 12068 12069
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
12070

12071 12072 12073 12074 12075
    /* 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 已提交
12076 12077
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
12078
     */
E
Eric Blake 已提交
12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090
    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);
12091 12092
    }

E
Eric Blake 已提交
12093 12094 12095 12096 12097 12098 12099
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
12100
    }
E
Eric Blake 已提交
12101
    ret = 0;
12102

E
Eric Blake 已提交
12103 12104 12105
cleanup:
    virCommandFree(cmd);
    return ret;
12106 12107 12108 12109 12110 12111 12112 12113
}

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

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
12114
        vshError(ctl,
12115
                 _("%s: failed to read temporary file: %s"),
12116
                 filename, strerror(errno));
12117 12118 12119 12120 12121
        return NULL;
    }
    return ret;
}

12122

P
Paolo Bonzini 已提交
12123 12124 12125 12126
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
12127 12128
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
12129 12130 12131 12132
    {NULL, NULL}
};

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

E
Eric Blake 已提交
12137
static bool
12138
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
12139
{
12140
    const char *dir = NULL;
12141
    char *dir_malloced = NULL;
E
Eric Blake 已提交
12142
    bool ret = true;
P
Paolo Bonzini 已提交
12143 12144

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

12149
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
12150
        uid_t uid = geteuid();
12151
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
12152 12153 12154 12155
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
12156
    if (chdir(dir) == -1) {
12157
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
12158
        ret = false;
P
Paolo Bonzini 已提交
12159 12160
    }

12161
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
12162
    return ret;
P
Paolo Bonzini 已提交
12163 12164 12165 12166 12167 12168
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
12169 12170
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
12171 12172 12173
    {NULL, NULL}
};

E
Eric Blake 已提交
12174
static bool
P
Paolo Bonzini 已提交
12175 12176 12177
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
12178
    bool ret = true;
P
Paolo Bonzini 已提交
12179

12180 12181
    cwd = getcwd(NULL, 0);
    if (!cwd) {
12182 12183
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
12184 12185
        ret = false;
    } else {
P
Paolo Bonzini 已提交
12186
        vshPrint (ctl, _("%s\n"), cwd);
12187 12188
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
12189

12190
    return ret;
P
Paolo Bonzini 已提交
12191 12192
}

E
Eric Blake 已提交
12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204
/*
 * "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")},
12205
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
12206 12207 12208 12209 12210 12211
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
12212
static bool
E
Eric Blake 已提交
12213 12214 12215 12216 12217
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
12218
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
12219 12220 12221 12222 12223 12224 12225 12226
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

12227
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
12228 12229 12230
        bool close_quote = false;
        char *q;

12231
        arg = opt->data;
E
Eric Blake 已提交
12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259
        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 已提交
12260
        return false;
E
Eric Blake 已提交
12261 12262 12263 12264 12265
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
12266
    return true;
E
Eric Blake 已提交
12267 12268
}

12269 12270 12271 12272
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
12273 12274
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
12275 12276 12277 12278
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
12279
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12280 12281 12282 12283 12284 12285
    {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 已提交
12286
static bool
12287 12288
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
12289
    bool ret = false;
12290 12291 12292 12293 12294
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
12295
    unsigned int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
12296

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

J
Jim Meyering 已提交
12300
    dom = vshCommandOptDomain (ctl, cmd, NULL);
12301 12302 12303 12304
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
12305
    doc = virDomainGetXMLDesc (dom, flags);
12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323
    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 已提交
12324
        ret = true;
12325 12326 12327 12328 12329 12330 12331
        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.
     */
12332
    doc_reread = virDomainGetXMLDesc (dom, flags);
12333 12334 12335 12336
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
12337 12338
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350
        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 已提交
12351
    ret = true;
12352 12353 12354 12355 12356

 cleanup:
    if (dom)
        virDomainFree (dom);

12357 12358 12359
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
12360 12361 12362

    if (tmp) {
        unlink (tmp);
12363
        VIR_FREE(tmp);
12364 12365 12366 12367 12368
    }

    return ret;
}

12369

12370 12371 12372 12373
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
12374 12375
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
12376 12377 12378 12379
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
12380
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
12381 12382 12383 12384 12385 12386 12387 12388 12389 12390
    {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[] = {
12391 12392
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
12393 12394 12395 12396
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
12397
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
12398 12399 12400 12401 12402 12403
    {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 已提交
12404 12405 12406
/*
 * "quit" command
 */
12407
static const vshCmdInfo info_quit[] = {
12408
    {"help", N_("quit this interactive terminal")},
12409
    {"desc", ""},
12410
    {NULL, NULL}
K
Karel Zak 已提交
12411 12412
};

E
Eric Blake 已提交
12413
static bool
12414
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
12415
{
E
Eric Blake 已提交
12416 12417
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
12418 12419
}

12420 12421 12422 12423 12424 12425 12426
/* Helper for snapshot-create and snapshot-create-as */
static bool
vshSnapshotCreate(vshControl *ctl, virDomainPtr dom, const char *buffer,
                  unsigned int flags, const char *from)
{
    bool ret = false;
    virDomainSnapshotPtr snapshot;
12427
    bool halt = false;
12428 12429 12430 12431 12432 12433
    char *doc = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *name = NULL;

    snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457

    /* Emulate --halt on older servers.  */
    if (!snapshot && last_error->code == VIR_ERR_INVALID_ARG &&
        (flags & VIR_DOMAIN_SNAPSHOT_CREATE_HALT)) {
        int persistent;

        virFreeError(last_error);
        last_error = NULL;
        persistent = virDomainIsPersistent(dom);
        if (persistent < 0) {
            virshReportError(ctl);
            goto cleanup;
        }
        if (!persistent) {
            vshError(ctl, "%s",
                     _("cannot halt after snapshot of transient domain"));
            goto cleanup;
        }
        if (virDomainIsActive(dom) == 1)
            halt = true;
        flags &= ~VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
        snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
    }

12458 12459 12460
    if (snapshot == NULL)
        goto cleanup;

12461 12462 12463 12464 12465
    if (halt && virDomainDestroy(dom) < 0) {
        virshReportError(ctl);
        goto cleanup;
    }

12466 12467 12468 12469
    if (flags & VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA)
        doc = vshStrdup(ctl, buffer);
    else
        doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500
    if (!doc)
        goto cleanup;

    xml = virXMLParseStringCtxt(doc, "domainsnapshot.xml", &ctxt);
    if (!xml)
        goto cleanup;

    name = virXPathString("string(/domainsnapshot/name)", ctxt);
    if (!name) {
        vshError(ctl, "%s",
                 _("Could not find 'name' element in domain snapshot XML"));
        goto cleanup;
    }

    if (from)
        vshPrint(ctl, _("Domain snapshot %s created from '%s'"), name, from);
    else
        vshPrint(ctl, _("Domain snapshot %s created"), name);

    ret = true;

cleanup:
    VIR_FREE(name);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    return ret;
}

12501 12502 12503 12504
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
12505 12506
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
12507 12508 12509 12510 12511 12512
    {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")},
12513 12514 12515
    {"redefine", VSH_OT_BOOL, 0, N_("redefine metadata for existing snapshot")},
    {"current", VSH_OT_BOOL, 0, N_("with redefine, set current snapshot")},
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
12516
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
12517
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
12518 12519 12520
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12521
static bool
12522 12523 12524
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12525
    bool ret = false;
12526
    const char *from = NULL;
12527
    char *buffer = NULL;
12528 12529 12530 12531 12532 12533 12534 12535
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "redefine"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE;
    if (vshCommandOptBool(cmd, "current"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT;
    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
12536 12537
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
12538 12539
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
12540

12541
    if (!vshConnectionUsability(ctl, ctl->conn))
12542 12543 12544 12545 12546 12547
        goto cleanup;

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

12548
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
12549
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562 12563 12564
    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;
    }

12565
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, from);
12566 12567 12568 12569 12570 12571 12572 12573 12574

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

    return ret;
}

12575 12576 12577
/*
 * "snapshot-create-as" command
 */
12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 12617 12618 12619 12620 12621 12622 12623 12624 12625 12626 12627 12628 12629 12630 12631 12632 12633
static int
vshParseSnapshotDiskspec(vshControl *ctl, virBufferPtr buf, const char *str)
{
    int ret = -1;
    char *name = NULL;
    char *snapshot = NULL;
    char *driver = NULL;
    char *file = NULL;
    char *spec = vshStrdup(ctl, str);
    char *tmp = spec;
    size_t len = strlen(str);

    if (*str == ',')
        goto cleanup;
    name = tmp;
    while ((tmp = strchr(tmp, ','))) {
        if (tmp[1] == ',') {
            /* Recognize ,, as an escape for a literal comma */
            memmove(&tmp[1], &tmp[2], len - (tmp - spec) + 2);
            len--;
            tmp++;
            continue;
        }
        /* Terminate previous string, look for next recognized one */
        *tmp++ = '\0';
        if (!snapshot && STRPREFIX(tmp, "snapshot="))
            snapshot = tmp + strlen("snapshot=");
        else if (!driver && STRPREFIX(tmp, "driver="))
            driver = tmp + strlen("driver=");
        else if (!file && STRPREFIX(tmp, "file="))
            file = tmp + strlen("file=");
        else
            goto cleanup;
    }

    virBufferEscapeString(buf, "    <disk name='%s'", name);
    if (snapshot)
        virBufferAsprintf(buf, " snapshot='%s'", snapshot);
    if (driver || file) {
        virBufferAddLit(buf, ">\n");
        if (driver)
            virBufferAsprintf(buf, "      <driver type='%s'/>\n", driver);
        if (file)
            virBufferEscapeString(buf, "      <source file='%s'/>\n", file);
        virBufferAddLit(buf, "    </disk>\n");
    } else {
        virBufferAddLit(buf, "/>\n");
    }
    ret = 0;
cleanup:
    if (ret < 0)
        vshError(ctl, _("unable to parse diskspec: %s"), str);
    VIR_FREE(spec);
    return ret;
}

12634 12635 12636 12637 12638 12639 12640 12641 12642 12643
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 已提交
12644
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
12645
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
12646
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
12647 12648 12649
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
    {"diskspec", VSH_OT_ARGV, 0,
     N_("disk attributes: disk[,snapshot=type][,driver=type][,file=name]")},
12650 12651 12652 12653 12654 12655 12656 12657 12658 12659 12660 12661
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    char *buffer = NULL;
    const char *name = NULL;
    const char *desc = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
12662
    unsigned int flags = 0;
12663
    const vshCmdOpt *opt = NULL;
12664 12665 12666

    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
12667 12668
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
12669 12670
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686

    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)
12687
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
12688
    if (desc)
12689
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
12690 12691 12692 12693 12694 12695 12696 12697 12698 12699
    if (vshCommandOptBool(cmd, "diskspec")) {
        virBufferAddLit(&buf, "  <disks>\n");
        while ((opt = vshCommandOptArgv(cmd, opt))) {
            if (vshParseSnapshotDiskspec(ctl, &buf, opt->data) < 0) {
                virBufferFreeAndReset(&buf);
                goto cleanup;
            }
        }
        virBufferAddLit(&buf, "  </disks>\n");
    }
12700 12701 12702 12703 12704 12705 12706 12707
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
12708 12709 12710 12711 12712 12713
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

12714
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, NULL);
12715 12716 12717 12718 12719 12720 12721 12722 12723

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

    return ret;
}

12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824
/*
 * "snapshot-edit" command
 */
static const vshCmdInfo info_snapshot_edit[] = {
    {"help", N_("edit XML for a snapshot")},
    {"desc", N_("Edit the domain snapshot XML for a named snapshot")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_edit[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("also set edited snapshot as current")},
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotEdit(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    const char *name;
    bool ret = false;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    unsigned int getxml_flags = VIR_DOMAIN_XML_SECURE;
    unsigned int define_flags = VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE;

    if (vshCommandOptBool(cmd, "current"))
        define_flags |= VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT;

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

    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
        goto cleanup;

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

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

    /* Get the XML configuration of the snapshot.  */
    doc = virDomainSnapshotGetXMLDesc(snapshot, getxml_flags);
    if (!doc)
        goto cleanup;
    virDomainSnapshotFree(snapshot);
    snapshot = NULL;

    /* 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.  Short-circuit if it did not
     * change, and we do not have any flags.  */
    if (STREQ(doc, doc_edited) &&
        !(define_flags & VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT)) {
        vshPrint(ctl, _("Snapshot %s XML configuration not changed.\n"),
                 name);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
    snapshot = virDomainSnapshotCreateXML(dom, doc_edited, define_flags);
    if (!snapshot) {
        vshError(ctl, _("Failed to update %s"), name);
        goto cleanup;
    }

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

cleanup:
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);
    return ret;
}

12825 12826 12827 12828
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
12829 12830
    {"help", N_("Get or set the current snapshot")},
    {"desc", N_("Get or set the current snapshot")},
12831 12832 12833 12834 12835
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12836
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
12837 12838
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
12839 12840
    {"snapshotname", VSH_OT_DATA, 0,
     N_("name of existing snapshot to make current")},
12841 12842 12843
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12844
static bool
12845 12846 12847
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12848
    bool ret = false;
12849 12850
    int current;
    virDomainSnapshotPtr snapshot = NULL;
12851
    char *xml = NULL;
12852
    const char *snapshotname = NULL;
12853 12854 12855 12856
    unsigned int flags = 0;

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

12858
    if (!vshConnectionUsability(ctl, ctl->conn))
12859 12860 12861 12862 12863 12864
        goto cleanup;

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

12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893
    if (vshCommandOptString(cmd, "snapshotname", &snapshotname) < 0) {
        vshError(ctl, _("invalid snapshotname argument '%s'"), snapshotname);
        goto cleanup;
    }
    if (snapshotname) {
        virDomainSnapshotPtr snapshot2 = NULL;
        flags = (VIR_DOMAIN_SNAPSHOT_CREATE_REDEFINE |
                 VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT);

        if (vshCommandOptBool(cmd, "name")) {
            vshError(ctl, "%s",
                     _("--name and snapshotname are mutually exclusive"));
            goto cleanup;
        }
        snapshot = virDomainSnapshotLookupByName(dom, snapshotname, 0);
        if (snapshot == NULL)
            goto cleanup;
        xml = virDomainSnapshotGetXMLDesc(snapshot, VIR_DOMAIN_XML_SECURE);
        if (!xml)
            goto cleanup;
        snapshot2 = virDomainSnapshotCreateXML(dom, xml, flags);
        if (snapshot2 == NULL)
            goto cleanup;
        virDomainSnapshotFree(snapshot2);
        vshPrint(ctl, _("Snapshot %s set as current"), snapshotname);
        ret = true;
        goto cleanup;
    }

12894 12895 12896 12897
    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
12898
        char *name = NULL;
12899 12900 12901 12902

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

12903
        xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
12904 12905 12906
        if (!xml)
            goto cleanup;

12907 12908 12909 12910
        if (vshCommandOptBool(cmd, "name")) {
            xmlDocPtr xmldoc = NULL;
            xmlXPathContextPtr ctxt = NULL;

12911
            xmldoc = virXMLParseStringCtxt(xml, "domainsnapshot.xml", &ctxt);
12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923
            if (!xmldoc)
                goto cleanup;

            name = virXPathString("string(/domainsnapshot/name)", ctxt);
            xmlXPathFreeContext(ctxt);
            xmlFreeDoc(xmldoc);
            if (!name)
                goto cleanup;
        }

        vshPrint(ctl, "%s", name ? name : xml);
        VIR_FREE(name);
12924 12925
    }

E
Eric Blake 已提交
12926
    ret = true;
12927 12928

cleanup:
12929
    VIR_FREE(xml);
12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948
    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")},
12949
    {"parent", VSH_OT_BOOL, 0, N_("add a column showing parent snapshot")},
12950 12951 12952
    {"roots", VSH_OT_BOOL, 0, N_("list only snapshots without parents")},
    {"metadata", VSH_OT_BOOL, 0,
     N_("list only snapshots that have metadata that would prevent undefine")},
12953 12954 12955
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12956
static bool
12957 12958 12959
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12960
    bool ret = false;
12961
    unsigned int flags = 0;
12962 12963
    int parent_filter = 0; /* -1 for roots filtering, 0 for no parent
                              information needed, 1 for parent column */
12964 12965
    int numsnaps;
    char **names = NULL;
12966
    int actual = 0;
12967 12968 12969 12970 12971 12972
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
12973
    char *parent = NULL;
12974 12975
    long long creation_longlong;
    time_t creation_time_t;
12976 12977 12978
    char timestr[100];
    struct tm time_info;

12979
    if (vshCommandOptBool(cmd, "parent")) {
12980 12981 12982 12983 12984
        if (vshCommandOptBool(cmd, "roots")) {
            vshError(ctl, "%s",
                     _("--parent and --roots are mutually exlusive"));
            return false;
        }
12985
        parent_filter = 1;
12986 12987 12988 12989 12990 12991
    } else if (vshCommandOptBool(cmd, "roots")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
    }

    if (vshCommandOptBool(cmd, "metadata")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_METADATA;
12992 12993
    }

12994
    if (!vshConnectionUsability(ctl, ctl->conn))
12995 12996 12997 12998 12999 13000
        goto cleanup;

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

13001
    numsnaps = virDomainSnapshotNum(dom, flags);
13002

13003 13004 13005 13006 13007 13008 13009 13010 13011 13012
    /* Fall back to simulation if --roots was unsupported.  */
    if (numsnaps < 0 && last_error->code == VIR_ERR_INVALID_ARG &&
        (flags & VIR_DOMAIN_SNAPSHOT_LIST_ROOTS)) {
        virFreeError(last_error);
        last_error = NULL;
        parent_filter = -1;
        flags &= ~VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
        numsnaps = virDomainSnapshotNum(dom, flags);
    }

13013 13014 13015
    if (numsnaps < 0)
        goto cleanup;

13016 13017 13018 13019 13020 13021 13022 13023
    if (parent_filter > 0)
        vshPrintExtra(ctl, " %-20s %-25s %-15s %s",
                      _("Name"), _("Creation Time"), _("State"), _("Parent"));
    else
        vshPrintExtra(ctl, " %-20s %-25s %s",
                      _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "\n\
------------------------------------------------------------\n");
13024 13025 13026 13027 13028

    if (numsnaps) {
        if (VIR_ALLOC_N(names, numsnaps) < 0)
            goto cleanup;

13029
        actual = virDomainSnapshotListNames(dom, names, numsnaps, flags);
13030 13031 13032 13033 13034 13035 13036
        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 */
13037
            VIR_FREE(parent);
13038 13039 13040 13041
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
13042
            xmlFreeDoc(xml);
13043 13044 13045 13046 13047 13048 13049 13050 13051 13052
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

13053
            xml = virXMLParseStringCtxt(doc, "domainsnapshot.xml", &ctxt);
13054 13055 13056
            if (!xml)
                continue;

13057 13058 13059
            if (parent_filter) {
                parent = virXPathString("string(/domainsnapshot/parent/name)",
                                        ctxt);
13060 13061
                if (!parent && parent_filter < 0)
                    continue;
13062 13063
            }

13064 13065 13066
            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
13067 13068
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
13069
                continue;
13070 13071 13072 13073 13074 13075
            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);
13076 13077
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z",
                     &time_info);
13078

13079 13080 13081 13082 13083
            if (parent)
                vshPrint(ctl, " %-20s %-25s %-15s %s\n",
                         names[i], timestr, state, parent);
            else
                vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
13084 13085 13086
        }
    }

E
Eric Blake 已提交
13087
    ret = true;
13088 13089 13090

cleanup:
    /* this frees up memory from the last iteration of the loop */
13091
    VIR_FREE(parent);
13092 13093 13094 13095
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    xmlXPathFreeContext(ctxt);
13096
    xmlFreeDoc(xml);
13097
    VIR_FREE(doc);
13098 13099
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 13110 13111 13112 13113 13114 13115 13116 13117 13118
    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")},
13119 13120
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
13121 13122 13123
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13124
static bool
13125 13126 13127
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13128
    bool ret = false;
13129
    const char *name = NULL;
13130 13131
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
13132 13133 13134 13135
    unsigned int flags = 0;

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

13137
    if (!vshConnectionUsability(ctl, ctl->conn))
13138 13139 13140 13141 13142 13143
        goto cleanup;

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

13144
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13145 13146 13147 13148 13149 13150
        goto cleanup;

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

13151
    xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
13152 13153 13154
    if (!xml)
        goto cleanup;

13155
    vshPrint(ctl, "%s", xml);
13156

E
Eric Blake 已提交
13157
    ret = true;
13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168

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

    return ret;
}

E
Eric Blake 已提交
13169 13170 13171 13172
/*
 * "snapshot-parent" command
 */
static const vshCmdInfo info_snapshot_parent[] = {
E
Eric Blake 已提交
13173
    {"help", N_("Get the name of the parent of a snapshot")},
E
Eric Blake 已提交
13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213
    {"desc", N_("Extract the snapshot's parent, if any")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_parent[] = {
    {"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}
};

static bool
cmdSnapshotParent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    const char *name = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
    char *parent = NULL;
    xmlDocPtr xmldoc = NULL;
    xmlXPathContextPtr ctxt = NULL;

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

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

    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
        goto cleanup;

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

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

13214
    xmldoc = virXMLParseStringCtxt(xml, "domainsnapshot.xml", &ctxt);
E
Eric Blake 已提交
13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228
    if (!xmldoc)
        goto cleanup;

    parent = virXPathString("string(/domainsnapshot/parent/name)", ctxt);
    if (!parent)
        goto cleanup;

    vshPrint(ctl, "%s", parent);

    ret = true;

cleanup:
    VIR_FREE(parent);
    xmlXPathFreeContext(ctxt);
13229
    xmlFreeDoc(xmldoc);
E
Eric Blake 已提交
13230 13231 13232 13233 13234 13235 13236 13237 13238
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

13239
/*
13240
 * "snapshot-revert" command
13241
 */
13242
static const vshCmdInfo info_snapshot_revert[] = {
13243 13244 13245 13246 13247
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

13248
static const vshCmdOptDef opts_snapshot_revert[] = {
13249 13250
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
13251 13252
    {"running", VSH_OT_BOOL, 0, N_("after reverting, change state to running")},
    {"paused", VSH_OT_BOOL, 0, N_("after reverting, change state to paused")},
13253 13254 13255
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13256
static bool
13257
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
13258 13259
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13260
    bool ret = false;
13261
    const char *name = NULL;
13262
    virDomainSnapshotPtr snapshot = NULL;
13263 13264 13265 13266 13267 13268
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED;
13269

13270
    if (!vshConnectionUsability(ctl, ctl->conn))
13271 13272 13273 13274 13275 13276
        goto cleanup;

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

13277
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13278 13279 13280 13281 13282 13283
        goto cleanup;

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

13284
    if (virDomainRevertToSnapshot(snapshot, flags) < 0)
13285 13286
        goto cleanup;

E
Eric Blake 已提交
13287
    ret = true;
13288 13289 13290 13291 13292 13293 13294 13295 13296 13297 13298 13299 13300 13301 13302 13303 13304 13305 13306 13307 13308 13309 13310

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")},
13311 13312 13313
    {"children-only", VSH_OT_BOOL, 0, N_("delete children but not snapshot")},
    {"metadata", VSH_OT_BOOL, 0,
     N_("delete only libvirt metadata, leaving snapshot contents behind")},
13314 13315 13316
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13317
static bool
13318 13319 13320
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13321
    bool ret = false;
13322
    const char *name = NULL;
13323 13324 13325
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

13326
    if (!vshConnectionUsability(ctl, ctl->conn))
13327 13328 13329 13330 13331 13332
        goto cleanup;

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

13333
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13334 13335 13336 13337
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;
13338 13339 13340 13341
    if (vshCommandOptBool(cmd, "children-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY;
    if (vshCommandOptBool(cmd, "metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY;
13342 13343 13344 13345 13346

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

13347 13348 13349
    /* XXX If we wanted, we could emulate DELETE_CHILDREN_ONLY even on
     * older servers that reject the flag, by manually computing the
     * list of descendants.  But that's a lot of code to maintain.  */
13350
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
13351 13352 13353 13354
        if (flags & VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY)
            vshPrint(ctl, _("Domain snapshot %s children deleted\n"), name);
        else
            vshPrint(ctl, _("Domain snapshot %s deleted\n"), name);
13355 13356
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
13357
        goto cleanup;
13358
    }
13359

E
Eric Blake 已提交
13360
    ret = true;
13361 13362 13363 13364 13365 13366 13367 13368 13369 13370

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

    return ret;
}

13371 13372 13373 13374
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
13375 13376
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
13377 13378 13379 13380 13381
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
13382
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
13383
    {"cmd", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("command")},
13384 13385 13386
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13387
static bool
13388 13389 13390
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13391
    bool ret = false;
13392
    char *monitor_cmd = NULL;
13393
    char *result = NULL;
13394
    unsigned int flags = 0;
13395 13396 13397
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
13398 13399 13400 13401 13402 13403 13404 13405

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

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

13406 13407 13408 13409 13410 13411 13412 13413
    while ((opt = vshCommandOptArgv(cmd, opt))) {
        if (pad)
            virBufferAddChar(&buf, ' ');
        pad = true;
        virBufferAdd(&buf, opt->data, -1);
    }
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to collect command"));
13414 13415
        goto cleanup;
    }
13416
    monitor_cmd = virBufferContentAndReset(&buf);
13417

13418 13419 13420 13421
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
13422 13423 13424 13425
        goto cleanup;

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

E
Eric Blake 已提交
13426
    ret = true;
13427 13428 13429

cleanup:
    VIR_FREE(result);
13430
    VIR_FREE(monitor_cmd);
13431 13432 13433 13434 13435 13436
    if (dom)
        virDomainFree(dom);

    return ret;
}

13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480 13481 13482
/*
 * "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;
}

13483
static const vshCmdDef domManagementCmds[] = {
13484 13485 13486 13487 13488 13489 13490 13491
    {"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},
13492 13493
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
13494
#ifndef WIN32
13495
    {"console", cmdConsole, opts_console, info_console, 0},
13496
#endif
13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507
    {"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},
13508
    {"domif-setlink", cmdDomIfSetLink, opts_domif_setlink, info_domif_setlink, 0},
13509 13510 13511 13512 13513 13514 13515 13516 13517 13518 13519 13520
    {"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},
13521
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
13522 13523 13524 13525 13526 13527 13528 13529
    {"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},
13530 13531
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
13532 13533
    {"migrate-getspeed", cmdMigrateGetMaxSpeed,
     opts_migrate_getspeed, info_migrate_getspeed, 0},
13534 13535 13536 13537
    {"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},
13538 13539 13540 13541 13542 13543
    {"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},
13544
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
13545
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
13546 13547 13548 13549 13550 13551 13552 13553 13554 13555 13556 13557
    {"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 已提交
13558
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
13559
    {"version", cmdVersion, opts_version, info_version, 0},
13560 13561
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
13562 13563 13564
};

static const vshCmdDef domMonitoringCmds[] = {
13565
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
13566
    {"domblklist", cmdDomblklist, opts_domblklist, info_domblklist, 0},
13567
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
13568
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
13569
    {"domif-getlink", cmdDomIfGetLink, opts_domif_getlink, info_domif_getlink, 0},
13570 13571 13572 13573 13574 13575
    {"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}
13576 13577 13578
};

static const vshCmdDef storagePoolCmds[] = {
13579
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
13580
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
13581
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602
     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}
13603 13604 13605
};

static const vshCmdDef storageVolCmds[] = {
13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618 13619 13620 13621 13622 13623
    {"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}
13624
};
13625

13626
static const vshCmdDef networkCmds[] = {
13627 13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645
    {"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}
13646
};
13647

13648
static const vshCmdDef nodedevCmds[] = {
13649 13650 13651 13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663
    {"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}
13664 13665 13666
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
13667 13668 13669 13670
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684
    {"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 已提交
13685 13686
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
13687 13688 13689 13690 13691
    {"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}
13692
};
13693

13694
static const vshCmdDef nwfilterCmds[] = {
13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705
    {"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}
13706
};
13707

13708
static const vshCmdDef secretCmds[] = {
13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720
    {"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}
13721
};
13722

13723
static const vshCmdDef virshCmds[] = {
13724 13725 13726 13727 13728 13729 13730
    {"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}
13731
};
13732

13733
static const vshCmdDef snapshotCmds[] = {
13734 13735
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
13736 13737
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
13738 13739 13740 13741 13742 13743
    {"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},
13744 13745
    {"snapshot-edit", cmdSnapshotEdit, opts_snapshot_edit,
     info_snapshot_edit, 0},
13746 13747
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
E
Eric Blake 已提交
13748 13749
    {"snapshot-parent", cmdSnapshotParent, opts_snapshot_parent,
     info_snapshot_parent, 0},
13750 13751 13752
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
13753
};
13754

13755
static const vshCmdDef hostAndHypervisorCmds[] = {
13756 13757 13758 13759 13760
    {"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},
13761
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
13762
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
13763
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
13764
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
13765 13766 13767 13768 13769
    {"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 已提交
13770 13771
};

13772 13773 13774 13775 13776 13777 13778 13779 13780 13781 13782 13783 13784 13785 13786 13787 13788
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 已提交
13789 13790 13791 13792
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
13793
static const char *
13794
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
13795
{
13796
    const vshCmdInfo *info;
13797

K
Karel Zak 已提交
13798
    for (info = cmd->info; info && info->name; info++) {
13799
        if (STREQ(info->name, name))
K
Karel Zak 已提交
13800 13801 13802 13803 13804
            return info->data;
    }
    return NULL;
}

13805
static int
E
Eric Blake 已提交
13806
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
13807 13808 13809 13810 13811
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
13812 13813 13814
    *opts_need_arg = 0;
    *opts_required = 0;

13815 13816 13817 13818 13819 13820 13821 13822 13823
    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) {
E
Eric Blake 已提交
13824
            if (opt->flags & VSH_OFLAG_REQ)
13825 13826 13827
                return -1; /* bool options can't be mandatory */
            continue;
        }
E
Eric Blake 已提交
13828 13829
        if (opt->flags & VSH_OFLAG_REQ_OPT) {
            if (opt->flags & VSH_OFLAG_REQ)
L
Lai Jiangshan 已提交
13830 13831 13832 13833
                *opts_required |= 1 << i;
            continue;
        }

13834
        *opts_need_arg |= 1 << i;
E
Eric Blake 已提交
13835
        if (opt->flags & VSH_OFLAG_REQ) {
13836 13837 13838 13839 13840 13841 13842 13843 13844 13845
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
    }
    return 0;
}

13846
static const vshCmdOptDef *
13847 13848
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
13849
{
13850 13851 13852 13853
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
13854

13855 13856 13857 13858 13859
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
13860 13861
            if (opt->type != VSH_OT_ARGV)
                *opts_seen |= 1 << i;
K
Karel Zak 已提交
13862
            return opt;
13863 13864 13865 13866 13867
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
13868 13869 13870
    return NULL;
}

13871
static const vshCmdOptDef *
13872 13873
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
13874
{
13875
    int i;
13876
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
13877

13878 13879 13880 13881
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
13882
    i = ffs(*opts_need_arg) - 1;
13883 13884 13885 13886 13887
    opt = &cmd->opts[i];
    if (opt->type != VSH_OT_ARGV)
        *opts_need_arg &= ~(1 << i);
    *opts_seen |= 1 << i;
    return opt;
K
Karel Zak 已提交
13888 13889
}

13890 13891 13892
/*
 * Checks for required options
 */
13893
static int
13894 13895
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
13896
{
13897
    const vshCmdDef *def = cmd->def;
13898 13899 13900 13901 13902 13903 13904 13905 13906
    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];
13907

13908
            vshError(ctl,
13909
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
13910 13911 13912
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
13913 13914
        }
    }
13915
    return -1;
13916 13917
}

13918
static const vshCmdDef *
13919 13920
vshCmddefSearch(const char *cmdname)
{
13921
    const vshCmdGrp *g;
13922
    const vshCmdDef *c;
13923

13924 13925
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
13926
            if (STREQ(c->name, cmdname))
13927 13928 13929 13930
                return c;
        }
    }

K
Karel Zak 已提交
13931 13932 13933
    return NULL;
}

13934 13935 13936 13937 13938 13939
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
13940
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
13941 13942 13943 13944 13945 13946
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
13947
static bool
13948 13949 13950 13951 13952 13953 13954
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 已提交
13955
        return false;
13956 13957 13958 13959 13960 13961 13962 13963 13964 13965
    } 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 已提交
13966
    return true;
13967 13968
}

E
Eric Blake 已提交
13969
static bool
13970
vshCmddefHelp(vshControl *ctl, const char *cmdname)
13971
{
13972
    const vshCmdDef *def = vshCmddefSearch(cmdname);
13973

K
Karel Zak 已提交
13974
    if (!def) {
13975
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
13976
        return false;
13977
    } else {
E
Eric Blake 已提交
13978 13979
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
13980
        const char *help = _(vshCmddefGetInfo(def, "help"));
13981
        char buf[256];
13982 13983 13984 13985 13986 13987
        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 已提交
13988
            return false;
13989
        }
K
Karel Zak 已提交
13990

13991
        fputs(_("  NAME\n"), stdout);
13992 13993
        fprintf(stdout, "    %s - %s\n", def->name, help);

13994 13995 13996 13997 13998
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
13999
                const char *fmt = "%s";
14000 14001
                switch (opt->type) {
                case VSH_OT_BOOL:
14002
                    fmt = "[--%s]";
14003 14004
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
14005
                    /* xgettext:c-format */
E
Eric Blake 已提交
14006
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>"
14007
                           : _("[--%s <number>]"));
14008 14009
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
14010 14011
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
14012 14013
                    break;
                case VSH_OT_DATA:
E
Eric Blake 已提交
14014
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
14015 14016 14017
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
E
Eric Blake 已提交
14018
                    fmt = (opt->flags & VSH_OFLAG_REQ) ? _("<%s>...")
14019
                           : _("[<%s>]...");
14020 14021
                    break;
                default:
14022
                    assert(0);
14023
                }
14024
                fputc(' ', stdout);
E
Eric Blake 已提交
14025
                fprintf(stdout, fmt, opt->name);
14026
            }
K
Karel Zak 已提交
14027
        }
14028 14029 14030
        fputc('\n', stdout);

        if (desc[0]) {
14031
            /* Print the description only if it's not empty.  */
14032
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
14033
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
14034
        }
14035

K
Karel Zak 已提交
14036
        if (def->opts) {
14037
            const vshCmdOptDef *opt;
14038
            fputs(_("\n  OPTIONS\n"), stdout);
14039
            for (opt = def->opts; opt->name; opt++) {
14040 14041
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
14042
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
14043 14044
                    break;
                case VSH_OT_INT:
14045
                    snprintf(buf, sizeof(buf),
E
Eric Blake 已提交
14046
                             (opt->flags & VSH_OFLAG_REQ) ? _("[--%s] <number>")
14047
                             : _("--%s <number>"), opt->name);
14048 14049
                    break;
                case VSH_OT_STRING:
14050
                    /* OT_STRING should never be VSH_OFLAG_REQ */
14051
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
14052 14053
                    break;
                case VSH_OT_DATA:
14054 14055
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
14056 14057 14058
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
14059 14060
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
14061 14062 14063
                default:
                    assert(0);
                }
14064

E
Eric Blake 已提交
14065
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
14066
            }
K
Karel Zak 已提交
14067 14068 14069
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
14070
    return true;
K
Karel Zak 已提交
14071 14072 14073 14074 14075 14076
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
14077 14078 14079
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
14080 14081
    vshCmdOpt *a = arg;

14082
    while (a) {
K
Karel Zak 已提交
14083
        vshCmdOpt *tmp = a;
14084

K
Karel Zak 已提交
14085 14086
        a = a->next;

14087 14088
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
14089 14090 14091 14092
    }
}

static void
14093
vshCommandFree(vshCmd *cmd)
14094
{
K
Karel Zak 已提交
14095 14096
    vshCmd *c = cmd;

14097
    while (c) {
K
Karel Zak 已提交
14098
        vshCmd *tmp = c;
14099

K
Karel Zak 已提交
14100 14101 14102 14103
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
14104
        VIR_FREE(tmp);
K
Karel Zak 已提交
14105 14106 14107
    }
}

E
Eric Blake 已提交
14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118
/**
 * 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 已提交
14119
 */
E
Eric Blake 已提交
14120 14121
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
14122
{
E
Eric Blake 已提交
14123 14124
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
14125

E
Eric Blake 已提交
14126 14127 14128 14129 14130 14131 14132
    /* 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 已提交
14133
    }
E
Eric Blake 已提交
14134 14135 14136 14137 14138 14139 14140

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
E
Eric Blake 已提交
14141
            return (valid->flags & VSH_OFLAG_REQ) == 0 ? 0 : -1;
E
Eric Blake 已提交
14142 14143 14144 14145
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
14146 14147
}

E
Eric Blake 已提交
14148 14149
/**
 * vshCommandOptInt:
14150 14151 14152 14153 14154 14155 14156
 * @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 已提交
14157
 * 0 if option not found and not required (@value untouched)
14158
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
14159 14160
 */
static int
14161
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
14162
{
E
Eric Blake 已提交
14163 14164 14165
    vshCmdOpt *arg;
    int ret;
    int num;
14166
    char *end_p = NULL;
14167

E
Eric Blake 已提交
14168 14169 14170 14171 14172 14173 14174
    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;
14175
    }
E
Eric Blake 已提交
14176 14177 14178 14179 14180 14181 14182

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
14183 14184
}

14185

E
Eric Blake 已提交
14186 14187 14188 14189 14190 14191
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
14192 14193 14194 14195 14196 14197
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
14198 14199 14200
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
14201 14202
    char *end_p = NULL;

E
Eric Blake 已提交
14203 14204 14205 14206 14207 14208 14209
    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;
14210
    }
E
Eric Blake 已提交
14211 14212 14213 14214 14215 14216 14217

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14218 14219 14220
}


14221
/*
E
Eric Blake 已提交
14222 14223 14224 14225 14226
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
14227 14228 14229 14230 14231
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
14232
{
E
Eric Blake 已提交
14233 14234
    vshCmdOpt *arg;
    int ret;
14235
    unsigned long num;
14236 14237
    char *end_p = NULL;

E
Eric Blake 已提交
14238 14239 14240 14241 14242 14243 14244
    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;
14245
    }
E
Eric Blake 已提交
14246 14247 14248 14249 14250 14251 14252

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14253 14254
}

E
Eric Blake 已提交
14255 14256 14257 14258 14259 14260
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
14261
 * Returns option as STRING
E
Eric Blake 已提交
14262 14263 14264 14265
 * 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 已提交
14266
 */
14267 14268
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
14269
{
E
Eric Blake 已提交
14270 14271 14272 14273 14274 14275 14276 14277 14278 14279
    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;
14280
    }
14281

E
Eric Blake 已提交
14282
    if (!*arg->data && !(arg->def->flags & VSH_OFLAG_EMPTY_OK)) {
E
Eric Blake 已提交
14283 14284 14285 14286
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
14287 14288
}

E
Eric Blake 已提交
14289 14290 14291 14292 14293 14294
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
14295
 * Returns option as long long
14296
 * See vshCommandOptInt()
14297
 */
14298 14299 14300
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
14301
{
E
Eric Blake 已提交
14302 14303
    vshCmdOpt *arg;
    int ret;
14304
    long long num;
14305 14306
    char *end_p = NULL;

E
Eric Blake 已提交
14307 14308 14309 14310 14311 14312 14313
    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;
14314
    }
E
Eric Blake 已提交
14315 14316 14317 14318 14319 14320 14321

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14322 14323
}

E
Eric Blake 已提交
14324 14325 14326 14327 14328 14329 14330 14331 14332
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
14333 14334 14335 14336
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
14337 14338
    vshCmdOpt *arg;
    int ret;
14339 14340 14341
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
14342 14343 14344 14345 14346 14347 14348
    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;
14349
    }
E
Eric Blake 已提交
14350 14351 14352 14353 14354 14355 14356

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14357 14358 14359
}


E
Eric Blake 已提交
14360 14361 14362 14363 14364 14365 14366 14367 14368
/**
 * 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 已提交
14369
 */
E
Eric Blake 已提交
14370
static bool
14371
vshCommandOptBool(const vshCmd *cmd, const char *name)
14372
{
E
Eric Blake 已提交
14373 14374 14375
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
14376 14377
}

E
Eric Blake 已提交
14378 14379 14380 14381 14382
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
14383 14384
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
14385
 *
14386
 * Requires that a VSH_OT_ARGV option be last in the
14387 14388
 * list of supported options in CMD->def->opts.
 */
14389 14390
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
14391
{
14392
    opt = opt ? opt->next : cmd->opts;
14393 14394

    while (opt) {
E
Eric Blake 已提交
14395
        if (opt->def->type == VSH_OT_ARGV) {
14396
            return opt;
14397 14398 14399 14400 14401 14402
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414 14415 14416 14417 14418 14419 14420
/* 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)
14421
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
14422 14423 14424
                 cmd->def->name, optname);
    return found;
}
14425

K
Karel Zak 已提交
14426
static virDomainPtr
J
Jim Meyering 已提交
14427
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
14428
                      const char **name, int flag)
14429
{
K
Karel Zak 已提交
14430
    virDomainPtr dom = NULL;
14431
    const char *n = NULL;
K
Karel Zak 已提交
14432
    int id;
J
Jim Meyering 已提交
14433 14434 14435
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
14436

14437
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14438 14439
        return NULL;

14440
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14441 14442
             cmd->def->name, optname, n);

K
Karel Zak 已提交
14443 14444
    if (name)
        *name = n;
14445

K
Karel Zak 已提交
14446
    /* try it by ID */
14447
    if (flag & VSH_BYID) {
14448
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
14449 14450
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
14451 14452 14453
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
14454
    }
K
Karel Zak 已提交
14455
    /* try it by UUID */
14456
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
14457
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
14458
                 cmd->def->name, optname);
K
Karel Zak 已提交
14459
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
14460
    }
K
Karel Zak 已提交
14461
    /* try it by NAME */
14462
    if (dom==NULL && (flag & VSH_BYNAME)) {
14463
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
14464
                 cmd->def->name, optname);
K
Karel Zak 已提交
14465
        dom = virDomainLookupByName(ctl->conn, n);
14466
    }
K
Karel Zak 已提交
14467

14468
    if (!dom)
14469
        vshError(ctl, _("failed to get domain '%s'"), n);
14470

K
Karel Zak 已提交
14471 14472 14473
    return dom;
}

14474
static virNetworkPtr
J
Jim Meyering 已提交
14475
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
14476
                       const char **name, int flag)
14477 14478
{
    virNetworkPtr network = NULL;
14479
    const char *n = NULL;
J
Jim Meyering 已提交
14480 14481 14482
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
14483

14484
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14485 14486
        return NULL;

14487
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14488 14489 14490 14491 14492 14493
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
14494
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14495
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
14496
                 cmd->def->name, optname);
14497 14498 14499 14500
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
14501
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
14502 14503 14504 14505 14506
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
14507
        vshError(ctl, _("failed to get network '%s'"), n);
14508 14509 14510 14511

    return network;
}

14512 14513 14514

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
14515
                        const char **name, int flag)
14516 14517
{
    virNWFilterPtr nwfilter = NULL;
14518
    const char *n = NULL;
14519 14520 14521 14522
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14523
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14524 14525
        return NULL;

14526
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14527 14528 14529 14530 14531 14532 14533
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14534
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
14535 14536 14537 14538 14539
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
14540
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
14541 14542 14543 14544 14545 14546 14547 14548 14549 14550
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

14551 14552
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
14553
                         const char **name, int flag)
14554 14555
{
    virInterfacePtr iface = NULL;
14556
    const char *n = NULL;
14557 14558 14559 14560
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14561
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14562 14563
        return NULL;

14564
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14565 14566 14567 14568 14569 14570
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
14571
    if ((flag & VSH_BYNAME)) {
14572
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
14573 14574 14575 14576 14577
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
14578
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
14579 14580 14581 14582 14583
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
14584
        vshError(ctl, _("failed to get interface '%s'"), n);
14585 14586 14587 14588

    return iface;
}

14589
static virStoragePoolPtr
14590
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
14591
                    const char **name, int flag)
14592 14593
{
    virStoragePoolPtr pool = NULL;
14594
    const char *n = NULL;
14595

14596
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14597 14598
        return NULL;

14599
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14600 14601 14602 14603 14604 14605
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
14606
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14607
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
14608
                 cmd->def->name, optname);
14609 14610 14611
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
14612
    if (pool == NULL && (flag & VSH_BYNAME)) {
14613
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
14614 14615 14616 14617 14618
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
14619
        vshError(ctl, _("failed to get pool '%s'"), n);
14620 14621 14622 14623 14624

    return pool;
}

static virStorageVolPtr
14625
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
14626 14627
                   const char *optname,
                   const char *pooloptname,
14628
                   const char **name, int flag)
14629 14630 14631
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
14632
    const char *n = NULL, *p = NULL;
14633

14634
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14635 14636
        return NULL;

14637
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
14638
        vshError(ctl, "%s", _("missing option"));
14639
        return NULL;
14640
    }
14641 14642 14643 14644

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

14645
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
14646 14647 14648 14649 14650
             cmd->def->name, optname, n);

    if (name)
        *name = n;

14651
    /* try it by name */
14652
    if (pool && (flag & VSH_BYNAME)) {
14653
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
14654 14655 14656
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
14657
    /* try it by key */
14658
    if (vol == NULL && (flag & VSH_BYUUID)) {
14659
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
14660 14661 14662
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
14663
    /* try it by path */
14664
    if (vol == NULL && (flag & VSH_BYUUID)) {
14665
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
14666 14667 14668 14669 14670
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
14671
        vshError(ctl, _("failed to get vol '%s'"), n);
14672 14673 14674 14675 14676 14677 14678

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

14679
static virSecretPtr
14680
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
14681 14682
{
    virSecretPtr secret = NULL;
14683
    const char *n = NULL;
14684 14685 14686 14687 14688
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14689
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14690 14691
        return NULL;

14692 14693
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
14694 14695 14696 14697 14698 14699 14700

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
14701
        vshError(ctl, _("failed to get secret '%s'"), n);
14702 14703 14704 14705

    return secret;
}

K
Karel Zak 已提交
14706 14707 14708
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
14709
static bool
14710
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
14711
{
E
Eric Blake 已提交
14712
    bool ret = true;
14713 14714

    while (cmd) {
K
Karel Zak 已提交
14715
        struct timeval before, after;
14716
        bool enable_timing = ctl->timing;
14717

14718 14719
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
14720 14721
            vshReconnect(ctl);

14722
        if (enable_timing)
K
Karel Zak 已提交
14723
            GETTIMEOFDAY(&before);
14724

K
Karel Zak 已提交
14725 14726
        ret = cmd->def->handler(ctl, cmd);

14727
        if (enable_timing)
K
Karel Zak 已提交
14728
            GETTIMEOFDAY(&after);
14729

14730
        if (!ret)
J
John Levon 已提交
14731 14732
            virshReportError(ctl);

14733
        /* try to automatically catch disconnections */
14734
        if (!ret &&
14735 14736 14737 14738 14739 14740 14741 14742 14743
            ((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);

14744
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
14745 14746
            return ret;

14747
        if (enable_timing)
14748
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
14749 14750
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
14751
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
14752 14753 14754 14755 14756 14757
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
14758
 * Command parsing
K
Karel Zak 已提交
14759 14760 14761
 * ---------------
 */

14762 14763 14764 14765 14766 14767 14768 14769 14770 14771
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 已提交
14772
    /* vshCommandStringGetArg() */
14773
    char *pos;
L
Lai Jiangshan 已提交
14774 14775 14776
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
14777 14778
} vshCommandParser;

E
Eric Blake 已提交
14779
static bool
14780
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
14781
{
K
Karel Zak 已提交
14782 14783 14784
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
14785

K
Karel Zak 已提交
14786 14787 14788 14789
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
14790

14791
    while (1) {
K
Karel Zak 已提交
14792
        vshCmdOpt *last = NULL;
14793
        const vshCmdDef *cmd = NULL;
14794
        vshCommandToken tk;
L
Lai Jiangshan 已提交
14795
        bool data_only = false;
14796 14797 14798
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
14799

K
Karel Zak 已提交
14800
        first = NULL;
14801

14802
        while (1) {
14803
            const vshCmdOptDef *opt = NULL;
14804

K
Karel Zak 已提交
14805
            tkdata = NULL;
14806
            tk = parser->getNextArg(ctl, parser, &tkdata);
14807 14808

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14809
                goto syntaxError;
H
Hu Tao 已提交
14810 14811
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
14812
                break;
H
Hu Tao 已提交
14813
            }
14814 14815

            if (cmd == NULL) {
K
Karel Zak 已提交
14816 14817
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
14818
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
14819
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
14820
                }
14821 14822 14823 14824 14825 14826 14827
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
14828
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
14829 14830 14831 14832
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
14833 14834 14835 14836 14837
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
14838 14839
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
14840
                    VIR_FREE(optstr);
K
Karel Zak 已提交
14841 14842
                    goto syntaxError;
                }
14843
                VIR_FREE(tkdata);
K
Karel Zak 已提交
14844 14845 14846

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
14847 14848 14849
                    if (optstr)
                        tkdata = optstr;
                    else
14850
                        tk = parser->getNextArg(ctl, parser, &tkdata);
14851
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14852
                        goto syntaxError;
14853
                    if (tk != VSH_TK_ARG) {
14854
                        vshError(ctl,
14855
                                 _("expected syntax: --%s <%s>"),
14856 14857
                                 opt->name,
                                 opt->type ==
14858
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
14859 14860
                        goto syntaxError;
                    }
14861
                    opts_need_arg &= ~opts_seen;
14862 14863 14864 14865 14866 14867 14868 14869
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
14870
                }
L
Lai Jiangshan 已提交
14871 14872 14873 14874
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
14875
            } else {
L
Lai Jiangshan 已提交
14876
get_data:
14877 14878
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
14879
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
14880 14881 14882 14883 14884
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
14885
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
14886

K
Karel Zak 已提交
14887 14888 14889 14890
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
14891

K
Karel Zak 已提交
14892 14893 14894 14895 14896
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
14897

14898
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
14899 14900
                         cmd->name,
                         opt->name,
14901 14902
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
14903 14904
            }
        }
14905

D
Daniel Veillard 已提交
14906
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
14907
        if (cmd) {
14908
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
14909

K
Karel Zak 已提交
14910 14911 14912 14913
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

14914
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
14915
                VIR_FREE(c);
14916
                goto syntaxError;
14917
            }
14918

K
Karel Zak 已提交
14919 14920 14921 14922 14923 14924
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
14925 14926 14927

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
14928
    }
14929

E
Eric Blake 已提交
14930
    return true;
K
Karel Zak 已提交
14931

14932
 syntaxError:
14933
    if (ctl->cmd) {
K
Karel Zak 已提交
14934
        vshCommandFree(ctl->cmd);
14935 14936
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
14937 14938
    if (first)
        vshCommandOptFree(first);
14939
    VIR_FREE(tkdata);
E
Eric Blake 已提交
14940
    return false;
K
Karel Zak 已提交
14941 14942
}

14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960
/* --------------------
 * 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 已提交
14961 14962
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
14963 14964 14965 14966
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
14967
        return false;
14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985 14986 14987 14988 14989 14990 14991 14992 14993 14994 14995 14996 14997 14998 14999 15000 15001 15002 15003 15004 15005 15006 15007 15008 15009 15010 15011 15012 15013 15014 15015 15016 15017 15018 15019 15020 15021 15022 15023 15024 15025 15026 15027 15028 15029 15030 15031 15032 15033 15034 15035 15036 15037 15038 15039

    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 已提交
15040 15041
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
15042 15043 15044 15045
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
15046
        return false;
15047 15048 15049 15050 15051 15052

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
15053
/* ---------------
15054
 * Misc utils
K
Karel Zak 已提交
15055 15056
 * ---------------
 */
15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084
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 已提交
15085
static const char *
15086 15087
vshDomainStateToString(int state)
{
15088 15089
    /* Can't use virDomainStateTypeToString, because we want to mark
     * strings for translation.  */
15090
    switch ((virDomainState) state) {
15091
    case VIR_DOMAIN_RUNNING:
15092
        return N_("running");
15093
    case VIR_DOMAIN_BLOCKED:
15094
        return N_("idle");
15095
    case VIR_DOMAIN_PAUSED:
15096
        return N_("paused");
15097
    case VIR_DOMAIN_SHUTDOWN:
15098
        return N_("in shutdown");
15099
    case VIR_DOMAIN_SHUTOFF:
15100
        return N_("shut off");
15101
    case VIR_DOMAIN_CRASHED:
15102
        return N_("crashed");
15103
    case VIR_DOMAIN_NOSTATE:
15104
    default:
15105
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
15106
    }
15107
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
15108 15109
}

15110 15111 15112 15113 15114 15115 15116 15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140 15141 15142 15143 15144 15145 15146 15147 15148 15149 15150 15151 15152 15153 15154 15155 15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166 15167 15168 15169 15170 15171 15172 15173 15174 15175 15176 15177 15178 15179 15180 15181 15182 15183 15184 15185 15186 15187 15188 15189 15190 15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205
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;
15206 15207 15208

    default:
        ;
15209 15210 15211 15212 15213
    }

    return N_("unknown");
}

15214 15215 15216 15217 15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 15229 15230
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");
}

15231 15232 15233 15234
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
15235
    case VIR_VCPU_OFFLINE:
15236
        return N_("offline");
15237
    case VIR_VCPU_BLOCKED:
15238
        return N_("idle");
15239
    case VIR_VCPU_RUNNING:
15240
        return N_("running");
15241
    default:
15242
        ;/*FALLTHROUGH*/
15243
    }
15244
    return N_("no state");
15245 15246
}

E
Eric Blake 已提交
15247
static bool
15248
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
15249
{
15250 15251
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
15252 15253
     */
    if (!conn) {
15254
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
15255
        return false;
K
Karel Zak 已提交
15256
    }
E
Eric Blake 已提交
15257
    return true;
K
Karel Zak 已提交
15258 15259
}

K
Karel Zak 已提交
15260
static void
15261
vshDebug(vshControl *ctl, int level, const char *format, ...)
15262
{
K
Karel Zak 已提交
15263
    va_list ap;
15264
    char *str;
K
Karel Zak 已提交
15265

15266 15267 15268 15269 15270 15271 15272
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

15273
    va_start(ap, format);
15274
    vshOutputLogFile(ctl, level, format, ap);
15275 15276
    va_end(ap);

K
Karel Zak 已提交
15277
    va_start(ap, format);
15278 15279 15280 15281 15282
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
15283
    va_end(ap);
15284 15285
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
15286 15287 15288
}

static void
15289
vshPrintExtra(vshControl *ctl, const char *format, ...)
15290
{
K
Karel Zak 已提交
15291
    va_list ap;
15292
    char *str;
15293

15294
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
15295
        return;
15296

K
Karel Zak 已提交
15297
    va_start(ap, format);
15298 15299 15300 15301 15302
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
15303
    va_end(ap);
15304
    fputs(str, stdout);
15305
    VIR_FREE(str);
K
Karel Zak 已提交
15306 15307
}

K
Karel Zak 已提交
15308

K
Karel Zak 已提交
15309
static void
15310
vshError(vshControl *ctl, const char *format, ...)
15311
{
K
Karel Zak 已提交
15312
    va_list ap;
15313
    char *str;
15314

15315 15316 15317 15318 15319
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
15320

15321 15322 15323 15324
    /* Most output is to stdout, but if someone ran virsh 2>&1, then
     * printing to stderr will not interleave correctly with stdout
     * unless we flush between every transition between streams.  */
    fflush(stdout);
15325
    fputs(_("error: "), stderr);
15326

K
Karel Zak 已提交
15327
    va_start(ap, format);
15328 15329 15330
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
15331 15332
    va_end(ap);

15333
    fprintf(stderr, "%s\n", NULLSTR(str));
15334
    fflush(stderr);
15335
    VIR_FREE(str);
K
Karel Zak 已提交
15336 15337
}

15338

K
Karel Zak 已提交
15339
/*
15340
 * Initialize connection.
K
Karel Zak 已提交
15341
 */
E
Eric Blake 已提交
15342
static bool
15343
vshInit(vshControl *ctl)
15344
{
15345 15346
    char *debugEnv;

K
Karel Zak 已提交
15347
    if (ctl->conn)
E
Eric Blake 已提交
15348
        return false;
K
Karel Zak 已提交
15349

J
Jiri Denemark 已提交
15350
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
15351 15352 15353
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
15354 15355 15356
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
15357 15358
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
15359 15360
            } else {
                ctl->debug = debug;
15361 15362 15363 15364 15365 15366 15367 15368 15369 15370 15371 15372
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

15373 15374
    vshOpenLogFile(ctl);

15375 15376
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
15377

15378 15379 15380
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

15381
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
15382
        return false;
15383

15384 15385 15386 15387
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
15388

15389 15390 15391 15392 15393 15394 15395 15396 15397 15398 15399
        /* 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;
        }
15400
    }
K
Karel Zak 已提交
15401

E
Eric Blake 已提交
15402
    return true;
K
Karel Zak 已提交
15403 15404
}

15405 15406
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

15407 15408 15409 15410 15411 15412 15413 15414 15415 15416 15417 15418 15419 15420 15421 15422 15423 15424 15425
/**
 * 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:
15426
                vshError(ctl, "%s",
J
Jim Meyering 已提交
15427
                         _("failed to get the log file information"));
15428
                exit(EXIT_FAILURE);
15429 15430 15431
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
15432 15433
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
15434 15435 15436 15437
        }
    }

    /* log file open */
15438
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
15439
        vshError(ctl, "%s",
J
Jim Meyering 已提交
15440
                 _("failed to open the log file. check the log file path"));
15441
        exit(EXIT_FAILURE);
15442 15443 15444 15445 15446 15447 15448 15449 15450
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
15451 15452
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
15453
{
15454 15455 15456
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
15457 15458 15459 15460 15461 15462 15463 15464 15465 15466 15467 15468 15469 15470
    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);
15471
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
15472 15473 15474 15475 15476 15477
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
15478 15479
                      SIGN_NAME,
                      (int) getpid());
15480 15481 15482 15483 15484 15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499
    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;
    }
15500 15501 15502
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
15503

15504 15505
    if (virBufferError(&buf))
        goto error;
15506

15507 15508 15509 15510 15511
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
15512
    }
15513

15514 15515 15516 15517 15518 15519 15520 15521 15522 15523 15524
    /* 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);
15525 15526 15527 15528 15529 15530 15531 15532 15533 15534 15535
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
15536 15537 15538
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
15539 15540 15541
    }

    if (ctl->logfile) {
15542
        VIR_FREE(ctl->logfile);
15543 15544 15545 15546
        ctl->logfile = NULL;
    }
}

15547
#ifdef USE_READLINE
15548

K
Karel Zak 已提交
15549 15550 15551 15552 15553
/* -----------------
 * Readline stuff
 * -----------------
 */

15554
/*
K
Karel Zak 已提交
15555 15556
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
15557
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
15558 15559
 */
static char *
15560 15561
vshReadlineCommandGenerator(const char *text, int state)
{
15562
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
15563
    const char *name;
15564 15565
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
15566 15567

    if (!state) {
15568 15569
        grp_list_index = 0;
        cmd_list_index = 0;
15570
        len = strlen(text);
K
Karel Zak 已提交
15571 15572
    }

15573 15574
    grp = cmdGroups;

K
Karel Zak 已提交
15575
    /* Return the next name which partially matches from the
15576
     * command list.
K
Karel Zak 已提交
15577
     */
15578 15579 15580 15581 15582 15583 15584 15585 15586 15587 15588 15589 15590 15591
    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 已提交
15592 15593 15594 15595 15596 15597 15598
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
15599 15600
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
15601
    static int list_index, len;
15602
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
15603
    const char *name;
K
Karel Zak 已提交
15604 15605 15606 15607 15608 15609 15610 15611 15612

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

15613
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
15614
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
15615 15616 15617

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
15618
        len = strlen(text);
15619
        VIR_FREE(cmdname);
K
Karel Zak 已提交
15620 15621 15622 15623
    }

    if (!cmd)
        return NULL;
15624

15625 15626 15627
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
15628
    while ((name = cmd->opts[list_index].name)) {
15629
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
15630
        char *res;
15631

K
Karel Zak 已提交
15632
        list_index++;
15633

15634
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
15635 15636
            /* ignore non --option */
            continue;
15637

K
Karel Zak 已提交
15638
        if (len > 2) {
15639
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
15640 15641
                continue;
        }
15642
        res = vshMalloc(NULL, strlen(name) + 3);
15643
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
15644 15645 15646 15647 15648 15649 15650 15651
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
15652 15653 15654
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
15655 15656
    char **matches = (char **) NULL;

15657
    if (start == 0)
K
Karel Zak 已提交
15658
        /* command name generator */
15659
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
15660 15661
    else
        /* commands options */
15662
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
15663 15664 15665 15666
    return matches;
}


15667 15668
static int
vshReadlineInit(vshControl *ctl)
15669
{
15670 15671
    char *userdir = NULL;

K
Karel Zak 已提交
15672 15673 15674 15675 15676
    /* 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;
15677 15678 15679

    /* Limit the total size of the history buffer */
    stifle_history(500);
15680 15681

    /* Prepare to read/write history from/to the ~/.virsh/history file */
15682
    userdir = virGetUserDirectory(getuid());
15683

15684 15685
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
15686
        return -1;
15687
    }
15688 15689 15690

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15691
        VIR_FREE(userdir);
15692 15693 15694 15695 15696
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15697
        VIR_FREE(userdir);
15698 15699 15700
        return -1;
    }

15701
    VIR_FREE(userdir);
15702 15703 15704 15705 15706 15707 15708 15709 15710 15711 15712 15713 15714 15715 15716 15717 15718 15719

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

15720 15721
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
15722 15723
}

15724 15725 15726 15727 15728 15729
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

15730
#else /* !USE_READLINE */
15731

15732 15733 15734 15735 15736 15737 15738
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

15739
static void
15740
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
15741 15742 15743 15744 15745 15746 15747 15748 15749 15750 15751 15752 15753 15754 15755 15756 15757 15758 15759 15760 15761 15762 15763
{
    /* 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);
}

15764
#endif /* !USE_READLINE */
15765

K
Karel Zak 已提交
15766
/*
J
Jim Meyering 已提交
15767
 * Deinitialize virsh
K
Karel Zak 已提交
15768
 */
E
Eric Blake 已提交
15769
static bool
15770
vshDeinit(vshControl *ctl)
15771
{
15772
    vshReadlineDeinit(ctl);
15773
    vshCloseLogFile(ctl);
15774
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
15775
    if (ctl->conn) {
15776 15777 15778
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
15779 15780
        }
    }
D
Daniel P. Berrange 已提交
15781 15782
    virResetLastError();

E
Eric Blake 已提交
15783
    return true;
K
Karel Zak 已提交
15784
}
15785

K
Karel Zak 已提交
15786 15787 15788 15789
/*
 * Print usage
 */
static void
15790
vshUsage(void)
15791
{
15792
    const vshCmdGrp *grp;
15793
    const vshCmdDef *cmd;
15794

L
Lai Jiangshan 已提交
15795 15796
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
15797 15798 15799
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
15800
                      "    -d | --debug <num>      debug level [0-4]\n"
15801 15802 15803 15804
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
15805
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
15806
                      "    -V | --version=long     version and full options\n\n"
15807
                      "  commands (non interactive mode):\n\n"), progname, progname);
15808

15809 15810
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
15811

15812 15813 15814 15815 15816 15817 15818 15819 15820
        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"));
15821 15822 15823
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
15824 15825
}

15826 15827 15828 15829 15830 15831 15832 15833 15834 15835
/*
 * 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 已提交
15836 15837
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
15838 15839 15840 15841 15842 15843 15844 15845 15846 15847 15848 15849 15850 15851 15852 15853 15854 15855 15856 15857 15858 15859 15860 15861 15862 15863 15864 15865 15866 15867 15868 15869 15870 15871 15872
#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 已提交
15873
    vshPrint(ctl, "%s", _(" Networking:"));
15874 15875 15876 15877 15878 15879 15880 15881 15882 15883 15884 15885 15886 15887 15888 15889 15890 15891 15892 15893 15894 15895 15896 15897 15898 15899
#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 已提交
15900
    vshPrint(ctl, "%s", _(" Storage:"));
15901 15902 15903 15904 15905 15906 15907 15908 15909 15910 15911 15912 15913 15914 15915 15916 15917 15918 15919 15920 15921 15922 15923
#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 已提交
15924
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
15925
#ifdef WITH_SECDRIVER_APPARMOR
15926 15927 15928 15929 15930 15931 15932 15933 15934 15935 15936 15937 15938 15939 15940 15941 15942 15943 15944 15945 15946 15947 15948
    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 已提交
15949 15950 15951 15952
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
15953
static bool
15954
vshParseArgv(vshControl *ctl, int argc, char **argv)
15955
{
15956 15957
    bool help = false;
    int arg;
K
Karel Zak 已提交
15958
    struct option opt[] = {
E
Eric Blake 已提交
15959 15960 15961 15962 15963 15964 15965 15966 15967
        {"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}
15968 15969
    };

15970 15971 15972
    /* 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. */
15973
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
15974
        switch (arg) {
15975
        case 'd':
D
Daniel Veillard 已提交
15976
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
15977
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
15978 15979
                exit(EXIT_FAILURE);
            }
15980 15981
            break;
        case 'h':
15982
            help = true;
15983 15984
            break;
        case 'q':
E
Eric Blake 已提交
15985
            ctl->quiet = true;
15986 15987
            break;
        case 't':
E
Eric Blake 已提交
15988
            ctl->timing = true;
15989 15990 15991 15992
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
15993 15994 15995 15996 15997 15998
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
15999 16000 16001
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
16002
        case 'r':
E
Eric Blake 已提交
16003
            ctl->readonly = true;
16004
            break;
16005 16006 16007
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
16008
        default:
16009 16010
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
16011 16012 16013 16014
        }
    }

    if (help) {
16015 16016
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
16017 16018
            exit(EXIT_FAILURE);
        }
16019 16020 16021

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
16022
        exit(EXIT_SUCCESS);
16023 16024
    }

16025
    if (argc > optind) {
K
Karel Zak 已提交
16026
        /* parse command */
E
Eric Blake 已提交
16027
        ctl->imode = false;
16028
        if (argc - optind == 1) {
16029
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
16030
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
16031
        } else {
16032
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
16033 16034
        }
    }
E
Eric Blake 已提交
16035
    return true;
K
Karel Zak 已提交
16036 16037
}

16038 16039 16040 16041
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
16042
    char *defaultConn;
E
Eric Blake 已提交
16043
    bool ret = true;
K
Karel Zak 已提交
16044

16045 16046 16047
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
16048
    ctl->debug = VSH_DEBUG_DEFAULT;
16049

16050 16051
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
16052
        /* failure to setup locale is not fatal */
16053
    }
16054
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
16055
        perror("bindtextdomain");
E
Eric Blake 已提交
16056
        return EXIT_FAILURE;
16057
    }
16058
    if (!textdomain(PACKAGE)) {
16059
        perror("textdomain");
E
Eric Blake 已提交
16060
        return EXIT_FAILURE;
16061 16062
    }

16063 16064 16065 16066 16067
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

16068
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
16069 16070 16071
        progname = argv[0];
    else
        progname++;
16072

16073
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
16074
        ctl->name = vshStrdup(ctl, defaultConn);
16075 16076
    }

D
Daniel P. Berrange 已提交
16077 16078
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
16079
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
16080
    }
16081

D
Daniel P. Berrange 已提交
16082 16083
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
16084
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
16085
    }
16086

K
Karel Zak 已提交
16087
    if (!ctl->imode) {
16088
        ret = vshCommandRun(ctl, ctl->cmd);
16089
    } else {
K
Karel Zak 已提交
16090 16091
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
16092
            vshPrint(ctl,
16093
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
16094
                     progname);
J
Jim Meyering 已提交
16095
            vshPrint(ctl, "%s",
16096
                     _("Type:  'help' for help with commands\n"
16097
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
16098
        }
16099 16100 16101 16102 16103 16104

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
16105
        do {
16106
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
16107
            ctl->cmdstr =
16108
                vshReadline(ctl, prompt);
16109 16110
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
16111
            if (*ctl->cmdstr) {
16112
#if USE_READLINE
K
Karel Zak 已提交
16113
                add_history(ctl->cmdstr);
16114
#endif
16115
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
16116 16117
                    vshCommandRun(ctl, ctl->cmd);
            }
16118
            VIR_FREE(ctl->cmdstr);
16119
        } while (ctl->imode);
K
Karel Zak 已提交
16120

16121 16122
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
16123
    }
16124

K
Karel Zak 已提交
16125 16126
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
16127
}