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

13
#include <config.h>
14

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

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

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

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

static char *progname;

68 69
#define VIRSH_MAX_XML_FILE 10*1024*1024

K
Karel Zak 已提交
70 71 72
#define VSH_PROMPT_RW    "virsh # "
#define VSH_PROMPT_RO    "virsh > "

73 74
#define VIR_FROM_THIS VIR_FROM_NONE

K
Karel Zak 已提交
75 76 77 78 79
#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)

80 81 82
/* Default escape char Ctrl-] as per telnet */
#define CTRL_CLOSE_BRACKET "^]"

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

J
Jiri Denemark 已提交
110 111
#define VSH_DEBUG_DEFAULT VSH_ERR_ERROR

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

/*
133
 * vshCmdOptType - command option type
134
 */
K
Karel Zak 已提交
135
typedef enum {
136 137 138
    VSH_OT_BOOL,     /* optional boolean option */
    VSH_OT_STRING,   /* optional string option */
    VSH_OT_INT,      /* optional or mandatory int option */
139
    VSH_OT_DATA,     /* string data (as non-option) */
140
    VSH_OT_ARGV      /* remaining arguments */
K
Karel Zak 已提交
141 142
} vshCmdOptType;

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

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

/*
E
Eric Blake 已提交
174 175 176 177 178
 * 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 已提交
179
 */
180
typedef struct {
E
Eric Blake 已提交
181 182
    const char *name;           /* name of information, or NULL for list end */
    const char *data;           /* non-NULL information */
K
Karel Zak 已提交
183 184 185 186 187
} vshCmdInfo;

/*
 * vshCmdOptDef - command option definition
 */
188
typedef struct {
E
Eric Blake 已提交
189
    const char *name;           /* the name of option, or NULL for list end */
190
    vshCmdOptType type;         /* option type */
E
Eric Blake 已提交
191
    unsigned int flags;         /* flags */
E
Eric Blake 已提交
192
    const char *help;           /* non-NULL help string */
K
Karel Zak 已提交
193 194 195 196
} vshCmdOptDef;

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

207 208 209 210 211 212 213
/*
 * Command Usage Flags
 */
enum {
    VSH_CMD_FLAG_NOCONNECT = (1 << 0),  /* no prior connection needed */
};

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

/*
 * vshCmd - parsed command
 */
typedef struct __vshCmd {
229
    const vshCmdDef *def;       /* command definition */
230 231
    vshCmdOpt *opts;            /* list of command arguments */
    struct __vshCmd *next;      /* next command */
K
Karel Zak 已提交
232 233 234 235 236 237
} __vshCmd;

/*
 * vshControl
 */
typedef struct __vshControl {
K
Karel Zak 已提交
238
    char *name;                 /* connection name */
239
    virConnectPtr conn;         /* connection to hypervisor (MAY BE NULL) */
240 241
    vshCmd *cmd;                /* the current command */
    char *cmdstr;               /* string with command */
E
Eric Blake 已提交
242 243
    bool imode;                 /* interactive mode? */
    bool quiet;                 /* quiet mode */
244
    int debug;                  /* print debug messages? */
E
Eric Blake 已提交
245 246
    bool timing;                /* print timing info? */
    bool readonly;              /* connect readonly (first time only, not
247 248
                                 * during explicit connect command)
                                 */
249 250
    char *logfile;              /* log file name */
    int log_fd;                 /* log file descriptor */
251 252
    char *historydir;           /* readline history directory name */
    char *historyfile;          /* readline history file name */
253 254
    bool useGetInfo;            /* must use virDomainGetInfo, since
                                   virDomainGetState is not supported */
255 256
    bool useSnapshotOld;        /* cannot use virDomainSnapshotGetParent or
                                   virDomainSnapshotNumChildren */
J
Jiri Denemark 已提交
257
    virThread eventLoop;
258
    virMutex lock;
J
Jiri Denemark 已提交
259 260
    bool eventLoopStarted;
    bool quit;
261 262 263

    const char *escapeChar;     /* String representation of
                                   console escape character */
K
Karel Zak 已提交
264
} __vshControl;
265

266
typedef struct vshCmdGrp {
E
Eric Blake 已提交
267
    const char *name;    /* name of group, or NULL for list end */
268 269 270
    const char *keyword; /* help keyword */
    const vshCmdDef *commands;
} vshCmdGrp;
271

272
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
273

274 275
static void vshError(vshControl *ctl, const char *format, ...)
    ATTRIBUTE_FMT_PRINTF(2, 3);
E
Eric Blake 已提交
276 277
static bool vshInit(vshControl *ctl);
static bool vshDeinit(vshControl *ctl);
278
static void vshUsage(void);
279
static void vshOpenLogFile(vshControl *ctl);
280 281
static void vshOutputLogFile(vshControl *ctl, int log_level, const char *format, va_list ap)
    ATTRIBUTE_FMT_PRINTF(3, 0);
282
static void vshCloseLogFile(vshControl *ctl);
K
Karel Zak 已提交
283

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

286
static const char *vshCmddefGetInfo(const vshCmdDef *cmd, const char *info);
287
static const vshCmdDef *vshCmddefSearch(const char *cmdname);
E
Eric Blake 已提交
288
static bool vshCmddefHelp(vshControl *ctl, const char *name);
289
static const vshCmdGrp *vshCmdGrpSearch(const char *grpname);
E
Eric Blake 已提交
290
static bool vshCmdGrpHelp(vshControl *ctl, const char *name);
K
Karel Zak 已提交
291

E
Eric Blake 已提交
292 293 294
static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
    ATTRIBUTE_RETURN_CHECK;
295 296
static int vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
297 298 299
static int vshCommandOptUInt(const vshCmd *cmd, const char *name,
                             unsigned int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
300 301 302 303 304 305 306 307 308
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;
309 310 311
static int vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                                  unsigned long long *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
E
Eric Blake 已提交
312
static bool vshCommandOptBool(const vshCmd *cmd, const char *name);
313 314
static const vshCmdOpt *vshCommandOptArgv(const vshCmd *cmd,
                                          const vshCmdOpt *opt);
K
Karel Zak 已提交
315

316 317 318
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
319
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
320

321
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
322
                                          const char **name, int flag);
K
Karel Zak 已提交
323 324

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

328
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
329
                                            const char **name, int flag);
330 331

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
332 333
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
334 335
                           VSH_BYUUID|VSH_BYNAME)

336
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
337
                                                  const char **name, int flag);
338 339 340 341 342 343

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

344
static virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
345
                                                const char *optname,
346
                                                const char **name, int flag);
347 348 349

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

353
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
354
                            const char *optname, const char **name, int flag);
355 356 357 358 359 360

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

361
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
362 363
                                           const char *optname,
                                           const char *pooloptname,
364
                                           const char **name, int flag);
365 366

/* default is lookup by Name and UUID */
367
#define vshCommandOptVol(_ctl, _cmd, _optname, _pooloptname, _name)   \
368 369 370
    vshCommandOptVolBy(_ctl, _cmd, _optname, _pooloptname, _name,     \
                           VSH_BYUUID|VSH_BYNAME)

371
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
372
                                        const char **name);
373

374
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
375
    ATTRIBUTE_FMT_PRINTF(2, 3);
376
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
377
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
378 379

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

382
static int vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason);
K
Karel Zak 已提交
383
static const char *vshDomainStateToString(int state);
384
static const char *vshDomainStateReasonToString(int state, int reason);
385
static const char *vshDomainControlStateToString(int state);
386
static const char *vshDomainVcpuStateToString(int state);
E
Eric Blake 已提交
387
static bool vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
388 389 390
static virTypedParameterPtr vshFindTypedParamByName(const char *name,
                                                    virTypedParameterPtr list,
                                                    int count);
391 392
static char *vshGetTypedParamValue(vshControl *ctl, virTypedParameterPtr item)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
K
Karel Zak 已提交
393

394 395 396 397
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

404
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
405 406
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

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

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;

469
  /* User visible sort, so we want locale-specific case comparison.  */
470 471 472
  return strcasecmp(*sa, *sb);
}

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

    if (last_error->code == VIR_ERR_OK) {
532
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
533 534 535
        goto out;
    }

536
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
537 538 539 540 541 542

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

543 544 545 546 547 548 549 550 551
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;
}

552 553 554 555 556
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

557 558 559 560 561
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

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

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

    if (ctl->conn != NULL) {
        connected = true;
605
        virConnectClose(ctl->conn);
606
    }
607 608 609 610 611 612

    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);
    if (!ctl->conn)
        vshError(ctl, "%s", _("Failed to reconnect to the hypervisor"));
613
    else if (connected)
614 615
        vshError(ctl, "%s", _("Reconnected to the hypervisor"));
    disconnected = 0;
616
    ctl->useGetInfo = false;
617
    ctl->useSnapshotOld = false;
618
}
619

K
Karel Zak 已提交
620 621 622 623 624 625
/* ---------------
 * Commands
 * ---------------
 */

/*
626
 * "help" command
K
Karel Zak 已提交
627
 */
628
static const vshCmdInfo info_help[] = {
629
    {"help", N_("print help")},
630 631
    {"desc", N_("Prints global help, command specific help, or help for a\n"
                "    group of related commands")},
632

633
    {NULL, NULL}
K
Karel Zak 已提交
634 635
};

636
static const vshCmdOptDef opts_help[] = {
637
    {"command", VSH_OT_DATA, 0, N_("Prints global help, command specific help, or help for a group of related commands")},
638
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
639 640
};

E
Eric Blake 已提交
641
static bool
642
cmdHelp(vshControl *ctl, const vshCmd *cmd)
643
 {
644
    const char *name = NULL;
645

646
    if (vshCommandOptString(cmd, "command", &name) <= 0) {
647
        const vshCmdGrp *grp;
648
        const vshCmdDef *def;
649

650 651 652 653 654 655 656 657 658 659 660 661 662
        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 已提交
663
        return true;
664
    }
665

E
Eric Blake 已提交
666
    if (vshCmddefSearch(name)) {
667
        return vshCmddefHelp(ctl, name);
E
Eric Blake 已提交
668
    } else if (vshCmdGrpSearch(name)) {
669 670 671
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
E
Eric Blake 已提交
672
        return false;
K
Karel Zak 已提交
673 674 675
    }
}

676 677 678
/*
 * "autostart" command
 */
679
static const vshCmdInfo info_autostart[] = {
680
    {"help", N_("autostart a domain")},
681
    {"desc",
682
     N_("Configure a domain to be automatically started at boot.")},
683 684 685
    {NULL, NULL}
};

686
static const vshCmdOptDef opts_autostart[] = {
687 688
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
689 690 691
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
692
static bool
693
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
694 695
{
    virDomainPtr dom;
696
    const char *name;
697 698
    int autostart;

699
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
700
        return false;
701

J
Jim Meyering 已提交
702
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
703
        return false;
704 705 706 707

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
708
        if (autostart)
709
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
710
        else
711
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
712
        virDomainFree(dom);
E
Eric Blake 已提交
713
        return false;
714 715
    }

716
    if (autostart)
717
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
718
    else
719
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
720

721
    virDomainFree(dom);
E
Eric Blake 已提交
722
    return true;
723 724
}

K
Karel Zak 已提交
725
/*
726
 * "connect" command
K
Karel Zak 已提交
727
 */
728
static const vshCmdInfo info_connect[] = {
729
    {"help", N_("(re)connect to hypervisor")},
730
    {"desc",
731
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
732
    {NULL, NULL}
K
Karel Zak 已提交
733 734
};

735
static const vshCmdOptDef opts_connect[] = {
E
Eric Blake 已提交
736 737
    {"name",     VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("hypervisor connection URI")},
738
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
739
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
740 741
};

E
Eric Blake 已提交
742
static bool
743
cmdConnect(vshControl *ctl, const vshCmd *cmd)
744
{
E
Eric Blake 已提交
745
    bool ro = vshCommandOptBool(cmd, "readonly");
746
    const char *name = NULL;
747

K
Karel Zak 已提交
748
    if (ctl->conn) {
749 750 751
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
E
Eric Blake 已提交
752
            return false;
K
Karel Zak 已提交
753 754 755
        }
        ctl->conn = NULL;
    }
756

757
    VIR_FREE(ctl->name);
758 759
    if (vshCommandOptString(cmd, "name", &name) < 0) {
        vshError(ctl, "%s", _("Please specify valid connection URI"));
E
Eric Blake 已提交
760
        return false;
761
    }
762
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
763

764
    ctl->useGetInfo = false;
765
    ctl->useSnapshotOld = false;
E
Eric Blake 已提交
766
    ctl->readonly = ro;
K
Karel Zak 已提交
767

768 769 770
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

E
Eric Blake 已提交
774
    return !!ctl->conn;
K
Karel Zak 已提交
775 776
}

777 778
#ifndef WIN32

779
/*
780
 * "console" command
781
 */
782
static const vshCmdInfo info_console[] = {
783
    {"help", N_("connect to the guest console")},
784
    {"desc",
785
     N_("Connect the virtual serial console for the guest")},
786 787 788
    {NULL, NULL}
};

789
static const vshCmdOptDef opts_console[] = {
790
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
791
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
792 793 794
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
795
static bool
796
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
797
{
E
Eric Blake 已提交
798
    bool ret = false;
799
    int state;
800

801
    if ((state = vshDomainState(ctl, dom, NULL)) < 0) {
802 803 804 805
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

806
    if (state == VIR_DOMAIN_SHUTOFF) {
807 808 809 810
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

811
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
812 813
    vshPrintExtra(ctl, _("Escape character is %s\n"), ctl->escapeChar);
    if (vshRunConsole(dom, name, ctl->escapeChar) == 0)
E
Eric Blake 已提交
814
        ret = true;
815 816

 cleanup:
817

818 819 820
    return ret;
}

E
Eric Blake 已提交
821
static bool
822 823 824
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
825
    bool ret = false;
826
    const char *name = NULL;
827

828
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
829
        return false;
830 831

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

834 835 836 837
    if (vshCommandOptString(cmd, "devname", &name) < 0) {
        vshError(ctl, "%s", _("Invalid devname"));
        goto cleanup;
    }
838

839
    ret = cmdRunConsole(ctl, dom, name);
840

841
cleanup:
842 843 844 845
    virDomainFree(dom);
    return ret;
}

846 847 848
#endif /* WIN32 */


K
Karel Zak 已提交
849 850 851
/*
 * "list" command
 */
852
static const vshCmdInfo info_list[] = {
853 854
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
855
    {NULL, NULL}
K
Karel Zak 已提交
856 857
};

858
static const vshCmdOptDef opts_list[] = {
859 860
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
E
Eric Blake 已提交
861 862
    {"managed-save", VSH_OT_BOOL, 0,
     N_("mark domains with managed save state")},
863 864 865
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
866

E
Eric Blake 已提交
867
static bool
868
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
869
{
870 871 872 873
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
874
    char **names = NULL;
875
    int maxname = 0;
E
Eric Blake 已提交
876 877 878
    bool managed = vshCommandOptBool(cmd, "managed-save");
    int state;

879
    inactive |= all;
K
Karel Zak 已提交
880

881
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
882
        return false;
883

884
    if (active) {
885 886
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
887
            vshError(ctl, "%s", _("Failed to list active domains"));
E
Eric Blake 已提交
888
            return false;
889 890 891 892 893
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
894
                vshError(ctl, "%s", _("Failed to list active domains"));
895
                VIR_FREE(ids);
E
Eric Blake 已提交
896
                return false;
897 898
            }

899
            qsort(&ids[0], maxid, sizeof(int), idsorter);
900
        }
901 902
    }
    if (inactive) {
903 904
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
905
            vshError(ctl, "%s", _("Failed to list inactive domains"));
906
            VIR_FREE(ids);
E
Eric Blake 已提交
907
            return false;
908
        }
909 910 911 912
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
913
                vshError(ctl, "%s", _("Failed to list inactive domains"));
914 915
                VIR_FREE(ids);
                VIR_FREE(names);
E
Eric Blake 已提交
916
                return false;
917
            }
918

919
            qsort(&names[0], maxname, sizeof(char*), namesorter);
920
        }
921
    }
922
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
923
    vshPrintExtra(ctl, "----------------------------------\n");
924 925

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

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

K
Karel Zak 已提交
932
        vshPrint(ctl, "%3d %-20s %s\n",
933 934
                 virDomainGetID(dom),
                 virDomainGetName(dom),
E
Eric Blake 已提交
935
                 _(vshDomainStateToString(vshDomainState(ctl, dom, NULL))));
936
        virDomainFree(dom);
K
Karel Zak 已提交
937
    }
938 939 940 941
    for (i = 0; i < maxname; i++) {
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);

        /* this kind of work with domains is not atomic operation */
942
        if (!dom) {
943
            VIR_FREE(names[i]);
944
            continue;
945
        }
946

E
Eric Blake 已提交
947 948 949 950 951
        state = vshDomainState(ctl, dom, NULL);
        if (managed && state == VIR_DOMAIN_SHUTOFF &&
            virDomainHasManagedSaveImage(dom, 0) > 0)
            state = -2;

952 953 954
        vshPrint(ctl, "%3s %-20s %s\n",
                 "-",
                 names[i],
E
Eric Blake 已提交
955
                 state == -2 ? _("saved") : _(vshDomainStateToString(state)));
956

957
        virDomainFree(dom);
958
        VIR_FREE(names[i]);
959
    }
960 961
    VIR_FREE(ids);
    VIR_FREE(names);
E
Eric Blake 已提交
962
    return true;
K
Karel Zak 已提交
963 964 965
}

/*
K
Karel Zak 已提交
966
 * "domstate" command
K
Karel Zak 已提交
967
 */
968
static const vshCmdInfo info_domstate[] = {
969 970
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
971
    {NULL, NULL}
K
Karel Zak 已提交
972 973
};

974
static const vshCmdOptDef opts_domstate[] = {
975
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
976
    {"reason", VSH_OT_BOOL, 0, N_("also print reason for the state")},
977
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
978 979
};

E
Eric Blake 已提交
980
static bool
981
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
982
{
K
Karel Zak 已提交
983
    virDomainPtr dom;
E
Eric Blake 已提交
984
    bool ret = true;
985 986
    int showReason = vshCommandOptBool(cmd, "reason");
    int state, reason;
987

988
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
989
        return false;
990

J
Jim Meyering 已提交
991
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
992
        return false;
993

994
    if ((state = vshDomainState(ctl, dom, &reason)) < 0) {
E
Eric Blake 已提交
995
        ret = false;
996 997 998 999 1000 1001 1002 1003 1004 1005 1006
        goto cleanup;
    }

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

1008
cleanup:
1009 1010 1011 1012
    virDomainFree(dom);
    return ret;
}

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 1053 1054 1055 1056 1057 1058 1059
/*
 * "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;
}

1060 1061
/* "domblkstat" command
 */
1062
static const vshCmdInfo info_domblkstat[] = {
1063
    {"help", N_("get device block stats for a domain")},
1064 1065
    {"desc", N_("Get device block stats for a running domain. See man page or "
                "use --human for explanation of fields")},
1066 1067 1068
    {NULL,NULL}
};

1069
static const vshCmdOptDef opts_domblkstat[] = {
1070 1071
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
    {"human",  VSH_OT_BOOL, 0, N_("print a more human readable output")},
    {NULL, 0, 0, NULL}
};

struct _domblkstat_sequence {
    const char *field;  /* field name */
    const char *legacy; /* legacy name from previous releases */
    const char *human;  /* human-friendly explanation */
};

/* sequence of values for output to honor legacy format from previous
 * versions */
static const struct _domblkstat_sequence domblkstat_output[] = {
    { VIR_DOMAIN_BLOCK_STATS_READ_REQ,          "rd_req",
1086
      N_("number of read operations:") }, /* 0 */
1087
    { VIR_DOMAIN_BLOCK_STATS_READ_BYTES,        "rd_bytes",
1088
      N_("number of bytes read:") }, /* 1 */
1089
    { VIR_DOMAIN_BLOCK_STATS_WRITE_REQ,         "wr_req",
1090
      N_("number of write operations:") }, /* 2 */
1091
    { VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES,       "wr_bytes",
1092
      N_("number of bytes written:") }, /* 3 */
1093
    { VIR_DOMAIN_BLOCK_STATS_ERRS,              "errs",
1094
      N_("error count:") }, /* 4 */
1095
    { VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ,         NULL,
1096
      N_("number of flush operations:") }, /* 5 */
1097
    { VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES,  NULL,
1098
      N_("total duration of reads (ns):") }, /* 6 */
1099
    { VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES, NULL,
1100
      N_("total duration of writes (ns):") }, /* 7 */
1101 1102 1103 1104 1105 1106 1107
    { VIR_DOMAIN_BLOCK_STATS_FLUSH_TOTAL_TIMES, NULL,
      N_("total duration of flushes (ns):") }, /* 8 */
    { NULL, NULL, NULL }
};

#define DOMBLKSTAT_LEGACY_PRINT(ID, VALUE)              \
    if (VALUE >= 0)                                     \
1108 1109
        vshPrint(ctl, "%s %-*s %lld\n", device,         \
                 human ? 31 : 0,                        \
1110 1111 1112
                 human ? _(domblkstat_output[ID].human) \
                 : domblkstat_output[ID].legacy,        \
                 VALUE);
1113

E
Eric Blake 已提交
1114
static bool
1115
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
1116 1117
{
    virDomainPtr dom;
1118
    const char *name = NULL, *device = NULL;
1119
    struct _virDomainBlockStats stats;
1120
    virTypedParameterPtr params = NULL;
1121 1122 1123
    virTypedParameterPtr par = NULL;
    char *value = NULL;
    const char *field = NULL;
1124
    int rc, nparams = 0;
1125
    int i = 0;
1126
    bool ret = false;
1127
    bool human = vshCommandOptBool(cmd, "human"); /* human readable output */
1128

1129
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1130
        return false;
1131

1132
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1133
        return false;
1134

1135
    if (vshCommandOptString(cmd, "device", &device) <= 0)
1136
        goto cleanup;
1137

1138 1139 1140 1141 1142 1143 1144
    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) {
1145 1146
        /* try older API if newer is not supported */
        if (last_error->code != VIR_ERR_NO_SUPPORT)
1147 1148
            goto cleanup;

1149 1150
        virFreeError(last_error);
        last_error = NULL;
1151

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

1159 1160 1161 1162
        /* human friendly output */
        if (human) {
            vshPrint(ctl, N_("Device: %s\n"), device);
            device = "";
1163
        }
1164 1165 1166 1167 1168 1169

        DOMBLKSTAT_LEGACY_PRINT(0, stats.rd_req);
        DOMBLKSTAT_LEGACY_PRINT(1, stats.rd_bytes);
        DOMBLKSTAT_LEGACY_PRINT(2, stats.wr_req);
        DOMBLKSTAT_LEGACY_PRINT(3, stats.wr_bytes);
        DOMBLKSTAT_LEGACY_PRINT(4, stats.errs);
1170
    } else {
1171
        params = vshCalloc(ctl, nparams, sizeof(*params));
1172

1173 1174 1175 1176
        if (virDomainBlockStatsFlags (dom, device, params, &nparams, 0) < 0) {
            vshError(ctl, _("Failed to get block stats %s %s"), name, device);
            goto cleanup;
        }
1177

1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
        /* set for prettier output */
        if (human) {
            vshPrint(ctl, N_("Device: %s\n"), device);
            device = "";
        }

        /* at first print all known values in desired order */
        for (i = 0; domblkstat_output[i].field != NULL; i++) {
            if (!(par = vshFindTypedParamByName(domblkstat_output[i].field,
                                                params,
                                                nparams)))
                continue;

1191
            value = vshGetTypedParamValue(ctl, par);
1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206

            /* to print other not supported fields, mark the already printed */
            par->field[0] = '\0'; /* set the name to empty string */

            /* translate into human readable or legacy spelling */
            field = NULL;
            if (human)
                field = _(domblkstat_output[i].human);
            else
                field = domblkstat_output[i].legacy;

            /* use the provided spelling if no translation is available */
            if (!field)
                field = domblkstat_output[i].field;

1207 1208
            vshPrint(ctl, "%s %-*s %s\n", device,
                     human ? 31 : 0, field, value);
1209 1210 1211 1212 1213

            VIR_FREE(value);
        }

        /* go through the fields again, for remaining fields */
1214
        for (i = 0; i < nparams; i++) {
1215 1216
            if (!*params[i].field)
                continue;
1217

1218
            value = vshGetTypedParamValue(ctl, params+i);
1219 1220
            vshPrint(ctl, "%s %s %s\n", device, params[i].field, value);
            VIR_FREE(value);
1221 1222 1223 1224 1225 1226 1227
        }
    }

    ret = true;

cleanup:
    VIR_FREE(params);
1228
    virDomainFree(dom);
1229
    return ret;
1230
}
1231
#undef DOMBLKSTAT_LEGACY_PRINT
1232 1233 1234

/* "domifstat" command
 */
1235
static const vshCmdInfo info_domifstat[] = {
1236 1237
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1238 1239 1240
    {NULL,NULL}
};

1241
static const vshCmdOptDef opts_domifstat[] = {
1242 1243
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1244 1245 1246
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1247
static bool
1248
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1249 1250
{
    virDomainPtr dom;
1251
    const char *name = NULL, *device = NULL;
1252 1253
    struct _virDomainInterfaceStats stats;

1254
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1255
        return false;
1256

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

1260
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1261
        virDomainFree(dom);
E
Eric Blake 已提交
1262
        return false;
L
Laine Stump 已提交
1263
    }
1264 1265

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1266
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1267
        virDomainFree(dom);
E
Eric Blake 已提交
1268
        return false;
1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295
    }

    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 已提交
1296
    return true;
1297 1298
}

1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
/* "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;
1319
    const char *iface;
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338
    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;

1339
    if (vshCommandOptString(cmd, "interface", &iface) <= 0)
1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
        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 */
1368
    xml = virXMLParseStringCtxt(desc, _("(domain_definition)"), &ctxt);
1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
    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");

1391
                if (STRCASEEQ(mac, iface)) {
1392 1393 1394 1395 1396 1397 1398 1399 1400
                    VIR_FREE(mac);
                    goto hit;
                }
                VIR_FREE(mac);
            }
            cur = cur->next;
        }
    }

1401
    vshError(ctl, _("interface with address '%s' not found"), iface);
1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
    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;
1483
    const char *iface = NULL;
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500
    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;

1501
    if (vshCommandOptString (cmd, "interface", &iface) <= 0) {
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514
        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;
    }

1515
    xml = virXMLParseStringCtxt(desc, _("(domain_definition)"), &ctxt);
1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538
    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");

1539
                if (STRCASEEQ(mac, iface)){
1540 1541 1542
                    VIR_FREE(mac);
                    goto hit;
                }
1543
                VIR_FREE(mac);
1544 1545 1546 1547 1548
            }
            cur = cur->next;
        }
    }

1549
    vshError(ctl, _("Interface with address '%s' not found."), iface);
1550 1551 1552 1553 1554 1555 1556 1557 1558
    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");
1559
            vshPrint(ctl, "%s %s", iface, state);
1560 1561 1562 1563 1564 1565 1566 1567
            VIR_FREE(state);

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

    /* attribute not found */
1568
    vshPrint(ctl, "%s default", iface);
1569

1570
    ret = true;
1571 1572 1573 1574 1575 1576 1577 1578 1579 1580
cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    if (dom)
        virDomainFree(dom);

    return ret;
}

1581 1582 1583
/*
 * "dommemstats" command
 */
1584
static const vshCmdInfo info_dommemstat[] = {
1585 1586
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1587 1588 1589
    {NULL,NULL}
};

1590
static const vshCmdOptDef opts_dommemstat[] = {
1591
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1592 1593 1594
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1595
static bool
1596
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1597 1598
{
    virDomainPtr dom;
1599
    const char *name;
1600 1601 1602
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1607
        return false;
1608 1609 1610 1611 1612

    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 已提交
1613
        return false;
1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628
    }

    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);
1629 1630
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON)
            vshPrint (ctl, "actual %llu\n", stats[i].val);
1631 1632 1633
    }

    virDomainFree(dom);
E
Eric Blake 已提交
1634
    return true;
1635 1636
}

1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651
/*
 * "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 已提交
1652
static bool
1653 1654 1655 1656
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1657
    bool ret = true;
1658
    const char *device = NULL;
1659

1660
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1661
        return false;
1662 1663

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

1666
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1667
        virDomainFree(dom);
E
Eric Blake 已提交
1668
        return false;
1669 1670 1671 1672
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1673
        return false;
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683
    }

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

1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725
/*
 * "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;

1726
    xmldoc = virXMLParseStringCtxt(xml, _("(domain_definition)"), &ctxt);
1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755
    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);
    }

A
Alex Jia 已提交
1756
    ret = true;
1757 1758 1759 1760

cleanup:
    VIR_FREE(disks);
    virDomainFree(dom);
1761 1762 1763
    VIR_FREE(xml);
    xmlFreeDoc(xmldoc);
    xmlXPathFreeContext(ctxt);
1764 1765 1766
    return ret;
}

1767 1768 1769
/*
 * "suspend" command
 */
1770
static const vshCmdInfo info_suspend[] = {
1771 1772
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1773
    {NULL, NULL}
1774 1775
};

1776
static const vshCmdOptDef opts_suspend[] = {
1777
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1778
    {NULL, 0, 0, NULL}
1779 1780
};

E
Eric Blake 已提交
1781
static bool
1782
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1783
{
1784
    virDomainPtr dom;
1785
    const char *name;
E
Eric Blake 已提交
1786
    bool ret = true;
1787

1788
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1789
        return false;
1790

J
Jim Meyering 已提交
1791
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1792
        return false;
1793 1794

    if (virDomainSuspend(dom) == 0) {
1795
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1796
    } else {
1797
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1798
        ret = false;
1799
    }
1800

1801 1802 1803 1804
    virDomainFree(dom);
    return ret;
}

1805 1806 1807
/*
 * "create" command
 */
1808
static const vshCmdInfo info_create[] = {
1809 1810
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1811 1812 1813
    {NULL, NULL}
};

1814
static const vshCmdOptDef opts_create[] = {
1815
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1816
#ifndef WIN32
1817
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1818
#endif
1819
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1820
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1821 1822 1823
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1824
static bool
1825
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1826 1827
{
    virDomainPtr dom;
1828
    const char *from = NULL;
E
Eric Blake 已提交
1829
    bool ret = true;
1830
    char *buffer;
1831
#ifndef WIN32
1832
    int console = vshCommandOptBool(cmd, "console");
1833
#endif
1834
    unsigned int flags = VIR_DOMAIN_NONE;
1835

1836
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1837
        return false;
1838

1839
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1840
        return false;
1841

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

1845 1846
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1847 1848
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1849 1850

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1851
    VIR_FREE(buffer);
1852

1853
    if (dom != NULL) {
1854
        vshPrint(ctl, _("Domain %s created from %s\n"),
1855
                 virDomainGetName(dom), from);
1856
#ifndef WIN32
1857
        if (console)
1858
            cmdRunConsole(ctl, dom, NULL);
1859
#endif
1860
        virDomainFree(dom);
1861
    } else {
1862
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1863
        ret = false;
1864 1865 1866 1867
    }
    return ret;
}

1868 1869 1870
/*
 * "define" command
 */
1871
static const vshCmdInfo info_define[] = {
1872 1873
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1874 1875 1876
    {NULL, NULL}
};

1877
static const vshCmdOptDef opts_define[] = {
1878
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1879 1880 1881
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1882
static bool
1883
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1884 1885
{
    virDomainPtr dom;
1886
    const char *from = NULL;
E
Eric Blake 已提交
1887
    bool ret = true;
1888
    char *buffer;
1889

1890
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1891
        return false;
1892

1893
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1894
        return false;
1895

1896
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1897
        return false;
1898 1899

    dom = virDomainDefineXML(ctl->conn, buffer);
1900
    VIR_FREE(buffer);
1901

1902
    if (dom != NULL) {
1903
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1904
                 virDomainGetName(dom), from);
1905
        virDomainFree(dom);
1906
    } else {
1907
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1908
        ret = false;
1909 1910 1911 1912 1913 1914 1915
    }
    return ret;
}

/*
 * "undefine" command
 */
1916
static const vshCmdInfo info_undefine[] = {
1917 1918 1919
    {"help", N_("undefine a domain")},
    {"desc",
     N_("Undefine an inactive domain, or convert persistent to transient.")},
1920 1921 1922
    {NULL, NULL}
};

1923
static const vshCmdOptDef opts_undefine[] = {
1924
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1925
    {"managed-save", VSH_OT_BOOL, 0, N_("remove domain managed state file")},
1926 1927 1928 1929 1930 1931 1932
    {"storage", VSH_OT_DATA, VSH_OFLAG_NONE,
     N_("remove associated storage volumes (comma separated list of targets "
        "or source paths) (see domblklist)")},
    {"remove-all-storage", VSH_OT_BOOL, 0,
     N_("remove all associated storage volumes (use with caution)")},
    {"wipe-storage", VSH_OT_BOOL, VSH_OFLAG_NONE,
     N_("wipe data on the removed volumes")},
1933 1934
    {"snapshots-metadata", VSH_OT_BOOL, 0,
     N_("remove all domain snapshot metadata, if inactive")},
1935 1936 1937
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1938
static bool
1939
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1940 1941
{
    virDomainPtr dom;
1942
    bool ret = false;
1943
    const char *name = NULL;
1944
    /* Flags to attempt.  */
E
Eric Blake 已提交
1945
    unsigned int flags = 0;
1946 1947 1948
    /* User-requested actions.  */
    bool managed_save = vshCommandOptBool(cmd, "managed-save");
    bool snapshots_metadata = vshCommandOptBool(cmd, "snapshots-metadata");
1949 1950 1951
    bool wipe_storage = vshCommandOptBool(cmd, "wipe-storage");
    bool remove_storage = false;
    bool remove_all_storage = vshCommandOptBool(cmd, "remove-all-storage");
1952
    /* Positive if these items exist.  */
1953
    int has_managed_save = 0;
1954 1955 1956 1957 1958
    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;
1959
    int rc = -1;
1960
    int running;
1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
    /* list of volumes to remove along with this domain */
    const char *volumes_arg = NULL;
    char *volumes = NULL;
    char **volume_tokens = NULL;
    char *volume_tok = NULL;
    int nvolume_tokens = 0;
    char *def = NULL;
    char *source = NULL;
    char *target = NULL;
    int vol_i;
    int tok_i;
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr *vol_nodes = NULL;
    int nvolumes = 0;
    virStorageVolPtr vol = NULL;
    bool vol_del_failed = false;
1978

1979
    if (managed_save) {
1980
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
1981 1982 1983 1984 1985 1986
        managed_save_safe = true;
    }
    if (snapshots_metadata) {
        flags |= VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
1987

1988
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1989
        return false;
1990

1991
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1992
        return false;
1993

1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004
    /* check if a string that should contain list of volumes to remove is present */
    if (vshCommandOptString(cmd, "storage", &volumes_arg) > 0) {
        volumes = vshStrdup(ctl, volumes_arg);

        if (remove_all_storage) {
            vshError(ctl, _("Specified both --storage and --remove-all-storage"));
            goto cleanup;
        }
        remove_storage = true;
   }

2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023
    /* 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;
            }
2024 2025
            virFreeError(last_error);
            last_error = NULL;
2026
            has_managed_save = 0;
2027 2028
        }

2029 2030
        has_snapshots = virDomainSnapshotNum(dom, 0);
        if (has_snapshots < 0) {
2031 2032
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044
                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.  */
2045 2046
                virFreeError(last_error);
                last_error = NULL;
2047 2048 2049 2050 2051
                has_snapshots_metadata = has_snapshots;
            } else {
                /* The server knew the new flag, all aspects of
                 * undefineFlags are safe.  */
                managed_save_safe = snapshots_safe = true;
2052
            }
2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065
        }
    }
    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;
    }
2066

2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079
    /* Stash domain description for later use */
    if (remove_storage || remove_all_storage) {
        if (running) {
            vshError(ctl, _("Storage volume deletion is supported only on stopped domains"));
            goto cleanup;
        }

        if (!(def = virDomainGetXMLDesc(dom, 0))) {
            vshError(ctl, _("Could not retrieve domain XML description"));
            goto cleanup;
        }
    }

2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093
    /* 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;
    }
2094

2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106
    /* 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;
2107 2108 2109
        }
    }

2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123
    /* 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:
2124
    if (rc == 0) {
2125
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
2126
        ret = true;
2127
    } else {
2128
        vshError(ctl, _("Failed to undefine domain %s"), name);
2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 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
        goto cleanup;
    }

    /* try to undefine storage volumes associated with this domain, if it's requested */
    if (remove_storage || remove_all_storage) {
        ret = false;

        /* tokenize the string from user and save it's parts into an array */
        if (volumes) {
            /* count the delimiters */
            volume_tok = volumes;
            nvolume_tokens = 1; /* we need at least one member */
            while (*volume_tok) {
                if (*volume_tok == ',')
                    nvolume_tokens++;
                volume_tok++;
            }

            volume_tokens = vshCalloc(ctl, nvolume_tokens,  sizeof(char *));

            /* tokenize the input string */
            nvolume_tokens = 0;
            volume_tok = volumes;
            do {
                volume_tokens[nvolume_tokens] = strsep(&volume_tok, ",");
                nvolume_tokens++;
            } while (volume_tok);
        }

        doc = virXMLParseStringCtxt(def, _("(domain_definition)"), &ctxt);
        if (!doc)
            goto cleanup;

        nvolumes = virXPathNodeSet("./devices/disk", ctxt, &vol_nodes);

        if (nvolumes < 0)
            goto cleanup;

        for (vol_i = 0; vol_i < nvolumes; vol_i++) {
            ctxt->node = vol_nodes[vol_i];
            VIR_FREE(target);
            VIR_FREE(source);
            if (vol) {
                virStorageVolFree(vol);
                vol = NULL;
            }

            /* get volume source and target paths */
            if (!(target = virXPathString("string(./target/@dev)", ctxt))) {
                vshError(ctl, _("Failed to enumerate devices"));
                goto cleanup;
            }

            if (!(source = virXPathString("string("
                                          "./source/@file|"
                                          "./source/@dir|"
                                          "./source/@name|"
                                          "./source/@dev)", ctxt)) &&
                virGetLastError())
                goto cleanup;

            /* lookup if volume was selected by user */
            if (volumes) {
                volume_tok = NULL;
                for (tok_i = 0; tok_i < nvolume_tokens; tok_i++) {
                    if (volume_tokens[tok_i] &&
                        (STREQ_NULLABLE(volume_tokens[tok_i], target) ||
                         STREQ_NULLABLE(volume_tokens[tok_i], source))) {
                        volume_tok = volume_tokens[tok_i];
                        volume_tokens[tok_i] = NULL;
                        break;
                    }
                }
                if (!volume_tok)
                    continue;
            }

            if (!source)
                continue;

            if (!(vol = virStorageVolLookupByPath(ctl->conn, source))) {
                vshPrint(ctl,
                         _("Storage volume '%s'(%s) is not managed by libvirt. "
                           "Remove it manually.\n"), target, source);
                virResetLastError();
                continue;
            }

            if (wipe_storage) {
                vshPrint(ctl, _("Wiping volume '%s'(%s) ... "), target, source);
                fflush(stdout);
                if (virStorageVolWipe(vol, 0) < 0) {
                    vshError(ctl, _("Failed! Volume not removed."));
                    vol_del_failed = true;
                    continue;
                } else {
                    vshPrint(ctl, _("Done.\n"));
                }
            }

            /* delete the volume */
            if (virStorageVolDelete(vol, 0) < 0) {
                vshError(ctl, _("Failed to remove storage volume '%s'(%s)"),
                         target, source);
                vol_del_failed = true;
            }
            vshPrint(ctl, _("Volume '%s' removed.\n"), volume_tok?volume_tok:source);
        }

        /* print volumes specified by user that were not found in domain definition */
        if (volumes) {
            for (tok_i = 0; tok_i < nvolume_tokens; tok_i++) {
                if (volume_tokens[tok_i])
                    vshPrint(ctl, _("Volume '%s' was not found in domain's "
                                    "definition.\n"),
                             volume_tokens[tok_i]);
            }
        }

        if (!vol_del_failed)
            ret = true;
2250 2251
    }

