virsh.c 457.4 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
/* "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;
1260
    const char *iface;
1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
    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;

1280
    if (vshCommandOptString(cmd, "interface", &iface) <= 0)
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
        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");

1332
                if (STRCASEEQ(mac, iface)) {
1333 1334 1335 1336 1337 1338 1339 1340 1341
                    VIR_FREE(mac);
                    goto hit;
                }
                VIR_FREE(mac);
            }
            cur = cur->next;
        }
    }

1342
    vshError(ctl, _("interface with address '%s' not found"), iface);
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
    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;
1424
    const char *iface = NULL;
1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441
    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;

1442
    if (vshCommandOptString (cmd, "interface", &iface) <= 0) {
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
        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");

1480
                if (STRCASEEQ(mac, iface)){
1481 1482 1483 1484 1485 1486 1487 1488
                    VIR_FREE(mac);
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }

1489
    vshError(ctl, _("Interface with address '%s' not found."), iface);
1490 1491 1492 1493 1494 1495 1496 1497 1498
    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");
1499
            vshPrint(ctl, "%s %s", iface, state);
1500 1501 1502 1503 1504 1505 1506 1507
            VIR_FREE(state);

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

    /* attribute not found */
1508
    vshPrint(ctl, "%s default", iface);
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519

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

    return ret;
}

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

1529
static const vshCmdOptDef opts_dommemstat[] = {
1530
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1531 1532 1533
    {NULL, 0, 0, NULL}
};

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

1542
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1543
        return false;
1544 1545

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1546
        return false;
1547 1548 1549 1550 1551

    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 已提交
1552
        return false;
1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567
    }

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

    virDomainFree(dom);
E
Eric Blake 已提交
1573
    return true;
1574 1575
}

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

1599
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1600
        return false;
1601 1602

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

1605
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1606
        virDomainFree(dom);
E
Eric Blake 已提交
1607
        return false;
1608 1609 1610 1611
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1612
        return false;
1613 1614 1615 1616 1617 1618 1619 1620 1621 1622
    }

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

1623 1624 1625 1626 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
/*
 * "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;
}

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

1712
static const vshCmdOptDef opts_suspend[] = {
1713
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1714
    {NULL, 0, 0, NULL}
1715 1716
};

E
Eric Blake 已提交
1717
static bool
1718
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1719
{
1720
    virDomainPtr dom;
1721
    const char *name;
E
Eric Blake 已提交
1722
    bool ret = true;
1723

1724
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1725
        return false;
1726

J
Jim Meyering 已提交
1727
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1728
        return false;
1729 1730

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

1737 1738 1739 1740
    virDomainFree(dom);
    return ret;
}

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

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

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

1772
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1773
        return false;
1774

1775
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1776
        return false;
1777

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

1781 1782
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1783 1784
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1785 1786

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1787
    VIR_FREE(buffer);
1788

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

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

1813
static const vshCmdOptDef opts_define[] = {
1814
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1815 1816 1817
    {NULL, 0, 0, NULL}
};

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

1826
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1827
        return false;
1828

1829
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1830
        return false;
1831

1832
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1833
        return false;
1834 1835

    dom = virDomainDefineXML(ctl->conn, buffer);
1836
    VIR_FREE(buffer);
1837

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

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

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

E
Eric Blake 已提交
1866
static bool
1867
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1868 1869
{
    virDomainPtr dom;
1870
    bool ret = false;
1871
    const char *name = NULL;
1872
    /* Flags to attempt.  */
E
Eric Blake 已提交
1873
    unsigned int flags = 0;
1874 1875 1876 1877
    /* User-requested actions.  */
    bool managed_save = vshCommandOptBool(cmd, "managed-save");
    bool snapshots_metadata = vshCommandOptBool(cmd, "snapshots-metadata");
    /* Positive if these items exist.  */
1878
    int has_managed_save = 0;
1879 1880 1881 1882 1883
    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;
1884
    int rc = -1;
1885
    int running;
1886

1887
    if (managed_save) {
1888
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
1889 1890 1891 1892 1893 1894
        managed_save_safe = true;
    }
    if (snapshots_metadata) {
        flags |= VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
1895

1896
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1897
        return false;
1898

1899
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1900
        return false;
1901

1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920
    /* 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;
            }
1921 1922
            virFreeError(last_error);
            last_error = NULL;
1923
            has_managed_save = 0;
1924 1925
        }

1926 1927
        has_snapshots = virDomainSnapshotNum(dom, 0);
        if (has_snapshots < 0) {
1928 1929
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941
                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.  */
1942 1943
                virFreeError(last_error);
                last_error = NULL;
1944 1945 1946 1947 1948
                has_snapshots_metadata = has_snapshots;
            } else {
                /* The server knew the new flag, all aspects of
                 * undefineFlags are safe.  */
                managed_save_safe = snapshots_safe = true;
1949
            }
1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962
        }
    }
    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;
    }
1963

1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
    /* 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;
    }
1978

1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990
    /* 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;
1991 1992 1993
        }
    }

1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007
    /* 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:
2008
    if (rc == 0) {
2009
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
2010
        ret = true;
2011
    } else {
2012
        vshError(ctl, _("Failed to undefine domain %s"), name);
2013 2014
    }

2015
cleanup:
2016
    virDomainFree(dom);
2017 2018 2019 2020 2021 2022 2023
    return ret;
}


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

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

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

2058
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2059
        return false;
2060

2061 2062
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
2063
        return false;
2064 2065

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

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

2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104
    /* 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 已提交
2105 2106
    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
2107
         : virDomainCreate(dom)) < 0) {
2108
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
2109
        goto cleanup;
2110
    }
2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122

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

    ret = true;

cleanup:
2123
    virDomainFree(dom);
2124 2125 2126
    return ret;
}

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

2136
static const vshCmdOptDef opts_save[] = {
2137
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2138 2139
    {"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")},
2140 2141
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2142 2143
    {"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")},
2144
    {NULL, 0, 0, NULL}
2145 2146
};

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

2158
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2159
        return false;
2160

2161
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
2162
        return false;
2163

2164 2165
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2166 2167 2168 2169
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2170

2171 2172 2173 2174 2175
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

2179 2180 2181 2182 2183 2184
    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
        goto cleanup;

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
2185
         : virDomainSave(dom, to)) < 0) {
2186
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
2187
        goto cleanup;
2188
    }
2189

2190 2191 2192 2193
    vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
    ret = true;

cleanup:
2194
    VIR_FREE(xml);
2195 2196 2197 2198
    virDomainFree(dom);
    return ret;
}

2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219
/*
 * "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 已提交
2220
    unsigned int flags = 0;
2221 2222 2223 2224 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
    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")},
2257 2258
    {"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")},
2259 2260 2261 2262 2263 2264 2265 2266 2267 2268
    {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;
2269 2270 2271 2272 2273 2274
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2275 2276 2277 2278 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

    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")},
2314 2315
    {"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")},
2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326
    {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;
2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342
    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;
    }
2343 2344 2345 2346 2347 2348 2349 2350

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

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

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

2369 2370 2371
    /* 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) {
2372 2373 2374 2375 2376 2377 2378
        vshPrint(ctl, _("Saved image %s XML configuration not changed.\n"),
                 file);
        ret = true;
        goto cleanup;
    }

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

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

static const vshCmdOptDef opts_managedsave[] = {
2411
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2412
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2413 2414
    {"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")},
2415 2416 2417
    {NULL, 0, 0, NULL}
};

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

2426
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2427
        return false;
2428

2429 2430
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2431 2432 2433 2434
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2435

2436
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2437
        return false;
2438

2439
    if (virDomainManagedSave(dom, flags) < 0) {
2440
        vshError(ctl, _("Failed to save domain %s state"), name);
2441
        goto cleanup;
2442 2443
    }

2444 2445 2446 2447
    vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    ret = true;

cleanup:
2448 2449 2450 2451
    virDomainFree(dom);
    return ret;
}

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

2474
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2475
        return false;
2476 2477

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2478
        return false;
2479 2480 2481

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

cleanup:
    virDomainFree(dom);
    return ret;
}

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

2515
static const vshCmdOptDef opts_schedinfo[] = {
2516 2517 2518 2519
    {"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")},
2520 2521 2522
    {"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")},
2523 2524 2525
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
2526
static int
2527
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
2528
                   virTypedParameterPtr param)
2529
{
2530
    const char *data = NULL;
2531 2532 2533

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

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

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

        if (!match)
            return 0;

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

2616 2617
    return 0;
}
2618

2619

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

2648
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2649
        return false;
2650

2651
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2652
        return false;
2653 2654 2655

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

2665
    if (nparams) {
2666
        params = vshMalloc(ctl, sizeof(*params) * nparams);
2667

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

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

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

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

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

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

2757
 cleanup:
2758
    VIR_FREE(params);
2759
    virDomainFree(dom);
2760
    return ret_val;
2761 2762
}

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

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

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

2792
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2793
        return false;
2794

2795
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2796
        return false;
2797

2798 2799
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2800 2801 2802 2803
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2804

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

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

cleanup:
2825
    VIR_FREE(xml);
2826 2827 2828
    return ret;
}

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

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

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

2857
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2858
        return false;
D
Daniel Veillard 已提交
2859

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

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

P
Paolo Bonzini 已提交
2866 2867
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
2868 2869
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;
2870 2871
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DUMP_BYPASS_CACHE;
2872

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

2878 2879 2880 2881
    vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
    ret = true;

cleanup:
D
Daniel Veillard 已提交
2882 2883 2884 2885
    virDomainFree(dom);
    return ret;
}

2886 2887 2888 2889 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
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;
}

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

3042
static const vshCmdOptDef opts_resume[] = {
3043
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3044
    {NULL, 0, 0, NULL}
3045 3046
};

E
Eric Blake 已提交
3047
static bool
3048
cmdResume(vshControl *ctl, const vshCmd *cmd)
3049
{
3050
    virDomainPtr dom;
E
Eric Blake 已提交
3051
    bool ret = true;
3052
    const char *name;
3053

3054
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3055
        return false;
3056

J
Jim Meyering 已提交
3057
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3058
        return false;
3059 3060

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

3067 3068 3069 3070
    virDomainFree(dom);
    return ret;
}

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

3080
static const vshCmdOptDef opts_shutdown[] = {
3081
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3082
    {NULL, 0, 0, NULL}
3083 3084
};

E
Eric Blake 已提交
3085
static bool
3086
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
3087
{
3088
    virDomainPtr dom;
E
Eric Blake 已提交
3089
    bool ret = true;
3090
    const char *name;
3091

3092
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3093
        return false;
3094

J
Jim Meyering 已提交
3095
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3096
        return false;
3097 3098

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

3105 3106 3107 3108
    virDomainFree(dom);
    return ret;
}

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

3118
static const vshCmdOptDef opts_reboot[] = {
3119
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3120 3121 3122
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3123
static bool
3124
cmdReboot(vshControl *ctl, const vshCmd *cmd)
3125 3126
{
    virDomainPtr dom;
E
Eric Blake 已提交
3127
    bool ret = true;
3128
    const char *name;
3129

3130
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3131
        return false;
3132

J
Jim Meyering 已提交
3133
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3134
        return false;
3135 3136

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

    virDomainFree(dom);
    return ret;
}

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

3157
static const vshCmdOptDef opts_destroy[] = {
3158
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3159
    {NULL, 0, 0, NULL}
3160 3161
};

E
Eric Blake 已提交
3162
static bool
3163
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
3164
{
3165
    virDomainPtr dom;
E
Eric Blake 已提交
3166
    bool ret = true;
3167
    const char *name;
3168

3169
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3170
        return false;
3171

J
Jim Meyering 已提交
3172
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3173
        return false;
3174 3175

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

3182
    virDomainFree(dom);
K
Karel Zak 已提交
3183 3184 3185 3186
    return ret;
}

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

3195
static const vshCmdOptDef opts_dominfo[] = {
3196
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3197
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3198 3199
};

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

3214
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3215
        return false;
K
Karel Zak 已提交
3216

J
Jim Meyering 已提交
3217
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3218
        return false;
3219

3220 3221
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3222
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
3223
    else
3224
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
3225 3226
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
3227
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
3228
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
3229 3230

    if ((str = virDomainGetOSType(dom))) {
3231
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
3232
        VIR_FREE(str);
3233 3234 3235
    }

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

3239
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
3240 3241

        if (info.cpuTime != 0) {
3242
            double cpuUsed = info.cpuTime;
3243

3244
            cpuUsed /= 1000000000.0;
3245

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

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

3256
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
3257 3258
                 info.memory);

K
Karel Zak 已提交
3259
    } else {
E
Eric Blake 已提交
3260
        ret = false;
K
Karel Zak 已提交
3261
    }
3262

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

3278 3279 3280 3281 3282 3283 3284
    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"));

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

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

            VIR_FREE(seclabel);
3318 3319
        }
    }
3320
    virDomainFree(dom);
K
Karel Zak 已提交
3321 3322 3323
    return ret;
}

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

static const vshCmdOptDef opts_domjobinfo[] = {
3334
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3335 3336 3337 3338
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
3339
static bool
3340 3341 3342 3343
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
3344
    bool ret = true;
3345

3346
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3347
        return false;
3348 3349

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

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

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

static const vshCmdOptDef opts_domjobabort[] = {
3417
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3418 3419 3420
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3421
static bool
3422 3423 3424
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3425
    bool ret = true;
3426

3427
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3428
        return false;
3429 3430

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
3434
        ret = false;
3435 3436 3437 3438 3439

    virDomainFree(dom);
    return ret;
}

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

3449
static const vshCmdOptDef opts_freecell[] = {
3450
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
3451
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
3452 3453 3454
    {NULL, 0, 0, NULL}
};

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

3472

3473
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3474
        return false;
3475

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

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

        if (nodes_cnt == -1) {
3504
            vshError(ctl, "%s", _("could not get information about "
3505
                                  "NUMA topology"));
3506 3507 3508
            goto cleanup;
        }

3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529
        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;
            }
        }

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

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

E
Eric Blake 已提交
3556
    func_ret = true;
3557

3558
cleanup:
3559
    xmlXPathFreeContext(ctxt);
3560
    xmlFreeDoc(xml);
3561
    VIR_FREE(nodes);
3562 3563 3564
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
3565
    return func_ret;
3566 3567
}

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

3588 3589
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
3590
        return false;
3591
    }
E
Eric Blake 已提交
3592 3593

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3594
        return false;
E
Eric Blake 已提交
3595 3596 3597

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

E
Eric Blake 已提交
3601
    return true;
E
Eric Blake 已提交
3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615
}

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

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

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

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

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3678
        return false;
E
Eric Blake 已提交
3679 3680

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

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

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

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

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

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

3821
static const vshCmdOptDef opts_vcpuinfo[] = {
3822
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3823 3824 3825
    {NULL, 0, 0, NULL}
};

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

3839
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3840
        return false;
3841

J
Jim Meyering 已提交
3842
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3843
        return false;
3844 3845 3846

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3847
        return false;
3848 3849 3850 3851
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3852
        return false;
3853 3854
    }

3855
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
3856 3857 3858
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
3859

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

E
Eric Blake 已提交
3890
            /* fallback plan to use virDomainGetVcpuPinInfo */
3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908

            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;
3909
        }
3910 3911
    }

3912
    VIR_FREE(cpumaps);
3913
    VIR_FREE(cpuinfo);
3914 3915 3916 3917 3918 3919 3920
    virDomainFree(dom);
    return ret;
}

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

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

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

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

3976
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3977
        return false;
3978

J
Jim Meyering 已提交
3979
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3980
        return false;
3981

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

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

3997 3998
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3999
        return false;
4000 4001 4002
    }

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

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

4014 4015
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
4016

4017 4018 4019 4020 4021 4022 4023 4024
    /* 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 已提交
4025
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
4026 4027 4028 4029 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
                                             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);
4071 4072
    /* Parse cpulist */
    cur = cpulist;
4073
    if (*cur == 0) {
4074
        goto parse_error;
4075 4076 4077
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
4078
        cur = "";
4079
    }
4080 4081 4082 4083 4084 4085 4086

    while (*cur != 0) {

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

4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100
        /* 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);
4101

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

4130 4131 4132 4133 4134 4135
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
4136
        } else {
4137
            goto parse_error;
4138
        }
4139
    }
4140

4141 4142 4143 4144 4145 4146 4147 4148
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
4149 4150
    }

4151
cleanup:
4152
    VIR_FREE(cpumap);
4153 4154
    virDomainFree(dom);
    return ret;
4155 4156 4157 4158 4159

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

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

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

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

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

4209
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4210
        return false;
4211

J
Jim Meyering 已提交
4212
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4213
        return false;
4214

4215 4216 4217 4218
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
4219

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

4230 4231
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

4232 4233 4234 4235 4236 4237 4238 4239
            /* 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 已提交
4240
                ret = false;
4241 4242 4243 4244 4245
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
4246
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
4247
            ret = false;
E
Eric Blake 已提交
4248
        }
4249 4250
    }

4251
  cleanup:
4252 4253 4254 4255
    virDomainFree(dom);
    return ret;
}

4256 4257 4258 4259 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
/*
 * "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;
}

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

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4301 4302
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT,
     N_("the codeset of keycodes, default:linux")},
4303
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
A
Alex Jia 已提交
4304
     N_("the time (in milliseconds) how long the keys will be held")},
4305 4306 4307 4308 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
    {"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;
}

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

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

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

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

4423
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4424
        return false;
4425

J
Jim Meyering 已提交
4426
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4427
        return false;
4428

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

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

4511
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4512
        return false;
4513

J
Jim Meyering 已提交
4514
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4515
        return false;
4516

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

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

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

4540 4541 4542 4543
    virDomainFree(dom);
    return ret;
}

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

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

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4595
        return false;
4596 4597

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

4600
    if ((rv = vshCommandOptInt(cmd, "weight", &weight)) < 0) {
4601 4602 4603 4604 4605
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

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

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4624
            ret = true;
4625 4626 4627 4628 4629
            goto cleanup;
        }

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

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

E
Eric Blake 已提交
4666
        ret = true;
4667 4668 4669 4670 4671 4672
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4673
            temp->type = VIR_TYPED_PARAM_UINT;
4674 4675 4676 4677 4678 4679 4680 4681

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

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

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

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

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4751
        return false;
4752 4753

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

4756 4757 4758 4759 4760 4761 4762 4763 4764
    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;
    }

4765 4766 4767 4768 4769 4770 4771 4772 4773
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

4774 4775 4776
    if (min_guarantee)
        nparams++;

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

4785 4786
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4787
            ret = true;
4788 4789 4790
            goto cleanup;
        }

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

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

E
Eric Blake 已提交
4832
        ret = true;
4833 4834
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
4835
        params = vshCalloc(ctl, nparams, sizeof(*params));
4836 4837 4838

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

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

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

  cleanup:
E
Eric Blake 已提交
4880
    VIR_FREE(params);
4881 4882 4883 4884
    virDomainFree(dom);
    return ret;
}

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

E
Eric Blake 已提交
4894
static bool
4895
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4896 4897
{
    virNodeInfo info;
4898

4899
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4900
        return false;
4901 4902

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

4918 4919 4920 4921 4922
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
4923
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
4924 4925 4926 4927 4928 4929 4930 4931 4932 4933
    {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
4934
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
4935 4936 4937 4938
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
4939 4940
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
4941 4942 4943 4944 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
    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;

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

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065
/*
 * "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;
5066 5067
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
5068 5069 5070 5071 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
    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;
}

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

E
Eric Blake 已提交
5117
static bool
5118
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5119 5120 5121
{
    char *caps;

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

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

E
Eric Blake 已提交
5132
    return true;
5133 5134
}

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

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

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

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
5167 5168
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
5169

5170
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5171
        return false;
5172

J
Jim Meyering 已提交
5173
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
5174
        return false;
5175

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

5184 5185 5186 5187
    virDomainFree(dom);
    return ret;
}

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

static const vshCmdOptDef opts_domxmlfromnative[] = {
5198 5199
    {"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")},
5200 5201 5202
    {NULL, 0, 0, NULL}
};

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

5213
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5214
        return false;
5215

5216 5217
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
5218
        return false;
5219

5220
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
5221
        return false;
5222 5223 5224

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

    return ret;
}

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

static const vshCmdOptDef opts_domxmltonative[] = {
5244 5245
    {"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")},
5246 5247 5248
    {NULL, 0, 0, NULL}
};

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

5259
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5260
        return false;
5261

5262 5263
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
5264
        return false;
5265

5266
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
5267
        return false;
5268 5269 5270

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

    return ret;
}

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

5289
static const vshCmdOptDef opts_domname[] = {
5290
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
5291
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5292 5293
};

E
Eric Blake 已提交
5294
static bool
5295
cmdDomname(vshControl *ctl, const vshCmd *cmd)
5296
{
K
Karel Zak 已提交
5297 5298
    virDomainPtr dom;

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

K
Karel Zak 已提交
5305 5306
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
5307
    return true;
K
Karel Zak 已提交
5308 5309 5310
}

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

5319
static const vshCmdOptDef opts_domid[] = {
5320
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
5321
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5322 5323
};

E
Eric Blake 已提交
5324
static bool
5325
cmdDomid(vshControl *ctl, const vshCmd *cmd)
5326
{
5327
    virDomainPtr dom;
5328
    unsigned int id;
K
Karel Zak 已提交
5329

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

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

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

5354
static const vshCmdOptDef opts_domuuid[] = {
5355
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
5356 5357 5358
    {NULL, 0, 0, NULL}
};

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

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

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

5376
    virDomainFree(dom);
E
Eric Blake 已提交
5377
    return true;
K
Karel Zak 已提交
5378 5379
}

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

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

5411 5412 5413 5414 5415 5416 5417 5418
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

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

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

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

J
Jim Meyering 已提交
5441
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
5442
        goto out;
5443

5444 5445
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
5446 5447
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
5448
        goto out;
5449
    }
5450

5451 5452 5453 5454 5455
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

5456 5457
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
5458 5459
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
5460
    if (vshCommandOptBool (cmd, "tunnelled"))
5461
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
5462

C
Chris Lalancette 已提交
5463 5464 5465 5466 5467
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

5468 5469 5470
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

5471 5472 5473 5474 5475 5476
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

5477 5478
    if (vshCommandOptBool (cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;
5479 5480 5481 5482 5483 5484

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


5485 5486 5487 5488
    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. */
5489

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

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

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
5503
        if (!dconn) goto out;
5504

5505
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
5506 5507
        if (ddom) {
            virDomainFree(ddom);
5508
            ret = '0';
5509 5510 5511
        }
        virConnectClose (dconn);
    }
