virsh.c 515.8 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"
K
Karel Zak 已提交
64 65 66

static char *progname;

67 68
#define VIRSH_MAX_XML_FILE 10*1024*1024

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

72 73
#define VIR_FROM_THIS VIR_FROM_NONE

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

E
Eric Blake 已提交
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
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
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466

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;

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

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

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

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

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

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

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

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

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

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

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

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

K
Karel Zak 已提交
618 619 620 621 622 623
/* ---------------
 * Commands
 * ---------------
 */

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

631
    {NULL, NULL}
K
Karel Zak 已提交
632 633
};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

775 776
#ifndef WIN32

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

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

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

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

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

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

 cleanup:
815

816 817 818
    return ret;
}

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

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

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

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

837
    ret = cmdRunConsole(ctl, dom, name);
838

839
cleanup:
840 841 842 843
    virDomainFree(dom);
    return ret;
}

844 845 846
#endif /* WIN32 */


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

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

K
Karel Zak 已提交
864

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

877
    inactive |= all;
K
Karel Zak 已提交
878

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1006
cleanup:
1007 1008 1009 1010
    virDomainFree(dom);
    return ret;
}

1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
/*
 * "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;
}

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

1067
static const vshCmdOptDef opts_domblkstat[] = {
1068 1069
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083
    {"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",
1084
      N_("number of read operations:") }, /* 0 */
1085
    { VIR_DOMAIN_BLOCK_STATS_READ_BYTES,        "rd_bytes",
1086
      N_("number of bytes read:") }, /* 1 */
1087
    { VIR_DOMAIN_BLOCK_STATS_WRITE_REQ,         "wr_req",
1088
      N_("number of write operations:") }, /* 2 */
1089
    { VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES,       "wr_bytes",
1090
      N_("number of bytes written:") }, /* 3 */
1091
    { VIR_DOMAIN_BLOCK_STATS_ERRS,              "errs",
1092
      N_("error count:") }, /* 4 */
1093
    { VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ,         NULL,
1094
      N_("number of flush operations:") }, /* 5 */
1095
    { VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES,  NULL,
1096
      N_("total duration of reads (ns):") }, /* 6 */
1097
    { VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES, NULL,
1098
      N_("total duration of writes (ns):") }, /* 7 */
1099 1100 1101 1102 1103 1104 1105
    { 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)                                     \
1106 1107
        vshPrint(ctl, "%s %-*s %lld\n", device,         \
                 human ? 31 : 0,                        \
1108 1109 1110
                 human ? _(domblkstat_output[ID].human) \
                 : domblkstat_output[ID].legacy,        \
                 VALUE);
1111

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

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

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

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

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

1147 1148
        virFreeError(last_error);
        last_error = NULL;
1149

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

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

        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);
1168
    } else {
1169
        params = vshCalloc(ctl, nparams, sizeof(*params));
1170

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

1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
        /* 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;

            if (!(value = vshGetTypedParamValue(ctl, par)))
                continue;

            /* 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;

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

            VIR_FREE(value);
        }

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

1217 1218 1219 1220 1221
            if (!(value = vshGetTypedParamValue(ctl, params+i)))
                continue;

            vshPrint(ctl, "%s %s %s\n", device, params[i].field, value);
            VIR_FREE(value);
1222 1223 1224 1225 1226 1227 1228
        }
    }

    ret = true;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    /* attribute not found */
1569
    vshPrint(ctl, "%s default", iface);
1570 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 1761 1762 1763

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

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

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

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

1785
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1786
        return false;
1787

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

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

1798 1799 1800 1801
    virDomainFree(dom);
    return ret;
}

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

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

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

1833
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1834
        return false;
1835

1836
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1837
        return false;
1838

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

1842 1843
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1844 1845
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1846 1847

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1848
    VIR_FREE(buffer);
1849

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

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

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

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

1887
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1888
        return false;
1889

1890
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1891
        return false;
1892

1893
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1894
        return false;
1895 1896

    dom = virDomainDefineXML(ctl->conn, buffer);
1897
    VIR_FREE(buffer);
1898

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

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

1920
static const vshCmdOptDef opts_undefine[] = {
1921
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1922
    {"managed-save", VSH_OT_BOOL, 0, N_("remove domain managed state file")},
1923 1924
    {"snapshots-metadata", VSH_OT_BOOL, 0,
     N_("remove all domain snapshot metadata, if inactive")},
1925 1926 1927
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1928
static bool
1929
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1930 1931
{
    virDomainPtr dom;
1932
    bool ret = false;
1933
    const char *name = NULL;
1934
    /* Flags to attempt.  */
E
Eric Blake 已提交
1935
    unsigned int flags = 0;
1936 1937 1938 1939
    /* User-requested actions.  */
    bool managed_save = vshCommandOptBool(cmd, "managed-save");
    bool snapshots_metadata = vshCommandOptBool(cmd, "snapshots-metadata");
    /* Positive if these items exist.  */
1940
    int has_managed_save = 0;
1941 1942 1943 1944 1945
    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;
1946
    int rc = -1;
1947
    int running;
1948

1949
    if (managed_save) {
1950
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
1951 1952 1953 1954 1955 1956
        managed_save_safe = true;
    }
    if (snapshots_metadata) {
        flags |= VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
1957

1958
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1959
        return false;
1960

1961
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1962
        return false;
1963

1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982
    /* 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;
            }
1983 1984
            virFreeError(last_error);
            last_error = NULL;
1985
            has_managed_save = 0;
1986 1987
        }

1988 1989
        has_snapshots = virDomainSnapshotNum(dom, 0);
        if (has_snapshots < 0) {
1990 1991
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003
                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.  */
2004 2005
                virFreeError(last_error);
                last_error = NULL;
2006 2007 2008 2009 2010
                has_snapshots_metadata = has_snapshots;
            } else {
                /* The server knew the new flag, all aspects of
                 * undefineFlags are safe.  */
                managed_save_safe = snapshots_safe = true;
2011
            }
2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024
        }
    }
    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;
    }
2025

2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039
    /* 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;
    }
2040

2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052
    /* 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;
2053 2054 2055
        }
    }

2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069
    /* 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:
2070
    if (rc == 0) {
2071
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
2072
        ret = true;
2073
    } else {
2074
        vshError(ctl, _("Failed to undefine domain %s"), name);
2075 2076
    }

2077
cleanup:
2078
    virDomainFree(dom);
2079 2080 2081 2082 2083 2084 2085
    return ret;
}


/*
 * "start" command
 */
2086
static const vshCmdInfo info_start[] = {
2087
    {"help", N_("start a (previously defined) inactive domain")},
2088 2089 2090
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
2091 2092 2093
    {NULL, NULL}
};

2094
static const vshCmdOptDef opts_start[] = {
2095
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
2096
#ifndef WIN32
2097
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
2098
#endif
E
Eric Blake 已提交
2099
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
2100 2101
    {"autodestroy", VSH_OT_BOOL, 0,
     N_("automatically destroy the guest when virsh disconnects")},
2102 2103
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when loading")},
2104 2105
    {"force-boot", VSH_OT_BOOL, 0,
     N_("force fresh boot by discarding any managed save")},
2106 2107 2108
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2109
static bool
2110
cmdStart(vshControl *ctl, const vshCmd *cmd)
2111 2112
{
    virDomainPtr dom;
2113
    bool ret = false;
2114
#ifndef WIN32
2115
    int console = vshCommandOptBool(cmd, "console");
2116
#endif
E
Eric Blake 已提交
2117
    unsigned int flags = VIR_DOMAIN_NONE;
2118
    int rc;
2119

2120
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2121
        return false;
2122

2123 2124
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
2125
        return false;
2126 2127

    if (virDomainGetID(dom) != (unsigned int)-1) {
2128
        vshError(ctl, "%s", _("Domain is already active"));
2129
        virDomainFree(dom);
E
Eric Blake 已提交
2130
        return false;
2131 2132
    }

E
Eric Blake 已提交
2133 2134
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
2135 2136
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
2137 2138
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_START_BYPASS_CACHE;
2139 2140
    if (vshCommandOptBool(cmd, "force-boot"))
        flags |= VIR_DOMAIN_START_FORCE_BOOT;
E
Eric Blake 已提交
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
    /* 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 已提交
2167 2168
    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
2169
         : virDomainCreate(dom)) < 0) {
2170
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
2171
        goto cleanup;
2172
    }
2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184

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

    ret = true;

cleanup:
2185
    virDomainFree(dom);
2186 2187 2188
    return ret;
}

2189 2190 2191
/*
 * "save" command
 */
2192
static const vshCmdInfo info_save[] = {
2193
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
2194
    {"desc", N_("Save the RAM state of a running domain.")},
2195
    {NULL, NULL}
2196 2197
};

2198
static const vshCmdOptDef opts_save[] = {
2199
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2200 2201
    {"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")},
2202 2203
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2204 2205
    {"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")},
2206
    {NULL, 0, 0, NULL}
2207 2208
};

E
Eric Blake 已提交
2209
static bool
2210
cmdSave(vshControl *ctl, const vshCmd *cmd)
2211
{
2212
    virDomainPtr dom;
2213 2214
    const char *name = NULL;
    const char *to = NULL;
2215
    bool ret = false;
E
Eric Blake 已提交
2216
    unsigned int flags = 0;
2217 2218
    const char *xmlfile = NULL;
    char *xml = NULL;
2219

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

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

2226 2227
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2228 2229 2230 2231
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2232

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

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

2241 2242 2243 2244 2245 2246
    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
        goto cleanup;

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
2247
         : virDomainSave(dom, to)) < 0) {
2248
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
2249
        goto cleanup;
2250
    }
2251

2252 2253 2254 2255
    vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
    ret = true;

cleanup:
2256
    VIR_FREE(xml);
2257 2258 2259 2260
    virDomainFree(dom);
    return ret;
}

2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281
/*
 * "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 已提交
2282
    unsigned int flags = 0;
2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318
    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")},
2319 2320
    {"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")},
2321 2322 2323 2324 2325 2326 2327 2328 2329 2330
    {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;
2331 2332 2333 2334 2335 2336
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351

    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;

2352
    if (virDomainSaveImageDefineXML(ctl->conn, file, xml, flags) < 0) {
2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375
        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")},
2376 2377
    {"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")},
2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388
    {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;
2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404
    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;
    }
2405 2406 2407 2408 2409 2410 2411 2412

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

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

    /* Get the XML configuration of the saved image.  */
2413
    doc = virDomainSaveImageGetXMLDesc(ctl->conn, file, getxml_flags);
2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430
    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;

2431 2432 2433
    /* 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) {
2434 2435 2436 2437 2438 2439 2440
        vshPrint(ctl, _("Saved image %s XML configuration not changed.\n"),
                 file);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
2441 2442
    if (virDomainSaveImageDefineXML(ctl->conn, file, doc_edited,
                                    define_flags) < 0) {
2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459
        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;
}

2460 2461 2462 2463 2464
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
2465 2466 2467 2468
    {"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.")},
2469 2470 2471 2472
    {NULL, NULL}
};

static const vshCmdOptDef opts_managedsave[] = {
2473
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
2474
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2475 2476
    {"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")},
2477 2478 2479
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2480
static bool
2481 2482 2483
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
2484
    const char *name;
2485
    bool ret = false;
E
Eric Blake 已提交
2486
    unsigned int flags = 0;
2487

2488
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2489
        return false;
2490

2491 2492
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2493 2494 2495 2496
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2497

2498
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2499
        return false;
2500

2501
    if (virDomainManagedSave(dom, flags) < 0) {
2502
        vshError(ctl, _("Failed to save domain %s state"), name);
2503
        goto cleanup;
2504 2505
    }

2506 2507 2508 2509
    vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    ret = true;

cleanup:
2510 2511 2512 2513
    virDomainFree(dom);
    return ret;
}

2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527
/*
 * "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 已提交
2528
static bool
2529 2530 2531
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
2532
    const char *name;
E
Eric Blake 已提交
2533
    bool ret = false;
2534 2535
    int hassave;

2536
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2537
        return false;
2538 2539

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2540
        return false;
2541 2542 2543

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
2544
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560
        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 已提交
2561
    ret = true;
2562 2563 2564 2565 2566 2567

cleanup:
    virDomainFree(dom);
    return ret;
}

2568 2569 2570
/*
 * "schedinfo" command
 */
2571
static const vshCmdInfo info_schedinfo[] = {
2572 2573
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
2574 2575 2576
    {NULL, NULL}
};

2577
static const vshCmdOptDef opts_schedinfo[] = {
2578 2579 2580 2581
    {"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")},
2582 2583 2584
    {"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")},
2585 2586 2587
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
2588
static int
2589
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
2590
                   virTypedParameterPtr param)
2591
{
2592
    const char *data = NULL;
2593 2594 2595

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
2596
        param->type == VIR_TYPED_PARAM_UINT &&
2597 2598
        vshCommandOptBool(cmd, "weight")) {
        int val;
2599
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
2600
            vshError(ctl, "%s", _("Invalid value of weight"));
2601
            return -1;
2602
        } else {
2603
            param->value.ui = val;
2604
        }
2605
        return 1;
2606 2607
    }

2608 2609
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
2610
        param->type == VIR_TYPED_PARAM_UINT &&
2611 2612
        vshCommandOptBool(cmd, "cap")) {
        int val;
2613
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
2614
            vshError(ctl, "%s", _("Invalid value of cap"));
2615
            return -1;
2616
        } else {
2617
            param->value.ui = val;
2618
        }
2619
        return 1;
2620
    }
2621

2622
    if (vshCommandOptString(cmd, "set", &data) > 0) {
2623 2624 2625
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
2626
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
2627
            return -1;
2628
        }
2629 2630 2631 2632 2633 2634 2635 2636 2637
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
2638
        case VIR_TYPED_PARAM_INT:
2639
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
2640
                vshError(ctl, "%s",
2641 2642 2643 2644
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
2645
        case VIR_TYPED_PARAM_UINT:
2646
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
2647
                vshError(ctl, "%s",
2648 2649 2650 2651
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
2652
        case VIR_TYPED_PARAM_LLONG:
2653
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
2654
                vshError(ctl, "%s",
J
Jim Meyering 已提交
2655
                         _("Invalid value for parameter, expecting a long long"));
2656 2657 2658
                return -1;
            }
            break;
2659
        case VIR_TYPED_PARAM_ULLONG:
2660
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
2661
                vshError(ctl, "%s",
2662 2663 2664 2665
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
2666
        case VIR_TYPED_PARAM_DOUBLE:
2667
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
2668
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
2669 2670 2671
                return -1;
            }
            break;
2672
        case VIR_TYPED_PARAM_BOOLEAN:
2673
            param->value.b = STREQ(val, "0") ? 0 : 1;
2674
        }
2675
        return 1;
2676
    }
2677

2678 2679
    return 0;
}
2680

2681

E
Eric Blake 已提交
2682
static bool
2683 2684 2685 2686
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
2687
    virTypedParameterPtr params = NULL;
2688 2689 2690
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
2691
    bool ret_val = false;
2692 2693 2694 2695 2696 2697 2698 2699 2700 2701
    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;
        }
2702
        flags = VIR_DOMAIN_AFFECT_CURRENT;
2703 2704
    } else {
        if (config)
2705
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
2706
        if (live)
2707
            flags |= VIR_DOMAIN_AFFECT_LIVE;
2708
    }
2709

2710
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2711
        return false;
2712

2713
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2714
        return false;
2715 2716 2717

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
2718
    if (schedulertype != NULL) {
2719
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
2720
             schedulertype);
2721
        VIR_FREE(schedulertype);
2722
    } else {
2723
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
2724
        goto cleanup;
2725 2726
    }

2727
    if (nparams) {
2728
        params = vshMalloc(ctl, sizeof(*params) * nparams);
2729

2730
        memset(params, 0, sizeof(*params) * nparams);
2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741
        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);
        }
2742 2743 2744 2745
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
2746
        for (i = 0; i < nparams; i++) {
2747 2748 2749 2750 2751 2752 2753 2754 2755 2756
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
2757 2758 2759 2760 2761
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
2762 2763 2764
            if (ret == -1)
                goto cleanup;

2765 2766 2767 2768 2769 2770 2771
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
2772 2773
            if (ret == -1)
                goto cleanup;
2774 2775 2776 2777
        } 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.  */
2778 2779
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
2780 2781 2782 2783
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
2784 2785 2786 2787 2788 2789
            /* 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;
            }
2790 2791
        }

E
Eric Blake 已提交
2792
        ret_val = true;
2793
        for (i = 0; i < nparams; i++) {
2794
            switch (params[i].type) {
2795
            case VIR_TYPED_PARAM_INT:
2796
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
2797
                 break;
2798
            case VIR_TYPED_PARAM_UINT:
2799
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
2800
                 break;
2801
            case VIR_TYPED_PARAM_LLONG:
2802
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
2803
                 break;
2804
            case VIR_TYPED_PARAM_ULLONG:
2805
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
2806
                 break;
2807
            case VIR_TYPED_PARAM_DOUBLE:
2808
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
2809
                 break;
2810
            case VIR_TYPED_PARAM_BOOLEAN:
2811
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
2812 2813
                 break;
            default:
2814
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
2815 2816 2817
            }
        }
    }
2818

2819
 cleanup:
2820
    VIR_FREE(params);
2821
    virDomainFree(dom);
2822
    return ret_val;
2823 2824
}

2825 2826 2827
/*
 * "restore" command
 */
2828
static const vshCmdInfo info_restore[] = {
2829 2830
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
2831
    {NULL, NULL}
2832 2833
};

2834
static const vshCmdOptDef opts_restore[] = {
2835
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
2836 2837
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when restoring")},
2838 2839
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
2840 2841
    {"running", VSH_OT_BOOL, 0, N_("restore domain into running state")},
    {"paused", VSH_OT_BOOL, 0, N_("restore domain into paused state")},
2842
    {NULL, 0, 0, NULL}
2843 2844
};

E
Eric Blake 已提交
2845
static bool
2846
cmdRestore(vshControl *ctl, const vshCmd *cmd)
2847
{
2848
    const char *from = NULL;
2849
    bool ret = false;
E
Eric Blake 已提交
2850
    unsigned int flags = 0;
2851 2852
    const char *xmlfile = NULL;
    char *xml = NULL;
2853

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

2857
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2858
        return false;
2859

2860 2861
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2862 2863 2864 2865
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2866

2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877
    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)
2878
         : virDomainRestore(ctl->conn, from)) < 0) {
2879
        vshError(ctl, _("Failed to restore domain from %s"), from);
2880
        goto cleanup;
2881
    }
2882 2883 2884 2885 2886

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

cleanup:
2887
    VIR_FREE(xml);
2888 2889 2890
    return ret;
}

D
Daniel Veillard 已提交
2891 2892 2893
/*
 * "dump" command
 */
2894
static const vshCmdInfo info_dump[] = {
2895 2896
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
2897 2898 2899
    {NULL, NULL}
};

2900
static const vshCmdOptDef opts_dump[] = {
2901 2902
    {"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")},
2903 2904
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when saving")},
2905
    {"reset", VSH_OT_BOOL, 0, N_("reset the domain after core dump")},
2906 2907
    {"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 已提交
2908 2909 2910
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2911
static bool
2912
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
2913 2914
{
    virDomainPtr dom;
2915 2916
    const char *name = NULL;
    const char *to = NULL;
2917
    bool ret = false;
E
Eric Blake 已提交
2918
    unsigned int flags = 0;
D
Daniel Veillard 已提交
2919

2920
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2921
        return false;
D
Daniel Veillard 已提交
2922

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

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

P
Paolo Bonzini 已提交
2929 2930
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
2931 2932
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;
2933 2934
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DUMP_BYPASS_CACHE;
2935 2936
    if (vshCommandOptBool(cmd, "reset"))
        flags |= VIR_DUMP_RESET;
2937

2938
    if (virDomainCoreDump(dom, to, flags) < 0) {
2939
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
2940
        goto cleanup;
D
Daniel Veillard 已提交
2941 2942
    }

2943 2944 2945 2946
    vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
    ret = true;

cleanup:
D
Daniel Veillard 已提交
2947 2948 2949 2950
    virDomainFree(dom);
    return ret;
}

2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024
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;
3025
    bool created = false;
3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064
    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;
        }
3065 3066
    } else {
        created = true;
3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098
    }

    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
        vshError(ctl, _("could not receive data from domain %s"), name);
        goto cleanup;
    }

    if (VIR_CLOSE(fd) < 0) {
        vshError(ctl, _("cannot close file %s"), file);
        goto cleanup;
    }

    if (virStreamFinish(st) < 0) {
        vshError(ctl, _("cannot close stream on domain %s"), name);
        goto cleanup;
    }

    vshPrint(ctl, _("Screenshot saved to %s, with type of %s"), file, mime);
    ret = true;

cleanup:
    if (!ret && created)
        unlink(file);
    if (generated)
        VIR_FREE(file);
    virDomainFree(dom);
    if (st)
        virStreamFree(st);
    VIR_FORCE_CLOSE(fd);
    return ret;
}

3099 3100 3101
/*
 * "resume" command
 */
3102
static const vshCmdInfo info_resume[] = {
3103 3104
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
3105
    {NULL, NULL}
3106 3107
};

3108
static const vshCmdOptDef opts_resume[] = {
3109
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3110
    {NULL, 0, 0, NULL}
3111 3112
};

E
Eric Blake 已提交
3113
static bool
3114
cmdResume(vshControl *ctl, const vshCmd *cmd)
3115
{
3116
    virDomainPtr dom;
E
Eric Blake 已提交
3117
    bool ret = true;
3118
    const char *name;
3119

3120
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3121
        return false;
3122

J
Jim Meyering 已提交
3123
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3124
        return false;
3125 3126

    if (virDomainResume(dom) == 0) {
3127
        vshPrint(ctl, _("Domain %s resumed\n"), name);
3128
    } else {
3129
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
3130
        ret = false;
3131
    }
3132

3133 3134 3135 3136
    virDomainFree(dom);
    return ret;
}

3137 3138 3139
/*
 * "shutdown" command
 */
3140
static const vshCmdInfo info_shutdown[] = {
3141 3142
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
3143
    {NULL, NULL}
3144 3145
};

3146
static const vshCmdOptDef opts_shutdown[] = {
3147
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3148
    {NULL, 0, 0, NULL}
3149 3150
};

E
Eric Blake 已提交
3151
static bool
3152
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
3153
{
3154
    virDomainPtr dom;
E
Eric Blake 已提交
3155
    bool ret = true;
3156
    const char *name;
3157

3158
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3159
        return false;
3160

J
Jim Meyering 已提交
3161
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3162
        return false;
3163 3164

    if (virDomainShutdown(dom) == 0) {
3165
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
3166
    } else {
3167
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
3168
        ret = false;
3169
    }
3170

3171 3172 3173 3174
    virDomainFree(dom);
    return ret;
}

3175 3176 3177
/*
 * "reboot" command
 */
3178
static const vshCmdInfo info_reboot[] = {
3179 3180
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
3181 3182 3183
    {NULL, NULL}
};

3184
static const vshCmdOptDef opts_reboot[] = {
3185
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3186 3187 3188
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3189
static bool
3190
cmdReboot(vshControl *ctl, const vshCmd *cmd)
3191 3192
{
    virDomainPtr dom;
E
Eric Blake 已提交
3193
    bool ret = true;
3194
    const char *name;
3195

3196
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3197
        return false;
3198

J
Jim Meyering 已提交
3199
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3200
        return false;
3201 3202

    if (virDomainReboot(dom, 0) == 0) {
3203
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
3204
    } else {
3205
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
3206
        ret = false;
3207 3208 3209 3210 3211 3212
    }

    virDomainFree(dom);
    return ret;
}

X
Xu He Jie 已提交
3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250
/*
 * "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;
}

3251 3252 3253
/*
 * "destroy" command
 */
3254
static const vshCmdInfo info_destroy[] = {
3255 3256 3257
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
3258
    {NULL, NULL}
3259 3260
};

3261
static const vshCmdOptDef opts_destroy[] = {
3262
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3263
    {NULL, 0, 0, NULL}
3264 3265
};

E
Eric Blake 已提交
3266
static bool
3267
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
3268
{
3269
    virDomainPtr dom;
E
Eric Blake 已提交
3270
    bool ret = true;
3271
    const char *name;
3272

3273
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3274
        return false;
3275

J
Jim Meyering 已提交
3276
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3277
        return false;
3278 3279

    if (virDomainDestroy(dom) == 0) {
3280
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
3281
    } else {
3282
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
3283
        ret = false;
3284
    }
3285

3286
    virDomainFree(dom);
K
Karel Zak 已提交
3287 3288 3289 3290
    return ret;
}

/*
3291
 * "dominfo" command
K
Karel Zak 已提交
3292
 */
3293
static const vshCmdInfo info_dominfo[] = {
3294 3295
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
3296
    {NULL, NULL}
K
Karel Zak 已提交
3297 3298
};

3299
static const vshCmdOptDef opts_dominfo[] = {
3300
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3301
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3302 3303
};

E
Eric Blake 已提交
3304
static bool
3305
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
3306
{
K
Karel Zak 已提交
3307 3308
    virDomainInfo info;
    virDomainPtr dom;
3309
    virSecurityModel secmodel;
3310
    virSecurityLabelPtr seclabel;
3311
    int persistent = 0;
E
Eric Blake 已提交
3312 3313
    bool ret = true;
    int autostart;
3314
    unsigned int id;
3315
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
3316
    int has_managed_save = 0;
3317

3318
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3319
        return false;
K
Karel Zak 已提交
3320

J
Jim Meyering 已提交
3321
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3322
        return false;
3323

3324 3325
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3326
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
3327
    else
3328
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
3329 3330
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
3331
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
3332
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
3333 3334

    if ((str = virDomainGetOSType(dom))) {
3335
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
3336
        VIR_FREE(str);
3337 3338 3339
    }

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

3343
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
3344 3345

        if (info.cpuTime != 0) {
3346
            double cpuUsed = info.cpuTime;
3347

3348
            cpuUsed /= 1000000000.0;
3349

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

3353 3354
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
3355
                 info.maxMem);
3356
        else
3357
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
3358 3359
                 _("no limit"));

3360
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
3361 3362
                 info.memory);

K
Karel Zak 已提交
3363
    } else {
E
Eric Blake 已提交
3364
        ret = false;
K
Karel Zak 已提交
3365
    }
3366

3367 3368
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
3369 3370
    vshDebug(ctl, VSH_ERR_DEBUG, "Domain persistent flag value: %d\n",
             persistent);
3371 3372 3373 3374 3375 3376
    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 */
3377
    if (!virDomainGetAutostart(dom, &autostart)) {
3378
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
3379 3380 3381
                 autostart ? _("enable") : _("disable") );
    }

3382 3383 3384 3385 3386 3387 3388
    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"));

3389 3390 3391
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
3392 3393
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
3394
            return false;
3395 3396 3397
        } else {
            virFreeError(last_error);
            last_error = NULL;
3398
        }
3399 3400 3401 3402 3403 3404 3405
    } 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 */
3406
            if (VIR_ALLOC(seclabel) < 0) {
3407
                virDomainFree(dom);
E
Eric Blake 已提交
3408
                return false;
3409 3410 3411 3412 3413
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
3414
                return false;
3415
            } else {
3416
                if (seclabel->label[0] != '\0')
3417
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
3418
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
3419
            }
3420 3421

            VIR_FREE(seclabel);
3422 3423
        }
    }
3424
    virDomainFree(dom);
K
Karel Zak 已提交
3425 3426 3427
    return ret;
}

3428 3429 3430 3431
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
3432 3433
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
3434 3435 3436 3437
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
3438
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3439 3440 3441 3442
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
3443
static bool
3444 3445 3446 3447
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
3448
    bool ret = true;
3449

3450
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3451
        return false;
3452 3453

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3454
        return false;
3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480

    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 已提交
3481
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
3482
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
3483
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
3484
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
3485
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
3486 3487 3488
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
3489
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
3490
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
3491
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
3492
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
3493
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
3494 3495 3496
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
3497
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
3498
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
3499
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
3500
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
3501
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
3502 3503
        }
    } else {
E
Eric Blake 已提交
3504
        ret = false;
3505 3506 3507 3508 3509 3510
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

3511 3512 3513 3514
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
3515 3516
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
3517 3518 3519 3520
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
3521
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3522 3523 3524
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3525
static bool
3526 3527 3528
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3529
    bool ret = true;
3530

3531
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3532
        return false;
3533 3534

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
3538
        ret = false;
3539 3540 3541 3542 3543

    virDomainFree(dom);
    return ret;
}

3544 3545 3546
/*
 * "freecell" command
 */
3547
static const vshCmdInfo info_freecell[] = {
3548 3549
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
3550 3551 3552
    {NULL, NULL}
};