2252
cleanup:
2253 2254 2255 2256 2257 2258 2259 2260
    VIR_FREE(source);
    VIR_FREE(target);
    VIR_FREE(volumes);
    VIR_FREE(volume_tokens);
    VIR_FREE(def);
    VIR_FREE(vol_nodes);
    xmlFreeDoc(doc);
    xmlXPathFreeContext(ctxt);
2261
    virDomainFree(dom);
2262 2263 2264 2265 2266 2267 2268
    return ret;
}


/*
 * "start" command
 */
2269
static const vshCmdInfo info_start[] = {
2270
    {"help", N_("start a (previously defined) inactive domain")},
2271 2272 2273
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
2274 2275 2276
    {NULL, NULL}
};

2277
static const vshCmdOptDef opts_start[] = {
2278
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
2279
#ifndef WIN32
2280
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
2281
#endif
E
Eric Blake 已提交
2282
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
2283 2284
    {"autodestroy", VSH_OT_BOOL, 0,
     N_("automatically destroy the guest when virsh disconnects")},
2285 2286
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when loading")},
2287 2288
    {"force-boot", VSH_OT_BOOL, 0,
     N_("force fresh boot by discarding any managed save")},
2289 2290 2291
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2292
static bool
2293
cmdStart(vshControl *ctl, const vshCmd *cmd)
2294 2295
{
    virDomainPtr dom;
2296
    bool ret = false;
2297
#ifndef WIN32
2298
    int console = vshCommandOptBool(cmd, "console");
2299
#endif
E
Eric Blake 已提交
2300
    unsigned int flags = VIR_DOMAIN_NONE;
2301
    int rc;
2302

2303
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2304
        return false;
2305

2306 2307
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
2308
        return false;
2309 2310

    if (virDomainGetID(dom) != (unsigned int)-1) {
2311
        vshError(ctl, "%s", _("Domain is already active"));
2312
        virDomainFree(dom);
E
Eric Blake 已提交
2313
        return false;
2314 2315
    }

E
Eric Blake 已提交
2316 2317
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
2318 2319
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
2320 2321
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_START_BYPASS_CACHE;
2322 2323
    if (vshCommandOptBool(cmd, "force-boot"))
        flags |= VIR_DOMAIN_START_FORCE_BOOT;
E
Eric Blake 已提交
2324

2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349
    /* 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 已提交
2350 2351
    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
2352
         : virDomainCreate(dom)) < 0) {
2353
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
2354
        goto cleanup;
2355
    }
2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367

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

    ret = true;

cleanup:
2368
    virDomainFree(dom);
2369 2370 2371
    return ret;
}

2372 2373 2374
/*
 * "save" command
 */
2375
static const vshCmdInfo info_save[] = {
2376
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
2377
    {"desc", N_("Save the RAM state of a running domain.")},
2378
    {NULL, NULL}
2379 2380
};

2381
static const vshCmdOptDef opts_save[] = {
2382
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2383 2384
    {"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")},
2385 2386
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2387 2388
    {"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")},
2389
    {NULL, 0, 0, NULL}
2390 2391
};

E
Eric Blake 已提交
2392
static bool
2393
cmdSave(vshControl *ctl, const vshCmd *cmd)
2394
{
2395
    virDomainPtr dom;
2396 2397
    const char *name = NULL;
    const char *to = NULL;
2398
    bool ret = false;
E
Eric Blake 已提交
2399
    unsigned int flags = 0;
2400 2401
    const char *xmlfile = NULL;
    char *xml = NULL;
2402

2403
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2404
        return false;
2405

2406
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
2407
        return false;
2408

2409 2410
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2411 2412 2413 2414
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2415

2416 2417 2418 2419 2420
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

2424 2425 2426 2427 2428 2429
    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
        goto cleanup;

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
2430
         : virDomainSave(dom, to)) < 0) {
2431
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
2432
        goto cleanup;
2433
    }
2434

2435 2436 2437 2438
    vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
    ret = true;

cleanup:
2439
    VIR_FREE(xml);
2440 2441 2442 2443
    virDomainFree(dom);
    return ret;
}

2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464
/*
 * "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 已提交
2465
    unsigned int flags = 0;
2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501
    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")},
2502 2503
    {"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")},
2504 2505 2506 2507 2508 2509 2510 2511 2512 2513
    {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;
2514 2515 2516 2517 2518 2519
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534

    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;

2535
    if (virDomainSaveImageDefineXML(ctl->conn, file, xml, flags) < 0) {
2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558
        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")},
2559 2560
    {"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")},
2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571
    {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;
2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587
    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;
    }
2588 2589 2590 2591 2592 2593 2594 2595

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

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

    /* Get the XML configuration of the saved image.  */
2596
    doc = virDomainSaveImageGetXMLDesc(ctl->conn, file, getxml_flags);
2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613
    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;

2614 2615 2616
    /* 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) {
2617 2618 2619 2620 2621 2622 2623
        vshPrint(ctl, _("Saved image %s XML configuration not changed.\n"),
                 file);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
2624 2625
    if (virDomainSaveImageDefineXML(ctl->conn, file, doc_edited,
                                    define_flags) < 0) {
2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642
        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;
}

2643 2644 2645 2646 2647
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
2648 2649 2650 2651
    {"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.")},
2652 2653 2654 2655
    {NULL, NULL}
};

static const vshCmdOptDef opts_managedsave[] = {
2656
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2657
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2658 2659
    {"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")},
2660 2661 2662
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2663
static bool
2664 2665 2666
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
2667
    const char *name;
2668
    bool ret = false;
E
Eric Blake 已提交
2669
    unsigned int flags = 0;
2670

2671
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2672
        return false;
2673

2674 2675
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2676 2677 2678 2679
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2680

2681
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2682
        return false;
2683

2684
    if (virDomainManagedSave(dom, flags) < 0) {
2685
        vshError(ctl, _("Failed to save domain %s state"), name);
2686
        goto cleanup;
2687 2688
    }

2689 2690 2691 2692
    vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    ret = true;

cleanup:
2693 2694 2695 2696
    virDomainFree(dom);
    return ret;
}

2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710
/*
 * "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 已提交
2711
static bool
2712 2713 2714
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
2715
    const char *name;
E
Eric Blake 已提交
2716
    bool ret = false;
2717 2718
    int hassave;

2719
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2720
        return false;
2721 2722

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2723
        return false;
2724 2725 2726

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
2727
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743
        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 已提交
2744
    ret = true;
2745 2746 2747 2748 2749 2750

cleanup:
    virDomainFree(dom);
    return ret;
}

2751 2752 2753
/*
 * "schedinfo" command
 */
2754
static const vshCmdInfo info_schedinfo[] = {
2755 2756
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
2757 2758 2759
    {NULL, NULL}
};

2760
static const vshCmdOptDef opts_schedinfo[] = {
2761 2762 2763 2764
    {"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")},
2765 2766 2767
    {"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")},
2768 2769 2770
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
2771
static int
2772
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
2773
                   virTypedParameterPtr param)
2774
{
2775
    const char *data = NULL;
2776 2777 2778

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
2779
        param->type == VIR_TYPED_PARAM_UINT &&
2780 2781
        vshCommandOptBool(cmd, "weight")) {
        int val;
2782
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
2783
            vshError(ctl, "%s", _("Invalid value of weight"));
2784
            return -1;
2785
        } else {
2786
            param->value.ui = val;
2787
        }
2788
        return 1;
2789 2790
    }

2791 2792
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
2793
        param->type == VIR_TYPED_PARAM_UINT &&
2794 2795
        vshCommandOptBool(cmd, "cap")) {
        int val;
2796
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
2797
            vshError(ctl, "%s", _("Invalid value of cap"));
2798
            return -1;
2799
        } else {
2800
            param->value.ui = val;
2801
        }
2802
        return 1;
2803
    }
2804

2805
    if (vshCommandOptString(cmd, "set", &data) > 0) {
2806 2807 2808
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
2809
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
2810
            return -1;
2811
        }
2812 2813 2814 2815 2816 2817 2818 2819 2820
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
2821
        case VIR_TYPED_PARAM_INT:
2822
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
2823
                vshError(ctl, "%s",
2824 2825 2826 2827
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
2828
        case VIR_TYPED_PARAM_UINT:
2829
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
2830
                vshError(ctl, "%s",
2831 2832 2833 2834
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
2835
        case VIR_TYPED_PARAM_LLONG:
2836
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
2837
                vshError(ctl, "%s",
J
Jim Meyering 已提交
2838
                         _("Invalid value for parameter, expecting a long long"));
2839 2840 2841
                return -1;
            }
            break;
2842
        case VIR_TYPED_PARAM_ULLONG:
2843
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
2844
                vshError(ctl, "%s",
2845 2846 2847 2848
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
2849
        case VIR_TYPED_PARAM_DOUBLE:
2850
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
2851
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
2852 2853 2854
                return -1;
            }
            break;
2855
        case VIR_TYPED_PARAM_BOOLEAN:
2856
            param->value.b = STREQ(val, "0") ? 0 : 1;
2857
        }
2858
        return 1;
2859
    }
2860

2861 2862
    return 0;
}
2863

2864

E
Eric Blake 已提交
2865
static bool
2866 2867 2868 2869
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
2870
    virTypedParameterPtr params = NULL;
2871 2872 2873
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
2874
    bool ret_val = false;
2875 2876 2877 2878 2879 2880 2881 2882 2883 2884
    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;
        }
2885
        flags = VIR_DOMAIN_AFFECT_CURRENT;
2886 2887
    } else {
        if (config)
2888
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
2889
        if (live)
2890
            flags |= VIR_DOMAIN_AFFECT_LIVE;
2891
    }
2892

2893
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2894
        return false;
2895

2896
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2897
        return false;
2898 2899 2900

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
2901
    if (schedulertype != NULL) {
2902
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
2903
             schedulertype);
2904
        VIR_FREE(schedulertype);
2905
    } else {
2906
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
2907
        goto cleanup;
2908 2909
    }

2910
    if (nparams) {
2911
        params = vshMalloc(ctl, sizeof(*params) * nparams);
2912

2913
        memset(params, 0, sizeof(*params) * nparams);
2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924
        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);
        }
2925 2926 2927 2928
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
2929
        for (i = 0; i < nparams; i++) {
2930 2931 2932 2933 2934 2935 2936 2937 2938 2939
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
2940 2941 2942 2943 2944
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
2945 2946 2947
            if (ret == -1)
                goto cleanup;

2948 2949 2950 2951 2952 2953 2954
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
2955 2956
            if (ret == -1)
                goto cleanup;
2957 2958 2959 2960
        } 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.  */
2961 2962
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
2963 2964 2965 2966
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
2967 2968 2969 2970 2971 2972
            /* 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;
            }
2973 2974
        }

E
Eric Blake 已提交
2975
        ret_val = true;
2976
        for (i = 0; i < nparams; i++) {
2977 2978 2979
            char *str = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
            VIR_FREE(str);
2980 2981
        }
    }
2982

2983
 cleanup:
2984
    VIR_FREE(params);
2985
    virDomainFree(dom);
2986
    return ret_val;
2987 2988
}

2989 2990 2991
/*
 * "restore" command
 */
2992
static const vshCmdInfo info_restore[] = {
2993 2994
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
2995
    {NULL, NULL}
2996 2997
};

2998
static const vshCmdOptDef opts_restore[] = {
2999
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
3000 3001
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when restoring")},
3002 3003
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
3004 3005
    {"running", VSH_OT_BOOL, 0, N_("restore domain into running state")},
    {"paused", VSH_OT_BOOL, 0, N_("restore domain into paused state")},
3006
    {NULL, 0, 0, NULL}
3007 3008
};

E
Eric Blake 已提交
3009
static bool
3010
cmdRestore(vshControl *ctl, const vshCmd *cmd)
3011
{
3012
    const char *from = NULL;
3013
    bool ret = false;
E
Eric Blake 已提交
3014
    unsigned int flags = 0;
3015 3016
    const char *xmlfile = NULL;
    char *xml = NULL;
3017

3018
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3019
        return false;
3020

3021
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
3022
        return false;
3023

3024 3025
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
3026 3027 3028 3029
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
3030

3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041
    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)
3042
         : virDomainRestore(ctl->conn, from)) < 0) {
3043
        vshError(ctl, _("Failed to restore domain from %s"), from);
3044
        goto cleanup;
3045
    }
3046 3047 3048 3049 3050

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

cleanup:
3051
    VIR_FREE(xml);
3052 3053 3054
    return ret;
}

D
Daniel Veillard 已提交
3055 3056 3057
/*
 * "dump" command
 */
3058
static const vshCmdInfo info_dump[] = {
3059 3060
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
3061 3062 3063
    {NULL, NULL}
};

3064
static const vshCmdOptDef opts_dump[] = {
3065 3066
    {"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")},
3067 3068
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when saving")},
3069
    {"reset", VSH_OT_BOOL, 0, N_("reset the domain after core dump")},
3070 3071
    {"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 已提交
3072 3073 3074
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3075
static bool
3076
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
3077 3078
{
    virDomainPtr dom;
3079 3080
    const char *name = NULL;
    const char *to = NULL;
3081
    bool ret = false;
E
Eric Blake 已提交
3082
    unsigned int flags = 0;
D
Daniel Veillard 已提交
3083

3084
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3085
        return false;
D
Daniel Veillard 已提交
3086

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

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

P
Paolo Bonzini 已提交
3093 3094
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
3095 3096
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;
3097 3098
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DUMP_BYPASS_CACHE;
3099 3100
    if (vshCommandOptBool(cmd, "reset"))
        flags |= VIR_DUMP_RESET;
3101

3102
    if (virDomainCoreDump(dom, to, flags) < 0) {
3103
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
3104
        goto cleanup;
D
Daniel Veillard 已提交
3105 3106
    }

3107 3108 3109 3110
    vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
    ret = true;

cleanup:
D
Daniel Veillard 已提交
3111 3112 3113 3114
    virDomainFree(dom);
    return ret;
}

3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188
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;
3189
    bool created = false;
3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228
    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) {
        if (errno != EEXIST ||
            (fd = open(file, O_WRONLY|O_TRUNC, 0666)) < 0) {
            vshError(ctl, _("cannot create file %s"), file);
            goto cleanup;
        }
3229 3230
    } else {
        created = true;
3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259
    }

    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);
3260
    VIR_FREE(mime);
3261 3262 3263
    return ret;
}

3264 3265 3266
/*
 * "resume" command
 */
3267
static const vshCmdInfo info_resume[] = {
3268 3269
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
3270
    {NULL, NULL}
3271 3272
};

3273
static const vshCmdOptDef opts_resume[] = {
3274
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3275
    {NULL, 0, 0, NULL}
3276 3277
};

E
Eric Blake 已提交
3278
static bool
3279
cmdResume(vshControl *ctl, const vshCmd *cmd)
3280
{
3281
    virDomainPtr dom;
E
Eric Blake 已提交
3282
    bool ret = true;
3283
    const char *name;
3284

3285
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3286
        return false;
3287

J
Jim Meyering 已提交
3288
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3289
        return false;
3290 3291

    if (virDomainResume(dom) == 0) {
3292
        vshPrint(ctl, _("Domain %s resumed\n"), name);
3293
    } else {
3294
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
3295
        ret = false;
3296
    }
3297

3298 3299 3300 3301
    virDomainFree(dom);
    return ret;
}

3302 3303 3304
/*
 * "shutdown" command
 */
3305
static const vshCmdInfo info_shutdown[] = {
3306 3307
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
3308
    {NULL, NULL}
3309 3310
};

3311
static const vshCmdOptDef opts_shutdown[] = {
3312
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3313
    {NULL, 0, 0, NULL}
3314 3315
};

E
Eric Blake 已提交
3316
static bool
3317
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
3318
{
3319
    virDomainPtr dom;
E
Eric Blake 已提交
3320
    bool ret = true;
3321
    const char *name;
3322

3323
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3324
        return false;
3325

J
Jim Meyering 已提交
3326
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3327
        return false;
3328 3329

    if (virDomainShutdown(dom) == 0) {
3330
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
3331
    } else {
3332
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
3333
        ret = false;
3334
    }
3335

3336 3337 3338 3339
    virDomainFree(dom);
    return ret;
}

3340 3341 3342
/*
 * "reboot" command
 */
3343
static const vshCmdInfo info_reboot[] = {
3344 3345
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
3346 3347 3348
    {NULL, NULL}
};

3349
static const vshCmdOptDef opts_reboot[] = {
3350
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3351 3352 3353
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3354
static bool
3355
cmdReboot(vshControl *ctl, const vshCmd *cmd)
3356 3357
{
    virDomainPtr dom;
E
Eric Blake 已提交
3358
    bool ret = true;
3359
    const char *name;
3360

3361
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3362
        return false;
3363

J
Jim Meyering 已提交
3364
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3365
        return false;
3366 3367

    if (virDomainReboot(dom, 0) == 0) {
3368
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
3369
    } else {
3370
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
3371
        ret = false;
3372 3373 3374 3375 3376 3377
    }

    virDomainFree(dom);
    return ret;
}

X
Xu He Jie 已提交
3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415
/*
 * "reset" command
 */
static const vshCmdInfo info_reset[] = {
    {"help", N_("reset a domain")},
    {"desc", N_("Reset the target domain as if by power button")},
    {NULL, NULL}
};

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

static bool
cmdReset(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = true;
    const char *name;

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

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

    if (virDomainReset(dom, 0) == 0) {
        vshPrint(ctl, _("Domain %s was reset\n"), name);
    } else {
        vshError(ctl, _("Failed to reset domain %s"), name);
        ret = false;
    }

    virDomainFree(dom);
    return ret;
}

3416 3417 3418
/*
 * "destroy" command
 */
3419
static const vshCmdInfo info_destroy[] = {
3420 3421 3422
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
3423
    {NULL, NULL}
3424 3425
};

3426
static const vshCmdOptDef opts_destroy[] = {
3427
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3428
    {NULL, 0, 0, NULL}
3429 3430
};

E
Eric Blake 已提交
3431
static bool
3432
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
3433
{
3434
    virDomainPtr dom;
E
Eric Blake 已提交
3435
    bool ret = true;
3436
    const char *name;
3437

3438
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3439
        return false;
3440

J
Jim Meyering 已提交
3441
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3442
        return false;
3443 3444

    if (virDomainDestroy(dom) == 0) {
3445
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
3446
    } else {
3447
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
3448
        ret = false;
3449
    }
3450

3451
    virDomainFree(dom);
K
Karel Zak 已提交
3452 3453 3454 3455
    return ret;
}

/*
3456
 * "dominfo" command
K
Karel Zak 已提交
3457
 */
3458
static const vshCmdInfo info_dominfo[] = {
3459 3460
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
3461
    {NULL, NULL}
K
Karel Zak 已提交
3462 3463
};

3464
static const vshCmdOptDef opts_dominfo[] = {
3465
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3466
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3467 3468
};

E
Eric Blake 已提交
3469
static bool
3470
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
3471
{
K
Karel Zak 已提交
3472 3473
    virDomainInfo info;
    virDomainPtr dom;
3474
    virSecurityModel secmodel;
3475
    virSecurityLabelPtr seclabel;
3476
    int persistent = 0;
E
Eric Blake 已提交
3477 3478
    bool ret = true;
    int autostart;
3479
    unsigned int id;
3480
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
3481
    int has_managed_save = 0;
3482

3483
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3484
        return false;
K
Karel Zak 已提交
3485

J
Jim Meyering 已提交
3486
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3487
        return false;
3488

3489 3490
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3491
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
3492
    else
3493
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
3494 3495
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
3496
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
3497
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
3498 3499

    if ((str = virDomainGetOSType(dom))) {
3500
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
3501
        VIR_FREE(str);
3502 3503 3504
    }

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

3508
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
3509 3510

        if (info.cpuTime != 0) {
3511
            double cpuUsed = info.cpuTime;
3512

3513
            cpuUsed /= 1000000000.0;
3514

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

3518 3519
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
3520
                 info.maxMem);
3521
        else
3522
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
3523 3524
                 _("no limit"));

3525
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
3526 3527
                 info.memory);

K
Karel Zak 已提交
3528
    } else {
E
Eric Blake 已提交
3529
        ret = false;
K
Karel Zak 已提交
3530
    }
3531

3532 3533
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
3534 3535
    vshDebug(ctl, VSH_ERR_DEBUG, "Domain persistent flag value: %d\n",
             persistent);
3536 3537 3538 3539 3540 3541
    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 */
3542
    if (!virDomainGetAutostart(dom, &autostart)) {
3543
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
3544 3545 3546
                 autostart ? _("enable") : _("disable") );
    }

3547 3548 3549 3550 3551 3552 3553
    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"));

3554 3555 3556
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
3557 3558
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
3559
            return false;
3560 3561 3562
        } else {
            virFreeError(last_error);
            last_error = NULL;
3563
        }
3564 3565 3566 3567 3568 3569 3570
    } 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 */
3571
            if (VIR_ALLOC(seclabel) < 0) {
3572
                virDomainFree(dom);
E
Eric Blake 已提交
3573
                return false;
3574 3575 3576 3577 3578
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
3579
                return false;
3580
            } else {
3581
                if (seclabel->label[0] != '\0')
3582
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
3583
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
3584
            }
3585 3586

            VIR_FREE(seclabel);
3587 3588
        }
    }
3589
    virDomainFree(dom);
K
Karel Zak 已提交
3590 3591 3592
    return ret;
}

3593 3594 3595 3596
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
3597 3598
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
3599 3600 3601 3602
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
3603
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3604 3605 3606 3607
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
3608
static bool
3609 3610 3611 3612
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
3613
    bool ret = true;
3614

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3619
        return false;
3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645

    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 已提交
3646
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
3647
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
3648
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
3649
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
3650
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
3651 3652 3653
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
3654
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
3655
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
3656
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
3657
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
3658
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
3659 3660 3661
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
3662
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
3663
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
3664
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
3665
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
3666
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
3667 3668
        }
    } else {
E
Eric Blake 已提交
3669
        ret = false;
3670 3671 3672 3673 3674 3675
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

3676 3677 3678 3679
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
3680 3681
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
3682 3683 3684 3685
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
3686
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3687 3688 3689
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3690
static bool
3691 3692 3693
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3694
    bool ret = true;
3695

3696
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3697
        return false;
3698 3699

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
3703
        ret = false;
3704 3705 3706 3707 3708

    virDomainFree(dom);
    return ret;
}

3709 3710 3711
/*
 * "freecell" command
 */
3712
static const vshCmdInfo info_freecell[] = {
3713 3714
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
3715 3716 3717
    {NULL, NULL}
};

3718
static const vshCmdOptDef opts_freecell[] = {
3719
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
3720
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
3721 3722 3723
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3724
static bool
3725
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
3726
{
W
Wen Congyang 已提交
3727
    bool func_ret = false;
3728
    int ret;
3729
    int cell = -1, cell_given;
3730
    unsigned long long memory;
3731 3732 3733 3734
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
3735
    int all_given;
3736 3737 3738 3739
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
3740

3741

3742
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3743
        return false;
3744

3745 3746 3747 3748
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
3749 3750 3751 3752 3753 3754 3755 3756 3757
    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) {
3758 3759 3760
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3761 3762 3763
            goto cleanup;
        }

3764
        xml = virXMLParseStringCtxt(cap_xml, _("(capabilities)"), &ctxt);
3765 3766
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3767 3768
            goto cleanup;
        }
3769 3770 3771 3772
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
3773
            vshError(ctl, "%s", _("could not get information about "
3774
                                  "NUMA topology"));
3775 3776 3777
            goto cleanup;
        }

3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798
        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;
            }
        }

3799
        memory = 0;
3800 3801 3802 3803
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
3804 3805 3806 3807
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
3808
    } else {
3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822
        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));
3823 3824
    }

E
Eric Blake 已提交
3825
    func_ret = true;
3826

3827
cleanup:
3828
    xmlXPathFreeContext(ctxt);
3829
    xmlFreeDoc(xml);
3830
    VIR_FREE(nodes);
3831 3832 3833
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
3834
    return func_ret;
3835 3836
}

E
Eric Blake 已提交
3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850
/*
 * "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 已提交
3851
static bool
E
Eric Blake 已提交
3852 3853
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
3854
    const char *type = NULL;
E
Eric Blake 已提交
3855 3856
    int vcpus;

3857 3858
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
3859
        return false;
3860
    }
E
Eric Blake 已提交
3861 3862

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3863
        return false;
E
Eric Blake 已提交
3864 3865 3866

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

E
Eric Blake 已提交
3870
    return true;
E
Eric Blake 已提交
3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884
}

/*
 * "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")},
3885
    {"active", VSH_OT_BOOL, 0, N_("get number of currently active vcpus")},
E
Eric Blake 已提交
3886
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
3887 3888 3889
    {"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 已提交
3890 3891 3892
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3893
static bool
E
Eric Blake 已提交
3894 3895 3896
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3897
    bool ret = true;
E
Eric Blake 已提交
3898
    int maximum = vshCommandOptBool(cmd, "maximum");
3899
    int active = vshCommandOptBool(cmd, "active");
E
Eric Blake 已提交
3900 3901
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3902 3903
    int current = vshCommandOptBool(cmd, "current");
    bool all = maximum + active + current + config + live == 0;
E
Eric Blake 已提交
3904 3905
    int count;

3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920
    /* 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 已提交
3921
        return false;
E
Eric Blake 已提交
3922
    }
3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935

    /* 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 已提交
3936
        vshError(ctl, "%s",
3937
                 _("--maximum and --active cannot both be specified"));
E
Eric Blake 已提交
3938
        return false;
E
Eric Blake 已提交
3939
    }
3940 3941 3942
    if (current + config + live > 1) {
        vshError(ctl, "%s",
                 _("--config, --live, and --current are mutually exclusive"));
E
Eric Blake 已提交
3943
        return false;
E
Eric Blake 已提交
3944 3945 3946
    }

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

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

    /* In all cases, try the new API first; if it fails because we are
3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966
     * 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 已提交
3967 3968
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
3969
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
3970 3971 3972 3973 3974 3975 3976 3977 3978
        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;
            }
3979 3980
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
3981 3982 3983 3984 3985
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
3986
            ret = false;
E
Eric Blake 已提交
3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998
        } 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 |
3999
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
4000 4001 4002 4003 4004 4005 4006
        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 已提交
4007
            ret = false;
E
Eric Blake 已提交
4008 4009 4010 4011 4012 4013 4014 4015 4016 4017
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

4018
    if (all || (active && config)) {
4019
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043
        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 已提交
4044
            ret = false;
E
Eric Blake 已提交
4045 4046 4047 4048 4049 4050 4051 4052 4053 4054
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

4055
    if (all || (active && live)) {
4056
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
4057 4058 4059 4060 4061 4062 4063 4064 4065
        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 已提交
4066
            ret = false;
E
Eric Blake 已提交
4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080
        } 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;
}

4081 4082 4083
/*
 * "vcpuinfo" command
 */
4084
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
4085
    {"help", N_("detailed domain vcpu information")},
4086
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
4087 4088 4089
    {NULL, NULL}
};

4090
static const vshCmdOptDef opts_vcpuinfo[] = {
4091
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4092 4093 4094
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4095
static bool
4096
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
4097 4098 4099 4100 4101
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
4102 4103
    unsigned char *cpumaps;
    int ncpus, maxcpu;
4104
    size_t cpumaplen;
E
Eric Blake 已提交
4105
    bool ret = true;
4106
    int n, m;
4107

4108
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4109
        return false;
4110

J
Jim Meyering 已提交
4111
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4112
        return false;
4113 4114 4115

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
4116
        return false;
4117 4118 4119 4120
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
4121
        return false;
4122 4123
    }

4124
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
4125 4126 4127
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
4128

4129 4130
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
4131
                                   cpumaps, cpumaplen)) >= 0) {
4132 4133 4134 4135
        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 已提交
4136
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
4137 4138 4139 4140 4141 4142 4143 4144
            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:"));
4145 4146
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
4147 4148 4149 4150 4151 4152
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
4153
    } else {
4154
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
4155
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
4156 4157 4158
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
4159
            /* fallback plan to use virDomainGetVcpuPinInfo */
4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177

            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;
4178
        }
4179 4180
    }

4181
    VIR_FREE(cpumaps);
4182
    VIR_FREE(cpuinfo);
4183 4184 4185 4186 4187 4188 4189
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
4190
static const vshCmdInfo info_vcpupin[] = {
4191
    {"help", N_("control or query domain vcpu affinity")},
4192
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
4193 4194 4195
    {NULL, NULL}
};

4196
static const vshCmdOptDef opts_vcpupin[] = {
4197
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4198 4199 4200
    {"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")},
4201 4202 4203
    {"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")},
4204 4205 4206
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4207
static bool
E
Eric Blake 已提交
4208
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
4209 4210 4211 4212
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
4213
    int vcpu = -1;
4214
    const char *cpulist = NULL;
E
Eric Blake 已提交
4215
    bool ret = true;
4216 4217
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
4218
    size_t cpumaplen;
4219 4220
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
4221
    bool unuse = false;
4222
    const char *cur;
4223 4224 4225
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
4226
    bool query = false; /* Query mode if no cpulist */
E
Eric Blake 已提交
4227
    unsigned int flags = 0;
4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243

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

4245
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4246
        return false;
4247

J
Jim Meyering 已提交
4248
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4249
        return false;
4250

4251 4252
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
4253
        virDomainFree(dom);
E
Eric Blake 已提交
4254
        return false;
4255
    }
4256
    query = !cpulist;
4257

4258 4259 4260 4261
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
4262
        virDomainFree(dom);
E
Eric Blake 已提交
4263
        return false;
4264
    }
4265

4266 4267
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
4268
        return false;
4269 4270 4271
    }

    if (virDomainGetInfo(dom, &info) != 0) {
4272
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
4273
        virDomainFree(dom);
E
Eric Blake 已提交
4274
        return false;
4275 4276 4277
    }

    if (vcpu >= info.nrVirtCpu) {
4278
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
4279
        virDomainFree(dom);
E
Eric Blake 已提交
4280
        return false;
4281 4282
    }

4283 4284
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
4285

4286 4287 4288 4289 4290 4291 4292 4293
    /* 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 已提交
4294
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 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
                                             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);
4340 4341
    /* Parse cpulist */
    cur = cpulist;
4342
    if (*cur == 0) {
4343
        goto parse_error;
4344 4345 4346
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
4347
        cur = "";
4348
    }
4349 4350 4351 4352 4353 4354 4355

    while (*cur != 0) {

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

4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369
        /* 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);
4370

4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397
        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);
        }
4398

4399 4400 4401 4402 4403 4404
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
4405
        } else {
4406
            goto parse_error;
4407
        }
4408
    }
4409

4410 4411 4412 4413 4414 4415 4416 4417
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
4418 4419
    }

4420
cleanup:
4421
    VIR_FREE(cpumap);
4422 4423
    virDomainFree(dom);
    return ret;
4424 4425 4426 4427 4428

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

4431 4432 4433
/*
 * "setvcpus" command
 */
4434
static const vshCmdInfo info_setvcpus[] = {
4435 4436
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
4437 4438 4439
    {NULL, NULL}
};

4440
static const vshCmdOptDef opts_setvcpus[] = {
4441
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4442
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
4443 4444 4445
    {"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")},
4446
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
4447 4448 4449
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4450
static bool
4451
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
4452 4453
{
    virDomainPtr dom;
4454
    int count = 0;
E
Eric Blake 已提交
4455
    bool ret = true;
E
Eric Blake 已提交
4456 4457 4458
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
4459
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4460
    unsigned int flags = 0;
4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476

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

4478
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4479
        return false;
4480

J
Jim Meyering 已提交
4481
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4482
        return false;
4483

4484 4485 4486 4487
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
4488

4489
    if (flags == -1) {
E
Eric Blake 已提交
4490
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
4491
            ret = false;
E
Eric Blake 已提交
4492 4493
        }
    } else {
4494 4495 4496
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
4497
            vshDebug(ctl, VSH_ERR_DEBUG, "--maximum flag was given\n");
4498

4499 4500
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

4501 4502 4503 4504 4505 4506 4507 4508
            /* 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 已提交
4509
                ret = false;
4510 4511 4512 4513 4514
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
4515
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
4516
            ret = false;
E
Eric Blake 已提交
4517
        }
4518 4519
    }

4520
  cleanup:
4521 4522 4523 4524
    virDomainFree(dom);
    return ret;
}

4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558
/*
 * "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;
}

4559 4560 4561 4562 4563
/*
 * "send-key" command
 */
static const vshCmdInfo info_send_key[] = {
    {"help", N_("Send keycodes to the guest")},
4564
    {"desc", N_("Send keycodes (integers or symbolic names) to the guest")},
4565 4566 4567 4568 4569
    {NULL, NULL}
};

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4570 4571
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT,
     N_("the codeset of keycodes, default:linux")},
4572
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
A
Alex Jia 已提交
4573
     N_("the time (in milliseconds) how long the keys will be held")},
4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645
    {"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;
}

4646 4647 4648
/*
 * "setmemory" command
 */
4649
static const vshCmdInfo info_setmem[] = {
4650 4651
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
4652 4653 4654
    {NULL, NULL}
};

4655
static const vshCmdOptDef opts_setmem[] = {
4656
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4657
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
4658 4659
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
4660
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
4661 4662 4663
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4664
static bool
4665
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
4666 4667
{
    virDomainPtr dom;
4668
    virDomainInfo info;
4669
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
4670
    bool ret = true;
4671 4672
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
4673
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4674
    unsigned int flags = 0;
4675

4676 4677 4678
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4679
            return false;
4680
        }
4681
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4682 4683
    } else {
        if (config)
4684
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4685
        if (live)
4686
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4687 4688 4689
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
4690
    }
4691

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

J
Jim Meyering 已提交
4695
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4696
        return false;
4697

4698 4699
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4700
        return false;
4701 4702
    }

4703
    if (kilobytes <= 0) {
4704
        virDomainFree(dom);
4705
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
4706
        return false;
4707 4708
    }

4709 4710
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
4711
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
4712
        return false;
4713 4714 4715 4716
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
4717
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
4718
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
4719
        return false;
4720 4721
    }

4722
    if (flags == -1) {
4723
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
4724
            ret = false;
4725 4726 4727
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
4728
            ret = false;
4729
        }
4730 4731 4732 4733 4734 4735 4736 4737 4738
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
4739
static const vshCmdInfo info_setmaxmem[] = {
4740 4741
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
4742 4743 4744
    {NULL, NULL}
};

4745
static const vshCmdOptDef opts_setmaxmem[] = {
4746
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4747
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
4748 4749 4750
    {"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")},
4751 4752 4753
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4754
static bool
4755
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
4756 4757
{
    virDomainPtr dom;
4758
    int kilobytes = 0;
E
Eric Blake 已提交
4759
    bool ret = true;
4760 4761 4762
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4763
    unsigned int flags = VIR_DOMAIN_MEM_MAXIMUM;
4764 4765 4766 4767

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4768
            return false;
4769 4770 4771
        }
    } else {
        if (config)
4772
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4773
        if (live)
4774
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4775 4776 4777 4778
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
4779

4780
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4781
        return false;
4782

J
Jim Meyering 已提交
4783
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4784
        return false;
4785

4786 4787
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4788
        return false;
4789 4790
    }

4791
    if (kilobytes <= 0) {
4792
        virDomainFree(dom);
4793
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
4794
        return false;
4795 4796
    }

4797 4798 4799
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4800
            ret = false;
4801 4802 4803 4804
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4805
            ret = false;
4806
        }
4807 4808
    }

4809 4810 4811 4812
    virDomainFree(dom);
    return ret;
}

4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828
/*
 * "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]")},
4829 4830
    {"device-weights", VSH_OT_STRING, VSH_OFLAG_NONE,
     N_("per-device IO Weights, in the form of /path/to/device,weight,...")},
H
Hu Tao 已提交
4831 4832 4833
    {"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")},
4834 4835 4836
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4837
static bool
4838 4839 4840
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
4841
    const char *device_weight = NULL;
4842 4843
    int weight = 0;
    int nparams = 0;
4844
    int rv = 0;
4845
    unsigned int i = 0;
4846
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4847
    bool ret = false;
H
Hu Tao 已提交
4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864
    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;
    }
4865 4866

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

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

4872
    if ((rv = vshCommandOptInt(cmd, "weight", &weight)) < 0) {
4873 4874 4875 4876 4877
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

4878
    if (rv > 0) {
4879
        nparams++;
4880
        if (weight <= 0) {
4881 4882 4883 4884 4885
            vshError(ctl, _("Invalid value of %d for I/O weight"), weight);
            goto cleanup;
        }
    }

4886 4887 4888 4889 4890 4891 4892 4893 4894 4895
    rv = vshCommandOptString(cmd, "device-weights", &device_weight);
    if (rv < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse string parameter"));
        goto cleanup;
    }
    if (rv > 0) {
        nparams++;
    }

4896 4897
    if (nparams == 0) {
        /* get the number of blkio parameters */
H
Hu Tao 已提交
4898
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
4899 4900 4901 4902 4903 4904 4905
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4906
            ret = true;
4907 4908 4909 4910 4911
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
4912
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
4913 4914 4915 4916 4917
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
4918 4919 4920
            char *str = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
            VIR_FREE(str);
4921 4922 4923 4924 4925 4926 4927
        }
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4928
            temp->type = VIR_TYPED_PARAM_UINT;
4929 4930 4931

            if (weight) {
                temp->value.ui = weight;
4932 4933 4934
                if (!virStrcpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                               sizeof(temp->field)))
                    goto cleanup;