5512

5513 5514 5515
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
5516
    if (dom) virDomainFree (dom);
5517
    VIR_FREE(xml);
5518 5519 5520
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

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

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

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

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
5571 5572

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

W
Wen Congyang 已提交
5575 5576 5577
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

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

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

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
5648
            functionReturn = false;
W
Wen Congyang 已提交
5649 5650 5651
            break;
        }

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

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

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
5680
    return functionReturn;
5681 5682
}

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

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

5705
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5706
        return false;
5707 5708

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

5711 5712
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
5713 5714 5715 5716 5717 5718 5719
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
5720
    ret = true;
5721 5722 5723 5724 5725 5726

done:
    virDomainFree(dom);
    return ret;
}

5727 5728 5729 5730 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
/*
 * "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;
}

5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809
/*
 * "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;
}

5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826
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))
5827
        goto cleanup;
5828 5829

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
5830
        goto cleanup;
5831 5832

    if (vshCommandOptString(cmd, "path", &path) < 0)
5833
        goto cleanup;
5834

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

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

5849
cleanup:
5850 5851
    if (dom)
        virDomainFree(dom);
5852 5853 5854 5855 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
    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;
}


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

5946
static const vshCmdOptDef opts_network_autostart[] = {
5947 5948
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
5949 5950 5951
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5952
static bool
5953
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
5954 5955
{
    virNetworkPtr network;
5956
    const char *name;
5957 5958
    int autostart;

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

J
Jim Meyering 已提交
5962
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5963
        return false;
5964 5965 5966 5967

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

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

5976
    if (autostart)
5977
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
5978
    else
5979
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
5980

L
Laine Stump 已提交
5981
    virNetworkFree(network);
E
Eric Blake 已提交
5982
    return true;
5983
}
K
Karel Zak 已提交
5984

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

5994
static const vshCmdOptDef opts_network_create[] = {
5995
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
5996 5997 5998
    {NULL, 0, 0, NULL}
};

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

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

6010
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6011
        return false;
6012

6013
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6014
        return false;
6015 6016

    network = virNetworkCreateXML(ctl->conn, buffer);
6017
    VIR_FREE(buffer);
6018

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


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

6040
static const vshCmdOptDef opts_network_define[] = {
6041
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
6042 6043 6044
    {NULL, 0, 0, NULL}
};

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

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

6056
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6057
        return false;
6058

6059
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6060
        return false;
6061 6062

    network = virNetworkDefineXML(ctl->conn, buffer);
6063
    VIR_FREE(buffer);
6064

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


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

6086
static const vshCmdOptDef opts_network_destroy[] = {
6087
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6088 6089 6090
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6091
static bool
6092
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
6093 6094
{
    virNetworkPtr network;
E
Eric Blake 已提交
6095
    bool ret = true;
6096
    const char *name;
6097

6098
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6099
        return false;
6100

J
Jim Meyering 已提交
6101
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6102
        return false;
6103 6104 6105 6106

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

6111
    virNetworkFree(network);
6112 6113 6114 6115 6116 6117 6118
    return ret;
}


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

6125
static const vshCmdOptDef opts_network_dumpxml[] = {
6126
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6127 6128 6129
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6130
static bool
6131
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
6132 6133
{
    virNetworkPtr network;
E
Eric Blake 已提交
6134
    bool ret = true;
6135 6136
    char *dump;

6137
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6138
        return false;
6139

J
Jim Meyering 已提交
6140
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
6141
        return false;
6142 6143 6144

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

    virNetworkFree(network);
    return ret;
}

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

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

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

6210
    VIR_FREE(bridge);
O
Osier Yang 已提交
6211
    virNetworkFree(network);
E
Eric Blake 已提交
6212
    return true;
O
Osier Yang 已提交
6213
}
6214

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

static const vshCmdOptDef opts_interface_edit[] = {
6225
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6226 6227 6228
    {NULL, 0, 0, NULL}
};

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

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

cleanup:
    if (iface)
        virInterfaceFree (iface);

6300 6301 6302
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
6303 6304 6305

    if (tmp) {
        unlink (tmp);
6306
        VIR_FREE(tmp);
6307 6308 6309 6310 6311
    }

    return ret;
}

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

6321
static const vshCmdOptDef opts_network_list[] = {
6322 6323
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
6324 6325 6326
    {NULL, 0, 0, NULL}
};

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

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

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

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

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

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

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

    for (i = 0; i < maxactive; i++) {
6386 6387
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
6388 6389
        const char *autostartStr;
        int autostart = 0;
6390 6391 6392

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6393
            VIR_FREE(activeNames[i]);
6394
            continue;
6395
        }
6396

6397 6398 6399
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6400
            autostartStr = autostart ? _("yes") : _("no");
6401 6402 6403 6404 6405

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

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6416
            VIR_FREE(inactiveNames[i]);
6417
            continue;
6418
        }
6419

6420 6421 6422
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6423
            autostartStr = autostart ? _("yes") : _("no");
6424

6425
        vshPrint(ctl, "%-20s %-10s %-10s\n",
6426 6427 6428
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
6429 6430

        virNetworkFree(network);
6431
        VIR_FREE(inactiveNames[i]);
6432
    }
6433 6434
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6435
    return true;
6436 6437 6438 6439 6440 6441
}


/*
 * "net-name" command
 */
6442
static const vshCmdInfo info_network_name[] = {
6443
    {"help", N_("convert a network UUID to network name")},
6444
    {"desc", ""},
6445 6446 6447
    {NULL, NULL}
};

6448
static const vshCmdOptDef opts_network_name[] = {
6449
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
6450 6451 6452
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6453
static bool
6454
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
6455 6456 6457
{
    virNetworkPtr network;

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

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
6466
    return true;
6467 6468 6469 6470 6471 6472
}


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

6479
static const vshCmdOptDef opts_network_start[] = {
6480
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
6481 6482 6483
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6484
static bool
6485
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
6486 6487
{
    virNetworkPtr network;
E
Eric Blake 已提交
6488
    bool ret = true;
6489

6490
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6491
        return false;
6492

J
Jim Meyering 已提交
6493
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
6494
         return false;
6495 6496 6497

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


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

6518
static const vshCmdOptDef opts_network_undefine[] = {
6519
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6520 6521 6522
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6523
static bool
6524
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
6525 6526
{
    virNetworkPtr network;
E
Eric Blake 已提交
6527
    bool ret = true;
6528
    const char *name;
6529

6530
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6531
        return false;
6532

J
Jim Meyering 已提交
6533
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6534
        return false;
6535 6536 6537 6538

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

L
Laine Stump 已提交
6543
    virNetworkFree(network);
6544 6545 6546 6547 6548 6549 6550
    return ret;
}


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

6557
static const vshCmdOptDef opts_network_uuid[] = {
6558
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
6559 6560 6561
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6562
static bool
6563
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
6564 6565 6566 6567
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

J
Jim Meyering 已提交
6571
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
6572
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6573
        return false;
6574 6575 6576 6577

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

L
Laine Stump 已提交
6580
    virNetworkFree(network);
E
Eric Blake 已提交
6581
    return true;
6582 6583 6584
}


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

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

6610
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6611
        return false;
6612 6613 6614 6615

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

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

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

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

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

    for (i = 0; i < maxactive; i++) {
6659 6660
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
6661 6662 6663

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6664
            VIR_FREE(activeNames[i]);
6665 6666 6667 6668 6669 6670 6671 6672
            continue;
        }

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

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
6681
            VIR_FREE(inactiveNames[i]);
6682 6683 6684 6685 6686 6687 6688 6689
            continue;
        }

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

}

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

static const vshCmdOptDef opts_interface_name[] = {
6708
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
6709 6710 6711
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6712
static bool
6713 6714 6715 6716
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6717
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6718
        return false;
6719 6720
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
6721
        return false;
6722 6723 6724

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6725
    return true;
6726 6727 6728 6729 6730 6731
}

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

static const vshCmdOptDef opts_interface_mac[] = {
6738
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
6739 6740 6741
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6742
static bool
6743 6744 6745 6746
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

6747
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6748
        return false;
6749 6750
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6751
        return false;
6752 6753 6754

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
6755
    return true;
6756 6757 6758 6759 6760 6761
}

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

static const vshCmdOptDef opts_interface_dumpxml[] = {
6768 6769
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
6770 6771 6772
    {NULL, 0, 0, NULL}
};

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

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
6784

6785
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6786
        return false;
6787 6788

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

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

    virInterfaceFree(iface);
    return ret;
}

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

static const vshCmdOptDef opts_interface_define[] = {
6813
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
6814 6815 6816
    {NULL, 0, 0, NULL}
};

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

6825
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6826
        return false;
6827

6828
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6829
        return false;
6830 6831

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

6834
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
6835
    VIR_FREE(buffer);
6836

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

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

static const vshCmdOptDef opts_interface_undefine[] = {
6858
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6859 6860 6861
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6862
static bool
6863 6864 6865
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6866
    bool ret = true;
6867
    const char *name;
6868

6869
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6870
        return false;
6871 6872

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6873
        return false;
6874 6875 6876 6877

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

    virInterfaceFree(iface);
    return ret;
}

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

static const vshCmdOptDef opts_interface_start[] = {
6896
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6897 6898 6899
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6900
static bool
6901 6902 6903
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6904
    bool ret = true;
6905
    const char *name;
6906

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

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6911
        return false;
6912 6913 6914 6915

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

    virInterfaceFree(iface);
    return ret;
}

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

static const vshCmdOptDef opts_interface_destroy[] = {
6934
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6935 6936 6937
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6938
static bool
6939 6940 6941
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
6942
    bool ret = true;
6943
    const char *name;
6944

6945
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6946
        return false;
6947 6948

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
6949
        return false;
6950 6951 6952 6953

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

    virInterfaceFree(iface);
    return ret;
}

6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 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
/*
 * "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;
}
7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061

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

7070
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7071
        return false;
7072

7073
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7074
        return false;
7075 7076

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
7077
        return false;
7078 7079 7080 7081 7082 7083 7084 7085 7086 7087

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

7115
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7116
        return false;
7117 7118

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
7119
        return false;
7120 7121 7122 7123 7124

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

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

7154
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7155
        return false;
7156 7157

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
7158
        return false;
7159 7160 7161

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

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

7192
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7193
        return false;
7194 7195 7196 7197

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

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

    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 已提交
7235
    return true;
7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252
}


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

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

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


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

7347
static const vshCmdOptDef opts_pool_autostart[] = {
7348 7349
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
7350 7351
    {NULL, 0, 0, NULL}
};
7352

E
Eric Blake 已提交
7353
static bool
7354
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
7355
{
7356
    virStoragePoolPtr pool;
7357
    const char *name;
7358
    int autostart;
7359

7360
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7361
        return false;
7362

7363
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7364
        return false;
7365

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

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

7377
    if (autostart)
7378
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
7379
    else
7380
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
7381

L
Laine Stump 已提交
7382
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7383
    return true;
7384 7385
}

7386
/*
7387
 * "pool-create" command
7388
 */
7389
static const vshCmdInfo info_pool_create[] = {
7390 7391
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
7392 7393 7394
    {NULL, NULL}
};

7395
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
7396
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
7397
     N_("file containing an XML pool description")},
7398 7399 7400
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7401
static bool
7402
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
7403
{
7404
    virStoragePoolPtr pool;
7405
    const char *from = NULL;
E
Eric Blake 已提交
7406
    bool ret = true;
7407
    char *buffer;
7408

7409
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7410
        return false;
7411

7412
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7413
        return false;
7414

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

7418
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
7419
    VIR_FREE(buffer);
7420 7421 7422 7423

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7424
        virStoragePoolFree(pool);
7425
    } else {
7426
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
7427
        ret = false;
7428 7429
    }
    return ret;
7430 7431
}

7432

7433 7434 7435 7436
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
7437
    {"help", N_("create a device defined "
7438
                          "by an XML file on the node")},
7439
    {"desc", N_("Create a device on the node.  Note that this "
7440 7441 7442 7443 7444 7445 7446
                          "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,
7447
     N_("file containing an XML description of the device")},
7448 7449 7450
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7451
static bool
7452 7453 7454
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
7455
    const char *from = NULL;
E
Eric Blake 已提交
7456
    bool ret = true;
7457 7458
    char *buffer;

7459
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7460
        return false;
7461

7462
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7463
        return false;
7464

7465
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
7466
        return false;
7467 7468

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
7469
    VIR_FREE(buffer);
7470 7471 7472 7473

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
7474
        virNodeDeviceFree(dev);
7475
    } else {
7476
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
7477
        ret = false;
7478 7479 7480 7481 7482 7483 7484 7485 7486 7487
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
7488
    {"help", N_("destroy (stop) a device on the node")},
7489
    {"desc", N_("Destroy a device on the node.  Note that this "
7490
                "command destroys devices on the physical host")},
7491 7492 7493 7494 7495
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
7496
     N_("name of the device to be destroyed")},
7497 7498 7499
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7500
static bool
7501 7502 7503
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
7504
    bool ret = true;
7505
    const char *name = NULL;
7506

7507
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
7508
        return false;
7509 7510
    }

7511
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
7512
        return false;
7513 7514 7515 7516 7517 7518

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
7519
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
7520
        ret = false;
7521 7522 7523 7524 7525 7526 7527
    }

    virNodeDeviceFree(dev);
    return ret;
}


7528
/*
7529
 * XML Building helper for pool-define-as and pool-create-as
7530
 */
7531
static const vshCmdOptDef opts_pool_X_as[] = {
7532 7533 7534 7535 7536 7537 7538 7539
    {"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")},
7540
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
7541 7542 7543
    {NULL, 0, 0, NULL}
};

7544
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
7545

7546 7547
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
7548
    virBuffer buf = VIR_BUFFER_INITIALIZER;
7549

7550
    if (vshCommandOptString(cmd, "name", &name) <= 0)
7551
        goto cleanup;
7552
    if (vshCommandOptString(cmd, "type", &type) <= 0)
7553 7554
        goto cleanup;

7555 7556 7557 7558 7559
    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 ||
7560 7561
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
7562
        goto cleanup;
7563
    }
7564

7565 7566
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
7567
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
7568
        virBufferAddLit(&buf, "  <source>\n");
7569

7570
        if (srcHost)
7571
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
7572
        if (srcPath)
7573
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
7574
        if (srcDev)
7575
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
7576
        if (srcFormat)
7577
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
7578
        if (srcName)
7579
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
7580 7581

        virBufferAddLit(&buf, "  </source>\n");
7582 7583
    }
    if (target) {
7584
        virBufferAddLit(&buf, "  <target>\n");
7585
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
7586
        virBufferAddLit(&buf, "  </target>\n");
7587
    }
7588 7589 7590 7591
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7592
        return false;
7593
    }
7594 7595 7596

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
7597
    return true;
7598 7599

cleanup:
7600
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7601
    return false;
7602 7603 7604 7605 7606 7607
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
7608 7609
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
7610 7611 7612
    {NULL, NULL}
};

E
Eric Blake 已提交
7613
static bool
7614 7615 7616
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
7617 7618
    const char *name;
    char *xml;
7619
    int printXML = vshCommandOptBool(cmd, "print-xml");
7620

7621
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7622
        return false;
7623 7624

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

7627
    if (printXML) {
7628
        vshPrint(ctl, "%s", xml);
7629
        VIR_FREE(xml);
7630
    } else {
7631
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
7632
        VIR_FREE(xml);
7633

7634 7635 7636 7637
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
7638
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
7639
            return false;
7640 7641
        }
    }
E
Eric Blake 已提交
7642
    return true;
7643 7644
}

7645

7646
/*
7647
 * "pool-define" command
7648
 */
7649
static const vshCmdInfo info_pool_define[] = {
7650 7651
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
7652 7653 7654
    {NULL, NULL}
};

7655
static const vshCmdOptDef opts_pool_define[] = {
7656
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
7657 7658 7659
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7660
static bool
7661
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
7662
{
7663
    virStoragePoolPtr pool;
7664
    const char *from = NULL;
E
Eric Blake 已提交
7665
    bool ret = true;
7666
    char *buffer;
7667

7668
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7669
        return false;
7670

7671
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7672
        return false;
7673

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

7677
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
7678
    VIR_FREE(buffer);
7679 7680 7681 7682

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
7683
        virStoragePoolFree(pool);
7684
    } else {
7685
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
7686
        ret = false;
7687 7688
    }
    return ret;
7689 7690
}

7691

7692 7693 7694
/*
 * "pool-define-as" command
 */
7695
static const vshCmdInfo info_pool_define_as[] = {
7696 7697
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
7698 7699 7700
    {NULL, NULL}
};