3553
static const vshCmdOptDef opts_freecell[] = {
3554
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
3555
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
3556 3557 3558
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3559
static bool
3560
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
3561
{
W
Wen Congyang 已提交
3562
    bool func_ret = false;
3563
    int ret;
3564
    int cell = -1, cell_given;
3565
    unsigned long long memory;
3566 3567 3568 3569
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
3570
    int all_given;
3571 3572 3573 3574
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
3575

3576

3577
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3578
        return false;
3579

3580 3581 3582 3583
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
3584 3585 3586 3587 3588 3589 3590 3591 3592
    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) {
3593 3594 3595
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3596 3597 3598
            goto cleanup;
        }

3599
        xml = virXMLParseStringCtxt(cap_xml, _("(capabilities)"), &ctxt);
3600 3601
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
3602 3603
            goto cleanup;
        }
3604 3605 3606 3607
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
3608
            vshError(ctl, "%s", _("could not get information about "
3609
                                  "NUMA topology"));
3610 3611 3612
            goto cleanup;
        }

3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633
        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;
            }
        }

3634
        memory = 0;
3635 3636 3637 3638
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
3639 3640 3641 3642
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
3643
    } else {
3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657
        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));
3658 3659
    }

E
Eric Blake 已提交
3660
    func_ret = true;
3661

3662
cleanup:
3663
    xmlXPathFreeContext(ctxt);
3664
    xmlFreeDoc(xml);
3665
    VIR_FREE(nodes);
3666 3667 3668
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
3669
    return func_ret;
3670 3671
}

E
Eric Blake 已提交
3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685
/*
 * "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 已提交
3686
static bool
E
Eric Blake 已提交
3687 3688
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
3689
    const char *type = NULL;
E
Eric Blake 已提交
3690 3691
    int vcpus;

3692 3693
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
3694
        return false;
3695
    }
E
Eric Blake 已提交
3696 3697

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

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

E
Eric Blake 已提交
3705
    return true;
E
Eric Blake 已提交
3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719
}

/*
 * "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")},
3720
    {"active", VSH_OT_BOOL, 0, N_("get number of currently active vcpus")},
E
Eric Blake 已提交
3721
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
3722 3723 3724
    {"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 已提交
3725 3726 3727
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3728
static bool
E
Eric Blake 已提交
3729 3730 3731
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3732
    bool ret = true;
E
Eric Blake 已提交
3733
    int maximum = vshCommandOptBool(cmd, "maximum");
3734
    int active = vshCommandOptBool(cmd, "active");
E
Eric Blake 已提交
3735 3736
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3737 3738
    int current = vshCommandOptBool(cmd, "current");
    bool all = maximum + active + current + config + live == 0;
E
Eric Blake 已提交
3739 3740
    int count;

3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755
    /* 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 已提交
3756
        return false;
E
Eric Blake 已提交
3757
    }
3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770

    /* 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 已提交
3771
        vshError(ctl, "%s",
3772
                 _("--maximum and --active cannot both be specified"));
E
Eric Blake 已提交
3773
        return false;
E
Eric Blake 已提交
3774
    }
3775 3776 3777
    if (current + config + live > 1) {
        vshError(ctl, "%s",
                 _("--config, --live, and --current are mutually exclusive"));
E
Eric Blake 已提交
3778
        return false;
E
Eric Blake 已提交
3779 3780 3781
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3782
        return false;
E
Eric Blake 已提交
3783 3784

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

    /* In all cases, try the new API first; if it fails because we are
3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801
     * 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 已提交
3802 3803
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
3804
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
3805 3806 3807 3808 3809 3810 3811 3812 3813
        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;
            }
3814 3815
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
3816 3817 3818 3819 3820
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
3821
            ret = false;
E
Eric Blake 已提交
3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833
        } 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 |
3834
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
3835 3836 3837 3838 3839 3840 3841
        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 已提交
3842
            ret = false;
E
Eric Blake 已提交
3843 3844 3845 3846 3847 3848 3849 3850 3851 3852
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3853
    if (all || (active && config)) {
3854
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878
        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 已提交
3879
            ret = false;
E
Eric Blake 已提交
3880 3881 3882 3883 3884 3885 3886 3887 3888 3889
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

3890
    if (all || (active && live)) {
3891
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
3892 3893 3894 3895 3896 3897 3898 3899 3900
        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 已提交
3901
            ret = false;
E
Eric Blake 已提交
3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915
        } 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;
}

3916 3917 3918
/*
 * "vcpuinfo" command
 */
3919
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
3920
    {"help", N_("detailed domain vcpu information")},
3921
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
3922 3923 3924
    {NULL, NULL}
};

3925
static const vshCmdOptDef opts_vcpuinfo[] = {
3926
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3927 3928 3929
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3930
static bool
3931
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
3932 3933 3934 3935 3936
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
3937 3938
    unsigned char *cpumaps;
    int ncpus, maxcpu;
3939
    size_t cpumaplen;
E
Eric Blake 已提交
3940
    bool ret = true;
3941
    int n, m;
3942

3943
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3944
        return false;
3945

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

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3951
        return false;
3952 3953 3954 3955
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3956
        return false;
3957 3958
    }

3959
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
3960 3961 3962
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
3963

3964 3965
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
3966
                                   cpumaps, cpumaplen)) >= 0) {
3967 3968 3969 3970
        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 已提交
3971
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
3972 3973 3974 3975 3976 3977 3978 3979
            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:"));
3980 3981
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
3982 3983 3984 3985 3986 3987
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
3988
    } else {
3989
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
3990
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3991 3992 3993
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
3994
            /* fallback plan to use virDomainGetVcpuPinInfo */
3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012

            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;
4013
        }
4014 4015
    }

4016
    VIR_FREE(cpumaps);
4017
    VIR_FREE(cpuinfo);
4018 4019 4020 4021 4022 4023 4024
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
4025
static const vshCmdInfo info_vcpupin[] = {
4026
    {"help", N_("control or query domain vcpu affinity")},
4027
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
4028 4029 4030
    {NULL, NULL}
};

4031
static const vshCmdOptDef opts_vcpupin[] = {
4032
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4033 4034 4035
    {"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")},
4036 4037 4038
    {"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")},
4039 4040 4041
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4042
static bool
E
Eric Blake 已提交
4043
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
4044 4045 4046 4047
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
4048
    int vcpu = -1;
4049
    const char *cpulist = NULL;
E
Eric Blake 已提交
4050
    bool ret = true;
4051 4052
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
4053
    size_t cpumaplen;
4054 4055
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
4056
    bool unuse = false;
4057
    const char *cur;
4058 4059 4060
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
4061
    bool query = false; /* Query mode if no cpulist */
E
Eric Blake 已提交
4062
    unsigned int flags = 0;
4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078

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

4080
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4081
        return false;
4082

J
Jim Meyering 已提交
4083
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4084
        return false;
4085

4086 4087
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
4088
        virDomainFree(dom);
E
Eric Blake 已提交
4089
        return false;
4090
    }
4091
    query = !cpulist;
4092

4093 4094 4095 4096
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
4097
        virDomainFree(dom);
E
Eric Blake 已提交
4098
        return false;
4099
    }
4100

4101 4102
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
4103
        return false;
4104 4105 4106
    }

    if (virDomainGetInfo(dom, &info) != 0) {
4107
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
4108
        virDomainFree(dom);
E
Eric Blake 已提交
4109
        return false;
4110 4111 4112
    }

    if (vcpu >= info.nrVirtCpu) {
4113
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
4114
        virDomainFree(dom);
E
Eric Blake 已提交
4115
        return false;
4116 4117
    }

4118 4119
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
4120

4121 4122 4123 4124 4125 4126 4127 4128
    /* 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 已提交
4129
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174
                                             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);
4175 4176
    /* Parse cpulist */
    cur = cpulist;
4177
    if (*cur == 0) {
4178
        goto parse_error;
4179 4180 4181
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
4182
        cur = "";
4183
    }
4184 4185 4186 4187 4188 4189 4190

    while (*cur != 0) {

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

4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204
        /* 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);
4205

4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232
        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);
        }
4233

4234 4235 4236 4237 4238 4239
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
4240
        } else {
4241
            goto parse_error;
4242
        }
4243
    }
4244

4245 4246 4247 4248 4249 4250 4251 4252
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
4253 4254
    }

4255
cleanup:
4256
    VIR_FREE(cpumap);
4257 4258
    virDomainFree(dom);
    return ret;
4259 4260 4261 4262 4263

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

4266 4267 4268
/*
 * "setvcpus" command
 */
4269
static const vshCmdInfo info_setvcpus[] = {
4270 4271
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
4272 4273 4274
    {NULL, NULL}
};

4275
static const vshCmdOptDef opts_setvcpus[] = {
4276
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4277
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
4278 4279 4280
    {"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")},
4281
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
4282 4283 4284
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4285
static bool
4286
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
4287 4288
{
    virDomainPtr dom;
4289
    int count = 0;
E
Eric Blake 已提交
4290
    bool ret = true;
E
Eric Blake 已提交
4291 4292 4293
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
4294
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4295
    unsigned int flags = 0;
4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311

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

4313
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4314
        return false;
4315

J
Jim Meyering 已提交
4316
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4317
        return false;
4318

4319 4320 4321 4322
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
4323

4324
    if (flags == -1) {
E
Eric Blake 已提交
4325
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
4326
            ret = false;
E
Eric Blake 已提交
4327 4328
        }
    } else {
4329 4330 4331
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
4332
            vshDebug(ctl, VSH_ERR_DEBUG, "--maximum flag was given\n");
4333

4334 4335
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

4336 4337 4338 4339 4340 4341 4342 4343
            /* 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 已提交
4344
                ret = false;
4345 4346 4347 4348 4349
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
4350
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
4351
            ret = false;
E
Eric Blake 已提交
4352
        }
4353 4354
    }

4355
  cleanup:
4356 4357 4358 4359
    virDomainFree(dom);
    return ret;
}

4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393
/*
 * "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;
}

4394 4395 4396 4397 4398
/*
 * "send-key" command
 */
static const vshCmdInfo info_send_key[] = {
    {"help", N_("Send keycodes to the guest")},
4399
    {"desc", N_("Send keycodes (integers or symbolic names) to the guest")},
4400 4401 4402 4403 4404
    {NULL, NULL}
};

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4405 4406
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT,
     N_("the codeset of keycodes, default:linux")},
4407
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
A
Alex Jia 已提交
4408
     N_("the time (in milliseconds) how long the keys will be held")},
4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480
    {"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;
}

4481 4482 4483
/*
 * "setmemory" command
 */
4484
static const vshCmdInfo info_setmem[] = {
4485 4486
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
4487 4488 4489
    {NULL, NULL}
};

4490
static const vshCmdOptDef opts_setmem[] = {
4491
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4492
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
4493 4494
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
4495
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
4496 4497 4498
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4499
static bool
4500
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
4501 4502
{
    virDomainPtr dom;
4503
    virDomainInfo info;
4504
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
4505
    bool ret = true;
4506 4507
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
4508
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4509
    unsigned int flags = 0;
4510

4511 4512 4513
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4514
            return false;
4515
        }
4516
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4517 4518
    } else {
        if (config)
4519
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4520
        if (live)
4521
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4522 4523 4524
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
4525
    }
4526

4527
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4528
        return false;
4529

J
Jim Meyering 已提交
4530
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4531
        return false;
4532

4533 4534
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4535
        return false;
4536 4537
    }

4538
    if (kilobytes <= 0) {
4539
        virDomainFree(dom);
4540
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
4541
        return false;
4542 4543
    }

4544 4545
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
4546
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
4547
        return false;
4548 4549 4550 4551
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
4552
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
4553
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
4554
        return false;
4555 4556
    }

4557
    if (flags == -1) {
4558
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
4559
            ret = false;
4560 4561 4562
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
4563
            ret = false;
4564
        }
4565 4566 4567 4568 4569 4570 4571 4572 4573
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
4574
static const vshCmdInfo info_setmaxmem[] = {
4575 4576
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
4577 4578 4579
    {NULL, NULL}
};

4580
static const vshCmdOptDef opts_setmaxmem[] = {
4581
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4582
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
4583 4584 4585
    {"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")},
4586 4587 4588
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4589
static bool
4590
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
4591 4592
{
    virDomainPtr dom;
4593
    int kilobytes = 0;
E
Eric Blake 已提交
4594
    bool ret = true;
4595 4596 4597
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
4598
    unsigned int flags = VIR_DOMAIN_MEM_MAXIMUM;
4599 4600 4601 4602

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
4603
            return false;
4604 4605 4606
        }
    } else {
        if (config)
4607
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4608
        if (live)
4609
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4610 4611 4612 4613
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
4614

4615
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4616
        return false;
4617

J
Jim Meyering 已提交
4618
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4619
        return false;
4620

4621 4622
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
4623
        return false;
4624 4625
    }

4626
    if (kilobytes <= 0) {
4627
        virDomainFree(dom);
4628
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
4629
        return false;
4630 4631
    }

4632 4633 4634
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4635
            ret = false;
4636 4637 4638 4639
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
4640
            ret = false;
4641
        }
4642 4643
    }

4644 4645 4646 4647
    virDomainFree(dom);
    return ret;
}

4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663
/*
 * "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]")},
4664 4665
    {"device-weights", VSH_OT_STRING, VSH_OFLAG_NONE,
     N_("per-device IO Weights, in the form of /path/to/device,weight,...")},
H
Hu Tao 已提交
4666 4667 4668
    {"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")},
4669 4670 4671
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4672
static bool
4673 4674 4675
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
4676
    const char *device_weight = NULL;
4677 4678
    int weight = 0;
    int nparams = 0;
4679
    int rv = 0;
4680
    unsigned int i = 0;
4681
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4682
    bool ret = false;
H
Hu Tao 已提交
4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699
    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;
    }
4700 4701

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4702
        return false;
4703 4704

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

4707
    if ((rv = vshCommandOptInt(cmd, "weight", &weight)) < 0) {
4708 4709 4710 4711 4712
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

4713
    if (rv > 0) {
4714
        nparams++;
4715
        if (weight <= 0) {
4716 4717 4718 4719 4720
            vshError(ctl, _("Invalid value of %d for I/O weight"), weight);
            goto cleanup;
        }
    }

4721 4722 4723 4724 4725 4726 4727 4728 4729 4730
    rv = vshCommandOptString(cmd, "device-weights", &device_weight);
    if (rv < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse string parameter"));
        goto cleanup;
    }
    if (rv > 0) {
        nparams++;
    }

4731 4732
    if (nparams == 0) {
        /* get the number of blkio parameters */
H
Hu Tao 已提交
4733
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
4734 4735 4736 4737 4738 4739 4740
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4741
            ret = true;
4742 4743 4744 4745 4746
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
4747
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
4748 4749 4750 4751 4752 4753
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4754
                case VIR_TYPED_PARAM_INT:
4755 4756 4757
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4758
                case VIR_TYPED_PARAM_UINT:
4759 4760 4761
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4762
                case VIR_TYPED_PARAM_LLONG:
4763 4764 4765
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4766
                case VIR_TYPED_PARAM_ULLONG:
4767 4768 4769
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
4770
                case VIR_TYPED_PARAM_DOUBLE:
4771 4772 4773
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4774
                case VIR_TYPED_PARAM_BOOLEAN:
4775 4776 4777
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
4778 4779 4780 4781
                case VIR_TYPED_PARAM_STRING:
                    vshPrint(ctl, "%-15s: %s\n", params[i].field,
                             params[i].value.s);
                    break;
4782 4783 4784 4785 4786 4787 4788 4789 4790 4791
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4792
            temp->type = VIR_TYPED_PARAM_UINT;
4793 4794 4795

            if (weight) {
                temp->value.ui = weight;
4796 4797 4798
                if (!virStrcpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                               sizeof(temp->field)))
                    goto cleanup;
4799 4800
                weight = 0;
            } else if (device_weight) {
4801 4802 4803 4804 4805
                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;
4806
                device_weight = NULL;
4807 4808
            }
        }
4809 4810

        if (virDomainSetBlkioParameters(dom, params, nparams, flags) < 0) {
4811
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
4812 4813
            goto cleanup;
        }
4814 4815
    }

4816 4817
    ret = true;

4818
  cleanup:
4819
    virTypedParameterArrayClear(params, nparams);
4820 4821 4822 4823 4824
    VIR_FREE(params);
    virDomainFree(dom);
    return ret;
}

4825 4826 4827 4828
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
4829 4830 4831
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
4832 4833 4834 4835 4836 4837 4838
                "    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")},
4839
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4840
     N_("Max memory in kilobytes")},
4841
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4842
     N_("Memory during contention in kilobytes")},
4843
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
4844
     N_("Max memory plus swap in kilobytes")},
4845
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
4846
     N_("Min guaranteed memory in kilobytes")},
4847 4848 4849
    {"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")},
4850 4851 4852
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4853
static bool
4854 4855 4856
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
4857 4858
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
4859 4860
    int nparams = 0;
    unsigned int i = 0;
4861
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
4862
    bool ret = false;
4863 4864 4865 4866 4867 4868 4869 4870 4871 4872
    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;
        }
4873
        flags = VIR_DOMAIN_AFFECT_CURRENT;
4874 4875
    } else {
        if (config)
4876
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
4877
        if (live)
4878
            flags |= VIR_DOMAIN_AFFECT_LIVE;
4879
    }
4880 4881

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4882
        return false;
4883 4884

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

4887 4888 4889 4890 4891 4892 4893 4894 4895
    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;
    }

4896 4897 4898 4899 4900 4901 4902 4903 4904
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

4905 4906 4907
    if (min_guarantee)
        nparams++;

4908 4909
    if (nparams == 0) {
        /* get the number of memory parameters */
4910
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
4911 4912 4913 4914 4915
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

4916 4917
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4918
            ret = true;
4919 4920 4921
            goto cleanup;
        }

4922
        /* now go get all the memory parameters */
E
Eric Blake 已提交
4923
        params = vshCalloc(ctl, nparams, sizeof(*params));
4924
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
4925 4926 4927 4928 4929 4930
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4931
                case VIR_TYPED_PARAM_INT:
4932 4933 4934
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4935
                case VIR_TYPED_PARAM_UINT:
4936 4937 4938
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4939
                case VIR_TYPED_PARAM_LLONG:
4940 4941 4942
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4943
                case VIR_TYPED_PARAM_ULLONG:
4944 4945 4946 4947 4948
                    if (params[i].value.ul == VIR_DOMAIN_MEMORY_PARAM_UNLIMITED)
                        vshPrint(ctl, "%-15s: unlimited\n", params[i].field);
                    else
                        vshPrint(ctl, "%-15s: %llu kB\n", params[i].field,
                                 params[i].value.ul);
4949
                    break;
4950
                case VIR_TYPED_PARAM_DOUBLE:
4951 4952 4953
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4954
                case VIR_TYPED_PARAM_BOOLEAN:
4955 4956 4957 4958
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
4959
                    vshPrint(ctl, "unimplemented memory parameter type\n");
4960 4961 4962
            }
        }

E
Eric Blake 已提交
4963
        ret = true;
4964 4965
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
4966
        params = vshCalloc(ctl, nparams, sizeof(*params));
4967 4968 4969

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
4970
            temp->type = VIR_TYPED_PARAM_ULLONG;
4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989

            /*
             * 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;
4990
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
4991 4992
                        sizeof(temp->field));
                swap_hard_limit = 0;
4993 4994 4995 4996 4997
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
4998
            }
4999 5000 5001 5002

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
5003
        }
5004
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
5005
            vshError(ctl, "%s", _("Unable to change memory parameters"));
5006
        else
E
Eric Blake 已提交
5007
            ret = true;
5008 5009 5010
    }

  cleanup:
E
Eric Blake 已提交
5011
    VIR_FREE(params);
5012 5013 5014 5015
    virDomainFree(dom);
    return ret;
}

5016 5017 5018
/*
 * "nodeinfo" command
 */
5019
static const vshCmdInfo info_nodeinfo[] = {
5020 5021
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
5022 5023 5024
    {NULL, NULL}
};

E
Eric Blake 已提交
5025
static bool
5026
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5027 5028
{
    virNodeInfo info;
5029

5030
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5031
        return false;
5032 5033

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
5034
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
5035
        return false;
5036 5037 5038 5039 5040 5041 5042 5043 5044 5045
    }
    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 已提交
5046
    return true;
5047 5048
}

5049 5050 5051 5052 5053
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
5054
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
5055 5056 5057 5058 5059 5060 5061 5062 5063 5064
    {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
5065
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
5066 5067 5068 5069
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
5070 5071
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114
    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;

5115
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
5116
                cpu_stats[i].sys = value;
5117
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
5118
                cpu_stats[i].user = value;
5119
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
5120
                cpu_stats[i].idle = value;
5121
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
5122
                cpu_stats[i].iowait = value;
5123
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137
                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) {
5138
            vshPrint(ctl, "%-15s %20llu\n", _("user:"), cpu_stats[0].user);
5139
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
5140
            vshPrint(ctl, "%-15s %20llu\n", _("idle:"), cpu_stats[0].idle);
5141 5142 5143 5144 5145 5146 5147
            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);
5148
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle:"), 100 - usage);
5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160
        } 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",
5161
                     _("user:"), user_time / total_time * 100);
5162
            vshPrint(ctl, "%-15s %5.1lf%%\n",
5163
                     _("system:"), sys_time  / total_time * 100);
5164
            vshPrint(ctl, "%-15s %5.1lf%%\n",
5165
                     _("idle:"), idle_time     / total_time * 100);
5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196
/*
 * "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;
5197 5198
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
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
    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;
}

5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301
/*
 * "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;

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

    if (vshCommandOptLongLong(cmd, "duration", &duration) < 0)
        return false;

    if (vshCommandOptUInt(cmd, "flags", &flags) < 0)
        return false;

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


5302 5303 5304
/*
 * "capabilities" command
 */
5305
static const vshCmdInfo info_capabilities[] = {
5306 5307
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
5308 5309 5310
    {NULL, NULL}
};

E
Eric Blake 已提交
5311
static bool
5312
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5313 5314 5315
{
    char *caps;

5316
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5317
        return false;
5318 5319

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
5320
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
5321
        return false;
5322 5323
    }
    vshPrint (ctl, "%s\n", caps);
5324
    VIR_FREE(caps);
5325

E
Eric Blake 已提交
5326
    return true;
5327 5328
}

5329 5330 5331
/*
 * "dumpxml" command
 */
5332
static const vshCmdInfo info_dumpxml[] = {
5333 5334
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
5335
    {NULL, NULL}
5336 5337
};

5338
static const vshCmdOptDef opts_dumpxml[] = {
5339 5340 5341
    {"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")},
5342
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
5343
    {NULL, 0, 0, NULL}
5344 5345
};

E
Eric Blake 已提交
5346
static bool
5347
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
5348
{
5349
    virDomainPtr dom;
E
Eric Blake 已提交
5350
    bool ret = true;
5351
    char *dump;
E
Eric Blake 已提交
5352
    unsigned int flags = 0;
5353 5354
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
5355
    int update = vshCommandOptBool(cmd, "update-cpu");
5356 5357 5358 5359 5360

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
5361 5362
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
5363

5364
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5365
        return false;
5366

J
Jim Meyering 已提交
5367
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
5368
        return false;
5369

5370
    dump = virDomainGetXMLDesc(dom, flags);
5371
    if (dump != NULL) {
5372
        vshPrint(ctl, "%s", dump);
5373
        VIR_FREE(dump);
5374
    } else {
E
Eric Blake 已提交
5375
        ret = false;
5376
    }
5377

5378 5379 5380 5381
    virDomainFree(dom);
    return ret;
}

5382 5383 5384 5385
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
5386 5387
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
5388 5389 5390 5391
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
5392 5393
    {"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")},
5394 5395 5396
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5397
static bool
5398 5399
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5400
    bool ret = true;
5401 5402
    const char *format = NULL;
    const char *configFile = NULL;
5403 5404
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
5405
    unsigned int flags = 0;
5406

5407
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5408
        return false;
5409

5410 5411
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
5412
        return false;
5413

5414
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
5415
        return false;
5416 5417 5418

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
5419
        vshPrint(ctl, "%s", xmlData);
5420
        VIR_FREE(xmlData);
5421
    } else {
E
Eric Blake 已提交
5422
        ret = false;
5423 5424 5425 5426 5427 5428 5429 5430 5431
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
5432 5433
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
5434 5435 5436 5437
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
5438 5439
    {"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")},
5440 5441 5442
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5443
static bool
5444 5445
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5446
    bool ret = true;
5447 5448
    const char *format = NULL;
    const char *xmlFile = NULL;
5449 5450
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
5451
    unsigned int flags = 0;
5452

5453
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5454
        return false;
5455

5456 5457
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
5458
        return false;
5459

5460
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
5461
        return false;
5462 5463 5464

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
5465
        vshPrint(ctl, "%s", configData);
5466
        VIR_FREE(configData);
5467
    } else {
E
Eric Blake 已提交
5468
        ret = false;
5469 5470 5471 5472 5473
    }

    return ret;
}

K
Karel Zak 已提交
5474
/*
K
Karel Zak 已提交
5475
 * "domname" command
K
Karel Zak 已提交
5476
 */
5477
static const vshCmdInfo info_domname[] = {
5478
    {"help", N_("convert a domain id or UUID to domain name")},
5479
    {"desc", ""},
5480
    {NULL, NULL}
K
Karel Zak 已提交
5481 5482
};

5483
static const vshCmdOptDef opts_domname[] = {
5484
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
5485
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5486 5487
};

E
Eric Blake 已提交
5488
static bool
5489
cmdDomname(vshControl *ctl, const vshCmd *cmd)
5490
{
K
Karel Zak 已提交
5491 5492
    virDomainPtr dom;

5493
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5494
        return false;
J
Jim Meyering 已提交
5495
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5496
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
5497
        return false;
5498

K
Karel Zak 已提交
5499 5500
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
5501
    return true;
K
Karel Zak 已提交
5502 5503 5504
}

/*
K
Karel Zak 已提交
5505
 * "domid" command
K
Karel Zak 已提交
5506
 */
5507
static const vshCmdInfo info_domid[] = {
5508
    {"help", N_("convert a domain name or UUID to domain id")},
5509
    {"desc", ""},
5510
    {NULL, NULL}
K
Karel Zak 已提交
5511 5512
};

5513
static const vshCmdOptDef opts_domid[] = {
5514
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
5515
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5516 5517
};

E
Eric Blake 已提交
5518
static bool
5519
cmdDomid(vshControl *ctl, const vshCmd *cmd)
5520
{
5521
    virDomainPtr dom;
5522
    unsigned int id;
K
Karel Zak 已提交
5523

5524
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5525
        return false;
J
Jim Meyering 已提交
5526
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5527
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
5528
        return false;
5529

5530 5531
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
5532
        vshPrint(ctl, "%s\n", "-");
5533
    else
5534
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
5535
    virDomainFree(dom);
E
Eric Blake 已提交
5536
    return true;
K
Karel Zak 已提交
5537
}
5538

K
Karel Zak 已提交
5539 5540 5541
/*
 * "domuuid" command
 */
5542
static const vshCmdInfo info_domuuid[] = {
5543
    {"help", N_("convert a domain name or id to domain UUID")},
5544
    {"desc", ""},
K
Karel Zak 已提交
5545 5546 5547
    {NULL, NULL}
};

5548
static const vshCmdOptDef opts_domuuid[] = {
5549
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
5550 5551 5552
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5553
static bool
5554
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
5555 5556
{
    virDomainPtr dom;
5557
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
5558

5559
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5560
        return false;
J
Jim Meyering 已提交
5561
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
5562
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
5563
        return false;
5564

K
Karel Zak 已提交
5565 5566 5567
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
5568
        vshError(ctl, "%s", _("failed to get domain UUID"));
5569

5570
    virDomainFree(dom);
E
Eric Blake 已提交
5571
    return true;
K
Karel Zak 已提交
5572 5573
}

5574 5575 5576
/*
 * "migrate" command
 */
5577
static const vshCmdInfo info_migrate[] = {
5578 5579
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
5580 5581 5582
    {NULL, NULL}
};

5583
static const vshCmdOptDef opts_migrate[] = {
5584 5585 5586 5587 5588 5589 5590
    {"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")},
5591 5592
    {"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)")},
5593 5594
    {"change-protection", VSH_OT_BOOL, 0,
     N_("prevent any configuration changes to domain until migration ends)")},
W
Wen Congyang 已提交
5595
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
5596
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
5597
    {"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)")},
5598 5599
    {"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 已提交
5600
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
5601
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
5602 5603 5604
    {NULL, 0, 0, NULL}
};

5605 5606 5607 5608 5609 5610 5611 5612
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
5613
{
5614
    char ret = '1';
5615
    virDomainPtr dom = NULL;
5616 5617 5618
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
E
Eric Blake 已提交
5619
    unsigned int flags = 0;
5620 5621 5622
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
5623 5624
    const char *xmlfile = NULL;
    char *xml = NULL;
5625
    sigset_t sigmask, oldsigmask;
5626 5627 5628 5629 5630

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

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

J
Jim Meyering 已提交
5635
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
5636
        goto out;
5637

5638 5639
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
5640 5641
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
5642
        goto out;
5643
    }