4935 4936
                weight = 0;
            } else if (device_weight) {
4937 4938 4939 4940 4941
                temp->value.s = vshStrdup(ctl, device_weight);
                temp->type = VIR_TYPED_PARAM_STRING;
                if (!virStrcpy(temp->field, VIR_DOMAIN_BLKIO_DEVICE_WEIGHT,
                               sizeof(temp->field)))
                    goto cleanup;
4942
                device_weight = NULL;
4943 4944
            }
        }
4945 4946

        if (virDomainSetBlkioParameters(dom, params, nparams, flags) < 0) {
4947
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
4948 4949
            goto cleanup;
        }
4950 4951
    }

4952 4953
    ret = true;

4954
  cleanup:
4955
    virTypedParameterArrayClear(params, nparams);
4956 4957 4958 4959 4960
    VIR_FREE(params);
    virDomainFree(dom);
    return ret;
}

4961 4962 4963 4964
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
4965 4966 4967
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
4968 4969 4970 4971 4972 4973 4974
                "    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")},
4975
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4976
     N_("Max memory in kilobytes")},
4977
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4978
     N_("Memory during contention in kilobytes")},
4979
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4980
     N_("Max memory plus swap in kilobytes")},
4981
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
4982
     N_("Min guaranteed memory in kilobytes")},
4983 4984 4985
    {"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")},
4986 4987 4988
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4989
static bool
4990 4991 4992
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
4993 4994
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
4995 4996
    int nparams = 0;
    unsigned int i = 0;
4997
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4998
    bool ret = false;
4999 5000 5001 5002 5003 5004 5005 5006 5007 5008
    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;
        }
5009
        flags = VIR_DOMAIN_AFFECT_CURRENT;
5010 5011
    } else {
        if (config)
5012
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
5013
        if (live)
5014
            flags |= VIR_DOMAIN_AFFECT_LIVE;
5015
    }
5016 5017

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5018
        return false;
5019 5020

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

5023 5024 5025 5026 5027 5028 5029 5030 5031
    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;
    }

5032 5033 5034 5035 5036 5037 5038 5039 5040
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

5041 5042 5043
    if (min_guarantee)
        nparams++;

5044 5045
    if (nparams == 0) {
        /* get the number of memory parameters */
5046
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
5047 5048 5049 5050 5051
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

5052 5053
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
5054
            ret = true;
5055 5056 5057
            goto cleanup;
        }

5058
        /* now go get all the memory parameters */
E
Eric Blake 已提交
5059
        params = vshCalloc(ctl, nparams, sizeof(*params));
5060
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
5061 5062 5063 5064 5065
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
5066 5067 5068 5069 5070 5071 5072
            if (params[i].type == VIR_TYPED_PARAM_ULLONG &&
                params[i].value.ul == VIR_DOMAIN_MEMORY_PARAM_UNLIMITED) {
                vshPrint(ctl, "%-15s: %s\n", params[i].field, _("unlimited"));
            } else {
                char *str = vshGetTypedParamValue(ctl, &params[i]);
                vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
                VIR_FREE(str);
5073 5074 5075
            }
        }

E
Eric Blake 已提交
5076
        ret = true;
5077 5078
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
5079
        params = vshCalloc(ctl, nparams, sizeof(*params));
5080 5081 5082

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
5083
            temp->type = VIR_TYPED_PARAM_ULLONG;
5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102

            /*
             * 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;
5103
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
5104 5105
                        sizeof(temp->field));
                swap_hard_limit = 0;
5106 5107 5108 5109 5110
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
5111
            }
5112 5113 5114 5115

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
5116
        }
5117
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
5118
            vshError(ctl, "%s", _("Unable to change memory parameters"));
5119
        else
E
Eric Blake 已提交
5120
            ret = true;
5121 5122 5123
    }

  cleanup:
E
Eric Blake 已提交
5124
    VIR_FREE(params);
5125 5126 5127 5128
    virDomainFree(dom);
    return ret;
}

H
Hu Tao 已提交
5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286
/*
 * "numatune" command
 */
static const vshCmdInfo info_numatune[] = {
    {"help", N_("Get or set numa parameters")},
    {"desc", N_("Get or set the current numa parameters for a guest" \
                " domain.\n" \
                "    To get the numa parameters use following command: \n\n" \
                "    virsh # numatune <domain>")},
    {NULL, NULL}

};

static const vshCmdOptDef opts_numatune[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"mode", VSH_OT_DATA, VSH_OFLAG_NONE,
     N_("NUMA mode, one of strict, preferred and interleave")},
    {"nodeset", VSH_OT_DATA, VSH_OFLAG_NONE,
     N_("NUMA node selections to set")},
    {"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")},
    {NULL, 0, 0, NULL}
};

static bool
cmdNumatune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int nparams = 0;
    unsigned int i = 0;
    virTypedParameterPtr params = NULL, temp = NULL;
    const char *nodeset = NULL;
    bool ret = false;
    unsigned int flags = 0;
    int current = vshCommandOptBool(cmd, "current");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    const char *mode = NULL;

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

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

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

    if (vshCommandOptString(cmd, "nodeset", &nodeset) < 0) {
        vshError(ctl, "%s", _("Unable to parse nodeset."));
        virDomainFree(dom);
        return false;
    }
    if (nodeset)
        nparams++;
    if (vshCommandOptString(cmd, "mode", &mode) < 0) {
        vshError(ctl, "%s", _("Unable to parse mode."));
        virDomainFree(dom);
        return false;
    }
    if (mode)
        nparams++;

    if (nparams == 0) {
        /* get the number of numa parameters */
        if (virDomainGetNumaParameters(dom, NULL, &nparams, flags) != 0) {
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

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

        /* now go get all the numa parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
        if (virDomainGetNumaParameters(dom, params, &nparams, flags) != 0) {
            vshError(ctl, "%s", _("Unable to get numa parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            if (params[i].type == VIR_TYPED_PARAM_INT &&
                STREQ(params[i].field, VIR_DOMAIN_NUMA_MODE)) {
                vshPrint(ctl, "%-15s: %s\n", params[i].field,
                         virDomainNumatuneMemModeTypeToString(params[i].value.i));
            } else {
                char *str = vshGetTypedParamValue(ctl, &params[i]);
                vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
                VIR_FREE(str);
            }
        }

        ret = true;
    } else {
        /* set the numa parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];

            /*
             * 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 (mode) {
                /* Accept string or integer, in case server
                 * understands newer integer than what strings we were
                 * compiled with */
                if ((temp->value.i =
                    virDomainNumatuneMemModeTypeFromString(mode)) < 0 &&
                    virStrToLong_i(mode, NULL, 0, &temp->value.i) < 0) {
                    vshError(ctl, _("Invalid mode: %s"), mode);
                    goto cleanup;
                }
                if (!virStrcpy(temp->field, VIR_DOMAIN_NUMA_MODE,
                               sizeof(temp->field)))
                    goto cleanup;
                temp->type = VIR_TYPED_PARAM_INT;
                mode = NULL;
            } else if (nodeset) {
                temp->value.s = vshStrdup(ctl, nodeset);
                temp->type = VIR_TYPED_PARAM_STRING;
                if (!virStrcpy(temp->field, VIR_DOMAIN_NUMA_NODESET,
                               sizeof(temp->field)))
                    goto cleanup;
                nodeset = NULL;
            }
        }
        if (virDomainSetNumaParameters(dom, params, nparams, flags) != 0)
            vshError(ctl, "%s", _("Unable to change numa parameters"));
        else
            ret = true;
    }

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

5287 5288 5289
/*
 * "nodeinfo" command
 */
5290
static const vshCmdInfo info_nodeinfo[] = {
5291 5292
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
5293 5294 5295
    {NULL, NULL}
};

E
Eric Blake 已提交
5296
static bool
5297
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5298 5299
{
    virNodeInfo info;
5300

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

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
5305
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
5306
        return false;
5307 5308 5309 5310 5311 5312 5313 5314 5315 5316
    }
    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 已提交
5317
    return true;
5318 5319
}

5320 5321 5322 5323 5324
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
5325
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
5326 5327 5328 5329 5330 5331 5332 5333 5334 5335
    {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
5336
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
5337 5338 5339 5340
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
5341 5342
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385
    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;

5386
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
5387
                cpu_stats[i].sys = value;
5388
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
5389
                cpu_stats[i].user = value;
5390
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
5391
                cpu_stats[i].idle = value;
5392
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
5393
                cpu_stats[i].iowait = value;
5394
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408
                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) {
5409
            vshPrint(ctl, "%-15s %20llu\n", _("user:"), cpu_stats[0].user);
5410
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
5411
            vshPrint(ctl, "%-15s %20llu\n", _("idle:"), cpu_stats[0].idle);
5412 5413 5414 5415 5416 5417 5418
            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);
5419
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle:"), 100 - usage);
5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431
        } 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",
5432
                     _("user:"), user_time / total_time * 100);
5433
            vshPrint(ctl, "%-15s %5.1lf%%\n",
5434
                     _("system:"), sys_time  / total_time * 100);
5435
            vshPrint(ctl, "%-15s %5.1lf%%\n",
5436
                     _("idle:"), idle_time     / total_time * 100);
5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467
/*
 * "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;
5468 5469
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509
    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;
}

5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538
/*
 * "nodesuspend" command
 */
static const vshCmdInfo info_nodesuspend[] = {
    {"help", N_("suspend the host node for a given time duration")},
    {"desc", N_("Suspend the host node for a given time duration "
                               "and attempt to resume thereafter.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_suspend[] = {
    {"target", VSH_OT_DATA, VSH_OFLAG_REQ, N_("mem(Suspend-to-RAM), "
                                               "disk(Suspend-to-Disk), hybrid(Hybrid-Suspend)")},
    {"duration", VSH_OT_INT, VSH_OFLAG_REQ, N_("Suspend duration in seconds")},
    {"flags", VSH_OT_INT, VSH_OFLAG_NONE, N_("Suspend flags, 0 for default")},
    {NULL, 0, 0, NULL}
};

static bool
cmdNodeSuspend(vshControl *ctl, const vshCmd *cmd)
{
    const char *target = NULL;
    unsigned int suspendTarget;
    long long duration;
    unsigned int flags = 0;

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

5539 5540
    if (vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(ctl, _("Invalid target argument"));
5541
        return false;
5542
    }
5543

5544 5545
    if (vshCommandOptLongLong(cmd, "duration", &duration) < 0) {
        vshError(ctl, _("Invalid duration argument"));
5546
        return false;
5547
    }
5548

5549 5550
    if (vshCommandOptUInt(cmd, "flags", &flags) < 0) {
        vshError(ctl, _("Invalid flags argument"));
5551
        return false;
5552
    }
5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578

    if (STREQ(target, "mem"))
        suspendTarget = VIR_NODE_SUSPEND_TARGET_MEM;
    else if (STREQ(target, "disk"))
        suspendTarget = VIR_NODE_SUSPEND_TARGET_DISK;
    else if (STREQ(target, "hybrid"))
        suspendTarget = VIR_NODE_SUSPEND_TARGET_HYBRID;
    else {
        vshError(ctl, "%s", _("Invalid target"));
        return false;
    }

    if (duration <= 0) {
        vshError(ctl, "%s", _("Invalid duration"));
        return false;
    }

    if (virNodeSuspendForDuration(ctl->conn, suspendTarget, duration,
                                  flags) < 0) {
        vshError(ctl, "%s", _("The host was not suspended"));
        return false;
    }
    return true;
}


5579 5580 5581
/*
 * "capabilities" command
 */
5582
static const vshCmdInfo info_capabilities[] = {
5583 5584
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
5585 5586 5587
    {NULL, NULL}
};

E
Eric Blake 已提交
5588
static bool
5589
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5590 5591 5592
{
    char *caps;

5593
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5594
        return false;
5595 5596

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
5597
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
5598
        return false;
5599 5600
    }
    vshPrint (ctl, "%s\n", caps);
5601
    VIR_FREE(caps);
5602

E
Eric Blake 已提交
5603
    return true;
5604 5605
}

5606 5607 5608
/*
 * "dumpxml" command
 */
5609
static const vshCmdInfo info_dumpxml[] = {
5610 5611
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
5612
    {NULL, NULL}
5613 5614
};

5615
static const vshCmdOptDef opts_dumpxml[] = {
5616 5617 5618
    {"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")},
5619
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
5620
    {NULL, 0, 0, NULL}
5621 5622
};

E
Eric Blake 已提交
5623
static bool
5624
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
5625
{
5626
    virDomainPtr dom;
E
Eric Blake 已提交
5627
    bool ret = true;
5628
    char *dump;
E
Eric Blake 已提交
5629
    unsigned int flags = 0;
5630 5631
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
5632
    int update = vshCommandOptBool(cmd, "update-cpu");
5633 5634 5635 5636 5637

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
5638 5639
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
5640

5641
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5642
        return false;
5643

J
Jim Meyering 已提交
5644
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
5645
        return false;
5646

5647
    dump = virDomainGetXMLDesc(dom, flags);
5648
    if (dump != NULL) {
5649
        vshPrint(ctl, "%s", dump);
5650
        VIR_FREE(dump);
5651
    } else {
E
Eric Blake 已提交
5652
        ret = false;
5653
    }
5654

5655 5656 5657 5658
    virDomainFree(dom);
    return ret;
}

5659 5660 5661 5662
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
5663 5664
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
5665 5666 5667 5668
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
5669 5670
    {"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")},
5671 5672 5673
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5674
static bool
5675 5676
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5677
    bool ret = true;
5678 5679
    const char *format = NULL;
    const char *configFile = NULL;
5680 5681
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
5682
    unsigned int flags = 0;
5683

5684
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5685
        return false;
5686

5687 5688
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
5689
        return false;
5690

5691
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
5692
        return false;
5693 5694 5695

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
5696
        vshPrint(ctl, "%s", xmlData);
5697
        VIR_FREE(xmlData);
5698
    } else {
E
Eric Blake 已提交
5699
        ret = false;
5700 5701
    }

5702
    VIR_FREE(configData);
5703 5704 5705 5706 5707 5708 5709
    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
5710 5711
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
5712 5713 5714 5715
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
5716 5717
    {"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")},
5718 5719 5720
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5721
static bool
5722 5723
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5724
    bool ret = true;
5725 5726
    const char *format = NULL;
    const char *xmlFile = NULL;
5727 5728
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
5729
    unsigned int flags = 0;
5730

5731
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5732
        return false;
5733

5734 5735
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
5736
        return false;
5737

5738
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
5739
        return false;
5740 5741 5742

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
5743
        vshPrint(ctl, "%s", configData);
5744
        VIR_FREE(configData);
5745
    } else {
E
Eric Blake 已提交
5746
        ret = false;
5747 5748
    }

5749
    VIR_FREE(xmlData);
5750 5751 5752
    return ret;
}

K
Karel Zak 已提交
5753
/*
K
Karel Zak 已提交
5754
 * "domname" command
K
Karel Zak 已提交
5755
 */
5756
static const vshCmdInfo info_domname[] = {
5757
    {"help", N_("convert a domain id or UUID to domain name")},
5758
    {"desc", ""},
5759
    {NULL, NULL}
K
Karel Zak 已提交
5760 5761
};

5762
static const vshCmdOptDef opts_domname[] = {
5763
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
5764
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5765 5766
};

E
Eric Blake 已提交
5767
static bool
5768
cmdDomname(vshControl *ctl, const vshCmd *cmd)
5769
{
K
Karel Zak 已提交
5770 5771
    virDomainPtr dom;

5772
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5773
        return false;
J
Jim Meyering 已提交
5774
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5775
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
5776
        return false;
5777

K
Karel Zak 已提交
5778 5779
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
5780
    return true;
K
Karel Zak 已提交
5781 5782 5783
}

/*
K
Karel Zak 已提交
5784
 * "domid" command
K
Karel Zak 已提交
5785
 */
5786
static const vshCmdInfo info_domid[] = {
5787
    {"help", N_("convert a domain name or UUID to domain id")},
5788
    {"desc", ""},
5789
    {NULL, NULL}
K
Karel Zak 已提交
5790 5791
};

5792
static const vshCmdOptDef opts_domid[] = {
5793
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
5794
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5795 5796
};

E
Eric Blake 已提交
5797
static bool
5798
cmdDomid(vshControl *ctl, const vshCmd *cmd)
5799
{
5800
    virDomainPtr dom;
5801
    unsigned int id;
K
Karel Zak 已提交
5802

5803
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5804
        return false;
J
Jim Meyering 已提交
5805
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5806
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
5807
        return false;
5808

5809 5810
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
5811
        vshPrint(ctl, "%s\n", "-");
5812
    else
5813
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
5814
    virDomainFree(dom);
E
Eric Blake 已提交
5815
    return true;
K
Karel Zak 已提交
5816
}
5817

K
Karel Zak 已提交
5818 5819 5820
/*
 * "domuuid" command
 */
5821
static const vshCmdInfo info_domuuid[] = {
5822
    {"help", N_("convert a domain name or id to domain UUID")},
5823
    {"desc", ""},
K
Karel Zak 已提交
5824 5825 5826
    {NULL, NULL}
};

5827
static const vshCmdOptDef opts_domuuid[] = {
5828
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
5829 5830 5831
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5832
static bool
5833
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
5834 5835
{
    virDomainPtr dom;
5836
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
5837

5838
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5839
        return false;
J
Jim Meyering 已提交
5840
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5841
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
5842
        return false;
5843

K
Karel Zak 已提交
5844 5845 5846
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
5847
        vshError(ctl, "%s", _("failed to get domain UUID"));
5848

5849
    virDomainFree(dom);
E
Eric Blake 已提交
5850
    return true;
K
Karel Zak 已提交
5851 5852
}

5853 5854 5855
/*
 * "migrate" command
 */
5856
static const vshCmdInfo info_migrate[] = {
5857 5858
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
5859 5860 5861
    {NULL, NULL}
};

5862
static const vshCmdOptDef opts_migrate[] = {
5863 5864 5865 5866 5867 5868 5869
    {"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")},
5870 5871
    {"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)")},
5872 5873
    {"change-protection", VSH_OT_BOOL, 0,
     N_("prevent any configuration changes to domain until migration ends)")},
W
Wen Congyang 已提交
5874
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
5875
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
5876
    {"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)")},
5877 5878
    {"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 已提交
5879
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
5880
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
5881 5882 5883
    {NULL, 0, 0, NULL}
};

5884 5885 5886 5887 5888 5889 5890 5891
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
5892
{
5893
    char ret = '1';
5894
    virDomainPtr dom = NULL;
5895 5896 5897
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
E
Eric Blake 已提交
5898
    unsigned int flags = 0;
5899 5900 5901
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
5902 5903
    const char *xmlfile = NULL;
    char *xml = NULL;
5904
    sigset_t sigmask, oldsigmask;
5905 5906 5907 5908 5909

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

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

J
Jim Meyering 已提交
5914
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
5915
        goto out;
5916

5917 5918
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
5919 5920
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
5921
        goto out;
5922
    }
5923

5924 5925 5926 5927 5928
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

5929 5930
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
5931 5932
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
5933
    if (vshCommandOptBool (cmd, "tunnelled"))
5934
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
5935

C
Chris Lalancette 已提交
5936 5937 5938 5939 5940
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

5941 5942 5943
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

5944 5945 5946 5947 5948 5949
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

5950 5951
    if (vshCommandOptBool (cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;
5952 5953 5954 5955 5956 5957

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


5958 5959 5960 5961
    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. */
5962

5963
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
5964
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
5965
            goto out;
5966
        }
5967

5968
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
5969
            ret = '0';
5970 5971 5972 5973 5974 5975
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
5976
        if (!dconn) goto out;
5977

5978
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
5979 5980
        if (ddom) {
            virDomainFree(ddom);
5981
            ret = '0';
5982 5983 5984
        }
        virConnectClose (dconn);
    }
5985

5986 5987 5988
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
5989
    if (dom) virDomainFree (dom);
5990
    VIR_FREE(xml);
5991 5992 5993
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
5994
static void
5995 5996
print_job_progress(const char *label, unsigned long long remaining,
                   unsigned long long total)
W
Wen Congyang 已提交
5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015
{
    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;
        }
    }

6016 6017
    /* see comments in vshError about why we must flush */
    fflush(stdout);
6018
    fprintf(stderr, "\r%s: [%3d %%]", label, progress);
6019
    fflush(stderr);
W
Wen Congyang 已提交
6020 6021
}

E
Eric Blake 已提交
6022
static bool
6023 6024 6025 6026 6027
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
6028
    bool functionReturn = false;
6029 6030 6031 6032 6033
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
6034 6035
    virDomainJobInfo jobinfo;
    bool verbose = false;
6036
    int timeout = 0;
W
Wen Congyang 已提交
6037 6038
    struct timeval start, curr;
    bool live_flag = false;
6039
    vshCtrlData data;
6040 6041 6042 6043
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
6044 6045

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

W
Wen Congyang 已提交
6048 6049 6050
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
6051
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
6052
        live_flag = true;
6053
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070
        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;
        }
    }

6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093
    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 已提交
6094
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
6095
    while (1) {
6096
repoll:
W
Wen Congyang 已提交
6097 6098 6099 6100
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
6101
                    functionReturn = true;
W
Wen Congyang 已提交
6102 6103
                    if (verbose) {
                        /* print [100 %] */
6104
                        print_job_progress("Migration", 0, 1);
W
Wen Congyang 已提交
6105 6106
                    }
                } else
W
Wen Congyang 已提交
6107
                    functionReturn = false;
6108
            } else
W
Wen Congyang 已提交
6109
                functionReturn = false;
W
Wen Congyang 已提交
6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
6121
            functionReturn = false;
W
Wen Congyang 已提交
6122 6123 6124
            break;
        }

W
Wen Congyang 已提交
6125 6126 6127 6128
        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. */
6129 6130
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "suspend the domain when migration timeouts\n");
W
Wen Congyang 已提交
6131 6132 6133 6134
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
6135 6136 6137 6138 6139
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
6140 6141
                print_job_progress("Migration", jobinfo.dataRemaining,
                                   jobinfo.dataTotal);
6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
6153
    return functionReturn;
6154 6155
}

6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166
/*
 * "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")},
6167
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
6168 6169 6170
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6171
static bool
6172 6173 6174
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
6175
    long long downtime = 0;
E
Eric Blake 已提交
6176
    bool ret = false;
6177

6178
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6179
        return false;
6180 6181

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

6184 6185
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
6186 6187 6188 6189 6190 6191 6192
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
6193
    ret = true;
6194 6195 6196 6197 6198 6199

done:
    virDomainFree(dom);
    return ret;
}

6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243
/*
 * "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;
}

6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282
/*
 * "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;
}

6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299
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))
6300
        goto cleanup;
6301 6302

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
6303
        goto cleanup;
6304 6305

    if (vshCommandOptString(cmd, "path", &path) < 0)
6306
        goto cleanup;
6307

6308 6309
    if (vshCommandOptUL(cmd, "bandwidth", &bandwidth) < 0) {
        vshError(ctl, "%s", _("bandwidth must be a number"));
6310
        goto cleanup;
6311
    }
6312 6313 6314 6315 6316 6317 6318 6319 6320 6321

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

6322
cleanup:
6323 6324
    if (dom)
        virDomainFree(dom);
6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407
    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;
}

6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464
/*
 * "blockresize" command
 */
static const vshCmdInfo info_block_resize[] = {
    {"help", N_("Resize block device of domain.")},
    {"desc", N_("Resize block device of domain.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_block_resize[] = {
    {"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 block device")},
    {"size", VSH_OT_INT, VSH_OFLAG_REQ, N_("New size of the block device in kilobytes, "
                                           "the size must be integer")},
    {NULL, 0, 0, NULL}
};

static bool
cmdBlockResize(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *path = NULL;
    unsigned long long size = 0;
    unsigned int flags = 0;
    int ret = false;

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

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

    if (vshCommandOptULongLong(cmd, "size", &size) < 0) {
        vshError(ctl, "%s", _("Unable to parse integer"));
        return false;
    }

    if (size > ULLONG_MAX / 1024) {
        vshError(ctl, _("Size must be less than %llu"), ULLONG_MAX / 1024);
        return false;
    }

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

    if (virDomainBlockResize(dom, path, size, flags) < 0) {
        vshError(ctl, _("Failed to resize block device '%s'"), path);
    } else {
        vshPrint(ctl, _("Block device '%s' is resized"), path);
        ret = true;
    }

    virDomainFree(dom);
    return ret;
}
6465

6466 6467 6468
/*
 * "net-autostart" command
 */
6469
static const vshCmdInfo info_network_autostart[] = {
6470
    {"help", N_("autostart a network")},
6471
    {"desc",
6472
     N_("Configure a network to be automatically started at boot.")},
6473 6474 6475
    {NULL, NULL}
};

6476
static const vshCmdOptDef opts_network_autostart[] = {
6477 6478
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6479 6480 6481
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6482
static bool
6483
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
6484 6485
{
    virNetworkPtr network;
6486
    const char *name;
6487 6488
    int autostart;

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

J
Jim Meyering 已提交
6492
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6493
        return false;
6494 6495 6496 6497

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
6498
        if (autostart)
6499
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
6500
        else
6501
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
6502
        virNetworkFree(network);
E
Eric Blake 已提交
6503
        return false;
6504 6505
    }

6506
    if (autostart)
6507
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
6508
    else
6509
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
6510

L
Laine Stump 已提交
6511
    virNetworkFree(network);
E
Eric Blake 已提交
6512
    return true;
6513
}
K
Karel Zak 已提交
6514

L
Lei Li 已提交
6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652
/*
 * "blkdeviotune" command
 */
static const vshCmdInfo info_blkdeviotune[] = {
    {"help", N_("Set or query a block device I/O tuning parameters.")},
    {"desc", N_("Set or query disk I/O parameters such as block throttling.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_blkdeviotune[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
    {"total_bytes_sec", VSH_OT_INT, VSH_OFLAG_NONE,
     N_("total throughput limit in bytes per second")},
    {"read_bytes_sec", VSH_OT_INT, VSH_OFLAG_NONE,
     N_("read throughput limit in bytes per second")},
    {"write_bytes_sec", VSH_OT_INT, VSH_OFLAG_NONE,
     N_("write throughput limit in bytes per second")},
    {"total_iops_sec", VSH_OT_INT, VSH_OFLAG_NONE,
     N_("total I/O operations limit per second")},
    {"read_iops_sec", VSH_OT_INT, VSH_OFLAG_NONE,
     N_("read I/O operations limit per second")},
    {"write_iops_sec", VSH_OT_INT, VSH_OFLAG_NONE,
     N_("write I/O operations limit per second")},
    {"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")},
    {NULL, 0, 0, NULL}
};

static bool
cmdBlkdeviotune(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    const char *name, *disk;
    unsigned long long total_bytes_sec = 0, read_bytes_sec = 0, write_bytes_sec = 0;
    unsigned long long total_iops_sec = 0, read_iops_sec = 0, write_iops_sec = 0;
    int nparams = 0;
    virTypedParameterPtr params = NULL, temp = NULL;
    unsigned int flags = 0, i = 0;
    int rv = 0;
    int current = vshCommandOptBool(cmd, "current");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    bool ret = false;

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

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

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

    if (vshCommandOptString(cmd, "device", &disk) < 0)
        goto cleanup;

    if ((rv = vshCommandOptULongLong(cmd, "total_bytes_sec", &total_bytes_sec)) < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    } else if (rv > 0) {
        nparams++;
    }

    if ((rv = vshCommandOptULongLong(cmd, "read_bytes_sec", &read_bytes_sec)) < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    } else if (rv > 0) {
        nparams++;
    }

    if ((rv = vshCommandOptULongLong(cmd, "write_bytes_sec", &write_bytes_sec)) < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    } else if (rv > 0) {
        nparams++;
    }

    if ((rv = vshCommandOptULongLong(cmd, "total_iops_sec", &total_iops_sec)) < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    } else if (rv > 0) {
        nparams++;
    }

    if ((rv = vshCommandOptULongLong(cmd, "read_iops_sec", &read_iops_sec)) < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    } else if (rv > 0) {
        nparams++;
    }

    if ((rv = vshCommandOptULongLong(cmd, "write_iops_sec", &write_iops_sec)) < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    } else if (rv > 0) {
        nparams++;
    }

    if (nparams == 0) {

        if ((virDomainGetBlockIoTune(dom, NULL, NULL, &nparams, flags)) != 0) {
            vshError(ctl, "%s",
                     _("Unable to get number of block I/O throttle parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            ret = true;
            goto cleanup;
        }

        params = vshCalloc(ctl, nparams, sizeof(*params));

        if ((virDomainGetBlockIoTune(dom, disk, params, &nparams, flags)) != 0) {
            vshError(ctl, "%s",
                     _("Unable to get block I/O throttle parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
6653 6654 6655
            char *str = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
            VIR_FREE(str);
L
Lei Li 已提交
6656 6657
        }

6658
        ret = true;
6659
        goto cleanup;
L
Lei Li 已提交
6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732
    } else {
        /* Set the block I/O throttle, match by opt since parameters can be 0 */
        params = vshCalloc(ctl, nparams, sizeof(*params));
        i = 0;

        if ((i < nparams) && (vshCommandOptBool(cmd, "total_bytes_sec"))) {
            temp = &params[i];
            temp->type = VIR_TYPED_PARAM_ULLONG;
            strncpy(temp->field, VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_BYTES_SEC,
                    sizeof(temp->field));
            temp->value.ul = total_bytes_sec;
            i++;
        }

        if ((i < nparams) && (vshCommandOptBool(cmd, "read_bytes_sec"))) {
            temp = &params[i];
            temp->type = VIR_TYPED_PARAM_ULLONG;
            strncpy(temp->field, VIR_DOMAIN_BLOCK_IOTUNE_READ_BYTES_SEC,
                    sizeof(temp->field));
            temp->value.ul = read_bytes_sec;
            i++;
        }

        if ((i < nparams) && (vshCommandOptBool(cmd, "write_bytes_sec"))) {
            temp = &params[i];
            temp->type = VIR_TYPED_PARAM_ULLONG;
            strncpy(temp->field, VIR_DOMAIN_BLOCK_IOTUNE_WRITE_BYTES_SEC,
                    sizeof(temp->field));
            temp->value.ul = write_bytes_sec;
            i++;
        }

        if ((i < nparams) && (vshCommandOptBool(cmd, "total_iops_sec"))) {
            temp = &params[i];
            temp->type = VIR_TYPED_PARAM_ULLONG;
            strncpy(temp->field, VIR_DOMAIN_BLOCK_IOTUNE_TOTAL_IOPS_SEC,
                    sizeof(temp->field));
            temp->value.ul = total_iops_sec;
            i++;
        }

        if ((i < nparams) && (vshCommandOptBool(cmd, "read_iops_sec"))) {
            temp = &params[i];
            temp->type = VIR_TYPED_PARAM_ULLONG;
            strncpy(temp->field, VIR_DOMAIN_BLOCK_IOTUNE_READ_IOPS_SEC,
                    sizeof(temp->field));
            temp->value.ul = read_iops_sec;
            i++;
        }

        if ((i < nparams) && (vshCommandOptBool(cmd, "write_iops_sec"))) {
            temp = &params[i];
            temp->type = VIR_TYPED_PARAM_ULLONG;
            strncpy(temp->field, VIR_DOMAIN_BLOCK_IOTUNE_WRITE_IOPS_SEC,
                    sizeof(temp->field));
            temp->value.ul = write_iops_sec;
        }

        if ((virDomainSetBlockIoTune(dom, disk, params, nparams, flags)) < 0) {
            vshError(ctl, "%s",
                     _("Unable to change block I/O throttle"));
            goto cleanup;
        }
    }

    ret = true;

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

6733 6734 6735
/*
 * "net-create" command
 */
6736
static const vshCmdInfo info_network_create[] = {
6737 6738
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
6739 6740 6741
    {NULL, NULL}
};

6742
static const vshCmdOptDef opts_network_create[] = {
6743
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
6744 6745 6746
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6747
static bool
6748
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
6749 6750
{
    virNetworkPtr network;
6751
    const char *from = NULL;
E
Eric Blake 已提交
6752
    bool ret = true;
6753
    char *buffer;
6754

6755
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6756
        return false;
6757

6758
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6759
        return false;
6760

6761
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6762
        return false;
6763 6764

    network = virNetworkCreateXML(ctl->conn, buffer);
6765
    VIR_FREE(buffer);
6766

6767 6768 6769
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
6770
        virNetworkFree(network);
6771
    } else {
6772
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
6773
        ret = false;
6774 6775 6776 6777 6778 6779 6780 6781
    }
    return ret;
}


/*
 * "net-define" command
 */
6782
static const vshCmdInfo info_network_define[] = {
6783 6784
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
6785 6786 6787
    {NULL, NULL}
};

6788
static const vshCmdOptDef opts_network_define[] = {
6789
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
6790 6791 6792
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6793
static bool
6794
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
6795 6796
{
    virNetworkPtr network;
6797
    const char *from = NULL;
E
Eric Blake 已提交
6798
    bool ret = true;
6799
    char *buffer;
6800

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

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

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

    network = virNetworkDefineXML(ctl->conn, buffer);
6811
    VIR_FREE(buffer);
6812

6813 6814 6815
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
6816
        virNetworkFree(network);
6817
    } else {
6818
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
6819
        ret = false;
6820 6821 6822 6823 6824 6825 6826 6827
    }
    return ret;
}


/*
 * "net-destroy" command
 */
6828
static const vshCmdInfo info_network_destroy[] = {
6829 6830
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
6831 6832 6833
    {NULL, NULL}
};

6834
static const vshCmdOptDef opts_network_destroy[] = {
6835
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6836 6837 6838
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6839
static bool
6840
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
6841 6842
{
    virNetworkPtr network;
E
Eric Blake 已提交
6843
    bool ret = true;
6844
    const char *name;
6845

6846
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6847
        return false;
6848

J
Jim Meyering 已提交
6849
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6850
        return false;
6851 6852 6853 6854

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

6859
    virNetworkFree(network);
6860 6861 6862 6863 6864 6865 6866
    return ret;
}


/*
 * "net-dumpxml" command
 */
6867
static const vshCmdInfo info_network_dumpxml[] = {
6868 6869
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
6870 6871 6872
    {NULL, NULL}
};

6873
static const vshCmdOptDef opts_network_dumpxml[] = {
6874
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6875 6876 6877
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6878
static bool
6879
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
6880 6881
{
    virNetworkPtr network;
E
Eric Blake 已提交
6882
    bool ret = true;
6883 6884
    char *dump;

6885
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6886
        return false;
6887

J
Jim Meyering 已提交
6888
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
6889
        return false;
6890 6891 6892

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
6893
        vshPrint(ctl, "%s", dump);
6894
        VIR_FREE(dump);
6895
    } else {
E
Eric Blake 已提交
6896
        ret = false;
6897 6898 6899 6900 6901 6902
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
6903 6904 6905 6906 6907
/*
 * "net-info" command
 */
static const vshCmdInfo info_network_info[] = {
    {"help", N_("network information")},
E
Eric Blake 已提交
6908
    {"desc", N_("Returns basic information about the network")},
O
Osier Yang 已提交
6909 6910 6911 6912 6913 6914 6915 6916
    {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 已提交
6917
static bool
O
Osier Yang 已提交
6918 6919 6920 6921 6922 6923 6924 6925 6926 6927
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 已提交
6928
        return false;
O
Osier Yang 已提交
6929 6930 6931

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6932
        return false;
O
Osier Yang 已提交
6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957

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

6958
    VIR_FREE(bridge);
O
Osier Yang 已提交
6959
    virNetworkFree(network);
E
Eric Blake 已提交
6960
    return true;
O
Osier Yang 已提交
6961
}
6962

6963 6964 6965 6966
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
6967 6968
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
6969 6970 6971 6972
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
6973
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6974 6975 6976
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6977
static bool
6978 6979
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6980
    bool ret = false;
6981 6982 6983 6984 6985
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
6986
    unsigned int flags = VIR_INTERFACE_XML_INACTIVE;
6987

6988
    if (!vshConnectionUsability(ctl, ctl->conn))
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
        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 已提交
7015
        ret = true;
7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027
        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)) {
7028 7029
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041
        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 已提交
7042
    ret = true;
7043 7044 7045 7046 7047

cleanup:
    if (iface)
        virInterfaceFree (iface);

7048 7049 7050
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
7051 7052 7053

    if (tmp) {
        unlink (tmp);
7054
        VIR_FREE(tmp);
7055 7056 7057 7058 7059
    }

    return ret;
}

7060 7061 7062
/*
 * "net-list" command
 */
7063
static const vshCmdInfo info_network_list[] = {
7064 7065
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
7066 7067 7068
    {NULL, NULL}
};

7069
static const vshCmdOptDef opts_network_list[] = {
7070 7071
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
7072 7073 7074
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7075
static bool
7076
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
7077 7078 7079 7080 7081
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
7082
    char **activeNames = NULL, **inactiveNames = NULL;
7083 7084
    inactive |= all;

7085
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7086
        return false;
7087 7088

    if (active) {
7089 7090
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
7091
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
7092
            return false;
7093
        }
7094
        if (maxactive) {
7095
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
7096

7097
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
7098
                                                    maxactive)) < 0) {
7099
                vshError(ctl, "%s", _("Failed to list active networks"));
7100
                VIR_FREE(activeNames);
E
Eric Blake 已提交
7101
                return false;
7102
            }
7103

7104
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
7105
        }
7106 7107
    }
    if (inactive) {
7108 7109
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
7110
            vshError(ctl, "%s", _("Failed to list inactive networks"));
7111
            VIR_FREE(activeNames);
E
Eric Blake 已提交
7112
            return false;
7113
        }
7114 7115 7116
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

7117 7118 7119
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
7120
                vshError(ctl, "%s", _("Failed to list inactive networks"));
7121 7122
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
7123
                return false;
7124
            }
7125

7126 7127
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
7128
    }
7129 7130
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
7131
    vshPrintExtra(ctl, "-----------------------------------------\n");
7132 7133

    for (i = 0; i < maxactive; i++) {
7134 7135
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
7136 7137
        const char *autostartStr;
        int autostart = 0;
7138 7139 7140

        /* this kind of work with networks is not atomic operation */
        if (!network) {
7141
            VIR_FREE(activeNames[i]);
7142
            continue;
7143
        }
7144

7145 7146 7147
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
7148
            autostartStr = autostart ? _("yes") : _("no");
7149 7150 7151 7152 7153

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
7154
        virNetworkFree(network);
7155
        VIR_FREE(activeNames[i]);
7156 7157 7158
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
7159 7160
        const char *autostartStr;
        int autostart = 0;
7161 7162 7163

        /* this kind of work with networks is not atomic operation */
        if (!network) {
7164
            VIR_FREE(inactiveNames[i]);
7165
            continue;
7166
        }
7167

7168 7169 7170
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
7171
            autostartStr = autostart ? _("yes") : _("no");
7172

7173
        vshPrint(ctl, "%-20s %-10s %-10s\n",
7174 7175 7176
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
7177 7178

        virNetworkFree(network);
7179
        VIR_FREE(inactiveNames[i]);
7180
    }
7181 7182
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
7183
    return true;
7184 7185 7186 7187 7188 7189
}


/*
 * "net-name" command
 */
7190
static const vshCmdInfo info_network_name[] = {
7191
    {"help", N_("convert a network UUID to network name")},
7192
    {"desc", ""},
7193 7194 7195
    {NULL, NULL}
};

7196
static const vshCmdOptDef opts_network_name[] = {
7197
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
7198 7199 7200
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7201
static bool
7202
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
7203 7204 7205
{
    virNetworkPtr network;

7206
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7207
        return false;
J
Jim Meyering 已提交
7208
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
7209
                                           VSH_BYUUID)))
E
Eric Blake 已提交
7210
        return false;
7211 7212 7213

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
7214
    return true;
7215 7216 7217 7218 7219 7220
}


/*
 * "net-start" command
 */
7221
static const vshCmdInfo info_network_start[] = {
7222 7223
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
7224 7225 7226
    {NULL, NULL}
};

7227
static const vshCmdOptDef opts_network_start[] = {
7228
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
7229 7230 7231
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7232
static bool
7233
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
7234 7235
{
    virNetworkPtr network;
E
Eric Blake 已提交
7236
    bool ret = true;
7237

7238
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7239
        return false;
7240

J
Jim Meyering 已提交
7241
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
7242
         return false;
7243 7244 7245

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
7246
                 virNetworkGetName(network));
7247
    } else {
7248
        vshError(ctl, _("Failed to start network %s"),
7249
                 virNetworkGetName(network));
E
Eric Blake 已提交
7250
        ret = false;
7251
    }
L
Laine Stump 已提交
7252
    virNetworkFree(network);
7253 7254 7255 7256 7257 7258 7259
    return ret;
}


/*
 * "net-undefine" command
 */
7260
static const vshCmdInfo info_network_undefine[] = {
7261 7262
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
7263 7264 7265
    {NULL, NULL}
};

7266
static const vshCmdOptDef opts_network_undefine[] = {
7267
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
7268 7269 7270
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7271
static bool
7272
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
7273 7274
{
    virNetworkPtr network;
E
Eric Blake 已提交
7275
    bool ret = true;
7276
    const char *name;
7277

7278
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7279
        return false;
7280

J
Jim Meyering 已提交
7281
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
7282
        return false;
7283 7284 7285 7286

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

L
Laine Stump 已提交
7291
    virNetworkFree(network);
7292 7293 7294 7295 7296 7297 7298
    return ret;
}


/*
 * "net-uuid" command
 */
7299
static const vshCmdInfo info_network_uuid[] = {
7300
    {"help", N_("convert a network name to network UUID")},
7301
    {"desc", ""},
7302 7303 7304
    {NULL, NULL}
};

7305
static const vshCmdOptDef opts_network_uuid[] = {
7306
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
7307 7308 7309
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7310
static bool
7311
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
7312 7313 7314 7315
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

7316
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7317
        return false;
7318

J
Jim Meyering 已提交
7319
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
7320
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7321
        return false;
7322 7323 7324 7325

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

L
Laine Stump 已提交
7328
    virNetworkFree(network);
E
Eric Blake 已提交
7329
    return true;
7330 7331 7332
}


7333 7334 7335 7336 7337
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
7338 7339
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
7340 7341 7342 7343
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
7344 7345
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
7346 7347
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
7348
static bool
7349 7350 7351 7352 7353 7354 7355 7356 7357
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;

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

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
7364
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
7365
            return false;
7366 7367 7368 7369 7370 7371
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
7372
                vshError(ctl, "%s", _("Failed to list active interfaces"));
7373
                VIR_FREE(activeNames);
E
Eric Blake 已提交
7374
                return false;
7375 7376 7377 7378 7379 7380 7381 7382
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
7383
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
7384
            VIR_FREE(activeNames);
E
Eric Blake 已提交
7385
            return false;
7386 7387 7388 7389
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

7390 7391 7392
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
7393
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
7394 7395
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
7396
                return false;
7397 7398 7399 7400 7401
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
7402 7403
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
7404 7405 7406
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
7407 7408
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
7409 7410 7411

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
7412
            VIR_FREE(activeNames[i]);
7413 7414 7415 7416 7417 7418 7419 7420
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
7421
        VIR_FREE(activeNames[i]);
7422 7423
    }
    for (i = 0; i < maxinactive; i++) {
7424 7425
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
7426 7427 7428

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
7429
            VIR_FREE(inactiveNames[i]);
7430 7431 7432 7433 7434 7435 7436 7437
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
7438
        VIR_FREE(inactiveNames[i]);
7439
    }
7440 7441
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
7442
    return true;
7443 7444 7445 7446 7447 7448 7449

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
7450
    {"help", N_("convert an interface MAC address to interface name")},
7451 7452 7453 7454 7455
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
7456
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
7457 7458 7459
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7460
static bool
7461 7462 7463 7464
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

7465
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7466
        return false;
7467
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL, NULL,
7468
                                           VSH_BYMAC)))