E
Eric Blake 已提交
7701
static bool
7702
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
7703 7704
{
    virStoragePoolPtr pool;
7705 7706
    const char *name;
    char *xml;
7707
    int printXML = vshCommandOptBool(cmd, "print-xml");
7708

7709
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7710
        return false;
7711

7712
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
7713
        return false;
7714

7715
    if (printXML) {
7716
        vshPrint(ctl, "%s", xml);
7717
        VIR_FREE(xml);
7718
    } else {
7719
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
7720
        VIR_FREE(xml);
7721

7722 7723 7724 7725
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
7726
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
7727
            return false;
7728 7729
        }
    }
E
Eric Blake 已提交
7730
    return true;
7731 7732 7733
}


7734
/*
7735
 * "pool-build" command
7736
 */
7737
static const vshCmdInfo info_pool_build[] = {
7738 7739
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
7740 7741 7742
    {NULL, NULL}
};

7743
static const vshCmdOptDef opts_pool_build[] = {
7744
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7745 7746
    {"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")},
7747 7748 7749
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7750
static bool
7751
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
7752
{
7753
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7754
    bool ret = true;
7755
    const char *name;
7756
    unsigned int flags = 0;
7757

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

7761
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7762
        return false;
7763

7764 7765 7766 7767 7768 7769 7770 7771 7772
    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) {
7773
        vshPrint(ctl, _("Pool %s built\n"), name);
7774
    } else {
7775
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
7776
        ret = false;
7777 7778
    }

7779 7780
    virStoragePoolFree(pool);

7781 7782 7783
    return ret;
}

7784
/*
7785
 * "pool-destroy" command
7786
 */
7787
static const vshCmdInfo info_pool_destroy[] = {
7788 7789 7790
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
7791 7792 7793
    {NULL, NULL}
};

7794
static const vshCmdOptDef opts_pool_destroy[] = {
7795
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7796 7797 7798
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7799
static bool
7800
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
7801
{
7802
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7803
    bool ret = true;
7804
    const char *name;
7805

7806
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7807
        return false;
7808

7809
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7810
        return false;
7811

7812 7813 7814
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
7815
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
7816
        ret = false;
7817 7818
    }

7819
    virStoragePoolFree(pool);
7820 7821 7822
    return ret;
}

7823

7824
/*
7825 7826
 * "pool-delete" command
 */
7827
static const vshCmdInfo info_pool_delete[] = {
7828 7829
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
7830 7831 7832
    {NULL, NULL}
};

7833
static const vshCmdOptDef opts_pool_delete[] = {
7834
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7835 7836 7837
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7838
static bool
7839
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
7840 7841
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7842
    bool ret = true;
7843
    const char *name;
7844

7845
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7846
        return false;
7847 7848

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7849
        return false;
7850 7851

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
7852
        vshPrint(ctl, _("Pool %s deleted\n"), name);
7853
    } else {
7854
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
7855
        ret = false;
7856 7857
    }

L
Laine Stump 已提交
7858
    virStoragePoolFree(pool);
7859 7860 7861 7862 7863 7864 7865
    return ret;
}


/*
 * "pool-refresh" command
 */
7866
static const vshCmdInfo info_pool_refresh[] = {
7867 7868
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
7869 7870 7871
    {NULL, NULL}
};

7872
static const vshCmdOptDef opts_pool_refresh[] = {
7873
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7874 7875 7876
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7877
static bool
7878
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
7879 7880
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7881
    bool ret = true;
7882
    const char *name;
7883

7884
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7885
        return false;
7886 7887

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7888
        return false;
7889 7890 7891 7892

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
7893
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
7894
        ret = false;
7895 7896 7897 7898 7899 7900 7901 7902 7903 7904
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
7905
static const vshCmdInfo info_pool_dumpxml[] = {
7906 7907
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
7908 7909 7910
    {NULL, NULL}
};

7911
static const vshCmdOptDef opts_pool_dumpxml[] = {
7912
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7913 7914 7915
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7916
static bool
7917
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
7918 7919
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7920
    bool ret = true;
7921 7922
    char *dump;

7923
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7924
        return false;
7925 7926

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7927
        return false;
7928 7929 7930

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
7931
        vshPrint(ctl, "%s", dump);
7932
        VIR_FREE(dump);
7933
    } else {
E
Eric Blake 已提交
7934
        ret = false;
7935 7936 7937 7938 7939 7940 7941 7942 7943 7944
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
7945
static const vshCmdInfo info_pool_list[] = {
7946 7947
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
7948 7949 7950
    {NULL, NULL}
};

7951
static const vshCmdOptDef opts_pool_list[] = {
7952 7953
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
7954
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
7955 7956 7957
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7958
static bool
7959
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7960
{
7961 7962
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
7963 7964
    int i, ret;
    bool functionReturn;
7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980
    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 */
7981
    int all = vshCommandOptBool(cmd, "all");
7982 7983
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
7984 7985 7986
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

7987
    /* Check the connection to libvirtd daemon is still working */
7988
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7989
        return false;
7990

7991
    /* Retrieve the number of active storage pools */
7992
    if (active) {
7993 7994
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
7995
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
7996
            return false;
7997 7998
        }
    }
7999 8000

    /* Retrieve the number of inactive storage pools */
8001
    if (inactive) {
8002 8003
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
8004
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
8005
            return false;
8006
        }
8007
    }
8008

8009 8010
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
8011

8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023
    /* 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 已提交
8024
            return false;
8025 8026 8027
        }
    }

8028 8029 8030 8031 8032 8033 8034 8035
    /* 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 已提交
8036
            return false;
8037 8038
        }
    }
8039

8040 8041 8042 8043 8044 8045 8046 8047 8048 8049
    /* 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]);
8050
        if (!pool) {
8051
            VIR_FREE(poolNames[i]);
8052 8053 8054
            continue;
        }

8055
        /* Retrieve the autostart status of the pool */
8056
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
8057
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
8058
        else
8059 8060 8061 8062 8063 8064
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
8065 8066
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077
            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;
        }
8078

8079 8080 8081 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
        /* 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 */
8191 8192 8193
        virStoragePoolFree(pool);
    }

8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211
    /* 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);
8212 8213
        }

8214
        /* Cleanup and return */
E
Eric Blake 已提交
8215
        functionReturn = true;
8216 8217
        goto cleanup;
    }
8218

8219 8220 8221 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
    /* 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. */
8257
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
8258
             (unsigned long) nameStrLength);
8259
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
8260
             (unsigned long) stateStrLength);
8261
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
8262
             (unsigned long) autostartStrLength);
8263
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
8264
             (unsigned long) persistStrLength);
8265
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
8266
             (unsigned long) capStrLength);
8267
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
8268
             (unsigned long) allocStrLength);
8269
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
8270 8271 8272 8273 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
             (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 已提交
8313
    functionReturn = true;
8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327
    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 已提交
8328
    functionReturn = false;
8329

8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341
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]);
8342
    }
8343 8344 8345 8346 8347 8348 8349

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

    /* Return the desired value */
    return functionReturn;
8350 8351
}

8352 8353 8354 8355
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
8356 8357
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
8358 8359 8360 8361 8362
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
8363 8364 8365
     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")},
8366
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
8367 8368 8369
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8370
static bool
8371 8372
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
8373
    const char *type = NULL, *host = NULL;
8374 8375
    char *srcSpec = NULL;
    char *srcList;
8376
    const char *initiator = NULL;
8377

8378 8379
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
8380 8381
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
8382
        return false;
8383
    }
8384

8385
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8386
        return false;
8387 8388

    if (host) {
8389
        const char *port = NULL;
8390
        virBuffer buf = VIR_BUFFER_INITIALIZER;
8391 8392 8393 8394

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
8395
            return false;
8396
        }
8397
        virBufferAddLit(&buf, "<source>\n");
8398
        virBufferAsprintf(&buf, "  <host name='%s'", host);
8399
        if (port)
8400
            virBufferAsprintf(&buf, " port='%s'", port);
8401
        virBufferAddLit(&buf, "/>\n");
8402 8403
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
8404
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
8405 8406
            virBufferAddLit(&buf, "  </initiator>\n");
        }
8407 8408 8409
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
8410
            return false;
8411
        }
8412
        srcSpec = virBufferContentAndReset(&buf);
8413 8414 8415
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
8416
    VIR_FREE(srcSpec);
8417
    if (srcList == NULL) {
8418
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
8419
        return false;
8420 8421
    }
    vshPrint(ctl, "%s", srcList);
8422
    VIR_FREE(srcList);
8423

E
Eric Blake 已提交
8424
    return true;
8425 8426 8427 8428 8429 8430 8431
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
8432 8433
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
8434 8435 8436 8437 8438
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
8439
     N_("type of storage pool sources to discover")},
8440
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
8441
     N_("optional file of source xml to query for pools")},
8442 8443 8444
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8445
static bool
8446 8447
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
8448
    const char *type = NULL, *srcSpecFile = NULL;
8449
    char *srcSpec = NULL, *srcList;
8450

8451
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
8452
        return false;
8453

8454 8455
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
8456
        return false;
8457
    }
8458

8459
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8460
        return false;
8461 8462

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
8463
        return false;
8464 8465

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
8466
    VIR_FREE(srcSpec);
8467
    if (srcList == NULL) {
8468
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
8469
        return false;
8470 8471
    }
    vshPrint(ctl, "%s", srcList);
8472
    VIR_FREE(srcList);
8473

E
Eric Blake 已提交
8474
    return true;
8475 8476 8477
}


8478 8479 8480
/*
 * "pool-info" command
 */
8481
static const vshCmdInfo info_pool_info[] = {
8482 8483
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
8484 8485 8486
    {NULL, NULL}
};

8487
static const vshCmdOptDef opts_pool_info[] = {
8488
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8489 8490 8491
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8492
static bool
8493
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
8494 8495 8496
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
8497 8498
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
8499
    bool ret = true;
8500 8501
    char uuid[VIR_UUID_STRING_BUFLEN];

8502
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8503
        return false;
8504 8505

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8506
        return false;
8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532

    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;
8533 8534 8535 8536
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
8537 8538
        }

8539 8540
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
8541 8542
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
8543 8544 8545 8546 8547 8548 8549
        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);
8550 8551
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
8552 8553 8554 8555 8556
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568
        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 已提交
8569
        ret = false;
8570 8571 8572 8573 8574 8575 8576 8577 8578 8579
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
8580
static const vshCmdInfo info_pool_name[] = {
8581
    {"help", N_("convert a pool UUID to pool name")},
8582
    {"desc", ""},
8583 8584 8585
    {NULL, NULL}
};

8586
static const vshCmdOptDef opts_pool_name[] = {
8587
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
8588 8589 8590
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8591
static bool
8592
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
8593 8594 8595
{
    virStoragePoolPtr pool;

8596
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8597
        return false;
8598
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8599
                                           VSH_BYUUID)))
E
Eric Blake 已提交
8600
        return false;
8601 8602 8603

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8604
    return true;
8605 8606 8607 8608 8609 8610
}


/*
 * "pool-start" command
 */
8611
static const vshCmdInfo info_pool_start[] = {
8612 8613
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
8614 8615 8616
    {NULL, NULL}
};

8617
static const vshCmdOptDef opts_pool_start[] = {
8618
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
8619 8620 8621
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8622
static bool
8623
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
8624 8625
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8626
    bool ret = true;
8627

8628
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8629
        return false;
8630

8631
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
8632
         return false;
8633 8634 8635 8636 8637

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
8638
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
8639
        ret = false;
8640
    }
L
Laine Stump 已提交
8641 8642

    virStoragePoolFree(pool);
8643 8644 8645 8646
    return ret;
}


8647 8648 8649
/*
 * "vol-create-as" command
 */
8650
static const vshCmdInfo info_vol_create_as[] = {
8651 8652
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
8653 8654 8655
    {NULL, NULL}
};

8656
static const vshCmdOptDef opts_vol_create_as[] = {
8657 8658 8659 8660 8661
    {"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")},
8662 8663
    {"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")},
8664 8665 8666 8667 8668 8669 8670 8671 8672 8673
    {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 已提交
8674
        /* Deliberate fallthrough cases here :-) */
8675 8676 8677
        switch (*end) {
        case 'T':
            *val *= 1024;
8678
            /* fallthrough */
8679 8680
        case 'G':
            *val *= 1024;
8681
            /* fallthrough */
8682 8683
        case 'M':
            *val *= 1024;
8684
            /* fallthrough */
8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
8698
static bool
8699
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
8700 8701 8702
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8703
    char *xml;
8704 8705
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
8706
    unsigned long long capacity, allocation = 0;
8707
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8708

8709
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8710
        return false;
8711 8712 8713

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

8716
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8717 8718
        goto cleanup;

8719
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
8720 8721
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
8722
        vshError(ctl, _("Malformed size %s"), capacityStr);
8723

8724 8725
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
8726
        vshError(ctl, _("Malformed size %s"), allocationStr);
8727

8728 8729 8730 8731 8732 8733 8734
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

8735

8736
    virBufferAddLit(&buf, "<volume>\n");
8737 8738
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
8739
    if (allocationStr)
8740
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
8741 8742

    if (format) {
8743
        virBufferAddLit(&buf, "  <target>\n");
8744
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
8745
        virBufferAddLit(&buf, "  </target>\n");
8746
    }
8747

8748 8749 8750 8751
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
8752 8753
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
8754 8755 8756
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
8757 8758
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
8759 8760 8761 8762 8763
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
8764 8765
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
8766 8767 8768
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
8769 8770
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
8771 8772 8773 8774 8775
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
8776 8777
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
8778 8779 8780
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
8781 8782
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
8783 8784 8785 8786
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
8787
            goto cleanup;
8788 8789 8790 8791 8792
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
8793
            goto cleanup;
8794 8795 8796 8797
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
8798
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
8799
        if (snapshotStrFormat)
8800
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
8801 8802 8803 8804 8805 8806 8807 8808
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

8810 8811
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
8812
        goto cleanup;
8813 8814 8815
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
8816
    VIR_FREE(xml);
8817 8818 8819 8820 8821
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
8822
        return true;
8823
    } else {
8824
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
8825
        return false;
8826 8827 8828
    }

 cleanup:
8829
    virBufferFreeAndReset(&buf);
8830
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8831
    return false;
8832 8833 8834
}


8835 8836 8837
/*
 * "pool-undefine" command
 */
8838
static const vshCmdInfo info_pool_undefine[] = {
8839 8840
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
8841 8842 8843
    {NULL, NULL}
};

8844
static const vshCmdOptDef opts_pool_undefine[] = {
8845
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8846 8847 8848
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8849
static bool
8850
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
8851 8852
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8853
    bool ret = true;
8854
    const char *name;
8855

8856
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8857
        return false;
8858 8859

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8860
        return false;
8861 8862 8863 8864

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

L
Laine Stump 已提交
8869
    virStoragePoolFree(pool);
8870 8871 8872 8873 8874 8875 8876
    return ret;
}


/*
 * "pool-uuid" command
 */
8877
static const vshCmdInfo info_pool_uuid[] = {
8878
    {"help", N_("convert a pool name to pool UUID")},
8879
    {"desc", ""},
8880 8881 8882
    {NULL, NULL}
};

8883
static const vshCmdOptDef opts_pool_uuid[] = {
8884
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
8885 8886 8887
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8888
static bool
8889
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
8890 8891 8892 8893
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
8898
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8899
        return false;
8900 8901 8902 8903

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

L
Laine Stump 已提交
8906
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8907
    return true;
8908 8909 8910 8911 8912 8913
}


/*
 * "vol-create" command
 */
8914
static const vshCmdInfo info_vol_create[] = {
8915 8916
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
8917 8918 8919
    {NULL, NULL}
};

8920
static const vshCmdOptDef opts_vol_create[] = {
8921 8922
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
8923 8924 8925
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8926
static bool
8927
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
8928 8929 8930
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8931
    const char *from = NULL;
E
Eric Blake 已提交
8932
    bool ret = true;
8933 8934
    char *buffer;

8935
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8936
        return false;
8937 8938

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

8942
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
8943
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8944
        return false;
8945 8946 8947
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
8948
        virshReportError(ctl);
8949
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8950
        return false;
8951 8952 8953
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
8954
    VIR_FREE(buffer);
8955 8956 8957 8958 8959 8960 8961
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
8962
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
8963
        ret = false;
8964 8965 8966 8967
    }
    return ret;
}

8968 8969 8970 8971
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
8972 8973
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
8974 8975 8976 8977
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
8978 8979 8980
    {"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 已提交
8981
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
8982 8983 8984
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8985
static bool
8986 8987 8988 8989
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
8990
    const char *from = NULL;
E
Eric Blake 已提交
8991
    bool ret = false;
8992 8993
    char *buffer = NULL;

8994
    if (!vshConnectionUsability(ctl, ctl->conn))
8995 8996 8997 8998 8999
        goto cleanup;

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

9000
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9001 9002 9003 9004 9005 9006 9007
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9008
        virshReportError(ctl);
9009 9010 9011 9012 9013 9014 9015 9016 9017
        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 {
9018
        vshError(ctl, _("Failed to create vol from %s"), from);
9019 9020 9021
        goto cleanup;
    }

E
Eric Blake 已提交
9022
    ret = true;
9023
cleanup:
9024
    VIR_FREE(buffer);
9025 9026 9027 9028
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
9029 9030
    if (newvol)
        virStorageVolFree(newvol);
9031 9032 9033 9034
    return ret;
}