5644

5645 5646 5647 5648 5649
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

5650 5651
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
5652 5653
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
5654
    if (vshCommandOptBool (cmd, "tunnelled"))
5655
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
5656

C
Chris Lalancette 已提交
5657 5658 5659 5660 5661
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

5662 5663 5664
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

5665 5666 5667 5668 5669 5670
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

5671 5672
    if (vshCommandOptBool (cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;
5673 5674 5675 5676 5677 5678

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


5679 5680 5681 5682
    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. */
5683

5684
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
5685
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
5686
            goto out;
5687
        }
5688

5689
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
5690
            ret = '0';
5691 5692 5693 5694 5695 5696
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
5697
        if (!dconn) goto out;
5698

5699
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
5700 5701
        if (ddom) {
            virDomainFree(ddom);
5702
            ret = '0';
5703 5704 5705
        }
        virConnectClose (dconn);
    }
5706

5707 5708 5709
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
5710
    if (dom) virDomainFree (dom);
5711
    VIR_FREE(xml);
5712 5713 5714
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
5715
static void
5716 5717
print_job_progress(const char *label, unsigned long long remaining,
                   unsigned long long total)
W
Wen Congyang 已提交
5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736
{
    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;
        }
    }

5737 5738
    /* see comments in vshError about why we must flush */
    fflush(stdout);
5739
    fprintf(stderr, "\r%s: [%3d %%]", label, progress);
5740
    fflush(stderr);
W
Wen Congyang 已提交
5741 5742
}

E
Eric Blake 已提交
5743
static bool
5744 5745 5746 5747 5748
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
5749
    bool functionReturn = false;
5750 5751 5752 5753 5754
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
5755 5756
    virDomainJobInfo jobinfo;
    bool verbose = false;
5757
    int timeout = 0;
W
Wen Congyang 已提交
5758 5759
    struct timeval start, curr;
    bool live_flag = false;
5760
    vshCtrlData data;
5761 5762 5763 5764
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
5765 5766

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

W
Wen Congyang 已提交
5769 5770 5771
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
5772
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
5773
        live_flag = true;
5774
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791
        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;
        }
    }

5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814
    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 已提交
5815
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
5816
    while (1) {
5817
repoll:
W
Wen Congyang 已提交
5818 5819 5820 5821
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
5822
                    functionReturn = true;
W
Wen Congyang 已提交
5823 5824
                    if (verbose) {
                        /* print [100 %] */
5825
                        print_job_progress("Migration", 0, 1);
W
Wen Congyang 已提交
5826 5827
                    }
                } else
W
Wen Congyang 已提交
5828
                    functionReturn = false;
5829
            } else
W
Wen Congyang 已提交
5830
                functionReturn = false;
W
Wen Congyang 已提交
5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
5842
            functionReturn = false;
W
Wen Congyang 已提交
5843 5844 5845
            break;
        }

W
Wen Congyang 已提交
5846 5847 5848 5849
        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. */
5850 5851
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "suspend the domain when migration timeouts\n");
W
Wen Congyang 已提交
5852 5853 5854 5855
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
5856 5857 5858 5859 5860
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
5861 5862
                print_job_progress("Migration", jobinfo.dataRemaining,
                                   jobinfo.dataTotal);
5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
5874
    return functionReturn;
5875 5876
}

5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887
/*
 * "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")},
5888
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
5889 5890 5891
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5892
static bool
5893 5894 5895
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
5896
    long long downtime = 0;
E
Eric Blake 已提交
5897
    bool ret = false;
5898

5899
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5900
        return false;
5901 5902

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

5905 5906
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
5907 5908 5909 5910 5911 5912 5913
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
5914
    ret = true;
5915 5916 5917 5918 5919 5920

done:
    virDomainFree(dom);
    return ret;
}

5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964
/*
 * "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;
}

5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003
/*
 * "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;
}

6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020
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))
6021
        goto cleanup;
6022 6023

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

    if (vshCommandOptString(cmd, "path", &path) < 0)
6027
        goto cleanup;
6028

6029 6030
    if (vshCommandOptUL(cmd, "bandwidth", &bandwidth) < 0) {
        vshError(ctl, "%s", _("bandwidth must be a number"));
6031
        goto cleanup;
6032
    }
6033 6034 6035 6036 6037 6038 6039 6040 6041 6042

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

6043
cleanup:
6044 6045
    if (dom)
        virDomainFree(dom);
6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128
    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;
}

6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185
/*
 * "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;
}
6186

6187 6188 6189
/*
 * "net-autostart" command
 */
6190
static const vshCmdInfo info_network_autostart[] = {
6191
    {"help", N_("autostart a network")},
6192
    {"desc",
6193
     N_("Configure a network to be automatically started at boot.")},
6194 6195 6196
    {NULL, NULL}
};

6197
static const vshCmdOptDef opts_network_autostart[] = {
6198 6199
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6200 6201 6202
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6203
static bool
6204
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
6205 6206
{
    virNetworkPtr network;
6207
    const char *name;
6208 6209
    int autostart;

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

J
Jim Meyering 已提交
6213
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6214
        return false;
6215 6216 6217 6218

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
6219
        if (autostart)
6220
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
6221
        else
6222
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
6223
        virNetworkFree(network);
E
Eric Blake 已提交
6224
        return false;
6225 6226
    }

6227
    if (autostart)
6228
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
6229
    else
6230
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
6231

L
Laine Stump 已提交
6232
    virNetworkFree(network);
E
Eric Blake 已提交
6233
    return true;
6234
}
K
Karel Zak 已提交
6235

L
Lei Li 已提交
6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 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
/*
 * "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++) {
            switch(params[i].type) {
                case VIR_TYPED_PARAM_INT:
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
                case VIR_TYPED_PARAM_UINT:
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
                case VIR_TYPED_PARAM_LLONG:
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
                case VIR_TYPED_PARAM_ULLONG:
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                             params[i].value.ul);
                    break;
                case VIR_TYPED_PARAM_DOUBLE:
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
                case VIR_TYPED_PARAM_BOOLEAN:
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented block I/O throttle parameter type\n");
            }
        }

6404
        ret = true;
6405
        goto cleanup;
L
Lei Li 已提交
6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 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 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478
    } 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;
}

6479 6480 6481
/*
 * "net-create" command
 */
6482
static const vshCmdInfo info_network_create[] = {
6483 6484
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
6485 6486 6487
    {NULL, NULL}
};

6488
static const vshCmdOptDef opts_network_create[] = {
6489
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
6490 6491 6492
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6493
static bool
6494
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
6495 6496
{
    virNetworkPtr network;
6497
    const char *from = NULL;
E
Eric Blake 已提交
6498
    bool ret = true;
6499
    char *buffer;
6500

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

6504
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6505
        return false;
6506

6507
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6508
        return false;
6509 6510

    network = virNetworkCreateXML(ctl->conn, buffer);
6511
    VIR_FREE(buffer);
6512

6513 6514 6515
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
6516
        virNetworkFree(network);
6517
    } else {
6518
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
6519
        ret = false;
6520 6521 6522 6523 6524 6525 6526 6527
    }
    return ret;
}


/*
 * "net-define" command
 */
6528
static const vshCmdInfo info_network_define[] = {
6529 6530
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
6531 6532 6533
    {NULL, NULL}
};

6534
static const vshCmdOptDef opts_network_define[] = {
6535
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
6536 6537 6538
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6539
static bool
6540
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
6541 6542
{
    virNetworkPtr network;
6543
    const char *from = NULL;
E
Eric Blake 已提交
6544
    bool ret = true;
6545
    char *buffer;
6546

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

6550
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6551
        return false;
6552

6553
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6554
        return false;
6555 6556

    network = virNetworkDefineXML(ctl->conn, buffer);
6557
    VIR_FREE(buffer);
6558

6559 6560 6561
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
6562
        virNetworkFree(network);
6563
    } else {
6564
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
6565
        ret = false;
6566 6567 6568 6569 6570 6571 6572 6573
    }
    return ret;
}


/*
 * "net-destroy" command
 */
6574
static const vshCmdInfo info_network_destroy[] = {
6575 6576
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
6577 6578 6579
    {NULL, NULL}
};

6580
static const vshCmdOptDef opts_network_destroy[] = {
6581
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6582 6583 6584
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6585
static bool
6586
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
6587 6588
{
    virNetworkPtr network;
E
Eric Blake 已提交
6589
    bool ret = true;
6590
    const char *name;
6591

6592
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6593
        return false;
6594

J
Jim Meyering 已提交
6595
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6596
        return false;
6597 6598 6599 6600

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

6605
    virNetworkFree(network);
6606 6607 6608 6609 6610 6611 6612
    return ret;
}


/*
 * "net-dumpxml" command
 */
6613
static const vshCmdInfo info_network_dumpxml[] = {
6614 6615
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
6616 6617 6618
    {NULL, NULL}
};

6619
static const vshCmdOptDef opts_network_dumpxml[] = {
6620
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6621 6622 6623
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6624
static bool
6625
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
6626 6627
{
    virNetworkPtr network;
E
Eric Blake 已提交
6628
    bool ret = true;
6629 6630
    char *dump;

6631
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6632
        return false;
6633

J
Jim Meyering 已提交
6634
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
6635
        return false;
6636 6637 6638

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
6639
        vshPrint(ctl, "%s", dump);
6640
        VIR_FREE(dump);
6641
    } else {
E
Eric Blake 已提交
6642
        ret = false;
6643 6644 6645 6646 6647 6648
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
6649 6650 6651 6652 6653
/*
 * "net-info" command
 */
static const vshCmdInfo info_network_info[] = {
    {"help", N_("network information")},
E
Eric Blake 已提交
6654
    {"desc", N_("Returns basic information about the network")},
O
Osier Yang 已提交
6655 6656 6657 6658 6659 6660 6661 6662
    {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 已提交
6663
static bool
O
Osier Yang 已提交
6664 6665 6666 6667 6668 6669 6670 6671 6672 6673
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 已提交
6674
        return false;
O
Osier Yang 已提交
6675 6676 6677

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6678
        return false;
O
Osier Yang 已提交
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

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

6704
    VIR_FREE(bridge);
O
Osier Yang 已提交
6705
    virNetworkFree(network);
E
Eric Blake 已提交
6706
    return true;
O
Osier Yang 已提交
6707
}
6708

6709 6710 6711 6712
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
6713 6714
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
6715 6716 6717 6718
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
6719
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6720 6721 6722
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6723
static bool
6724 6725
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6726
    bool ret = false;
6727 6728 6729 6730 6731
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
6732
    unsigned int flags = VIR_INTERFACE_XML_INACTIVE;
6733

6734
    if (!vshConnectionUsability(ctl, ctl->conn))
6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760
        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 已提交
6761
        ret = true;
6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773
        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)) {
6774 6775
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787
        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 已提交
6788
    ret = true;
6789 6790 6791 6792 6793

cleanup:
    if (iface)
        virInterfaceFree (iface);

6794 6795 6796
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
6797 6798 6799

    if (tmp) {
        unlink (tmp);
6800
        VIR_FREE(tmp);
6801 6802 6803 6804 6805
    }

    return ret;
}

6806 6807 6808
/*
 * "net-list" command
 */
6809
static const vshCmdInfo info_network_list[] = {
6810 6811
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
6812 6813 6814
    {NULL, NULL}
};

6815
static const vshCmdOptDef opts_network_list[] = {
6816 6817
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
6818 6819 6820
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6821
static bool
6822
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6823 6824 6825 6826 6827
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
6828
    char **activeNames = NULL, **inactiveNames = NULL;
6829 6830
    inactive |= all;

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

    if (active) {
6835 6836
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
6837
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
6838
            return false;
6839
        }
6840
        if (maxactive) {
6841
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
6842

6843
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
6844
                                                    maxactive)) < 0) {
6845
                vshError(ctl, "%s", _("Failed to list active networks"));
6846
                VIR_FREE(activeNames);
E
Eric Blake 已提交
6847
                return false;
6848
            }
6849

6850
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
6851
        }
6852 6853
    }
    if (inactive) {
6854 6855
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
6856
            vshError(ctl, "%s", _("Failed to list inactive networks"));
6857
            VIR_FREE(activeNames);
E
Eric Blake 已提交
6858
            return false;
6859
        }
6860 6861 6862
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

6863 6864 6865
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
6866
                vshError(ctl, "%s", _("Failed to list inactive networks"));
6867 6868
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6869
                return false;
6870
            }
6871

6872 6873
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
6874
    }
6875 6876
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
6877
    vshPrintExtra(ctl, "-----------------------------------------\n");
6878 6879

    for (i = 0; i < maxactive; i++) {
6880 6881
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
6882 6883
        const char *autostartStr;
        int autostart = 0;
6884 6885 6886

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6887
            VIR_FREE(activeNames[i]);
6888
            continue;
6889
        }
6890

6891 6892 6893
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6894
            autostartStr = autostart ? _("yes") : _("no");
6895 6896 6897 6898 6899

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
6900
        virNetworkFree(network);
6901
        VIR_FREE(activeNames[i]);
6902 6903 6904
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
6905 6906
        const char *autostartStr;
        int autostart = 0;
6907 6908 6909

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6910
            VIR_FREE(inactiveNames[i]);
6911
            continue;
6912
        }
6913

6914 6915 6916
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6917
            autostartStr = autostart ? _("yes") : _("no");
6918

6919
        vshPrint(ctl, "%-20s %-10s %-10s\n",
6920 6921 6922
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
6923 6924

        virNetworkFree(network);
6925
        VIR_FREE(inactiveNames[i]);
6926
    }
6927 6928
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6929
    return true;
6930 6931 6932 6933 6934 6935
}


/*
 * "net-name" command
 */
6936
static const vshCmdInfo info_network_name[] = {
6937
    {"help", N_("convert a network UUID to network name")},
6938
    {"desc", ""},
6939 6940 6941
    {NULL, NULL}
};

6942
static const vshCmdOptDef opts_network_name[] = {
6943
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
6944 6945 6946
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6947
static bool
6948
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
6949 6950 6951
{
    virNetworkPtr network;

6952
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6953
        return false;
J
Jim Meyering 已提交
6954
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
6955
                                           VSH_BYUUID)))
E
Eric Blake 已提交
6956
        return false;
6957 6958 6959

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
6960
    return true;
6961 6962 6963 6964 6965 6966
}


/*
 * "net-start" command
 */
6967
static const vshCmdInfo info_network_start[] = {
6968 6969
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
6970 6971 6972
    {NULL, NULL}
};

6973
static const vshCmdOptDef opts_network_start[] = {
6974
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
6975 6976 6977
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6978
static bool
6979
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
6980 6981
{
    virNetworkPtr network;
E
Eric Blake 已提交
6982
    bool ret = true;
6983

6984
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6985
        return false;
6986

J
Jim Meyering 已提交
6987
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
6988
         return false;
6989 6990 6991

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
6992
                 virNetworkGetName(network));
6993
    } else {
6994
        vshError(ctl, _("Failed to start network %s"),
6995
                 virNetworkGetName(network));
E
Eric Blake 已提交
6996
        ret = false;
6997
    }
L
Laine Stump 已提交
6998
    virNetworkFree(network);
6999 7000 7001 7002 7003 7004 7005
    return ret;
}


/*
 * "net-undefine" command
 */
7006
static const vshCmdInfo info_network_undefine[] = {
7007 7008
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
7009 7010 7011
    {NULL, NULL}
};

7012
static const vshCmdOptDef opts_network_undefine[] = {
7013
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
7014 7015 7016
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7017
static bool
7018
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
7019 7020
{
    virNetworkPtr network;
E
Eric Blake 已提交
7021
    bool ret = true;
7022
    const char *name;
7023

7024
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7025
        return false;
7026

J
Jim Meyering 已提交
7027
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
7028
        return false;
7029 7030 7031 7032

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

L
Laine Stump 已提交
7037
    virNetworkFree(network);
7038 7039 7040 7041 7042 7043 7044
    return ret;
}


/*
 * "net-uuid" command
 */
7045
static const vshCmdInfo info_network_uuid[] = {
7046
    {"help", N_("convert a network name to network UUID")},
7047
    {"desc", ""},
7048 7049 7050
    {NULL, NULL}
};

7051
static const vshCmdOptDef opts_network_uuid[] = {
7052
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
7053 7054 7055
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7056
static bool
7057
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
7058 7059 7060 7061
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

7062
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7063
        return false;
7064

J
Jim Meyering 已提交
7065
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
7066
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7067
        return false;
7068 7069 7070 7071

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

L
Laine Stump 已提交
7074
    virNetworkFree(network);
E
Eric Blake 已提交
7075
    return true;
7076 7077 7078
}


7079 7080 7081 7082 7083
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
7084 7085
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
7086 7087 7088 7089
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
7090 7091
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
7092 7093
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
7094
static bool
7095 7096 7097 7098 7099 7100 7101 7102 7103
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;

7104
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7105
        return false;
7106 7107 7108 7109

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
7110
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
7111
            return false;
7112 7113 7114 7115 7116 7117
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
7118
                vshError(ctl, "%s", _("Failed to list active interfaces"));
7119
                VIR_FREE(activeNames);
E
Eric Blake 已提交
7120
                return false;
7121 7122 7123 7124 7125 7126 7127 7128
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
7129
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
7130
            VIR_FREE(activeNames);
E
Eric Blake 已提交
7131
            return false;
7132 7133 7134 7135
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

7136 7137 7138
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
7139
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
7140 7141
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
7142
                return false;
7143 7144 7145 7146 7147
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
7148 7149
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
7150 7151 7152
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
7153 7154
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
7155 7156 7157

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
7158
            VIR_FREE(activeNames[i]);
7159 7160 7161 7162 7163 7164 7165 7166
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
7167
        VIR_FREE(activeNames[i]);
7168 7169
    }
    for (i = 0; i < maxinactive; i++) {
7170 7171
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
7172 7173 7174

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
7175
            VIR_FREE(inactiveNames[i]);
7176 7177 7178 7179 7180 7181 7182 7183
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
7184
        VIR_FREE(inactiveNames[i]);
7185
    }
7186 7187
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
7188
    return true;
7189 7190 7191 7192 7193 7194 7195

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
7196
    {"help", N_("convert an interface MAC address to interface name")},
7197 7198 7199 7200 7201
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
7202
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
7203 7204 7205
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7206
static bool
7207 7208 7209 7210
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

7211
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7212
        return false;
7213
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL, NULL,
7214
                                           VSH_BYMAC)))
E
Eric Blake 已提交
7215
        return false;
7216 7217 7218

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
7219
    return true;
7220 7221 7222 7223 7224 7225
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
7226
    {"help", N_("convert an interface name to interface MAC address")},
7227 7228 7229 7230 7231
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
7232
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
7233 7234 7235
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7236
static bool
7237 7238 7239 7240
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

7241
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7242
        return false;
7243
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL, NULL,
7244
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7245
        return false;
7246 7247 7248

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
7249
    return true;
7250 7251 7252 7253 7254 7255
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
7256 7257
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
7258 7259 7260 7261
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
7262 7263
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
7264 7265 7266
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7267
static bool
7268 7269 7270
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
7271
    bool ret = true;
7272
    char *dump;
E
Eric Blake 已提交
7273
    unsigned int flags = 0;
7274 7275 7276 7277
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
7278

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

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

7285
    dump = virInterfaceGetXMLDesc(iface, flags);
7286
    if (dump != NULL) {
7287
        vshPrint(ctl, "%s", dump);
7288
        VIR_FREE(dump);
7289
    } else {
E
Eric Blake 已提交
7290
        ret = false;
7291 7292 7293 7294 7295 7296 7297 7298 7299 7300
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
7301 7302
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
7303 7304 7305 7306
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
7307
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
7308 7309 7310
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7311
static bool
7312 7313
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
7314
    virInterfacePtr iface;
7315
    const char *from = NULL;
E
Eric Blake 已提交
7316
    bool ret = true;
7317 7318
    char *buffer;

7319
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7320
        return false;
7321

7322
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7323
        return false;
7324 7325

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

7328
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
7329
    VIR_FREE(buffer);
7330

7331
    if (iface != NULL) {
7332
        vshPrint(ctl, _("Interface %s defined from %s\n"),
7333
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
7334
        virInterfaceFree (iface);
7335
    } else {
7336
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
7337
        ret = false;
7338 7339 7340 7341 7342 7343 7344 7345
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
7346 7347
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
7348 7349 7350 7351
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
7352
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
7353 7354 7355
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7356
static bool
7357 7358 7359
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
7360
    bool ret = true;
7361
    const char *name;
7362

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

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
7367
        return false;
7368 7369 7370 7371

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
7372
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
7373
        ret = false;
7374 7375 7376 7377 7378 7379 7380 7381 7382 7383
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
7384 7385
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
7386 7387 7388 7389
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
7390
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
7391 7392 7393
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7394
static bool
7395 7396 7397
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
7398
    bool ret = true;
7399
    const char *name;
7400

7401
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7402
        return false;
7403 7404

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
7405
        return false;
7406 7407 7408 7409

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
7410
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
7411
        ret = false;
7412 7413 7414 7415 7416 7417 7418 7419 7420 7421
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
7422
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
7423
    {"desc", N_("forcefully stop a physical host interface.")},
7424 7425 7426 7427
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
7428
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
7429 7430 7431
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7432
static bool
7433 7434 7435
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
7436
    bool ret = true;
7437
    const char *name;
7438

7439
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7440
        return false;
7441 7442

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
7443
        return false;
7444 7445 7446 7447

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
7448
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
7449
        ret = false;
7450 7451 7452 7453 7454 7455
    }

    virInterfaceFree(iface);
    return ret;
}

7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540
/*
 * "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;
}
7541

7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 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 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
/*
 * "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;
}

7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968
/*
 * "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 已提交
7969
static bool
7970 7971 7972
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
7973
    const char *from = NULL;
E
Eric Blake 已提交
7974
    bool ret = true;
7975 7976
    char *buffer;

7977
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7978
        return false;
7979

7980
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7981
        return false;
7982 7983

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
7984
        return false;
7985 7986 7987 7988 7989 7990 7991 7992 7993 7994

    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 已提交
7995
        ret = false;
7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014
    }
    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 已提交
8015
static bool
8016 8017 8018
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
8019
    bool ret = true;
8020
    const char *name;
8021

8022
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8023
        return false;
8024 8025

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
8026
        return false;
8027 8028 8029 8030 8031

    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 已提交
8032
        ret = false;
8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053
    }

    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 已提交
8054
static bool
8055 8056 8057
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
8058
    bool ret = true;
8059 8060
    char *dump;

8061
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8062
        return false;
8063 8064

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
8065
        return false;
8066 8067 8068

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
8069
        vshPrint(ctl, "%s", dump);
8070 8071
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
8072
        ret = false;
8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091
    }

    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 已提交
8092
static bool
8093 8094 8095 8096 8097 8098
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

8099
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8100
        return false;
8101 8102 8103 8104

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
8105
        return false;
8106 8107 8108 8109 8110 8111 8112 8113
    }

    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 已提交
8114
        return false;
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
    }

    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 已提交
8142
    return true;
8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159
}


/*
 * "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 已提交
8160
static bool
8161 8162
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
8163
    bool ret = false;
8164 8165 8166 8167 8168 8169
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

8170
    if (!vshConnectionUsability(ctl, ctl->conn))
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
        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 已提交
8197
        ret = true;
8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223
        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 已提交
8224
    ret = true;
8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242

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


8243
/**************************************************************************/
8244
/*
8245
 * "pool-autostart" command
8246
 */
8247
static const vshCmdInfo info_pool_autostart[] = {
8248
    {"help", N_("autostart a pool")},
8249
    {"desc",
8250
     N_("Configure a pool to be automatically started at boot.")},
8251
    {NULL, NULL}
8252 8253
};

8254
static const vshCmdOptDef opts_pool_autostart[] = {
8255 8256
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
8257 8258
    {NULL, 0, 0, NULL}
};
8259

E
Eric Blake 已提交
8260
static bool
8261
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
8262
{
8263
    virStoragePoolPtr pool;
8264
    const char *name;
8265
    int autostart;
8266

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

8270
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8271
        return false;
8272

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

8275 8276
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
8277
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
8278
        else
8279
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
8280
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8281
        return false;
8282 8283
    }

8284
    if (autostart)
8285
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
8286
    else
8287
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
8288

L
Laine Stump 已提交
8289
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8290
    return true;
8291 8292
}

8293
/*
8294
 * "pool-create" command
8295
 */
8296
static const vshCmdInfo info_pool_create[] = {
8297 8298
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
8299 8300 8301
    {NULL, NULL}
};

8302
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
8303
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
8304
     N_("file containing an XML pool description")},
8305 8306 8307
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8308
static bool
8309
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
8310
{
8311
    virStoragePoolPtr pool;
8312
    const char *from = NULL;
E
Eric Blake 已提交
8313
    bool ret = true;
8314
    char *buffer;
8315

8316
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8317
        return false;
8318

8319
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8320
        return false;
8321

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

8325
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
8326
    VIR_FREE(buffer);
8327 8328 8329 8330

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
8331
        virStoragePoolFree(pool);
8332
    } else {
8333
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
8334
        ret = false;
8335 8336
    }
    return ret;
8337 8338
}

8339

8340 8341 8342 8343
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
8344
    {"help", N_("create a device defined "
8345
                          "by an XML file on the node")},
8346
    {"desc", N_("Create a device on the node.  Note that this "
8347 8348 8349 8350 8351 8352 8353
                          "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,
8354
     N_("file containing an XML description of the device")},
8355 8356 8357
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8358
static bool
8359 8360 8361
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
8362
    const char *from = NULL;
E
Eric Blake 已提交
8363
    bool ret = true;
8364 8365
    char *buffer;

8366
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8367
        return false;
8368

8369
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8370
        return false;
8371

8372
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
8373
        return false;
8374 8375

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
8376
    VIR_FREE(buffer);
8377 8378 8379 8380

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
8381
        virNodeDeviceFree(dev);
8382
    } else {
8383
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
8384
        ret = false;
8385 8386 8387 8388 8389 8390 8391 8392 8393 8394
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
8395
    {"help", N_("destroy (stop) a device on the node")},
8396
    {"desc", N_("Destroy a device on the node.  Note that this "
8397
                "command destroys devices on the physical host")},
8398 8399 8400 8401 8402
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
8403
     N_("name of the device to be destroyed")},
8404 8405 8406
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8407
static bool
8408 8409 8410
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
8411
    bool ret = true;
8412
    const char *name = NULL;
8413

8414
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
8415
        return false;
8416 8417
    }

8418
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
8419
        return false;
8420 8421 8422 8423 8424 8425

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
8426
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
8427
        ret = false;
8428 8429 8430 8431 8432 8433 8434
    }

    virNodeDeviceFree(dev);
    return ret;
}


8435
/*
8436
 * XML Building helper for pool-define-as and pool-create-as
8437
 */
8438
static const vshCmdOptDef opts_pool_X_as[] = {
8439 8440 8441 8442 8443 8444 8445 8446
    {"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")},
8447
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
8448 8449 8450
    {NULL, 0, 0, NULL}
};

8451
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
8452

8453 8454
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
8455
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8456

8457
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8458
        goto cleanup;
8459
    if (vshCommandOptString(cmd, "type", &type) <= 0)
8460 8461
        goto cleanup;

8462 8463 8464 8465 8466
    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 ||
8467 8468
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
8469
        goto cleanup;
8470
    }
8471

8472 8473
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
8474
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
8475
        virBufferAddLit(&buf, "  <source>\n");
8476

8477
        if (srcHost)
8478
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
8479
        if (srcPath)
8480
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
8481
        if (srcDev)
8482
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
8483
        if (srcFormat)
8484
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
8485
        if (srcName)
8486
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
8487 8488

        virBufferAddLit(&buf, "  </source>\n");
8489 8490
    }
    if (target) {
8491
        virBufferAddLit(&buf, "  <target>\n");
8492
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
8493
        virBufferAddLit(&buf, "  </target>\n");
8494
    }
8495 8496 8497 8498
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
8499
        return false;
8500
    }
8501 8502 8503

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
8504
    return true;
8505 8506

cleanup:
8507
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
8508
    return false;
8509 8510 8511 8512 8513 8514
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
8515 8516
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
8517 8518 8519
    {NULL, NULL}
};

E
Eric Blake 已提交
8520
static bool
8521 8522 8523
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
8524 8525
    const char *name;
    char *xml;
8526
    int printXML = vshCommandOptBool(cmd, "print-xml");
8527

8528
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8529
        return false;
8530 8531

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

8534
    if (printXML) {
8535
        vshPrint(ctl, "%s", xml);
8536
        VIR_FREE(xml);
8537
    } else {
8538
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
8539
        VIR_FREE(xml);
8540

8541 8542 8543 8544
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
8545
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
8546
            return false;
8547 8548
        }
    }
E
Eric Blake 已提交
8549
    return true;
8550 8551
}

8552

8553
/*
8554
 * "pool-define" command
8555
 */