E
Eric Blake 已提交
7469
        return false;
7470 7471 7472

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
7473
    return true;
7474 7475 7476 7477 7478 7479
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
7480
    {"help", N_("convert an interface name to interface MAC address")},
7481 7482 7483 7484 7485
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
7486
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
7487 7488 7489
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7490
static bool
7491 7492 7493 7494
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

7495
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7496
        return false;
7497
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL, NULL,
7498
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7499
        return false;
7500 7501 7502

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
7503
    return true;
7504 7505 7506 7507 7508 7509
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
7510 7511
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
7512 7513 7514 7515
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
7516 7517
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
7518 7519 7520
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7521
static bool
7522 7523 7524
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
7525
    bool ret = true;
7526
    char *dump;
E
Eric Blake 已提交
7527
    unsigned int flags = 0;
7528 7529 7530 7531
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
7532

7533
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7534
        return false;
7535 7536

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

7539
    dump = virInterfaceGetXMLDesc(iface, flags);
7540
    if (dump != NULL) {
7541
        vshPrint(ctl, "%s", dump);
7542
        VIR_FREE(dump);
7543
    } else {
E
Eric Blake 已提交
7544
        ret = false;
7545 7546 7547 7548 7549 7550 7551 7552 7553 7554
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
7555 7556
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
7557 7558 7559 7560
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
7561
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
7562 7563 7564
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7565
static bool
7566 7567
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
7568
    virInterfacePtr iface;
7569
    const char *from = NULL;
E
Eric Blake 已提交
7570
    bool ret = true;
7571 7572
    char *buffer;

7573
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7574
        return false;
7575

7576
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7577
        return false;
7578 7579

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

7582
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
7583
    VIR_FREE(buffer);
7584

7585
    if (iface != NULL) {
7586
        vshPrint(ctl, _("Interface %s defined from %s\n"),
7587
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
7588
        virInterfaceFree (iface);
7589
    } else {
7590
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
7591
        ret = false;
7592 7593 7594 7595 7596 7597 7598 7599
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
7600 7601
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
7602 7603 7604 7605
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
7606
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
7607 7608 7609
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7610
static bool
7611 7612 7613
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
7614
    bool ret = true;
7615
    const char *name;
7616

7617
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7618
        return false;
7619 7620

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
7621
        return false;
7622 7623 7624 7625

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
7626
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
7627
        ret = false;
7628 7629 7630 7631 7632 7633 7634 7635 7636 7637
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
7638 7639
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
7640 7641 7642 7643
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
7644
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
7645 7646 7647
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7648
static bool
7649 7650 7651
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
7652
    bool ret = true;
7653
    const char *name;
7654

7655
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7656
        return false;
7657 7658

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
7659
        return false;
7660 7661 7662 7663

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
7664
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
7665
        ret = false;
7666 7667 7668 7669 7670 7671 7672 7673 7674 7675
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
7676
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
7677
    {"desc", N_("forcefully stop a physical host interface.")},
7678 7679 7680 7681
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
7682
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
7683 7684 7685
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7686
static bool
7687 7688 7689
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
7690
    bool ret = true;
7691
    const char *name;
7692

7693
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7694
        return false;
7695 7696

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
7697
        return false;
7698 7699 7700 7701

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
7702
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
7703
        ret = false;
7704 7705 7706 7707 7708 7709
    }

    virInterfaceFree(iface);
    return ret;
}

7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794
/*
 * "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;
}
7795

7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 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 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208
/*
 * "iface-bridge" command
 */
static const vshCmdInfo info_interface_bridge[] = {
    {"help", N_("create a bridge device and attach an existing network device to it")},
    {"desc", N_("bridge an existing network device")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_bridge[] = {
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("existing interface name")},
    {"bridge", VSH_OT_DATA, VSH_OFLAG_REQ, N_("new bridge device name")},
    {"no-stp", VSH_OT_BOOL, 0, N_("do not enable STP for this bridge")},
    {"delay", VSH_OT_INT, 0,
     N_("number of seconds to squelch traffic on newly connected ports")},
    {"no-start", VSH_OT_BOOL, 0, N_("don't start the bridge immediately")},
    {NULL, 0, 0, NULL}
};

static bool
cmdInterfaceBridge(vshControl *ctl, const vshCmd *cmd)
{
    bool ret = false;
    virInterfacePtr if_handle = NULL, br_handle = NULL;
    const char *if_name, *br_name;
    char *if_type = NULL, *if2_name = NULL, *delay_str = NULL;
    bool stp = false, nostart = false;
    unsigned int delay = 0;
    char *if_xml = NULL;
    xmlChar *br_xml = NULL;
    int br_xml_size;
    xmlDocPtr xml_doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr top_node, br_node, if_node, cur;

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

    /* Get a handle to the original device */
    if (!(if_handle = vshCommandOptInterfaceBy(ctl, cmd, "interface",
                                               &if_name, VSH_BYNAME))) {
        goto cleanup;
    }

    /* Name for new bridge device */
    if (vshCommandOptString(cmd, "bridge", &br_name) <= 0) {
        vshError(ctl, "%s", _("Missing bridge device name in command"));
        goto cleanup;
    }

    /* make sure "new" device doesn't already exist */
    if ((br_handle = virInterfaceLookupByName(ctl->conn, br_name))) {
        vshError(ctl, _("Network device %s already exists"), br_name);
        goto cleanup;
    }

    /* use "no-stp" because we want "stp" to default true */
    stp = !vshCommandOptBool(cmd, "no-stp");

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

    nostart = vshCommandOptBool(cmd, "no-start");

    /* Get the original interface into an xmlDoc */
    if (!(if_xml = virInterfaceGetXMLDesc(if_handle, VIR_INTERFACE_XML_INACTIVE)))
        goto cleanup;
    if (!(xml_doc = virXMLParseStringCtxt(if_xml,
                                          _("(interface definition)"), &ctxt))) {
        vshError(ctl, _("Failed to parse configuration of %s"), if_name);
        goto cleanup;
    }
    top_node = ctxt->node;

    /* Verify that the original device isn't already a bridge. */
    if (!(if_type = virXMLPropString(top_node, "type"))) {
        vshError(ctl, _("Existing device %s has no type"), if_name);
        goto cleanup;
    }

    if (STREQ(if_type, "bridge")) {
        vshError(ctl, _("Existing device %s is already a bridge"), if_name);
        goto cleanup;
    }

    /* verify the name in the XML matches the device name */
    if (!(if2_name = virXMLPropString(top_node, "name")) ||
        STRNEQ(if2_name, if_name)) {
        vshError(ctl, _("Interface name from config %s doesn't match given supplied name %s"),
                 if2_name, if_name);
        goto cleanup;
    }

    /* Create a <bridge> node under <interface>. */
    if (!(br_node = xmlNewChild(top_node, NULL, BAD_CAST "bridge", NULL))) {
        vshError(ctl, "%s", _("Failed to create bridge node in xml document"));
        goto cleanup;
    }

    /* Set stp and delay attributes in <bridge> according to the
     * commandline options.
     */
    if (!xmlSetProp(br_node, BAD_CAST "stp", BAD_CAST (stp ? "on" : "off"))) {
        vshError(ctl, "%s", _("Failed to set stp attribute in xml document"));
        goto cleanup;
    }

    if ((delay || stp) &&
        ((virAsprintf(&delay_str, "%d", delay) < 0) ||
         !xmlSetProp(br_node, BAD_CAST "delay", BAD_CAST delay_str))) {
        vshError(ctl, _("Failed to set bridge delay %d in xml document"), delay);
        goto cleanup;
    }

    /* Change the type of the outer/master interface to "bridge" and the
     * name to the provided bridge name.
     */
    if (!xmlSetProp(top_node, BAD_CAST "type", BAD_CAST "bridge")) {
        vshError(ctl, "%s", _("Failed to set bridge interface type to 'bridge' in xml document"));
        goto cleanup;
    }

    if (!xmlSetProp(top_node, BAD_CAST "name", BAD_CAST br_name)) {
        vshError(ctl, _("Failed to set master bridge interface name to '%s' in xml document"),
            br_name);
        goto cleanup;
    }

    /* Create an <interface> node under <bridge> that uses the
     * original interface's type and name.
     */
    if (!(if_node = xmlNewChild(br_node, NULL, BAD_CAST "interface", NULL))) {
        vshError(ctl, "%s", _("Failed to create interface node under bridge node in xml document"));
        goto cleanup;
    }

    /* set the type of the inner/slave interface to the original
     * if_type, and the name to the original if_name.
     */
    if (!xmlSetProp(if_node, BAD_CAST "type", BAD_CAST if_type)) {
        vshError(ctl, _("Failed to set new slave interface type to '%s' in xml document"),
                 if_name);
        goto cleanup;
    }

    if (!xmlSetProp(if_node, BAD_CAST "name", BAD_CAST if_name)) {
        vshError(ctl, _("Failed to set new slave interface name to '%s' in xml document"),
            br_name);
        goto cleanup;
    }

    /* Cycle through all the nodes under the original <interface>,
     * moving all <mac>, <bond> and <vlan> nodes down into the new
     * lower level <interface>.
     */
    cur = top_node->children;
    while (cur) {
        xmlNodePtr old = cur;

        cur = cur->next;
        if ((old->type == XML_ELEMENT_NODE) &&
            (xmlStrEqual(old->name, BAD_CAST "mac") ||  /* ethernet stuff to move down */
             xmlStrEqual(old->name, BAD_CAST "bond") || /* bond stuff to move down */
             xmlStrEqual(old->name, BAD_CAST "vlan"))) { /* vlan stuff to move down */
            xmlUnlinkNode(old);
            if (!xmlAddChild(if_node, old)) {
                vshError(ctl, _("Failed to move '%s' element in xml document"), old->name);
                xmlFreeNode(old);
                goto cleanup;
            }
        }
    }

    /* The document should now be fully converted; write it out to a string. */
    xmlDocDumpMemory(xml_doc, &br_xml, &br_xml_size);

    if (!br_xml || br_xml_size <= 0) {
        vshError(ctl, _("Failed to format new xml document for bridge %s"), br_name);
        goto cleanup;
    }


    /* br_xml is the new interface to define. It will automatically undefine the
     * independent original interface.
     */
    if (!(br_handle = virInterfaceDefineXML(ctl->conn, (char *) br_xml, 0))) {
        vshError(ctl, _("Failed to define new bridge interface %s"),
                 br_name);
        goto cleanup;
    }

    vshPrint(ctl, _("Created bridge %s with attached device %s\n"),
             if_name, br_name);

    /* start it up unless requested not to */
    if (!nostart) {
        if (virInterfaceCreate(br_handle, 0) < 0) {
            vshError(ctl, _("Failed to start bridge interface %s"), br_name);
            goto cleanup;
        }
        vshPrint(ctl, _("Bridge interface %s started\n"), br_name);
    }

    ret = true;
 cleanup:
    if (if_handle)
       virInterfaceFree(if_handle);
    if (br_handle)
       virInterfaceFree(br_handle);
    VIR_FREE(if_xml);
    VIR_FREE(br_xml);
    VIR_FREE(if_type);
    VIR_FREE(if2_name);
    VIR_FREE(delay_str);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml_doc);
    return ret;
}

/*
 * "iface-unbridge" command
 */
static const vshCmdInfo info_interface_unbridge[] = {
    {"help", N_("undefine a bridge device after detaching its slave device")},
    {"desc", N_("unbridge a network device")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_unbridge[] = {
    {"bridge", VSH_OT_DATA, VSH_OFLAG_REQ, N_("current bridge device name")},
    {"no-start", VSH_OT_BOOL, 0,
     N_("don't start the un-slaved interface immediately (not recommended)")},
    {NULL, 0, 0, NULL}
};

static bool
cmdInterfaceUnbridge(vshControl *ctl, const vshCmd *cmd)
{
    bool ret = false;
    virInterfacePtr if_handle = NULL, br_handle = NULL;
    const char *br_name;
    char *if_type = NULL, *if_name = NULL;
    bool nostart = false;
    char *br_xml = NULL;
    xmlChar *if_xml = NULL;
    int if_xml_size;
    xmlDocPtr xml_doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr top_node, br_node, if_node, cur;

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

    /* Get a handle to the original device */
    if (!(br_handle = vshCommandOptInterfaceBy(ctl, cmd, "bridge",
                                               &br_name, VSH_BYNAME))) {
        goto cleanup;
    }

    nostart = vshCommandOptBool(cmd, "no-start");

    /* Get the bridge xml into an xmlDoc */
    if (!(br_xml = virInterfaceGetXMLDesc(br_handle, VIR_INTERFACE_XML_INACTIVE)))
        goto cleanup;
    if (!(xml_doc = virXMLParseStringCtxt(br_xml,
                                          _("(bridge interface definition)"),
                                          &ctxt))) {
        vshError(ctl, _("Failed to parse configuration of %s"), br_name);
        goto cleanup;
    }
    top_node = ctxt->node;

    /* Verify that the device really is a bridge. */
    if (!(if_type = virXMLPropString(top_node, "type"))) {
        vshError(ctl, _("Existing device %s has no type"), br_name);
        goto cleanup;
    }

    if (STRNEQ(if_type, "bridge")) {
        vshError(ctl, _("Device %s is not a bridge"), br_name);
        goto cleanup;
    }
    VIR_FREE(if_type);

    /* verify the name in the XML matches the device name */
    if (!(if_name = virXMLPropString(top_node, "name")) ||
        STRNEQ(if_name, br_name)) {
        vshError(ctl, _("Interface name from config %s doesn't match given supplied name %s"),
                 if_name, br_name);
        goto cleanup;
    }
    VIR_FREE(if_name);

    /* Find the <bridge> node under <interface>. */
    if (!(br_node = virXPathNode("./bridge", ctxt))) {
        vshError(ctl, "%s", _("No bridge node in xml document"));
        goto cleanup;
    }

    if ((if_node = virXPathNode("./bridge/interface[2]", ctxt))) {
        vshError(ctl, "%s", _("Multiple interfaecs attached to bridge"));
        goto cleanup;
    }

    if (!(if_node = virXPathNode("./bridge/interface", ctxt))) {
        vshError(ctl, "%s", _("No interface attached to bridge"));
        goto cleanup;
    }

    /* Change the type and name of the outer/master interface to
     * the type/name of the attached slave interface.
     */
    if (!(if_name = virXMLPropString(if_node, "name"))) {
        vshError(ctl, _("Device attached to bridge %s has no name"), br_name);
        goto cleanup;
    }

    if (!(if_type = virXMLPropString(if_node, "type"))) {
        vshError(ctl, _("Attached device %s has no type"), if_name);
        goto cleanup;
    }

    if (!xmlSetProp(top_node, BAD_CAST "type", BAD_CAST if_type)) {
        vshError(ctl, _("Failed to set interface type to '%s' in xml document"),
                 if_type);
        goto cleanup;
    }

    if (!xmlSetProp(top_node, BAD_CAST "name", BAD_CAST if_name)) {
        vshError(ctl, _("Failed to set interface name to '%s' in xml document"),
                 if_name);
        goto cleanup;
    }

    /* Cycle through all the nodes under the attached <interface>,
     * moving all <mac>, <bond> and <vlan> nodes up into the toplevel
     * <interface>.
     */
    cur = if_node->children;
    while (cur) {
        xmlNodePtr old = cur;

        cur = cur->next;
        if ((old->type == XML_ELEMENT_NODE) &&
            (xmlStrEqual(old->name, BAD_CAST "mac") ||  /* ethernet stuff to move down */
             xmlStrEqual(old->name, BAD_CAST "bond") || /* bond stuff to move down */
             xmlStrEqual(old->name, BAD_CAST "vlan"))) { /* vlan stuff to move down */
            xmlUnlinkNode(old);
            if (!xmlAddChild(top_node, old)) {
                vshError(ctl, _("Failed to move '%s' element in xml document"), old->name);
                xmlFreeNode(old);
                goto cleanup;
            }
        }
    }

    /* The document should now be fully converted; write it out to a string. */
    xmlDocDumpMemory(xml_doc, &if_xml, &if_xml_size);

    if (!if_xml || if_xml_size <= 0) {
        vshError(ctl, _("Failed to format new xml document for un-enslaved interface %s"),
                 if_name);
        goto cleanup;
    }

    /* Destroy and Undefine the bridge device, since we otherwise
     * can't safely define the unattached device.
     */
    if (virInterfaceDestroy(br_handle, 0) < 0) {
        vshError(ctl, _("Failed to destroy bridge interface %s"), br_name);
        goto cleanup;
    }
    if (virInterfaceUndefine(br_handle) < 0) {
        vshError(ctl, _("Failed to undefine bridge interface %s"), br_name);
        goto cleanup;
    }

    /* if_xml is the new interface to define.
     */
    if (!(if_handle = virInterfaceDefineXML(ctl->conn, (char *) if_xml, 0))) {
        vshError(ctl, _("Failed to define new interface %s"), if_name);
        goto cleanup;
    }

    vshPrint(ctl, _("Device %s un-attached from bridge %s\n"),
             if_name, br_name);

    /* unless requested otherwise, undefine the bridge device */
    if (!nostart) {
        if (virInterfaceCreate(if_handle, 0) < 0) {
            vshError(ctl, _("Failed to start interface %s"), if_name);
            goto cleanup;
        }
        vshPrint(ctl, _("Interface %s started\n"), if_name);
    }

    ret = true;
 cleanup:
    if (if_handle)
       virInterfaceFree(if_handle);
    if (br_handle)
       virInterfaceFree(br_handle);
    VIR_FREE(if_xml);
    VIR_FREE(br_xml);
    VIR_FREE(if_type);
    VIR_FREE(if_name);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml_doc);
    return ret;
}

8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222
/*
 * "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 已提交
8223
static bool
8224 8225 8226
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
8227
    const char *from = NULL;
E
Eric Blake 已提交
8228
    bool ret = true;
8229 8230
    char *buffer;

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

8234
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8235
        return false;
8236 8237

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
8238
        return false;
8239 8240 8241 8242 8243 8244 8245 8246 8247 8248

    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 已提交
8249
        ret = false;
8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268
    }
    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 已提交
8269
static bool
8270 8271 8272
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
8273
    bool ret = true;
8274
    const char *name;
8275

8276
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8277
        return false;
8278 8279

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
8280
        return false;
8281 8282 8283 8284 8285

    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 已提交
8286
        ret = false;
8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307
    }

    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 已提交
8308
static bool
8309 8310 8311
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
8312
    bool ret = true;
8313 8314
    char *dump;

8315
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8316
        return false;
8317 8318

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
8319
        return false;
8320 8321 8322

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
8323
        vshPrint(ctl, "%s", dump);
8324 8325
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
8326
        ret = false;
8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345
    }

    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 已提交
8346
static bool
8347 8348 8349 8350 8351 8352
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

8353
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8354
        return false;
8355 8356 8357 8358

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
8359
        return false;
8360 8361 8362 8363 8364 8365 8366 8367
    }

    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 已提交
8368
        return false;
8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395
    }

    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 已提交
8396
    return true;
8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413
}


/*
 * "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 已提交
8414
static bool
8415 8416
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
8417
    bool ret = false;
8418 8419 8420 8421 8422 8423
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

8424
    if (!vshConnectionUsability(ctl, ctl->conn))
8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450
        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 已提交
8451
        ret = true;
8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477
        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 已提交
8478
    ret = true;
8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496

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


8497
/**************************************************************************/
8498
/*
8499
 * "pool-autostart" command
8500
 */
8501
static const vshCmdInfo info_pool_autostart[] = {
8502
    {"help", N_("autostart a pool")},
8503
    {"desc",
8504
     N_("Configure a pool to be automatically started at boot.")},
8505
    {NULL, NULL}
8506 8507
};

8508
static const vshCmdOptDef opts_pool_autostart[] = {
8509 8510
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
8511 8512
    {NULL, 0, 0, NULL}
};
8513

E
Eric Blake 已提交
8514
static bool
8515
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
8516
{
8517
    virStoragePoolPtr pool;
8518
    const char *name;
8519
    int autostart;
8520

8521
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8522
        return false;
8523

8524
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8525
        return false;
8526

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

8529 8530
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
8531
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
8532
        else
8533
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
8534
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8535
        return false;
8536 8537
    }

8538
    if (autostart)
8539
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
8540
    else
8541
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
8542

L
Laine Stump 已提交
8543
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8544
    return true;
8545 8546
}

8547
/*
8548
 * "pool-create" command
8549
 */
8550
static const vshCmdInfo info_pool_create[] = {
8551 8552
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
8553 8554 8555
    {NULL, NULL}
};

8556
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
8557
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
8558
     N_("file containing an XML pool description")},
8559 8560 8561
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8562
static bool
8563
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
8564
{
8565
    virStoragePoolPtr pool;
8566
    const char *from = NULL;
E
Eric Blake 已提交
8567
    bool ret = true;
8568
    char *buffer;
8569

8570
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8571
        return false;
8572

8573
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8574
        return false;
8575

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

8579
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
8580
    VIR_FREE(buffer);
8581 8582 8583 8584

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
8585
        virStoragePoolFree(pool);
8586
    } else {
8587
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
8588
        ret = false;
8589 8590
    }
    return ret;
8591 8592
}

8593

8594 8595 8596 8597
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
8598
    {"help", N_("create a device defined "
8599
                          "by an XML file on the node")},
8600
    {"desc", N_("Create a device on the node.  Note that this "
8601 8602 8603 8604 8605 8606 8607
                          "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,
8608
     N_("file containing an XML description of the device")},
8609 8610 8611
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8612
static bool
8613 8614 8615
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
8616
    const char *from = NULL;
E
Eric Blake 已提交
8617
    bool ret = true;
8618 8619
    char *buffer;

8620
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8621
        return false;
8622

8623
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8624
        return false;
8625

8626
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
8627
        return false;
8628 8629

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
8630
    VIR_FREE(buffer);
8631 8632 8633 8634

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
8635
        virNodeDeviceFree(dev);
8636
    } else {
8637
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
8638
        ret = false;
8639 8640 8641 8642 8643 8644 8645 8646 8647 8648
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
8649
    {"help", N_("destroy (stop) a device on the node")},
8650
    {"desc", N_("Destroy a device on the node.  Note that this "
8651
                "command destroys devices on the physical host")},
8652 8653 8654 8655 8656
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
8657
     N_("name of the device to be destroyed")},
8658 8659 8660
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8661
static bool
8662 8663 8664
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
8665
    bool ret = true;
8666
    const char *name = NULL;
8667

8668
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
8669
        return false;
8670 8671
    }

8672
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
8673
        return false;
8674 8675 8676 8677 8678 8679

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
8680
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
8681
        ret = false;
8682 8683 8684 8685 8686 8687 8688
    }

    virNodeDeviceFree(dev);
    return ret;
}


8689
/*
8690
 * XML Building helper for pool-define-as and pool-create-as
8691
 */
8692
static const vshCmdOptDef opts_pool_X_as[] = {
8693 8694 8695 8696 8697 8698 8699 8700
    {"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")},
8701
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
8702 8703 8704
    {NULL, 0, 0, NULL}
};

8705
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
8706

8707 8708
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
8709
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8710

8711
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8712
        goto cleanup;
8713
    if (vshCommandOptString(cmd, "type", &type) <= 0)
8714 8715
        goto cleanup;

8716 8717 8718 8719 8720
    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 ||
8721 8722
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
8723
        goto cleanup;
8724
    }
8725

8726 8727
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
8728
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
8729
        virBufferAddLit(&buf, "  <source>\n");
8730

8731
        if (srcHost)
8732
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
8733
        if (srcPath)
8734
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
8735
        if (srcDev)
8736
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
8737
        if (srcFormat)
8738
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
8739
        if (srcName)
8740
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
8741 8742

        virBufferAddLit(&buf, "  </source>\n");
8743 8744
    }
    if (target) {
8745
        virBufferAddLit(&buf, "  <target>\n");
8746
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
8747
        virBufferAddLit(&buf, "  </target>\n");
8748
    }
8749 8750 8751 8752
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
8753
        return false;
8754
    }
8755 8756 8757

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
8758
    return true;
8759 8760

cleanup:
8761
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
8762
    return false;
8763 8764 8765 8766 8767 8768
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
8769 8770
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
8771 8772 8773
    {NULL, NULL}
};

E
Eric Blake 已提交
8774
static bool
8775 8776 8777
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
8778 8779
    const char *name;
    char *xml;
8780
    int printXML = vshCommandOptBool(cmd, "print-xml");
8781

8782
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8783
        return false;
8784 8785

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

8788
    if (printXML) {
8789
        vshPrint(ctl, "%s", xml);
8790
        VIR_FREE(xml);
8791
    } else {
8792
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
8793
        VIR_FREE(xml);
8794

8795 8796 8797 8798
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
8799
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
8800
            return false;
8801 8802
        }
    }
E
Eric Blake 已提交
8803
    return true;
8804 8805
}

8806

8807
/*
8808
 * "pool-define" command
8809
 */
8810
static const vshCmdInfo info_pool_define[] = {
8811 8812
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
8813 8814 8815
    {NULL, NULL}
};

8816
static const vshCmdOptDef opts_pool_define[] = {
8817
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
8818 8819 8820
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8821
static bool
8822
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
8823
{
8824
    virStoragePoolPtr pool;
8825
    const char *from = NULL;
E
Eric Blake 已提交
8826
    bool ret = true;
8827
    char *buffer;
8828

8829
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8830
        return false;
8831

8832
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8833
        return false;
8834

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

8838
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
8839
    VIR_FREE(buffer);
8840 8841 8842 8843

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
8844
        virStoragePoolFree(pool);
8845
    } else {
8846
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
8847
        ret = false;
8848 8849
    }
    return ret;
8850 8851
}

8852

8853 8854 8855
/*
 * "pool-define-as" command
 */
8856
static const vshCmdInfo info_pool_define_as[] = {
8857 8858
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
8859 8860 8861
    {NULL, NULL}
};

E
Eric Blake 已提交
8862
static bool
8863
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
8864 8865
{
    virStoragePoolPtr pool;
8866 8867
    const char *name;
    char *xml;
8868
    int printXML = vshCommandOptBool(cmd, "print-xml");
8869

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

8873
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
8874
        return false;
8875

8876
    if (printXML) {
8877
        vshPrint(ctl, "%s", xml);
8878
        VIR_FREE(xml);
8879
    } else {
8880
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
8881
        VIR_FREE(xml);
8882

8883 8884 8885 8886
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
8887
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
8888
            return false;
8889 8890
        }
    }
E
Eric Blake 已提交
8891
    return true;
8892 8893 8894
}


8895
/*
8896
 * "pool-build" command
8897
 */
8898
static const vshCmdInfo info_pool_build[] = {
8899 8900
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
8901 8902 8903
    {NULL, NULL}
};

8904
static const vshCmdOptDef opts_pool_build[] = {
8905
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8906 8907
    {"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")},
8908 8909 8910
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8911
static bool
8912
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
8913
{
8914
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8915
    bool ret = true;
8916
    const char *name;
8917
    unsigned int flags = 0;
8918

8919
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8920
        return false;
8921

8922
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8923
        return false;
8924

8925 8926 8927 8928 8929 8930 8931 8932 8933
    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) {
8934
        vshPrint(ctl, _("Pool %s built\n"), name);
8935
    } else {
8936
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
8937
        ret = false;
8938 8939
    }

8940 8941
    virStoragePoolFree(pool);

8942 8943 8944
    return ret;
}

8945
/*
8946
 * "pool-destroy" command
8947
 */
8948
static const vshCmdInfo info_pool_destroy[] = {
8949 8950 8951
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
8952 8953 8954
    {NULL, NULL}
};

8955
static const vshCmdOptDef opts_pool_destroy[] = {
8956
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8957 8958 8959
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8960
static bool
8961
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
8962
{
8963
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8964
    bool ret = true;
8965
    const char *name;
8966

8967
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8968
        return false;
8969

8970
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8971
        return false;
8972

8973 8974 8975
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
8976
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
8977
        ret = false;
8978 8979
    }

8980
    virStoragePoolFree(pool);
8981 8982 8983
    return ret;
}

8984

8985
/*
8986 8987
 * "pool-delete" command
 */
8988
static const vshCmdInfo info_pool_delete[] = {
8989 8990
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
8991 8992 8993
    {NULL, NULL}
};

8994
static const vshCmdOptDef opts_pool_delete[] = {
8995
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8996 8997 8998
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8999
static bool
9000
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
9001 9002
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
9003
    bool ret = true;
9004
    const char *name;
9005

9006
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9007
        return false;
9008 9009

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
9010
        return false;
9011 9012

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
9013
        vshPrint(ctl, _("Pool %s deleted\n"), name);
9014
    } else {
9015
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
9016
        ret = false;
9017 9018
    }

L
Laine Stump 已提交
9019
    virStoragePoolFree(pool);
9020 9021 9022 9023 9024 9025 9026
    return ret;
}


/*
 * "pool-refresh" command
 */
9027
static const vshCmdInfo info_pool_refresh[] = {
9028 9029
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
9030 9031 9032
    {NULL, NULL}
};

9033
static const vshCmdOptDef opts_pool_refresh[] = {
9034
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9035 9036 9037
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9038
static bool
9039
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
9040 9041
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
9042
    bool ret = true;
9043
    const char *name;
9044

9045
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9046
        return false;
9047 9048

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
9049
        return false;
9050 9051 9052 9053

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
9054
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
9055
        ret = false;
9056 9057 9058 9059 9060 9061 9062 9063 9064 9065
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
9066
static const vshCmdInfo info_pool_dumpxml[] = {
9067 9068
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
9069 9070 9071
    {NULL, NULL}
};

9072
static const vshCmdOptDef opts_pool_dumpxml[] = {
9073
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9074 9075 9076
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9077
static bool
9078
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
9079 9080
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
9081
    bool ret = true;
9082 9083
    char *dump;

9084
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9085
        return false;
9086 9087

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
9088
        return false;
9089 9090 9091

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
9092
        vshPrint(ctl, "%s", dump);
9093
        VIR_FREE(dump);
9094
    } else {
E
Eric Blake 已提交
9095
        ret = false;
9096 9097 9098 9099 9100 9101 9102 9103 9104 9105
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
9106
static const vshCmdInfo info_pool_list[] = {
9107 9108
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
9109 9110 9111
    {NULL, NULL}
};

9112
static const vshCmdOptDef opts_pool_list[] = {
9113 9114
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
9115
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
9116 9117 9118
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9119
static bool
9120
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9121
{
9122 9123
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
9124 9125
    int i, ret;
    bool functionReturn;
9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141
    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 */
9142
    int all = vshCommandOptBool(cmd, "all");
9143 9144
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
9145 9146 9147
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

9148
    /* Check the connection to libvirtd daemon is still working */
9149
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9150
        return false;
9151

9152
    /* Retrieve the number of active storage pools */
9153
    if (active) {
9154 9155
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
9156
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
9157
            return false;
9158 9159
        }
    }
9160 9161

    /* Retrieve the number of inactive storage pools */
9162
    if (inactive) {
9163 9164
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
9165
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
9166
            return false;
9167
        }
9168
    }
9169

9170 9171
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
9172

9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184
    /* 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 已提交
9185
            return false;
9186 9187 9188
        }
    }

9189 9190 9191 9192 9193 9194 9195 9196
    /* 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 已提交
9197
            return false;
9198 9199
        }
    }
9200

9201 9202 9203 9204 9205 9206 9207 9208 9209 9210
    /* 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]);
9211
        if (!pool) {
9212
            VIR_FREE(poolNames[i]);
9213 9214 9215
            continue;
        }

9216
        /* Retrieve the autostart status of the pool */
9217
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
9218
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
9219
        else
9220 9221 9222 9223 9224 9225
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
9226 9227
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238
            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;
        }
9239

9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351
        /* 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 */
9352 9353 9354
        virStoragePoolFree(pool);
    }

9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372
    /* 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);
9373 9374
        }

9375
        /* Cleanup and return */
E
Eric Blake 已提交
9376
        functionReturn = true;
9377 9378
        goto cleanup;
    }
9379

9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417
    /* 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. */
9418
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
9419
             (unsigned long) nameStrLength);
9420
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
9421
             (unsigned long) stateStrLength);
9422
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
9423
             (unsigned long) autostartStrLength);
9424
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
9425
             (unsigned long) persistStrLength);
9426
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
9427
             (unsigned long) capStrLength);
9428
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
9429
             (unsigned long) allocStrLength);
9430
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 9466 9467 9468 9469 9470 9471 9472 9473
             (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 已提交
9474
    functionReturn = true;
9475 9476 9477 9478 9479 9480 9481 9482 9483 9484 9485 9486 9487 9488
    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 已提交
9489
    functionReturn = false;
9490

9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502
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]);
9503
    }
9504 9505 9506 9507 9508 9509 9510

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

    /* Return the desired value */
    return functionReturn;
9511 9512
}

9513 9514 9515 9516
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
9517 9518
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
9519 9520 9521 9522 9523
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
9524 9525 9526
     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")},
9527
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
9528 9529 9530
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9531
static bool
9532 9533
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
9534
    const char *type = NULL, *host = NULL;
9535 9536
    char *srcSpec = NULL;
    char *srcList;
9537
    const char *initiator = NULL;
9538

9539 9540
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
9541 9542
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
9543
        return false;
9544
    }
9545

9546
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9547
        return false;
9548 9549

    if (host) {
9550
        const char *port = NULL;
9551
        virBuffer buf = VIR_BUFFER_INITIALIZER;
9552 9553 9554 9555

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
9556
            return false;
9557
        }
9558
        virBufferAddLit(&buf, "<source>\n");
9559
        virBufferAsprintf(&buf, "  <host name='%s'", host);
9560
        if (port)
9561
            virBufferAsprintf(&buf, " port='%s'", port);
9562
        virBufferAddLit(&buf, "/>\n");
9563 9564
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
9565
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
9566 9567
            virBufferAddLit(&buf, "  </initiator>\n");
        }
9568 9569 9570
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
9571
            return false;
9572
        }
9573
        srcSpec = virBufferContentAndReset(&buf);
9574 9575 9576
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
9577
    VIR_FREE(srcSpec);