static xmlChar *
9035
makeCloneXML(const char *origxml, const char *newname) {
9036

9037 9038 9039
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
9040 9041 9042
    xmlChar *newxml = NULL;
    int size;

9043
    doc = virXMLParseStringCtxt(origxml, "domain.xml", &ctxt);
9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065
    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[] = {
9066 9067
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
9068 9069 9070 9071
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
9072 9073
    {"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 已提交
9074
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9075 9076 9077
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9078
static bool
9079 9080 9081 9082
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
9083
    const char *name = NULL;
9084
    char *origxml = NULL;
9085
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
9086
    bool ret = false;
9087

9088
    if (!vshConnectionUsability(ctl, ctl->conn))
9089 9090 9091 9092 9093 9094 9095
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
9096
        vshError(ctl, "%s", _("failed to get parent pool"));
9097 9098 9099
        goto cleanup;
    }

9100
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118
        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 {
9119
        vshError(ctl, _("Failed to clone vol from %s"),
9120 9121 9122 9123
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
9124
    ret = true;
9125 9126

cleanup:
9127
    VIR_FREE(origxml);
9128 9129 9130
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
9131 9132
    if (newvol)
        virStorageVolFree(newvol);
9133 9134 9135 9136 9137
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150

/*
 * "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 已提交
9151
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165
    {"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 已提交
9166
static bool
9167 9168 9169 9170
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
9171
    bool ret = false;
9172 9173 9174 9175 9176 9177 9178 9179 9180 9181
    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 已提交
9182
        return false;
9183 9184 9185 9186
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
9187
        return false;
9188 9189 9190
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9191
        return false;
9192 9193 9194 9195 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
    }

    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 已提交
9226
    ret = true;
9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250

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 已提交
9251
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9252 9253 9254 9255 9256
    {"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 已提交
9257
static bool
9258 9259 9260 9261
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
9262
    bool ret = false;
9263 9264 9265 9266
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
9267
    bool created = false;
9268 9269

    if (!vshConnectionUsability(ctl, ctl->conn))
9270
        return false;
9271 9272 9273

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
9274
        return false;
9275 9276 9277 9278
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
9279
        return false;
9280 9281 9282
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
9283
        return false;
9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295

    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;
        }
9296 9297
    } else {
        created = true;
9298 9299 9300 9301 9302 9303 9304 9305
    }

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

9306
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321
        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 已提交
9322
    ret = true;
9323 9324

cleanup:
9325
    VIR_FORCE_CLOSE(fd);
9326
    if (!ret && created)
9327 9328 9329 9330 9331 9332 9333 9334 9335
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


9336 9337 9338
/*
 * "vol-delete" command
 */
9339
static const vshCmdInfo info_vol_delete[] = {
9340 9341
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
9342 9343 9344
    {NULL, NULL}
};

9345
static const vshCmdOptDef opts_vol_delete[] = {
9346
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9347
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9348 9349 9350
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9351
static bool
9352
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
9353 9354
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9355
    bool ret = true;
9356
    const char *name;
9357

9358
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9359
        return false;
9360 9361

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9362
        return false;
9363 9364 9365
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
9366
        vshPrint(ctl, _("Vol %s deleted\n"), name);
9367
    } else {
9368
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
9369
        ret = false;
9370 9371
    }

L
Laine Stump 已提交
9372
    virStorageVolFree(vol);
9373 9374 9375 9376
    return ret;
}


D
David Allan 已提交
9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387
/*
 * "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 已提交
9388
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
9389 9390 9391
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9392
static bool
D
David Allan 已提交
9393 9394 9395
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9396
    bool ret = true;
9397
    const char *name;
D
David Allan 已提交
9398

9399
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9400
        return false;
D
David Allan 已提交
9401 9402

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9403
        return false;
D
David Allan 已提交
9404 9405 9406 9407 9408 9409
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
9410
        ret = false;
D
David Allan 已提交
9411 9412 9413 9414 9415 9416 9417
    }

    virStorageVolFree(vol);
    return ret;
}


9418 9419 9420
/*
 * "vol-info" command
 */
9421
static const vshCmdInfo info_vol_info[] = {
9422 9423
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
9424 9425 9426
    {NULL, NULL}
};

9427
static const vshCmdOptDef opts_vol_info[] = {
9428
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9429
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9430 9431 9432
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9433
static bool
9434
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
9435 9436 9437
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
9438
    bool ret = true;
9439

9440
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9441
        return false;
9442 9443

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9444
        return false;
9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460

    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 已提交
9461
        ret = false;
9462 9463 9464 9465 9466 9467 9468 9469 9470 9471
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
9472
static const vshCmdInfo info_vol_dumpxml[] = {
9473 9474
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
9475 9476 9477
    {NULL, NULL}
};

9478
static const vshCmdOptDef opts_vol_dumpxml[] = {
9479
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
9480
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9481 9482 9483
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9484
static bool
9485
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
9486 9487
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
9488
    bool ret = true;
9489 9490
    char *dump;

9491
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9492
        return false;
9493 9494

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9495
        return false;
9496 9497 9498

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
9499
        vshPrint(ctl, "%s", dump);
9500
        VIR_FREE(dump);
9501
    } else {
E
Eric Blake 已提交
9502
        ret = false;
9503 9504 9505 9506 9507 9508 9509 9510 9511 9512
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
9513
static const vshCmdInfo info_vol_list[] = {
9514 9515
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
9516 9517 9518
    {NULL, NULL}
};

9519
static const vshCmdOptDef opts_vol_list[] = {
9520
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9521
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
9522 9523 9524
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9525
static bool
9526
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9527
{
9528
    virStorageVolInfo volumeInfo;
9529 9530
    virStoragePoolPtr pool;
    char **activeNames = NULL;
9531 9532 9533 9534 9535
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
9536 9537
    int ret;
    bool functionReturn;
9538 9539 9540 9541 9542 9543 9544 9545 9546 9547 9548
    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;
9549

9550
    /* Check the connection to libvirtd daemon is still working */
9551
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9552
        return false;
9553

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

9558 9559
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
9560

9561 9562 9563
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9564
        return false;
9565 9566
    }

9567 9568 9569 9570 9571
    /* 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) {
9572
            vshError(ctl, "%s", _("Failed to list active vols"));
9573
            VIR_FREE(activeNames);
9574
            virStoragePoolFree(pool);
E
Eric Blake 已提交
9575
            return false;
9576 9577
        }

9578 9579 9580 9581 9582
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

9585 9586 9587 9588 9589
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
9590

9591 9592 9593 9594
        /* 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"));
9595 9596
        }

9597 9598 9599 9600 9601 9602 9603 9604 9605
        /* 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 */
9606

9607
                /* Volume type */
9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620
                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"));
                }
9621 9622 9623 9624 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

                /* 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;
        }
9671

9672
        /* Cleanup memory allocation */
9673
        virStorageVolFree(vol);
9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691
    }

    /* 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 已提交
9692
        functionReturn = true;
9693 9694 9695 9696 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
        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 */
9724 9725 9726 9727 9728 9729 9730 9731 9732 9733
    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);
9734 9735 9736 9737 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

    /* 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 已提交
9768
    functionReturn = true;
9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782
    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 已提交
9783
    functionReturn = false;
9784 9785 9786 9787 9788 9789 9790 9791 9792 9793

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);
9794
        VIR_FREE(activeNames[i]);
9795
    }
9796 9797 9798 9799

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
9800
    VIR_FREE(activeNames);
9801
    virStoragePoolFree(pool);
9802 9803 9804

    /* Return the desired value */
    return functionReturn;
9805 9806 9807 9808 9809 9810
}


/*
 * "vol-name" command
 */
9811
static const vshCmdInfo info_vol_name[] = {
9812
    {"help", N_("returns the volume name for a given volume key or path")},
9813
    {"desc", ""},
9814 9815 9816
    {NULL, NULL}
};

9817
static const vshCmdOptDef opts_vol_name[] = {
9818
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
9819 9820 9821
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9822
static bool
9823
cmdVolName(vshControl *ctl, const vshCmd *cmd)
9824 9825 9826
{
    virStorageVolPtr vol;

9827
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9828
        return false;
9829

9830
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
9831
                                   VSH_BYUUID)))
E
Eric Blake 已提交
9832
        return false;
9833 9834 9835

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9836
    return true;
9837 9838 9839
}


J
Justin Clift 已提交
9840 9841 9842 9843 9844 9845 9846 9847 9848 9849
/*
 * "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[] = {
9850
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
9851 9852 9853 9854
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9855
static bool
J
Justin Clift 已提交
9856 9857 9858 9859
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9860
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
9861 9862

    /* Check the connection to libvirtd daemon is still working */
9863
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9864
        return false;
J
Justin Clift 已提交
9865 9866

    /* Use the supplied string to locate the volume */
9867
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
9868
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
9869
        return false;
J
Justin Clift 已提交
9870 9871 9872 9873 9874 9875 9876
    }

    /* 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 已提交
9877
        return false;
J
Justin Clift 已提交
9878 9879
    }

9880 9881 9882 9883 9884 9885 9886 9887 9888
    /* 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 已提交
9889 9890 9891 9892

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9893
    return true;
J
Justin Clift 已提交
9894 9895
}

9896 9897 9898 9899

/*
 * "vol-key" command
 */
9900
static const vshCmdInfo info_vol_key[] = {
9901
    {"help", N_("returns the volume key for a given volume name or path")},
9902
    {"desc", ""},
9903 9904 9905
    {NULL, NULL}
};

9906
static const vshCmdOptDef opts_vol_key[] = {
9907
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
9908
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9909 9910 9911
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9912
static bool
9913
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
9914 9915 9916
{
    virStorageVolPtr vol;

9917
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9918
        return false;
9919

9920
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
9921
        return false;
9922 9923 9924

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
9925
    return true;
9926 9927 9928 9929 9930 9931 9932
}



/*
 * "vol-path" command
 */
9933
static const vshCmdInfo info_vol_path[] = {
9934
    {"help", N_("returns the volume path for a given volume name or key")},
9935
    {"desc", ""},
9936 9937 9938
    {NULL, NULL}
};

9939
static const vshCmdOptDef opts_vol_path[] = {
9940
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
9941
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9942 9943 9944
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9945
static bool
9946
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
9947 9948
{
    virStorageVolPtr vol;
9949
    const char *name = NULL;
9950
    char * StorageVolPath;
9951

9952
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9953
        return false;
9954 9955

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
9956
        return false;
9957
    }
9958

9959 9960 9961 9962 9963 9964 9965
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
9966
    virStorageVolFree(vol);
E
Eric Blake 已提交
9967
    return true;
9968 9969 9970
}


9971 9972 9973 9974
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
9975 9976
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
9977 9978
    {NULL, NULL}
};
9979

9980
static const vshCmdOptDef opts_secret_define[] = {
9981
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
9982 9983
    {NULL, 0, 0, NULL}
};
9984

E
Eric Blake 已提交
9985
static bool
9986 9987
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
9988
    const char *from = NULL;
9989
    char *buffer;
9990
    virSecretPtr res;
9991
    char uuid[VIR_UUID_STRING_BUFLEN];
9992

9993
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9994
        return false;
9995

9996
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9997
        return false;
9998 9999

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
10003
    VIR_FREE(buffer);
10004 10005

    if (res == NULL) {
10006
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
10007
        return false;
10008
    }
10009
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
10010
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
10011
        virSecretFree(res);
E
Eric Blake 已提交
10012
        return false;
10013 10014 10015
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
10016
    return true;
10017 10018 10019 10020 10021 10022
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
10023 10024
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
10025 10026 10027 10028
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
10029
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10030 10031 10032
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10033
static bool
10034 10035 10036
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
10037
    bool ret = false;
10038 10039
    char *xml;

10040
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10041
        return false;
10042 10043 10044

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
10045
        return false;
10046 10047 10048 10049

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
10050
    vshPrint(ctl, "%s", xml);
10051
    VIR_FREE(xml);
E
Eric Blake 已提交
10052
    ret = true;
10053 10054 10055 10056 10057 10058 10059 10060 10061 10062

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
10063 10064
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
10065 10066 10067 10068
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
10069 10070
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
10071 10072 10073
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10074
static bool
10075 10076 10077 10078
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
10079
    const char *base64 = NULL;
10080
    char *value;
E
Eric Blake 已提交
10081 10082
    int res;
    bool ret = false;
10083

10084
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10085
        return false;
10086 10087 10088

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

10091
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
10092 10093 10094
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
10095
        vshError(ctl, "%s", _("Invalid base64 data"));
10096 10097 10098
        goto cleanup;
    }
    if (value == NULL) {
10099
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
10100
        return false;
10101 10102 10103 10104
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
10105
    VIR_FREE(value);
10106 10107

    if (res != 0) {
10108
        vshError(ctl, "%s", _("Failed to set secret value"));
10109 10110 10111
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
10112
    ret = true;
10113 10114 10115 10116 10117 10118 10119 10120 10121 10122

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
10123 10124
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
10125 10126 10127 10128
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
10129
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10130 10131 10132
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10133
static bool
10134 10135 10136 10137 10138 10139
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
10140
    bool ret = false;
10141

10142
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10143
        return false;
10144 10145 10146

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
10147
        return false;
10148 10149 10150 10151 10152 10153 10154

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
10155
    VIR_FREE(value);
10156 10157

    if (base64 == NULL) {
10158
        vshError(ctl, "%s", _("Failed to allocate memory"));
10159 10160
        goto cleanup;
    }
10161
    vshPrint(ctl, "%s", base64);
10162
    memset(base64, 0, strlen(base64));
10163
    VIR_FREE(base64);
E
Eric Blake 已提交
10164
    ret = true;
10165 10166 10167 10168 10169 10170 10171 10172 10173 10174

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
10175 10176
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
10177 10178 10179 10180
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
10181
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10182 10183 10184
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10185
static bool
10186 10187 10188
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
10189
    bool ret = false;
10190
    const char *uuid;
10191

10192
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10193
        return false;
10194 10195 10196

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
10197
        return false;
10198 10199

    if (virSecretUndefine(secret) < 0) {
10200
        vshError(ctl, _("Failed to delete secret %s"), uuid);
10201 10202 10203
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
10204
    ret = true;
10205 10206 10207 10208 10209 10210 10211 10212 10213 10214

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
10215 10216
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
10217 10218 10219
    {NULL, NULL}
};

E
Eric Blake 已提交
10220
static bool
10221 10222 10223 10224 10225
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

10226
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10227
        return false;
10228 10229 10230

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
10231
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
10232
        return false;
10233 10234 10235 10236 10237
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
10238
        vshError(ctl, "%s", _("Failed to list secrets"));
10239
        VIR_FREE(uuids);
E
Eric Blake 已提交
10240
        return false;
10241 10242 10243 10244
    }

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

10245 10246
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
10247 10248

    for (i = 0; i < maxuuids; i++) {
10249 10250 10251 10252
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
10253
            VIR_FREE(uuids[i]);
10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271
            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);
10272
        VIR_FREE(uuids[i]);
10273
    }
10274
    VIR_FREE(uuids);
E
Eric Blake 已提交
10275
    return true;
10276
}
10277 10278 10279 10280 10281


/*
 * "version" command
 */
10282
static const vshCmdInfo info_version[] = {
10283 10284
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
10285 10286 10287
    {NULL, NULL}
};

10288 10289 10290 10291
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
10292

E
Eric Blake 已提交
10293
static bool
10294
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10295 10296 10297 10298 10299 10300
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
10301
    unsigned long daemonVersion;
10302 10303 10304 10305 10306
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

10307
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10308
        return false;
10309 10310 10311

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
10312
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
10313
        return false;
10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325
    }

    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) {
10326
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
10327
        return false;
10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344
    }
    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) {
10345
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
10346
        return false;
10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359
    }
    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);
    }
10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374

    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 已提交
10375
    return true;
10376 10377
}

10378 10379 10380 10381
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
10382
    {"help", N_("enumerate devices on this host")},
10383
    {"desc", ""},
10384 10385 10386 10387
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
10388 10389
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
10390 10391 10392
    {NULL, 0, 0, NULL}
};

10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413 10414
#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] = '-';
10415 10416
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
10417 10418 10419
    }

    /* Print this device */
10420
    vshPrint(ctl, "%s", indentBuf);
10421 10422 10423 10424 10425 10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443
    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) {
10444
        vshPrint(ctl, "%s", indentBuf);
10445
        vshPrint(ctl, " |\n");
10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467
    }

    /* 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) {
10468
        vshPrint(ctl, "%s", indentBuf);
10469 10470 10471 10472
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
10473
static bool
10474 10475
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
10476
    const char *cap = NULL;
10477
    char **devices;
10478
    int num_devices, i;
10479
    int tree = vshCommandOptBool(cmd, "tree");
10480

10481
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10482
        return false;
10483

10484
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
10485 10486 10487 10488
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
10489
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
10490
        return false;
10491
    } else if (num_devices == 0) {
E
Eric Blake 已提交
10492
        return true;
10493 10494 10495 10496 10497 10498
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
10499
        vshError(ctl, "%s", _("Failed to list node devices"));
10500
        VIR_FREE(devices);
E
Eric Blake 已提交
10501
        return false;
10502
    }
10503
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
10504 10505 10506 10507 10508 10509 10510
    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 已提交
10511
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530
            } 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++) {
10531 10532
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
10533
        }
10534
        VIR_FREE(parents);
10535 10536 10537
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
10538
            VIR_FREE(devices[i]);
10539
        }
10540
    }
10541
    VIR_FREE(devices);
E
Eric Blake 已提交
10542
    return true;
10543 10544 10545 10546 10547 10548
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
10549 10550
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
10551 10552 10553 10554 10555
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
10556
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10557 10558 10559
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10560
static bool
10561 10562
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
10563
    const char *name = NULL;
10564
    virNodeDevicePtr device;
L
Laine Stump 已提交
10565
    char *xml;
10566

10567
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10568
        return false;
10569
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10570
        return false;
10571
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10572
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10573
        return false;
10574 10575
    }

L
Laine Stump 已提交
10576 10577 10578
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
10579
        return false;
L
Laine Stump 已提交
10580 10581 10582
    }

    vshPrint(ctl, "%s\n", xml);
10583
    VIR_FREE(xml);
10584
    virNodeDeviceFree(device);
E
Eric Blake 已提交
10585
    return true;
10586 10587
}

10588 10589 10590 10591
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
10592 10593
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
10594 10595 10596 10597 10598
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
10599
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10600 10601 10602
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10603
static bool
10604 10605
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
10606
    const char *name = NULL;
10607
    virNodeDevicePtr device;
E
Eric Blake 已提交
10608
    bool ret = true;
10609

10610
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10611
        return false;
10612
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10613
        return false;
10614
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10615
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10616
        return false;
10617 10618 10619 10620 10621
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
10622
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
10623
        ret = false;
10624 10625 10626 10627 10628 10629 10630 10631 10632
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
10633 10634
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
10635 10636 10637 10638 10639
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
10640
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10641 10642 10643
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10644
static bool
10645 10646
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
10647
    const char *name = NULL;
10648
    virNodeDevicePtr device;
E
Eric Blake 已提交
10649
    bool ret = true;
10650

10651
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10652
        return false;
10653
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10654
        return false;
10655
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10656
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10657
        return false;
10658 10659 10660 10661 10662
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
10663
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
10664
        ret = false;
10665 10666 10667 10668 10669 10670 10671 10672 10673
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
10674 10675
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
10676 10677 10678 10679 10680
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
10681
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
10682 10683 10684
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10685
static bool
10686 10687
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
10688
    const char *name = NULL;
10689
    virNodeDevicePtr device;
E
Eric Blake 已提交
10690
    bool ret = true;
10691

10692
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10693
        return false;
10694
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
10695
        return false;
10696
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
10697
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
10698
        return false;
10699 10700 10701 10702 10703
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
10704
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
10705
        ret = false;
10706 10707 10708 10709 10710
    }
    virNodeDeviceFree(device);
    return ret;
}

10711
/*
E
Eric Blake 已提交
10712
 * "hostname" command
10713
 */
10714
static const vshCmdInfo info_hostname[] = {
10715
    {"help", N_("print the hypervisor hostname")},
10716
    {"desc", ""},
10717 10718 10719
    {NULL, NULL}
};

E
Eric Blake 已提交
10720
static bool
10721
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10722 10723 10724
{
    char *hostname;

10725
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10726
        return false;
10727 10728 10729

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
10730
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
10731
        return false;
10732 10733 10734
    }

    vshPrint (ctl, "%s\n", hostname);
10735
    VIR_FREE(hostname);
10736

E
Eric Blake 已提交
10737
    return true;
10738 10739 10740 10741 10742
}

/*
 * "uri" command
 */
10743
static const vshCmdInfo info_uri[] = {
10744
    {"help", N_("print the hypervisor canonical URI")},
10745
    {"desc", ""},
10746 10747 10748
    {NULL, NULL}
};

E
Eric Blake 已提交
10749
static bool
10750
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10751 10752 10753
{
    char *uri;

10754
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10755
        return false;
10756 10757 10758

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
10759
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
10760
        return false;
10761 10762 10763
    }

    vshPrint (ctl, "%s\n", uri);
10764
    VIR_FREE(uri);
10765

E
Eric Blake 已提交
10766
    return true;
10767 10768
}

E
Eric Blake 已提交
10769 10770 10771 10772 10773 10774 10775 10776 10777 10778
/*
 * "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 已提交
10779
static bool
E
Eric Blake 已提交
10780 10781 10782 10783 10784
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10785
        return false;
E
Eric Blake 已提交
10786 10787 10788 10789

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
10790
        return false;
E
Eric Blake 已提交
10791 10792 10793 10794 10795
    }

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

E
Eric Blake 已提交
10796
    return true;
E
Eric Blake 已提交
10797 10798
}

10799 10800 10801
/*
 * "vncdisplay" command
 */