8556
static const vshCmdInfo info_pool_define[] = {
8557 8558
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
8559 8560 8561
    {NULL, NULL}
};

8562
static const vshCmdOptDef opts_pool_define[] = {
8563
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
8564 8565 8566
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8567
static bool
8568
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
8569
{
8570
    virStoragePoolPtr pool;
8571
    const char *from = NULL;
E
Eric Blake 已提交
8572
    bool ret = true;
8573
    char *buffer;
8574

8575
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8576
        return false;
8577

8578
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8579
        return false;
8580

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

8584
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
8585
    VIR_FREE(buffer);
8586 8587 8588 8589

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
8590
        virStoragePoolFree(pool);
8591
    } else {
8592
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
8593
        ret = false;
8594 8595
    }
    return ret;
8596 8597
}

8598

8599 8600 8601
/*
 * "pool-define-as" command
 */
8602
static const vshCmdInfo info_pool_define_as[] = {
8603 8604
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
8605 8606 8607
    {NULL, NULL}
};

E
Eric Blake 已提交
8608
static bool
8609
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
8610 8611
{
    virStoragePoolPtr pool;
8612 8613
    const char *name;
    char *xml;
8614
    int printXML = vshCommandOptBool(cmd, "print-xml");
8615

8616
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8617
        return false;
8618

8619
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
8620
        return false;
8621

8622
    if (printXML) {
8623
        vshPrint(ctl, "%s", xml);
8624
        VIR_FREE(xml);
8625
    } else {
8626
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
8627
        VIR_FREE(xml);
8628

8629 8630 8631 8632
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
8633
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
8634
            return false;
8635 8636
        }
    }
E
Eric Blake 已提交
8637
    return true;
8638 8639 8640
}


8641
/*
8642
 * "pool-build" command
8643
 */
8644
static const vshCmdInfo info_pool_build[] = {
8645 8646
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
8647 8648 8649
    {NULL, NULL}
};

8650
static const vshCmdOptDef opts_pool_build[] = {
8651
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8652 8653
    {"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")},
8654 8655 8656
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8657
static bool
8658
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
8659
{
8660
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8661
    bool ret = true;
8662
    const char *name;
8663
    unsigned int flags = 0;
8664

8665
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8666
        return false;
8667

8668
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8669
        return false;
8670

8671 8672 8673 8674 8675 8676 8677 8678 8679
    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) {
8680
        vshPrint(ctl, _("Pool %s built\n"), name);
8681
    } else {
8682
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
8683
        ret = false;
8684 8685
    }

8686 8687
    virStoragePoolFree(pool);

8688 8689 8690
    return ret;
}

8691
/*
8692
 * "pool-destroy" command
8693
 */
8694
static const vshCmdInfo info_pool_destroy[] = {
8695 8696 8697
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
8698 8699 8700
    {NULL, NULL}
};

8701
static const vshCmdOptDef opts_pool_destroy[] = {
8702
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8703 8704 8705
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8706
static bool
8707
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
8708
{
8709
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8710
    bool ret = true;
8711
    const char *name;
8712

8713
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8714
        return false;
8715

8716
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8717
        return false;
8718

8719 8720 8721
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
8722
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
8723
        ret = false;
8724 8725
    }

8726
    virStoragePoolFree(pool);
8727 8728 8729
    return ret;
}

8730

8731
/*
8732 8733
 * "pool-delete" command
 */
8734
static const vshCmdInfo info_pool_delete[] = {
8735 8736
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
8737 8738 8739
    {NULL, NULL}
};

8740
static const vshCmdOptDef opts_pool_delete[] = {
8741
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8742 8743 8744
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8745
static bool
8746
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
8747 8748
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8749
    bool ret = true;
8750
    const char *name;
8751

8752
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8753
        return false;
8754 8755

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8756
        return false;
8757 8758

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
8759
        vshPrint(ctl, _("Pool %s deleted\n"), name);
8760
    } else {
8761
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
8762
        ret = false;
8763 8764
    }

L
Laine Stump 已提交
8765
    virStoragePoolFree(pool);
8766 8767 8768 8769 8770 8771 8772
    return ret;
}


/*
 * "pool-refresh" command
 */
8773
static const vshCmdInfo info_pool_refresh[] = {
8774 8775
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
8776 8777 8778
    {NULL, NULL}
};

8779
static const vshCmdOptDef opts_pool_refresh[] = {
8780
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8781 8782 8783
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8784
static bool
8785
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
8786 8787
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8788
    bool ret = true;
8789
    const char *name;
8790

8791
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8792
        return false;
8793 8794

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8795
        return false;
8796 8797 8798 8799

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
8800
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
8801
        ret = false;
8802 8803 8804 8805 8806 8807 8808 8809 8810 8811
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
8812
static const vshCmdInfo info_pool_dumpxml[] = {
8813 8814
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
8815 8816 8817
    {NULL, NULL}
};

8818
static const vshCmdOptDef opts_pool_dumpxml[] = {
8819
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8820 8821 8822
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8823
static bool
8824
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
8825 8826
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8827
    bool ret = true;
8828 8829
    char *dump;

8830
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8831
        return false;
8832 8833

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8834
        return false;
8835 8836 8837

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
8838
        vshPrint(ctl, "%s", dump);
8839
        VIR_FREE(dump);
8840
    } else {
E
Eric Blake 已提交
8841
        ret = false;
8842 8843 8844 8845 8846 8847 8848 8849 8850 8851
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
8852
static const vshCmdInfo info_pool_list[] = {
8853 8854
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
8855 8856 8857
    {NULL, NULL}
};

8858
static const vshCmdOptDef opts_pool_list[] = {
8859 8860
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
8861
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
8862 8863 8864
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8865
static bool
8866
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8867
{
8868 8869
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
8870 8871
    int i, ret;
    bool functionReturn;
8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887
    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 */
8888
    int all = vshCommandOptBool(cmd, "all");
8889 8890
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
8891 8892 8893
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

8894
    /* Check the connection to libvirtd daemon is still working */
8895
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8896
        return false;
8897

8898
    /* Retrieve the number of active storage pools */
8899
    if (active) {
8900 8901
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
8902
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
8903
            return false;
8904 8905
        }
    }
8906 8907

    /* Retrieve the number of inactive storage pools */
8908
    if (inactive) {
8909 8910
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
8911
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
8912
            return false;
8913
        }
8914
    }
8915

8916 8917
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
8918

8919 8920 8921 8922 8923 8924 8925 8926 8927 8928 8929 8930
    /* 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 已提交
8931
            return false;
8932 8933 8934
        }
    }

8935 8936 8937 8938 8939 8940 8941 8942
    /* 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 已提交
8943
            return false;
8944 8945
        }
    }
8946

8947 8948 8949 8950 8951 8952 8953 8954 8955 8956
    /* 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]);
8957
        if (!pool) {
8958
            VIR_FREE(poolNames[i]);
8959 8960 8961
            continue;
        }

8962
        /* Retrieve the autostart status of the pool */
8963
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
8964
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
8965
        else
8966 8967 8968 8969 8970 8971
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
8972 8973
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984
            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;
        }
8985

8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096 9097
        /* 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 */
9098 9099 9100
        virStoragePoolFree(pool);
    }

9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118
    /* 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);
9119 9120
        }

9121
        /* Cleanup and return */
E
Eric Blake 已提交
9122
        functionReturn = true;
9123 9124
        goto cleanup;
    }
9125

9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163
    /* 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. */
9164
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
9165
             (unsigned long) nameStrLength);
9166
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
9167
             (unsigned long) stateStrLength);
9168
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
9169
             (unsigned long) autostartStrLength);
9170
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
9171
             (unsigned long) persistStrLength);
9172
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
9173
             (unsigned long) capStrLength);
9174
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
9175
             (unsigned long) allocStrLength);
9176
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219
             (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 已提交
9220
    functionReturn = true;
9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234
    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 已提交
9235
    functionReturn = false;
9236

9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248
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]);
9249
    }
9250 9251 9252 9253 9254 9255 9256

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

    /* Return the desired value */
    return functionReturn;
9257 9258
}

9259 9260 9261 9262
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
9263 9264
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
9265 9266 9267 9268 9269
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
9270 9271 9272
     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")},
9273
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
9274 9275 9276
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9277
static bool
9278 9279
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
9280
    const char *type = NULL, *host = NULL;
9281 9282
    char *srcSpec = NULL;
    char *srcList;
9283
    const char *initiator = NULL;
9284

9285 9286
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
9287 9288
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
9289
        return false;
9290
    }
9291

9292
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9293
        return false;
9294 9295

    if (host) {
9296
        const char *port = NULL;
9297
        virBuffer buf = VIR_BUFFER_INITIALIZER;
9298 9299 9300 9301

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
9302
            return false;
9303
        }
9304
        virBufferAddLit(&buf, "<source>\n");
9305
        virBufferAsprintf(&buf, "  <host name='%s'", host);
9306
        if (port)
9307
            virBufferAsprintf(&buf, " port='%s'", port);
9308
        virBufferAddLit(&buf, "/>\n");
9309 9310
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
9311
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
9312 9313
            virBufferAddLit(&buf, "  </initiator>\n");
        }
9314 9315 9316
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
9317
            return false;
9318
        }
9319
        srcSpec = virBufferContentAndReset(&buf);
9320 9321 9322
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
9323
    VIR_FREE(srcSpec);
9324
    if (srcList == NULL) {
9325
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
9326
        return false;
9327 9328
    }
    vshPrint(ctl, "%s", srcList);
9329
    VIR_FREE(srcList);
9330

E
Eric Blake 已提交
9331
    return true;
9332 9333 9334 9335 9336 9337 9338
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
9339 9340
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
9341 9342 9343 9344 9345
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
9346
     N_("type of storage pool sources to discover")},
9347
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
9348
     N_("optional file of source xml to query for pools")},
9349 9350 9351
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9352
static bool
9353 9354
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
9355
    const char *type = NULL, *srcSpecFile = NULL;
9356
    char *srcSpec = NULL, *srcList;
9357

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

9361 9362
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
9363
        return false;
9364
    }
9365

9366
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9367
        return false;
9368 9369

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
9370
        return false;
9371 9372

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
9373
    VIR_FREE(srcSpec);
9374
    if (srcList == NULL) {
9375
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
9376
        return false;
9377 9378
    }
    vshPrint(ctl, "%s", srcList);
9379
    VIR_FREE(srcList);
9380

E
Eric Blake 已提交
9381
    return true;
9382 9383 9384
}


9385 9386 9387
/*
 * "pool-info" command
 */
9388
static const vshCmdInfo info_pool_info[] = {
9389 9390
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
9391 9392 9393
    {NULL, NULL}
};

9394
static const vshCmdOptDef opts_pool_info[] = {
9395
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9396 9397 9398
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9399
static bool
9400
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
9401 9402 9403
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
9404 9405
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
9406
    bool ret = true;
9407 9408
    char uuid[VIR_UUID_STRING_BUFLEN];

9409
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9410
        return false;
9411 9412

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
9413
        return false;
9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439

    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;
9440 9441 9442 9443
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
9444 9445
        }

9446 9447
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
9448 9449
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
9450 9451 9452 9453 9454 9455 9456
        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);
9457 9458
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
9459 9460 9461 9462 9463
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

9464 9465 9466 9467 9468 9469 9470 9471 9472 9473 9474 9475
        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 已提交
9476
        ret = false;
9477 9478 9479 9480 9481 9482 9483 9484 9485 9486
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
9487
static const vshCmdInfo info_pool_name[] = {
9488
    {"help", N_("convert a pool UUID to pool name")},
9489
    {"desc", ""},
9490 9491 9492
    {NULL, NULL}
};

9493
static const vshCmdOptDef opts_pool_name[] = {
9494
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
9495 9496 9497
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9498
static bool
9499
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
9500 9501 9502
{
    virStoragePoolPtr pool;

9503
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9504
        return false;
9505
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
9506
                                           VSH_BYUUID)))
E
Eric Blake 已提交
9507
        return false;
9508 9509 9510

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9511
    return true;
9512 9513 9514 9515 9516 9517
}


/*
 * "pool-start" command
 */
9518
static const vshCmdInfo info_pool_start[] = {
9519 9520
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
9521 9522 9523
    {NULL, NULL}
};

9524
static const vshCmdOptDef opts_pool_start[] = {
9525
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
9526 9527 9528
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9529
static bool
9530
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
9531 9532
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
9533
    bool ret = true;
9534

9535
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9536
        return false;
9537

9538
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
9539
         return false;
9540 9541 9542 9543 9544

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
9545
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
9546
        ret = false;
9547
    }
L
Laine Stump 已提交
9548 9549

    virStoragePoolFree(pool);
9550 9551 9552 9553
    return ret;
}


9554 9555 9556
/*
 * "vol-create-as" command
 */
9557
static const vshCmdInfo info_vol_create_as[] = {
9558 9559
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
9560 9561 9562
    {NULL, NULL}
};

9563
static const vshCmdOptDef opts_vol_create_as[] = {
9564 9565 9566 9567 9568
    {"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")},
9569 9570
    {"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")},
9571 9572 9573 9574 9575 9576 9577 9578 9579 9580
    {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 已提交
9581
        /* Deliberate fallthrough cases here :-) */
9582 9583 9584
        switch (*end) {
        case 'T':
            *val *= 1024;
9585
            /* fallthrough */
9586 9587
        case 'G':
            *val *= 1024;
9588
            /* fallthrough */
9589 9590
        case 'M':
            *val *= 1024;
9591
            /* fallthrough */
9592 9593 9594 9595 9596 9597 9598 9599 9600 9601 9602 9603 9604
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
9605
static bool
9606
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
9607 9608 9609
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9610
    char *xml;
9611 9612
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
9613
    unsigned long long capacity, allocation = 0;
9614
    virBuffer buf = VIR_BUFFER_INITIALIZER;
9615

9616
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9617
        return false;
9618 9619 9620

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

9623
    if (vshCommandOptString(cmd, "name", &name) <= 0)
9624 9625
        goto cleanup;

9626
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
9627 9628
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
9629
        vshError(ctl, _("Malformed size %s"), capacityStr);
9630

9631 9632
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
9633
        vshError(ctl, _("Malformed size %s"), allocationStr);
9634

9635 9636 9637 9638 9639 9640 9641
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

9642

9643
    virBufferAddLit(&buf, "<volume>\n");
9644 9645
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
9646
    if (allocationStr)
9647
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
9648 9649

    if (format) {
9650
        virBufferAddLit(&buf, "  <target>\n");
9651
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
9652
        virBufferAddLit(&buf, "  </target>\n");
9653
    }
9654

9655 9656 9657 9658
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
9659 9660
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
9661 9662 9663
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
9664 9665
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
9666 9667 9668 9669 9670
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
9671 9672
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
9673 9674 9675
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
9676 9677
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
9678 9679 9680 9681 9682
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
9683 9684
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
9685 9686 9687
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
9688 9689
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
9690 9691 9692 9693
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
9694
            goto cleanup;
9695 9696 9697 9698 9699
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
9700
            goto cleanup;
9701 9702 9703 9704
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
9705
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
9706
        if (snapshotStrFormat)
9707
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
9708 9709 9710 9711 9712 9713 9714 9715
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

9717 9718
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
9719
        goto cleanup;
9720 9721 9722
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
9723
    VIR_FREE(xml);
9724 9725 9726 9727 9728
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
9729
        return true;
9730
    } else {
9731
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
9732
        return false;
9733 9734 9735
    }

 cleanup:
9736
    virBufferFreeAndReset(&buf);
9737
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9738
    return false;
9739 9740 9741
}


9742 9743 9744
/*
 * "pool-undefine" command
 */
9745
static const vshCmdInfo info_pool_undefine[] = {
9746 9747
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
9748 9749 9750
    {NULL, NULL}
};

9751
static const vshCmdOptDef opts_pool_undefine[] = {
9752
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9753 9754 9755
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9756
static bool
9757
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
9758 9759
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
9760
    bool ret = true;
9761
    const char *name;
9762

9763
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9764
        return false;
9765 9766

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
9767
        return false;
9768 9769 9770 9771

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

L
Laine Stump 已提交
9776
    virStoragePoolFree(pool);
9777 9778 9779 9780 9781 9782 9783
    return ret;
}


/*
 * "pool-uuid" command
 */
9784
static const vshCmdInfo info_pool_uuid[] = {
9785
    {"help", N_("convert a pool name to pool UUID")},
9786
    {"desc", ""},
9787 9788 9789
    {NULL, NULL}
};

9790
static const vshCmdOptDef opts_pool_uuid[] = {
9791
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
9792 9793 9794
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9795
static bool
9796
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
9797 9798 9799 9800
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

9801
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9802
        return false;
9803 9804

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
9805
                                           VSH_BYNAME)))
E
Eric Blake 已提交
9806
        return false;
9807 9808 9809 9810

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

L
Laine Stump 已提交
9813
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9814
    return true;
9815 9816 9817 9818 9819 9820
}


/*
 * "vol-create" command
 */
9821
static const vshCmdInfo info_vol_create[] = {
9822 9823
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
9824 9825 9826
    {NULL, NULL}
};

9827
static const vshCmdOptDef opts_vol_create[] = {
9828 9829
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
9830 9831 9832
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9833
static bool
9834
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
9835 9836 9837
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9838
    const char *from = NULL;
E
Eric Blake 已提交
9839
    bool ret = true;
9840 9841
    char *buffer;

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

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

9849
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9850
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9851
        return false;
9852 9853 9854
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9855
        virshReportError(ctl);
9856
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9857
        return false;
9858 9859 9860
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
9861
    VIR_FREE(buffer);
9862 9863 9864 9865 9866 9867 9868
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
9869
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
9870
        ret = false;
9871 9872 9873 9874
    }
    return ret;
}

9875 9876 9877 9878
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
9879 9880
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
9881 9882 9883 9884
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
9885 9886 9887
    {"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 已提交
9888
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
9889 9890 9891
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9892
static bool
9893 9894 9895 9896
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
9897
    const char *from = NULL;
E
Eric Blake 已提交
9898
    bool ret = false;
9899 9900
    char *buffer = NULL;

9901
    if (!vshConnectionUsability(ctl, ctl->conn))
9902 9903 9904 9905 9906
        goto cleanup;

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

9907
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9908 9909 9910 9911 9912 9913 9914
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9915
        virshReportError(ctl);
9916 9917 9918 9919 9920 9921 9922 9923 9924
        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 {
9925
        vshError(ctl, _("Failed to create vol from %s"), from);
9926 9927 9928
        goto cleanup;
    }

E
Eric Blake 已提交
9929
    ret = true;
9930
cleanup:
9931
    VIR_FREE(buffer);
9932 9933 9934 9935
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
9936 9937
    if (newvol)
        virStorageVolFree(newvol);
9938 9939 9940 9941
    return ret;
}

static xmlChar *
9942 9943
makeCloneXML(const char *origxml, const char *newname)
{
9944

9945 9946 9947
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
9948 9949 9950
    xmlChar *newxml = NULL;
    int size;

9951
    doc = virXMLParseStringCtxt(origxml, _("(volume_definition)"), &ctxt);
9952 9953 9954 9955 9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973
    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[] = {
9974 9975
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
9976 9977 9978 9979
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
9980 9981
    {"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 已提交
9982
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9983 9984 9985
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9986
static bool
9987 9988 9989 9990
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
9991
    const char *name = NULL;
9992
    char *origxml = NULL;
9993
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
9994
    bool ret = false;
9995

9996
    if (!vshConnectionUsability(ctl, ctl->conn))
9997 9998 9999 10000 10001 10002 10003
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
10004
        vshError(ctl, "%s", _("failed to get parent pool"));
10005 10006 10007
        goto cleanup;
    }

10008
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026
        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 {
10027
        vshError(ctl, _("Failed to clone vol from %s"),
10028 10029 10030 10031
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
10032
    ret = true;
10033 10034

cleanup:
10035
    VIR_FREE(origxml);
10036 10037 10038
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
10039 10040
    if (newvol)
        virStorageVolFree(newvol);
10041 10042 10043 10044 10045
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

10046 10047 10048 10049 10050 10051 10052 10053 10054 10055 10056 10057 10058

/*
 * "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 已提交
10059
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10060 10061 10062 10063 10064 10065 10066 10067 10068 10069 10070 10071 10072 10073
    {"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 已提交
10074
static bool
10075 10076 10077 10078
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
10079
    bool ret = false;
10080 10081 10082 10083 10084 10085 10086 10087 10088 10089
    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 已提交
10090
        return false;
10091 10092 10093 10094
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
10095
        return false;
10096 10097 10098
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
10099
        return false;
10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 10127 10128 10129 10130 10131 10132 10133
    }

    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 已提交
10134
    ret = true;
10135 10136 10137 10138 10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158

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 已提交
10159
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10160 10161 10162 10163 10164
    {"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 已提交
10165
static bool
10166 10167 10168 10169
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
10170
    bool ret = false;
10171 10172 10173 10174
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
10175
    bool created = false;
10176 10177

    if (!vshConnectionUsability(ctl, ctl->conn))
10178
        return false;
10179 10180 10181

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
10182
        return false;
10183 10184 10185 10186
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
10187
        return false;
10188 10189 10190
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
10191
        return false;
10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203

    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;
        }
10204 10205
    } else {
        created = true;
10206 10207 10208 10209 10210 10211 10212 10213
    }

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

10214
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229
        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 已提交
10230
    ret = true;
10231 10232

cleanup:
10233
    VIR_FORCE_CLOSE(fd);
10234
    if (!ret && created)
10235 10236 10237 10238 10239 10240 10241 10242 10243
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


10244 10245 10246
/*
 * "vol-delete" command
 */
10247
static const vshCmdInfo info_vol_delete[] = {
10248 10249
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
10250 10251 10252
    {NULL, NULL}
};

10253
static const vshCmdOptDef opts_vol_delete[] = {
10254
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
10255
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10256 10257 10258
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10259
static bool
10260
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
10261 10262
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
10263
    bool ret = true;
10264
    const char *name;
10265

10266
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10267
        return false;
10268 10269

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
10270
        return false;
10271 10272 10273
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
10274
        vshPrint(ctl, _("Vol %s deleted\n"), name);
10275
    } else {
10276
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
10277
        ret = false;
10278 10279
    }

L
Laine Stump 已提交
10280
    virStorageVolFree(vol);
10281 10282 10283 10284
    return ret;
}


D
David Allan 已提交
10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295
/*
 * "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 已提交
10296
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
10297 10298 10299
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10300
static bool
D
David Allan 已提交
10301 10302 10303
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
10304
    bool ret = true;
10305
    const char *name;
D
David Allan 已提交
10306

10307
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10308
        return false;
D
David Allan 已提交
10309 10310

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
10311
        return false;
D
David Allan 已提交
10312 10313 10314 10315 10316 10317
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
10318
        ret = false;
D
David Allan 已提交
10319 10320 10321 10322 10323 10324 10325
    }

    virStorageVolFree(vol);
    return ret;
}


10326 10327 10328
/*
 * "vol-info" command
 */
10329
static const vshCmdInfo info_vol_info[] = {
10330 10331
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
10332 10333 10334
    {NULL, NULL}
};

10335
static const vshCmdOptDef opts_vol_info[] = {
10336
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
10337
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10338 10339 10340
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10341
static bool
10342
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
10343 10344 10345
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
10346
    bool ret = true;
10347

10348
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10349
        return false;
10350 10351

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
10352
        return false;
10353 10354 10355 10356 10357 10358

    vshPrint(ctl, "%-15s %s\n", _("Name:"), virStorageVolGetName(vol));

    if (virStorageVolGetInfo(vol, &info) == 0) {
        double val;
        const char *unit;
R
Ryota Ozaki 已提交
10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374
        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"));
        }
10375 10376 10377 10378 10379 10380 10381

        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 已提交
10382
        ret = false;
10383 10384 10385 10386 10387 10388 10389 10390 10391 10392
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
10393
static const vshCmdInfo info_vol_dumpxml[] = {
10394 10395
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
10396 10397 10398
    {NULL, NULL}
};

10399
static const vshCmdOptDef opts_vol_dumpxml[] = {
10400
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
10401
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10402 10403 10404
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10405
static bool
10406
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
10407 10408
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
10409
    bool ret = true;
10410 10411
    char *dump;

10412
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10413
        return false;
10414 10415

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
10416
        return false;
10417 10418 10419

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
10420
        vshPrint(ctl, "%s", dump);
10421
        VIR_FREE(dump);
10422
    } else {
E
Eric Blake 已提交
10423
        ret = false;
10424 10425 10426 10427 10428 10429 10430 10431 10432 10433
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
10434
static const vshCmdInfo info_vol_list[] = {
10435 10436
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
10437 10438 10439
    {NULL, NULL}
};

10440
static const vshCmdOptDef opts_vol_list[] = {
10441
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10442
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
10443 10444 10445
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10446
static bool
10447
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10448
{
10449
    virStorageVolInfo volumeInfo;
10450 10451
    virStoragePoolPtr pool;
    char **activeNames = NULL;
10452 10453 10454 10455 10456
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
10457 10458
    int ret;
    bool functionReturn;
10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469
    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;
10470

10471
    /* Check the connection to libvirtd daemon is still working */
10472
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10473
        return false;
10474

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

10479 10480
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
10481

10482 10483 10484
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
10485
        return false;
10486 10487
    }

10488 10489 10490 10491 10492
    /* 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) {
10493
            vshError(ctl, "%s", _("Failed to list active vols"));
10494
            VIR_FREE(activeNames);
10495
            virStoragePoolFree(pool);
E
Eric Blake 已提交
10496
            return false;
10497 10498
        }

10499 10500 10501 10502 10503
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

10506 10507 10508 10509 10510
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
10511

10512 10513 10514 10515
        /* 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"));
10516 10517
        }

10518 10519 10520 10521 10522 10523 10524 10525 10526
        /* 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 */
10527

10528
                /* Volume type */
10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541
                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"));
                }
10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591

                /* 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;
        }
10592

10593
        /* Cleanup memory allocation */
10594
        virStorageVolFree(vol);
10595 10596 10597 10598 10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612
    }

    /* 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 已提交
10613
        functionReturn = true;
10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644
        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 */
10645 10646 10647 10648 10649 10650 10651 10652 10653 10654
    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);
10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688

    /* 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 已提交
10689
    functionReturn = true;
10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703
    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 已提交
10704
    functionReturn = false;
10705 10706 10707 10708 10709 10710 10711 10712 10713 10714

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);
10715
        VIR_FREE(activeNames[i]);
10716
    }
10717 10718 10719 10720

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
10721
    VIR_FREE(activeNames);
10722
    virStoragePoolFree(pool);
10723 10724 10725

    /* Return the desired value */
    return functionReturn;
10726 10727 10728 10729 10730 10731
}


/*
 * "vol-name" command
 */
10732
static const vshCmdInfo info_vol_name[] = {
10733
    {"help", N_("returns the volume name for a given volume key or path")},
10734
    {"desc", ""},
10735 10736 10737
    {NULL, NULL}
};

10738
static const vshCmdOptDef opts_vol_name[] = {
10739
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
10740 10741 10742
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10743
static bool
10744
cmdVolName(vshControl *ctl, const vshCmd *cmd)
10745 10746 10747
{
    virStorageVolPtr vol;

10748
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10749
        return false;
10750

10751
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
10752
                                   VSH_BYUUID)))
E
Eric Blake 已提交
10753
        return false;
10754 10755 10756

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
10757
    return true;
10758 10759 10760
}


J
Justin Clift 已提交
10761 10762 10763 10764 10765 10766 10767 10768 10769 10770
/*
 * "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[] = {
10771
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
10772 10773 10774 10775
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10776
static bool
J
Justin Clift 已提交
10777 10778 10779 10780
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
10781
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
10782 10783

    /* Check the connection to libvirtd daemon is still working */
10784
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10785
        return false;
J
Justin Clift 已提交
10786 10787

    /* Use the supplied string to locate the volume */
10788
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
10789
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
10790
        return false;
J
Justin Clift 已提交
10791 10792 10793 10794 10795 10796 10797
    }

    /* 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 已提交
10798
        return false;
J
Justin Clift 已提交
10799 10800
    }

10801 10802 10803 10804 10805 10806 10807 10808 10809
    /* 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 已提交
10810 10811 10812 10813

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
10814
    return true;
J
Justin Clift 已提交
10815 10816
}

10817 10818 10819 10820

/*
 * "vol-key" command
 */
10821
static const vshCmdInfo info_vol_key[] = {
10822
    {"help", N_("returns the volume key for a given volume name or path")},
10823
    {"desc", ""},
10824 10825 10826
    {NULL, NULL}
};