9578
    if (srcList == NULL) {
9579
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
9580
        return false;
9581 9582
    }
    vshPrint(ctl, "%s", srcList);
9583
    VIR_FREE(srcList);
9584

E
Eric Blake 已提交
9585
    return true;
9586 9587 9588 9589 9590 9591 9592
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
9593 9594
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
9595 9596 9597 9598 9599
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
9600
     N_("type of storage pool sources to discover")},
9601
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
9602
     N_("optional file of source xml to query for pools")},
9603 9604 9605
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9606
static bool
9607 9608
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
9609
    const char *type = NULL, *srcSpecFile = NULL;
9610
    char *srcSpec = NULL, *srcList;
9611

9612
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
9613
        return false;
9614

9615 9616
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
9617
        return false;
9618
    }
9619

9620
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9621
        return false;
9622 9623

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
9624
        return false;
9625 9626

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
9627
    VIR_FREE(srcSpec);
9628
    if (srcList == NULL) {
9629
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
9630
        return false;
9631 9632
    }
    vshPrint(ctl, "%s", srcList);
9633
    VIR_FREE(srcList);
9634

E
Eric Blake 已提交
9635
    return true;
9636 9637 9638
}


9639 9640 9641
/*
 * "pool-info" command
 */
9642
static const vshCmdInfo info_pool_info[] = {
9643 9644
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
9645 9646 9647
    {NULL, NULL}
};

9648
static const vshCmdOptDef opts_pool_info[] = {
9649
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9650 9651 9652
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9653
static bool
9654
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
9655 9656 9657
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
9658 9659
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
9660
    bool ret = true;
9661 9662
    char uuid[VIR_UUID_STRING_BUFLEN];

9663
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9664
        return false;
9665 9666

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
9667
        return false;
9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693

    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;
9694 9695 9696 9697
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
9698 9699
        }

9700 9701
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
9702 9703
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
9704 9705 9706 9707 9708 9709 9710
        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);
9711 9712
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
9713 9714 9715 9716 9717
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729
        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 已提交
9730
        ret = false;
9731 9732 9733 9734 9735 9736 9737 9738 9739 9740
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
9741
static const vshCmdInfo info_pool_name[] = {
9742
    {"help", N_("convert a pool UUID to pool name")},
9743
    {"desc", ""},
9744 9745 9746
    {NULL, NULL}
};

9747
static const vshCmdOptDef opts_pool_name[] = {
9748
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
9749 9750 9751
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9752
static bool
9753
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
9754 9755 9756
{
    virStoragePoolPtr pool;

9757
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9758
        return false;
9759
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
9760
                                           VSH_BYUUID)))
E
Eric Blake 已提交
9761
        return false;
9762 9763 9764

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9765
    return true;
9766 9767 9768 9769 9770 9771
}


/*
 * "pool-start" command
 */
9772
static const vshCmdInfo info_pool_start[] = {
9773 9774
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
9775 9776 9777
    {NULL, NULL}
};

9778
static const vshCmdOptDef opts_pool_start[] = {
9779
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
9780 9781 9782
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9783
static bool
9784
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
9785 9786
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
9787
    bool ret = true;
9788

9789
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9790
        return false;
9791

9792
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
9793
         return false;
9794 9795 9796 9797 9798

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
9799
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
9800
        ret = false;
9801
    }
L
Laine Stump 已提交
9802 9803

    virStoragePoolFree(pool);
9804 9805 9806 9807
    return ret;
}


9808 9809 9810
/*
 * "vol-create-as" command
 */
9811
static const vshCmdInfo info_vol_create_as[] = {
9812 9813
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
9814 9815 9816
    {NULL, NULL}
};

9817
static const vshCmdOptDef opts_vol_create_as[] = {
9818 9819 9820 9821 9822
    {"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")},
9823 9824
    {"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")},
9825 9826 9827 9828 9829 9830 9831 9832 9833 9834
    {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 已提交
9835
        /* Deliberate fallthrough cases here :-) */
9836 9837 9838
        switch (*end) {
        case 'T':
            *val *= 1024;
9839
            /* fallthrough */
9840 9841
        case 'G':
            *val *= 1024;
9842
            /* fallthrough */
9843 9844
        case 'M':
            *val *= 1024;
9845
            /* fallthrough */
9846 9847 9848 9849 9850 9851 9852 9853 9854 9855 9856 9857 9858
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
9859
static bool
9860
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
9861 9862 9863
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9864
    char *xml;
9865 9866
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
9867
    unsigned long long capacity, allocation = 0;
9868
    virBuffer buf = VIR_BUFFER_INITIALIZER;
9869

9870
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9871
        return false;
9872 9873 9874

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

9877
    if (vshCommandOptString(cmd, "name", &name) <= 0)
9878 9879
        goto cleanup;

9880
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
9881 9882
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
9883
        vshError(ctl, _("Malformed size %s"), capacityStr);
9884

9885 9886
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
9887
        vshError(ctl, _("Malformed size %s"), allocationStr);
9888

9889 9890 9891 9892 9893 9894 9895
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

9896

9897
    virBufferAddLit(&buf, "<volume>\n");
9898 9899
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
9900
    if (allocationStr)
9901
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
9902 9903

    if (format) {
9904
        virBufferAddLit(&buf, "  <target>\n");
9905
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
9906
        virBufferAddLit(&buf, "  </target>\n");
9907
    }
9908

9909 9910 9911 9912
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
9913 9914
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
9915 9916 9917
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
9918 9919
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
9920 9921 9922 9923 9924
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
9925 9926
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
9927 9928 9929
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
9930 9931
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
9932 9933 9934 9935 9936
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
9937 9938
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
9939 9940 9941
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
9942 9943
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
9944 9945 9946 9947
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
9948
            goto cleanup;
9949 9950 9951 9952 9953
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
9954
            goto cleanup;
9955 9956 9957 9958
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
9959
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
9960
        if (snapshotStrFormat)
9961
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
9962 9963 9964 9965 9966 9967 9968 9969
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

9971 9972
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
9973
        goto cleanup;
9974 9975 9976
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
9977
    VIR_FREE(xml);
9978 9979 9980 9981 9982
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
9983
        return true;
9984
    } else {
9985
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
9986
        return false;
9987 9988 9989
    }

 cleanup:
9990
    virBufferFreeAndReset(&buf);
9991
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9992
    return false;
9993 9994 9995
}


9996 9997 9998
/*
 * "pool-undefine" command
 */
9999
static const vshCmdInfo info_pool_undefine[] = {
10000 10001
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
10002 10003 10004
    {NULL, NULL}
};

10005
static const vshCmdOptDef opts_pool_undefine[] = {
10006
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10007 10008 10009
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10010
static bool
10011
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
10012 10013
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
10014
    bool ret = true;
10015
    const char *name;
10016

10017
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10018
        return false;
10019 10020

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
10021
        return false;
10022 10023 10024 10025

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

L
Laine Stump 已提交
10030
    virStoragePoolFree(pool);
10031 10032 10033 10034 10035 10036 10037
    return ret;
}


/*
 * "pool-uuid" command
 */
10038
static const vshCmdInfo info_pool_uuid[] = {
10039
    {"help", N_("convert a pool name to pool UUID")},
10040
    {"desc", ""},
10041 10042 10043
    {NULL, NULL}
};

10044
static const vshCmdOptDef opts_pool_uuid[] = {
10045
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
10046 10047 10048
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10049
static bool
10050
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
10051 10052 10053 10054
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

10055
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10056
        return false;
10057 10058

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
10059
                                           VSH_BYNAME)))
E
Eric Blake 已提交
10060
        return false;
10061 10062 10063 10064

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

L
Laine Stump 已提交
10067
    virStoragePoolFree(pool);
E
Eric Blake 已提交
10068
    return true;
10069 10070 10071 10072 10073 10074
}


/*
 * "vol-create" command
 */
10075
static const vshCmdInfo info_vol_create[] = {
10076 10077
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
10078 10079 10080
    {NULL, NULL}
};

10081
static const vshCmdOptDef opts_vol_create[] = {
10082 10083
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
10084 10085 10086
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10087
static bool
10088
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
10089 10090 10091
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
10092
    const char *from = NULL;
E
Eric Blake 已提交
10093
    bool ret = true;
10094 10095
    char *buffer;

10096
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10097
        return false;
10098 10099

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

10103
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10104
        virStoragePoolFree(pool);
E
Eric Blake 已提交
10105
        return false;
10106 10107 10108
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10109
        virshReportError(ctl);
10110
        virStoragePoolFree(pool);
E
Eric Blake 已提交
10111
        return false;
10112 10113 10114
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
10115
    VIR_FREE(buffer);
10116 10117 10118 10119 10120 10121 10122
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
10123
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
10124
        ret = false;
10125 10126 10127 10128
    }
    return ret;
}

10129 10130 10131 10132
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
10133 10134
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
10135 10136 10137 10138
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
10139 10140 10141
    {"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 已提交
10142
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
10143 10144 10145
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10146
static bool
10147 10148 10149 10150
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
10151
    const char *from = NULL;
E
Eric Blake 已提交
10152
    bool ret = false;
10153 10154
    char *buffer = NULL;

10155
    if (!vshConnectionUsability(ctl, ctl->conn))
10156 10157 10158 10159 10160
        goto cleanup;

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

10161
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
10162 10163 10164 10165 10166 10167 10168
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
10169
        virshReportError(ctl);
10170 10171 10172 10173 10174 10175 10176 10177 10178
        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 {
10179
        vshError(ctl, _("Failed to create vol from %s"), from);
10180 10181 10182
        goto cleanup;
    }

E
Eric Blake 已提交
10183
    ret = true;
10184
cleanup:
10185
    VIR_FREE(buffer);
10186 10187 10188 10189
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
10190 10191
    if (newvol)
        virStorageVolFree(newvol);
10192 10193 10194 10195
    return ret;
}

static xmlChar *
10196 10197
makeCloneXML(const char *origxml, const char *newname)
{
10198

10199 10200 10201
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
10202 10203 10204
    xmlChar *newxml = NULL;
    int size;

10205
    doc = virXMLParseStringCtxt(origxml, _("(volume_definition)"), &ctxt);
10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227
    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[] = {
10228 10229
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
10230 10231 10232 10233
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
10234 10235
    {"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 已提交
10236
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10237 10238 10239
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10240
static bool
10241 10242 10243 10244
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
10245
    const char *name = NULL;
10246
    char *origxml = NULL;
10247
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
10248
    bool ret = false;
10249

10250
    if (!vshConnectionUsability(ctl, ctl->conn))
10251 10252 10253 10254 10255 10256 10257
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
10258
        vshError(ctl, "%s", _("failed to get parent pool"));
10259 10260 10261
        goto cleanup;
    }

10262
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280
        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 {
10281
        vshError(ctl, _("Failed to clone vol from %s"),
10282 10283 10284 10285
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
10286
    ret = true;
10287 10288

cleanup:
10289
    VIR_FREE(origxml);
10290 10291 10292
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
10293 10294
    if (newvol)
        virStorageVolFree(newvol);
10295 10296 10297 10298 10299
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312

/*
 * "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 已提交
10313
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327
    {"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 已提交
10328
static bool
10329 10330 10331 10332
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
10333
    bool ret = false;
10334 10335 10336 10337 10338 10339 10340 10341 10342 10343
    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 已提交
10344
        return false;
10345 10346 10347 10348
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
10349
        return false;
10350 10351 10352
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
10353
        return false;
10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380 10381 10382 10383 10384 10385 10386 10387
    }

    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 已提交
10388
    ret = true;
10389 10390 10391 10392 10393 10394 10395 10396 10397 10398 10399 10400 10401 10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412

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 已提交
10413
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10414 10415 10416 10417 10418
    {"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 已提交
10419
static bool
10420 10421 10422 10423
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
10424
    bool ret = false;
10425 10426 10427 10428
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
10429
    bool created = false;
10430 10431

    if (!vshConnectionUsability(ctl, ctl->conn))
10432
        return false;
10433 10434 10435

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
10436
        return false;
10437 10438 10439 10440
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
10441
        return false;
10442 10443 10444
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
10445
        return false;
10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457

    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;
        }
10458 10459
    } else {
        created = true;
10460 10461 10462 10463 10464 10465 10466 10467
    }

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

10468
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483
        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 已提交
10484
    ret = true;
10485 10486

cleanup:
10487
    VIR_FORCE_CLOSE(fd);
10488
    if (!ret && created)
10489 10490 10491 10492 10493 10494 10495 10496 10497
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


10498 10499 10500
/*
 * "vol-delete" command
 */
10501
static const vshCmdInfo info_vol_delete[] = {
10502 10503
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
10504 10505 10506
    {NULL, NULL}
};

10507
static const vshCmdOptDef opts_vol_delete[] = {
10508
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
10509
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10510 10511 10512
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10513
static bool
10514
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
10515 10516
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
10517
    bool ret = true;
10518
    const char *name;
10519

10520
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10521
        return false;
10522 10523

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
10524
        return false;
10525 10526 10527
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
10528
        vshPrint(ctl, _("Vol %s deleted\n"), name);
10529
    } else {
10530
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
10531
        ret = false;
10532 10533
    }

L
Laine Stump 已提交
10534
    virStorageVolFree(vol);
10535 10536 10537 10538
    return ret;
}


D
David Allan 已提交
10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549
/*
 * "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 已提交
10550
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
10551 10552 10553
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10554
static bool
D
David Allan 已提交
10555 10556 10557
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
10558
    bool ret = true;
10559
    const char *name;
D
David Allan 已提交
10560

10561
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10562
        return false;
D
David Allan 已提交
10563 10564

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
10565
        return false;
D
David Allan 已提交
10566 10567 10568 10569 10570 10571
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
10572
        ret = false;
D
David Allan 已提交
10573 10574 10575 10576 10577 10578 10579
    }

    virStorageVolFree(vol);
    return ret;
}


10580 10581 10582
/*
 * "vol-info" command
 */
10583
static const vshCmdInfo info_vol_info[] = {
10584 10585
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
10586 10587 10588
    {NULL, NULL}
};

10589
static const vshCmdOptDef opts_vol_info[] = {
10590
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
10591
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10592 10593 10594
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10595
static bool
10596
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
10597 10598 10599
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
10600
    bool ret = true;
10601

10602
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10603
        return false;
10604 10605

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
10606
        return false;
10607 10608 10609 10610 10611 10612

    vshPrint(ctl, "%-15s %s\n", _("Name:"), virStorageVolGetName(vol));

    if (virStorageVolGetInfo(vol, &info) == 0) {
        double val;
        const char *unit;
R
Ryota Ozaki 已提交
10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628
        switch(info.type) {
        case VIR_STORAGE_VOL_FILE:
            vshPrint(ctl, "%-15s %s\n", _("Type:"), _("file"));
            break;

        case VIR_STORAGE_VOL_BLOCK:
            vshPrint(ctl, "%-15s %s\n", _("Type:"), _("block"));
            break;

        case VIR_STORAGE_VOL_DIR:
            vshPrint(ctl, "%-15s %s\n", _("Type:"), _("dir"));
            break;

        default:
            vshPrint(ctl, "%-15s %s\n", _("Type:"), _("unknown"));
        }
10629 10630 10631 10632 10633 10634 10635

        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 已提交
10636
        ret = false;
10637 10638 10639 10640 10641 10642 10643 10644 10645 10646
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
10647
static const vshCmdInfo info_vol_dumpxml[] = {
10648 10649
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
10650 10651 10652
    {NULL, NULL}
};

10653
static const vshCmdOptDef opts_vol_dumpxml[] = {
10654
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
10655
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10656 10657 10658
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10659
static bool
10660
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
10661 10662
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
10663
    bool ret = true;
10664 10665
    char *dump;

10666
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10667
        return false;
10668 10669

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
10670
        return false;
10671 10672 10673

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
10674
        vshPrint(ctl, "%s", dump);
10675
        VIR_FREE(dump);
10676
    } else {
E
Eric Blake 已提交
10677
        ret = false;
10678 10679 10680 10681 10682 10683 10684 10685 10686 10687
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
10688
static const vshCmdInfo info_vol_list[] = {
10689 10690
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
10691 10692 10693
    {NULL, NULL}
};

10694
static const vshCmdOptDef opts_vol_list[] = {
10695
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10696
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
10697 10698 10699
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10700
static bool
10701
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10702
{
10703
    virStorageVolInfo volumeInfo;
10704 10705
    virStoragePoolPtr pool;
    char **activeNames = NULL;
10706 10707 10708 10709 10710
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
10711 10712
    int ret;
    bool functionReturn;
10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723
    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;
10724

10725
    /* Check the connection to libvirtd daemon is still working */
10726
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10727
        return false;
10728

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

10733 10734
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
10735

10736 10737 10738
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
10739
        return false;
10740 10741
    }

10742 10743 10744 10745 10746
    /* 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) {
10747
            vshError(ctl, "%s", _("Failed to list active vols"));
10748
            VIR_FREE(activeNames);
10749
            virStoragePoolFree(pool);
E
Eric Blake 已提交
10750
            return false;
10751 10752
        }

10753 10754 10755 10756 10757
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

10760 10761 10762 10763 10764
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
10765

10766 10767 10768 10769
        /* 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"));
10770 10771
        }

10772 10773 10774 10775 10776 10777 10778 10779 10780
        /* 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 */
10781

10782
                /* Volume type */
10783 10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795
                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"));
                }
10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845

                /* 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;
        }
10846

10847
        /* Cleanup memory allocation */
10848
        virStorageVolFree(vol);
10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866
    }

    /* 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 已提交
10867
        functionReturn = true;
10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 10879 10880 10881 10882 10883 10884 10885 10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898
        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 */
10899 10900 10901 10902 10903 10904 10905 10906 10907 10908
    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);
10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941 10942

    /* 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 已提交
10943
    functionReturn = true;
10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957
    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 已提交
10958
    functionReturn = false;
10959 10960 10961 10962 10963 10964 10965 10966 10967 10968

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);
10969
        VIR_FREE(activeNames[i]);
10970
    }
10971 10972 10973 10974

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
10975
    VIR_FREE(activeNames);
10976
    virStoragePoolFree(pool);
10977 10978 10979

    /* Return the desired value */
    return functionReturn;
10980 10981 10982 10983 10984 10985
}


/*
 * "vol-name" command
 */
10986
static const vshCmdInfo info_vol_name[] = {
10987
    {"help", N_("returns the volume name for a given volume key or path")},
10988
    {"desc", ""},
10989 10990 10991
    {NULL, NULL}
};

10992
static const vshCmdOptDef opts_vol_name[] = {
10993
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
10994 10995 10996
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10997
static bool
10998
cmdVolName(vshControl *ctl, const vshCmd *cmd)
10999 11000 11001
{
    virStorageVolPtr vol;

11002
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11003
        return false;
11004

11005
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
11006
                                   VSH_BYUUID)))
E
Eric Blake 已提交
11007
        return false;
11008 11009 11010

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
11011
    return true;
11012 11013 11014
}


J
Justin Clift 已提交
11015 11016 11017 11018 11019 11020 11021 11022 11023 11024
/*
 * "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[] = {
11025
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
11026 11027 11028 11029
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11030
static bool
J
Justin Clift 已提交
11031 11032 11033 11034
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
11035
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
11036 11037

    /* Check the connection to libvirtd daemon is still working */
11038
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11039
        return false;
J
Justin Clift 已提交
11040 11041

    /* Use the supplied string to locate the volume */
11042
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
11043
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
11044
        return false;
J
Justin Clift 已提交
11045 11046 11047 11048 11049 11050 11051
    }

    /* 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 已提交
11052
        return false;
J
Justin Clift 已提交
11053 11054
    }

11055 11056 11057 11058 11059 11060 11061 11062 11063
    /* 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 已提交
11064 11065 11066 11067

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
11068
    return true;
J
Justin Clift 已提交
11069 11070
}

11071 11072 11073 11074

/*
 * "vol-key" command
 */
11075
static const vshCmdInfo info_vol_key[] = {
11076
    {"help", N_("returns the volume key for a given volume name or path")},
11077
    {"desc", ""},
11078 11079 11080
    {NULL, NULL}
};

11081
static const vshCmdOptDef opts_vol_key[] = {
11082
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
11083
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
11084 11085 11086
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11087
static bool
11088
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
11089 11090 11091
{
    virStorageVolPtr vol;

11092
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11093
        return false;
11094

11095
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
11096
        return false;
11097 11098 11099

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
11100
    return true;
11101 11102 11103 11104 11105 11106 11107
}



/*
 * "vol-path" command
 */
11108
static const vshCmdInfo info_vol_path[] = {
11109
    {"help", N_("returns the volume path for a given volume name or key")},
11110
    {"desc", ""},
11111 11112 11113
    {NULL, NULL}
};

11114
static const vshCmdOptDef opts_vol_path[] = {
11115
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
11116
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
11117 11118 11119
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11120
static bool
11121
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
11122 11123
{
    virStorageVolPtr vol;
11124
    char * StorageVolPath;
11125

11126
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11127
        return false;
11128

11129
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL))) {
E
Eric Blake 已提交
11130
        return false;
11131
    }
11132

11133 11134 11135 11136 11137 11138 11139
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
11140
    virStorageVolFree(vol);
E
Eric Blake 已提交
11141
    return true;
11142 11143 11144
}


11145 11146 11147 11148
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
11149 11150
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
11151 11152
    {NULL, NULL}
};
11153

11154
static const vshCmdOptDef opts_secret_define[] = {
11155
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
11156 11157
    {NULL, 0, 0, NULL}
};
11158

E
Eric Blake 已提交
11159
static bool
11160 11161
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
11162
    const char *from = NULL;
11163
    char *buffer;
11164
    virSecretPtr res;
11165
    char uuid[VIR_UUID_STRING_BUFLEN];
11166

11167
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11168
        return false;
11169

11170
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
11171
        return false;
11172 11173

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
11177
    VIR_FREE(buffer);
11178 11179

    if (res == NULL) {
11180
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
11181
        return false;
11182
    }
11183
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
11184
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
11185
        virSecretFree(res);
E
Eric Blake 已提交
11186
        return false;
11187 11188 11189
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
11190
    return true;
11191 11192 11193 11194 11195 11196
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
11197 11198
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
11199 11200 11201 11202
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
11203
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
11204 11205 11206
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11207
static bool
11208 11209 11210
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
11211
    bool ret = false;
11212 11213
    char *xml;

11214
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11215
        return false;
11216 11217 11218

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
11219
        return false;
11220 11221 11222 11223

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
11224
    vshPrint(ctl, "%s", xml);
11225
    VIR_FREE(xml);
E
Eric Blake 已提交
11226
    ret = true;
11227 11228 11229 11230 11231 11232 11233 11234 11235 11236

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
11237 11238
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
11239 11240 11241 11242
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
11243 11244
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
11245 11246 11247
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11248
static bool
11249 11250 11251 11252
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
11253
    const char *base64 = NULL;
11254
    char *value;
E
Eric Blake 已提交
11255 11256
    int res;
    bool ret = false;
11257

11258
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11259
        return false;
11260 11261 11262

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

11265
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
11266 11267 11268
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
11269
        vshError(ctl, "%s", _("Invalid base64 data"));
11270 11271 11272
        goto cleanup;
    }
    if (value == NULL) {
11273
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
11274
        return false;
11275 11276 11277 11278
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
11279
    VIR_FREE(value);
11280 11281

    if (res != 0) {
11282
        vshError(ctl, "%s", _("Failed to set secret value"));
11283 11284 11285
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
11286
    ret = true;
11287 11288 11289 11290 11291 11292 11293 11294 11295 11296

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
11297 11298
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
11299 11300 11301 11302
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
11303
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
11304 11305 11306
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11307
static bool
11308 11309 11310 11311 11312 11313
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
11314
    bool ret = false;
11315

11316
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11317
        return false;
11318 11319 11320

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
11321
        return false;
11322 11323 11324 11325 11326 11327 11328

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
11329
    VIR_FREE(value);
11330 11331

    if (base64 == NULL) {
11332
        vshError(ctl, "%s", _("Failed to allocate memory"));
11333 11334
        goto cleanup;
    }
11335
    vshPrint(ctl, "%s", base64);
11336
    memset(base64, 0, strlen(base64));
11337
    VIR_FREE(base64);
E
Eric Blake 已提交
11338
    ret = true;
11339 11340 11341 11342 11343 11344 11345 11346 11347 11348

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
11349 11350
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
11351 11352 11353 11354
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
11355
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
11356 11357 11358
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11359
static bool
11360 11361 11362
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
11363
    bool ret = false;
11364
    const char *uuid;
11365

11366
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11367
        return false;
11368 11369 11370

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
11371
        return false;
11372 11373

    if (virSecretUndefine(secret) < 0) {
11374
        vshError(ctl, _("Failed to delete secret %s"), uuid);
11375 11376 11377
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
11378
    ret = true;
11379 11380 11381 11382 11383 11384 11385 11386 11387 11388

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
11389 11390
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
11391 11392 11393
    {NULL, NULL}
};

E
Eric Blake 已提交
11394
static bool
11395 11396 11397 11398 11399
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

11400
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11401
        return false;
11402 11403 11404

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
11405
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
11406
        return false;
11407 11408 11409 11410 11411
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
11412
        vshError(ctl, "%s", _("Failed to list secrets"));
11413
        VIR_FREE(uuids);
E
Eric Blake 已提交
11414
        return false;
11415 11416 11417 11418
    }

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

11419 11420
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
11421 11422

    for (i = 0; i < maxuuids; i++) {
11423 11424 11425 11426
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
11427
            VIR_FREE(uuids[i]);
11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445
            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);
11446
        VIR_FREE(uuids[i]);
11447
    }
11448
    VIR_FREE(uuids);
E
Eric Blake 已提交
11449
    return true;
11450
}
11451 11452 11453 11454 11455


/*
 * "version" command
 */
11456
static const vshCmdInfo info_version[] = {
11457 11458
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
11459 11460 11461
    {NULL, NULL}
};

11462 11463 11464 11465
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
11466

E
Eric Blake 已提交
11467
static bool
11468
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11469 11470 11471 11472 11473 11474
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
11475
    unsigned long daemonVersion;
11476 11477 11478 11479 11480
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

11481
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11482
        return false;
11483 11484 11485

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
11486
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
11487
        return false;
11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499
    }

    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) {
11500
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
11501
        return false;
11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518
    }
    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) {
11519
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
11520
        return false;
11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533
    }
    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);
    }
11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548

    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 已提交
11549
    return true;
11550 11551
}

11552 11553 11554 11555
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
11556
    {"help", N_("enumerate devices on this host")},
11557
    {"desc", ""},
11558 11559 11560 11561
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
11562 11563
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
11564 11565 11566
    {NULL, 0, 0, NULL}
};

11567 11568 11569 11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 11583 11584 11585 11586 11587 11588
#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] = '-';
11589 11590
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
11591 11592 11593
    }

    /* Print this device */
11594
    vshPrint(ctl, "%s", indentBuf);
11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616 11617
    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) {
11618
        vshPrint(ctl, "%s", indentBuf);
11619
        vshPrint(ctl, " |\n");
11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641
    }

    /* 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) {
11642
        vshPrint(ctl, "%s", indentBuf);
11643 11644 11645 11646
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
11647
static bool
11648 11649
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
11650
    const char *cap = NULL;
11651
    char **devices;
11652
    int num_devices, i;
11653
    int tree = vshCommandOptBool(cmd, "tree");
11654

11655
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11656
        return false;
11657

11658
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
11659 11660 11661 11662
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
11663
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
11664
        return false;
11665
    } else if (num_devices == 0) {
E
Eric Blake 已提交
11666
        return true;
11667 11668 11669 11670 11671 11672
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
11673
        vshError(ctl, "%s", _("Failed to list node devices"));
11674
        VIR_FREE(devices);
E
Eric Blake 已提交
11675
        return false;
11676
    }
11677
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
11678 11679 11680 11681 11682 11683 11684
    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 已提交
11685
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704
            } 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++) {
11705 11706
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
11707
        }
11708
        VIR_FREE(parents);
11709 11710 11711
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
11712
            VIR_FREE(devices[i]);
11713
        }
11714
    }
11715
    VIR_FREE(devices);
E
Eric Blake 已提交
11716
    return true;
11717 11718 11719 11720 11721 11722
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
11723 11724
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
11725 11726 11727 11728 11729
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
11730
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
11731 11732 11733
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11734
static bool
11735 11736
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
11737
    const char *name = NULL;
11738
    virNodeDevicePtr device;
L
Laine Stump 已提交
11739
    char *xml;
11740

11741
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11742
        return false;
11743
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
11744
        return false;
11745
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
11746
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
11747
        return false;
11748 11749
    }

L
Laine Stump 已提交
11750 11751 11752
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
11753
        return false;
L
Laine Stump 已提交
11754 11755 11756
    }

    vshPrint(ctl, "%s\n", xml);
11757
    VIR_FREE(xml);
11758
    virNodeDeviceFree(device);
E
Eric Blake 已提交
11759
    return true;
11760 11761
}

11762 11763 11764 11765
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
11766 11767
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
11768 11769 11770 11771 11772
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
11773
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
11774 11775 11776
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11777
static bool
11778 11779
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
11780
    const char *name = NULL;
11781
    virNodeDevicePtr device;
E
Eric Blake 已提交
11782
    bool ret = true;
11783

11784
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11785
        return false;
11786
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
11787
        return false;
11788
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
11789
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
11790
        return false;
11791 11792 11793 11794 11795
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
11796
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
11797
        ret = false;
11798 11799 11800 11801 11802 11803 11804 11805 11806
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
11807 11808
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
11809 11810 11811 11812 11813
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
11814
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
11815 11816 11817
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11818
static bool
11819 11820
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
11821
    const char *name = NULL;
11822
    virNodeDevicePtr device;
E
Eric Blake 已提交
11823
    bool ret = true;
11824

11825
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11826
        return false;
11827
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
11828
        return false;
11829
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
11830
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
11831
        return false;
11832 11833 11834 11835 11836
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
11837
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
11838
        ret = false;
11839 11840 11841 11842 11843 11844 11845 11846 11847
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
11848 11849
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
11850 11851 11852 11853 11854
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
11855
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
11856 11857 11858
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11859
static bool
11860 11861
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
11862
    const char *name = NULL;
11863
    virNodeDevicePtr device;
E
Eric Blake 已提交
11864
    bool ret = true;
11865

11866
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11867
        return false;
11868
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
11869
        return false;
11870
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
11871
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
11872
        return false;
11873 11874 11875 11876 11877
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
11878
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
11879
        ret = false;
11880 11881 11882 11883 11884
    }
    virNodeDeviceFree(device);
    return ret;
}

11885
/*
E
Eric Blake 已提交
11886
 * "hostname" command
11887
 */
11888
static const vshCmdInfo info_hostname[] = {
11889
    {"help", N_("print the hypervisor hostname")},
11890
    {"desc", ""},
11891 11892 11893
    {NULL, NULL}
};

E
Eric Blake 已提交
11894
static bool
11895
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11896 11897 11898
{
    char *hostname;

11899
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11900
        return false;
11901 11902 11903

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
11904
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
11905
        return false;
11906 11907 11908
    }

    vshPrint (ctl, "%s\n", hostname);
11909
    VIR_FREE(hostname);
11910

E
Eric Blake 已提交
11911
    return true;
11912 11913 11914 11915 11916
}

/*
 * "uri" command
 */
11917
static const vshCmdInfo info_uri[] = {
11918
    {"help", N_("print the hypervisor canonical URI")},
11919
    {"desc", ""},
11920 11921 11922
    {NULL, NULL}
};

E
Eric Blake 已提交
11923
static bool
11924
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11925 11926 11927
{
    char *uri;

11928
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11929
        return false;
11930 11931 11932

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
11933
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
11934
        return false;
11935 11936 11937
    }

    vshPrint (ctl, "%s\n", uri);
11938
    VIR_FREE(uri);
11939

E
Eric Blake 已提交
11940
    return true;
11941 11942
}

E
Eric Blake 已提交
11943 11944 11945 11946 11947 11948 11949 11950 11951 11952
/*
 * "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 已提交
11953
static bool
E
Eric Blake 已提交
11954 11955 11956 11957 11958
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11959
        return false;
E
Eric Blake 已提交
11960 11961 11962 11963

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
11964
        return false;
E
Eric Blake 已提交
11965 11966 11967 11968 11969
    }

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

E
Eric Blake 已提交
11970
    return true;
E
Eric Blake 已提交
11971 11972
}

11973 11974 11975
/*
 * "vncdisplay" command
 */
11976
static const vshCmdInfo info_vncdisplay[] = {
11977 11978
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
11979 11980 11981
    {NULL, NULL}
};

11982
static const vshCmdOptDef opts_vncdisplay[] = {
11983
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11984 11985 11986
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11987
static bool
11988
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
11989 11990 11991 11992 11993
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
11994
    bool ret = false;
11995 11996 11997
    int port = 0;
    char *doc;

11998
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11999
        return false;
12000

J
Jim Meyering 已提交
12001
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
12002
        return false;
12003 12004 12005 12006 12007

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

12008
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
12009
    VIR_FREE(doc);
12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024
    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) ||
12025
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
12026 12027 12028 12029 12030 12031
        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 已提交
12032
    ret = true;
12033 12034 12035 12036

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
12037
    xmlFreeDoc(xml);
12038 12039 12040 12041 12042 12043 12044
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
12045
static const vshCmdInfo info_ttyconsole[] = {
12046 12047
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
12048 12049 12050
    {NULL, NULL}
};

12051
static const vshCmdOptDef opts_ttyconsole[] = {
12052
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12053 12054 12055
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12056
static bool
12057
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
12058 12059 12060 12061 12062
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
12063
    bool ret = false;
12064 12065
    char *doc;

12066
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12067
        return false;
12068

J
Jim Meyering 已提交
12069
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
12070
        return false;
12071 12072 12073 12074 12075

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

12076
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
12077
    VIR_FREE(doc);
12078 12079 12080 12081 12082 12083 12084 12085 12086
    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 已提交
12087
    ret = true;
12088 12089 12090 12091

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
12092
    xmlFreeDoc(xml);
12093 12094 12095 12096 12097 12098
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
12099
 */
12100
static const vshCmdInfo info_attach_device[] = {
12101 12102
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
12103 12104 12105
    {NULL, NULL}
};

12106
static const vshCmdOptDef opts_attach_device[] = {
12107 12108 12109
    {"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")},
12110 12111 12112
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12113
static bool
12114
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
12115 12116
{
    virDomainPtr dom;
12117
    const char *from = NULL;
12118
    char *buffer;
W
Wen Congyang 已提交
12119
    int ret;
J
Jim Fehlig 已提交
12120
    unsigned int flags;
12121

12122
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12123
        return false;
12124

J
Jim Meyering 已提交
12125
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
12126
        return false;
12127

12128
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
12129
        virDomainFree(dom);
E
Eric Blake 已提交
12130
        return false;
12131 12132
    }

12133
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
12134
        virshReportError(ctl);
12135
        virDomainFree(dom);
E
Eric Blake 已提交
12136
        return false;
12137
    }
12138

J
Jim Fehlig 已提交
12139
    if (vshCommandOptBool(cmd, "persistent")) {
12140
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
12141
        if (virDomainIsActive(dom) == 1)
12142
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
12143 12144 12145 12146
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
12147
    VIR_FREE(buffer);
12148 12149

    if (ret < 0) {
12150
        vshError(ctl, _("Failed to attach device from %s"), from);
12151
        virDomainFree(dom);
E
Eric Blake 已提交
12152
        return false;
12153
    } else {
J
Jim Meyering 已提交
12154
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
12155 12156 12157
    }

    virDomainFree(dom);
E
Eric Blake 已提交
12158
    return true;
12159 12160
}

12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176
/**
 * Check if n1 is superset of n2, meaning n1 contains all elements and
 * attributes as n2 at least. Including children.
 * @n1 first node
 * @n2 second node
 * returns true in case n1 covers n2, false otherwise.
 */
static bool
vshNodeIsSuperset(xmlNodePtr n1, xmlNodePtr n2)
{
    xmlNodePtr child1, child2;
    xmlAttrPtr attr;
    char *prop1, *prop2;
    bool found;
    bool visited;
    bool ret = false;
E
Eric Blake 已提交
12177
    long n1_child_size, n2_child_size, n1_iter;
12178 12179 12180 12181 12182 12183 12184 12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205
    virBitmapPtr bitmap;

    if (!n1 && !n2)
        return true;

    if (!n1 || !n2)
        return false;

    if (!xmlStrEqual(n1->name, n2->name))
        return false;

    /* Iterate over n2 attributes and check if n1 contains them*/
    attr = n2->properties;
    while (attr) {
        if (attr->type == XML_ATTRIBUTE_NODE) {
            prop1 = virXMLPropString(n1, (const char *) attr->name);
            prop2 = virXMLPropString(n2, (const char *) attr->name);
            if (STRNEQ_NULLABLE(prop1, prop2)) {
                xmlFree(prop1);
                xmlFree(prop2);
                return false;
            }
            xmlFree(prop1);
            xmlFree(prop2);
        }
        attr = attr->next;
    }

E
Eric Blake 已提交
12206 12207 12208 12209
    n1_child_size = virXMLChildElementCount(n1);
    n2_child_size = virXMLChildElementCount(n2);
    if (n1_child_size < 0 || n2_child_size < 0 ||
        n1_child_size < n2_child_size)
12210 12211
        return false;

12212 12213 12214
    if (n1_child_size == 0 && n2_child_size == 0)
        return true;

12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 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 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362 12363 12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404
    if (!(bitmap = virBitmapAlloc(n1_child_size))) {
        virReportOOMError();
        return false;
    }

    child2 = n2->children;
    while (child2) {
        if (child2->type != XML_ELEMENT_NODE) {
            child2 = child2->next;
            continue;
        }

        child1 = n1->children;
        n1_iter = 0;
        found = false;
        while (child1) {
            if (child1->type != XML_ELEMENT_NODE) {
                child1 = child1->next;
                continue;
            }

            if (virBitmapGetBit(bitmap, n1_iter, &visited) < 0) {
                vshError(NULL, "%s", _("Bad child elements counting."));
                goto cleanup;
            }

            if (visited) {
                child1 = child1->next;
                n1_iter++;
                continue;
            }

            if (xmlStrEqual(child1->name, child2->name)) {
                found = true;
                if (virBitmapSetBit(bitmap, n1_iter) < 0) {
                    vshError(NULL, "%s", _("Bad child elements counting."));
                    goto cleanup;
                }

                if (!vshNodeIsSuperset(child1, child2))
                    goto cleanup;

                break;
            }

            child1 = child1->next;
            n1_iter++;
        }

        if (!found)
            goto cleanup;

        child2 = child2->next;
    }

    ret = true;

cleanup:
    virBitmapFree(bitmap);
    return ret;
}