10802
static const vshCmdInfo info_vncdisplay[] = {
10803 10804
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
10805 10806 10807
    {NULL, NULL}
};

10808
static const vshCmdOptDef opts_vncdisplay[] = {
10809
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10810 10811 10812
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10813
static bool
10814
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
10815 10816 10817 10818 10819
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10820
    bool ret = false;
10821 10822 10823
    int port = 0;
    char *doc;

10824
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10825
        return false;
10826

J
Jim Meyering 已提交
10827
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10828
        return false;
10829 10830 10831 10832 10833

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10834
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10835
    VIR_FREE(doc);
10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850
    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) ||
10851
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
10852 10853 10854 10855 10856 10857
        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 已提交
10858
    ret = true;
10859 10860 10861 10862

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10863
    xmlFreeDoc(xml);
10864 10865 10866 10867 10868 10869 10870
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
10871
static const vshCmdInfo info_ttyconsole[] = {
10872 10873
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
10874 10875 10876
    {NULL, NULL}
};

10877
static const vshCmdOptDef opts_ttyconsole[] = {
10878
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10879 10880 10881
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10882
static bool
10883
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
10884 10885 10886 10887 10888
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
10889
    bool ret = false;
10890 10891
    char *doc;

10892
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10893
        return false;
10894

J
Jim Meyering 已提交
10895
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10896
        return false;
10897 10898 10899 10900 10901

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

10902
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
10903
    VIR_FREE(doc);
10904 10905 10906 10907 10908 10909 10910 10911 10912
    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 已提交
10913
    ret = true;
10914 10915 10916 10917

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
10918
    xmlFreeDoc(xml);
10919 10920 10921 10922 10923 10924
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
10925
 */
10926
static const vshCmdInfo info_attach_device[] = {
10927 10928
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
10929 10930 10931
    {NULL, NULL}
};

10932
static const vshCmdOptDef opts_attach_device[] = {
10933 10934 10935
    {"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")},
10936 10937 10938
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10939
static bool
10940
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
10941 10942
{
    virDomainPtr dom;
10943
    const char *from = NULL;
10944
    char *buffer;
W
Wen Congyang 已提交
10945
    int ret;
J
Jim Fehlig 已提交
10946
    unsigned int flags;
10947

10948
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10949
        return false;
10950

J
Jim Meyering 已提交
10951
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
10952
        return false;
10953

10954
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10955
        virDomainFree(dom);
E
Eric Blake 已提交
10956
        return false;
10957 10958
    }

10959
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10960
        virshReportError(ctl);
10961
        virDomainFree(dom);
E
Eric Blake 已提交
10962
        return false;
10963
    }
10964

J
Jim Fehlig 已提交
10965
    if (vshCommandOptBool(cmd, "persistent")) {
10966
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10967
        if (virDomainIsActive(dom) == 1)
10968
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10969 10970 10971 10972
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
10973
    VIR_FREE(buffer);
10974 10975

    if (ret < 0) {
10976
        vshError(ctl, _("Failed to attach device from %s"), from);
10977
        virDomainFree(dom);
E
Eric Blake 已提交
10978
        return false;
10979
    } else {
J
Jim Meyering 已提交
10980
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
10981 10982 10983
    }

    virDomainFree(dom);
E
Eric Blake 已提交
10984
    return true;
10985 10986 10987 10988 10989 10990
}


/*
 * "detach-device" command
 */
10991
static const vshCmdInfo info_detach_device[] = {
10992 10993
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
10994 10995 10996
    {NULL, NULL}
};

10997
static const vshCmdOptDef opts_detach_device[] = {
10998 10999 11000
    {"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")},
11001 11002 11003
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11004
static bool
11005
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
11006 11007
{
    virDomainPtr dom;
11008
    const char *from = NULL;
11009
    char *buffer;
W
Wen Congyang 已提交
11010
    int ret;
J
Jim Fehlig 已提交
11011
    unsigned int flags;
11012

11013
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11014
        return false;
11015

J
Jim Meyering 已提交
11016
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
11017
        return false;
11018

11019
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11020
        virDomainFree(dom);
E
Eric Blake 已提交
11021
        return false;
11022 11023
    }

11024
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11025
        virshReportError(ctl);
11026
        virDomainFree(dom);
E
Eric Blake 已提交
11027
        return false;
11028
    }
11029

J
Jim Fehlig 已提交
11030
    if (vshCommandOptBool(cmd, "persistent")) {
11031
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11032
        if (virDomainIsActive(dom) == 1)
11033
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11034 11035 11036 11037
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
11038
    VIR_FREE(buffer);
11039 11040

    if (ret < 0) {
11041
        vshError(ctl, _("Failed to detach device from %s"), from);
11042
        virDomainFree(dom);
E
Eric Blake 已提交
11043
        return false;
11044
    } else {
J
Jim Meyering 已提交
11045
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
11046 11047 11048
    }

    virDomainFree(dom);
E
Eric Blake 已提交
11049
    return true;
11050 11051
}

11052

11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065
/*
 * "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")},
11066
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
11067 11068 11069
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11070
static bool
11071 11072 11073
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
11074
    const char *from = NULL;
11075
    char *buffer;
W
Wen Congyang 已提交
11076
    int ret;
11077 11078
    unsigned int flags;

11079
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11080
        return false;
11081 11082

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

11085
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11086
        virDomainFree(dom);
E
Eric Blake 已提交
11087
        return false;
11088 11089 11090
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11091
        virshReportError(ctl);
11092
        virDomainFree(dom);
E
Eric Blake 已提交
11093
        return false;
11094 11095 11096
    }

    if (vshCommandOptBool(cmd, "persistent")) {
11097
        flags = VIR_DOMAIN_AFFECT_CONFIG;
11098
        if (virDomainIsActive(dom) == 1)
11099
           flags |= VIR_DOMAIN_AFFECT_LIVE;
11100
    } else {
11101
        flags = VIR_DOMAIN_AFFECT_LIVE;
11102
    }
11103 11104 11105 11106

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

11107 11108 11109 11110 11111 11112
    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 已提交
11113
        return false;
11114 11115 11116 11117 11118
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
11119
    return true;
11120 11121 11122
}


11123 11124 11125
/*
 * "attach-interface" command
 */
11126
static const vshCmdInfo info_attach_interface[] = {
11127 11128
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
11129 11130 11131
    {NULL, NULL}
};

11132
static const vshCmdOptDef opts_attach_interface[] = {
11133 11134 11135 11136 11137 11138
    {"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")},
11139
    {"model", VSH_OT_DATA, 0, N_("model type")},
11140
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
11141 11142 11143
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11144
static bool
11145
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
11146 11147
{
    virDomainPtr dom = NULL;
11148 11149
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
11150
    int typ;
W
Wen Congyang 已提交
11151 11152
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11153
    unsigned int flags;
11154 11155
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
11156

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

J
Jim Meyering 已提交
11160
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11161 11162
        goto cleanup;

11163
    if (vshCommandOptString(cmd, "type", &type) <= 0)
11164 11165
        goto cleanup;

11166 11167 11168 11169
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
11170 11171
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
11172
        goto cleanup;
11173
    }
11174 11175

    /* check interface type */
11176
    if (STREQ(type, "network")) {
11177
        typ = 1;
11178
    } else if (STREQ(type, "bridge")) {
11179 11180
        typ = 2;
    } else {
E
Eric Blake 已提交
11181 11182
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
11183 11184 11185 11186
        goto cleanup;
    }

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

11189
    if (typ == 1)
11190
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
11191
    else if (typ == 2)
11192
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
11193

11194
    if (target != NULL)
11195
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11196
    if (mac != NULL)
11197
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
11198
    if (script != NULL)
11199
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
11200
    if (model != NULL)
11201
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
11202

11203
    virBufferAddLit(&buf, "</interface>\n");
11204

11205 11206
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
11207
        goto cleanup;
11208 11209
    }

11210
    xml = virBufferContentAndReset(&buf);
11211

J
Jim Fehlig 已提交
11212
    if (vshCommandOptBool(cmd, "persistent")) {
11213
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11214
        if (virDomainIsActive(dom) == 1)
11215
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11216
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
11217
    } else {
11218
        ret = virDomainAttachDevice(dom, xml);
11219
    }
11220

11221 11222
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11223
    if (ret != 0) {
L
Laine Stump 已提交
11224
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
11225 11226
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
11227
        functionReturn = true;
J
Jim Fehlig 已提交
11228
    }
11229 11230 11231 11232

 cleanup:
    if (dom)
        virDomainFree(dom);
11233
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11234
    return functionReturn;
11235 11236 11237 11238 11239
}

/*
 * "detach-interface" command
 */
11240
static const vshCmdInfo info_detach_interface[] = {
11241 11242
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
11243 11244 11245
    {NULL, NULL}
};

11246
static const vshCmdOptDef opts_detach_interface[] = {
11247 11248 11249 11250
    {"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")},
11251 11252 11253
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11254
static bool
11255
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
11256 11257 11258 11259 11260 11261 11262
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
11263
    const char *mac =NULL, *type = NULL;
11264
    char *doc;
11265
    char buf[64];
E
Eric Blake 已提交
11266
    int i = 0, diff_mac;
W
Wen Congyang 已提交
11267 11268
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
11269
    unsigned int flags;
11270

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

J
Jim Meyering 已提交
11274
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11275 11276
        goto cleanup;

11277
    if (vshCommandOptString(cmd, "type", &type) <= 0)
11278 11279
        goto cleanup;

11280 11281
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
11282
        goto cleanup;
11283
    }
11284 11285 11286 11287 11288

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11289
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
11290
    VIR_FREE(doc);
11291
    if (!xml) {
11292
        vshError(ctl, "%s", _("Failed to get interface information"));
11293 11294 11295
        goto cleanup;
    }

E
Eric Blake 已提交
11296
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
11297 11298 11299
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11300
        vshError(ctl, _("No found interface whose type is %s"), type);
11301 11302 11303
        goto cleanup;
    }

11304 11305 11306 11307 11308 11309
    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;
    }

11310 11311 11312 11313 11314 11315 11316
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11317 11318 11319 11320 11321
            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);
11322 11323 11324 11325 11326 11327 11328
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11329
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
11330 11331 11332 11333 11334
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11335
        vshError(ctl, "%s", _("Failed to allocate memory"));
11336 11337 11338
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
11344
    if (vshCommandOptBool(cmd, "persistent")) {
11345
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11346
        if (virDomainIsActive(dom) == 1)
11347
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11348 11349 11350 11351 11352 11353 11354 11355
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11356
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
11357
    } else {
J
Jim Meyering 已提交
11358
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
11359
        functionReturn = true;
11360
    }
11361 11362 11363 11364

 cleanup:
    if (dom)
        virDomainFree(dom);
11365
    xmlXPathFreeObject(obj);
11366
    xmlXPathFreeContext(ctxt);
11367 11368
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
11369
    return functionReturn;
11370 11371 11372 11373 11374
}

/*
 * "attach-disk" command
 */
11375
static const vshCmdInfo info_attach_disk[] = {
11376 11377
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
11378 11379 11380
    {NULL, NULL}
};

11381
static const vshCmdOptDef opts_attach_disk[] = {
11382 11383 11384 11385 11386
    {"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")},
11387
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
11388 11389 11390
    {"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")},
11391
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
11392 11393 11394
    {"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")},
11395 11396 11397
    {NULL, 0, 0, NULL}
};

11398 11399 11400 11401 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
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 已提交
11545
static bool
11546
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
11547 11548
{
    virDomainPtr dom = NULL;
11549
    const char *source = NULL, *target = NULL, *driver = NULL,
11550 11551 11552
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
11553 11554
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
11555
    unsigned int flags;
11556
    const char *stype = NULL;
11557 11558
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
11559

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

J
Jim Meyering 已提交
11563
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11564 11565
        goto cleanup;

11566
    if (vshCommandOptString(cmd, "source", &source) <= 0)
11567 11568
        goto cleanup;

11569
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11570 11571
        goto cleanup;

11572 11573 11574 11575
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
11576 11577 11578
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
11579
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
11580
        vshError(ctl, "%s", _("missing option"));
11581 11582
        goto cleanup;
    }
11583

11584 11585
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
11586
            isFile = true;
11587
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
11588
        isFile = true;
11589 11590 11591
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
11592 11593 11594
    }

    if (mode) {
11595
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
11596 11597
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
11598 11599 11600 11601 11602
            goto cleanup;
        }
    }

    /* Make XML of disk */
11603
    virBufferAsprintf(&buf, "<disk type='%s'",
11604 11605
                      (isFile) ? "file" : "block");
    if (type)
11606
        virBufferAsprintf(&buf, " device='%s'", type);
11607 11608
    virBufferAddLit(&buf, ">\n");

11609
    if (driver || subdriver)
11610
        virBufferAsprintf(&buf, "  <driver");
11611 11612

    if (driver)
11613
        virBufferAsprintf(&buf, " name='%s'", driver);
11614
    if (subdriver)
11615
        virBufferAsprintf(&buf, " type='%s'", subdriver);
11616 11617
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
11618

11619
    if (driver || subdriver || cache)
11620
        virBufferAddLit(&buf, "/>\n");
11621

11622
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
11623 11624
                      (isFile) ? "file" : "dev",
                      source);
11625
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
11626
    if (mode)
11627
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
11628

11629 11630 11631 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
    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;
            }
        }
    }

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

11679 11680
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
11681
        return false;
11682 11683
    }

11684
    xml = virBufferContentAndReset(&buf);
11685

J
Jim Fehlig 已提交
11686
    if (vshCommandOptBool(cmd, "persistent")) {
11687
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11688
        if (virDomainIsActive(dom) == 1)
11689
            flags |= VIR_DOMAIN_AFFECT_LIVE;
11690
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
11691
    } else {
11692
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
11693
    }
11694

11695 11696
    VIR_FREE(xml);

J
Jim Fehlig 已提交
11697
    if (ret != 0) {
L
Laine Stump 已提交
11698
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
11699 11700
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
11701
        functionReturn = true;
J
Jim Fehlig 已提交
11702
    }
11703 11704 11705 11706

 cleanup:
    if (dom)
        virDomainFree(dom);
11707
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
11708
    return functionReturn;
11709 11710 11711 11712 11713
}

/*
 * "detach-disk" command
 */
11714
static const vshCmdInfo info_detach_disk[] = {
11715 11716
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
11717 11718 11719
    {NULL, NULL}
};

11720
static const vshCmdOptDef opts_detach_disk[] = {
11721 11722 11723
    {"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")},
11724 11725 11726
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11727
static bool
11728
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
11729 11730 11731 11732 11733 11734 11735
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
11736
    const char *target = NULL;
11737
    char *doc;
E
Eric Blake 已提交
11738
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
11739 11740
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
11741
    unsigned int flags;
11742

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

J
Jim Meyering 已提交
11746
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
11747 11748
        goto cleanup;

11749
    if (vshCommandOptString(cmd, "target", &target) <= 0)
11750 11751 11752 11753 11754 11755
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11756
    xml = virXMLParseStringCtxt(doc, "domain.xml", &ctxt);
11757
    VIR_FREE(doc);
11758
    if (!xml) {
11759
        vshError(ctl, "%s", _("Failed to get disk information"));
11760 11761 11762 11763 11764 11765
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
11766
        vshError(ctl, "%s", _("Failed to get disk information"));
11767 11768 11769 11770 11771 11772 11773
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
11774 11775 11776 11777 11778
            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);
11779 11780 11781 11782 11783 11784 11785
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
11786
    vshError(ctl, _("No found disk whose target is %s"), target);
11787 11788 11789 11790 11791
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
11792
        vshError(ctl, "%s", _("Failed to allocate memory"));
11793 11794 11795
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
11801
    if (vshCommandOptBool(cmd, "persistent")) {
11802
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11803
        if (virDomainIsActive(dom) == 1)
11804
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11805 11806 11807 11808 11809 11810 11811 11812
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
11813
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
11814
    } else {
J
Jim Meyering 已提交
11815
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
11816
        functionReturn = true;
11817
    }
11818 11819

 cleanup:
11820
    xmlXPathFreeObject(obj);
11821
    xmlXPathFreeContext(ctxt);
11822 11823
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
11824 11825
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
11826
    return functionReturn;
11827 11828
}

11829 11830 11831 11832
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
11833 11834
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
11835 11836 11837 11838
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
11839
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
11840 11841 11842
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11843
static bool
11844 11845
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
11846
    const char *from = NULL;
E
Eric Blake 已提交
11847
    bool ret = true;
11848 11849 11850
    char *buffer;
    int result;

11851
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11852
        return false;
11853

11854
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11855
        return false;
11856 11857

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
11861
    VIR_FREE(buffer);
11862 11863 11864 11865 11866

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
11867
        ret = false;
11868 11869 11870 11871 11872
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
11873
        ret = true;
11874 11875 11876 11877 11878
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
11879
        ret = true;
11880 11881 11882 11883 11884
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
11885
        ret = false;
11886 11887 11888 11889 11890
    }

    return ret;
}

11891 11892 11893 11894
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
11895 11896
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
11897 11898 11899 11900
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
11901
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
11902 11903 11904
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11905
static bool
11906 11907
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
11908
    const char *from = NULL;
E
Eric Blake 已提交
11909
    bool ret = true;
11910 11911 11912 11913 11914
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
11915
    xmlNodePtr node_list;
11916 11917 11918 11919 11920 11921
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

11922
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11923
        return false;
11924

11925
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11926
        return false;
11927 11928

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
11929
        return false;
11930 11931 11932 11933 11934

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

L
Laine Stump 已提交
11935 11936
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
11937 11938
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
11939
        ret = false;
11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975
        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 已提交
11976
        ret = false;
11977 11978 11979 11980 11981 11982 11983 11984
        goto cleanup;
    }

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

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
11985
        ret = false;
11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002

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 已提交
12003
    ret = false;
12004
    goto cleanup;
12005 12006
}

12007 12008 12009 12010 12011 12012 12013 12014
/* 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;

12015
    ret = vshMalloc(ctl, PATH_MAX);
12016 12017 12018

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
12019 12020
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
12021
    if (fd == -1) {
12022
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
12023
                 strerror(errno));
12024
        VIR_FREE(ret);
12025 12026 12027 12028
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
12029 12030
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
12031
        VIR_FORCE_CLOSE(fd);
12032
        unlink (ret);
12033
        VIR_FREE(ret);
12034 12035
        return NULL;
    }
S
Stefan Berger 已提交
12036
    if (VIR_CLOSE(fd) < 0) {
12037 12038
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
12039
        unlink (ret);
12040
        VIR_FREE(ret);
12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055
        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 已提交
12056 12057 12058 12059
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
12060

12061
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
12062 12063 12064 12065
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
12066

12067 12068 12069 12070 12071
    /* 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 已提交
12072 12073
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
12074
     */
E
Eric Blake 已提交
12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086
    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);
12087 12088
    }

E
Eric Blake 已提交
12089 12090 12091 12092 12093 12094 12095
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
12096
    }
E
Eric Blake 已提交
12097
    ret = 0;
12098

E
Eric Blake 已提交
12099 12100 12101
cleanup:
    virCommandFree(cmd);
    return ret;
12102 12103 12104 12105 12106 12107 12108 12109
}

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

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
12110
        vshError(ctl,
12111
                 _("%s: failed to read temporary file: %s"),
12112
                 filename, strerror(errno));
12113 12114 12115 12116 12117
        return NULL;
    }
    return ret;
}

12118