10827
static const vshCmdOptDef opts_vol_key[] = {
10828
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
10829
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10830 10831 10832
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10833
static bool
10834
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
10835 10836 10837
{
    virStorageVolPtr vol;

10838
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10839
        return false;
10840

10841
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
10842
        return false;
10843 10844 10845

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
10846
    return true;
10847 10848 10849 10850 10851 10852 10853
}



/*
 * "vol-path" command
 */
10854
static const vshCmdInfo info_vol_path[] = {
10855
    {"help", N_("returns the volume path for a given volume name or key")},
10856
    {"desc", ""},
10857 10858 10859
    {NULL, NULL}
};

10860
static const vshCmdOptDef opts_vol_path[] = {
10861
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
10862
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10863 10864 10865
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10866
static bool
10867
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
10868 10869
{
    virStorageVolPtr vol;
10870
    char * StorageVolPath;
10871

10872
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10873
        return false;
10874

10875
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL))) {
E
Eric Blake 已提交
10876
        return false;
10877
    }
10878

10879 10880 10881 10882 10883 10884 10885
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
10886
    virStorageVolFree(vol);
E
Eric Blake 已提交
10887
    return true;
10888 10889 10890
}


10891 10892 10893 10894
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
10895 10896
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
10897 10898
    {NULL, NULL}
};
10899

10900
static const vshCmdOptDef opts_secret_define[] = {
10901
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
10902 10903
    {NULL, 0, 0, NULL}
};
10904

E
Eric Blake 已提交
10905
static bool
10906 10907
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
10908
    const char *from = NULL;
10909
    char *buffer;
10910
    virSecretPtr res;
10911
    char uuid[VIR_UUID_STRING_BUFLEN];
10912

10913
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10914
        return false;
10915

10916
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10917
        return false;
10918 10919

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
10923
    VIR_FREE(buffer);
10924 10925

    if (res == NULL) {
10926
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
10927
        return false;
10928
    }
10929
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
10930
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
10931
        virSecretFree(res);
E
Eric Blake 已提交
10932
        return false;
10933 10934 10935
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
10936
    return true;
10937 10938 10939 10940 10941 10942
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
10943 10944
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
10945 10946 10947 10948
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
10949
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10950 10951 10952
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10953
static bool
10954 10955 10956
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
10957
    bool ret = false;
10958 10959
    char *xml;

10960
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10961
        return false;
10962 10963 10964

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
10965
        return false;
10966 10967 10968 10969

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
10970
    vshPrint(ctl, "%s", xml);
10971
    VIR_FREE(xml);
E
Eric Blake 已提交
10972
    ret = true;
10973 10974 10975 10976 10977 10978 10979 10980 10981 10982

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
10983 10984
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
10985 10986 10987 10988
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
10989 10990
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
10991 10992 10993
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10994
static bool
10995 10996 10997 10998
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
10999
    const char *base64 = NULL;
11000
    char *value;
E
Eric Blake 已提交
11001 11002
    int res;
    bool ret = false;
11003

11004
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11005
        return false;
11006 11007 11008

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

11011
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
11012 11013 11014
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
11015
        vshError(ctl, "%s", _("Invalid base64 data"));
11016 11017 11018
        goto cleanup;
    }
    if (value == NULL) {
11019
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
11020
        return false;
11021 11022 11023 11024
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
11025
    VIR_FREE(value);
11026 11027

    if (res != 0) {
11028
        vshError(ctl, "%s", _("Failed to set secret value"));
11029 11030 11031
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
11032
    ret = true;
11033 11034 11035 11036 11037 11038 11039 11040 11041 11042

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
11043 11044
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
11045 11046 11047 11048
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
11049
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
11050 11051 11052
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11053
static bool
11054 11055 11056 11057 11058 11059
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
11060
    bool ret = false;
11061

11062
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11063
        return false;
11064 11065 11066

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
11067
        return false;
11068 11069 11070 11071 11072 11073 11074

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
11075
    VIR_FREE(value);
11076 11077

    if (base64 == NULL) {
11078
        vshError(ctl, "%s", _("Failed to allocate memory"));
11079 11080
        goto cleanup;
    }
11081
    vshPrint(ctl, "%s", base64);
11082
    memset(base64, 0, strlen(base64));
11083
    VIR_FREE(base64);
E
Eric Blake 已提交
11084
    ret = true;
11085 11086 11087 11088 11089 11090 11091 11092 11093 11094

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
11095 11096
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
11097 11098 11099 11100
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
11101
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
11102 11103 11104
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11105
static bool
11106 11107 11108
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
11109
    bool ret = false;
11110
    const char *uuid;
11111

11112
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11113
        return false;
11114 11115 11116

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
11117
        return false;
11118 11119

    if (virSecretUndefine(secret) < 0) {
11120
        vshError(ctl, _("Failed to delete secret %s"), uuid);
11121 11122 11123
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
11124
    ret = true;
11125 11126 11127 11128 11129 11130 11131 11132 11133 11134

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
11135 11136
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
11137 11138 11139
    {NULL, NULL}
};

E
Eric Blake 已提交
11140
static bool
11141 11142 11143 11144 11145
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

11146
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11147
        return false;
11148 11149 11150

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
11151
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
11152
        return false;
11153 11154 11155 11156 11157
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
11158
        vshError(ctl, "%s", _("Failed to list secrets"));
11159
        VIR_FREE(uuids);
E
Eric Blake 已提交
11160
        return false;
11161 11162 11163 11164
    }

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

11165 11166
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
11167 11168

    for (i = 0; i < maxuuids; i++) {
11169 11170 11171 11172
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
11173
            VIR_FREE(uuids[i]);
11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191
            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);
11192
        VIR_FREE(uuids[i]);
11193
    }
11194
    VIR_FREE(uuids);
E
Eric Blake 已提交
11195
    return true;
11196
}
11197 11198 11199 11200 11201


/*
 * "version" command
 */
11202
static const vshCmdInfo info_version[] = {
11203 11204
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
11205 11206 11207
    {NULL, NULL}
};

11208 11209 11210 11211
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
11212

E
Eric Blake 已提交
11213
static bool
11214
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11215 11216 11217 11218 11219 11220
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
11221
    unsigned long daemonVersion;
11222 11223 11224 11225 11226
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

11227
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11228
        return false;
11229 11230 11231

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
11232
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
11233
        return false;
11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245
    }

    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) {
11246
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
11247
        return false;
11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264
    }
    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) {
11265
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
11266
        return false;
11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279
    }
    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);
    }
11280 11281 11282 11283 11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294

    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 已提交
11295
    return true;
11296 11297
}

11298 11299 11300 11301
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
11302
    {"help", N_("enumerate devices on this host")},
11303
    {"desc", ""},
11304 11305 11306 11307
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
11308 11309
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
11310 11311 11312
    {NULL, 0, 0, NULL}
};

11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334
#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] = '-';
11335 11336
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
11337 11338 11339
    }

    /* Print this device */
11340
    vshPrint(ctl, "%s", indentBuf);
11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363
    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) {
11364
        vshPrint(ctl, "%s", indentBuf);
11365
        vshPrint(ctl, " |\n");
11366 11367 11368 11369 11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387
    }

    /* 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) {
11388
        vshPrint(ctl, "%s", indentBuf);
11389 11390 11391 11392
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
11393
static bool
11394 11395
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
11396
    const char *cap = NULL;
11397
    char **devices;
11398
    int num_devices, i;
11399
    int tree = vshCommandOptBool(cmd, "tree");
11400

11401
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11402
        return false;
11403

11404
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
11405 11406 11407 11408
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
11409
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
11410
        return false;
11411
    } else if (num_devices == 0) {
E
Eric Blake 已提交
11412
        return true;
11413 11414 11415 11416 11417 11418
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
11419
        vshError(ctl, "%s", _("Failed to list node devices"));
11420
        VIR_FREE(devices);
E
Eric Blake 已提交
11421
        return false;
11422
    }
11423
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
11424 11425 11426 11427 11428 11429 11430
    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 已提交
11431
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450
            } 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++) {
11451 11452
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
11453
        }
11454
        VIR_FREE(parents);
11455 11456 11457
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
11458
            VIR_FREE(devices[i]);
11459
        }
11460
    }
11461
    VIR_FREE(devices);
E
Eric Blake 已提交
11462
    return true;
11463 11464 11465 11466 11467 11468
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
11469 11470
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
11471 11472 11473 11474 11475
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
11476
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
11477 11478 11479
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11480
static bool
11481 11482
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
11483
    const char *name = NULL;
11484
    virNodeDevicePtr device;
L
Laine Stump 已提交
11485
    char *xml;
11486

11487
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11488
        return false;
11489
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
11490
        return false;
11491
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
11492
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
11493
        return false;
11494 11495
    }

L
Laine Stump 已提交
11496 11497 11498
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
11499
        return false;
L
Laine Stump 已提交
11500 11501 11502
    }

    vshPrint(ctl, "%s\n", xml);
11503
    VIR_FREE(xml);
11504
    virNodeDeviceFree(device);
E
Eric Blake 已提交
11505
    return true;
11506 11507
}

11508 11509 11510 11511
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
11512 11513
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
11514 11515 11516 11517 11518
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
11519
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
11520 11521 11522
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11523
static bool
11524 11525
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
11526
    const char *name = NULL;
11527
    virNodeDevicePtr device;
E
Eric Blake 已提交
11528
    bool ret = true;
11529

11530
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11531
        return false;
11532
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
11533
        return false;
11534
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
11535
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
11536
        return false;
11537 11538 11539 11540 11541
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
11542
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
11543
        ret = false;
11544 11545 11546 11547 11548 11549 11550 11551 11552
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
11553 11554
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
11555 11556 11557 11558 11559
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
11560
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
11561 11562 11563
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11564
static bool
11565 11566
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
11567
    const char *name = NULL;
11568
    virNodeDevicePtr device;
E
Eric Blake 已提交
11569
    bool ret = true;
11570

11571
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11572
        return false;
11573
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
11574
        return false;
11575
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
11576
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
11577
        return false;
11578 11579 11580 11581 11582
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
11583
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
11584
        ret = false;
11585 11586 11587 11588 11589 11590 11591 11592 11593
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
11594 11595
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
11596 11597 11598 11599 11600
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
11601
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
11602 11603 11604
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11605
static bool
11606 11607
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
11608
    const char *name = NULL;
11609
    virNodeDevicePtr device;
E
Eric Blake 已提交
11610
    bool ret = true;
11611

11612
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11613
        return false;
11614
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
11615
        return false;
11616
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
11617
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
11618
        return false;
11619 11620 11621 11622 11623
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
11624
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
11625
        ret = false;
11626 11627 11628 11629 11630
    }
    virNodeDeviceFree(device);
    return ret;
}

11631
/*
E
Eric Blake 已提交
11632
 * "hostname" command
11633
 */
11634
static const vshCmdInfo info_hostname[] = {
11635
    {"help", N_("print the hypervisor hostname")},
11636
    {"desc", ""},
11637 11638 11639
    {NULL, NULL}
};

E
Eric Blake 已提交
11640
static bool
11641
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11642 11643 11644
{
    char *hostname;

11645
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11646
        return false;
11647 11648 11649

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
11650
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
11651
        return false;
11652 11653 11654
    }

    vshPrint (ctl, "%s\n", hostname);
11655
    VIR_FREE(hostname);
11656

E
Eric Blake 已提交
11657
    return true;
11658 11659 11660 11661 11662
}

/*
 * "uri" command
 */
11663
static const vshCmdInfo info_uri[] = {
11664
    {"help", N_("print the hypervisor canonical URI")},
11665
    {"desc", ""},
11666 11667 11668
    {NULL, NULL}
};

E
Eric Blake 已提交
11669
static bool
11670
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11671 11672 11673
{
    char *uri;

11674
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11675
        return false;
11676 11677 11678

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
11679
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
11680
        return false;
11681 11682 11683
    }

    vshPrint (ctl, "%s\n", uri);
11684
    VIR_FREE(uri);
11685

E
Eric Blake 已提交
11686
    return true;
11687 11688
}

E
Eric Blake 已提交
11689 11690 11691 11692 11693 11694 11695 11696 11697 11698
/*
 * "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 已提交
11699
static bool
E
Eric Blake 已提交
11700 11701 11702 11703 11704
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11705
        return false;
E
Eric Blake 已提交
11706 11707 11708 11709

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
11710
        return false;
E
Eric Blake 已提交
11711 11712 11713 11714 11715
    }

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

E
Eric Blake 已提交
11716
    return true;
E
Eric Blake 已提交
11717 11718
}

11719 11720 11721
/*
 * "vncdisplay" command
 */
11722
static const vshCmdInfo info_vncdisplay[] = {
11723 11724
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
11725 11726 11727
    {NULL, NULL}
};

11728
static const vshCmdOptDef opts_vncdisplay[] = {
11729
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11730 11731 11732
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11733
static bool
11734
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
11735 11736 11737 11738 11739
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
11740
    bool ret = false;
11741 11742 11743
    int port = 0;
    char *doc;

11744
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11745
        return false;
11746

J
Jim Meyering 已提交
11747
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
11748
        return false;
11749 11750 11751 11752 11753

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11754
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
11755
    VIR_FREE(doc);
11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770
    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) ||
11771
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
11772 11773 11774 11775 11776 11777
        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 已提交
11778
    ret = true;
11779 11780 11781 11782

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
11783
    xmlFreeDoc(xml);
11784 11785 11786 11787 11788 11789 11790
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
11791
static const vshCmdInfo info_ttyconsole[] = {
11792 11793
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
11794 11795 11796
    {NULL, NULL}
};

11797
static const vshCmdOptDef opts_ttyconsole[] = {
11798
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11799 11800 11801
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11802
static bool
11803
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
11804 11805 11806 11807 11808
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
11809
    bool ret = false;
11810 11811
    char *doc;

11812
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11813
        return false;
11814

J
Jim Meyering 已提交
11815
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
11816
        return false;
11817 11818 11819 11820 11821

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11822
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
11823
    VIR_FREE(doc);
11824 11825 11826 11827 11828 11829 11830 11831 11832
    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 已提交
11833
    ret = true;
11834 11835 11836 11837

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
11838
    xmlFreeDoc(xml);
11839 11840 11841 11842 11843 11844
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
11845
 */
11846
static const vshCmdInfo info_attach_device[] = {
11847 11848
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
11849 11850 11851
    {NULL, NULL}
};

11852
static const vshCmdOptDef opts_attach_device[] = {
11853 11854 11855
    {"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")},
11856 11857 11858
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11859
static bool
11860
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
11861 11862
{
    virDomainPtr dom;
11863
    const char *from = NULL;
11864
    char *buffer;
W
Wen Congyang 已提交
11865
    int ret;
J
Jim Fehlig 已提交
11866
    unsigned int flags;
11867

11868
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11869
        return false;
11870

J
Jim Meyering 已提交
11871
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
11872
        return false;
11873

11874
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11875
        virDomainFree(dom);
E
Eric Blake 已提交
11876
        return false;
11877 11878
    }

11879
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11880
        virshReportError(ctl);
11881
        virDomainFree(dom);
E
Eric Blake 已提交
11882
        return false;
11883
    }
11884

J
Jim Fehlig 已提交
11885
    if (vshCommandOptBool(cmd, "persistent")) {
11886
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11887
        if (virDomainIsActive(dom) == 1)
11888
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11889 11890 11891 11892
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
11893
    VIR_FREE(buffer);
11894 11895

    if (ret < 0) {
11896
        vshError(ctl, _("Failed to attach device from %s"), from);
11897
        virDomainFree(dom);
E
Eric Blake 已提交
11898
        return false;
11899
    } else {
J
Jim Meyering 已提交
11900
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
11901 11902 11903
    }

    virDomainFree(dom);
E
Eric Blake 已提交
11904
    return true;
11905 11906
}

11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922
/**
 * 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 已提交
11923
    long n1_child_size, n2_child_size, n1_iter;
11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951
    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 已提交
11952 11953 11954 11955
    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)
11956 11957
        return false;

11958 11959 11960
    if (n1_child_size == 0 && n2_child_size == 0)
        return true;

11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019 12020 12021 12022 12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040 12041 12042 12043 12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 12084 12085 12086 12087 12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101 12102 12103 12104 12105 12106 12107 12108 12109 12110 12111 12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150
    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;
}
12151 12152 12153 12154

/*
 * "detach-device" command
 */
12155
static const vshCmdInfo info_detach_device[] = {
12156 12157
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
12158 12159 12160
    {NULL, NULL}
};

12161
static const vshCmdOptDef opts_detach_device[] = {
12162 12163 12164
    {"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")},
12165 12166 12167
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12168
static bool
12169
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
12170
{
12171
    virDomainPtr dom = NULL;
12172
    const char *from = NULL;
12173
    char *buffer = NULL, *new_buffer = NULL;
W
Wen Congyang 已提交
12174
    int ret;
12175
    bool funcRet = false;
J
Jim Fehlig 已提交
12176
    unsigned int flags;
12177

12178
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12179
        return false;
12180

J
Jim Meyering 已提交
12181
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
12182
        return false;
12183

12184 12185
    if (vshCommandOptString(cmd, "file", &from) <= 0)
        goto cleanup;
12186

12187
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
12188
        virshReportError(ctl);
12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203
        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;
12204
    }
12205

J
Jim Fehlig 已提交
12206
    if (vshCommandOptBool(cmd, "persistent")) {
12207
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
12208
        if (virDomainIsActive(dom) == 1)
12209
           flags |= VIR_DOMAIN_AFFECT_LIVE;
12210
        ret = virDomainDetachDeviceFlags(dom, new_buffer, flags);
J
Jim Fehlig 已提交
12211
    } else {
12212
        ret = virDomainDetachDevice(dom, new_buffer);
J
Jim Fehlig 已提交
12213
    }
12214 12215

    if (ret < 0) {
12216
        vshError(ctl, _("Failed to detach device from %s"), from);
12217
        goto cleanup;
12218 12219
    }

12220 12221 12222 12223 12224 12225
    vshPrint(ctl, "%s", _("Device detached successfully\n"));
    funcRet = true;

cleanup:
    VIR_FREE(new_buffer);
    VIR_FREE(buffer);
12226
    virDomainFree(dom);
12227
    return funcRet;
12228 12229
}

12230

12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243
/*
 * "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")},
12244
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
12245 12246 12247
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12248
static bool
12249 12250 12251
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
12252
    const char *from = NULL;
12253
    char *buffer;
W
Wen Congyang 已提交
12254
    int ret;
12255 12256
    unsigned int flags;

12257
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12258
        return false;
12259 12260

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

12263
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
12264
        virDomainFree(dom);
E
Eric Blake 已提交
12265
        return false;
12266 12267 12268
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
12269
        virshReportError(ctl);
12270
        virDomainFree(dom);
E
Eric Blake 已提交
12271
        return false;
12272 12273 12274
    }

    if (vshCommandOptBool(cmd, "persistent")) {
12275
        flags = VIR_DOMAIN_AFFECT_CONFIG;
12276
        if (virDomainIsActive(dom) == 1)
12277
           flags |= VIR_DOMAIN_AFFECT_LIVE;
12278
    } else {
12279
        flags = VIR_DOMAIN_AFFECT_LIVE;
12280
    }
12281 12282 12283 12284

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

12285 12286 12287 12288 12289 12290
    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 已提交
12291
        return false;
12292 12293 12294 12295 12296
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
12297
    return true;
12298 12299 12300
}


12301 12302 12303
/*
 * "attach-interface" command
 */
12304
static const vshCmdInfo info_attach_interface[] = {
12305 12306
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
12307 12308 12309
    {NULL, NULL}
};

12310
static const vshCmdOptDef opts_attach_interface[] = {
12311 12312 12313 12314 12315 12316
    {"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")},
12317
    {"model", VSH_OT_DATA, 0, N_("model type")},
12318
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
12319 12320
    {"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")},
12321 12322 12323
    {NULL, 0, 0, NULL}
};

12324 12325 12326
/* 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. */
12327
static int parseRateStr(const char *rateStr, virNetDevBandwidthRatePtr rate)
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
{
    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 已提交
12359
static bool
12360
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
12361 12362
{
    virDomainPtr dom = NULL;
12363
    const char *mac = NULL, *target = NULL, *script = NULL,
12364 12365
                *type = NULL, *source = NULL, *model = NULL,
                *inboundStr = NULL, *outboundStr = NULL;
12366
    virNetDevBandwidthRate inbound, outbound;
E
Eric Blake 已提交
12367
    int typ;
W
Wen Congyang 已提交
12368 12369
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
12370
    unsigned int flags;
12371 12372
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
12373

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

J
Jim Meyering 已提交
12377
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
12378 12379
        goto cleanup;

12380
    if (vshCommandOptString(cmd, "type", &type) <= 0)
12381 12382
        goto cleanup;

12383 12384 12385 12386
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
12387 12388 12389
        vshCommandOptString(cmd, "model", &model) < 0 ||
        vshCommandOptString(cmd, "inbound", &inboundStr) < 0 ||
        vshCommandOptString(cmd, "outbound", &outboundStr) < 0) {
12390
        vshError(ctl, "missing argument");
12391
        goto cleanup;
12392
    }
12393 12394

    /* check interface type */
12395
    if (STREQ(type, "network")) {
12396
        typ = 1;
12397
    } else if (STREQ(type, "bridge")) {
12398 12399
        typ = 2;
    } else {
E
Eric Blake 已提交
12400 12401
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
12402 12403 12404
        goto cleanup;
    }

12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427
    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;
        }
    }

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

12431
    if (typ == 1)
12432
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
12433
    else if (typ == 2)
12434
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
12435

12436
    if (target != NULL)
12437
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
12438
    if (mac != NULL)
12439
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
12440
    if (script != NULL)
12441
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
12442
    if (model != NULL)
12443
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
12444

12445 12446 12447 12448 12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465
    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");
    }

12466
    virBufferAddLit(&buf, "</interface>\n");
12467

12468 12469
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
12470
        goto cleanup;
12471 12472
    }

12473
    xml = virBufferContentAndReset(&buf);
12474

J
Jim Fehlig 已提交
12475
    if (vshCommandOptBool(cmd, "persistent")) {
12476
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
12477
        if (virDomainIsActive(dom) == 1)
12478
            flags |= VIR_DOMAIN_AFFECT_LIVE;
12479
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
12480
    } else {
12481
        ret = virDomainAttachDevice(dom, xml);
12482
    }
12483

12484 12485
    VIR_FREE(xml);

J
Jim Fehlig 已提交
12486
    if (ret != 0) {
L
Laine Stump 已提交
12487
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
12488 12489
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
12490
        functionReturn = true;
J
Jim Fehlig 已提交
12491
    }
12492 12493 12494 12495

 cleanup:
    if (dom)
        virDomainFree(dom);
12496
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
12497
    return functionReturn;
12498 12499 12500 12501 12502
}

/*
 * "detach-interface" command
 */
12503
static const vshCmdInfo info_detach_interface[] = {
12504 12505
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
12506 12507 12508
    {NULL, NULL}
};

12509
static const vshCmdOptDef opts_detach_interface[] = {
12510 12511 12512 12513
    {"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")},
12514 12515 12516
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12517
static bool
12518
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
12519 12520 12521 12522 12523 12524 12525
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
12526
    const char *mac =NULL, *type = NULL;
12527
    char *doc;
12528
    char buf[64];
E
Eric Blake 已提交
12529
    int i = 0, diff_mac;
W
Wen Congyang 已提交
12530 12531
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
12532
    unsigned int flags;
12533

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

J
Jim Meyering 已提交
12537
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
12538 12539
        goto cleanup;

12540
    if (vshCommandOptString(cmd, "type", &type) <= 0)
12541 12542
        goto cleanup;

12543 12544
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
12545
        goto cleanup;
12546
    }
12547 12548 12549 12550 12551

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

12552
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
12553
    VIR_FREE(doc);
12554
    if (!xml) {
12555
        vshError(ctl, "%s", _("Failed to get interface information"));
12556 12557 12558
        goto cleanup;
    }

E
Eric Blake 已提交
12559
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
12560 12561 12562
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
12563
        vshError(ctl, _("No found interface whose type is %s"), type);
12564 12565 12566
        goto cleanup;
    }

12567 12568 12569 12570 12571 12572
    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;
    }

12573 12574 12575 12576 12577 12578 12579
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
12580 12581 12582 12583 12584
            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);
12585 12586 12587 12588 12589 12590 12591
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
12592
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
12593 12594 12595 12596 12597
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
12598
        vshError(ctl, "%s", _("Failed to allocate memory"));
12599 12600 12601
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
12607
    if (vshCommandOptBool(cmd, "persistent")) {
12608
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
12609
        if (virDomainIsActive(dom) == 1)
12610
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
12611 12612 12613 12614 12615 12616 12617 12618
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
12619
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
12620
    } else {
J
Jim Meyering 已提交
12621
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
12622
        functionReturn = true;
12623
    }
12624 12625 12626 12627

 cleanup:
    if (dom)
        virDomainFree(dom);
12628
    xmlXPathFreeObject(obj);
12629
    xmlXPathFreeContext(ctxt);
12630 12631
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
12632
    return functionReturn;
12633 12634 12635 12636 12637
}

/*
 * "attach-disk" command
 */
12638
static const vshCmdInfo info_attach_disk[] = {
12639 12640
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
12641 12642 12643
    {NULL, NULL}
};

12644
static const vshCmdOptDef opts_attach_disk[] = {
12645
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12646 12647
    {"source",  VSH_OT_DATA, VSH_OFLAG_REQ | VSH_OFLAG_EMPTY_OK,
     N_("source of disk device")},
12648 12649 12650
    {"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")},
12651
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
12652 12653 12654
    {"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")},
12655
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
12656 12657 12658
    {"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")},
12659 12660 12661
    {NULL, 0, 0, NULL}
};

12662 12663 12664 12665 12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 12717 12718 12719 12720 12721 12722 12723 12724 12725 12726 12727 12728 12729 12730 12731 12732 12733 12734 12735 12736 12737 12738 12739 12740 12741 12742 12743 12744 12745 12746 12747 12748 12749 12750 12751 12752 12753 12754 12755 12756 12757 12758 12759 12760 12761 12762 12763 12764 12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782 12783 12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808
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 已提交
12809
static bool
12810
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
12811 12812
{
    virDomainPtr dom = NULL;
12813
    const char *source = NULL, *target = NULL, *driver = NULL,
12814 12815 12816
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
12817 12818
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
12819
    unsigned int flags;
12820
    const char *stype = NULL;
12821 12822
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
12823

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

J
Jim Meyering 已提交
12827
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
12828 12829
        goto cleanup;

12830
    if (vshCommandOptString(cmd, "source", &source) <= 0)
12831
        goto cleanup;
12832 12833 12834 12835
    /* Allow empty string as a placeholder that implies no source, for
     * use in adding a cdrom drive with no disk.  */
    if (!*source)
        source = NULL;
12836

12837
    if (vshCommandOptString(cmd, "target", &target) <= 0)
12838 12839
        goto cleanup;

12840 12841 12842 12843
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
12844 12845 12846
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
12847
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
12848
        vshError(ctl, "%s", _("missing option"));
12849 12850
        goto cleanup;
    }
12851

12852 12853
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
12854
            isFile = true;
12855
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
12856
        isFile = true;
12857 12858 12859
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
12860 12861 12862
    }

    if (mode) {
12863
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
12864 12865
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
12866 12867 12868 12869 12870
            goto cleanup;
        }
    }

    /* Make XML of disk */
12871
    virBufferAsprintf(&buf, "<disk type='%s'",
12872 12873
                      (isFile) ? "file" : "block");
    if (type)
12874
        virBufferAsprintf(&buf, " device='%s'", type);
12875 12876
    virBufferAddLit(&buf, ">\n");

12877
    if (driver || subdriver)
12878
        virBufferAsprintf(&buf, "  <driver");
12879 12880

    if (driver)
12881
        virBufferAsprintf(&buf, " name='%s'", driver);
12882
    if (subdriver)
12883
        virBufferAsprintf(&buf, " type='%s'", subdriver);
12884 12885
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
12886

12887
    if (driver || subdriver || cache)
12888
        virBufferAddLit(&buf, "/>\n");
12889

12890 12891 12892 12893
    if (source)
        virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
                          (isFile) ? "file" : "dev",
                          source);
12894
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
12895
    if (mode)
12896
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
12897

12898 12899 12900 12901 12902 12903 12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 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
    if (serial)
        virBufferAsprintf(&buf, "  <serial>%s</serial>\n", serial);

    if (vshCommandOptBool(cmd, "shareable"))
        virBufferAsprintf(&buf, "  <shareable/>\n");

    if (straddr) {
        if (str2DiskAddress(straddr, &diskAddr) != 0) {
            vshError(ctl, _("Invalid address."));
            goto cleanup;
        }

        if (STRPREFIX((const char *)target, "vd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_PCI) {
                virBufferAsprintf(&buf,
                                  "  <address type='pci' domain='0x%04x'"
                                  " bus ='0x%02x' slot='0x%02x' function='0x%0x' />\n",
                                  diskAddr.addr.pci.domain, diskAddr.addr.pci.bus,
                                  diskAddr.addr.pci.slot, diskAddr.addr.pci.function);
            } else {
                vshError(ctl, "%s", _("expecting a pci:0000.00.00.00 address."));
                goto cleanup;
            }
        } else if (STRPREFIX((const char *)target, "sd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_SCSI) {
                virBufferAsprintf(&buf,
                                  "  <address type='drive' controller='%d'"
                                  " bus='%d' unit='%d' />\n",
                                  diskAddr.addr.scsi.controller, diskAddr.addr.scsi.bus,
                                  diskAddr.addr.scsi.unit);
            } else {
                vshError(ctl, "%s", _("expecting a scsi:00.00.00 address."));
                goto cleanup;
            }
        } else if (STRPREFIX((const char *)target, "hd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_IDE) {
                virBufferAsprintf(&buf,
                                  "  <address type='drive' controller='%d'"
                                  " bus='%d' unit='%d' />\n",
                                  diskAddr.addr.ide.controller, diskAddr.addr.ide.bus,
                                  diskAddr.addr.ide.unit);
            } else {
                vshError(ctl, "%s", _("expecting an ide:00.00.00 address."));
                goto cleanup;
            }
        }
    }