/**
 * vshCompleteXMLFromDomain:
 * @ctl vshControl for error messages printing
 * @dom domain
 * @oldXML device XML before
 * @newXML and after completion
 *
 * For given domain and (probably incomplete) device XML specification try to
 * find such device in domain and complete missing parts. This is however
 * possible only when given device XML is sufficiently precise so it addresses
 * only one device.
 *
 * Returns -2 when no such device exists in domain, -3 when given XML selects many
 *          (is too ambiguous), 0 in case of success. Otherwise returns -1. @newXML
 *          is touched only in case of success.
 */
static int
vshCompleteXMLFromDomain(vshControl *ctl, virDomainPtr dom, char *oldXML,
                         char **newXML)
{
    int funcRet = -1;
    char *domXML = NULL;
    xmlDocPtr domDoc = NULL, devDoc = NULL;
    xmlNodePtr node = NULL;
    xmlXPathContextPtr domCtxt = NULL, devCtxt = NULL;
    xmlNodePtr *devices = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    int devices_size;
    char *xpath = NULL;
    xmlBufferPtr buf = NULL;
    int i = 0;
    int indx = -1;

    if (!(domXML = virDomainGetXMLDesc(dom, 0))) {
        vshError(ctl, _("couldn't get XML description of domain %s"),
                 virDomainGetName(dom));
        goto cleanup;
    }

    domDoc = virXMLParseStringCtxt(domXML, _("(domain_definition)"), &domCtxt);
    if (!domDoc) {
        vshError(ctl, _("Failed to parse domain definition xml"));
        goto cleanup;
    }

    devDoc = virXMLParseStringCtxt(oldXML, _("(device_definition)"), &devCtxt);
    if (!devDoc) {
        vshError(ctl, _("Failed to parse device definition xml"));
        goto cleanup;
    }

    node = xmlDocGetRootElement(devDoc);

    buf = xmlBufferCreate();
    if (!buf) {
        vshError(ctl, "%s", _("out of memory"));
        goto cleanup;
    }

    /* Get all possible devices */
    virAsprintf(&xpath, "/domain/devices/%s", node->name);
    if (!xpath) {
        virReportOOMError();
        goto cleanup;
    }
    devices_size = virXPathNodeSet(xpath, domCtxt, &devices);

    if (devices_size < 0) {
        /* error */
        vshError(ctl, "%s", _("error when selecting nodes"));
        goto cleanup;
    } else if (devices_size == 0) {
        /* no such device */
        funcRet = -2;
        goto cleanup;
    }

    /* and refine */
    for (i = 0; i < devices_size; i++) {
        if (vshNodeIsSuperset(devices[i], node)) {
            if (indx >= 0) {
                funcRet = -3; /* ambiguous */
                goto cleanup;
            }
            indx = i;
        }
    }

    if (indx < 0) {
        funcRet = -2; /* no such device */
        goto cleanup;
    }

    vshDebug(ctl, VSH_ERR_DEBUG, "Found device at pos %d\n", indx);

    if (newXML) {
        sctxt = xmlSaveToBuffer(buf, NULL, 0);
        if (!sctxt) {
            vshError(ctl, "%s", _("failed to create document saving context"));
            goto cleanup;
        }

        xmlSaveTree(sctxt, devices[indx]);
        xmlSaveClose(sctxt);
        *newXML = (char *) xmlBufferContent(buf);
        if (!*newXML) {
            virReportOOMError();
            goto cleanup;
        }
        buf->content = NULL;
    }

    vshDebug(ctl, VSH_ERR_DEBUG, "Old xml:\n%s\nNew xml:\n%s\n", oldXML,
             newXML ? NULLSTR(*newXML) : "(null)");

    funcRet = 0;

cleanup:
    xmlBufferFree(buf);
    VIR_FREE(devices);
    xmlXPathFreeContext(devCtxt);
    xmlXPathFreeContext(domCtxt);
    xmlFreeDoc(devDoc);
    xmlFreeDoc(domDoc);
    VIR_FREE(domXML);
    VIR_FREE(xpath);
    return funcRet;
}
12405 12406 12407 12408

/*
 * "detach-device" command
 */
12409
static const vshCmdInfo info_detach_device[] = {
12410 12411
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
12412 12413 12414
    {NULL, NULL}
};

12415
static const vshCmdOptDef opts_detach_device[] = {
12416 12417 12418
    {"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")},
12419 12420 12421
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12422
static bool
12423
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
12424
{
12425
    virDomainPtr dom = NULL;
12426
    const char *from = NULL;
12427
    char *buffer = NULL, *new_buffer = NULL;
W
Wen Congyang 已提交
12428
    int ret;
12429
    bool funcRet = false;
J
Jim Fehlig 已提交
12430
    unsigned int flags;
12431

12432
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12433
        return false;
12434

J
Jim Meyering 已提交
12435
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
12436
        return false;
12437

12438 12439
    if (vshCommandOptString(cmd, "file", &from) <= 0)
        goto cleanup;
12440

12441
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
12442
        virshReportError(ctl);
12443 12444 12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457
        goto cleanup;
    }

    ret = vshCompleteXMLFromDomain(ctl, dom, buffer, &new_buffer);
    if (ret < 0) {
        if (ret == -2) {
            vshError(ctl, _("no such device in %s"), virDomainGetName(dom));
        } else if (ret == -3) {
            vshError(ctl, "%s", _("given XML selects too many devices. "
                                  "Please, be more specific"));
        } else {
            /* vshCompleteXMLFromDomain() already printed error message,
             * so nothing to do here. */
        }
        goto cleanup;
12458
    }
12459

J
Jim Fehlig 已提交
12460
    if (vshCommandOptBool(cmd, "persistent")) {
12461
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
12462
        if (virDomainIsActive(dom) == 1)
12463
           flags |= VIR_DOMAIN_AFFECT_LIVE;
12464
        ret = virDomainDetachDeviceFlags(dom, new_buffer, flags);
J
Jim Fehlig 已提交
12465
    } else {
12466
        ret = virDomainDetachDevice(dom, new_buffer);
J
Jim Fehlig 已提交
12467
    }
12468 12469

    if (ret < 0) {
12470
        vshError(ctl, _("Failed to detach device from %s"), from);
12471
        goto cleanup;
12472 12473
    }

12474 12475 12476 12477 12478 12479
    vshPrint(ctl, "%s", _("Device detached successfully\n"));
    funcRet = true;

cleanup:
    VIR_FREE(new_buffer);
    VIR_FREE(buffer);
12480
    virDomainFree(dom);
12481
    return funcRet;
12482 12483
}

12484

12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497
/*
 * "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")},
12498
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
12499 12500 12501
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12502
static bool
12503 12504 12505
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
12506
    const char *from = NULL;
12507
    char *buffer;
W
Wen Congyang 已提交
12508
    int ret;
12509 12510
    unsigned int flags;

12511
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12512
        return false;
12513 12514

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

12517
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
12518
        virDomainFree(dom);
E
Eric Blake 已提交
12519
        return false;
12520 12521 12522
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
12523
        virshReportError(ctl);
12524
        virDomainFree(dom);
E
Eric Blake 已提交
12525
        return false;
12526 12527 12528
    }

    if (vshCommandOptBool(cmd, "persistent")) {
12529
        flags = VIR_DOMAIN_AFFECT_CONFIG;
12530
        if (virDomainIsActive(dom) == 1)
12531
           flags |= VIR_DOMAIN_AFFECT_LIVE;
12532
    } else {
12533
        flags = VIR_DOMAIN_AFFECT_LIVE;
12534
    }
12535 12536 12537 12538

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

12539 12540 12541 12542 12543 12544
    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 已提交
12545
        return false;
12546 12547 12548 12549 12550
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
12551
    return true;
12552 12553 12554
}


12555 12556 12557
/*
 * "attach-interface" command
 */
12558
static const vshCmdInfo info_attach_interface[] = {
12559 12560
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
12561 12562 12563
    {NULL, NULL}
};

12564
static const vshCmdOptDef opts_attach_interface[] = {
12565 12566 12567 12568 12569 12570
    {"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")},
12571
    {"model", VSH_OT_DATA, 0, N_("model type")},
12572
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
12573 12574
    {"inbound", VSH_OT_DATA, VSH_OFLAG_NONE, N_("control domain's incoming traffics")},
    {"outbound", VSH_OT_DATA, VSH_OFLAG_NONE, N_("control domain's outgoing traffics")},
12575 12576 12577
    {NULL, 0, 0, NULL}
};

12578 12579 12580
/* parse inbound and outbound which are in the format of
 * 'average,peak,burst', in which peak and burst are optional,
 * thus 'average,,burst' and 'average,peak' are also legal. */
12581
static int parseRateStr(const char *rateStr, virNetDevBandwidthRatePtr rate)
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
{
    const char *average = NULL;
    char *peak = NULL, *burst = NULL;

    average = rateStr;
    if (!average)
        return -1;
    if (virStrToLong_ull(average, &peak, 10, &rate->average) < 0)
        return -1;

    /* peak will be updated to point to the end of rateStr in case
     * of 'average' */
    if (peak && *peak != '\0') {
        burst = strchr(peak + 1, ',');
        if (!(burst && (burst - peak == 1))) {
            if (virStrToLong_ull(peak + 1, &burst, 10, &rate->peak) < 0)
                return -1;
        }

        /* burst will be updated to point to the end of rateStr in case
         * of 'average,peak' */
        if (burst && *burst != '\0') {
            if (virStrToLong_ull(burst + 1, NULL, 10, &rate->burst) < 0)
                return -1;
        }
    }


    return 0;
}

E
Eric Blake 已提交
12613
static bool
12614
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
12615 12616
{
    virDomainPtr dom = NULL;
12617
    const char *mac = NULL, *target = NULL, *script = NULL,
12618 12619
                *type = NULL, *source = NULL, *model = NULL,
                *inboundStr = NULL, *outboundStr = NULL;
12620
    virNetDevBandwidthRate inbound, outbound;
E
Eric Blake 已提交
12621
    int typ;
W
Wen Congyang 已提交
12622 12623
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
12624
    unsigned int flags;
12625 12626
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
12627

12628
    if (!vshConnectionUsability(ctl, ctl->conn))
12629 12630
        goto cleanup;

J
Jim Meyering 已提交
12631
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
12632 12633
        goto cleanup;

12634
    if (vshCommandOptString(cmd, "type", &type) <= 0)
12635 12636
        goto cleanup;

12637 12638 12639 12640
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
12641 12642 12643
        vshCommandOptString(cmd, "model", &model) < 0 ||
        vshCommandOptString(cmd, "inbound", &inboundStr) < 0 ||
        vshCommandOptString(cmd, "outbound", &outboundStr) < 0) {
12644
        vshError(ctl, "missing argument");
12645
        goto cleanup;
12646
    }
12647 12648

    /* check interface type */
12649
    if (STREQ(type, "network")) {
12650
        typ = 1;
12651
    } else if (STREQ(type, "bridge")) {
12652 12653
        typ = 2;
    } else {
E
Eric Blake 已提交
12654 12655
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
12656 12657 12658
        goto cleanup;
    }

12659 12660 12661 12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681
    if (inboundStr) {
        memset(&inbound, 0, sizeof(inbound));
        if (parseRateStr(inboundStr, &inbound) < 0) {
            vshError(ctl, _("inbound format is incorrect"));
            goto cleanup;
        }
        if (inbound.average == 0) {
            vshError(ctl, _("inbound average is mandatory"));
            goto cleanup;
        }
    }
    if (outboundStr) {
        memset(&outbound, 0, sizeof(outbound));
        if (parseRateStr(outboundStr, &outbound) < 0) {
            vshError(ctl, _("outbound format is incorrect"));
            goto cleanup;
        }
        if (outbound.average == 0) {
            vshError(ctl, _("outbound average is mandatory"));
            goto cleanup;
        }
    }

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

12685
    if (typ == 1)
12686
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
12687
    else if (typ == 2)
12688
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
12689

12690
    if (target != NULL)
12691
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
12692
    if (mac != NULL)
12693
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
12694
    if (script != NULL)
12695
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
12696
    if (model != NULL)
12697
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
12698

12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719
    if (inboundStr || outboundStr) {
        virBufferAsprintf(&buf, "  <bandwidth>\n");
        if (inboundStr && inbound.average > 0) {
            virBufferAsprintf(&buf, "    <inbound average='%llu'", inbound.average);
            if (inbound.peak > 0)
                virBufferAsprintf(&buf, " peak='%llu'", inbound.peak);
            if (inbound.burst > 0)
                virBufferAsprintf(&buf, " burst='%llu'", inbound.burst);
            virBufferAsprintf(&buf, "/>\n");
        }
        if (outboundStr && outbound.average > 0) {
            virBufferAsprintf(&buf, "    <outbound average='%llu'", outbound.average);
            if (outbound.peak > 0)
                virBufferAsprintf(&buf, " peak='%llu'", outbound.peak);
            if (outbound.burst > 0)
                virBufferAsprintf(&buf, " burst='%llu'", outbound.burst);
            virBufferAsprintf(&buf, "/>\n");
        }
        virBufferAsprintf(&buf, "  </bandwidth>\n");
    }

12720
    virBufferAddLit(&buf, "</interface>\n");
12721

12722 12723
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
12724
        goto cleanup;
12725 12726
    }

12727
    xml = virBufferContentAndReset(&buf);
12728

J
Jim Fehlig 已提交
12729
    if (vshCommandOptBool(cmd, "persistent")) {
12730
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
12731
        if (virDomainIsActive(dom) == 1)
12732
            flags |= VIR_DOMAIN_AFFECT_LIVE;
12733
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
12734
    } else {
12735
        ret = virDomainAttachDevice(dom, xml);
12736
    }
12737

12738 12739
    VIR_FREE(xml);

J
Jim Fehlig 已提交
12740
    if (ret != 0) {
L
Laine Stump 已提交
12741
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
12742 12743
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
12744
        functionReturn = true;
J
Jim Fehlig 已提交
12745
    }
12746 12747 12748 12749

 cleanup:
    if (dom)
        virDomainFree(dom);
12750
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
12751
    return functionReturn;
12752 12753 12754 12755 12756
}

/*
 * "detach-interface" command
 */
12757
static const vshCmdInfo info_detach_interface[] = {
12758 12759
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
12760 12761 12762
    {NULL, NULL}
};

12763
static const vshCmdOptDef opts_detach_interface[] = {
12764 12765 12766 12767
    {"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")},
12768 12769 12770
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12771
static bool
12772
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
12773 12774 12775 12776 12777 12778 12779
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
12780
    const char *mac =NULL, *type = NULL;
12781
    char *doc;
12782
    char buf[64];
E
Eric Blake 已提交
12783
    int i = 0, diff_mac;
W
Wen Congyang 已提交
12784 12785
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
12786
    unsigned int flags;
12787

12788
    if (!vshConnectionUsability(ctl, ctl->conn))
12789 12790
        goto cleanup;

J
Jim Meyering 已提交
12791
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
12792 12793
        goto cleanup;

12794
    if (vshCommandOptString(cmd, "type", &type) <= 0)
12795 12796
        goto cleanup;

12797 12798
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
12799
        goto cleanup;
12800
    }
12801 12802 12803 12804 12805

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

12806
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
12807
    VIR_FREE(doc);
12808
    if (!xml) {
12809
        vshError(ctl, "%s", _("Failed to get interface information"));
12810 12811 12812
        goto cleanup;
    }

E
Eric Blake 已提交
12813
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
12814 12815 12816
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
12817
        vshError(ctl, _("No found interface whose type is %s"), type);
12818 12819 12820
        goto cleanup;
    }

12821 12822 12823 12824 12825 12826
    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;
    }

12827 12828 12829 12830 12831 12832 12833
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
12834 12835 12836 12837 12838
            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);
12839 12840 12841 12842 12843 12844 12845
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
12846
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
12847 12848 12849 12850 12851
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
12852
        vshError(ctl, "%s", _("Failed to allocate memory"));
12853 12854 12855
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
12861
    if (vshCommandOptBool(cmd, "persistent")) {
12862
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
12863
        if (virDomainIsActive(dom) == 1)
12864
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
12865 12866 12867 12868 12869 12870 12871 12872
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
12873
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
12874
    } else {
J
Jim Meyering 已提交
12875
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
12876
        functionReturn = true;
12877
    }
12878 12879 12880 12881

 cleanup:
    if (dom)
        virDomainFree(dom);
12882
    xmlXPathFreeObject(obj);
12883
    xmlXPathFreeContext(ctxt);
12884 12885
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
12886
    return functionReturn;
12887 12888 12889 12890 12891
}

/*
 * "attach-disk" command
 */
12892
static const vshCmdInfo info_attach_disk[] = {
12893 12894
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
12895 12896 12897
    {NULL, NULL}
};

12898
static const vshCmdOptDef opts_attach_disk[] = {
12899
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12900 12901
    {"source",  VSH_OT_DATA, VSH_OFLAG_REQ | VSH_OFLAG_EMPTY_OK,
     N_("source of disk device")},
12902 12903 12904
    {"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")},
12905
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
12906 12907 12908
    {"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")},
12909
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
12910 12911 12912
    {"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")},
12913 12914
    {"multifunction", VSH_OT_BOOL, 0,
     N_("use multifunction pci under specified address")},
12915 12916 12917
    {NULL, 0, 0, NULL}
};

12918 12919 12920 12921 12922 12923 12924 12925 12926 12927 12928 12929 12930 12931 12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064
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 已提交
13065
static bool
13066
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
13067 13068
{
    virDomainPtr dom = NULL;
13069
    const char *source = NULL, *target = NULL, *driver = NULL,
13070 13071 13072
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
13073 13074
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
13075
    unsigned int flags;
13076
    const char *stype = NULL;
13077 13078
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
13079

13080
    if (!vshConnectionUsability(ctl, ctl->conn))
13081 13082
        goto cleanup;

J
Jim Meyering 已提交
13083
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
13084 13085
        goto cleanup;

13086
    if (vshCommandOptString(cmd, "source", &source) <= 0)
13087
        goto cleanup;
13088 13089 13090 13091
    /* Allow empty string as a placeholder that implies no source, for
     * use in adding a cdrom drive with no disk.  */
    if (!*source)
        source = NULL;
13092

13093
    if (vshCommandOptString(cmd, "target", &target) <= 0)
13094 13095
        goto cleanup;

13096 13097 13098 13099
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
13100 13101 13102
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
13103
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
13104
        vshError(ctl, "%s", _("missing option"));
13105 13106
        goto cleanup;
    }
13107

13108 13109
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
13110
            isFile = true;
13111
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
13112
        isFile = true;
13113 13114 13115
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
13116 13117 13118
    }

    if (mode) {
13119
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
13120 13121
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
13122 13123 13124 13125 13126
            goto cleanup;
        }
    }

    /* Make XML of disk */
13127
    virBufferAsprintf(&buf, "<disk type='%s'",
13128 13129
                      (isFile) ? "file" : "block");
    if (type)
13130
        virBufferAsprintf(&buf, " device='%s'", type);
13131 13132
    virBufferAddLit(&buf, ">\n");

13133
    if (driver || subdriver)
13134
        virBufferAsprintf(&buf, "  <driver");
13135 13136

    if (driver)
13137
        virBufferAsprintf(&buf, " name='%s'", driver);
13138
    if (subdriver)
13139
        virBufferAsprintf(&buf, " type='%s'", subdriver);
13140 13141
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
13142

13143
    if (driver || subdriver || cache)
13144
        virBufferAddLit(&buf, "/>\n");
13145

13146 13147 13148 13149
    if (source)
        virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
                          (isFile) ? "file" : "dev",
                          source);
13150
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
13151
    if (mode)
13152
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
13153

13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169
    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'"
13170
                                  " bus ='0x%02x' slot='0x%02x' function='0x%0x'",
13171 13172
                                  diskAddr.addr.pci.domain, diskAddr.addr.pci.bus,
                                  diskAddr.addr.pci.slot, diskAddr.addr.pci.function);
13173 13174 13175
                if (vshCommandOptBool(cmd, "multifunction"))
                    virBufferAddLit(&buf, " multifunction='on'");
                virBufferAddLit(&buf, "/>\n");
13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204
            } 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;
            }
        }
    }

13205
    virBufferAddLit(&buf, "</disk>\n");
13206

13207 13208
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
13209
        return false;
13210 13211
    }

13212
    xml = virBufferContentAndReset(&buf);
13213

J
Jim Fehlig 已提交
13214
    if (vshCommandOptBool(cmd, "persistent")) {
13215
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
13216
        if (virDomainIsActive(dom) == 1)
13217
            flags |= VIR_DOMAIN_AFFECT_LIVE;
13218
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
13219
    } else {
13220
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
13221
    }
13222

13223 13224
    VIR_FREE(xml);

J
Jim Fehlig 已提交
13225
    if (ret != 0) {
L
Laine Stump 已提交
13226
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
13227 13228
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
13229
        functionReturn = true;
J
Jim Fehlig 已提交
13230
    }
13231 13232 13233 13234

 cleanup:
    if (dom)
        virDomainFree(dom);
13235
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
13236
    return functionReturn;
13237 13238 13239 13240 13241
}

/*
 * "detach-disk" command
 */
13242
static const vshCmdInfo info_detach_disk[] = {
13243 13244
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
13245 13246 13247
    {NULL, NULL}
};

13248
static const vshCmdOptDef opts_detach_disk[] = {
13249 13250 13251
    {"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")},
13252 13253 13254
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13255
static bool
13256
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
13257 13258 13259 13260 13261 13262 13263
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
13264
    const char *target = NULL;
13265
    char *doc;
E
Eric Blake 已提交
13266
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
13267 13268
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
13269
    unsigned int flags;
13270

13271
    if (!vshConnectionUsability(ctl, ctl->conn))
13272 13273
        goto cleanup;

J
Jim Meyering 已提交
13274
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
13275 13276
        goto cleanup;

13277
    if (vshCommandOptString(cmd, "target", &target) <= 0)
13278 13279 13280 13281 13282 13283
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

13284
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
13285
    VIR_FREE(doc);
13286
    if (!xml) {
13287
        vshError(ctl, "%s", _("Failed to get disk information"));
13288 13289 13290 13291 13292 13293
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
13294
        vshError(ctl, "%s", _("Failed to get disk information"));
13295 13296 13297 13298 13299 13300 13301
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
13302 13303 13304 13305 13306
            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);
13307 13308 13309 13310 13311 13312 13313
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
13314
    vshError(ctl, _("No found disk whose target is %s"), target);
13315 13316 13317 13318 13319
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
13320
        vshError(ctl, "%s", _("Failed to allocate memory"));
13321 13322 13323
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
13329
    if (vshCommandOptBool(cmd, "persistent")) {
13330
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
13331
        if (virDomainIsActive(dom) == 1)
13332
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
13333 13334 13335 13336 13337 13338 13339 13340
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
13341
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
13342
    } else {
J
Jim Meyering 已提交
13343
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
13344
        functionReturn = true;
13345
    }
13346 13347

 cleanup:
13348
    xmlXPathFreeObject(obj);
13349
    xmlXPathFreeContext(ctxt);
13350 13351
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
13352 13353
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
13354
    return functionReturn;
13355 13356
}

13357 13358 13359 13360
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
13361 13362
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
13363 13364 13365 13366
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
13367
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
13368 13369 13370
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13371
static bool
13372 13373
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
13374
    const char *from = NULL;
13375
    bool ret = false;
13376 13377
    char *buffer;
    int result;
13378 13379 13380 13381 13382 13383
    const char *snippet;

    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlBufferPtr xml_buf = NULL;
    xmlNodePtr node;
13384

13385
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13386
        return false;
13387

13388
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
13389
        return false;
13390

13391 13392 13393
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
        vshError(ctl, _("Failed to read file '%s' to compare"),
                 from);
E
Eric Blake 已提交
13394
        return false;
13395
    }
13396

13397 13398 13399 13400 13401 13402 13403 13404 13405 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421
    /* try to extract the CPU element from as it would appear in a domain XML*/
    if (!(xml = virXMLParseStringCtxt(buffer, from, &ctxt)))
        goto cleanup;

    if ((node = virXPathNode("/cpu|"
                             "/domain/cpu|"
                              "/capabilities/host/cpu", ctxt))) {
        if (!(xml_buf = xmlBufferCreate())) {
            vshError(ctl, _("Can't create XML buffer to extract CPU element."));
            goto cleanup;
        }

        if (xmlNodeDump(xml_buf, xml, node, 0, 0) < 0) {
            vshError(ctl, _("Failed to extract CPU element snippet from domain XML."));
            goto cleanup;
        }

        snippet = (const char *) xmlBufferContent(xml_buf);
    } else {
        vshError(ctl, _("File '%s' does not contain a <cpu> element or is not "
                        "a valid domain or capabilities XML"), from);
        goto cleanup;
    }

    result = virConnectCompareCPU(ctl->conn, snippet, 0);
13422 13423 13424 13425 13426

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
13427
        goto cleanup;
13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
13443
        goto cleanup;
13444 13445
    }

13446 13447 13448 13449 13450 13451 13452 13453
    ret = true;

cleanup:
    VIR_FREE(buffer);
    xmlBufferFree(xml_buf);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);

13454 13455 13456
    return ret;
}

13457 13458 13459 13460
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
13461 13462
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
13463 13464 13465 13466
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
13467
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
13468 13469 13470
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13471
static bool
13472 13473
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
13474
    const char *from = NULL;
13475
    bool ret = false;
13476 13477 13478
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
13479 13480 13481 13482
    int count = 0;

    xmlDocPtr xml = NULL;
    xmlNodePtr *node_list = NULL;
13483
    xmlXPathContextPtr ctxt = NULL;
13484 13485 13486
    xmlBufferPtr xml_buf = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    int i;
13487

13488
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13489
        return false;
13490

13491
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
13492
        return false;
13493 13494

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

E
Eric Blake 已提交
13497
    /* add a separate container around the xml */
13498 13499
    virBufferStrcat(&buf, "<container>", buffer, "</container>", NULL);
    if (virBufferError(&buf))
13500 13501
        goto no_memory;

13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514
    VIR_FREE(buffer);
    buffer = virBufferContentAndReset(&buf);


    if (!(xml = virXMLParseStringCtxt(buffer, from, &ctxt)))
        goto cleanup;

    if ((count = virXPathNodeSet("//cpu[not(ancestor::cpus)]",
                                 ctxt, &node_list)) == -1)
        goto cleanup;

    if (count == 0) {
        vshError(ctl, _("No host CPU specified in '%s'"), from);
13515 13516 13517
        goto cleanup;
    }

13518
    list = vshCalloc(ctl, count, sizeof(const char *));
13519

13520
    if (!(xml_buf = xmlBufferCreate()))
13521 13522
        goto no_memory;

13523 13524
    for (i = 0; i < count; i++) {
        xmlBufferEmpty(xml_buf);
13525

13526 13527 13528
        if (xmlNodeDump(xml_buf, xml,  node_list[i], 0, 0) < 0) {
            vshError(ctl, _("Failed to extract <cpu> element"));
            goto cleanup;
13529 13530
        }

13531
        list[i] = vshStrdup(ctl, (const char *)xmlBufferContent(xml_buf));
13532 13533 13534 13535
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

13536
    if (result) {
13537
        vshPrint(ctl, "%s", result);
13538 13539
        ret = true;
    }
13540 13541 13542

cleanup:
    xmlXPathFreeContext(ctxt);
13543 13544
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
13545 13546
    VIR_FREE(result);
    if ((list != NULL) && (count > 0)) {
13547
        for (i = 0; i < count; i++)
13548 13549 13550 13551 13552 13553 13554 13555 13556
            VIR_FREE(list[i]);
    }
    VIR_FREE(list);
    VIR_FREE(buffer);

    return ret;

no_memory:
    vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
13557
    ret = false;
13558
    goto cleanup;
13559 13560
}

13561 13562 13563 13564 13565 13566 13567 13568
/* 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;

13569
    ret = vshMalloc(ctl, PATH_MAX);
13570 13571 13572

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
13573 13574
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
13575
    if (fd == -1) {
13576
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
13577
                 strerror(errno));
13578
        VIR_FREE(ret);
13579 13580 13581 13582
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
13583 13584
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
13585
        VIR_FORCE_CLOSE(fd);
13586
        unlink (ret);
13587
        VIR_FREE(ret);
13588 13589
        return NULL;
    }
S
Stefan Berger 已提交
13590
    if (VIR_CLOSE(fd) < 0) {
13591 13592
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
13593
        unlink (ret);
13594
        VIR_FREE(ret);
13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609
        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 已提交
13610 13611 13612 13613
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
13614

13615
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
13616 13617 13618 13619
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
13620

13621 13622 13623 13624 13625
    /* 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 已提交
13626 13627
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
13628
     */
E
Eric Blake 已提交
13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640
    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);
13641 13642
    }

E
Eric Blake 已提交
13643 13644 13645 13646 13647 13648 13649
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
13650
    }
E
Eric Blake 已提交
13651
    ret = 0;
13652

E
Eric Blake 已提交
13653 13654 13655
cleanup:
    virCommandFree(cmd);
    return ret;
13656 13657 13658 13659 13660 13661 13662 13663
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
13664
        vshError(ctl,
13665
                 _("%s: failed to read temporary file: %s"),
13666
                 filename, strerror(errno));
13667 13668 13669 13670 13671
        return NULL;
    }
    return ret;
}

13672

P
Paolo Bonzini 已提交
13673 13674 13675 13676
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
13677 13678
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
13679 13680 13681 13682
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
13683
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
13684 13685 13686
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13687
static bool
13688
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
13689
{
13690
    const char *dir = NULL;
13691
    char *dir_malloced = NULL;
E
Eric Blake 已提交
13692
    bool ret = true;
P
Paolo Bonzini 已提交
13693 13694

    if (!ctl->imode) {
13695
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
13696
        return false;
P
Paolo Bonzini 已提交
13697 13698
    }

13699
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
13700
        uid_t uid = geteuid();
13701
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
13702 13703 13704 13705
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
13706
    if (chdir(dir) == -1) {
13707
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
13708
        ret = false;
P
Paolo Bonzini 已提交
13709 13710
    }

13711
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
13712
    return ret;
P
Paolo Bonzini 已提交
13713 13714 13715 13716 13717 13718
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
13719 13720
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
13721 13722 13723
    {NULL, NULL}
};

E
Eric Blake 已提交
13724
static bool
P
Paolo Bonzini 已提交
13725 13726 13727
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
13728
    bool ret = true;
P
Paolo Bonzini 已提交
13729

13730 13731
    cwd = getcwd(NULL, 0);
    if (!cwd) {
13732 13733
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
13734 13735
        ret = false;
    } else {
P
Paolo Bonzini 已提交
13736
        vshPrint (ctl, _("%s\n"), cwd);
13737 13738
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
13739

13740
    return ret;
P
Paolo Bonzini 已提交
13741 13742
}

E
Eric Blake 已提交
13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754
/*
 * "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")},
13755
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
13756 13757 13758 13759 13760 13761
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
13762
static bool
13763
cmdEcho (vshControl *ctl, const vshCmd *cmd)
E
Eric Blake 已提交
13764 13765 13766 13767
{
    bool shell = false;
    bool xml = false;
    int count = 0;
13768
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
13769 13770 13771 13772 13773 13774 13775 13776
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

13777
    while ((opt = vshCommandOptArgv(cmd, opt))) {
13778 13779
        char *str;
        virBuffer xmlbuf = VIR_BUFFER_INITIALIZER;
E
Eric Blake 已提交
13780

13781
        arg = opt->data;
13782

E
Eric Blake 已提交
13783 13784
        if (count)
            virBufferAddChar(&buf, ' ');
13785

E
Eric Blake 已提交
13786
        if (xml) {
13787 13788 13789 13790
            virBufferEscapeString(&xmlbuf, "%s", arg);
            if (virBufferError(&buf)) {
                vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
                return false;
E
Eric Blake 已提交
13791
            }
13792 13793 13794
            str = virBufferContentAndReset(&xmlbuf);
        } else {
            str = vshStrdup(ctl, arg);
E
Eric Blake 已提交
13795
        }
13796 13797 13798 13799 13800

        if (shell)
            virBufferEscapeShell(&buf, str);
        else
            virBufferAdd(&buf, str, -1);
E
Eric Blake 已提交
13801
        count++;
13802
        VIR_FREE(str);
E
Eric Blake 已提交
13803 13804 13805 13806
    }

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
13807
        return false;
E
Eric Blake 已提交
13808 13809 13810 13811 13812
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
13813
    return true;
E
Eric Blake 已提交
13814 13815
}

13816 13817 13818 13819
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
13820 13821
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
13822 13823 13824 13825
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
13826
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
13827 13828 13829 13830 13831 13832
    {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 已提交
13833
static bool
13834 13835
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
13836
    bool ret = false;
13837 13838 13839 13840 13841
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
13842
    unsigned int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
13843

13844
    if (!vshConnectionUsability(ctl, ctl->conn))
13845 13846
        goto cleanup;

J
Jim Meyering 已提交
13847
    dom = vshCommandOptDomain (ctl, cmd, NULL);
13848 13849 13850 13851
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
13852
    doc = virDomainGetXMLDesc (dom, flags);
13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870
    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 已提交
13871
        ret = true;
13872 13873 13874 13875 13876 13877 13878
        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.
     */
13879
    doc_reread = virDomainGetXMLDesc (dom, flags);
13880 13881 13882 13883
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
13884 13885
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897
        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 已提交
13898
    ret = true;
13899 13900 13901 13902 13903

 cleanup:
    if (dom)
        virDomainFree (dom);

13904 13905 13906
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
13907 13908 13909

    if (tmp) {
        unlink (tmp);
13910
        VIR_FREE(tmp);
13911 13912 13913 13914 13915
    }

    return ret;
}

13916

13917 13918 13919 13920
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
13921 13922
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
13923 13924 13925 13926
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
13927
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
13928 13929 13930 13931 13932 13933 13934 13935 13936 13937
    {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[] = {
13938 13939
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
13940 13941 13942 13943
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
13944
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
13945 13946 13947 13948 13949 13950
    {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 已提交
13951 13952 13953
/*
 * "quit" command
 */
13954
static const vshCmdInfo info_quit[] = {
13955
    {"help", N_("quit this interactive terminal")},
13956
    {"desc", ""},
13957
    {NULL, NULL}
K
Karel Zak 已提交
13958 13959
};

E
Eric Blake 已提交
13960
static bool
13961
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
13962
{
E
Eric Blake 已提交
13963 13964
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
13965 13966
}

13967 13968 13969 13970 13971 13972 13973
/* 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;
13974
    bool halt = false;
13975 13976 13977
    char *doc = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
E
Eric Blake 已提交
13978
    const char *name = NULL;
13979 13980

    snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004

    /* 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);
    }

14005 14006 14007
    if (snapshot == NULL)
        goto cleanup;

14008 14009 14010 14011 14012
    if (halt && virDomainDestroy(dom) < 0) {
        virshReportError(ctl);
        goto cleanup;
    }

E
Eric Blake 已提交
14013
    name = virDomainSnapshotGetName(snapshot);
14014
    if (!name) {
E
Eric Blake 已提交
14015
        vshError(ctl, "%s", _("Could not get snapshot name"));
14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034
        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;
}

14035 14036 14037 14038
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
14039 14040
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
14041 14042 14043 14044 14045 14046
    {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")},
14047 14048 14049
    {"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")},
14050
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
14051
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
14052 14053 14054
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14055
static bool
14056 14057 14058
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14059
    bool ret = false;
14060
    const char *from = NULL;
14061
    char *buffer = NULL;
14062 14063 14064 14065 14066 14067 14068 14069
    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;
14070 14071
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
14072 14073
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
14074

14075
    if (!vshConnectionUsability(ctl, ctl->conn))
14076 14077 14078 14079 14080 14081
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

14082
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
14083
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
14084 14085 14086 14087 14088 14089 14090 14091 14092 14093 14094 14095 14096 14097 14098
    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;
    }

14099
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, from);
14100 14101 14102 14103 14104 14105 14106 14107 14108

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

14109 14110 14111
/*
 * "snapshot-create-as" command
 */
14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131 14132 14133 14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167
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;
}

14168 14169 14170 14171 14172 14173 14174 14175 14176 14177
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 已提交
14178
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
14179
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
14180
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
14181 14182 14183
    {"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]")},
14184 14185 14186 14187 14188 14189 14190 14191 14192 14193 14194 14195
    {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;
14196
    unsigned int flags = 0;
14197
    const vshCmdOpt *opt = NULL;
14198 14199 14200

    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
14201 14202
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
14203 14204
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
14205 14206 14207 14208 14209 14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220

    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)
14221
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
14222
    if (desc)
14223
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
14224 14225 14226 14227 14228 14229 14230 14231 14232 14233
    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");
    }
14234 14235 14236 14237 14238 14239 14240 14241
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
14242 14243 14244 14245 14246 14247
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

14248
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, NULL);
14249 14250 14251 14252 14253 14254 14255 14256 14257

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296
/* Helper for resolving {--current | --ARG name} into a snapshot
 * belonging to DOM.  If EXCLUSIVE, fail if both --current and arg are
 * present.  On success, populate *SNAP and *NAME, before returning 0.
 * On failure, return -1 after issuing an error message.  */
static int
vshLookupSnapshot(vshControl *ctl, const vshCmd *cmd,
                  const char *arg, bool exclusive, virDomainPtr dom,
                  virDomainSnapshotPtr *snap, const char **name)
{
    bool current = vshCommandOptBool(cmd, "current");
    const char *snapname = NULL;

    if (vshCommandOptString(cmd, arg, &snapname) < 0) {
        vshError(ctl, _("invalid argument for --%s"), arg);
        return -1;
    }

    if (exclusive && current && snapname) {
        vshError(ctl, _("--%s and --current are mutually exclusive"), arg);
        return -1;
    }

    if (snapname) {
        *snap = virDomainSnapshotLookupByName(dom, snapname, 0);
    } else if (current) {
        *snap = virDomainSnapshotCurrent(dom, 0);
    } else {
        vshError(ctl, _("--%s or --current is required"), arg);
        return -1;
    }
    if (!*snap) {
        virshReportError(ctl);
        return -1;
    }

    *name = virDomainSnapshotGetName(*snap);
    return 0;
}

14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307
/*
 * "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")},
14308
    {"snapshotname", VSH_OT_DATA, 0, N_("snapshot name")},
14309
    {"current", VSH_OT_BOOL, 0, N_("also set edited snapshot as current")},
14310 14311
    {"rename", VSH_OT_BOOL, 0, N_("allow renaming an existing snapshot")},
    {"clone", VSH_OT_BOOL, 0, N_("allow cloning to new name")},
14312 14313 14314 14315 14316 14317 14318 14319
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotEdit(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    virDomainSnapshotPtr snapshot = NULL;
14320
    virDomainSnapshotPtr edited = NULL;
14321
    const char *name;
14322
    const char *edited_name;
14323 14324 14325 14326 14327 14328
    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;
14329 14330 14331 14332 14333 14334 14335 14336
    bool rename_okay = vshCommandOptBool(cmd, "rename");
    bool clone_okay = vshCommandOptBool(cmd, "clone");

    if (rename_okay && clone_okay) {
        vshError(ctl, "%s",
                 _("--rename and --clone are mutually exclusive"));
        return false;
    }
14337

14338 14339
    if (vshCommandOptBool(cmd, "current") &&
        vshCommandOptBool(cmd, "snapshotname"))
14340 14341 14342 14343 14344 14345 14346 14347 14348
        define_flags |= VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT;

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

14349 14350
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", false, dom,
                          &snapshot, &name) < 0)
14351 14352 14353 14354 14355 14356 14357
        goto cleanup;

    /* Get the XML configuration of the snapshot.  */
    doc = virDomainSnapshotGetXMLDesc(snapshot, getxml_flags);
    if (!doc)
        goto cleanup;