P
Paolo Bonzini 已提交
12119 12120 12121 12122
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
12123 12124
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
12125 12126 12127 12128
    {NULL, NULL}
};

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

E
Eric Blake 已提交
12133
static bool
12134
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
12135
{
12136
    const char *dir = NULL;
12137
    char *dir_malloced = NULL;
E
Eric Blake 已提交
12138
    bool ret = true;
P
Paolo Bonzini 已提交
12139 12140

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

12145
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
12146
        uid_t uid = geteuid();
12147
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
12148 12149 12150 12151
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
12152
    if (chdir(dir) == -1) {
12153
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
12154
        ret = false;
P
Paolo Bonzini 已提交
12155 12156
    }

12157
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
12158
    return ret;
P
Paolo Bonzini 已提交
12159 12160 12161 12162 12163 12164
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
12165 12166
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
12167 12168 12169
    {NULL, NULL}
};

E
Eric Blake 已提交
12170
static bool
P
Paolo Bonzini 已提交
12171 12172 12173
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
12174
    bool ret = true;
P
Paolo Bonzini 已提交
12175

12176 12177
    cwd = getcwd(NULL, 0);
    if (!cwd) {
12178 12179
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
12180 12181
        ret = false;
    } else {
P
Paolo Bonzini 已提交
12182
        vshPrint (ctl, _("%s\n"), cwd);
12183 12184
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
12185

12186
    return ret;
P
Paolo Bonzini 已提交
12187 12188
}

E
Eric Blake 已提交
12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200
/*
 * "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")},
12201
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
12202 12203 12204 12205 12206 12207
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
12208
static bool
E
Eric Blake 已提交
12209 12210 12211 12212 12213
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
12214
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
12215 12216 12217 12218 12219 12220 12221 12222
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

12223
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
12224 12225 12226
        bool close_quote = false;
        char *q;

12227
        arg = opt->data;
E
Eric Blake 已提交
12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 12255
        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 已提交
12256
        return false;
E
Eric Blake 已提交
12257 12258 12259 12260 12261
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
12262
    return true;
E
Eric Blake 已提交
12263 12264
}

12265 12266 12267 12268
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
12269 12270
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
12271 12272 12273 12274
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
12275
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12276 12277 12278 12279 12280 12281
    {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 已提交
12282
static bool
12283 12284
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
12285
    bool ret = false;
12286 12287 12288 12289 12290
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
12291
    unsigned int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
12292

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

J
Jim Meyering 已提交
12296
    dom = vshCommandOptDomain (ctl, cmd, NULL);
12297 12298 12299 12300
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
12301
    doc = virDomainGetXMLDesc (dom, flags);
12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319
    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 已提交
12320
        ret = true;
12321 12322 12323 12324 12325 12326 12327
        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.
     */
12328
    doc_reread = virDomainGetXMLDesc (dom, flags);
12329 12330 12331 12332
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
12333 12334
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346
        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 已提交
12347
    ret = true;
12348 12349 12350 12351 12352

 cleanup:
    if (dom)
        virDomainFree (dom);

12353 12354 12355
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
12356 12357 12358

    if (tmp) {
        unlink (tmp);
12359
        VIR_FREE(tmp);
12360 12361 12362 12363 12364
    }

    return ret;
}

12365

12366 12367 12368 12369
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
12370 12371
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
12372 12373 12374 12375
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
12376
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
12377 12378 12379 12380 12381 12382 12383 12384 12385 12386
    {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[] = {
12387 12388
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
12389 12390 12391 12392
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
12393
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
12394 12395 12396 12397 12398 12399
    {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 已提交
12400 12401 12402
/*
 * "quit" command
 */
12403
static const vshCmdInfo info_quit[] = {
12404
    {"help", N_("quit this interactive terminal")},
12405
    {"desc", ""},
12406
    {NULL, NULL}
K
Karel Zak 已提交
12407 12408
};

E
Eric Blake 已提交
12409
static bool
12410
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
12411
{
E
Eric Blake 已提交
12412 12413
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
12414 12415
}

12416 12417 12418 12419 12420 12421 12422
/* 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;
12423
    bool halt = false;
12424 12425 12426
    char *doc = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
E
Eric Blake 已提交
12427
    const char *name = NULL;
12428 12429

    snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
12430 12431 12432 12433 12434 12435 12436 12437 12438 12439 12440 12441 12442 12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453

    /* 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);
    }

12454 12455 12456
    if (snapshot == NULL)
        goto cleanup;

12457 12458 12459 12460 12461
    if (halt && virDomainDestroy(dom) < 0) {
        virshReportError(ctl);
        goto cleanup;
    }

E
Eric Blake 已提交
12462
    name = virDomainSnapshotGetName(snapshot);
12463
    if (!name) {
E
Eric Blake 已提交
12464
        vshError(ctl, "%s", _("Could not get snapshot name"));
12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478 12479 12480 12481 12482 12483
        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:
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    return ret;
}

12484 12485 12486 12487
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
12488 12489
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
12490 12491 12492 12493 12494 12495
    {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")},
12496 12497 12498
    {"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")},
12499
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
12500
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
12501 12502 12503
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12504
static bool
12505 12506 12507
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12508
    bool ret = false;
12509
    const char *from = NULL;
12510
    char *buffer = NULL;
12511 12512 12513 12514 12515 12516 12517 12518
    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;
12519 12520
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
12521 12522
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
12523

12524
    if (!vshConnectionUsability(ctl, ctl->conn))
12525 12526 12527 12528 12529 12530
        goto cleanup;

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

12531
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
12532
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
12533 12534 12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547
    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;
    }

12548
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, from);
12549 12550 12551 12552 12553 12554 12555 12556 12557

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

    return ret;
}

12558 12559 12560
/*
 * "snapshot-create-as" command
 */
12561 12562 12563 12564 12565 12566 12567 12568 12569 12570 12571 12572 12573 12574 12575 12576 12577 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
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;
}

12617 12618 12619 12620 12621 12622 12623 12624 12625 12626
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 已提交
12627
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
12628
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
12629
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
12630 12631 12632
    {"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]")},
12633 12634 12635 12636 12637 12638 12639 12640 12641 12642 12643 12644
    {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;
12645
    unsigned int flags = 0;
12646
    const vshCmdOpt *opt = NULL;
12647 12648 12649

    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
12650 12651
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
12652 12653
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
12654 12655 12656 12657 12658 12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669

    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)
12670
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
12671
    if (desc)
12672
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
12673 12674 12675 12676 12677 12678 12679 12680 12681 12682
    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");
    }
12683 12684 12685 12686 12687 12688 12689 12690
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
12691 12692 12693 12694 12695 12696
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

12697
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, NULL);
12698 12699 12700 12701 12702 12703 12704 12705 12706

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

    return ret;
}

12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 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
/*
 * "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;
}

12808 12809 12810 12811
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
12812 12813
    {"help", N_("Get or set the current snapshot")},
    {"desc", N_("Get or set the current snapshot")},
12814 12815 12816 12817 12818
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12819
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
12820 12821
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
12822 12823
    {"snapshotname", VSH_OT_DATA, 0,
     N_("name of existing snapshot to make current")},
12824 12825 12826
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12827
static bool
12828 12829 12830
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12831
    bool ret = false;
12832 12833
    int current;
    virDomainSnapshotPtr snapshot = NULL;
12834
    char *xml = NULL;
12835
    const char *snapshotname = NULL;
12836 12837 12838 12839
    unsigned int flags = 0;

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

12841
    if (!vshConnectionUsability(ctl, ctl->conn))
12842 12843 12844 12845 12846 12847
        goto cleanup;

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

12848 12849 12850 12851 12852 12853 12854 12855 12856 12857 12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876
    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;
    }

12877 12878 12879 12880
    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
E
Eric Blake 已提交
12881
        const char *name = NULL;
12882 12883 12884 12885

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

12886
        if (vshCommandOptBool(cmd, "name")) {
E
Eric Blake 已提交
12887
            name = virDomainSnapshotGetName(snapshot);
12888 12889
            if (!name)
                goto cleanup;
E
Eric Blake 已提交
12890 12891 12892 12893
        } else {
            xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
            if (!xml)
                goto cleanup;
12894 12895 12896
        }

        vshPrint(ctl, "%s", name ? name : xml);
12897 12898
    }

E
Eric Blake 已提交
12899
    ret = true;
12900 12901

cleanup:
12902
    VIR_FREE(xml);
12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921
    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")},
12922
    {"parent", VSH_OT_BOOL, 0, N_("add a column showing parent snapshot")},
12923 12924 12925
    {"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")},
12926 12927 12928
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12929
static bool
12930 12931 12932
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
12933
    bool ret = false;
12934
    unsigned int flags = 0;
12935 12936
    int parent_filter = 0; /* -1 for roots filtering, 0 for no parent
                              information needed, 1 for parent column */
12937 12938
    int numsnaps;
    char **names = NULL;
12939
    int actual = 0;
12940 12941 12942 12943 12944 12945
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
12946
    char *parent = NULL;
12947 12948
    long long creation_longlong;
    time_t creation_time_t;
12949 12950 12951
    char timestr[100];
    struct tm time_info;

12952
    if (vshCommandOptBool(cmd, "parent")) {
12953 12954 12955 12956 12957
        if (vshCommandOptBool(cmd, "roots")) {
            vshError(ctl, "%s",
                     _("--parent and --roots are mutually exlusive"));
            return false;
        }
12958
        parent_filter = 1;
12959 12960 12961 12962 12963 12964
    } else if (vshCommandOptBool(cmd, "roots")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
    }

    if (vshCommandOptBool(cmd, "metadata")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_METADATA;
12965 12966
    }

12967
    if (!vshConnectionUsability(ctl, ctl->conn))
12968 12969 12970 12971 12972 12973
        goto cleanup;

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

12974
    numsnaps = virDomainSnapshotNum(dom, flags);
12975

12976 12977 12978 12979 12980 12981 12982 12983 12984 12985
    /* 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);
    }

12986 12987 12988
    if (numsnaps < 0)
        goto cleanup;

12989 12990 12991 12992 12993 12994 12995 12996
    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");
12997 12998 12999 13000 13001

    if (numsnaps) {
        if (VIR_ALLOC_N(names, numsnaps) < 0)
            goto cleanup;

13002
        actual = virDomainSnapshotListNames(dom, names, numsnaps, flags);
13003 13004 13005 13006 13007 13008 13009
        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 */
13010
            VIR_FREE(parent);
13011 13012 13013 13014
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
13015
            xmlFreeDoc(xml);
13016 13017 13018 13019 13020 13021 13022 13023 13024 13025
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

13026
            xml = virXMLParseStringCtxt(doc, "domainsnapshot.xml", &ctxt);
13027 13028 13029
            if (!xml)
                continue;

13030 13031 13032
            if (parent_filter) {
                parent = virXPathString("string(/domainsnapshot/parent/name)",
                                        ctxt);
13033 13034
                if (!parent && parent_filter < 0)
                    continue;
13035 13036
            }

13037 13038 13039
            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
13040 13041
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
13042
                continue;
13043 13044 13045 13046 13047 13048
            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);
13049 13050
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z",
                     &time_info);
13051

13052 13053 13054 13055 13056
            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);
13057 13058 13059
        }
    }

E
Eric Blake 已提交
13060
    ret = true;
13061 13062 13063

cleanup:
    /* this frees up memory from the last iteration of the loop */
13064
    VIR_FREE(parent);
13065 13066 13067 13068
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    xmlXPathFreeContext(ctxt);
13069
    xmlFreeDoc(xml);
13070
    VIR_FREE(doc);
13071 13072
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091
    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")},
13092 13093
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
13094 13095 13096
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13097
static bool
13098 13099 13100
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13101
    bool ret = false;
13102
    const char *name = NULL;
13103 13104
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
13105 13106 13107 13108
    unsigned int flags = 0;

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

13110
    if (!vshConnectionUsability(ctl, ctl->conn))
13111 13112 13113 13114 13115 13116
        goto cleanup;

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

13117
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13118 13119 13120 13121 13122 13123
        goto cleanup;

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

13124
    xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
13125 13126 13127
    if (!xml)
        goto cleanup;

13128
    vshPrint(ctl, "%s", xml);
13129

E
Eric Blake 已提交
13130
    ret = true;
13131 13132 13133 13134 13135 13136 13137 13138 13139 13140 13141

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

    return ret;
}

E
Eric Blake 已提交
13142 13143 13144 13145
/*
 * "snapshot-parent" command
 */
static const vshCmdInfo info_snapshot_parent[] = {
E
Eric Blake 已提交
13146
    {"help", N_("Get the name of the parent of a snapshot")},
E
Eric Blake 已提交
13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186
    {"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;

13187
    xmldoc = virXMLParseStringCtxt(xml, "domainsnapshot.xml", &ctxt);
E
Eric Blake 已提交
13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201
    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);
13202
    xmlFreeDoc(xmldoc);
E
Eric Blake 已提交
13203 13204 13205 13206 13207 13208 13209 13210 13211
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

13212
/*
13213
 * "snapshot-revert" command
13214
 */
13215
static const vshCmdInfo info_snapshot_revert[] = {
13216 13217 13218 13219 13220
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

13221
static const vshCmdOptDef opts_snapshot_revert[] = {
13222 13223
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
13224 13225
    {"running", VSH_OT_BOOL, 0, N_("after reverting, change state to running")},
    {"paused", VSH_OT_BOOL, 0, N_("after reverting, change state to paused")},
13226 13227 13228
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13229
static bool
13230
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
13231 13232
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13233
    bool ret = false;
13234
    const char *name = NULL;
13235
    virDomainSnapshotPtr snapshot = NULL;
13236 13237 13238 13239 13240 13241
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED;
13242

13243
    if (!vshConnectionUsability(ctl, ctl->conn))
13244 13245 13246 13247 13248 13249
        goto cleanup;

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

13250
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13251 13252 13253 13254 13255 13256
        goto cleanup;

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

13257
    if (virDomainRevertToSnapshot(snapshot, flags) < 0)
13258 13259
        goto cleanup;

E
Eric Blake 已提交
13260
    ret = true;
13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276 13277 13278 13279 13280 13281 13282 13283

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")},
13284 13285 13286
    {"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")},
13287 13288 13289
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13290
static bool
13291 13292 13293
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13294
    bool ret = false;
13295
    const char *name = NULL;
13296 13297 13298
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

13299
    if (!vshConnectionUsability(ctl, ctl->conn))
13300 13301 13302 13303 13304 13305
        goto cleanup;

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

13306
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
13307 13308 13309 13310
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;
13311 13312 13313 13314
    if (vshCommandOptBool(cmd, "children-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY;
    if (vshCommandOptBool(cmd, "metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY;
13315 13316 13317 13318 13319

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

13320 13321 13322
    /* 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.  */
13323
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
13324 13325 13326 13327
        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);
13328 13329
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
13330
        goto cleanup;
13331
    }
13332

E
Eric Blake 已提交
13333
    ret = true;
13334 13335 13336 13337 13338 13339 13340 13341 13342 13343

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

    return ret;
}

13344 13345 13346 13347
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
13348 13349
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
13350 13351 13352 13353 13354
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
13355
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
13356
    {"cmd", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("command")},
13357 13358 13359
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13360
static bool
13361 13362 13363
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13364
    bool ret = false;
13365
    char *monitor_cmd = NULL;
13366
    char *result = NULL;
13367
    unsigned int flags = 0;
13368 13369 13370
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
13371 13372 13373 13374 13375 13376 13377 13378

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

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

13379 13380 13381 13382 13383 13384 13385 13386
    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"));
13387 13388
        goto cleanup;
    }
13389
    monitor_cmd = virBufferContentAndReset(&buf);
13390

13391 13392 13393 13394
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
13395 13396 13397 13398
        goto cleanup;

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

E
Eric Blake 已提交
13399
    ret = true;
13400 13401 13402

cleanup:
    VIR_FREE(result);
13403
    VIR_FREE(monitor_cmd);
13404 13405 13406 13407 13408 13409
    if (dom)
        virDomainFree(dom);

    return ret;
}

13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 13451 13452 13453 13454 13455
/*
 * "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;
}

13456
static const vshCmdDef domManagementCmds[] = {
13457 13458 13459 13460 13461 13462 13463 13464
    {"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},
13465 13466
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
13467
#ifndef WIN32
13468
    {"console", cmdConsole, opts_console, info_console, 0},
13469
#endif
13470 13471 13472 13473 13474 13475 13476 13477 13478 13479 13480
    {"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},
13481
    {"domif-setlink", cmdDomIfSetLink, opts_domif_setlink, info_domif_setlink, 0},
13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493
    {"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},
13494
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
13495 13496 13497 13498 13499 13500 13501 13502
    {"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},
13503 13504
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
13505 13506
    {"migrate-getspeed", cmdMigrateGetMaxSpeed,
     opts_migrate_getspeed, info_migrate_getspeed, 0},
13507 13508 13509 13510
    {"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},
13511 13512 13513 13514 13515 13516
    {"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},
13517
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
13518
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530
    {"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 已提交
13531
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
13532
    {"version", cmdVersion, opts_version, info_version, 0},
13533 13534
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
13535 13536 13537
};

static const vshCmdDef domMonitoringCmds[] = {
13538
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
13539
    {"domblklist", cmdDomblklist, opts_domblklist, info_domblklist, 0},
13540
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
13541
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
13542
    {"domif-getlink", cmdDomIfGetLink, opts_domif_getlink, info_domif_getlink, 0},
13543 13544 13545 13546 13547 13548
    {"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}
13549 13550 13551
};

static const vshCmdDef storagePoolCmds[] = {
13552
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
13553
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
13554
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572 13573 13574 13575
     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}
13576 13577 13578
};

static const vshCmdDef storageVolCmds[] = {
13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596
    {"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}
13597
};
13598

13599
static const vshCmdDef networkCmds[] = {
13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618
    {"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}
13619
};
13620

13621
static const vshCmdDef nodedevCmds[] = {
13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 13635 13636
    {"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}
13637 13638 13639
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
13640 13641 13642 13643
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654 13655 13656 13657
    {"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 已提交
13658 13659
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
13660 13661 13662 13663 13664
    {"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}
13665
};
13666

13667
static const vshCmdDef nwfilterCmds[] = {
13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678
    {"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}
13679
};
13680

13681
static const vshCmdDef secretCmds[] = {
13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693
    {"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}
13694
};
13695

13696
static const vshCmdDef virshCmds[] = {
13697 13698 13699 13700 13701 13702 13703
    {"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}
13704
};
13705

13706
static const vshCmdDef snapshotCmds[] = {
13707 13708
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
13709 13710
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
13711 13712 13713 13714 13715 13716
    {"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},
13717 13718
    {"snapshot-edit", cmdSnapshotEdit, opts_snapshot_edit,
     info_snapshot_edit, 0},
13719 13720
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
E
Eric Blake 已提交
13721 13722
    {"snapshot-parent", cmdSnapshotParent, opts_snapshot_parent,
     info_snapshot_parent, 0},
13723 13724 13725
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
13726
};
13727

13728
static const vshCmdDef hostAndHypervisorCmds[] = {
13729 13730 13731 13732 13733
    {"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},
13734
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
13735
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
13736
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
13737
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
13738 13739 13740 13741 13742
    {"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 已提交
13743 13744
};

13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756 13757 13758 13759 13760 13761
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 已提交
13762 13763 13764 13765
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
13766
static const char *
13767
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
13768
{
13769
    const vshCmdInfo *info;
13770

K
Karel Zak 已提交
13771
    for (info = cmd->info; info && info->name; info++) {
13772
        if (STREQ(info->name, name))
K
Karel Zak 已提交
13773 13774 13775 13776 13777
            return info->data;
    }
    return NULL;
}

13778
static int
E
Eric Blake 已提交
13779
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
13780 13781 13782 13783 13784
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
13785 13786 13787
    *opts_need_arg = 0;
    *opts_required = 0;

13788 13789 13790 13791 13792 13793 13794 13795 13796
    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 已提交
13797
            if (opt->flags & VSH_OFLAG_REQ)
13798 13799 13800
                return -1; /* bool options can't be mandatory */
            continue;
        }