12946
    virBufferAddLit(&buf, "</disk>\n");
12947

12948 12949
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
12950
        return false;
12951 12952
    }

12953
    xml = virBufferContentAndReset(&buf);
12954

J
Jim Fehlig 已提交
12955
    if (vshCommandOptBool(cmd, "persistent")) {
12956
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
12957
        if (virDomainIsActive(dom) == 1)
12958
            flags |= VIR_DOMAIN_AFFECT_LIVE;
12959
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
12960
    } else {
12961
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
12962
    }
12963

12964 12965
    VIR_FREE(xml);

J
Jim Fehlig 已提交
12966
    if (ret != 0) {
L
Laine Stump 已提交
12967
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
12968 12969
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
12970
        functionReturn = true;
J
Jim Fehlig 已提交
12971
    }
12972 12973 12974 12975

 cleanup:
    if (dom)
        virDomainFree(dom);
12976
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
12977
    return functionReturn;
12978 12979 12980 12981 12982
}

/*
 * "detach-disk" command
 */
12983
static const vshCmdInfo info_detach_disk[] = {
12984 12985
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
12986 12987 12988
    {NULL, NULL}
};

12989
static const vshCmdOptDef opts_detach_disk[] = {
12990 12991 12992
    {"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")},
12993 12994 12995
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12996
static bool
12997
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
12998 12999 13000 13001 13002 13003 13004
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
13005
    const char *target = NULL;
13006
    char *doc;
E
Eric Blake 已提交
13007
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
13008 13009
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
13010
    unsigned int flags;
13011

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

J
Jim Meyering 已提交
13015
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
13016 13017
        goto cleanup;

13018
    if (vshCommandOptString(cmd, "target", &target) <= 0)
13019 13020 13021 13022 13023 13024
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

13025
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
13026
    VIR_FREE(doc);
13027
    if (!xml) {
13028
        vshError(ctl, "%s", _("Failed to get disk information"));
13029 13030 13031 13032 13033 13034
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
13035
        vshError(ctl, "%s", _("Failed to get disk information"));
13036 13037 13038 13039 13040 13041 13042
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
13043 13044 13045 13046 13047
            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);
13048 13049 13050 13051 13052 13053 13054
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
13055
    vshError(ctl, _("No found disk whose target is %s"), target);
13056 13057 13058 13059 13060
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
13061
        vshError(ctl, "%s", _("Failed to allocate memory"));
13062 13063 13064
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
13070
    if (vshCommandOptBool(cmd, "persistent")) {
13071
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
13072
        if (virDomainIsActive(dom) == 1)
13073
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
13074 13075 13076 13077 13078 13079 13080 13081
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
13082
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
13083
    } else {
J
Jim Meyering 已提交
13084
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
13085
        functionReturn = true;
13086
    }
13087 13088

 cleanup:
13089
    xmlXPathFreeObject(obj);
13090
    xmlXPathFreeContext(ctxt);
13091 13092
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
13093 13094
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
13095
    return functionReturn;
13096 13097
}

13098 13099 13100 13101
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
13102 13103
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
13104 13105 13106 13107
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
13108
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
13109 13110 13111
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13112
static bool
13113 13114
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
13115
    const char *from = NULL;
13116
    bool ret = false;
13117 13118
    char *buffer;
    int result;
13119 13120 13121 13122 13123 13124
    const char *snippet;

    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlBufferPtr xml_buf = NULL;
    xmlNodePtr node;
13125

13126
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13127
        return false;
13128

13129
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
13130
        return false;
13131

13132 13133 13134
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
        vshError(ctl, _("Failed to read file '%s' to compare"),
                 from);
E
Eric Blake 已提交
13135
        return false;
13136
    }
13137

13138 13139 13140 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162
    /* 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);
13163 13164 13165 13166 13167

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
13168
        goto cleanup;
13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183
        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);
13184
        goto cleanup;
13185 13186
    }

13187 13188 13189 13190 13191 13192 13193 13194
    ret = true;

cleanup:
    VIR_FREE(buffer);
    xmlBufferFree(xml_buf);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);

13195 13196 13197
    return ret;
}

13198 13199 13200 13201
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
13202 13203
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
13204 13205 13206 13207
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
13208
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
13209 13210 13211
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13212
static bool
13213 13214
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
13215
    const char *from = NULL;
13216
    bool ret = false;
13217 13218 13219
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
13220 13221 13222 13223
    int count = 0;

    xmlDocPtr xml = NULL;
    xmlNodePtr *node_list = NULL;
13224
    xmlXPathContextPtr ctxt = NULL;
13225 13226 13227
    xmlBufferPtr xml_buf = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    int i;
13228

13229
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13230
        return false;
13231

13232
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
13233
        return false;
13234 13235

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

E
Eric Blake 已提交
13238
    /* add a separate container around the xml */
13239 13240
    virBufferStrcat(&buf, "<container>", buffer, "</container>", NULL);
    if (virBufferError(&buf))
13241 13242
        goto no_memory;

13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255
    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);
13256 13257 13258
        goto cleanup;
    }

13259
    list = vshCalloc(ctl, count, sizeof(const char *));
13260

13261
    if (!(xml_buf = xmlBufferCreate()))
13262 13263
        goto no_memory;

13264 13265
    for (i = 0; i < count; i++) {
        xmlBufferEmpty(xml_buf);
13266

13267 13268 13269
        if (xmlNodeDump(xml_buf, xml,  node_list[i], 0, 0) < 0) {
            vshError(ctl, _("Failed to extract <cpu> element"));
            goto cleanup;
13270 13271
        }

13272
        list[i] = vshStrdup(ctl, (const char *)xmlBufferContent(xml_buf));
13273 13274 13275 13276
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

13277
    if (result) {
13278
        vshPrint(ctl, "%s", result);
13279 13280
        ret = true;
    }
13281 13282 13283

cleanup:
    xmlXPathFreeContext(ctxt);
13284 13285
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
13286 13287
    VIR_FREE(result);
    if ((list != NULL) && (count > 0)) {
13288
        for (i = 0; i < count; i++)
13289 13290 13291 13292 13293 13294 13295 13296 13297
            VIR_FREE(list[i]);
    }
    VIR_FREE(list);
    VIR_FREE(buffer);

    return ret;

no_memory:
    vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
13298
    ret = false;
13299
    goto cleanup;
13300 13301
}

13302 13303 13304 13305 13306 13307 13308 13309
/* 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;

13310
    ret = vshMalloc(ctl, PATH_MAX);
13311 13312 13313

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
13314 13315
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
13316
    if (fd == -1) {
13317
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
13318
                 strerror(errno));
13319
        VIR_FREE(ret);
13320 13321 13322 13323
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
13324 13325
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
13326
        VIR_FORCE_CLOSE(fd);
13327
        unlink (ret);
13328
        VIR_FREE(ret);
13329 13330
        return NULL;
    }
S
Stefan Berger 已提交
13331
    if (VIR_CLOSE(fd) < 0) {
13332 13333
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
13334
        unlink (ret);
13335
        VIR_FREE(ret);
13336 13337 13338 13339 13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350
        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 已提交
13351 13352 13353 13354
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
13355

13356
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
13357 13358 13359 13360
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
13361

13362 13363 13364 13365 13366
    /* 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 已提交
13367 13368
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
13369
     */
E
Eric Blake 已提交
13370 13371 13372 13373 13374 13375 13376 13377 13378 13379 13380 13381
    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);
13382 13383
    }

E
Eric Blake 已提交
13384 13385 13386 13387 13388 13389 13390
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
13391
    }
E
Eric Blake 已提交
13392
    ret = 0;
13393

E
Eric Blake 已提交
13394 13395 13396
cleanup:
    virCommandFree(cmd);
    return ret;
13397 13398 13399 13400 13401 13402 13403 13404
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
13405
        vshError(ctl,
13406
                 _("%s: failed to read temporary file: %s"),
13407
                 filename, strerror(errno));
13408 13409 13410 13411 13412
        return NULL;
    }
    return ret;
}

13413

P
Paolo Bonzini 已提交
13414 13415 13416 13417
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
13418 13419
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
13420 13421 13422 13423
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
13424
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
13425 13426 13427
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13428
static bool
13429
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
13430
{
13431
    const char *dir = NULL;
13432
    char *dir_malloced = NULL;
E
Eric Blake 已提交
13433
    bool ret = true;
P
Paolo Bonzini 已提交
13434 13435

    if (!ctl->imode) {
13436
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
13437
        return false;
P
Paolo Bonzini 已提交
13438 13439
    }

13440
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
13441
        uid_t uid = geteuid();
13442
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
13443 13444 13445 13446
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
13447
    if (chdir(dir) == -1) {
13448
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
13449
        ret = false;
P
Paolo Bonzini 已提交
13450 13451
    }

13452
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
13453
    return ret;
P
Paolo Bonzini 已提交
13454 13455 13456 13457 13458 13459
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
13460 13461
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
13462 13463 13464
    {NULL, NULL}
};

E
Eric Blake 已提交
13465
static bool
P
Paolo Bonzini 已提交
13466 13467 13468
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
13469
    bool ret = true;
P
Paolo Bonzini 已提交
13470

13471 13472
    cwd = getcwd(NULL, 0);
    if (!cwd) {
13473 13474
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
13475 13476
        ret = false;
    } else {
P
Paolo Bonzini 已提交
13477
        vshPrint (ctl, _("%s\n"), cwd);
13478 13479
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
13480

13481
    return ret;
P
Paolo Bonzini 已提交
13482 13483
}

E
Eric Blake 已提交
13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495
/*
 * "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")},
13496
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
13497 13498 13499 13500 13501 13502
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
13503
static bool
13504
cmdEcho (vshControl *ctl, const vshCmd *cmd)
E
Eric Blake 已提交
13505 13506 13507 13508
{
    bool shell = false;
    bool xml = false;
    int count = 0;
13509
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
13510 13511 13512 13513 13514 13515 13516 13517
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

13518
    while ((opt = vshCommandOptArgv(cmd, opt))) {
13519 13520
        char *str;
        virBuffer xmlbuf = VIR_BUFFER_INITIALIZER;
E
Eric Blake 已提交
13521

13522
        arg = opt->data;
13523

E
Eric Blake 已提交
13524 13525
        if (count)
            virBufferAddChar(&buf, ' ');
13526

E
Eric Blake 已提交
13527
        if (xml) {
13528 13529 13530 13531
            virBufferEscapeString(&xmlbuf, "%s", arg);
            if (virBufferError(&buf)) {
                vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
                return false;
E
Eric Blake 已提交
13532
            }
13533 13534 13535
            str = virBufferContentAndReset(&xmlbuf);
        } else {
            str = vshStrdup(ctl, arg);
E
Eric Blake 已提交
13536
        }
13537 13538 13539 13540 13541

        if (shell)
            virBufferEscapeShell(&buf, str);
        else
            virBufferAdd(&buf, str, -1);
E
Eric Blake 已提交
13542
        count++;
13543
        VIR_FREE(str);
E
Eric Blake 已提交
13544 13545 13546 13547
    }

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
13548
        return false;
E
Eric Blake 已提交
13549 13550 13551 13552 13553
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
13554
    return true;
E
Eric Blake 已提交
13555 13556
}

13557 13558 13559 13560
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
13561 13562
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
13563 13564 13565 13566
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
13567
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
13568 13569 13570 13571 13572 13573
    {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 已提交
13574
static bool
13575 13576
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
13577
    bool ret = false;
13578 13579 13580 13581 13582
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
13583
    unsigned int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
13584

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

J
Jim Meyering 已提交
13588
    dom = vshCommandOptDomain (ctl, cmd, NULL);
13589 13590 13591 13592
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
13593
    doc = virDomainGetXMLDesc (dom, flags);
13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611
    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 已提交
13612
        ret = true;
13613 13614 13615 13616 13617 13618 13619
        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.
     */
13620
    doc_reread = virDomainGetXMLDesc (dom, flags);
13621 13622 13623 13624
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
13625 13626
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
13627 13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638
        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 已提交
13639
    ret = true;
13640 13641 13642 13643 13644

 cleanup:
    if (dom)
        virDomainFree (dom);

13645 13646 13647
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
13648 13649 13650

    if (tmp) {
        unlink (tmp);
13651
        VIR_FREE(tmp);
13652 13653 13654 13655 13656
    }

    return ret;
}

13657

13658 13659 13660 13661
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
13662 13663
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
13664 13665 13666 13667
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
13668
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
13669 13670 13671 13672 13673 13674 13675 13676 13677 13678
    {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[] = {
13679 13680
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
13681 13682 13683 13684
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
13685
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
13686 13687 13688 13689 13690 13691
    {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 已提交
13692 13693 13694
/*
 * "quit" command
 */
13695
static const vshCmdInfo info_quit[] = {
13696
    {"help", N_("quit this interactive terminal")},
13697
    {"desc", ""},
13698
    {NULL, NULL}
K
Karel Zak 已提交
13699 13700
};

E
Eric Blake 已提交
13701
static bool
13702
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
13703
{
E
Eric Blake 已提交
13704 13705
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
13706 13707
}

13708 13709 13710 13711 13712 13713 13714
/* 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;
13715
    bool halt = false;
13716 13717 13718
    char *doc = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
E
Eric Blake 已提交
13719
    const char *name = NULL;
13720 13721

    snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745

    /* 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);
    }

13746 13747 13748
    if (snapshot == NULL)
        goto cleanup;

13749 13750 13751 13752 13753
    if (halt && virDomainDestroy(dom) < 0) {
        virshReportError(ctl);
        goto cleanup;
    }

E
Eric Blake 已提交
13754
    name = virDomainSnapshotGetName(snapshot);
13755
    if (!name) {
E
Eric Blake 已提交
13756
        vshError(ctl, "%s", _("Could not get snapshot name"));
13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775
        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;
}

13776 13777 13778 13779
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
13780 13781
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
13782 13783 13784 13785 13786 13787
    {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")},
13788 13789 13790
    {"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")},
13791
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
13792
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
13793 13794 13795
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13796
static bool
13797 13798 13799
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13800
    bool ret = false;
13801
    const char *from = NULL;
13802
    char *buffer = NULL;
13803 13804 13805 13806 13807 13808 13809 13810
    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;
13811 13812
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
13813 13814
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
13815

13816
    if (!vshConnectionUsability(ctl, ctl->conn))
13817 13818 13819 13820 13821 13822
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

13823
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
13824
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839
    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;
    }

13840
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, from);
13841 13842 13843 13844 13845 13846 13847 13848 13849

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

13850 13851 13852
/*
 * "snapshot-create-as" command
 */
13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908
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;
}

13909 13910 13911 13912 13913 13914 13915 13916 13917 13918
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 已提交
13919
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
13920
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
13921
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
13922 13923 13924
    {"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]")},
13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936
    {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;
13937
    unsigned int flags = 0;
13938
    const vshCmdOpt *opt = NULL;
13939 13940 13941

    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
13942 13943
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
13944 13945
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961

    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)
13962
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
13963
    if (desc)
13964
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
13965 13966 13967 13968 13969 13970 13971 13972 13973 13974
    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");
    }
13975 13976 13977 13978 13979 13980 13981 13982
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
13983 13984 13985 13986 13987 13988
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

13989
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, NULL);
13990 13991 13992 13993 13994 13995 13996 13997 13998

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

13999 14000 14001 14002 14003 14004 14005 14006 14007 14008 14009 14010 14011 14012 14013 14014 14015 14016 14017 14018 14019 14020 14021 14022 14023 14024 14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037
/* 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;
}

14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048
/*
 * "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")},
14049
    {"snapshotname", VSH_OT_DATA, 0, N_("snapshot name")},
14050
    {"current", VSH_OT_BOOL, 0, N_("also set edited snapshot as current")},
14051 14052
    {"rename", VSH_OT_BOOL, 0, N_("allow renaming an existing snapshot")},
    {"clone", VSH_OT_BOOL, 0, N_("allow cloning to new name")},
14053 14054 14055 14056 14057 14058 14059 14060
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotEdit(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    virDomainSnapshotPtr snapshot = NULL;
14061
    virDomainSnapshotPtr edited = NULL;
14062
    const char *name;
14063
    const char *edited_name;
14064 14065 14066 14067 14068 14069
    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;
14070 14071 14072 14073 14074 14075 14076 14077
    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;
    }
14078

14079 14080
    if (vshCommandOptBool(cmd, "current") &&
        vshCommandOptBool(cmd, "snapshotname"))
14081 14082 14083 14084 14085 14086 14087 14088 14089
        define_flags |= VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT;

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

14090 14091
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", false, dom,
                          &snapshot, &name) < 0)
14092 14093 14094 14095 14096 14097 14098
        goto cleanup;

    /* Get the XML configuration of the snapshot.  */
    doc = virDomainSnapshotGetXMLDesc(snapshot, getxml_flags);
    if (!doc)
        goto cleanup;

14099 14100 14101 14102
    /* 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;

14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127
    /* 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.  */
14128 14129
    edited = virDomainSnapshotCreateXML(dom, doc_edited, define_flags);
    if (!edited) {
14130 14131 14132 14133
        vshError(ctl, _("Failed to update %s"), name);
        goto cleanup;
    }

14134 14135 14136 14137 14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157
    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;
        }
    }

14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168
    ret = true;

cleanup:
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
    if (snapshot)
        virDomainSnapshotFree(snapshot);
14169 14170
    if (edited)
        virDomainSnapshotFree(edited);
14171 14172 14173 14174 14175
    if (dom)
        virDomainFree(dom);
    return ret;
}

14176 14177 14178 14179
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
14180 14181
    {"help", N_("Get or set the current snapshot")},
    {"desc", N_("Get or set the current snapshot")},
14182 14183 14184 14185 14186
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
14187
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
14188 14189
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
14190 14191
    {"snapshotname", VSH_OT_DATA, 0,
     N_("name of existing snapshot to make current")},
14192 14193 14194
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14195
static bool
14196 14197 14198
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14199
    bool ret = false;
14200 14201
    int current;
    virDomainSnapshotPtr snapshot = NULL;
14202
    char *xml = NULL;
14203
    const char *snapshotname = NULL;
14204
    unsigned int flags = 0;
14205
    const char *domname;
14206 14207 14208

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

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

14213
    dom = vshCommandOptDomain(ctl, cmd, &domname);
14214 14215 14216
    if (dom == NULL)
        goto cleanup;

14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236
    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;
14237 14238 14239
        /* 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;
14240 14241 14242 14243 14244 14245 14246 14247 14248
        snapshot2 = virDomainSnapshotCreateXML(dom, xml, flags);
        if (snapshot2 == NULL)
            goto cleanup;
        virDomainSnapshotFree(snapshot2);
        vshPrint(ctl, _("Snapshot %s set as current"), snapshotname);
        ret = true;
        goto cleanup;
    }

14249
    current = virDomainHasCurrentSnapshot(dom, 0);
14250 14251 14252 14253
    if (current < 0) {
        goto cleanup;
    } else if (!current) {
        vshError(ctl, _("domain '%s' has no current snapshot"), domname);
14254
        goto cleanup;
14255
    } else {
E
Eric Blake 已提交
14256
        const char *name = NULL;
14257 14258 14259 14260

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

14261
        if (vshCommandOptBool(cmd, "name")) {
E
Eric Blake 已提交
14262
            name = virDomainSnapshotGetName(snapshot);
14263 14264
            if (!name)
                goto cleanup;
E
Eric Blake 已提交
14265 14266 14267 14268
        } else {
            xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
            if (!xml)
                goto cleanup;
14269 14270 14271
        }

        vshPrint(ctl, "%s", name ? name : xml);
14272 14273
    }

E
Eric Blake 已提交
14274
    ret = true;
14275 14276

cleanup:
14277 14278
    if (!ret)
        virshReportError(ctl);
14279
    VIR_FREE(xml);
14280 14281 14282 14283 14284 14285 14286 14287
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

14288
/* Helper function to get the name of a snapshot's parent.  Caller
14289 14290 14291 14292 14293 14294
 * 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)
14295 14296 14297 14298 14299
{
    virDomainSnapshotPtr parent = NULL;
    char *xml = NULL;
    xmlDocPtr xmldoc = NULL;
    xmlXPathContextPtr ctxt = NULL;
14300 14301 14302
    int ret = -1;

    *parent_name = NULL;
14303 14304

    /* Try new API, since it is faster. */
14305
    if (!ctl->useSnapshotOld) {
14306 14307 14308
        parent = virDomainSnapshotGetParent(snapshot, 0);
        if (parent) {
            /* API works, and virDomainSnapshotGetName will succeed */
14309 14310
            *parent_name = vshStrdup(ctl, virDomainSnapshotGetName(parent));
            ret = 0;
14311 14312 14313 14314
            goto cleanup;
        }
        if (last_error->code == VIR_ERR_NO_DOMAIN_SNAPSHOT) {
            /* API works, and we found a root with no parent */
14315
            ret = 0;
14316 14317 14318
            goto cleanup;
        }
        /* API didn't work, fall back to XML scraping. */
14319
        ctl->useSnapshotOld = true;
14320 14321 14322 14323 14324 14325 14326 14327 14328 14329
    }

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

    xmldoc = virXMLParseStringCtxt(xml, _("(domain_snapshot)"), &ctxt);
    if (!xmldoc)
        goto cleanup;

14330 14331
    *parent_name = virXPathString("string(/domainsnapshot/parent/name)", ctxt);
    ret = 0;
14332 14333

cleanup:
14334 14335 14336 14337 14338 14339 14340
    if (ret < 0) {
        virshReportError(ctl);
        vshError(ctl, "%s", _("unable to determine if snapshot has parent"));
    } else {
        virFreeError(last_error);
        last_error = NULL;
    }
14341 14342 14343 14344 14345
    if (parent)
        virDomainSnapshotFree(parent);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xmldoc);
    VIR_FREE(xml);
14346
    return ret;
14347 14348
}

14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359
/*
 * "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")},
14360
    {"parent", VSH_OT_BOOL, 0, N_("add a column showing parent snapshot")},
14361
    {"roots", VSH_OT_BOOL, 0, N_("list only snapshots without parents")},
14362
    {"leaves", VSH_OT_BOOL, 0, N_("list only snapshots without children")},
14363 14364
    {"metadata", VSH_OT_BOOL, 0,
     N_("list only snapshots that have metadata that would prevent undefine")},
14365
    {"tree", VSH_OT_BOOL, 0, N_("list snapshots in a tree")},
14366
    {"from", VSH_OT_DATA, 0, N_("limit list to children of given snapshot")},
14367 14368
    {"current", VSH_OT_BOOL, 0,
     N_("limit list to children of current snapshot")},
14369
    {"descendants", VSH_OT_BOOL, 0, N_("with --from, list all descendants")},
14370 14371 14372
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14373
static bool
14374 14375 14376
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14377
    bool ret = false;
14378
    unsigned int flags = 0;
14379 14380
    int parent_filter = 0; /* -1 for roots filtering, 0 for no parent
                              information needed, 1 for parent column */
14381 14382
    int numsnaps;
    char **names = NULL;
14383
    char **parents = NULL;
14384
    int actual = 0;
14385 14386 14387 14388 14389 14390
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
14391
    char *parent = NULL;
14392 14393
    long long creation_longlong;
    time_t creation_time_t;
14394 14395
    char timestr[100];
    struct tm time_info;
14396
    bool tree = vshCommandOptBool(cmd, "tree");
14397
    bool leaves = vshCommandOptBool(cmd, "leaves");
14398 14399
    const char *from = NULL;
    virDomainSnapshotPtr start = NULL;
14400
    int start_index = -1;
14401
    bool descendants = false;
14402

14403 14404 14405 14406 14407 14408 14409 14410 14411 14412
    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)
14413
        goto cleanup;
14414

14415
    if (vshCommandOptBool(cmd, "parent")) {
14416 14417
        if (vshCommandOptBool(cmd, "roots")) {
            vshError(ctl, "%s",
14418
                     _("--parent and --roots are mutually exclusive"));
14419 14420
            return false;
        }
14421 14422
        if (tree) {
            vshError(ctl, "%s",
14423
                     _("--parent and --tree are mutually exclusive"));
14424 14425
            return false;
        }
14426
        parent_filter = 1;
14427
    } else if (vshCommandOptBool(cmd, "roots")) {
14428 14429
        if (tree) {
            vshError(ctl, "%s",
14430
                     _("--roots and --tree are mutually exclusive"));
14431 14432
            return false;
        }
14433 14434 14435 14436
        if (from) {
            vshError(ctl, "%s",
                     _("--roots and --from are mutually exclusive"));
        }
14437 14438
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
    }
14439 14440 14441 14442 14443 14444 14445 14446
    if (leaves) {
        if (tree) {
            vshError(ctl, "%s",
                     _("--leaves and --tree are mutually exclusive"));
            return false;
        }
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_LEAVES;
    }
14447 14448 14449

    if (vshCommandOptBool(cmd, "metadata")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_METADATA;
14450 14451
    }

14452
    if (from) {
14453 14454
        descendants = vshCommandOptBool(cmd, "descendants");
        if (descendants || tree) {
14455 14456
            flags |= VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS;
        }
14457 14458
        numsnaps = ctl->useSnapshotOld ? -1 :
            virDomainSnapshotNumChildren(start, flags);
14459
        if (numsnaps < 0) {
14460 14461
            if (ctl->useSnapshotOld ||
                last_error->code == VIR_ERR_NO_SUPPORT) {
14462
                /* We can emulate --from.  */
14463
                /* XXX can we also emulate --leaves? */
14464 14465 14466 14467 14468 14469
                virFreeError(last_error);
                last_error = NULL;
                ctl->useSnapshotOld = true;
                flags &= ~VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS;
                numsnaps = virDomainSnapshotNum(dom, flags);
            }
14470 14471
        } else if (tree) {
            numsnaps++;
14472
        }
14473
    } else {
14474
        numsnaps = virDomainSnapshotNum(dom, flags);
14475 14476

        /* Fall back to simulation if --roots was unsupported. */
14477
        /* XXX can we also emulate --leaves? */
14478 14479 14480 14481 14482 14483 14484 14485
        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);
        }
14486 14487
    }

14488 14489 14490
    if (numsnaps < 0) {
        if (!last_error)
            vshError(ctl, _("missing support"));
14491
        goto cleanup;
14492
    }
14493

14494 14495 14496 14497 14498 14499 14500 14501 14502
    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\
14503
------------------------------------------------------------\n");
14504
    }
14505

14506 14507 14508 14509
    if (!numsnaps) {
        ret = true;
        goto cleanup;
    }
14510

14511 14512 14513
    if (VIR_ALLOC_N(names, numsnaps) < 0)
        goto cleanup;

14514
    if (from && !ctl->useSnapshotOld) {
14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532
        /* 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);
    }
14533 14534
    if (actual < 0)
        goto cleanup;
14535

E
Eric Blake 已提交
14536 14537
    qsort(&names[0], actual, sizeof(char*), namesorter);

14538 14539
    if (tree || ctl->useSnapshotOld) {
        parents = vshCalloc(ctl, sizeof(char *), actual);
14540
        for (i = (from && !ctl->useSnapshotOld); i < actual; i++) {
14541 14542 14543 14544 14545
            if (ctl->useSnapshotOld && STREQ(names[i], from)) {
                start_index = i;
                continue;
            }

14546 14547 14548 14549
            /* free up memory from previous iterations of the loop */
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
14550 14551
            if (!snapshot ||
                vshGetSnapshotParent(ctl, snapshot, &parents[i]) < 0) {
14552 14553 14554 14555 14556 14557
                while (--i >= 0)
                    VIR_FREE(parents[i]);
                VIR_FREE(parents);
                goto cleanup;
            }
        }
14558 14559 14560
    }
    if (tree) {
        char indentBuf[INDENT_BUFLEN];
14561 14562
        for (i = 0 ; i < actual ; i++) {
            memset(indentBuf, '\0', sizeof indentBuf);
14563
            if (ctl->useSnapshotOld ? STREQ(names[i], from) : !parents[i])
14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 14577
                cmdNodeListDevicesPrint(ctl,
                                        names,
                                        parents,
                                        actual,
                                        i,
                                        i,
                                        0,
                                        0,
                                        indentBuf);
        }

        ret = true;
        goto cleanup;
    } else {
14578
        if (ctl->useSnapshotOld && descendants) {
14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600 14601 14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628
            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]);