14358 14359 14360 14361
    /* strstr is safe here, since xml came from libvirt API and not user */
    if (strstr(doc, "<state>disk-snapshot</state>"))
        define_flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;

14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386
    /* 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.  */
14387 14388
    edited = virDomainSnapshotCreateXML(dom, doc_edited, define_flags);
    if (!edited) {
14389 14390 14391 14392
        vshError(ctl, _("Failed to update %s"), name);
        goto cleanup;
    }

14393 14394 14395 14396 14397 14398 14399 14400 14401 14402 14403 14404 14405 14406 14407 14408 14409 14410 14411 14412 14413 14414 14415 14416
    edited_name = virDomainSnapshotGetName(edited);
    if (STREQ(name, edited_name)) {
        vshPrint(ctl, _("Snapshot %s edited.\n"), name);
    } else if (clone_okay) {
        vshPrint(ctl, _("Snapshot %s cloned to %s.\n"), name,
                 edited_name);
    } else {
        unsigned int delete_flags;

        delete_flags = VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY;
        if (virDomainSnapshotDelete(rename_okay ? snapshot : edited,
                                    delete_flags) < 0) {
            virshReportError(ctl);
            vshError(ctl, _("Failed to clean up %s"),
                     rename_okay ? name : edited_name);
            goto cleanup;
        }
        if (!rename_okay) {
            vshError(ctl, _("Must use --rename or --clone to change %s to %s"),
                     name, edited_name);
            goto cleanup;
        }
    }

14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427
    ret = true;

cleanup:
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
    if (snapshot)
        virDomainSnapshotFree(snapshot);
14428 14429
    if (edited)
        virDomainSnapshotFree(edited);
14430 14431 14432 14433 14434
    if (dom)
        virDomainFree(dom);
    return ret;
}

14435 14436 14437 14438
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
14439 14440
    {"help", N_("Get or set the current snapshot")},
    {"desc", N_("Get or set the current snapshot")},
14441 14442 14443 14444 14445
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
14446
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
14447 14448
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
14449 14450
    {"snapshotname", VSH_OT_DATA, 0,
     N_("name of existing snapshot to make current")},
14451 14452 14453
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14454
static bool
14455 14456 14457
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14458
    bool ret = false;
14459 14460
    int current;
    virDomainSnapshotPtr snapshot = NULL;
14461
    char *xml = NULL;
14462
    const char *snapshotname = NULL;
14463
    unsigned int flags = 0;
14464
    const char *domname;
14465 14466 14467

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

14469
    if (!vshConnectionUsability(ctl, ctl->conn))
14470 14471
        goto cleanup;

14472
    dom = vshCommandOptDomain(ctl, cmd, &domname);
14473 14474 14475
    if (dom == NULL)
        goto cleanup;

14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495
    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;
14496 14497 14498
        /* strstr is safe here, since xml came from libvirt API and not user */
        if (strstr(xml, "<state>disk-snapshot</state>"))
            flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
14499 14500 14501 14502 14503 14504 14505 14506 14507
        snapshot2 = virDomainSnapshotCreateXML(dom, xml, flags);
        if (snapshot2 == NULL)
            goto cleanup;
        virDomainSnapshotFree(snapshot2);
        vshPrint(ctl, _("Snapshot %s set as current"), snapshotname);
        ret = true;
        goto cleanup;
    }

14508
    current = virDomainHasCurrentSnapshot(dom, 0);
14509 14510 14511 14512
    if (current < 0) {
        goto cleanup;
    } else if (!current) {
        vshError(ctl, _("domain '%s' has no current snapshot"), domname);
14513
        goto cleanup;
14514
    } else {
E
Eric Blake 已提交
14515
        const char *name = NULL;
14516 14517 14518 14519

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

14520
        if (vshCommandOptBool(cmd, "name")) {
E
Eric Blake 已提交
14521
            name = virDomainSnapshotGetName(snapshot);
14522 14523
            if (!name)
                goto cleanup;
E
Eric Blake 已提交
14524 14525 14526 14527
        } else {
            xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
            if (!xml)
                goto cleanup;
14528 14529 14530
        }

        vshPrint(ctl, "%s", name ? name : xml);
14531 14532
    }

E
Eric Blake 已提交
14533
    ret = true;
14534 14535

cleanup:
14536 14537
    if (!ret)
        virshReportError(ctl);
14538
    VIR_FREE(xml);
14539 14540 14541 14542 14543 14544 14545 14546
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

14547
/* Helper function to get the name of a snapshot's parent.  Caller
14548 14549 14550 14551 14552 14553
 * must free the result.  Returns 0 on success (including when it was
 * proven no parent exists), and -1 on failure with error reported
 * (such as no snapshot support or domain deleted in meantime).  */
static int
vshGetSnapshotParent(vshControl *ctl, virDomainSnapshotPtr snapshot,
                     char **parent_name)
14554 14555 14556 14557 14558
{
    virDomainSnapshotPtr parent = NULL;
    char *xml = NULL;
    xmlDocPtr xmldoc = NULL;
    xmlXPathContextPtr ctxt = NULL;
14559 14560 14561
    int ret = -1;

    *parent_name = NULL;
14562 14563

    /* Try new API, since it is faster. */
14564
    if (!ctl->useSnapshotOld) {
14565 14566 14567
        parent = virDomainSnapshotGetParent(snapshot, 0);
        if (parent) {
            /* API works, and virDomainSnapshotGetName will succeed */
14568 14569
            *parent_name = vshStrdup(ctl, virDomainSnapshotGetName(parent));
            ret = 0;
14570 14571 14572 14573
            goto cleanup;
        }
        if (last_error->code == VIR_ERR_NO_DOMAIN_SNAPSHOT) {
            /* API works, and we found a root with no parent */
14574
            ret = 0;
14575 14576 14577
            goto cleanup;
        }
        /* API didn't work, fall back to XML scraping. */
14578
        ctl->useSnapshotOld = true;
14579 14580 14581 14582 14583 14584 14585 14586 14587 14588
    }

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

    xmldoc = virXMLParseStringCtxt(xml, _("(domain_snapshot)"), &ctxt);
    if (!xmldoc)
        goto cleanup;

14589 14590
    *parent_name = virXPathString("string(/domainsnapshot/parent/name)", ctxt);
    ret = 0;
14591 14592

cleanup:
14593 14594 14595 14596 14597 14598 14599
    if (ret < 0) {
        virshReportError(ctl);
        vshError(ctl, "%s", _("unable to determine if snapshot has parent"));
    } else {
        virFreeError(last_error);
        last_error = NULL;
    }
14600 14601 14602 14603 14604
    if (parent)
        virDomainSnapshotFree(parent);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xmldoc);
    VIR_FREE(xml);
14605
    return ret;
14606 14607
}

14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618
/*
 * "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")},
14619
    {"parent", VSH_OT_BOOL, 0, N_("add a column showing parent snapshot")},
14620
    {"roots", VSH_OT_BOOL, 0, N_("list only snapshots without parents")},
14621
    {"leaves", VSH_OT_BOOL, 0, N_("list only snapshots without children")},
14622 14623
    {"metadata", VSH_OT_BOOL, 0,
     N_("list only snapshots that have metadata that would prevent undefine")},
14624
    {"tree", VSH_OT_BOOL, 0, N_("list snapshots in a tree")},
14625
    {"from", VSH_OT_DATA, 0, N_("limit list to children of given snapshot")},
14626 14627
    {"current", VSH_OT_BOOL, 0,
     N_("limit list to children of current snapshot")},
14628
    {"descendants", VSH_OT_BOOL, 0, N_("with --from, list all descendants")},
14629 14630 14631
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14632
static bool
14633 14634 14635
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14636
    bool ret = false;
14637
    unsigned int flags = 0;
14638 14639
    int parent_filter = 0; /* -1 for roots filtering, 0 for no parent
                              information needed, 1 for parent column */
14640 14641
    int numsnaps;
    char **names = NULL;
14642
    char **parents = NULL;
14643
    int actual = 0;
14644 14645 14646 14647 14648 14649
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
14650
    char *parent = NULL;
14651 14652
    long long creation_longlong;
    time_t creation_time_t;
14653 14654
    char timestr[100];
    struct tm time_info;
14655
    bool tree = vshCommandOptBool(cmd, "tree");
14656
    bool leaves = vshCommandOptBool(cmd, "leaves");
14657 14658
    const char *from = NULL;
    virDomainSnapshotPtr start = NULL;
14659
    int start_index = -1;
14660
    bool descendants = false;
14661

14662 14663 14664 14665 14666 14667 14668 14669 14670 14671
    if (!vshConnectionUsability(ctl, ctl->conn))
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    if ((vshCommandOptBool(cmd, "from") ||
         vshCommandOptBool(cmd, "current")) &&
        vshLookupSnapshot(ctl, cmd, "from", true, dom, &start, &from) < 0)
14672
        goto cleanup;
14673

14674
    if (vshCommandOptBool(cmd, "parent")) {
14675 14676
        if (vshCommandOptBool(cmd, "roots")) {
            vshError(ctl, "%s",
14677
                     _("--parent and --roots are mutually exclusive"));
14678 14679
            return false;
        }
14680 14681
        if (tree) {
            vshError(ctl, "%s",
14682
                     _("--parent and --tree are mutually exclusive"));
14683 14684
            return false;
        }
14685
        parent_filter = 1;
14686
    } else if (vshCommandOptBool(cmd, "roots")) {
14687 14688
        if (tree) {
            vshError(ctl, "%s",
14689
                     _("--roots and --tree are mutually exclusive"));
14690 14691
            return false;
        }
14692 14693 14694 14695
        if (from) {
            vshError(ctl, "%s",
                     _("--roots and --from are mutually exclusive"));
        }
14696 14697
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
    }
14698 14699 14700 14701 14702 14703 14704 14705
    if (leaves) {
        if (tree) {
            vshError(ctl, "%s",
                     _("--leaves and --tree are mutually exclusive"));
            return false;
        }
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_LEAVES;
    }
14706 14707 14708

    if (vshCommandOptBool(cmd, "metadata")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_METADATA;
14709 14710
    }

14711
    if (from) {
14712 14713
        descendants = vshCommandOptBool(cmd, "descendants");
        if (descendants || tree) {
14714 14715
            flags |= VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS;
        }
14716 14717
        numsnaps = ctl->useSnapshotOld ? -1 :
            virDomainSnapshotNumChildren(start, flags);
14718
        if (numsnaps < 0) {
14719 14720
            if (ctl->useSnapshotOld ||
                last_error->code == VIR_ERR_NO_SUPPORT) {
14721
                /* We can emulate --from.  */
14722
                /* XXX can we also emulate --leaves? */
14723 14724 14725 14726 14727 14728
                virFreeError(last_error);
                last_error = NULL;
                ctl->useSnapshotOld = true;
                flags &= ~VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS;
                numsnaps = virDomainSnapshotNum(dom, flags);
            }
14729 14730
        } else if (tree) {
            numsnaps++;
14731
        }
14732
    } else {
14733
        numsnaps = virDomainSnapshotNum(dom, flags);
14734 14735

        /* Fall back to simulation if --roots was unsupported. */
14736
        /* XXX can we also emulate --leaves? */
14737 14738 14739 14740 14741 14742 14743 14744
        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);
        }
14745 14746
    }

14747 14748 14749
    if (numsnaps < 0) {
        if (!last_error)
            vshError(ctl, _("missing support"));
14750
        goto cleanup;
14751
    }
14752

14753 14754 14755 14756 14757 14758 14759 14760 14761
    if (!tree) {
        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\
14762
------------------------------------------------------------\n");
14763
    }
14764

14765 14766 14767 14768
    if (!numsnaps) {
        ret = true;
        goto cleanup;
    }
14769

14770 14771 14772
    if (VIR_ALLOC_N(names, numsnaps) < 0)
        goto cleanup;

14773
    if (from && !ctl->useSnapshotOld) {
14774 14775 14776 14777 14778 14779 14780 14781 14782 14783 14784 14785 14786 14787 14788 14789 14790 14791
        /* When mixing --from and --tree, we want to start the tree at the
         * given snapshot.  Without --tree, only list the children.  */
        if (tree) {
            if (numsnaps)
                actual = virDomainSnapshotListChildrenNames(start, names + 1,
                                                            numsnaps - 1,
                                                            flags);
            if (actual >= 0) {
                actual++;
                names[0] = vshStrdup(ctl, from);
            }
        } else {
            actual = virDomainSnapshotListChildrenNames(start, names,
                                                        numsnaps, flags);
        }
    } else {
        actual = virDomainSnapshotListNames(dom, names, numsnaps, flags);
    }
14792 14793
    if (actual < 0)
        goto cleanup;
14794

E
Eric Blake 已提交
14795 14796
    qsort(&names[0], actual, sizeof(char*), namesorter);

14797 14798
    if (tree || ctl->useSnapshotOld) {
        parents = vshCalloc(ctl, sizeof(char *), actual);
14799
        for (i = (from && !ctl->useSnapshotOld); i < actual; i++) {
14800 14801 14802 14803 14804
            if (ctl->useSnapshotOld && STREQ(names[i], from)) {
                start_index = i;
                continue;
            }

14805 14806 14807 14808
            /* free up memory from previous iterations of the loop */
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
14809 14810
            if (!snapshot ||
                vshGetSnapshotParent(ctl, snapshot, &parents[i]) < 0) {
14811 14812 14813 14814 14815 14816
                while (--i >= 0)
                    VIR_FREE(parents[i]);
                VIR_FREE(parents);
                goto cleanup;
            }
        }
14817 14818 14819
    }
    if (tree) {
        char indentBuf[INDENT_BUFLEN];
14820 14821
        for (i = 0 ; i < actual ; i++) {
            memset(indentBuf, '\0', sizeof indentBuf);
14822
            if (ctl->useSnapshotOld ? STREQ(names[i], from) : !parents[i])
14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836
                cmdNodeListDevicesPrint(ctl,
                                        names,
                                        parents,
                                        actual,
                                        i,
                                        i,
                                        0,
                                        0,
                                        indentBuf);
        }

        ret = true;
        goto cleanup;
    } else {
14837
        if (ctl->useSnapshotOld && descendants) {
14838 14839 14840 14841 14842 14843 14844 14845 14846 14847 14848 14849 14850 14851 14852 14853 14854 14855 14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887
            bool changed = false;

            /* Make multiple passes over the list - first pass NULLs
             * out all roots except start, remaining passes NULL out
             * any entry whose parent is not still in list.  Also, we
             * NULL out parent when name is known to be in list.
             * Sorry, this is O(n^3) - hope your hierarchy isn't huge.  */
            if (start_index < 0) {
                vshError(ctl, _("snapshot %s disappeared from list"), from);
                goto cleanup;
            }
            for (i = 0; i < actual; i++) {
                if (i == start_index)
                    continue;
                if (!parents[i]) {
                    VIR_FREE(names[i]);
                } else if (STREQ(parents[i], from)) {
                    VIR_FREE(parents[i]);
                    changed = true;
                }
            }
            if (!changed) {
                ret = true;
                goto cleanup;
            }
            while (changed) {
                changed = false;
                for (i = 0; i < actual; i++) {
                    bool found = false;
                    int j;

                    if (!names[i] || !parents[i])
                        continue;
                    for (j = 0; j < actual; j++) {
                        if (!names[j] || i == j)
                            continue;
                        if (STREQ(parents[i], names[j])) {
                            found = true;
                            if (!parents[j])
                                VIR_FREE(parents[i]);
                            break;
                        }
                    }
                    if (!found) {
                        changed = true;
                        VIR_FREE(names[i]);
                    }
                }
            }
            VIR_FREE(names[start_index]);
14888 14889
        }

14890
        for (i = 0; i < actual; i++) {
14891 14892
            if (ctl->useSnapshotOld &&
                (descendants ? !names[i] : STRNEQ_NULLABLE(parents[i], from)))
14893 14894
                continue;

14895
            /* free up memory from previous iterations of the loop */
14896
            VIR_FREE(parent);
14897 14898 14899 14900
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
14901
            xmlFreeDoc(xml);
14902 14903 14904 14905 14906 14907 14908 14909 14910 14911
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

14912
            xml = virXMLParseStringCtxt(doc, _("(domain_snapshot)"), &ctxt);
14913 14914 14915
            if (!xml)
                continue;

14916 14917 14918
            if (parent_filter) {
                parent = virXPathString("string(/domainsnapshot/parent/name)",
                                        ctxt);
14919 14920
                if (!parent && parent_filter < 0)
                    continue;
14921 14922
            }

14923 14924 14925
            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
14926 14927
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
14928
                continue;
14929 14930 14931 14932 14933 14934
            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);
14935 14936
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z",
                     &time_info);
14937

14938 14939 14940 14941 14942
            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);
14943 14944 14945
        }
    }

E
Eric Blake 已提交
14946
    ret = true;
14947 14948 14949

cleanup:
    /* this frees up memory from the last iteration of the loop */
14950
    VIR_FREE(parent);
14951 14952 14953
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
14954 14955
    if (start)
        virDomainSnapshotFree(start);
14956
    xmlXPathFreeContext(ctxt);
14957
    xmlFreeDoc(xml);
14958
    VIR_FREE(doc);
14959
    for (i = 0; i < actual; i++) {
14960
        VIR_FREE(names[i]);
14961 14962 14963
        if (parents)
            VIR_FREE(parents[i]);
    }
14964
    VIR_FREE(names);
14965
    VIR_FREE(parents);
14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983
    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")},
14984 14985
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
14986 14987 14988
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14989
static bool
14990 14991 14992
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14993
    bool ret = false;
14994
    const char *name = NULL;
14995 14996
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
14997 14998 14999 15000
    unsigned int flags = 0;

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

15002
    if (!vshConnectionUsability(ctl, ctl->conn))
15003 15004 15005 15006 15007 15008
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

15009
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
15010 15011 15012 15013 15014 15015
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

15016
    xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
15017 15018 15019
    if (!xml)
        goto cleanup;

15020
    vshPrint(ctl, "%s", xml);
15021

E
Eric Blake 已提交
15022
    ret = true;
15023 15024 15025 15026 15027 15028 15029 15030 15031 15032 15033

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

E
Eric Blake 已提交
15034 15035 15036 15037
/*
 * "snapshot-parent" command
 */
static const vshCmdInfo info_snapshot_parent[] = {
E
Eric Blake 已提交
15038
    {"help", N_("Get the name of the parent of a snapshot")},
E
Eric Blake 已提交
15039 15040 15041 15042 15043 15044
    {"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")},
15045 15046
    {"snapshotname", VSH_OT_DATA, 0, N_("find parent of snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("find parent of current snapshot")},
E
Eric Blake 已提交
15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065
    {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 *parent = NULL;

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

15066 15067
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", true, dom,
                          &snapshot, &name) < 0)
E
Eric Blake 已提交
15068 15069
        goto cleanup;

15070
    if (vshGetSnapshotParent(ctl, snapshot, &parent) < 0)
E
Eric Blake 已提交
15071
        goto cleanup;
15072 15073 15074 15075
    if (!parent) {
        vshError(ctl, _("snapshot '%s' has no parent"), name);
        goto cleanup;
    }
E
Eric Blake 已提交
15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088 15089 15090

    vshPrint(ctl, "%s", parent);

    ret = true;

cleanup:
    VIR_FREE(parent);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

15091
/*
15092
 * "snapshot-revert" command
15093
 */
15094
static const vshCmdInfo info_snapshot_revert[] = {
15095 15096 15097 15098 15099
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

15100
static const vshCmdOptDef opts_snapshot_revert[] = {
15101
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
15102 15103
    {"snapshotname", VSH_OT_DATA, 0, N_("snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("revert to current snapshot")},
15104 15105
    {"running", VSH_OT_BOOL, 0, N_("after reverting, change state to running")},
    {"paused", VSH_OT_BOOL, 0, N_("after reverting, change state to paused")},
E
Eric Blake 已提交
15106
    {"force", VSH_OT_BOOL, 0, N_("try harder on risky reverts")},
15107 15108 15109
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
15110
static bool
15111
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
15112 15113
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
15114
    bool ret = false;
15115
    const char *name = NULL;
15116
    virDomainSnapshotPtr snapshot = NULL;
15117
    unsigned int flags = 0;
E
Eric Blake 已提交
15118 15119
    bool force = false;
    int result;
15120 15121 15122 15123 15124

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED;
E
Eric Blake 已提交
15125 15126 15127 15128 15129 15130
    /* We want virsh snapshot-revert --force to work even when talking
     * to older servers that did the unsafe revert by default but
     * reject the flag, so we probe without the flag, and only use it
     * when the error says it will make a difference.  */
    if (vshCommandOptBool(cmd, "force"))
        force = true;
15131

15132
    if (!vshConnectionUsability(ctl, ctl->conn))
15133 15134 15135 15136 15137 15138
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

15139 15140
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", true, dom,
                          &snapshot, &name) < 0)
15141 15142
        goto cleanup;

E
Eric Blake 已提交
15143 15144 15145 15146 15147 15148 15149 15150 15151
    result = virDomainRevertToSnapshot(snapshot, flags);
    if (result < 0 && force &&
        last_error->code == VIR_ERR_SNAPSHOT_REVERT_RISKY) {
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_FORCE;
        virFreeError(last_error);
        last_error = NULL;
        result = virDomainRevertToSnapshot(snapshot, flags);
    }
    if (result < 0)
15152 15153
        goto cleanup;

E
Eric Blake 已提交
15154
    ret = true;
15155 15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166 15167 15168 15169 15170 15171 15172 15173 15174 15175

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")},
15176 15177
    {"snapshotname", VSH_OT_DATA, 0, N_("snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("delete current snapshot")},
15178
    {"children", VSH_OT_BOOL, 0, N_("delete snapshot and all children")},
15179 15180 15181
    {"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")},
15182 15183 15184
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
15185
static bool
15186 15187 15188
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
15189
    bool ret = false;
15190
    const char *name = NULL;
15191 15192 15193
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

15194
    if (!vshConnectionUsability(ctl, ctl->conn))
15195 15196 15197 15198 15199 15200
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

15201 15202
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", true, dom,
                          &snapshot, &name) < 0)
15203 15204 15205 15206
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;
15207 15208 15209 15210
    if (vshCommandOptBool(cmd, "children-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY;
    if (vshCommandOptBool(cmd, "metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY;
15211

15212 15213 15214
    /* 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.  */
15215
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
15216 15217 15218 15219
        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);
15220 15221
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
15222
        goto cleanup;
15223
    }
15224

E
Eric Blake 已提交
15225
    ret = true;
15226 15227 15228 15229 15230 15231 15232 15233 15234 15235

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

15236 15237 15238 15239
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
15240 15241
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
15242 15243 15244 15245 15246
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
15247
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
15248
    {"cmd", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("command")},
15249 15250 15251
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
15252
static bool
15253 15254 15255
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
15256
    bool ret = false;
15257
    char *monitor_cmd = NULL;
15258
    char *result = NULL;
15259
    unsigned int flags = 0;
15260 15261 15262
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
15263 15264 15265 15266 15267 15268 15269 15270

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

15271 15272 15273 15274 15275 15276 15277 15278
    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"));
15279 15280
        goto cleanup;
    }
15281
    monitor_cmd = virBufferContentAndReset(&buf);
15282

15283 15284 15285 15286
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
15287 15288 15289 15290
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
15291
    ret = true;
15292 15293 15294

cleanup:
    VIR_FREE(result);
15295
    VIR_FREE(monitor_cmd);
15296 15297 15298 15299 15300 15301
    if (dom)
        virDomainFree(dom);

    return ret;
}

15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 15312 15313 15314 15315 15316 15317 15318 15319 15320 15321 15322 15323 15324 15325 15326 15327 15328 15329 15330 15331 15332 15333 15334 15335 15336 15337 15338 15339 15340 15341 15342 15343 15344 15345 15346 15347
/*
 * "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;
}

15348
static const vshCmdDef domManagementCmds[] = {
15349 15350 15351 15352 15353 15354 15355
    {"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},
L
Lei Li 已提交
15356
    {"blkdeviotune", cmdBlkdeviotune, opts_blkdeviotune, info_blkdeviotune, 0},
15357
    {"blkiotune", cmdBlkiotune, opts_blkiotune, info_blkiotune, 0},
15358 15359
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
15360
    {"blockresize", cmdBlockResize, opts_block_resize, info_block_resize, 0},
15361
#ifndef WIN32
15362
    {"console", cmdConsole, opts_console, info_console, 0},
15363
#endif
15364 15365 15366 15367 15368 15369 15370 15371 15372 15373 15374
    {"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},
15375
    {"domif-setlink", cmdDomIfSetLink, opts_domif_setlink, info_domif_setlink, 0},
15376 15377 15378 15379 15380 15381 15382 15383 15384 15385 15386 15387
    {"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},
15388
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
15389 15390 15391 15392 15393 15394 15395 15396
    {"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},
15397 15398
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
15399 15400
    {"migrate-getspeed", cmdMigrateGetMaxSpeed,
     opts_migrate_getspeed, info_migrate_getspeed, 0},
H
Hu Tao 已提交
15401
    {"numatune", cmdNumatune, opts_numatune, info_numatune, 0},
15402
    {"reboot", cmdReboot, opts_reboot, info_reboot, 0},
X
Xu He Jie 已提交
15403
    {"reset", cmdReset, opts_reset, info_reset, 0},
15404 15405 15406
    {"restore", cmdRestore, opts_restore, info_restore, 0},
    {"resume", cmdResume, opts_resume, info_resume, 0},
    {"save", cmdSave, opts_save, info_save, 0},
15407 15408 15409 15410 15411 15412
    {"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},
15413
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
15414
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
15415 15416 15417 15418 15419 15420 15421 15422 15423 15424 15425 15426
    {"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 已提交
15427
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
15428
    {"version", cmdVersion, opts_version, info_version, 0},
15429 15430
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
15431 15432 15433
};

static const vshCmdDef domMonitoringCmds[] = {
15434
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
15435
    {"domblklist", cmdDomblklist, opts_domblklist, info_domblklist, 0},
15436
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
15437
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
15438
    {"domif-getlink", cmdDomIfGetLink, opts_domif_getlink, info_domif_getlink, 0},
15439 15440 15441 15442 15443 15444
    {"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}
15445 15446 15447
};

static const vshCmdDef storagePoolCmds[] = {
15448
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
15449
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
15450
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
15451 15452 15453 15454 15455 15456 15457 15458 15459 15460 15461 15462 15463 15464 15465 15466 15467 15468 15469 15470 15471
     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}
15472 15473 15474
};

static const vshCmdDef storageVolCmds[] = {
15475 15476 15477 15478 15479 15480 15481 15482 15483 15484 15485 15486 15487 15488 15489 15490 15491 15492
    {"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}
15493
};
15494

15495
static const vshCmdDef networkCmds[] = {
15496 15497 15498 15499 15500 15501 15502 15503 15504 15505 15506 15507 15508 15509 15510 15511 15512 15513 15514
    {"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}
15515
};
15516

15517
static const vshCmdDef nodedevCmds[] = {
15518 15519 15520 15521 15522 15523 15524 15525 15526 15527 15528 15529 15530 15531 15532
    {"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}
15533 15534 15535
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
15536 15537
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
15538 15539
    {"iface-bridge", cmdInterfaceBridge, opts_interface_bridge,
     info_interface_bridge, 0},
E
Eric Blake 已提交
15540 15541
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
15542 15543 15544 15545 15546 15547 15548 15549 15550 15551 15552 15553 15554 15555
    {"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 已提交
15556 15557
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
15558 15559
    {"iface-start", cmdInterfaceStart, opts_interface_start,
     info_interface_start, 0},
15560 15561
    {"iface-unbridge", cmdInterfaceUnbridge, opts_interface_unbridge,
     info_interface_unbridge, 0},
15562 15563 15564
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine,
     info_interface_undefine, 0},
    {NULL, NULL, NULL, NULL, 0}
15565
};
15566

15567
static const vshCmdDef nwfilterCmds[] = {
15568 15569 15570 15571 15572 15573 15574 15575 15576 15577 15578
    {"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}
15579
};
15580

15581
static const vshCmdDef secretCmds[] = {
15582 15583 15584 15585 15586 15587 15588 15589 15590 15591 15592 15593
    {"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}
15594
};
15595

15596
static const vshCmdDef virshCmds[] = {
15597 15598 15599 15600 15601 15602 15603
    {"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}
15604
};
15605

15606
static const vshCmdDef snapshotCmds[] = {
15607 15608
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
15609 15610
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
15611 15612 15613 15614 15615 15616
    {"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},
15617 15618
    {"snapshot-edit", cmdSnapshotEdit, opts_snapshot_edit,
     info_snapshot_edit, 0},
15619 15620
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
E
Eric Blake 已提交
15621 15622
    {"snapshot-parent", cmdSnapshotParent, opts_snapshot_parent,
     info_snapshot_parent, 0},
15623 15624 15625
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
15626
};
15627

15628
static const vshCmdDef hostAndHypervisorCmds[] = {
15629 15630 15631 15632 15633
    {"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},
15634
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
15635
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
15636
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
15637
    {"nodesuspend", cmdNodeSuspend, opts_node_suspend, info_nodesuspend, 0},
15638
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
15639 15640 15641 15642 15643
    {"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 已提交
15644 15645
};

15646 15647 15648 15649 15650 15651 15652 15653 15654 15655 15656 15657 15658 15659 15660 15661 15662
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 已提交
15663 15664 15665 15666
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
15667
static const char *
15668
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
15669
{
15670
    const vshCmdInfo *info;
15671

K
Karel Zak 已提交
15672
    for (info = cmd->info; info && info->name; info++) {
15673
        if (STREQ(info->name, name))
K
Karel Zak 已提交
15674 15675 15676 15677 15678
            return info->data;
    }
    return NULL;
}

15679
/* Validate that the options associated with cmd can be parsed.  */
15680
static int
E
Eric Blake 已提交
15681
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
15682 15683 15684 15685 15686
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
15687 15688 15689
    *opts_need_arg = 0;
    *opts_required = 0;

15690 15691 15692 15693 15694 15695 15696 15697 15698
    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 已提交
15699
            if (opt->flags & VSH_OFLAG_REQ)
15700 15701 15702
                return -1; /* bool options can't be mandatory */
            continue;
        }
E
Eric Blake 已提交
15703 15704
        if (opt->flags & VSH_OFLAG_REQ_OPT) {
            if (opt->flags & VSH_OFLAG_REQ)
L
Lai Jiangshan 已提交
15705 15706 15707 15708
                *opts_required |= 1 << i;
            continue;
        }

15709
        *opts_need_arg |= 1 << i;
E
Eric Blake 已提交
15710
        if (opt->flags & VSH_OFLAG_REQ) {
15711 15712 15713 15714 15715 15716
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
15717 15718 15719

        if (opt->type == VSH_OT_ARGV && cmd->opts[i + 1].name)
            return -1; /* argv option must be listed last */
15720 15721 15722 15723
    }
    return 0;
}

15724
static const vshCmdOptDef *
15725
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
15726
                   uint32_t *opts_seen, int *opt_index)
15727
{
15728 15729 15730 15731
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
15732

15733
        if (STREQ(opt->name, name)) {
15734
            if ((*opts_seen & (1 << i)) && opt->type != VSH_OT_ARGV) {
15735 15736 15737
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
15738 15739
            *opts_seen |= 1 << i;
            *opt_index = i;
K
Karel Zak 已提交
15740
            return opt;
15741 15742 15743 15744 15745
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
15746 15747 15748
    return NULL;
}

15749
static const vshCmdOptDef *
15750 15751
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
15752
{
15753
    int i;
15754
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
15755

15756 15757 15758 15759
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
15760
    i = ffs(*opts_need_arg) - 1;
15761
    opt = &cmd->opts[i];
15762
    if (opt->type != VSH_OT_ARGV)
15763
        *opts_need_arg &= ~(1 << i);
15764
    *opts_seen |= 1 << i;
15765
    return opt;
K
Karel Zak 已提交
15766 15767
}

15768 15769 15770
/*
 * Checks for required options
 */
15771
static int
15772 15773
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
15774
{
15775
    const vshCmdDef *def = cmd->def;
15776 15777 15778 15779 15780 15781 15782 15783 15784
    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];
15785

15786
            vshError(ctl,
15787
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
15788 15789 15790
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
15791 15792
        }
    }
15793
    return -1;
15794 15795
}

15796
static const vshCmdDef *
15797 15798
vshCmddefSearch(const char *cmdname)
{
15799
    const vshCmdGrp *g;
15800
    const vshCmdDef *c;
15801

15802 15803
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
15804
            if (STREQ(c->name, cmdname))
15805 15806 15807 15808
                return c;
        }
    }

K
Karel Zak 已提交
15809 15810 15811
    return NULL;
}

15812 15813 15814 15815 15816 15817
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
15818
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
15819 15820 15821 15822 15823 15824
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
15825
static bool
15826 15827 15828 15829 15830 15831 15832
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 已提交
15833
        return false;
15834 15835 15836 15837 15838 15839 15840 15841 15842 15843
    } 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 已提交
15844
    return true;
15845 15846
}

E
Eric Blake 已提交
15847
static bool
15848
vshCmddefHelp(vshControl *ctl, const char *cmdname)
15849
{
15850
    const vshCmdDef *def = vshCmddefSearch(cmdname);
15851

K
Karel Zak 已提交
15852
    if (!def) {
15853
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
15854
        return false;
15855
    } else {
E
Eric Blake 已提交
15856 15857
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
15858
        const char *help = _(vshCmddefGetInfo(def, "help"));
15859
        char buf[256];
15860 15861
        uint32_t opts_need_arg;
        uint32_t opts_required;
15862
        bool shortopt = false; /* true if 'arg' works instead of '--opt arg' */
15863 15864 15865 15866

        if (vshCmddefOptParse(def, &opts_need_arg, &opts_required)) {
            vshError(ctl, _("internal error: bad options in command: '%s'"),
                     def->name);
E
Eric Blake 已提交
15867
            return false;
15868
        }
K
Karel Zak 已提交
15869

15870
        fputs(_("  NAME\n"), stdout);
15871 15872
        fprintf(stdout, "    %s - %s\n", def->name, help);

15873 15874 15875 15876 15877
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
15878
                const char *fmt = "%s";
15879 15880
                switch (opt->type) {
                case VSH_OT_BOOL:
15881
                    fmt = "[--%s]";
15882 15883
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
15884
                    /* xgettext:c-format */
E
Eric Blake 已提交
15885
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>"
15886
                           : _("[--%s <number>]"));
15887 15888
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
15889 15890
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
15891 15892
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
15893 15894
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
15895 15896
                    break;
                case VSH_OT_DATA:
E
Eric Blake 已提交
15897
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
15898 15899
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
15900 15901 15902
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
15903 15904 15905 15906 15907 15908 15909 15910
                    if (shortopt) {
                        fmt = (opt->flags & VSH_OFLAG_REQ)
                            ? _("{[--%s] <string>}...")
                            : _("[[--%s] <string>]...");
                    } else {
                        fmt = (opt->flags & VSH_OFLAG_REQ) ? _("<%s>...")
                            : _("[<%s>]...");
                    }
15911 15912
                    break;
                default:
15913
                    assert(0);
15914
                }
15915
                fputc(' ', stdout);
E
Eric Blake 已提交
15916
                fprintf(stdout, fmt, opt->name);
15917
            }
K
Karel Zak 已提交
15918
        }
15919 15920 15921
        fputc('\n', stdout);

        if (desc[0]) {
15922
            /* Print the description only if it's not empty.  */
15923
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
15924
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
15925
        }
15926

K
Karel Zak 已提交
15927
        if (def->opts) {
15928
            const vshCmdOptDef *opt;
15929
            fputs(_("\n  OPTIONS\n"), stdout);
15930
            for (opt = def->opts; opt->name; opt++) {
15931 15932
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
15933
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
15934 15935
                    break;
                case VSH_OT_INT:
15936
                    snprintf(buf, sizeof(buf),
E
Eric Blake 已提交
15937
                             (opt->flags & VSH_OFLAG_REQ) ? _("[--%s] <number>")
15938
                             : _("--%s <number>"), opt->name);
15939 15940
                    break;
                case VSH_OT_STRING:
15941
                    /* OT_STRING should never be VSH_OFLAG_REQ */
15942
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
15943 15944
                    break;
                case VSH_OT_DATA:
15945 15946
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
15947 15948
                    break;
                case VSH_OT_ARGV:
15949 15950 15951
                    snprintf(buf, sizeof(buf),
                             shortopt ? _("[--%s] <string>") : _("<%s>"),
                             opt->name);
15952
                    break;
15953 15954 15955
                default:
                    assert(0);
                }
15956

E
Eric Blake 已提交
15957
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
15958
            }
K
Karel Zak 已提交
15959 15960 15961
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
15962
    return true;
K
Karel Zak 已提交
15963 15964 15965 15966 15967 15968
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
15969 15970 15971
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
15972 15973
    vshCmdOpt *a = arg;

15974
    while (a) {
K
Karel Zak 已提交
15975
        vshCmdOpt *tmp = a;
15976

K
Karel Zak 已提交
15977 15978
        a = a->next;

15979 15980
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
15981 15982 15983 15984
    }
}

static void
15985
vshCommandFree(vshCmd *cmd)
15986
{
K
Karel Zak 已提交
15987 15988
    vshCmd *c = cmd;

15989
    while (c) {
K
Karel Zak 已提交
15990
        vshCmd *tmp = c;
15991

K
Karel Zak 已提交
15992 15993 15994 15995
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
15996
        VIR_FREE(tmp);
K
Karel Zak 已提交
15997 15998 15999
    }
}

E
Eric Blake 已提交
16000 16001 16002 16003 16004 16005 16006 16007 16008 16009 16010
/**
 * 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 已提交
16011
 */