E
Eric Blake 已提交
13801 13802
        if (opt->flags & VSH_OFLAG_REQ_OPT) {
            if (opt->flags & VSH_OFLAG_REQ)
L
Lai Jiangshan 已提交
13803 13804 13805 13806
                *opts_required |= 1 << i;
            continue;
        }

13807
        *opts_need_arg |= 1 << i;
E
Eric Blake 已提交
13808
        if (opt->flags & VSH_OFLAG_REQ) {
13809 13810 13811 13812 13813 13814 13815 13816 13817 13818
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
    }
    return 0;
}

13819
static const vshCmdOptDef *
13820 13821
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
13822
{
13823 13824 13825 13826
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
13827

13828 13829 13830 13831 13832
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
13833 13834
            if (opt->type != VSH_OT_ARGV)
                *opts_seen |= 1 << i;
K
Karel Zak 已提交
13835
            return opt;
13836 13837 13838 13839 13840
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
13841 13842 13843
    return NULL;
}

13844
static const vshCmdOptDef *
13845 13846
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
13847
{
13848
    int i;
13849
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
13850

13851 13852 13853 13854
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
13855
    i = ffs(*opts_need_arg) - 1;
13856 13857 13858 13859 13860
    opt = &cmd->opts[i];
    if (opt->type != VSH_OT_ARGV)
        *opts_need_arg &= ~(1 << i);
    *opts_seen |= 1 << i;
    return opt;
K
Karel Zak 已提交
13861 13862
}

13863 13864 13865
/*
 * Checks for required options
 */
13866
static int
13867 13868
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
13869
{
13870
    const vshCmdDef *def = cmd->def;
13871 13872 13873 13874 13875 13876 13877 13878 13879
    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];
13880

13881
            vshError(ctl,
13882
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
13883 13884 13885
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
13886 13887
        }
    }
13888
    return -1;
13889 13890
}

13891
static const vshCmdDef *
13892 13893
vshCmddefSearch(const char *cmdname)
{
13894
    const vshCmdGrp *g;
13895
    const vshCmdDef *c;
13896

13897 13898
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
13899
            if (STREQ(c->name, cmdname))
13900 13901 13902 13903
                return c;
        }
    }

K
Karel Zak 已提交
13904 13905 13906
    return NULL;
}

13907 13908 13909 13910 13911 13912
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
13913
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
13914 13915 13916 13917 13918 13919
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
13920
static bool
13921 13922 13923 13924 13925 13926 13927
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 已提交
13928
        return false;
13929 13930 13931 13932 13933 13934 13935 13936 13937 13938
    } 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 已提交
13939
    return true;
13940 13941
}

E
Eric Blake 已提交
13942
static bool
13943
vshCmddefHelp(vshControl *ctl, const char *cmdname)
13944
{
13945
    const vshCmdDef *def = vshCmddefSearch(cmdname);
13946

K
Karel Zak 已提交
13947
    if (!def) {
13948
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
13949
        return false;
13950
    } else {
E
Eric Blake 已提交
13951 13952
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
13953
        const char *help = _(vshCmddefGetInfo(def, "help"));
13954
        char buf[256];
13955 13956 13957 13958 13959 13960
        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 已提交
13961
            return false;
13962
        }
K
Karel Zak 已提交
13963

13964
        fputs(_("  NAME\n"), stdout);
13965 13966
        fprintf(stdout, "    %s - %s\n", def->name, help);

13967 13968 13969 13970 13971
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
13972
                const char *fmt = "%s";
13973 13974
                switch (opt->type) {
                case VSH_OT_BOOL:
13975
                    fmt = "[--%s]";
13976 13977
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
13978
                    /* xgettext:c-format */
E
Eric Blake 已提交
13979
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>"
13980
                           : _("[--%s <number>]"));
13981 13982
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
13983 13984
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
13985 13986
                    break;
                case VSH_OT_DATA:
E
Eric Blake 已提交
13987
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
13988 13989 13990
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
E
Eric Blake 已提交
13991
                    fmt = (opt->flags & VSH_OFLAG_REQ) ? _("<%s>...")
13992
                           : _("[<%s>]...");
13993 13994
                    break;
                default:
13995
                    assert(0);
13996
                }
13997
                fputc(' ', stdout);
E
Eric Blake 已提交
13998
                fprintf(stdout, fmt, opt->name);
13999
            }
K
Karel Zak 已提交
14000
        }
14001 14002 14003
        fputc('\n', stdout);

        if (desc[0]) {
14004
            /* Print the description only if it's not empty.  */
14005
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
14006
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
14007
        }
14008

K
Karel Zak 已提交
14009
        if (def->opts) {
14010
            const vshCmdOptDef *opt;
14011
            fputs(_("\n  OPTIONS\n"), stdout);
14012
            for (opt = def->opts; opt->name; opt++) {
14013 14014
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
14015
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
14016 14017
                    break;
                case VSH_OT_INT:
14018
                    snprintf(buf, sizeof(buf),
E
Eric Blake 已提交
14019
                             (opt->flags & VSH_OFLAG_REQ) ? _("[--%s] <number>")
14020
                             : _("--%s <number>"), opt->name);
14021 14022
                    break;
                case VSH_OT_STRING:
14023
                    /* OT_STRING should never be VSH_OFLAG_REQ */
14024
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
14025 14026
                    break;
                case VSH_OT_DATA:
14027 14028
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
14029 14030 14031
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
14032 14033
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
14034 14035 14036
                default:
                    assert(0);
                }
14037

E
Eric Blake 已提交
14038
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
14039
            }
K
Karel Zak 已提交
14040 14041 14042
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
14043
    return true;
K
Karel Zak 已提交
14044 14045 14046 14047 14048 14049
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
14050 14051 14052
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
14053 14054
    vshCmdOpt *a = arg;

14055
    while (a) {
K
Karel Zak 已提交
14056
        vshCmdOpt *tmp = a;
14057

K
Karel Zak 已提交
14058 14059
        a = a->next;

14060 14061
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
14062 14063 14064 14065
    }
}

static void
14066
vshCommandFree(vshCmd *cmd)
14067
{
K
Karel Zak 已提交
14068 14069
    vshCmd *c = cmd;

14070
    while (c) {
K
Karel Zak 已提交
14071
        vshCmd *tmp = c;
14072

K
Karel Zak 已提交
14073 14074 14075 14076
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
14077
        VIR_FREE(tmp);
K
Karel Zak 已提交
14078 14079 14080
    }
}

E
Eric Blake 已提交
14081 14082 14083 14084 14085 14086 14087 14088 14089 14090 14091
/**
 * 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 已提交
14092
 */
E
Eric Blake 已提交
14093 14094
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
14095
{
E
Eric Blake 已提交
14096 14097
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
14098

E
Eric Blake 已提交
14099 14100 14101 14102 14103 14104 14105
    /* 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 已提交
14106
    }
E
Eric Blake 已提交
14107 14108 14109 14110 14111 14112 14113

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
E
Eric Blake 已提交
14114
            return (valid->flags & VSH_OFLAG_REQ) == 0 ? 0 : -1;
E
Eric Blake 已提交
14115 14116 14117 14118
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
14119 14120
}

E
Eric Blake 已提交
14121 14122
/**
 * vshCommandOptInt:
14123 14124 14125 14126 14127 14128 14129
 * @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 已提交
14130
 * 0 if option not found and not required (@value untouched)
14131
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
14132 14133
 */
static int
14134
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
14135
{
E
Eric Blake 已提交
14136 14137 14138
    vshCmdOpt *arg;
    int ret;
    int num;
14139
    char *end_p = NULL;
14140

E
Eric Blake 已提交
14141 14142 14143 14144 14145 14146 14147
    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;
14148
    }
E
Eric Blake 已提交
14149 14150 14151 14152 14153 14154 14155

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
14156 14157
}

14158

E
Eric Blake 已提交
14159 14160 14161 14162 14163 14164
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
14165 14166 14167 14168 14169 14170
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
14171 14172 14173
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
14174 14175
    char *end_p = NULL;

E
Eric Blake 已提交
14176 14177 14178 14179 14180 14181 14182
    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;
14183
    }
E
Eric Blake 已提交
14184 14185 14186 14187 14188 14189 14190

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14191 14192 14193
}


14194
/*
E
Eric Blake 已提交
14195 14196 14197 14198 14199
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
14200 14201 14202 14203 14204
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
14205
{
E
Eric Blake 已提交
14206 14207
    vshCmdOpt *arg;
    int ret;
14208
    unsigned long num;
14209 14210
    char *end_p = NULL;

E
Eric Blake 已提交
14211 14212 14213 14214 14215 14216 14217
    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;
14218
    }
E
Eric Blake 已提交
14219 14220 14221 14222 14223 14224 14225

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14226 14227
}

E
Eric Blake 已提交
14228 14229 14230 14231 14232 14233
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
14234
 * Returns option as STRING
E
Eric Blake 已提交
14235 14236 14237 14238
 * 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 已提交
14239
 */
14240 14241
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
14242
{
E
Eric Blake 已提交
14243 14244 14245 14246 14247 14248 14249 14250 14251 14252
    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;
14253
    }
14254

E
Eric Blake 已提交
14255
    if (!*arg->data && !(arg->def->flags & VSH_OFLAG_EMPTY_OK)) {
E
Eric Blake 已提交
14256 14257 14258 14259
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
14260 14261
}

E
Eric Blake 已提交
14262 14263 14264 14265 14266 14267
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
14268
 * Returns option as long long
14269
 * See vshCommandOptInt()
14270
 */
14271 14272 14273
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
14274
{
E
Eric Blake 已提交
14275 14276
    vshCmdOpt *arg;
    int ret;
14277
    long long num;
14278 14279
    char *end_p = NULL;

E
Eric Blake 已提交
14280 14281 14282 14283 14284 14285 14286
    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;
14287
    }
E
Eric Blake 已提交
14288 14289 14290 14291 14292 14293 14294

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14295 14296
}

E
Eric Blake 已提交
14297 14298 14299 14300 14301 14302 14303 14304 14305
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
14306 14307 14308 14309
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
14310 14311
    vshCmdOpt *arg;
    int ret;
14312 14313 14314
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
14315 14316 14317 14318 14319 14320 14321
    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;
14322
    }
E
Eric Blake 已提交
14323 14324 14325 14326 14327 14328 14329

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
14330 14331 14332
}


E
Eric Blake 已提交
14333 14334 14335 14336 14337 14338 14339 14340 14341
/**
 * 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 已提交
14342
 */
E
Eric Blake 已提交
14343
static bool
14344
vshCommandOptBool(const vshCmd *cmd, const char *name)
14345
{
E
Eric Blake 已提交
14346 14347 14348
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
14349 14350
}

E
Eric Blake 已提交
14351 14352 14353 14354 14355
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
14356 14357
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
14358
 *
14359
 * Requires that a VSH_OT_ARGV option be last in the
14360 14361
 * list of supported options in CMD->def->opts.
 */
14362 14363
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
14364
{
14365
    opt = opt ? opt->next : cmd->opts;
14366 14367

    while (opt) {
E
Eric Blake 已提交
14368
        if (opt->def->type == VSH_OT_ARGV) {
14369
            return opt;
14370 14371 14372 14373 14374 14375
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391 14392 14393
/* 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)
14394
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
14395 14396 14397
                 cmd->def->name, optname);
    return found;
}
14398

K
Karel Zak 已提交
14399
static virDomainPtr
J
Jim Meyering 已提交
14400
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
14401
                      const char **name, int flag)
14402
{
K
Karel Zak 已提交
14403
    virDomainPtr dom = NULL;
14404
    const char *n = NULL;
K
Karel Zak 已提交
14405
    int id;
J
Jim Meyering 已提交
14406 14407 14408
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
14409

14410
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14411 14412
        return NULL;

14413
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14414 14415
             cmd->def->name, optname, n);

K
Karel Zak 已提交
14416 14417
    if (name)
        *name = n;
14418

K
Karel Zak 已提交
14419
    /* try it by ID */
14420
    if (flag & VSH_BYID) {
14421
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
14422 14423
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
14424 14425 14426
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
14427
    }
K
Karel Zak 已提交
14428
    /* try it by UUID */
14429
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
14430
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
14431
                 cmd->def->name, optname);
K
Karel Zak 已提交
14432
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
14433
    }
K
Karel Zak 已提交
14434
    /* try it by NAME */
14435
    if (dom==NULL && (flag & VSH_BYNAME)) {
14436
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
14437
                 cmd->def->name, optname);
K
Karel Zak 已提交
14438
        dom = virDomainLookupByName(ctl->conn, n);
14439
    }
K
Karel Zak 已提交
14440

14441
    if (!dom)
14442
        vshError(ctl, _("failed to get domain '%s'"), n);
14443

K
Karel Zak 已提交
14444 14445 14446
    return dom;
}

14447
static virNetworkPtr
J
Jim Meyering 已提交
14448
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
14449
                       const char **name, int flag)
14450 14451
{
    virNetworkPtr network = NULL;
14452
    const char *n = NULL;
J
Jim Meyering 已提交
14453 14454 14455
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
14456

14457
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14458 14459
        return NULL;

14460
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14461 14462 14463 14464 14465 14466
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
14467
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14468
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
14469
                 cmd->def->name, optname);
14470 14471 14472 14473
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
14474
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
14475 14476 14477 14478 14479
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
14480
        vshError(ctl, _("failed to get network '%s'"), n);
14481 14482 14483 14484

    return network;
}

14485 14486 14487

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
14488
                        const char **name, int flag)
14489 14490
{
    virNWFilterPtr nwfilter = NULL;
14491
    const char *n = NULL;
14492 14493 14494 14495
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14496
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14497 14498
        return NULL;

14499
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14500 14501 14502 14503 14504 14505 14506
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14507
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
14508 14509 14510 14511 14512
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
14513
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
14514 14515 14516 14517 14518 14519 14520 14521 14522 14523
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

14524 14525
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
14526
                         const char **name, int flag)
14527 14528
{
    virInterfacePtr iface = NULL;
14529
    const char *n = NULL;
14530 14531 14532 14533
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14534
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14535 14536
        return NULL;

14537
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14538 14539 14540 14541 14542 14543
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
14544
    if ((flag & VSH_BYNAME)) {
14545
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
14546 14547 14548 14549 14550
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
14551
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
14552 14553 14554 14555 14556
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
14557
        vshError(ctl, _("failed to get interface '%s'"), n);
14558 14559 14560 14561

    return iface;
}

14562
static virStoragePoolPtr
14563
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
14564
                    const char **name, int flag)
14565 14566
{
    virStoragePoolPtr pool = NULL;
14567
    const char *n = NULL;
14568

14569
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14570 14571
        return NULL;

14572
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
14573 14574 14575 14576 14577 14578
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
14579
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
14580
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
14581
                 cmd->def->name, optname);
14582 14583 14584
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
14585
    if (pool == NULL && (flag & VSH_BYNAME)) {
14586
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
14587 14588 14589 14590 14591
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
14592
        vshError(ctl, _("failed to get pool '%s'"), n);
14593 14594 14595 14596 14597

    return pool;
}

static virStorageVolPtr
14598
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
14599 14600
                   const char *optname,
                   const char *pooloptname,
14601
                   const char **name, int flag)
14602 14603 14604
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
14605
    const char *n = NULL, *p = NULL;
14606

14607
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14608 14609
        return NULL;

14610
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
14611
        vshError(ctl, "%s", _("missing option"));
14612
        return NULL;
14613
    }
14614 14615 14616 14617

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

14618
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
14619 14620 14621 14622 14623
             cmd->def->name, optname, n);

    if (name)
        *name = n;

14624
    /* try it by name */