14629 14630
        }

14631
        for (i = 0; i < actual; i++) {
14632 14633
            if (ctl->useSnapshotOld &&
                (descendants ? !names[i] : STRNEQ_NULLABLE(parents[i], from)))
14634 14635
                continue;

14636
            /* free up memory from previous iterations of the loop */
14637
            VIR_FREE(parent);
14638 14639 14640 14641
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
14642
            xmlFreeDoc(xml);
14643 14644 14645 14646 14647 14648 14649 14650 14651 14652
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

14653
            xml = virXMLParseStringCtxt(doc, _("(domain_snapshot)"), &ctxt);
14654 14655 14656
            if (!xml)
                continue;

14657 14658 14659
            if (parent_filter) {
                parent = virXPathString("string(/domainsnapshot/parent/name)",
                                        ctxt);
14660 14661
                if (!parent && parent_filter < 0)
                    continue;
14662 14663
            }

14664 14665 14666
            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
14667 14668
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
14669
                continue;
14670 14671 14672 14673 14674 14675
            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);
14676 14677
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z",
                     &time_info);
14678

14679 14680 14681 14682 14683
            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);
14684 14685 14686
        }
    }

E
Eric Blake 已提交
14687
    ret = true;
14688 14689 14690

cleanup:
    /* this frees up memory from the last iteration of the loop */
14691
    VIR_FREE(parent);
14692 14693 14694
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
14695 14696
    if (start)
        virDomainSnapshotFree(start);
14697
    xmlXPathFreeContext(ctxt);
14698
    xmlFreeDoc(xml);
14699
    VIR_FREE(doc);
14700
    for (i = 0; i < actual; i++) {
14701
        VIR_FREE(names[i]);
14702 14703 14704
        if (parents)
            VIR_FREE(parents[i]);
    }
14705
    VIR_FREE(names);
14706
    VIR_FREE(parents);
14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724
    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")},
14725 14726
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
14727 14728 14729
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14730
static bool
14731 14732 14733
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14734
    bool ret = false;
14735
    const char *name = NULL;
14736 14737
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
14738 14739 14740 14741
    unsigned int flags = 0;

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

14743
    if (!vshConnectionUsability(ctl, ctl->conn))
14744 14745 14746 14747 14748 14749
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

14750
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
14751 14752 14753 14754 14755 14756
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

14757
    xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
14758 14759 14760
    if (!xml)
        goto cleanup;

14761
    vshPrint(ctl, "%s", xml);
14762

E
Eric Blake 已提交
14763
    ret = true;
14764 14765 14766 14767 14768 14769 14770 14771 14772 14773 14774

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

E
Eric Blake 已提交
14775 14776 14777 14778
/*
 * "snapshot-parent" command
 */
static const vshCmdInfo info_snapshot_parent[] = {
E
Eric Blake 已提交
14779
    {"help", N_("Get the name of the parent of a snapshot")},
E
Eric Blake 已提交
14780 14781 14782 14783 14784 14785
    {"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")},
14786 14787
    {"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 已提交
14788 14789 14790 14791 14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803 14804 14805 14806
    {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;

14807 14808
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", true, dom,
                          &snapshot, &name) < 0)
E
Eric Blake 已提交
14809 14810
        goto cleanup;

14811
    if (vshGetSnapshotParent(ctl, snapshot, &parent) < 0)
E
Eric Blake 已提交
14812
        goto cleanup;
14813 14814 14815 14816
    if (!parent) {
        vshError(ctl, _("snapshot '%s' has no parent"), name);
        goto cleanup;
    }
E
Eric Blake 已提交
14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831

    vshPrint(ctl, "%s", parent);

    ret = true;

cleanup:
    VIR_FREE(parent);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

14832
/*
14833
 * "snapshot-revert" command
14834
 */
14835
static const vshCmdInfo info_snapshot_revert[] = {
14836 14837 14838 14839 14840
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

14841
static const vshCmdOptDef opts_snapshot_revert[] = {
14842
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
14843 14844
    {"snapshotname", VSH_OT_DATA, 0, N_("snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("revert to current snapshot")},
14845 14846
    {"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 已提交
14847
    {"force", VSH_OT_BOOL, 0, N_("try harder on risky reverts")},
14848 14849 14850
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14851
static bool
14852
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
14853 14854
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14855
    bool ret = false;
14856
    const char *name = NULL;
14857
    virDomainSnapshotPtr snapshot = NULL;
14858
    unsigned int flags = 0;
E
Eric Blake 已提交
14859 14860
    bool force = false;
    int result;
14861 14862 14863 14864 14865

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED;
E
Eric Blake 已提交
14866 14867 14868 14869 14870 14871
    /* 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;
14872

14873
    if (!vshConnectionUsability(ctl, ctl->conn))
14874 14875 14876 14877 14878 14879
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

14880 14881
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", true, dom,
                          &snapshot, &name) < 0)
14882 14883
        goto cleanup;

E
Eric Blake 已提交
14884 14885 14886 14887 14888 14889 14890 14891 14892
    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)
14893 14894
        goto cleanup;

E
Eric Blake 已提交
14895
    ret = true;
14896 14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916

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")},
14917 14918
    {"snapshotname", VSH_OT_DATA, 0, N_("snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("delete current snapshot")},
14919
    {"children", VSH_OT_BOOL, 0, N_("delete snapshot and all children")},
14920 14921 14922
    {"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")},
14923 14924 14925
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14926
static bool
14927 14928 14929
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14930
    bool ret = false;
14931
    const char *name = NULL;
14932 14933 14934
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

14935
    if (!vshConnectionUsability(ctl, ctl->conn))
14936 14937 14938 14939 14940 14941
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

14942 14943
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", true, dom,
                          &snapshot, &name) < 0)
14944 14945 14946 14947
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;
14948 14949 14950 14951
    if (vshCommandOptBool(cmd, "children-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY;
    if (vshCommandOptBool(cmd, "metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY;
14952

14953 14954 14955
    /* 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.  */
14956
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
14957 14958 14959 14960
        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);
14961 14962
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
14963
        goto cleanup;
14964
    }
14965

E
Eric Blake 已提交
14966
    ret = true;
14967 14968 14969 14970 14971 14972 14973 14974 14975 14976

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

14977 14978 14979 14980
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
14981 14982
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
14983 14984 14985 14986 14987
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
14988
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
14989
    {"cmd", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("command")},
14990 14991 14992
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14993
static bool
14994 14995 14996
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14997
    bool ret = false;
14998
    char *monitor_cmd = NULL;
14999
    char *result = NULL;
15000
    unsigned int flags = 0;
15001 15002 15003
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
15004 15005 15006 15007 15008 15009 15010 15011

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

15012 15013 15014 15015 15016 15017 15018 15019
    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"));
15020 15021
        goto cleanup;
    }
15022
    monitor_cmd = virBufferContentAndReset(&buf);
15023

15024 15025 15026 15027
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
15028 15029 15030 15031
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
15032
    ret = true;
15033 15034 15035

cleanup:
    VIR_FREE(result);
15036
    VIR_FREE(monitor_cmd);
15037 15038 15039 15040 15041 15042
    if (dom)
        virDomainFree(dom);

    return ret;
}

15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 15084 15085 15086 15087 15088
/*
 * "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;
}

15089
static const vshCmdDef domManagementCmds[] = {
15090 15091 15092 15093 15094 15095 15096
    {"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 已提交
15097
    {"blkdeviotune", cmdBlkdeviotune, opts_blkdeviotune, info_blkdeviotune, 0},
15098
    {"blkiotune", cmdBlkiotune, opts_blkiotune, info_blkiotune, 0},
15099 15100
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
15101
    {"blockresize", cmdBlockResize, opts_block_resize, info_block_resize, 0},
15102
#ifndef WIN32
15103
    {"console", cmdConsole, opts_console, info_console, 0},
15104
#endif
15105 15106 15107 15108 15109 15110 15111 15112 15113 15114 15115
    {"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},
15116
    {"domif-setlink", cmdDomIfSetLink, opts_domif_setlink, info_domif_setlink, 0},
15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128
    {"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},
15129
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
15130 15131 15132 15133 15134 15135 15136 15137
    {"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},
15138 15139
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
15140 15141
    {"migrate-getspeed", cmdMigrateGetMaxSpeed,
     opts_migrate_getspeed, info_migrate_getspeed, 0},
15142
    {"reboot", cmdReboot, opts_reboot, info_reboot, 0},
X
Xu He Jie 已提交
15143
    {"reset", cmdReset, opts_reset, info_reset, 0},
15144 15145 15146
    {"restore", cmdRestore, opts_restore, info_restore, 0},
    {"resume", cmdResume, opts_resume, info_resume, 0},
    {"save", cmdSave, opts_save, info_save, 0},
15147 15148 15149 15150 15151 15152
    {"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},
15153
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
15154
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
15155 15156 15157 15158 15159 15160 15161 15162 15163 15164 15165 15166
    {"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 已提交
15167
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
15168
    {"version", cmdVersion, opts_version, info_version, 0},
15169 15170
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
15171 15172 15173
};

static const vshCmdDef domMonitoringCmds[] = {
15174
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
15175
    {"domblklist", cmdDomblklist, opts_domblklist, info_domblklist, 0},
15176
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
15177
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
15178
    {"domif-getlink", cmdDomIfGetLink, opts_domif_getlink, info_domif_getlink, 0},
15179 15180 15181 15182 15183 15184
    {"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}
15185 15186 15187
};

static const vshCmdDef storagePoolCmds[] = {
15188
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
15189
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
15190
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205 15206 15207 15208 15209 15210 15211
     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}
15212 15213 15214
};

static const vshCmdDef storageVolCmds[] = {
15215 15216 15217 15218 15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 15229 15230 15231 15232
    {"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}
15233
};
15234

15235
static const vshCmdDef networkCmds[] = {
15236 15237 15238 15239 15240 15241 15242 15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254
    {"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}
15255
};
15256

15257
static const vshCmdDef nodedevCmds[] = {
15258 15259 15260 15261 15262 15263 15264 15265 15266 15267 15268 15269 15270 15271 15272
    {"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}
15273 15274 15275
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
15276 15277
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
15278 15279
    {"iface-bridge", cmdInterfaceBridge, opts_interface_bridge,
     info_interface_bridge, 0},
E
Eric Blake 已提交
15280 15281
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
15282 15283 15284 15285 15286 15287 15288 15289 15290 15291 15292 15293 15294 15295
    {"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 已提交
15296 15297
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
15298 15299
    {"iface-start", cmdInterfaceStart, opts_interface_start,
     info_interface_start, 0},
15300 15301
    {"iface-unbridge", cmdInterfaceUnbridge, opts_interface_unbridge,
     info_interface_unbridge, 0},
15302 15303 15304
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine,
     info_interface_undefine, 0},
    {NULL, NULL, NULL, NULL, 0}
15305
};
15306

15307
static const vshCmdDef nwfilterCmds[] = {
15308 15309 15310 15311 15312 15313 15314 15315 15316 15317 15318
    {"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}
15319
};
15320

15321
static const vshCmdDef secretCmds[] = {
15322 15323 15324 15325 15326 15327 15328 15329 15330 15331 15332 15333
    {"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}
15334
};
15335

15336
static const vshCmdDef virshCmds[] = {
15337 15338 15339 15340 15341 15342 15343
    {"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}
15344
};
15345

15346
static const vshCmdDef snapshotCmds[] = {
15347 15348
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
15349 15350
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
15351 15352 15353 15354 15355 15356
    {"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},
15357 15358
    {"snapshot-edit", cmdSnapshotEdit, opts_snapshot_edit,
     info_snapshot_edit, 0},
15359 15360
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
E
Eric Blake 已提交
15361 15362
    {"snapshot-parent", cmdSnapshotParent, opts_snapshot_parent,
     info_snapshot_parent, 0},
15363 15364 15365
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
15366
};
15367

15368
static const vshCmdDef hostAndHypervisorCmds[] = {
15369 15370 15371 15372 15373
    {"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},
15374
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
15375
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
15376
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
15377
    {"nodesuspend", cmdNodeSuspend, opts_node_suspend, info_nodesuspend, 0},
15378
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
15379 15380 15381 15382 15383
    {"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 已提交
15384 15385
};

15386 15387 15388 15389 15390 15391 15392 15393 15394 15395 15396 15397 15398 15399 15400 15401 15402
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 已提交
15403 15404 15405 15406
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
15407
static const char *
15408
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
15409
{
15410
    const vshCmdInfo *info;
15411

K
Karel Zak 已提交
15412
    for (info = cmd->info; info && info->name; info++) {
15413
        if (STREQ(info->name, name))
K
Karel Zak 已提交
15414 15415 15416 15417 15418
            return info->data;
    }
    return NULL;
}

15419
/* Validate that the options associated with cmd can be parsed.  */
15420
static int
E
Eric Blake 已提交
15421
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
15422 15423 15424 15425 15426
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
15427 15428 15429
    *opts_need_arg = 0;
    *opts_required = 0;

15430 15431 15432 15433 15434 15435 15436 15437 15438
    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 已提交
15439
            if (opt->flags & VSH_OFLAG_REQ)
15440 15441 15442
                return -1; /* bool options can't be mandatory */
            continue;
        }
E
Eric Blake 已提交
15443 15444
        if (opt->flags & VSH_OFLAG_REQ_OPT) {
            if (opt->flags & VSH_OFLAG_REQ)
L
Lai Jiangshan 已提交
15445 15446 15447 15448
                *opts_required |= 1 << i;
            continue;
        }

15449
        *opts_need_arg |= 1 << i;
E
Eric Blake 已提交
15450
        if (opt->flags & VSH_OFLAG_REQ) {
15451 15452 15453 15454 15455 15456
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
15457 15458 15459

        if (opt->type == VSH_OT_ARGV && cmd->opts[i + 1].name)
            return -1; /* argv option must be listed last */
15460 15461 15462 15463
    }
    return 0;
}

15464
static const vshCmdOptDef *
15465
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
15466
                   uint32_t *opts_seen, int *opt_index)
15467
{
15468 15469 15470 15471
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
15472

15473
        if (STREQ(opt->name, name)) {
15474
            if ((*opts_seen & (1 << i)) && opt->type != VSH_OT_ARGV) {
15475 15476 15477
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
15478 15479
            *opts_seen |= 1 << i;
            *opt_index = i;
K
Karel Zak 已提交
15480
            return opt;
15481 15482 15483 15484 15485
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
15486 15487 15488
    return NULL;
}

15489
static const vshCmdOptDef *
15490 15491
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
15492
{
15493
    int i;
15494
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
15495

15496 15497 15498 15499
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
15500
    i = ffs(*opts_need_arg) - 1;
15501
    opt = &cmd->opts[i];
15502
    if (opt->type != VSH_OT_ARGV)
15503
        *opts_need_arg &= ~(1 << i);
15504
    *opts_seen |= 1 << i;
15505
    return opt;
K
Karel Zak 已提交
15506 15507
}

15508 15509 15510
/*
 * Checks for required options
 */
15511
static int
15512 15513
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
15514
{
15515
    const vshCmdDef *def = cmd->def;
15516 15517 15518 15519 15520 15521 15522 15523 15524
    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];
15525

15526
            vshError(ctl,
15527
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
15528 15529 15530
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
15531 15532
        }
    }
15533
    return -1;
15534 15535
}

15536
static const vshCmdDef *
15537 15538
vshCmddefSearch(const char *cmdname)
{
15539
    const vshCmdGrp *g;
15540
    const vshCmdDef *c;
15541

15542 15543
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
15544
            if (STREQ(c->name, cmdname))
15545 15546 15547 15548
                return c;
        }
    }

K
Karel Zak 已提交
15549 15550 15551
    return NULL;
}

15552 15553 15554 15555 15556 15557
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
15558
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
15559 15560 15561 15562 15563 15564
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
15565
static bool
15566 15567 15568 15569 15570 15571 15572
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 已提交
15573
        return false;
15574 15575 15576 15577 15578 15579 15580 15581 15582 15583
    } 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 已提交
15584
    return true;
15585 15586
}

E
Eric Blake 已提交
15587
static bool
15588
vshCmddefHelp(vshControl *ctl, const char *cmdname)
15589
{
15590
    const vshCmdDef *def = vshCmddefSearch(cmdname);
15591

K
Karel Zak 已提交
15592
    if (!def) {
15593
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
15594
        return false;
15595
    } else {
E
Eric Blake 已提交
15596 15597
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
15598
        const char *help = _(vshCmddefGetInfo(def, "help"));
15599
        char buf[256];
15600 15601
        uint32_t opts_need_arg;
        uint32_t opts_required;
15602
        bool shortopt = false; /* true if 'arg' works instead of '--opt arg' */
15603 15604 15605 15606

        if (vshCmddefOptParse(def, &opts_need_arg, &opts_required)) {
            vshError(ctl, _("internal error: bad options in command: '%s'"),
                     def->name);
E
Eric Blake 已提交
15607
            return false;
15608
        }
K
Karel Zak 已提交
15609

15610
        fputs(_("  NAME\n"), stdout);
15611 15612
        fprintf(stdout, "    %s - %s\n", def->name, help);

15613 15614 15615 15616 15617
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
15618
                const char *fmt = "%s";
15619 15620
                switch (opt->type) {
                case VSH_OT_BOOL:
15621
                    fmt = "[--%s]";
15622 15623
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
15624
                    /* xgettext:c-format */
E
Eric Blake 已提交
15625
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>"
15626
                           : _("[--%s <number>]"));
15627 15628
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
15629 15630
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
15631 15632
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
15633 15634
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
15635 15636
                    break;
                case VSH_OT_DATA:
E
Eric Blake 已提交
15637
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
15638 15639
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
15640 15641 15642
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
15643 15644 15645 15646 15647 15648 15649 15650
                    if (shortopt) {
                        fmt = (opt->flags & VSH_OFLAG_REQ)
                            ? _("{[--%s] <string>}...")
                            : _("[[--%s] <string>]...");
                    } else {
                        fmt = (opt->flags & VSH_OFLAG_REQ) ? _("<%s>...")
                            : _("[<%s>]...");
                    }
15651 15652
                    break;
                default:
15653
                    assert(0);
15654
                }
15655
                fputc(' ', stdout);
E
Eric Blake 已提交
15656
                fprintf(stdout, fmt, opt->name);
15657
            }
K
Karel Zak 已提交
15658
        }
15659 15660 15661
        fputc('\n', stdout);

        if (desc[0]) {
15662
            /* Print the description only if it's not empty.  */
15663
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
15664
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
15665
        }
15666

K
Karel Zak 已提交
15667
        if (def->opts) {
15668
            const vshCmdOptDef *opt;
15669
            fputs(_("\n  OPTIONS\n"), stdout);
15670
            for (opt = def->opts; opt->name; opt++) {
15671 15672
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
15673
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
15674 15675
                    break;
                case VSH_OT_INT:
15676
                    snprintf(buf, sizeof(buf),
E
Eric Blake 已提交
15677
                             (opt->flags & VSH_OFLAG_REQ) ? _("[--%s] <number>")
15678
                             : _("--%s <number>"), opt->name);
15679 15680
                    break;
                case VSH_OT_STRING:
15681
                    /* OT_STRING should never be VSH_OFLAG_REQ */
15682
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
15683 15684
                    break;
                case VSH_OT_DATA:
15685 15686
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
15687 15688
                    break;
                case VSH_OT_ARGV:
15689 15690 15691
                    snprintf(buf, sizeof(buf),
                             shortopt ? _("[--%s] <string>") : _("<%s>"),
                             opt->name);
15692
                    break;
15693 15694 15695
                default:
                    assert(0);
                }
15696

E
Eric Blake 已提交
15697
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
15698
            }
K
Karel Zak 已提交
15699 15700 15701
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
15702
    return true;
K
Karel Zak 已提交
15703 15704 15705 15706 15707 15708
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
15709 15710 15711
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
15712 15713
    vshCmdOpt *a = arg;

15714
    while (a) {
K
Karel Zak 已提交
15715
        vshCmdOpt *tmp = a;
15716

K
Karel Zak 已提交
15717 15718
        a = a->next;

15719 15720
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
15721 15722 15723 15724
    }
}

static void
15725
vshCommandFree(vshCmd *cmd)
15726
{
K
Karel Zak 已提交
15727 15728
    vshCmd *c = cmd;

15729
    while (c) {
K
Karel Zak 已提交
15730
        vshCmd *tmp = c;
15731

K
Karel Zak 已提交
15732 15733 15734 15735
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
15736
        VIR_FREE(tmp);
K
Karel Zak 已提交
15737 15738 15739
    }
}

E
Eric Blake 已提交
15740 15741 15742 15743 15744 15745 15746 15747 15748 15749 15750
/**
 * 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 已提交
15751
 */
E
Eric Blake 已提交
15752 15753
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
15754
{
E
Eric Blake 已提交
15755 15756
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
15757

E
Eric Blake 已提交
15758 15759 15760 15761 15762 15763 15764
    /* 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 已提交
15765
    }
E
Eric Blake 已提交
15766 15767 15768 15769 15770 15771 15772

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
E
Eric Blake 已提交
15773
            return (valid->flags & VSH_OFLAG_REQ) == 0 ? 0 : -1;
E
Eric Blake 已提交
15774 15775 15776 15777
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
15778 15779
}

E
Eric Blake 已提交
15780 15781
/**
 * vshCommandOptInt:
15782 15783 15784 15785 15786 15787 15788
 * @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 已提交
15789
 * 0 if option not found and not required (@value untouched)
15790
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
15791 15792
 */
static int
15793
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
15794
{
E
Eric Blake 已提交
15795 15796 15797
    vshCmdOpt *arg;
    int ret;
    int num;
15798
    char *end_p = NULL;
15799

E
Eric Blake 已提交
15800 15801 15802 15803 15804 15805 15806
    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;
15807
    }
E
Eric Blake 已提交
15808 15809 15810 15811 15812 15813 15814

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
15815 15816
}

15817

E
Eric Blake 已提交
15818 15819 15820 15821 15822 15823
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
15824 15825 15826 15827 15828 15829
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
15830 15831 15832
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
15833 15834
    char *end_p = NULL;

E
Eric Blake 已提交
15835 15836 15837 15838 15839 15840 15841
    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;
15842
    }
E
Eric Blake 已提交
15843 15844 15845 15846 15847 15848 15849

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
15850 15851 15852
}


15853
/*
E
Eric Blake 已提交
15854 15855 15856 15857 15858
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
15859 15860 15861 15862 15863
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
15864
{
E
Eric Blake 已提交
15865 15866
    vshCmdOpt *arg;
    int ret;
15867
    unsigned long num;
15868 15869
    char *end_p = NULL;

E
Eric Blake 已提交
15870 15871 15872 15873 15874 15875 15876
    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;
15877
    }
E
Eric Blake 已提交
15878 15879 15880 15881 15882 15883 15884

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
15885 15886
}

E
Eric Blake 已提交
15887 15888 15889 15890 15891 15892
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
15893
 * Returns option as STRING
E
Eric Blake 已提交
15894 15895 15896 15897
 * 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 已提交
15898
 */
15899 15900
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
15901
{
E
Eric Blake 已提交
15902 15903 15904 15905 15906 15907 15908 15909 15910 15911
    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;
15912
    }
15913

E
Eric Blake 已提交
15914
    if (!*arg->data && !(arg->def->flags & VSH_OFLAG_EMPTY_OK)) {
E
Eric Blake 已提交
15915 15916 15917 15918
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
15919 15920
}

E
Eric Blake 已提交
15921 15922 15923 15924 15925 15926
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
15927
 * Returns option as long long
15928
 * See vshCommandOptInt()
15929
 */
15930 15931 15932
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
15933
{
E
Eric Blake 已提交
15934 15935
    vshCmdOpt *arg;
    int ret;
15936
    long long num;
15937 15938
    char *end_p = NULL;

E
Eric Blake 已提交
15939 15940 15941 15942 15943 15944 15945
    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;
15946
    }
E
Eric Blake 已提交
15947 15948 15949 15950 15951 15952 15953

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
15954 15955
}

E
Eric Blake 已提交
15956 15957 15958 15959 15960 15961 15962 15963 15964
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
15965 15966 15967 15968
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
15969 15970
    vshCmdOpt *arg;
    int ret;
15971 15972 15973
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
15974 15975 15976 15977 15978 15979 15980
    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;
15981
    }
E
Eric Blake 已提交
15982 15983 15984 15985 15986 15987 15988

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
15989 15990 15991
}


E
Eric Blake 已提交
15992 15993 15994 15995 15996 15997 15998 15999 16000
/**
 * 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 已提交
16001
 */
E
Eric Blake 已提交
16002
static bool
16003
vshCommandOptBool(const vshCmd *cmd, const char *name)
16004
{
E
Eric Blake 已提交
16005 16006 16007
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
16008 16009
}

E
Eric Blake 已提交
16010 16011 16012 16013 16014
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
16015 16016
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
16017
 *
16018
 * Requires that a VSH_OT_ARGV option be last in the
16019 16020
 * list of supported options in CMD->def->opts.
 */
16021 16022
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
16023
{
16024
    opt = opt ? opt->next : cmd->opts;
16025 16026

    while (opt) {
E
Eric Blake 已提交
16027
        if (opt->def->type == VSH_OT_ARGV) {
16028
            return opt;
16029 16030 16031 16032 16033 16034
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
16035 16036 16037 16038 16039 16040 16041 16042 16043 16044 16045 16046 16047 16048 16049 16050 16051 16052
/* 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)
16053
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
16054 16055 16056
                 cmd->def->name, optname);
    return found;
}
16057

K
Karel Zak 已提交
16058
static virDomainPtr
J
Jim Meyering 已提交
16059
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
16060
                      const char **name, int flag)
16061
{
K
Karel Zak 已提交
16062
    virDomainPtr dom = NULL;
16063
    const char *n = NULL;
K
Karel Zak 已提交
16064
    int id;
J
Jim Meyering 已提交
16065 16066 16067
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
16068

16069
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16070 16071
        return NULL;

16072
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16073 16074
             cmd->def->name, optname, n);

K
Karel Zak 已提交
16075 16076
    if (name)
        *name = n;
16077

K
Karel Zak 已提交
16078
    /* try it by ID */
16079
    if (flag & VSH_BYID) {
16080
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
16081 16082
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
16083 16084 16085
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
16086
    }
K
Karel Zak 已提交
16087
    /* try it by UUID */
16088
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
16089
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
16090
                 cmd->def->name, optname);
K
Karel Zak 已提交
16091
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
16092
    }
K
Karel Zak 已提交
16093
    /* try it by NAME */
16094
    if (dom==NULL && (flag & VSH_BYNAME)) {
16095
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
16096
                 cmd->def->name, optname);
K
Karel Zak 已提交
16097
        dom = virDomainLookupByName(ctl->conn, n);
16098
    }
K
Karel Zak 已提交
16099

16100
    if (!dom)
16101
        vshError(ctl, _("failed to get domain '%s'"), n);
16102

K
Karel Zak 已提交
16103 16104 16105
    return dom;
}

16106
static virNetworkPtr
J
Jim Meyering 已提交
16107
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
16108
                       const char **name, int flag)
16109 16110
{
    virNetworkPtr network = NULL;
16111
    const char *n = NULL;
J
Jim Meyering 已提交
16112 16113 16114
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
16115

16116
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16117 16118
        return NULL;

16119
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16120 16121 16122 16123 16124 16125
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
16126
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
16127
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
16128
                 cmd->def->name, optname);
16129 16130 16131 16132
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
16133
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
16134 16135 16136 16137 16138
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
16139
        vshError(ctl, _("failed to get network '%s'"), n);
16140 16141 16142 16143

    return network;
}

16144 16145 16146

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
16147
                        const char **name, int flag)
16148 16149
{
    virNWFilterPtr nwfilter = NULL;
16150
    const char *n = NULL;
16151 16152 16153 16154
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

16155
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16156 16157
        return NULL;

16158
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16159 16160 16161 16162 16163 16164 16165
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
16166
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
16167 16168 16169 16170 16171
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
16172
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
16173 16174 16175 16176 16177 16178 16179 16180 16181 16182
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

16183 16184
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
16185
                         const char *optname,
16186
                         const char **name, int flag)
16187 16188
{
    virInterfacePtr iface = NULL;
16189
    const char *n = NULL;
16190 16191 16192

    if (!optname)
       optname = "interface";
16193 16194 16195
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

16196
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16197 16198
        return NULL;

16199
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16200 16201 16202 16203 16204 16205
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
16206
    if ((flag & VSH_BYNAME)) {
16207
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
16208 16209 16210 16211 16212
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
16213
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
16214 16215 16216 16217 16218
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
16219
        vshError(ctl, _("failed to get interface '%s'"), n);
16220 16221 16222 16223

    return iface;
}

16224
static virStoragePoolPtr
16225
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
16226
                    const char **name, int flag)