E
Eric Blake 已提交
16012 16013
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
16014
{
E
Eric Blake 已提交
16015 16016
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
16017

E
Eric Blake 已提交
16018 16019 16020 16021 16022 16023 16024
    /* 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 已提交
16025
    }
E
Eric Blake 已提交
16026 16027 16028 16029 16030 16031 16032

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
E
Eric Blake 已提交
16033
            return (valid->flags & VSH_OFLAG_REQ) == 0 ? 0 : -1;
E
Eric Blake 已提交
16034 16035 16036 16037
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
16038 16039
}

E
Eric Blake 已提交
16040 16041
/**
 * vshCommandOptInt:
16042 16043 16044 16045 16046 16047 16048
 * @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 已提交
16049
 * 0 if option not found and not required (@value untouched)
16050
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
16051 16052
 */
static int
16053
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
16054
{
E
Eric Blake 已提交
16055 16056 16057
    vshCmdOpt *arg;
    int ret;
    int num;
16058
    char *end_p = NULL;
16059

E
Eric Blake 已提交
16060 16061 16062 16063 16064 16065 16066
    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;
16067
    }
E
Eric Blake 已提交
16068 16069 16070 16071 16072 16073 16074

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
16075 16076
}

16077

E
Eric Blake 已提交
16078 16079 16080 16081 16082 16083
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
16084 16085 16086 16087 16088 16089
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
16090 16091 16092
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
16093 16094
    char *end_p = NULL;

E
Eric Blake 已提交
16095 16096 16097 16098 16099 16100 16101
    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;
16102
    }
E
Eric Blake 已提交
16103 16104 16105 16106 16107 16108 16109

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
16110 16111 16112
}


16113
/*
E
Eric Blake 已提交
16114 16115 16116 16117 16118
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
16119 16120 16121 16122 16123
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
16124
{
E
Eric Blake 已提交
16125 16126
    vshCmdOpt *arg;
    int ret;
16127
    unsigned long num;
16128 16129
    char *end_p = NULL;

E
Eric Blake 已提交
16130 16131 16132 16133 16134 16135 16136
    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;
16137
    }
E
Eric Blake 已提交
16138 16139 16140 16141 16142 16143 16144

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
16145 16146
}

E
Eric Blake 已提交
16147 16148 16149 16150 16151 16152
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
16153
 * Returns option as STRING
E
Eric Blake 已提交
16154 16155 16156 16157
 * 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 已提交
16158
 */
16159 16160
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
16161
{
E
Eric Blake 已提交
16162 16163 16164 16165 16166 16167 16168 16169 16170 16171
    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;
16172
    }
16173

E
Eric Blake 已提交
16174
    if (!*arg->data && !(arg->def->flags & VSH_OFLAG_EMPTY_OK)) {
E
Eric Blake 已提交
16175 16176 16177 16178
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
16179 16180
}

E
Eric Blake 已提交
16181 16182 16183 16184 16185 16186
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
16187
 * Returns option as long long
16188
 * See vshCommandOptInt()
16189
 */
16190 16191 16192
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
16193
{
E
Eric Blake 已提交
16194 16195
    vshCmdOpt *arg;
    int ret;
16196
    long long num;
16197 16198
    char *end_p = NULL;

E
Eric Blake 已提交
16199 16200 16201 16202 16203 16204 16205
    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;
16206
    }
E
Eric Blake 已提交
16207 16208 16209 16210 16211 16212 16213

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
16214 16215
}

E
Eric Blake 已提交
16216 16217 16218 16219 16220 16221 16222 16223 16224
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
16225 16226 16227 16228
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
16229 16230
    vshCmdOpt *arg;
    int ret;
16231 16232 16233
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
16234 16235 16236 16237 16238 16239 16240
    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;
16241
    }
E
Eric Blake 已提交
16242 16243 16244 16245 16246 16247 16248

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
16249 16250 16251
}


E
Eric Blake 已提交
16252 16253 16254 16255 16256 16257 16258 16259 16260
/**
 * 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 已提交
16261
 */
E
Eric Blake 已提交
16262
static bool
16263
vshCommandOptBool(const vshCmd *cmd, const char *name)
16264
{
E
Eric Blake 已提交
16265 16266 16267
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
16268 16269
}

E
Eric Blake 已提交
16270 16271 16272 16273 16274
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
16275 16276
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
16277
 *
16278
 * Requires that a VSH_OT_ARGV option be last in the
16279 16280
 * list of supported options in CMD->def->opts.
 */
16281 16282
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
16283
{
16284
    opt = opt ? opt->next : cmd->opts;
16285 16286

    while (opt) {
E
Eric Blake 已提交
16287
        if (opt->def->type == VSH_OT_ARGV) {
16288
            return opt;
16289 16290 16291 16292 16293 16294
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
16295 16296 16297 16298 16299 16300 16301 16302 16303 16304 16305 16306 16307 16308 16309 16310 16311 16312
/* 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)
16313
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
16314 16315 16316
                 cmd->def->name, optname);
    return found;
}
16317

K
Karel Zak 已提交
16318
static virDomainPtr
J
Jim Meyering 已提交
16319
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
16320
                      const char **name, int flag)
16321
{
K
Karel Zak 已提交
16322
    virDomainPtr dom = NULL;
16323
    const char *n = NULL;
K
Karel Zak 已提交
16324
    int id;
J
Jim Meyering 已提交
16325 16326 16327
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
16328

16329
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16330 16331
        return NULL;

16332
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16333 16334
             cmd->def->name, optname, n);

K
Karel Zak 已提交
16335 16336
    if (name)
        *name = n;
16337

K
Karel Zak 已提交
16338
    /* try it by ID */
16339
    if (flag & VSH_BYID) {
16340
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
16341 16342
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
16343 16344 16345
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
16346
    }
K
Karel Zak 已提交
16347
    /* try it by UUID */
16348
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
16349
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
16350
                 cmd->def->name, optname);
K
Karel Zak 已提交
16351
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
16352
    }
K
Karel Zak 已提交
16353
    /* try it by NAME */
16354
    if (dom==NULL && (flag & VSH_BYNAME)) {
16355
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
16356
                 cmd->def->name, optname);
K
Karel Zak 已提交
16357
        dom = virDomainLookupByName(ctl->conn, n);
16358
    }
K
Karel Zak 已提交
16359

16360
    if (!dom)
16361
        vshError(ctl, _("failed to get domain '%s'"), n);
16362

K
Karel Zak 已提交
16363 16364 16365
    return dom;
}

16366
static virNetworkPtr
J
Jim Meyering 已提交
16367
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
16368
                       const char **name, int flag)
16369 16370
{
    virNetworkPtr network = NULL;
16371
    const char *n = NULL;
J
Jim Meyering 已提交
16372 16373 16374
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
16375

16376
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16377 16378
        return NULL;

16379
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16380 16381 16382 16383 16384 16385
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
16386
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
16387
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
16388
                 cmd->def->name, optname);
16389 16390 16391 16392
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
16393
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
16394 16395 16396 16397 16398
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
16399
        vshError(ctl, _("failed to get network '%s'"), n);
16400 16401 16402 16403

    return network;
}

16404 16405 16406

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
16407
                        const char **name, int flag)
16408 16409
{
    virNWFilterPtr nwfilter = NULL;
16410
    const char *n = NULL;
16411 16412 16413 16414
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

16415
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16416 16417
        return NULL;

16418
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16419 16420 16421 16422 16423 16424 16425
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
16426
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
16427 16428 16429 16430 16431
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
16432
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
16433 16434 16435 16436 16437 16438 16439 16440 16441 16442
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

16443 16444
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
16445
                         const char *optname,
16446
                         const char **name, int flag)
16447 16448
{
    virInterfacePtr iface = NULL;
16449
    const char *n = NULL;
16450 16451 16452

    if (!optname)
       optname = "interface";
16453 16454 16455
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

16456
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16457 16458
        return NULL;

16459
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16460 16461 16462 16463 16464 16465
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
16466
    if ((flag & VSH_BYNAME)) {
16467
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
16468 16469 16470 16471 16472
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
16473
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
16474 16475 16476 16477 16478
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
16479
        vshError(ctl, _("failed to get interface '%s'"), n);
16480 16481 16482 16483

    return iface;
}

16484
static virStoragePoolPtr
16485
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
16486
                    const char **name, int flag)
16487 16488
{
    virStoragePoolPtr pool = NULL;
16489
    const char *n = NULL;
16490

16491
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16492 16493
        return NULL;

16494
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16495 16496 16497 16498 16499 16500
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
16501
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
16502
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
16503
                 cmd->def->name, optname);
16504 16505 16506
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
16507
    if (pool == NULL && (flag & VSH_BYNAME)) {
16508
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
16509 16510 16511 16512 16513
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
16514
        vshError(ctl, _("failed to get pool '%s'"), n);
16515 16516 16517 16518 16519

    return pool;
}

static virStorageVolPtr
16520
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
16521 16522
                   const char *optname,
                   const char *pooloptname,
16523
                   const char **name, int flag)
16524 16525 16526
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
16527
    const char *n = NULL, *p = NULL;
16528

16529
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16530 16531
        return NULL;

16532
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
16533
        vshError(ctl, "%s", _("missing option"));
16534
        return NULL;
16535
    }
16536 16537 16538 16539

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

16540
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
16541 16542 16543 16544 16545
             cmd->def->name, optname, n);

    if (name)
        *name = n;

16546
    /* try it by name */
16547
    if (pool && (flag & VSH_BYNAME)) {
16548
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
16549 16550 16551
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
16552
    /* try it by key */
16553
    if (vol == NULL && (flag & VSH_BYUUID)) {
16554
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
16555 16556 16557
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
16558
    /* try it by path */
16559
    if (vol == NULL && (flag & VSH_BYUUID)) {
16560
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
16561 16562 16563 16564
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

16565 16566 16567 16568
    if (!vol) {
        if (pool)
            vshError(ctl, _("failed to get vol '%s'"), n);
        else
16569 16570
            vshError(ctl, _("failed to get vol '%s', specifying --%s "
                            "might help"), n, pooloptname);
16571
    }
16572 16573 16574 16575 16576 16577 16578

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

16579
static virSecretPtr
16580
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
16581 16582
{
    virSecretPtr secret = NULL;
16583
    const char *n = NULL;
16584 16585 16586 16587 16588
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

16589
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16590 16591
        return NULL;

16592 16593
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
16594 16595 16596 16597 16598 16599 16600

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
16601
        vshError(ctl, _("failed to get secret '%s'"), n);
16602 16603 16604 16605

    return secret;
}

K
Karel Zak 已提交
16606 16607 16608
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
16609
static bool
16610
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
16611
{
E
Eric Blake 已提交
16612
    bool ret = true;
16613 16614

    while (cmd) {
K
Karel Zak 已提交
16615
        struct timeval before, after;
16616
        bool enable_timing = ctl->timing;
16617

16618 16619
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
16620 16621
            vshReconnect(ctl);

16622
        if (enable_timing)
K
Karel Zak 已提交
16623
            GETTIMEOFDAY(&before);
16624

K
Karel Zak 已提交
16625 16626
        ret = cmd->def->handler(ctl, cmd);

16627
        if (enable_timing)
K
Karel Zak 已提交
16628
            GETTIMEOFDAY(&after);
16629

16630
        if (!ret)
J
John Levon 已提交
16631 16632
            virshReportError(ctl);

16633
        /* try to automatically catch disconnections */
16634
        if (!ret &&
16635 16636 16637 16638 16639 16640 16641 16642 16643
            ((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);

16644
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
16645 16646
            return ret;

16647
        if (enable_timing)
16648
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
16649 16650
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
16651
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
16652 16653 16654 16655 16656 16657
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
16658
 * Command parsing
K
Karel Zak 已提交
16659 16660 16661
 * ---------------
 */

16662 16663 16664 16665 16666 16667 16668 16669 16670 16671
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 已提交
16672
    /* vshCommandStringGetArg() */
16673
    char *pos;
L
Lai Jiangshan 已提交
16674 16675 16676
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
16677 16678
} vshCommandParser;

E
Eric Blake 已提交
16679
static bool
16680
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
16681
{
K
Karel Zak 已提交
16682 16683 16684
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
16685

K
Karel Zak 已提交
16686 16687 16688 16689
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
16690

16691
    while (1) {
K
Karel Zak 已提交
16692
        vshCmdOpt *last = NULL;
16693
        const vshCmdDef *cmd = NULL;
16694
        vshCommandToken tk;
L
Lai Jiangshan 已提交
16695
        bool data_only = false;
16696 16697 16698
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
16699

K
Karel Zak 已提交
16700
        first = NULL;
16701

16702
        while (1) {
16703
            const vshCmdOptDef *opt = NULL;
16704

K
Karel Zak 已提交
16705
            tkdata = NULL;
16706
            tk = parser->getNextArg(ctl, parser, &tkdata);
16707 16708

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
16709
                goto syntaxError;
H
Hu Tao 已提交
16710 16711
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
16712
                break;
H
Hu Tao 已提交
16713
            }
16714 16715

            if (cmd == NULL) {
K
Karel Zak 已提交
16716 16717
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
16718
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
16719
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
16720
                }
16721 16722 16723 16724 16725 16726 16727
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
16728
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
16729 16730 16731 16732
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
16733
                char *optstr = strchr(tkdata + 2, '=');
16734 16735
                int opt_index;

16736 16737 16738 16739
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
16740
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
16741
                                               &opts_seen, &opt_index))) {
16742
                    VIR_FREE(optstr);
K
Karel Zak 已提交
16743 16744
                    goto syntaxError;
                }
16745
                VIR_FREE(tkdata);
K
Karel Zak 已提交
16746 16747 16748

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
16749 16750 16751
                    if (optstr)
                        tkdata = optstr;
                    else
16752
                        tk = parser->getNextArg(ctl, parser, &tkdata);
16753
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
16754
                        goto syntaxError;
16755
                    if (tk != VSH_TK_ARG) {
16756
                        vshError(ctl,
16757
                                 _("expected syntax: --%s <%s>"),
16758 16759
                                 opt->name,
                                 opt->type ==
16760
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
16761 16762
                        goto syntaxError;
                    }
16763 16764
                    if (opt->type != VSH_OT_ARGV)
                        opts_need_arg &= ~(1 << opt_index);
16765 16766 16767 16768 16769 16770 16771 16772
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
16773
                }
L
Lai Jiangshan 已提交
16774 16775 16776 16777
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
16778
            } else {
L
Lai Jiangshan 已提交
16779
get_data:
16780 16781
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
16782
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
16783 16784 16785 16786 16787
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
16788
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
16789

K
Karel Zak 已提交
16790 16791 16792 16793
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
16794

K
Karel Zak 已提交
16795 16796 16797 16798 16799
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
16800

16801
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
16802 16803
                         cmd->name,
                         opt->name,
16804 16805
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
16806 16807
            }
        }
16808

D
Daniel Veillard 已提交
16809
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
16810
        if (cmd) {
16811
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
16812

K
Karel Zak 已提交
16813 16814 16815 16816
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

16817
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
16818
                VIR_FREE(c);
16819
                goto syntaxError;
16820
            }
16821

K
Karel Zak 已提交
16822 16823 16824 16825 16826 16827
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
16828 16829 16830

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
16831
    }
16832

E
Eric Blake 已提交
16833
    return true;
K
Karel Zak 已提交
16834

16835
 syntaxError:
16836
    if (ctl->cmd) {
K
Karel Zak 已提交
16837
        vshCommandFree(ctl->cmd);
16838 16839
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
16840 16841
    if (first)
        vshCommandOptFree(first);
16842
    VIR_FREE(tkdata);
E
Eric Blake 已提交
16843
    return false;
K
Karel Zak 已提交
16844 16845
}

16846 16847 16848 16849 16850 16851 16852 16853 16854 16855 16856 16857 16858 16859 16860 16861 16862 16863
/* --------------------
 * 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 已提交
16864 16865
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
16866 16867 16868 16869
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
16870
        return false;
16871 16872 16873 16874 16875 16876 16877 16878 16879 16880 16881 16882 16883 16884 16885 16886 16887 16888 16889 16890 16891 16892 16893 16894 16895 16896 16897 16898 16899 16900 16901 16902 16903 16904 16905 16906 16907 16908 16909 16910 16911 16912 16913 16914 16915 16916 16917 16918 16919 16920 16921 16922 16923 16924 16925 16926 16927 16928 16929 16930 16931 16932 16933 16934 16935 16936 16937 16938 16939 16940 16941 16942

    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 已提交
16943 16944
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
16945 16946 16947 16948
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
16949
        return false;
16950 16951 16952 16953 16954 16955

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
16956
/* ---------------
16957
 * Misc utils
K
Karel Zak 已提交
16958 16959
 * ---------------
 */
16960 16961 16962 16963 16964 16965 16966 16967 16968 16969 16970 16971 16972 16973 16974 16975 16976 16977 16978 16979 16980 16981 16982 16983 16984 16985 16986 16987
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 已提交
16988
static const char *
16989 16990
vshDomainStateToString(int state)
{
16991 16992
    /* Can't use virDomainStateTypeToString, because we want to mark
     * strings for translation.  */
16993
    switch ((virDomainState) state) {
16994
    case VIR_DOMAIN_RUNNING:
16995
        return N_("running");
16996
    case VIR_DOMAIN_BLOCKED:
16997
        return N_("idle");
16998
    case VIR_DOMAIN_PAUSED:
16999
        return N_("paused");
17000
    case VIR_DOMAIN_SHUTDOWN:
17001
        return N_("in shutdown");
17002
    case VIR_DOMAIN_SHUTOFF:
17003
        return N_("shut off");
17004
    case VIR_DOMAIN_CRASHED:
17005
        return N_("crashed");
17006
    case VIR_DOMAIN_NOSTATE:
17007
    default:
17008
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
17009
    }
17010
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
17011 17012
}

17013 17014 17015 17016 17017 17018 17019 17020 17021 17022 17023 17024 17025 17026 17027 17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 17044 17045 17046 17047 17048 17049 17050 17051 17052 17053 17054 17055 17056 17057 17058 17059 17060 17061 17062 17063 17064 17065 17066 17067
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");
17068 17069
        case VIR_DOMAIN_PAUSED_SHUTTING_DOWN:
            return N_("shutting down");
17070 17071 17072 17073 17074 17075 17076 17077 17078 17079 17080 17081 17082 17083 17084 17085 17086 17087 17088 17089 17090 17091 17092 17093 17094 17095 17096 17097 17098 17099 17100 17101 17102 17103 17104 17105 17106 17107 17108 17109 17110
        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;
17111 17112 17113

    default:
        ;
17114 17115 17116 17117 17118
    }

    return N_("unknown");
}

17119 17120
/* Return a non-NULL string representation of a typed parameter; exit
 * if we are out of memory.  */
17121 17122 17123 17124 17125 17126 17127 17128 17129 17130 17131 17132 17133 17134 17135 17136 17137 17138 17139 17140 17141 17142 17143 17144 17145 17146 17147 17148 17149 17150 17151
static char *
vshGetTypedParamValue(vshControl *ctl, virTypedParameterPtr item)
{
    int ret = 0;
    char *str = NULL;

    switch(item->type) {
    case VIR_TYPED_PARAM_INT:
        ret = virAsprintf(&str, "%d", item->value.i);
        break;

    case VIR_TYPED_PARAM_UINT:
        ret = virAsprintf(&str, "%u", item->value.ui);
        break;

    case VIR_TYPED_PARAM_LLONG:
        ret = virAsprintf(&str, "%lld", item->value.l);
        break;

    case VIR_TYPED_PARAM_ULLONG:
        ret = virAsprintf(&str, "%llu", item->value.ul);
        break;

    case VIR_TYPED_PARAM_DOUBLE:
        ret = virAsprintf(&str, "%f", item->value.d);
        break;

    case VIR_TYPED_PARAM_BOOLEAN:
        ret = virAsprintf(&str, "%s", item->value.b ? _("yes") : _("no"));
        break;

17152 17153 17154 17155
    case VIR_TYPED_PARAM_STRING:
        str = vshStrdup(ctl, item->value.s);
        break;

17156
    default:
17157
        vshError(ctl, _("unimplemented parameter type %d"), item->type);
17158 17159
    }

17160
    if (ret < 0) {
17161
        vshError(ctl, "%s", _("Out of memory"));
17162 17163
        exit(EXIT_FAILURE);
    }
17164 17165 17166 17167 17168 17169 17170 17171 17172 17173 17174 17175 17176 17177 17178 17179 17180 17181 17182 17183 17184 17185 17186
    return str;
}

static virTypedParameterPtr
vshFindTypedParamByName(const char *name, virTypedParameterPtr list, int count)
{
    int i = count;
    virTypedParameterPtr found = list;

    if (!list || !name)
        return NULL;

    while (i-- > 0) {
        if (STREQ(name, found->field))
            return found;

        found++; /* go to next struct in array */
    }

    /* not found */
    return NULL;
}

17187 17188 17189 17190 17191 17192 17193 17194 17195 17196 17197 17198 17199 17200 17201 17202 17203
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");
}

17204 17205 17206 17207
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
17208
    case VIR_VCPU_OFFLINE:
17209
        return N_("offline");
17210
    case VIR_VCPU_BLOCKED:
17211
        return N_("idle");
17212
    case VIR_VCPU_RUNNING:
17213
        return N_("running");
17214
    default:
17215
        ;/*FALLTHROUGH*/
17216
    }
17217
    return N_("no state");
17218 17219
}

E
Eric Blake 已提交
17220
static bool
17221
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
17222
{
17223 17224
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
17225 17226
     */
    if (!conn) {
17227
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
17228
        return false;
K
Karel Zak 已提交
17229
    }
E
Eric Blake 已提交
17230
    return true;
K
Karel Zak 已提交
17231 17232
}

K
Karel Zak 已提交
17233
static void
17234
vshDebug(vshControl *ctl, int level, const char *format, ...)
17235
{
K
Karel Zak 已提交
17236
    va_list ap;
17237
    char *str;
K
Karel Zak 已提交
17238

17239 17240 17241 17242 17243 17244 17245
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

17246
    va_start(ap, format);
17247
    vshOutputLogFile(ctl, level, format, ap);
17248 17249
    va_end(ap);

K
Karel Zak 已提交
17250
    va_start(ap, format);
17251 17252 17253 17254 17255
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
17256
    va_end(ap);
17257 17258
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
17259 17260 17261
}

static void
17262
vshPrintExtra(vshControl *ctl, const char *format, ...)
17263
{
K
Karel Zak 已提交
17264
    va_list ap;
17265
    char *str;
17266

17267
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
17268
        return;
17269

K
Karel Zak 已提交
17270
    va_start(ap, format);
17271 17272 17273 17274 17275
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
17276
    va_end(ap);
17277
    fputs(str, stdout);
17278
    VIR_FREE(str);
K
Karel Zak 已提交
17279 17280
}

K
Karel Zak 已提交
17281

K
Karel Zak 已提交
17282
static void
17283
vshError(vshControl *ctl, const char *format, ...)
17284
{
K
Karel Zak 已提交
17285
    va_list ap;
17286
    char *str;
17287

17288 17289 17290 17291 17292
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
17293

17294 17295 17296 17297
    /* 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);
17298
    fputs(_("error: "), stderr);
17299

K
Karel Zak 已提交
17300
    va_start(ap, format);
17301 17302 17303
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
17304 17305
    va_end(ap);

17306
    fprintf(stderr, "%s\n", NULLSTR(str));
17307
    fflush(stderr);
17308
    VIR_FREE(str);
K
Karel Zak 已提交
17309 17310
}

17311

J
Jiri Denemark 已提交
17312 17313 17314 17315 17316
static void
vshEventLoop(void *opaque)
{
    vshControl *ctl = opaque;

17317 17318 17319 17320 17321 17322 17323 17324 17325 17326
    while (1) {
        bool quit;
        virMutexLock(&ctl->lock);
        quit = ctl->quit;
        virMutexUnlock(&ctl->lock);

        if (quit)
            break;

        if (virEventRunDefaultImpl() < 0)
J
Jiri Denemark 已提交
17327 17328 17329 17330 17331
            virshReportError(ctl);
    }
}


K
Karel Zak 已提交
17332
/*
17333
 * Initialize connection.
K
Karel Zak 已提交
17334
 */
E
Eric Blake 已提交
17335
static bool
17336
vshInit(vshControl *ctl)
17337
{
17338 17339
    char *debugEnv;

K
Karel Zak 已提交
17340
    if (ctl->conn)
E
Eric Blake 已提交
17341
        return false;
K
Karel Zak 已提交
17342

J
Jiri Denemark 已提交
17343
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
17344 17345 17346
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
17347 17348 17349
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
17350 17351
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
17352 17353
            } else {
                ctl->debug = debug;
17354 17355 17356 17357 17358 17359 17360 17361 17362 17363 17364 17365
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

17366 17367
    vshOpenLogFile(ctl);

17368 17369
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
17370

17371 17372 17373
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

17374
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
17375
        return false;
17376

J
Jiri Denemark 已提交
17377 17378 17379 17380
    if (virThreadCreate(&ctl->eventLoop, true, vshEventLoop, ctl) < 0)
        return false;
    ctl->eventLoopStarted = true;

17381 17382 17383 17384
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
17385

17386 17387 17388 17389 17390 17391 17392 17393 17394 17395 17396
        /* 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;
        }
17397
    }
K
Karel Zak 已提交
17398

E
Eric Blake 已提交
17399
    return true;
K
Karel Zak 已提交
17400 17401
}

17402 17403
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

17404 17405 17406 17407 17408 17409 17410 17411 17412 17413 17414 17415 17416 17417 17418 17419 17420 17421 17422
/**
 * 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:
17423
                vshError(ctl, "%s",
J
Jim Meyering 已提交
17424
                         _("failed to get the log file information"));
17425
                exit(EXIT_FAILURE);
17426 17427 17428
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
17429 17430
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
17431 17432 17433 17434
        }
    }

    /* log file open */
17435
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
17436
        vshError(ctl, "%s",
J
Jim Meyering 已提交
17437
                 _("failed to open the log file. check the log file path"));
17438
        exit(EXIT_FAILURE);
17439 17440 17441 17442 17443 17444 17445 17446 17447
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
17448 17449
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
17450
{
17451 17452 17453
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
17454 17455 17456 17457 17458 17459 17460 17461 17462 17463 17464 17465 17466 17467
    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);
17468
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
17469 17470 17471 17472 17473 17474
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
17475 17476
                      SIGN_NAME,
                      (int) getpid());
17477 17478 17479 17480 17481 17482 17483 17484 17485 17486 17487 17488 17489 17490 17491 17492 17493 17494 17495 17496
    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;
    }
17497 17498 17499
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
17500

17501 17502
    if (virBufferError(&buf))
        goto error;
17503

17504 17505 17506 17507 17508
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
17509
    }
17510

17511 17512 17513 17514 17515 17516 17517 17518 17519 17520 17521
    /* 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);
17522 17523 17524 17525 17526 17527 17528 17529 17530 17531 17532
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
17533 17534 17535
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
17536 17537 17538
    }

    if (ctl->logfile) {
17539
        VIR_FREE(ctl->logfile);
17540 17541 17542 17543
        ctl->logfile = NULL;
    }
}

17544
#ifdef USE_READLINE
17545

K
Karel Zak 已提交
17546 17547 17548 17549 17550
/* -----------------
 * Readline stuff
 * -----------------
 */

17551
/*
K
Karel Zak 已提交
17552 17553
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
17554
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
17555 17556
 */
static char *
17557 17558
vshReadlineCommandGenerator(const char *text, int state)
{
17559
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
17560
    const char *name;
17561 17562
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
17563 17564

    if (!state) {
17565 17566
        grp_list_index = 0;
        cmd_list_index = 0;
17567
        len = strlen(text);
K
Karel Zak 已提交
17568 17569
    }

17570 17571
    grp = cmdGroups;

K
Karel Zak 已提交
17572
    /* Return the next name which partially matches from the
17573
     * command list.
K
Karel Zak 已提交
17574
     */
17575 17576 17577 17578 17579 17580 17581 17582 17583 17584 17585 17586 17587 17588
    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 已提交
17589 17590 17591 17592 17593 17594 17595
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
17596 17597
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
17598
    static int list_index, len;
17599
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
17600
    const char *name;
K
Karel Zak 已提交
17601 17602 17603 17604 17605 17606 17607 17608 17609

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

17610
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
17611
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
17612 17613 17614

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
17615
        len = strlen(text);
17616
        VIR_FREE(cmdname);
K
Karel Zak 已提交
17617 17618 17619 17620
    }

    if (!cmd)
        return NULL;
17621

17622 17623 17624
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
17625
    while ((name = cmd->opts[list_index].name)) {
17626
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
17627
        char *res;
17628

K
Karel Zak 已提交
17629
        list_index++;
17630

17631
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
17632 17633
            /* ignore non --option */
            continue;
17634

K
Karel Zak 已提交
17635
        if (len > 2) {
17636
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
17637 17638
                continue;
        }
17639
        res = vshMalloc(NULL, strlen(name) + 3);
17640
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
17641 17642 17643 17644 17645 17646 17647 17648
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
17649 17650 17651
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
17652 17653
    char **matches = (char **) NULL;

17654
    if (start == 0)
K
Karel Zak 已提交
17655
        /* command name generator */
17656
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
17657 17658
    else
        /* commands options */
17659
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
17660 17661 17662 17663
    return matches;
}


17664 17665
static int
vshReadlineInit(vshControl *ctl)
17666
{
17667 17668
    char *userdir = NULL;

K
Karel Zak 已提交
17669 17670 17671 17672 17673
    /* 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;
17674 17675 17676

    /* Limit the total size of the history buffer */
    stifle_history(500);
17677 17678

    /* Prepare to read/write history from/to the ~/.virsh/history file */
17679
    userdir = virGetUserDirectory(getuid());
17680

17681 17682
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
17683
        return -1;
17684
    }
17685 17686 17687

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
17688
        VIR_FREE(userdir);
17689 17690 17691 17692 17693
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
17694
        VIR_FREE(userdir);
17695 17696 17697
        return -1;
    }

17698
    VIR_FREE(userdir);
17699 17700 17701 17702 17703 17704 17705 17706 17707 17708 17709 17710 17711 17712 17713 17714 17715 17716

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

17717 17718
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
17719 17720
}

17721 17722 17723 17724 17725 17726
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

17727
#else /* !USE_READLINE */
17728

17729 17730 17731 17732 17733 17734 17735
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

17736
static void
17737
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
17738 17739 17740 17741 17742 17743 17744 17745 17746 17747 17748 17749 17750 17751 17752 17753 17754 17755 17756 17757 17758 17759 17760
{
    /* 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);
}

17761
#endif /* !USE_READLINE */
17762

17763 17764 17765 17766 17767 17768
static void
vshDeinitTimer(int timer ATTRIBUTE_UNUSED, void *opaque ATTRIBUTE_UNUSED)
{
    /* nothing to be done here */
}

K
Karel Zak 已提交
17769
/*
J
Jim Meyering 已提交
17770
 * Deinitialize virsh
K
Karel Zak 已提交
17771
 */
E
Eric Blake 已提交
17772
static bool
17773
vshDeinit(vshControl *ctl)
17774
{
17775
    vshReadlineDeinit(ctl);
17776
    vshCloseLogFile(ctl);
17777
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
17778
    if (ctl->conn) {
17779 17780 17781
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
17782 17783
        }
    }
D
Daniel P. Berrange 已提交
17784 17785
    virResetLastError();

J
Jiri Denemark 已提交
17786
    if (ctl->eventLoopStarted) {
17787 17788 17789 17790
        int timer;

        virMutexLock(&ctl->lock);
        ctl->quit = true;
J
Jiri Denemark 已提交
17791
        /* HACK: Add a dummy timeout to break event loop */
17792 17793 17794 17795 17796
        timer = virEventAddTimeout(0, vshDeinitTimer, NULL, NULL);
        virMutexUnlock(&ctl->lock);

        virThreadJoin(&ctl->eventLoop);

J
Jiri Denemark 已提交
17797 17798 17799 17800 17801 17802
        if (timer != -1)
            virEventRemoveTimeout(timer);

        ctl->eventLoopStarted = false;
    }

17803 17804
    virMutexDestroy(&ctl->lock);

E
Eric Blake 已提交
17805
    return true;
K
Karel Zak 已提交
17806
}
17807

K
Karel Zak 已提交
17808 17809 17810 17811
/*
 * Print usage
 */
static void
17812
vshUsage(void)
17813
{
17814
    const vshCmdGrp *grp;
17815
    const vshCmdDef *cmd;
17816

L
Lai Jiangshan 已提交
17817 17818
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
17819
                      "  options:\n"
17820
                      "    -c | --connect=URI      hypervisor connection URI\n"
17821
                      "    -r | --readonly         connect readonly\n"
17822
                      "    -d | --debug=NUM        debug level [0-4]\n"
17823 17824 17825
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
17826 17827 17828 17829 17830
                      "    -l | --log=FILE         output logging to file\n"
                      "    -v                      short version\n"
                      "    -V                      long version\n"
                      "         --version[=TYPE]   version, TYPE is short or long (default short)\n"
                      "    -e | --escape <char>    set escape sequence for console\n\n"
17831
                      "  commands (non interactive mode):\n\n"), progname, progname);
17832

17833 17834
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
17835

17836 17837 17838 17839 17840 17841 17842 17843 17844
        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"));
17845 17846 17847
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
17848 17849
}

17850 17851 17852 17853 17854 17855 17856 17857 17858 17859
/*
 * 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 已提交
17860 17861
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
17862 17863 17864 17865 17866 17867 17868 17869 17870 17871 17872 17873 17874 17875 17876 17877 17878 17879 17880 17881 17882 17883 17884 17885 17886 17887 17888 17889 17890 17891 17892 17893 17894 17895 17896
#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 已提交
17897
    vshPrint(ctl, "%s", _(" Networking:"));
17898 17899 17900 17901 17902 17903 17904 17905 17906 17907 17908 17909 17910 17911 17912 17913 17914 17915 17916 17917 17918 17919 17920 17921 17922 17923
#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 已提交
17924
    vshPrint(ctl, "%s", _(" Storage:"));
17925 17926 17927 17928 17929 17930 17931 17932 17933 17934 17935 17936 17937 17938 17939 17940 17941 17942 17943 17944 17945 17946 17947
#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 已提交
17948
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
17949
#ifdef WITH_SECDRIVER_APPARMOR
17950 17951 17952 17953 17954 17955 17956 17957 17958 17959 17960 17961 17962 17963 17964 17965 17966 17967 17968 17969 17970 17971 17972
    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 已提交
17973 17974 17975 17976
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
17977
static bool
17978
vshParseArgv(vshControl *ctl, int argc, char **argv)
17979
{
17980
    bool help = false;
17981
    int arg, len;
K
Karel Zak 已提交
17982
    struct option opt[] = {
E
Eric Blake 已提交
17983 17984 17985 17986 17987 17988 17989 17990
        {"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'},
17991
        {"escape", required_argument, NULL, 'e'},
E
Eric Blake 已提交
17992
        {NULL, 0, NULL, 0}
17993 17994
    };

17995 17996 17997
    /* 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. */
17998
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:e:", opt, NULL)) != -1) {
17999
        switch (arg) {
18000
        case 'd':
D
Daniel Veillard 已提交
18001
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
18002
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
18003 18004
                exit(EXIT_FAILURE);
            }
18005 18006
            break;
        case 'h':
18007
            help = true;
18008 18009
            break;
        case 'q':
E
Eric Blake 已提交
18010
            ctl->quiet = true;
18011 18012
            break;
        case 't':
E
Eric Blake 已提交
18013
            ctl->timing = true;
18014 18015 18016 18017
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
18018 18019 18020 18021 18022 18023
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
18024 18025 18026
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
18027
        case 'r':
E
Eric Blake 已提交
18028
            ctl->readonly = true;
18029
            break;
18030 18031 18032
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
18033 18034 18035 18036 18037 18038 18039 18040 18041 18042 18043 18044
        case 'e':
            len = strlen(optarg);

            if ((len == 2 && *optarg == '^') ||
                (len == 1 && *optarg != '^')) {
                ctl->escapeChar = optarg;
            } else {
                vshError(ctl, _("Invalid string '%s' for escape sequence"),
                         optarg);
                exit(EXIT_FAILURE);
            }
            break;
18045
        default:
18046 18047
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
18048 18049 18050 18051
        }
    }

    if (help) {
18052 18053
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
18054 18055
            exit(EXIT_FAILURE);
        }
18056 18057 18058

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
18059
        exit(EXIT_SUCCESS);
18060 18061
    }

18062
    if (argc > optind) {
K
Karel Zak 已提交
18063
        /* parse command */
E
Eric Blake 已提交
18064
        ctl->imode = false;
18065
        if (argc - optind == 1) {
18066
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
18067
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
18068
        } else {
18069
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
18070 18071
        }
    }
E
Eric Blake 已提交
18072
    return true;
K
Karel Zak 已提交
18073 18074
}

18075 18076 18077 18078
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
18079
    char *defaultConn;
E
Eric Blake 已提交
18080
    bool ret = true;
K
Karel Zak 已提交
18081

18082 18083 18084
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
18085
    ctl->debug = VSH_DEBUG_DEFAULT;
18086 18087
    ctl->escapeChar = CTRL_CLOSE_BRACKET;

18088

18089 18090
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
18091
        /* failure to setup locale is not fatal */
18092
    }
18093
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
18094
        perror("bindtextdomain");
E
Eric Blake 已提交
18095
        return EXIT_FAILURE;
18096
    }
18097
    if (!textdomain(PACKAGE)) {
18098
        perror("textdomain");
E
Eric Blake 已提交
18099
        return EXIT_FAILURE;
18100 18101
    }

18102 18103 18104 18105 18106
    if (virMutexInit(&ctl->lock) < 0) {
        vshError(ctl, "%s", _("Failed to initialize mutex"));
        return EXIT_FAILURE;
    }

18107 18108 18109 18110 18111
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

18112
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
18113 18114 18115
        progname = argv[0];
    else
        progname++;
18116

18117
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
18118
        ctl->name = vshStrdup(ctl, defaultConn);
18119 18120
    }

D
Daniel P. Berrange 已提交
18121 18122
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
18123
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
18124
    }
18125

D
Daniel P. Berrange 已提交
18126 18127
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
18128
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
18129
    }
18130

K
Karel Zak 已提交
18131
    if (!ctl->imode) {
18132
        ret = vshCommandRun(ctl, ctl->cmd);
18133
    } else {
K
Karel Zak 已提交
18134 18135
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
18136
            vshPrint(ctl,
18137
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
18138
                     progname);
J
Jim Meyering 已提交
18139
            vshPrint(ctl, "%s",
18140
                     _("Type:  'help' for help with commands\n"
18141
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
18142
        }
18143 18144 18145 18146 18147 18148

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
18149
        do {
18150
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
18151
            ctl->cmdstr =
18152
                vshReadline(ctl, prompt);
18153 18154
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
18155
            if (*ctl->cmdstr) {
18156
#if USE_READLINE
K
Karel Zak 已提交
18157
                add_history(ctl->cmdstr);
18158
#endif
18159
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
18160 18161
                    vshCommandRun(ctl, ctl->cmd);
            }
18162
            VIR_FREE(ctl->cmdstr);
18163
        } while (ctl->imode);
K
Karel Zak 已提交
18164

18165 18166
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
18167
    }
18168

K
Karel Zak 已提交
18169 18170
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
18171
}