14625
    if (pool && (flag & VSH_BYNAME)) {
14626
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
14627 14628 14629
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
14630
    /* try it by key */
14631
    if (vol == NULL && (flag & VSH_BYUUID)) {
14632
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
14633 14634 14635
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
14636
    /* try it by path */
14637
    if (vol == NULL && (flag & VSH_BYUUID)) {
14638
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
14639 14640 14641 14642 14643
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
14644
        vshError(ctl, _("failed to get vol '%s'"), n);
14645 14646 14647 14648 14649 14650 14651

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

14652
static virSecretPtr
14653
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
14654 14655
{
    virSecretPtr secret = NULL;
14656
    const char *n = NULL;
14657 14658 14659 14660 14661
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

14662
    if (vshCommandOptString(cmd, optname, &n) <= 0)
14663 14664
        return NULL;

14665 14666
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
14667 14668 14669 14670 14671 14672 14673

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
14674
        vshError(ctl, _("failed to get secret '%s'"), n);
14675 14676 14677 14678

    return secret;
}

K
Karel Zak 已提交
14679 14680 14681
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
14682
static bool
14683
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
14684
{
E
Eric Blake 已提交
14685
    bool ret = true;
14686 14687

    while (cmd) {
K
Karel Zak 已提交
14688
        struct timeval before, after;
14689
        bool enable_timing = ctl->timing;
14690

14691 14692
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
14693 14694
            vshReconnect(ctl);

14695
        if (enable_timing)
K
Karel Zak 已提交
14696
            GETTIMEOFDAY(&before);
14697

K
Karel Zak 已提交
14698 14699
        ret = cmd->def->handler(ctl, cmd);

14700
        if (enable_timing)
K
Karel Zak 已提交
14701
            GETTIMEOFDAY(&after);
14702

14703
        if (!ret)
J
John Levon 已提交
14704 14705
            virshReportError(ctl);

14706
        /* try to automatically catch disconnections */
14707
        if (!ret &&
14708 14709 14710 14711 14712 14713 14714 14715 14716
            ((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);

14717
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
14718 14719
            return ret;

14720
        if (enable_timing)
14721
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
14722 14723
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
14724
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
14725 14726 14727 14728 14729 14730
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
14731
 * Command parsing
K
Karel Zak 已提交
14732 14733 14734
 * ---------------
 */

14735 14736 14737 14738 14739 14740 14741 14742 14743 14744
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 已提交
14745
    /* vshCommandStringGetArg() */
14746
    char *pos;
L
Lai Jiangshan 已提交
14747 14748 14749
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
14750 14751
} vshCommandParser;

E
Eric Blake 已提交
14752
static bool
14753
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
14754
{
K
Karel Zak 已提交
14755 14756 14757
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
14758

K
Karel Zak 已提交
14759 14760 14761 14762
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
14763

14764
    while (1) {
K
Karel Zak 已提交
14765
        vshCmdOpt *last = NULL;
14766
        const vshCmdDef *cmd = NULL;
14767
        vshCommandToken tk;
L
Lai Jiangshan 已提交
14768
        bool data_only = false;
14769 14770 14771
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
14772

K
Karel Zak 已提交
14773
        first = NULL;
14774

14775
        while (1) {
14776
            const vshCmdOptDef *opt = NULL;
14777

K
Karel Zak 已提交
14778
            tkdata = NULL;
14779
            tk = parser->getNextArg(ctl, parser, &tkdata);
14780 14781

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14782
                goto syntaxError;
H
Hu Tao 已提交
14783 14784
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
14785
                break;
H
Hu Tao 已提交
14786
            }
14787 14788

            if (cmd == NULL) {
K
Karel Zak 已提交
14789 14790
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
14791
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
14792
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
14793
                }
14794 14795 14796 14797 14798 14799 14800
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
14801
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
14802 14803 14804 14805
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
14806 14807 14808 14809 14810
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
14811 14812
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
14813
                    VIR_FREE(optstr);
K
Karel Zak 已提交
14814 14815
                    goto syntaxError;
                }
14816
                VIR_FREE(tkdata);
K
Karel Zak 已提交
14817 14818 14819

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
14820 14821 14822
                    if (optstr)
                        tkdata = optstr;
                    else
14823
                        tk = parser->getNextArg(ctl, parser, &tkdata);
14824
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
14825
                        goto syntaxError;
14826
                    if (tk != VSH_TK_ARG) {
14827
                        vshError(ctl,
14828
                                 _("expected syntax: --%s <%s>"),
14829 14830
                                 opt->name,
                                 opt->type ==
14831
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
14832 14833
                        goto syntaxError;
                    }
14834
                    opts_need_arg &= ~opts_seen;
14835 14836 14837 14838 14839 14840 14841 14842
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
14843
                }
L
Lai Jiangshan 已提交
14844 14845 14846 14847
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
14848
            } else {
L
Lai Jiangshan 已提交
14849
get_data:
14850 14851
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
14852
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
14853 14854 14855 14856 14857
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
14858
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
14859

K
Karel Zak 已提交
14860 14861 14862 14863
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
14864

K
Karel Zak 已提交
14865 14866 14867 14868 14869
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
14870

14871
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
14872 14873
                         cmd->name,
                         opt->name,
14874 14875
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
14876 14877
            }
        }
14878

D
Daniel Veillard 已提交
14879
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
14880
        if (cmd) {
14881
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
14882

K
Karel Zak 已提交
14883 14884 14885 14886
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

14887
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
14888
                VIR_FREE(c);
14889
                goto syntaxError;
14890
            }
14891

K
Karel Zak 已提交
14892 14893 14894 14895 14896 14897
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
14898 14899 14900

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
14901
    }
14902

E
Eric Blake 已提交
14903
    return true;
K
Karel Zak 已提交
14904

14905
 syntaxError:
14906
    if (ctl->cmd) {
K
Karel Zak 已提交
14907
        vshCommandFree(ctl->cmd);
14908 14909
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
14910 14911
    if (first)
        vshCommandOptFree(first);
14912
    VIR_FREE(tkdata);
E
Eric Blake 已提交
14913
    return false;
K
Karel Zak 已提交
14914 14915
}

14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933
/* --------------------
 * 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 已提交
14934 14935
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
14936 14937 14938 14939
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
14940
        return false;
14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 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

    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 已提交
15013 15014
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
15015 15016 15017 15018
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
15019
        return false;
15020 15021 15022 15023 15024 15025

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
15026
/* ---------------
15027
 * Misc utils
K
Karel Zak 已提交
15028 15029
 * ---------------
 */
15030 15031 15032 15033 15034 15035 15036 15037 15038 15039 15040 15041 15042 15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057
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 已提交
15058
static const char *
15059 15060
vshDomainStateToString(int state)
{
15061 15062
    /* Can't use virDomainStateTypeToString, because we want to mark
     * strings for translation.  */
15063
    switch ((virDomainState) state) {
15064
    case VIR_DOMAIN_RUNNING:
15065
        return N_("running");
15066
    case VIR_DOMAIN_BLOCKED:
15067
        return N_("idle");
15068
    case VIR_DOMAIN_PAUSED:
15069
        return N_("paused");
15070
    case VIR_DOMAIN_SHUTDOWN:
15071
        return N_("in shutdown");
15072
    case VIR_DOMAIN_SHUTOFF:
15073
        return N_("shut off");
15074
    case VIR_DOMAIN_CRASHED:
15075
        return N_("crashed");
15076
    case VIR_DOMAIN_NOSTATE:
15077
    default:
15078
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
15079
    }
15080
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
15081 15082
}

15083 15084 15085 15086 15087 15088 15089 15090 15091 15092 15093 15094 15095 15096 15097 15098 15099 15100 15101 15102 15103 15104 15105 15106 15107 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
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;
15179 15180 15181

    default:
        ;
15182 15183 15184 15185 15186
    }

    return N_("unknown");
}

15187 15188 15189 15190 15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203
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");
}

15204 15205 15206 15207
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
15208
    case VIR_VCPU_OFFLINE:
15209
        return N_("offline");
15210
    case VIR_VCPU_BLOCKED:
15211
        return N_("idle");
15212
    case VIR_VCPU_RUNNING:
15213
        return N_("running");
15214
    default:
15215
        ;/*FALLTHROUGH*/
15216
    }
15217
    return N_("no state");
15218 15219
}

E
Eric Blake 已提交
15220
static bool
15221
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
15222
{
15223 15224
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
15225 15226
     */
    if (!conn) {
15227
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
15228
        return false;
K
Karel Zak 已提交
15229
    }
E
Eric Blake 已提交
15230
    return true;
K
Karel Zak 已提交
15231 15232
}

K
Karel Zak 已提交
15233
static void
15234
vshDebug(vshControl *ctl, int level, const char *format, ...)
15235
{
K
Karel Zak 已提交
15236
    va_list ap;
15237
    char *str;
K
Karel Zak 已提交
15238

15239 15240 15241 15242 15243 15244 15245
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

15246
    va_start(ap, format);
15247
    vshOutputLogFile(ctl, level, format, ap);
15248 15249
    va_end(ap);

K
Karel Zak 已提交
15250
    va_start(ap, format);
15251 15252 15253 15254 15255
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
15256
    va_end(ap);
15257 15258
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
15259 15260 15261
}

static void
15262
vshPrintExtra(vshControl *ctl, const char *format, ...)
15263
{
K
Karel Zak 已提交
15264
    va_list ap;
15265
    char *str;
15266

15267
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
15268
        return;
15269

K
Karel Zak 已提交
15270
    va_start(ap, format);
15271 15272 15273 15274 15275
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
15276
    va_end(ap);
15277
    fputs(str, stdout);
15278
    VIR_FREE(str);
K
Karel Zak 已提交
15279 15280
}

K
Karel Zak 已提交
15281

K
Karel Zak 已提交
15282
static void
15283
vshError(vshControl *ctl, const char *format, ...)
15284
{
K
Karel Zak 已提交
15285
    va_list ap;
15286
    char *str;
15287

15288 15289 15290 15291 15292
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
15293

15294 15295 15296 15297
    /* 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);
15298
    fputs(_("error: "), stderr);
15299

K
Karel Zak 已提交
15300
    va_start(ap, format);
15301 15302 15303
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
15304 15305
    va_end(ap);

15306
    fprintf(stderr, "%s\n", NULLSTR(str));
15307
    fflush(stderr);
15308
    VIR_FREE(str);
K
Karel Zak 已提交
15309 15310
}

15311

K
Karel Zak 已提交
15312
/*
15313
 * Initialize connection.
K
Karel Zak 已提交
15314
 */
E
Eric Blake 已提交
15315
static bool
15316
vshInit(vshControl *ctl)
15317
{
15318 15319
    char *debugEnv;

K
Karel Zak 已提交
15320
    if (ctl->conn)
E
Eric Blake 已提交
15321
        return false;
K
Karel Zak 已提交
15322

J
Jiri Denemark 已提交
15323
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
15324 15325 15326
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
15327 15328 15329
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
15330 15331
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
15332 15333
            } else {
                ctl->debug = debug;
15334 15335 15336 15337 15338 15339 15340 15341 15342 15343 15344 15345
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

15346 15347
    vshOpenLogFile(ctl);

15348 15349
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
15350

15351 15352 15353
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

15354
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
15355
        return false;
15356

15357 15358 15359 15360
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
15361

15362 15363 15364 15365 15366 15367 15368 15369 15370 15371 15372
        /* 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;
        }
15373
    }
K
Karel Zak 已提交
15374

E
Eric Blake 已提交
15375
    return true;
K
Karel Zak 已提交
15376 15377
}

15378 15379
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

15380 15381 15382 15383 15384 15385 15386 15387 15388 15389 15390 15391 15392 15393 15394 15395 15396 15397 15398
/**
 * 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:
15399
                vshError(ctl, "%s",
J
Jim Meyering 已提交
15400
                         _("failed to get the log file information"));
15401
                exit(EXIT_FAILURE);
15402 15403 15404
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
15405 15406
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
15407 15408 15409 15410
        }
    }

    /* log file open */
15411
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
15412
        vshError(ctl, "%s",
J
Jim Meyering 已提交
15413
                 _("failed to open the log file. check the log file path"));
15414
        exit(EXIT_FAILURE);
15415 15416 15417 15418 15419 15420 15421 15422 15423
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
15424 15425
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
15426
{
15427 15428 15429
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
15430 15431 15432 15433 15434 15435 15436 15437 15438 15439 15440 15441 15442 15443
    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);
15444
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
15445 15446 15447 15448 15449 15450
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
15451 15452
                      SIGN_NAME,
                      (int) getpid());
15453 15454 15455 15456 15457 15458 15459 15460 15461 15462 15463 15464 15465 15466 15467 15468 15469 15470 15471 15472
    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;
    }
15473 15474 15475
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
15476

15477 15478
    if (virBufferError(&buf))
        goto error;
15479

15480 15481 15482 15483 15484
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
15485
    }
15486

15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497
    /* 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);
15498 15499 15500 15501 15502 15503 15504 15505 15506 15507 15508
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
15509 15510 15511
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
15512 15513 15514
    }

    if (ctl->logfile) {
15515
        VIR_FREE(ctl->logfile);
15516 15517 15518 15519
        ctl->logfile = NULL;
    }
}

15520
#ifdef USE_READLINE
15521

K
Karel Zak 已提交
15522 15523 15524 15525 15526
/* -----------------
 * Readline stuff
 * -----------------
 */

15527
/*
K
Karel Zak 已提交
15528 15529
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
15530
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
15531 15532
 */
static char *
15533 15534
vshReadlineCommandGenerator(const char *text, int state)
{
15535
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
15536
    const char *name;
15537 15538
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
15539 15540

    if (!state) {
15541 15542
        grp_list_index = 0;
        cmd_list_index = 0;
15543
        len = strlen(text);
K
Karel Zak 已提交
15544 15545
    }

15546 15547
    grp = cmdGroups;

K
Karel Zak 已提交
15548
    /* Return the next name which partially matches from the
15549
     * command list.
K
Karel Zak 已提交
15550
     */
15551 15552 15553 15554 15555 15556 15557 15558 15559 15560 15561 15562 15563 15564
    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 已提交
15565 15566 15567 15568 15569 15570 15571
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
15572 15573
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
15574
    static int list_index, len;
15575
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
15576
    const char *name;
K
Karel Zak 已提交
15577 15578 15579 15580 15581 15582 15583 15584 15585

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

15586
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
15587
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
15588 15589 15590

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
15591
        len = strlen(text);
15592
        VIR_FREE(cmdname);
K
Karel Zak 已提交
15593 15594 15595 15596
    }

    if (!cmd)
        return NULL;
15597

15598 15599 15600
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
15601
    while ((name = cmd->opts[list_index].name)) {
15602
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
15603
        char *res;
15604

K
Karel Zak 已提交
15605
        list_index++;
15606

15607
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
15608 15609
            /* ignore non --option */
            continue;
15610

K
Karel Zak 已提交
15611
        if (len > 2) {
15612
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
15613 15614
                continue;
        }
15615
        res = vshMalloc(NULL, strlen(name) + 3);
15616
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
15617 15618 15619 15620 15621 15622 15623 15624
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
15625 15626 15627
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
15628 15629
    char **matches = (char **) NULL;

15630
    if (start == 0)
K
Karel Zak 已提交
15631
        /* command name generator */
15632
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
15633 15634
    else
        /* commands options */
15635
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
15636 15637 15638 15639
    return matches;
}


15640 15641
static int
vshReadlineInit(vshControl *ctl)
15642
{
15643 15644
    char *userdir = NULL;

K
Karel Zak 已提交
15645 15646 15647 15648 15649
    /* 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;
15650 15651 15652

    /* Limit the total size of the history buffer */
    stifle_history(500);
15653 15654

    /* Prepare to read/write history from/to the ~/.virsh/history file */
15655
    userdir = virGetUserDirectory(getuid());
15656

15657 15658
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
15659
        return -1;
15660
    }
15661 15662 15663

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15664
        VIR_FREE(userdir);
15665 15666 15667 15668 15669
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
15670
        VIR_FREE(userdir);
15671 15672 15673
        return -1;
    }

15674
    VIR_FREE(userdir);
15675 15676 15677 15678 15679 15680 15681 15682 15683 15684 15685 15686 15687 15688 15689 15690 15691 15692

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

15693 15694
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
15695 15696
}

15697 15698 15699 15700 15701 15702
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

15703
#else /* !USE_READLINE */
15704

15705 15706 15707 15708 15709 15710 15711
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

15712
static void
15713
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
15714 15715 15716 15717 15718 15719 15720 15721 15722 15723 15724 15725 15726 15727 15728 15729 15730 15731 15732 15733 15734 15735 15736
{
    /* 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);
}

15737
#endif /* !USE_READLINE */
15738

K
Karel Zak 已提交
15739
/*
J
Jim Meyering 已提交
15740
 * Deinitialize virsh
K
Karel Zak 已提交
15741
 */
E
Eric Blake 已提交
15742
static bool
15743
vshDeinit(vshControl *ctl)
15744
{
15745
    vshReadlineDeinit(ctl);
15746
    vshCloseLogFile(ctl);
15747
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
15748
    if (ctl->conn) {
15749 15750 15751
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
15752 15753
        }
    }
D
Daniel P. Berrange 已提交
15754 15755
    virResetLastError();

E
Eric Blake 已提交
15756
    return true;
K
Karel Zak 已提交
15757
}
15758

K
Karel Zak 已提交
15759 15760 15761 15762
/*
 * Print usage
 */
static void
15763
vshUsage(void)
15764
{
15765
    const vshCmdGrp *grp;
15766
    const vshCmdDef *cmd;
15767

L
Lai Jiangshan 已提交
15768 15769
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
15770 15771 15772
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
15773
                      "    -d | --debug <num>      debug level [0-4]\n"
15774 15775 15776 15777
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
15778
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
15779
                      "    -V | --version=long     version and full options\n\n"
15780
                      "  commands (non interactive mode):\n\n"), progname, progname);
15781

15782 15783
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
15784

15785 15786 15787 15788 15789 15790 15791 15792 15793
        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"));
15794 15795 15796
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
15797 15798
}

15799 15800 15801 15802 15803 15804 15805 15806 15807 15808
/*
 * 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 已提交
15809 15810
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
15811 15812 15813 15814 15815 15816 15817 15818 15819 15820 15821 15822 15823 15824 15825 15826 15827 15828 15829 15830 15831 15832 15833 15834 15835 15836 15837 15838 15839 15840 15841 15842 15843 15844 15845
#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 已提交
15846
    vshPrint(ctl, "%s", _(" Networking:"));
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_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 已提交
15873
    vshPrint(ctl, "%s", _(" Storage:"));
15874 15875 15876 15877 15878 15879 15880 15881 15882 15883 15884 15885 15886 15887 15888 15889 15890 15891 15892 15893 15894 15895 15896
#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 已提交
15897
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
15898
#ifdef WITH_SECDRIVER_APPARMOR
15899 15900 15901 15902 15903 15904 15905 15906 15907 15908 15909 15910 15911 15912 15913 15914 15915 15916 15917 15918 15919 15920 15921
    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 已提交
15922 15923 15924 15925
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
15926
static bool
15927
vshParseArgv(vshControl *ctl, int argc, char **argv)
15928
{
15929 15930
    bool help = false;
    int arg;
K
Karel Zak 已提交
15931
    struct option opt[] = {
E
Eric Blake 已提交
15932 15933 15934 15935 15936 15937 15938 15939 15940
        {"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}
15941 15942
    };

15943 15944 15945
    /* 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. */
15946
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
15947
        switch (arg) {
15948
        case 'd':
D
Daniel Veillard 已提交
15949
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
15950
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
15951 15952
                exit(EXIT_FAILURE);
            }
15953 15954
            break;
        case 'h':
15955
            help = true;
15956 15957
            break;
        case 'q':
E
Eric Blake 已提交
15958
            ctl->quiet = true;
15959 15960
            break;
        case 't':
E
Eric Blake 已提交
15961
            ctl->timing = true;
15962 15963 15964 15965
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
15966 15967 15968 15969 15970 15971
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
15972 15973 15974
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
15975
        case 'r':
E
Eric Blake 已提交
15976
            ctl->readonly = true;
15977
            break;
15978 15979 15980
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
15981
        default:
15982 15983
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
15984 15985 15986 15987
        }
    }

    if (help) {
15988 15989
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
15990 15991
            exit(EXIT_FAILURE);
        }
15992 15993 15994

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
15995
        exit(EXIT_SUCCESS);
15996 15997
    }

15998
    if (argc > optind) {
K
Karel Zak 已提交
15999
        /* parse command */
E
Eric Blake 已提交
16000
        ctl->imode = false;
16001
        if (argc - optind == 1) {
16002
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
16003
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
16004
        } else {
16005
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
16006 16007
        }
    }
E
Eric Blake 已提交
16008
    return true;
K
Karel Zak 已提交
16009 16010
}

16011 16012 16013 16014
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
16015
    char *defaultConn;
E
Eric Blake 已提交
16016
    bool ret = true;
K
Karel Zak 已提交
16017

16018 16019 16020
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
16021
    ctl->debug = VSH_DEBUG_DEFAULT;
16022

16023 16024
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
16025
        /* failure to setup locale is not fatal */
16026
    }
16027
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
16028
        perror("bindtextdomain");
E
Eric Blake 已提交
16029
        return EXIT_FAILURE;
16030
    }
16031
    if (!textdomain(PACKAGE)) {
16032
        perror("textdomain");
E
Eric Blake 已提交
16033
        return EXIT_FAILURE;
16034 16035
    }

16036 16037 16038 16039 16040
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

16041
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
16042 16043 16044
        progname = argv[0];
    else
        progname++;
16045

16046
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
16047
        ctl->name = vshStrdup(ctl, defaultConn);
16048 16049
    }

D
Daniel P. Berrange 已提交
16050 16051
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
16052
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
16053
    }
16054

D
Daniel P. Berrange 已提交
16055 16056
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
16057
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
16058
    }
16059

K
Karel Zak 已提交
16060
    if (!ctl->imode) {
16061
        ret = vshCommandRun(ctl, ctl->cmd);
16062
    } else {
K
Karel Zak 已提交
16063 16064
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
16065
            vshPrint(ctl,
16066
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
16067
                     progname);
J
Jim Meyering 已提交
16068
            vshPrint(ctl, "%s",
16069
                     _("Type:  'help' for help with commands\n"
16070
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
16071
        }
16072 16073 16074 16075 16076 16077

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
16078
        do {
16079
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
16080
            ctl->cmdstr =
16081
                vshReadline(ctl, prompt);
16082 16083
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
16084
            if (*ctl->cmdstr) {
16085
#if USE_READLINE
K
Karel Zak 已提交
16086
                add_history(ctl->cmdstr);
16087
#endif
16088
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
16089 16090
                    vshCommandRun(ctl, ctl->cmd);
            }
16091
            VIR_FREE(ctl->cmdstr);
16092
        } while (ctl->imode);
K
Karel Zak 已提交
16093

16094 16095
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
16096
    }
16097

K
Karel Zak 已提交
16098 16099
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
16100
}