16227 16228
{
    virStoragePoolPtr pool = NULL;
16229
    const char *n = NULL;
16230

16231
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16232 16233
        return NULL;

16234
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16235 16236 16237 16238 16239 16240
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
16241
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
16242
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
16243
                 cmd->def->name, optname);
16244 16245 16246
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
16247
    if (pool == NULL && (flag & VSH_BYNAME)) {
16248
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
16249 16250 16251 16252 16253
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
16254
        vshError(ctl, _("failed to get pool '%s'"), n);
16255 16256 16257 16258 16259

    return pool;
}

static virStorageVolPtr
16260
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
16261 16262
                   const char *optname,
                   const char *pooloptname,
16263
                   const char **name, int flag)
16264 16265 16266
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
16267
    const char *n = NULL, *p = NULL;
16268

16269
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16270 16271
        return NULL;

16272
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
16273
        vshError(ctl, "%s", _("missing option"));
16274
        return NULL;
16275
    }
16276 16277 16278 16279

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

16280
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
16281 16282 16283 16284 16285
             cmd->def->name, optname, n);

    if (name)
        *name = n;

16286
    /* try it by name */
16287
    if (pool && (flag & VSH_BYNAME)) {
16288
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
16289 16290 16291
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
16292
    /* try it by key */
16293
    if (vol == NULL && (flag & VSH_BYUUID)) {
16294
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
16295 16296 16297
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
16298
    /* try it by path */
16299
    if (vol == NULL && (flag & VSH_BYUUID)) {
16300
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
16301 16302 16303 16304
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

16305 16306 16307 16308
    if (!vol) {
        if (pool)
            vshError(ctl, _("failed to get vol '%s'"), n);
        else
16309 16310
            vshError(ctl, _("failed to get vol '%s', specifying --%s "
                            "might help"), n, pooloptname);
16311
    }
16312 16313 16314 16315 16316 16317 16318

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

16319
static virSecretPtr
16320
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
16321 16322
{
    virSecretPtr secret = NULL;
16323
    const char *n = NULL;
16324 16325 16326 16327 16328
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

16329
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16330 16331
        return NULL;

16332 16333
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
16334 16335 16336 16337 16338 16339 16340

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
16341
        vshError(ctl, _("failed to get secret '%s'"), n);
16342 16343 16344 16345

    return secret;
}

K
Karel Zak 已提交
16346 16347 16348
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
16349
static bool
16350
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
16351
{
E
Eric Blake 已提交
16352
    bool ret = true;
16353 16354

    while (cmd) {
K
Karel Zak 已提交
16355
        struct timeval before, after;
16356
        bool enable_timing = ctl->timing;
16357

16358 16359
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
16360 16361
            vshReconnect(ctl);

16362
        if (enable_timing)
K
Karel Zak 已提交
16363
            GETTIMEOFDAY(&before);
16364

K
Karel Zak 已提交
16365 16366
        ret = cmd->def->handler(ctl, cmd);

16367
        if (enable_timing)
K
Karel Zak 已提交
16368
            GETTIMEOFDAY(&after);
16369

16370
        if (!ret)
J
John Levon 已提交
16371 16372
            virshReportError(ctl);

16373
        /* try to automatically catch disconnections */
16374
        if (!ret &&
16375 16376 16377 16378 16379 16380 16381 16382 16383
            ((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);

16384
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
16385 16386
            return ret;

16387
        if (enable_timing)
16388
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
16389 16390
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
16391
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
16392 16393 16394 16395 16396 16397
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
16398
 * Command parsing
K
Karel Zak 已提交
16399 16400 16401
 * ---------------
 */

16402 16403 16404 16405 16406 16407 16408 16409 16410 16411
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 已提交
16412
    /* vshCommandStringGetArg() */
16413
    char *pos;
L
Lai Jiangshan 已提交
16414 16415 16416
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
16417 16418
} vshCommandParser;

E
Eric Blake 已提交
16419
static bool
16420
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
16421
{
K
Karel Zak 已提交
16422 16423 16424
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
16425

K
Karel Zak 已提交
16426 16427 16428 16429
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
16430

16431
    while (1) {
K
Karel Zak 已提交
16432
        vshCmdOpt *last = NULL;
16433
        const vshCmdDef *cmd = NULL;
16434
        vshCommandToken tk;
L
Lai Jiangshan 已提交
16435
        bool data_only = false;
16436 16437 16438
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
16439

K
Karel Zak 已提交
16440
        first = NULL;
16441

16442
        while (1) {
16443
            const vshCmdOptDef *opt = NULL;
16444

K
Karel Zak 已提交
16445
            tkdata = NULL;
16446
            tk = parser->getNextArg(ctl, parser, &tkdata);
16447 16448

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
16449
                goto syntaxError;
H
Hu Tao 已提交
16450 16451
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
16452
                break;
H
Hu Tao 已提交
16453
            }
16454 16455

            if (cmd == NULL) {
K
Karel Zak 已提交
16456 16457
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
16458
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
16459
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
16460
                }
16461 16462 16463 16464 16465 16466 16467
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
16468
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
16469 16470 16471 16472
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
16473
                char *optstr = strchr(tkdata + 2, '=');
16474 16475
                int opt_index;

16476 16477 16478 16479
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
16480
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
16481
                                               &opts_seen, &opt_index))) {
16482
                    VIR_FREE(optstr);
K
Karel Zak 已提交
16483 16484
                    goto syntaxError;
                }
16485
                VIR_FREE(tkdata);
K
Karel Zak 已提交
16486 16487 16488

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
16489 16490 16491
                    if (optstr)
                        tkdata = optstr;
                    else
16492
                        tk = parser->getNextArg(ctl, parser, &tkdata);
16493
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
16494
                        goto syntaxError;
16495
                    if (tk != VSH_TK_ARG) {
16496
                        vshError(ctl,
16497
                                 _("expected syntax: --%s <%s>"),
16498 16499
                                 opt->name,
                                 opt->type ==
16500
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
16501 16502
                        goto syntaxError;
                    }
16503 16504
                    if (opt->type != VSH_OT_ARGV)
                        opts_need_arg &= ~(1 << opt_index);
16505 16506 16507 16508 16509 16510 16511 16512
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
16513
                }
L
Lai Jiangshan 已提交
16514 16515 16516 16517
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
16518
            } else {
L
Lai Jiangshan 已提交
16519
get_data:
16520 16521
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
16522
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
16523 16524 16525 16526 16527
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
16528
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
16529

K
Karel Zak 已提交
16530 16531 16532 16533
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
16534

K
Karel Zak 已提交
16535 16536 16537 16538 16539
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
16540

16541
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
16542 16543
                         cmd->name,
                         opt->name,
16544 16545
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
16546 16547
            }
        }
16548

D
Daniel Veillard 已提交
16549
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
16550
        if (cmd) {
16551
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
16552

K
Karel Zak 已提交
16553 16554 16555 16556
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

16557
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
16558
                VIR_FREE(c);
16559
                goto syntaxError;
16560
            }
16561

K
Karel Zak 已提交
16562 16563 16564 16565 16566 16567
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
16568 16569 16570

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
16571
    }
16572

E
Eric Blake 已提交
16573
    return true;
K
Karel Zak 已提交
16574

16575
 syntaxError:
16576
    if (ctl->cmd) {
K
Karel Zak 已提交
16577
        vshCommandFree(ctl->cmd);
16578 16579
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
16580 16581
    if (first)
        vshCommandOptFree(first);
16582
    VIR_FREE(tkdata);
E
Eric Blake 已提交
16583
    return false;
K
Karel Zak 已提交
16584 16585
}

16586 16587 16588 16589 16590 16591 16592 16593 16594 16595 16596 16597 16598 16599 16600 16601 16602 16603
/* --------------------
 * 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 已提交
16604 16605
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
16606 16607 16608 16609
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
16610
        return false;
16611 16612 16613 16614 16615 16616 16617 16618 16619 16620 16621 16622 16623 16624 16625 16626 16627 16628 16629 16630 16631 16632 16633 16634 16635 16636 16637 16638 16639 16640 16641 16642 16643 16644 16645 16646 16647 16648 16649 16650 16651 16652 16653 16654 16655 16656 16657 16658 16659 16660 16661 16662 16663 16664 16665 16666 16667 16668 16669 16670 16671 16672 16673 16674 16675 16676 16677 16678 16679 16680 16681 16682

    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 已提交
16683 16684
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
16685 16686 16687 16688
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
16689
        return false;
16690 16691 16692 16693 16694 16695

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
16696
/* ---------------
16697
 * Misc utils
K
Karel Zak 已提交
16698 16699
 * ---------------
 */
16700 16701 16702 16703 16704 16705 16706 16707 16708 16709 16710 16711 16712 16713 16714 16715 16716 16717 16718 16719 16720 16721 16722 16723 16724 16725 16726 16727
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 已提交
16728
static const char *
16729 16730
vshDomainStateToString(int state)
{
16731 16732
    /* Can't use virDomainStateTypeToString, because we want to mark
     * strings for translation.  */
16733
    switch ((virDomainState) state) {
16734
    case VIR_DOMAIN_RUNNING:
16735
        return N_("running");
16736
    case VIR_DOMAIN_BLOCKED:
16737
        return N_("idle");
16738
    case VIR_DOMAIN_PAUSED:
16739
        return N_("paused");
16740
    case VIR_DOMAIN_SHUTDOWN:
16741
        return N_("in shutdown");
16742
    case VIR_DOMAIN_SHUTOFF:
16743
        return N_("shut off");
16744
    case VIR_DOMAIN_CRASHED:
16745
        return N_("crashed");
16746
    case VIR_DOMAIN_NOSTATE:
16747
    default:
16748
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
16749
    }
16750
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
16751 16752
}

16753 16754 16755 16756 16757 16758 16759 16760 16761 16762 16763 16764 16765 16766 16767 16768 16769 16770 16771 16772 16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 16787 16788 16789 16790 16791 16792 16793 16794 16795 16796 16797 16798 16799 16800 16801 16802 16803 16804 16805 16806 16807
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");
16808 16809
        case VIR_DOMAIN_PAUSED_SHUTTING_DOWN:
            return N_("shutting down");
16810 16811 16812 16813 16814 16815 16816 16817 16818 16819 16820 16821 16822 16823 16824 16825 16826 16827 16828 16829 16830 16831 16832 16833 16834 16835 16836 16837 16838 16839 16840 16841 16842 16843 16844 16845 16846 16847 16848 16849 16850
        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;
16851 16852 16853

    default:
        ;
16854 16855 16856 16857 16858
    }

    return N_("unknown");
}

16859 16860 16861 16862 16863 16864 16865 16866 16867 16868 16869 16870 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
static char *
vshGetTypedParamValue(vshControl *ctl, virTypedParameterPtr item)
{
    int ret = 0;
    char *str = NULL;

    if (!ctl || !item)
        return 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;

    default:
        vshError(ctl, _("unimplemented block statistics parameter type"));
    }

    if (ret < 0)
        vshError(ctl, "%s", _("Out of memory"));
    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;
}

16922 16923 16924 16925 16926 16927 16928 16929 16930 16931 16932 16933 16934 16935 16936 16937 16938
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");
}

16939 16940 16941 16942
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
16943
    case VIR_VCPU_OFFLINE:
16944
        return N_("offline");
16945
    case VIR_VCPU_BLOCKED:
16946
        return N_("idle");
16947
    case VIR_VCPU_RUNNING:
16948
        return N_("running");
16949
    default:
16950
        ;/*FALLTHROUGH*/
16951
    }
16952
    return N_("no state");
16953 16954
}

E
Eric Blake 已提交
16955
static bool
16956
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
16957
{
16958 16959
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
16960 16961
     */
    if (!conn) {
16962
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
16963
        return false;
K
Karel Zak 已提交
16964
    }
E
Eric Blake 已提交
16965
    return true;
K
Karel Zak 已提交
16966 16967
}

K
Karel Zak 已提交
16968
static void
16969
vshDebug(vshControl *ctl, int level, const char *format, ...)
16970
{
K
Karel Zak 已提交
16971
    va_list ap;
16972
    char *str;
K
Karel Zak 已提交
16973

16974 16975 16976 16977 16978 16979 16980
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

16981
    va_start(ap, format);
16982
    vshOutputLogFile(ctl, level, format, ap);
16983 16984
    va_end(ap);

K
Karel Zak 已提交
16985
    va_start(ap, format);
16986 16987 16988 16989 16990
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
16991
    va_end(ap);
16992 16993
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
16994 16995 16996
}

static void
16997
vshPrintExtra(vshControl *ctl, const char *format, ...)
16998
{
K
Karel Zak 已提交
16999
    va_list ap;
17000
    char *str;
17001

17002
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
17003
        return;
17004

K
Karel Zak 已提交
17005
    va_start(ap, format);
17006 17007 17008 17009 17010
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
17011
    va_end(ap);
17012
    fputs(str, stdout);
17013
    VIR_FREE(str);
K
Karel Zak 已提交
17014 17015
}

K
Karel Zak 已提交
17016

K
Karel Zak 已提交
17017
static void
17018
vshError(vshControl *ctl, const char *format, ...)
17019
{
K
Karel Zak 已提交
17020
    va_list ap;
17021
    char *str;
17022

17023 17024 17025 17026 17027
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
17028

17029 17030 17031 17032
    /* 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);
17033
    fputs(_("error: "), stderr);
17034

K
Karel Zak 已提交
17035
    va_start(ap, format);
17036 17037 17038
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
17039 17040
    va_end(ap);

17041
    fprintf(stderr, "%s\n", NULLSTR(str));
17042
    fflush(stderr);
17043
    VIR_FREE(str);
K
Karel Zak 已提交
17044 17045
}

17046

J
Jiri Denemark 已提交
17047 17048 17049 17050 17051
static void
vshEventLoop(void *opaque)
{
    vshControl *ctl = opaque;

17052 17053 17054 17055 17056 17057 17058 17059 17060 17061
    while (1) {
        bool quit;
        virMutexLock(&ctl->lock);
        quit = ctl->quit;
        virMutexUnlock(&ctl->lock);

        if (quit)
            break;

        if (virEventRunDefaultImpl() < 0)
J
Jiri Denemark 已提交
17062 17063 17064 17065 17066
            virshReportError(ctl);
    }
}


K
Karel Zak 已提交
17067
/*
17068
 * Initialize connection.
K
Karel Zak 已提交
17069
 */
E
Eric Blake 已提交
17070
static bool
17071
vshInit(vshControl *ctl)
17072
{
17073 17074
    char *debugEnv;

K
Karel Zak 已提交
17075
    if (ctl->conn)
E
Eric Blake 已提交
17076
        return false;
K
Karel Zak 已提交
17077

J
Jiri Denemark 已提交
17078
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
17079 17080 17081
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
17082 17083 17084
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
17085 17086
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
17087 17088
            } else {
                ctl->debug = debug;
17089 17090 17091 17092 17093 17094 17095 17096 17097 17098 17099 17100
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

17101 17102
    vshOpenLogFile(ctl);

17103 17104
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
17105

17106 17107 17108
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

17109
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
17110
        return false;
17111

J
Jiri Denemark 已提交
17112 17113 17114 17115
    if (virThreadCreate(&ctl->eventLoop, true, vshEventLoop, ctl) < 0)
        return false;
    ctl->eventLoopStarted = true;

17116 17117 17118 17119
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
17120

17121 17122 17123 17124 17125 17126 17127 17128 17129 17130 17131
        /* 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;
        }
17132
    }
K
Karel Zak 已提交
17133

E
Eric Blake 已提交
17134
    return true;
K
Karel Zak 已提交
17135 17136
}

17137 17138
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

17139 17140 17141 17142 17143 17144 17145 17146 17147 17148 17149 17150 17151 17152 17153 17154 17155 17156 17157
/**
 * 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:
17158
                vshError(ctl, "%s",
J
Jim Meyering 已提交
17159
                         _("failed to get the log file information"));
17160
                exit(EXIT_FAILURE);
17161 17162 17163
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
17164 17165
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
17166 17167 17168 17169
        }
    }

    /* log file open */
17170
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
17171
        vshError(ctl, "%s",
J
Jim Meyering 已提交
17172
                 _("failed to open the log file. check the log file path"));
17173
        exit(EXIT_FAILURE);
17174 17175 17176 17177 17178 17179 17180 17181 17182
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
17183 17184
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
17185
{
17186 17187 17188
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
17189 17190 17191 17192 17193 17194 17195 17196 17197 17198 17199 17200 17201 17202
    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);
17203
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
17204 17205 17206 17207 17208 17209
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
17210 17211
                      SIGN_NAME,
                      (int) getpid());
17212 17213 17214 17215 17216 17217 17218 17219 17220 17221 17222 17223 17224 17225 17226 17227 17228 17229 17230 17231
    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;
    }
17232 17233 17234
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
17235

17236 17237
    if (virBufferError(&buf))
        goto error;
17238

17239 17240 17241 17242 17243
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
17244
    }
17245

17246 17247 17248 17249 17250 17251 17252 17253 17254 17255 17256
    /* 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);
17257 17258 17259 17260 17261 17262 17263 17264 17265 17266 17267
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
17268 17269 17270
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
17271 17272 17273
    }

    if (ctl->logfile) {
17274
        VIR_FREE(ctl->logfile);
17275 17276 17277 17278
        ctl->logfile = NULL;
    }
}

17279
#ifdef USE_READLINE
17280

K
Karel Zak 已提交
17281 17282 17283 17284 17285
/* -----------------
 * Readline stuff
 * -----------------
 */

17286
/*
K
Karel Zak 已提交
17287 17288
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
17289
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
17290 17291
 */
static char *
17292 17293
vshReadlineCommandGenerator(const char *text, int state)
{
17294
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
17295
    const char *name;
17296 17297
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
17298 17299

    if (!state) {
17300 17301
        grp_list_index = 0;
        cmd_list_index = 0;
17302
        len = strlen(text);
K
Karel Zak 已提交
17303 17304
    }

17305 17306
    grp = cmdGroups;

K
Karel Zak 已提交
17307
    /* Return the next name which partially matches from the
17308
     * command list.
K
Karel Zak 已提交
17309
     */
17310 17311 17312 17313 17314 17315 17316 17317 17318 17319 17320 17321 17322 17323
    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 已提交
17324 17325 17326 17327 17328 17329 17330
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
17331 17332
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
17333
    static int list_index, len;
17334
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
17335
    const char *name;
K
Karel Zak 已提交
17336 17337 17338 17339 17340 17341 17342 17343 17344

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

17345
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
17346
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
17347 17348 17349

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
17350
        len = strlen(text);
17351
        VIR_FREE(cmdname);
K
Karel Zak 已提交
17352 17353 17354 17355
    }

    if (!cmd)
        return NULL;
17356

17357 17358 17359
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
17360
    while ((name = cmd->opts[list_index].name)) {
17361
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
17362
        char *res;
17363

K
Karel Zak 已提交
17364
        list_index++;
17365

17366
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
17367 17368
            /* ignore non --option */
            continue;
17369

K
Karel Zak 已提交
17370
        if (len > 2) {
17371
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
17372 17373
                continue;
        }
17374
        res = vshMalloc(NULL, strlen(name) + 3);
17375
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
17376 17377 17378 17379 17380 17381 17382 17383
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
17384 17385 17386
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
17387 17388
    char **matches = (char **) NULL;

17389
    if (start == 0)
K
Karel Zak 已提交
17390
        /* command name generator */
17391
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
17392 17393
    else
        /* commands options */
17394
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
17395 17396 17397 17398
    return matches;
}


17399 17400
static int
vshReadlineInit(vshControl *ctl)
17401
{
17402 17403
    char *userdir = NULL;

K
Karel Zak 已提交
17404 17405 17406 17407 17408
    /* 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;
17409 17410 17411

    /* Limit the total size of the history buffer */
    stifle_history(500);
17412 17413

    /* Prepare to read/write history from/to the ~/.virsh/history file */
17414
    userdir = virGetUserDirectory(getuid());
17415

17416 17417
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
17418
        return -1;
17419
    }
17420 17421 17422

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
17423
        VIR_FREE(userdir);
17424 17425 17426 17427 17428
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
17429
        VIR_FREE(userdir);
17430 17431 17432
        return -1;
    }

17433
    VIR_FREE(userdir);
17434 17435 17436 17437 17438 17439 17440 17441 17442 17443 17444 17445 17446 17447 17448 17449 17450 17451

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

17452 17453
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
17454 17455
}

17456 17457 17458 17459 17460 17461
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

17462
#else /* !USE_READLINE */
17463

17464 17465 17466 17467 17468 17469 17470
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

17471
static void
17472
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
17473 17474 17475 17476 17477 17478 17479 17480 17481 17482 17483 17484 17485 17486 17487 17488 17489 17490 17491 17492 17493 17494 17495
{
    /* 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);
}

17496
#endif /* !USE_READLINE */
17497

17498 17499 17500 17501 17502 17503
static void
vshDeinitTimer(int timer ATTRIBUTE_UNUSED, void *opaque ATTRIBUTE_UNUSED)
{
    /* nothing to be done here */
}

K
Karel Zak 已提交
17504
/*
J
Jim Meyering 已提交
17505
 * Deinitialize virsh
K
Karel Zak 已提交
17506
 */
E
Eric Blake 已提交
17507
static bool
17508
vshDeinit(vshControl *ctl)
17509
{
17510
    vshReadlineDeinit(ctl);
17511
    vshCloseLogFile(ctl);
17512
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
17513
    if (ctl->conn) {
17514 17515 17516
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
17517 17518
        }
    }
D
Daniel P. Berrange 已提交
17519 17520
    virResetLastError();

J
Jiri Denemark 已提交
17521
    if (ctl->eventLoopStarted) {
17522 17523 17524 17525
        int timer;

        virMutexLock(&ctl->lock);
        ctl->quit = true;
J
Jiri Denemark 已提交
17526
        /* HACK: Add a dummy timeout to break event loop */
17527 17528 17529 17530 17531
        timer = virEventAddTimeout(0, vshDeinitTimer, NULL, NULL);
        virMutexUnlock(&ctl->lock);

        virThreadJoin(&ctl->eventLoop);

J
Jiri Denemark 已提交
17532 17533 17534 17535 17536 17537
        if (timer != -1)
            virEventRemoveTimeout(timer);

        ctl->eventLoopStarted = false;
    }

17538 17539
    virMutexDestroy(&ctl->lock);

E
Eric Blake 已提交
17540
    return true;
K
Karel Zak 已提交
17541
}
17542

K
Karel Zak 已提交
17543 17544 17545 17546
/*
 * Print usage
 */
static void
17547
vshUsage(void)
17548
{
17549
    const vshCmdGrp *grp;
17550
    const vshCmdDef *cmd;
17551

L
Lai Jiangshan 已提交
17552 17553
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
17554
                      "  options:\n"
17555
                      "    -c | --connect=URI      hypervisor connection URI\n"
17556
                      "    -r | --readonly         connect readonly\n"
17557
                      "    -d | --debug=NUM        debug level [0-4]\n"
17558 17559 17560
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
17561 17562 17563 17564 17565
                      "    -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"
17566
                      "  commands (non interactive mode):\n\n"), progname, progname);
17567

17568 17569
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
17570

17571 17572 17573 17574 17575 17576 17577 17578 17579
        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"));
17580 17581 17582
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
17583 17584
}

17585 17586 17587 17588 17589 17590 17591 17592 17593 17594
/*
 * 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 已提交
17595 17596
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
17597 17598 17599 17600 17601 17602 17603 17604 17605 17606 17607 17608 17609 17610 17611 17612 17613 17614 17615 17616 17617 17618 17619 17620 17621 17622 17623 17624 17625 17626 17627 17628 17629 17630 17631
#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 已提交
17632
    vshPrint(ctl, "%s", _(" Networking:"));
17633 17634 17635 17636 17637 17638 17639 17640 17641 17642 17643 17644 17645 17646 17647 17648 17649 17650 17651 17652 17653 17654 17655 17656 17657 17658
#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 已提交
17659
    vshPrint(ctl, "%s", _(" Storage:"));
17660 17661 17662 17663 17664 17665 17666 17667 17668 17669 17670 17671 17672 17673 17674 17675 17676 17677 17678 17679 17680 17681 17682
#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 已提交
17683
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
17684
#ifdef WITH_SECDRIVER_APPARMOR
17685 17686 17687 17688 17689 17690 17691 17692 17693 17694 17695 17696 17697 17698 17699 17700 17701 17702 17703 17704 17705 17706 17707
    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 已提交
17708 17709 17710 17711
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
17712
static bool
17713
vshParseArgv(vshControl *ctl, int argc, char **argv)
17714
{
17715
    bool help = false;
17716
    int arg, len;
K
Karel Zak 已提交
17717
    struct option opt[] = {
E
Eric Blake 已提交
17718 17719 17720 17721 17722 17723 17724 17725
        {"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'},
17726
        {"escape", required_argument, NULL, 'e'},
E
Eric Blake 已提交
17727
        {NULL, 0, NULL, 0}
17728 17729
    };

17730 17731 17732
    /* 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. */
17733
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:e:", opt, NULL)) != -1) {
17734
        switch (arg) {
17735
        case 'd':
D
Daniel Veillard 已提交
17736
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
17737
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
17738 17739
                exit(EXIT_FAILURE);
            }
17740 17741
            break;
        case 'h':
17742
            help = true;
17743 17744
            break;
        case 'q':
E
Eric Blake 已提交
17745
            ctl->quiet = true;
17746 17747
            break;
        case 't':
E
Eric Blake 已提交
17748
            ctl->timing = true;
17749 17750 17751 17752
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
17753 17754 17755 17756 17757 17758
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
17759 17760 17761
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
17762
        case 'r':
E
Eric Blake 已提交
17763
            ctl->readonly = true;
17764
            break;
17765 17766 17767
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
17768 17769 17770 17771 17772 17773 17774 17775 17776 17777 17778 17779
        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;
17780
        default:
17781 17782
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
17783 17784 17785 17786
        }
    }

    if (help) {
17787 17788
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
17789 17790
            exit(EXIT_FAILURE);
        }
17791 17792 17793

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
17794
        exit(EXIT_SUCCESS);
17795 17796
    }

17797
    if (argc > optind) {
K
Karel Zak 已提交
17798
        /* parse command */
E
Eric Blake 已提交
17799
        ctl->imode = false;
17800
        if (argc - optind == 1) {
17801
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
17802
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
17803
        } else {
17804
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
17805 17806
        }
    }
E
Eric Blake 已提交
17807
    return true;
K
Karel Zak 已提交
17808 17809
}

17810 17811 17812 17813
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
17814
    char *defaultConn;
E
Eric Blake 已提交
17815
    bool ret = true;
K
Karel Zak 已提交
17816

17817 17818 17819
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
17820
    ctl->debug = VSH_DEBUG_DEFAULT;
17821 17822
    ctl->escapeChar = CTRL_CLOSE_BRACKET;

17823

17824 17825
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
17826
        /* failure to setup locale is not fatal */
17827
    }
17828
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
17829
        perror("bindtextdomain");
E
Eric Blake 已提交
17830
        return EXIT_FAILURE;
17831
    }
17832
    if (!textdomain(PACKAGE)) {
17833
        perror("textdomain");
E
Eric Blake 已提交
17834
        return EXIT_FAILURE;
17835 17836
    }

17837 17838 17839 17840 17841
    if (virMutexInit(&ctl->lock) < 0) {
        vshError(ctl, "%s", _("Failed to initialize mutex"));
        return EXIT_FAILURE;
    }

17842 17843 17844 17845 17846
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

17847
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
17848 17849 17850
        progname = argv[0];
    else
        progname++;
17851

17852
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
17853
        ctl->name = vshStrdup(ctl, defaultConn);
17854 17855
    }

D
Daniel P. Berrange 已提交
17856 17857
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
17858
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
17859
    }
17860

D
Daniel P. Berrange 已提交
17861 17862
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
17863
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
17864
    }
17865

K
Karel Zak 已提交
17866
    if (!ctl->imode) {
17867
        ret = vshCommandRun(ctl, ctl->cmd);
17868
    } else {
K
Karel Zak 已提交
17869 17870
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
17871
            vshPrint(ctl,
17872
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
17873
                     progname);
J
Jim Meyering 已提交
17874
            vshPrint(ctl, "%s",
17875
                     _("Type:  'help' for help with commands\n"
17876
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
17877
        }
17878 17879 17880 17881 17882 17883

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
17884
        do {
17885
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
17886
            ctl->cmdstr =
17887
                vshReadline(ctl, prompt);
17888 17889
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
17890
            if (*ctl->cmdstr) {
17891
#if USE_READLINE
K
Karel Zak 已提交
17892
                add_history(ctl->cmdstr);
17893
#endif
17894
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
17895 17896
                    vshCommandRun(ctl, ctl->cmd);
            }
17897
            VIR_FREE(ctl->cmdstr);
17898
        } while (ctl->imode);
K
Karel Zak 已提交
17899

17900 17901
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
17902
    }
17903

K
Karel Zak 已提交
17904 17905
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
17906
}