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

13
#include <config.h>
14

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

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

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

47
#include "internal.h"
48
#include "virterror_internal.h"
49
#include "base64.h"
50
#include "buf.h"
51
#include "console.h"
52
#include "util.h"
53
#include "memory.h"
54
#include "xml.h"
55
#include "libvirt/libvirt-qemu.h"
E
Eric Blake 已提交
56
#include "virfile.h"
57
#include "event_poll.h"
58
#include "configmake.h"
59
#include "threads.h"
E
Eric Blake 已提交
60
#include "command.h"
61
#include "virkeycode.h"
62
#include "virnetdevbandwidth.h"
63
#include "util/bitmap.h"
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
    ret = true;
1572 1573 1574 1575 1576 1577 1578 1579 1580 1581
cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    if (dom)
        virDomainFree(dom);

    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1727
    xmldoc = virXMLParseStringCtxt(xml, _("(domain_definition)"), &ctxt);
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756
    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 已提交
1757
    ret = true;
1758 1759 1760 1761

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

1953
    if (managed_save) {
1954
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
1955 1956 1957 1958 1959 1960
        managed_save_safe = true;
    }
    if (snapshots_metadata) {
        flags |= VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
1961

1962
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1963
        return false;
1964

1965
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1966
        return false;
1967

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

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

2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043
    /* 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;
    }
2044

2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056
    /* 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;
2057 2058 2059
        }
    }

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

2081
cleanup:
2082
    virDomainFree(dom);
2083 2084 2085 2086 2087 2088 2089
    return ret;
}


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

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

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

2124
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2125
        return false;
2126

2127 2128
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
2129
        return false;
2130 2131

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

E
Eric Blake 已提交
2137 2138
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
2139 2140
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
2141 2142
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_START_BYPASS_CACHE;
2143 2144
    if (vshCommandOptBool(cmd, "force-boot"))
        flags |= VIR_DOMAIN_START_FORCE_BOOT;
E
Eric Blake 已提交
2145

2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170
    /* 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 已提交
2171 2172
    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
2173
         : virDomainCreate(dom)) < 0) {
2174
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
2175
        goto cleanup;
2176
    }
2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188

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

    ret = true;

cleanup:
2189
    virDomainFree(dom);
2190 2191 2192
    return ret;
}

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

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

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

2224
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2225
        return false;
2226

2227
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
2228
        return false;
2229

2230 2231
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2232 2233 2234 2235
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2236

2237 2238 2239 2240 2241
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        return false;
    }

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

2245 2246 2247 2248 2249 2250
    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
        goto cleanup;

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
2251
         : virDomainSave(dom, to)) < 0) {
2252
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
2253
        goto cleanup;
2254
    }
2255

2256 2257 2258 2259
    vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
    ret = true;

cleanup:
2260
    VIR_FREE(xml);
2261 2262 2263 2264
    virDomainFree(dom);
    return ret;
}

2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285
/*
 * "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 已提交
2286
    unsigned int flags = 0;
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 2319 2320 2321 2322
    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")},
2323 2324
    {"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")},
2325 2326 2327 2328 2329 2330 2331 2332 2333 2334
    {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;
2335 2336 2337 2338 2339 2340
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355

    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;

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

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

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

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

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

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

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

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

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

2492
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2493
        return false;
2494

2495 2496
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2497 2498 2499 2500
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2501

2502
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2503
        return false;
2504

2505
    if (virDomainManagedSave(dom, flags) < 0) {
2506
        vshError(ctl, _("Failed to save domain %s state"), name);
2507
        goto cleanup;
2508 2509
    }

2510 2511 2512 2513
    vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    ret = true;

cleanup:
2514 2515 2516 2517
    virDomainFree(dom);
    return ret;
}

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

2540
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2541
        return false;
2542 2543

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2544
        return false;
2545 2546 2547

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

cleanup:
    virDomainFree(dom);
    return ret;
}

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

2581
static const vshCmdOptDef opts_schedinfo[] = {
2582 2583 2584 2585
    {"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")},
2586 2587 2588
    {"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")},
2589 2590 2591
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
2592
static int
2593
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
2594
                   virTypedParameterPtr param)
2595
{
2596
    const char *data = NULL;
2597 2598 2599

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

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

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

        if (!match)
            return 0;

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

2682 2683
    return 0;
}
2684

2685

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

2714
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2715
        return false;
2716

2717
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2718
        return false;
2719 2720 2721

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

2731
    if (nparams) {
2732
        params = vshMalloc(ctl, sizeof(*params) * nparams);
2733

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

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

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

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

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

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

2823
 cleanup:
2824
    VIR_FREE(params);
2825
    virDomainFree(dom);
2826
    return ret_val;
2827 2828
}

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

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

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

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

2861
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2862
        return false;
2863

2864 2865
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
2866 2867 2868 2869
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
2870

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

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

cleanup:
2891
    VIR_FREE(xml);
2892 2893 2894
    return ret;
}

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

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

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

2924
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2925
        return false;
D
Daniel Veillard 已提交
2926

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

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

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

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

2947 2948 2949 2950
    vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
    ret = true;

cleanup:
D
Daniel Veillard 已提交
2951 2952 2953 2954
    virDomainFree(dom);
    return ret;
}

2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028
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;
3029
    bool created = false;
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 3065 3066 3067 3068
    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;
        }
3069 3070
    } else {
        created = true;
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 3099 3100 3101 3102
    }

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

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

3112
static const vshCmdOptDef opts_resume[] = {
3113
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3114
    {NULL, 0, 0, NULL}
3115 3116
};

E
Eric Blake 已提交
3117
static bool
3118
cmdResume(vshControl *ctl, const vshCmd *cmd)
3119
{
3120
    virDomainPtr dom;
E
Eric Blake 已提交
3121
    bool ret = true;
3122
    const char *name;
3123

3124
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3125
        return false;
3126

J
Jim Meyering 已提交
3127
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3128
        return false;
3129 3130

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

3137 3138 3139 3140
    virDomainFree(dom);
    return ret;
}

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

3150
static const vshCmdOptDef opts_shutdown[] = {
3151
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3152
    {NULL, 0, 0, NULL}
3153 3154
};

E
Eric Blake 已提交
3155
static bool
3156
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
3157
{
3158
    virDomainPtr dom;
E
Eric Blake 已提交
3159
    bool ret = true;
3160
    const char *name;
3161

3162
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3163
        return false;
3164

J
Jim Meyering 已提交
3165
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3166
        return false;
3167 3168

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

3175 3176 3177 3178
    virDomainFree(dom);
    return ret;
}

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

3188
static const vshCmdOptDef opts_reboot[] = {
3189
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3190 3191 3192
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3193
static bool
3194
cmdReboot(vshControl *ctl, const vshCmd *cmd)
3195 3196
{
    virDomainPtr dom;
E
Eric Blake 已提交
3197
    bool ret = true;
3198
    const char *name;
3199

3200
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3201
        return false;
3202

J
Jim Meyering 已提交
3203
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3204
        return false;
3205 3206

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

    virDomainFree(dom);
    return ret;
}

X
Xu He Jie 已提交
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 3251 3252 3253 3254
/*
 * "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;
}

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

3265
static const vshCmdOptDef opts_destroy[] = {
3266
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3267
    {NULL, 0, 0, NULL}
3268 3269
};

E
Eric Blake 已提交
3270
static bool
3271
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
3272
{
3273
    virDomainPtr dom;
E
Eric Blake 已提交
3274
    bool ret = true;
3275
    const char *name;
3276

3277
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3278
        return false;
3279

J
Jim Meyering 已提交
3280
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3281
        return false;
3282 3283

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

3290
    virDomainFree(dom);
K
Karel Zak 已提交
3291 3292 3293 3294
    return ret;
}

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

3303
static const vshCmdOptDef opts_dominfo[] = {
3304
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3305
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
3306 3307
};

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

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

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

3328 3329
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
3330
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
3331
    else
3332
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
3333 3334
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
3335
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
3336
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
3337 3338

    if ((str = virDomainGetOSType(dom))) {
3339
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
3340
        VIR_FREE(str);
3341 3342 3343
    }

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

3347
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
3348 3349

        if (info.cpuTime != 0) {
3350
            double cpuUsed = info.cpuTime;
3351

3352
            cpuUsed /= 1000000000.0;
3353

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

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

3364
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
3365 3366
                 info.memory);

K
Karel Zak 已提交
3367
    } else {
E
Eric Blake 已提交
3368
        ret = false;
K
Karel Zak 已提交
3369
    }
3370

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

3386 3387 3388 3389 3390 3391 3392
    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"));

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

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

            VIR_FREE(seclabel);
3426 3427
        }
    }
3428
    virDomainFree(dom);
K
Karel Zak 已提交
3429 3430 3431
    return ret;
}

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

static const vshCmdOptDef opts_domjobinfo[] = {
3442
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3443 3444 3445 3446
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
3447
static bool
3448 3449 3450 3451
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
3452
    bool ret = true;
3453

3454
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3455
        return false;
3456 3457

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

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

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

static const vshCmdOptDef opts_domjobabort[] = {
3525
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3526 3527 3528
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3529
static bool
3530 3531 3532
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
3533
    bool ret = true;
3534

3535
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3536
        return false;
3537 3538

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
3542
        ret = false;
3543 3544 3545 3546 3547

    virDomainFree(dom);
    return ret;
}

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

3557
static const vshCmdOptDef opts_freecell[] = {
3558
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
3559
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
3560 3561 3562
    {NULL, 0, 0, NULL}
};

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

3580

3581
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3582
        return false;
3583

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

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

        if (nodes_cnt == -1) {
3612
            vshError(ctl, "%s", _("could not get information about "
3613
                                  "NUMA topology"));
3614 3615 3616
            goto cleanup;
        }

3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637
        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;
            }
        }

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

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

E
Eric Blake 已提交
3664
    func_ret = true;
3665

3666
cleanup:
3667
    xmlXPathFreeContext(ctxt);
3668
    xmlFreeDoc(xml);
3669
    VIR_FREE(nodes);
3670 3671 3672
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
3673
    return func_ret;
3674 3675
}

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

3696 3697
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
3698
        return false;
3699
    }
E
Eric Blake 已提交
3700 3701

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3702
        return false;
E
Eric Blake 已提交
3703 3704 3705

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

E
Eric Blake 已提交
3709
    return true;
E
Eric Blake 已提交
3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723
}

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

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

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

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

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3786
        return false;
E
Eric Blake 已提交
3787 3788

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

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

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

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

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

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

3929
static const vshCmdOptDef opts_vcpuinfo[] = {
3930
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3931 3932 3933
    {NULL, 0, 0, NULL}
};

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

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

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

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3955
        return false;
3956 3957 3958 3959
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3960
        return false;
3961 3962
    }

3963
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
3964 3965 3966
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
3967

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

E
Eric Blake 已提交
3998
            /* fallback plan to use virDomainGetVcpuPinInfo */
3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016

            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;
4017
        }
4018 4019
    }

4020
    VIR_FREE(cpumaps);
4021
    VIR_FREE(cpuinfo);
4022 4023 4024 4025 4026 4027 4028
    virDomainFree(dom);
    return ret;
}

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

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

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

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

4084
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4085
        return false;
4086

J
Jim Meyering 已提交
4087
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4088
        return false;
4089

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

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

4105 4106
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
4107
        return false;
4108 4109 4110
    }

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

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

4122 4123
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
4124

4125 4126 4127 4128 4129 4130 4131 4132
    /* 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 已提交
4133
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
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 4175 4176 4177 4178
                                             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);
4179 4180
    /* Parse cpulist */
    cur = cpulist;
4181
    if (*cur == 0) {
4182
        goto parse_error;
4183 4184 4185
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
4186
        cur = "";
4187
    }
4188 4189 4190 4191 4192 4193 4194

    while (*cur != 0) {

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

4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208
        /* 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);
4209

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

4238 4239 4240 4241 4242 4243
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
4244
        } else {
4245
            goto parse_error;
4246
        }
4247
    }
4248

4249 4250 4251 4252 4253 4254 4255 4256
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
4257 4258
    }

4259
cleanup:
4260
    VIR_FREE(cpumap);
4261 4262
    virDomainFree(dom);
    return ret;
4263 4264 4265 4266 4267

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

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

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

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

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

4317
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4318
        return false;
4319

J
Jim Meyering 已提交
4320
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4321
        return false;
4322

4323 4324 4325 4326
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
4327

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

4338 4339
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

4340 4341 4342 4343 4344 4345 4346 4347
            /* 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 已提交
4348
                ret = false;
4349 4350 4351 4352 4353
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
4354
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
4355
            ret = false;
E
Eric Blake 已提交
4356
        }
4357 4358
    }

4359
  cleanup:
4360 4361 4362 4363
    virDomainFree(dom);
    return ret;
}

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 4394 4395 4396 4397
/*
 * "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;
}

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

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4409 4410
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT,
     N_("the codeset of keycodes, default:linux")},
4411
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
A
Alex Jia 已提交
4412
     N_("the time (in milliseconds) how long the keys will be held")},
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 4481 4482 4483 4484
    {"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;
}

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

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

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

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

4531
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4532
        return false;
4533

J
Jim Meyering 已提交
4534
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4535
        return false;
4536

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

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

4619
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4620
        return false;
4621

J
Jim Meyering 已提交
4622
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4623
        return false;
4624

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

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

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

4648 4649 4650 4651
    virDomainFree(dom);
    return ret;
}

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

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

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4706
        return false;
4707 4708

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

4711
    if ((rv = vshCommandOptInt(cmd, "weight", &weight)) < 0) {
4712 4713 4714 4715 4716
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

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

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

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

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4745
            ret = true;
4746 4747 4748 4749 4750
            goto cleanup;
        }

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

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4758
                case VIR_TYPED_PARAM_INT:
4759 4760 4761
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4762
                case VIR_TYPED_PARAM_UINT:
4763 4764 4765
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4766
                case VIR_TYPED_PARAM_LLONG:
4767 4768 4769
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4770
                case VIR_TYPED_PARAM_ULLONG:
4771 4772 4773
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
4774
                case VIR_TYPED_PARAM_DOUBLE:
4775 4776 4777
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4778
                case VIR_TYPED_PARAM_BOOLEAN:
4779 4780 4781
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
4782 4783 4784 4785
                case VIR_TYPED_PARAM_STRING:
                    vshPrint(ctl, "%-15s: %s\n", params[i].field,
                             params[i].value.s);
                    break;
4786 4787 4788 4789 4790 4791 4792 4793 4794 4795
                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];
4796
            temp->type = VIR_TYPED_PARAM_UINT;
4797 4798 4799

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

        if (virDomainSetBlkioParameters(dom, params, nparams, flags) < 0) {
4815
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
4816 4817
            goto cleanup;
        }
4818 4819
    }

4820 4821
    ret = true;

4822
  cleanup:
4823
    virTypedParameterArrayClear(params, nparams);
4824 4825 4826 4827 4828
    VIR_FREE(params);
    virDomainFree(dom);
    return ret;
}

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

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

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4886
        return false;
4887 4888

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

4891 4892 4893 4894 4895 4896 4897 4898 4899
    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;
    }

4900 4901 4902 4903 4904 4905 4906 4907 4908
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

4909 4910 4911
    if (min_guarantee)
        nparams++;

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

4920 4921
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
4922
            ret = true;
4923 4924 4925
            goto cleanup;
        }

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

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
4935
                case VIR_TYPED_PARAM_INT:
4936 4937 4938
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
4939
                case VIR_TYPED_PARAM_UINT:
4940 4941 4942
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
4943
                case VIR_TYPED_PARAM_LLONG:
4944 4945 4946
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
4947
                case VIR_TYPED_PARAM_ULLONG:
4948 4949 4950 4951 4952
                    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);
4953
                    break;
4954
                case VIR_TYPED_PARAM_DOUBLE:
4955 4956 4957
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
4958
                case VIR_TYPED_PARAM_BOOLEAN:
4959 4960 4961 4962
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
4963
                    vshPrint(ctl, "unimplemented memory parameter type\n");
4964 4965 4966
            }
        }

E
Eric Blake 已提交
4967
        ret = true;
4968 4969
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
4970
        params = vshCalloc(ctl, nparams, sizeof(*params));
4971 4972 4973

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

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

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

  cleanup:
E
Eric Blake 已提交
5015
    VIR_FREE(params);
5016 5017 5018 5019
    virDomainFree(dom);
    return ret;
}

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

E
Eric Blake 已提交
5029
static bool
5030
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5031 5032
{
    virNodeInfo info;
5033

5034
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5035
        return false;
5036 5037

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

5053 5054 5055 5056 5057
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
5058
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
5059 5060 5061 5062 5063 5064 5065 5066 5067 5068
    {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
5069
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
5070 5071 5072 5073
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
5074 5075
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
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 5115 5116 5117 5118
    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;

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

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200
/*
 * "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;
5201 5202
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242
    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;
}

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


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

E
Eric Blake 已提交
5315
static bool
5316
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5317 5318 5319
{
    char *caps;

5320
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5321
        return false;
5322 5323

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

E
Eric Blake 已提交
5330
    return true;
5331 5332
}

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

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

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

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
5365 5366
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
5367

5368
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5369
        return false;
5370

J
Jim Meyering 已提交
5371
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
5372
        return false;
5373

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

5382 5383 5384 5385
    virDomainFree(dom);
    return ret;
}

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

static const vshCmdOptDef opts_domxmlfromnative[] = {
5396 5397
    {"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")},
5398 5399 5400
    {NULL, 0, 0, NULL}
};

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

5411
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5412
        return false;
5413

5414 5415
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
5416
        return false;
5417

5418
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
5419
        return false;
5420 5421 5422

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

    return ret;
}

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

static const vshCmdOptDef opts_domxmltonative[] = {
5442 5443
    {"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")},
5444 5445 5446
    {NULL, 0, 0, NULL}
};

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

5457
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5458
        return false;
5459

5460 5461
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
5462
        return false;
5463

5464
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
5465
        return false;
5466 5467 5468

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

    return ret;
}

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

5487
static const vshCmdOptDef opts_domname[] = {
5488
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
5489
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5490 5491
};

E
Eric Blake 已提交
5492
static bool
5493
cmdDomname(vshControl *ctl, const vshCmd *cmd)
5494
{
K
Karel Zak 已提交
5495 5496
    virDomainPtr dom;

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

K
Karel Zak 已提交
5503 5504
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
5505
    return true;
K
Karel Zak 已提交
5506 5507 5508
}

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

5517
static const vshCmdOptDef opts_domid[] = {
5518
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
5519
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
5520 5521
};

E
Eric Blake 已提交
5522
static bool
5523
cmdDomid(vshControl *ctl, const vshCmd *cmd)
5524
{
5525
    virDomainPtr dom;
5526
    unsigned int id;
K
Karel Zak 已提交
5527

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

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

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

5552
static const vshCmdOptDef opts_domuuid[] = {
5553
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
5554 5555 5556
    {NULL, 0, 0, NULL}
};

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

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

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

5574
    virDomainFree(dom);
E
Eric Blake 已提交
5575
    return true;
K
Karel Zak 已提交
5576 5577
}

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

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

5609 5610 5611 5612 5613 5614 5615 5616
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

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

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

5636
    if (!vshConnectionUsability (ctl, ctl->conn))
5637
        goto out;
5638

J
Jim Meyering 已提交
5639
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
5640
        goto out;
5641

5642 5643
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
5644 5645
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
5646
        goto out;
5647
    }
5648

5649 5650 5651 5652 5653
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

5654 5655
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
5656 5657
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
5658
    if (vshCommandOptBool (cmd, "tunnelled"))
5659
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
5660

C
Chris Lalancette 已提交
5661 5662 5663 5664 5665
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

5666 5667 5668
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

5669 5670 5671 5672 5673 5674
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

5675 5676
    if (vshCommandOptBool (cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;
5677 5678 5679 5680 5681 5682

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


5683 5684 5685 5686
    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. */
5687

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

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

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
5701
        if (!dconn) goto out;
5702

5703
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
5704 5705
        if (ddom) {
            virDomainFree(ddom);
5706
            ret = '0';
5707 5708 5709
        }
        virConnectClose (dconn);
    }
5710

5711 5712 5713
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
5714
    if (dom) virDomainFree (dom);
5715
    VIR_FREE(xml);
5716 5717 5718
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

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

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

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

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
5769 5770

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

W
Wen Congyang 已提交
5773 5774 5775
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

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

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

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
5846
            functionReturn = false;
W
Wen Congyang 已提交
5847 5848 5849
            break;
        }

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

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

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
5878
    return functionReturn;
5879 5880
}

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

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

5903
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5904
        return false;
5905 5906

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

5909 5910
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
5911 5912 5913 5914 5915 5916 5917
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
5918
    ret = true;
5919 5920 5921 5922 5923 5924

done:
    virDomainFree(dom);
    return ret;
}

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 5965 5966 5967 5968
/*
 * "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;
}

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 6004 6005 6006 6007
/*
 * "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;
}

6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024
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))
6025
        goto cleanup;
6026 6027

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

    if (vshCommandOptString(cmd, "path", &path) < 0)
6031
        goto cleanup;
6032

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

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

6047
cleanup:
6048 6049
    if (dom)
        virDomainFree(dom);
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 6129 6130 6131 6132
    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;
}

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 6186 6187 6188 6189
/*
 * "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;
}
6190

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

6201
static const vshCmdOptDef opts_network_autostart[] = {
6202 6203
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6204 6205 6206
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6207
static bool
6208
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
6209 6210
{
    virNetworkPtr network;
6211
    const char *name;
6212 6213
    int autostart;

6214
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6215
        return false;
6216

J
Jim Meyering 已提交
6217
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6218
        return false;
6219 6220 6221 6222

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

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

6231
    if (autostart)
6232
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
6233
    else
6234
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
6235

L
Laine Stump 已提交
6236
    virNetworkFree(network);
E
Eric Blake 已提交
6237
    return true;
6238
}
K
Karel Zak 已提交
6239

L
Lei Li 已提交
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 6404 6405 6406 6407
/*
 * "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");
            }
        }

6408
        ret = true;
6409
        goto cleanup;
L
Lei Li 已提交
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 6479 6480 6481 6482
    } 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;
}

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

6492
static const vshCmdOptDef opts_network_create[] = {
6493
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
6494 6495 6496
    {NULL, 0, 0, NULL}
};

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

6505
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6506
        return false;
6507

6508
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6509
        return false;
6510

6511
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6512
        return false;
6513 6514

    network = virNetworkCreateXML(ctl->conn, buffer);
6515
    VIR_FREE(buffer);
6516

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


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

6538
static const vshCmdOptDef opts_network_define[] = {
6539
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
6540 6541 6542
    {NULL, 0, 0, NULL}
};

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

6551
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6552
        return false;
6553

6554
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6555
        return false;
6556

6557
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6558
        return false;
6559 6560

    network = virNetworkDefineXML(ctl->conn, buffer);
6561
    VIR_FREE(buffer);
6562

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


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

6584
static const vshCmdOptDef opts_network_destroy[] = {
6585
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6586 6587 6588
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6589
static bool
6590
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
6591 6592
{
    virNetworkPtr network;
E
Eric Blake 已提交
6593
    bool ret = true;
6594
    const char *name;
6595

6596
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6597
        return false;
6598

J
Jim Meyering 已提交
6599
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
6600
        return false;
6601 6602 6603 6604

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

6609
    virNetworkFree(network);
6610 6611 6612 6613 6614 6615 6616
    return ret;
}


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

6623
static const vshCmdOptDef opts_network_dumpxml[] = {
6624
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
6625 6626 6627
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6628
static bool
6629
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
6630 6631
{
    virNetworkPtr network;
E
Eric Blake 已提交
6632
    bool ret = true;
6633 6634
    char *dump;

6635
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6636
        return false;
6637

J
Jim Meyering 已提交
6638
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
6639
        return false;
6640 6641 6642

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

    virNetworkFree(network);
    return ret;
}

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

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
6682
        return false;
O
Osier Yang 已提交
6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707

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

6708
    VIR_FREE(bridge);
O
Osier Yang 已提交
6709
    virNetworkFree(network);
E
Eric Blake 已提交
6710
    return true;
O
Osier Yang 已提交
6711
}
6712

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

static const vshCmdOptDef opts_interface_edit[] = {
6723
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
6724 6725 6726
    {NULL, 0, 0, NULL}
};

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

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

cleanup:
    if (iface)
        virInterfaceFree (iface);

6798 6799 6800
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
6801 6802 6803

    if (tmp) {
        unlink (tmp);
6804
        VIR_FREE(tmp);
6805 6806 6807 6808 6809
    }

    return ret;
}

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

6819
static const vshCmdOptDef opts_network_list[] = {
6820 6821
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
6822 6823 6824
    {NULL, 0, 0, NULL}
};

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

6835
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6836
        return false;
6837 6838

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

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

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

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

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

    for (i = 0; i < maxactive; i++) {
6884 6885
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
6886 6887
        const char *autostartStr;
        int autostart = 0;
6888 6889 6890

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6891
            VIR_FREE(activeNames[i]);
6892
            continue;
6893
        }
6894

6895 6896 6897
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6898
            autostartStr = autostart ? _("yes") : _("no");
6899 6900 6901 6902 6903

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

        /* this kind of work with networks is not atomic operation */
        if (!network) {
6914
            VIR_FREE(inactiveNames[i]);
6915
            continue;
6916
        }
6917

6918 6919 6920
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
6921
            autostartStr = autostart ? _("yes") : _("no");
6922

6923
        vshPrint(ctl, "%-20s %-10s %-10s\n",
6924 6925 6926
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
6927 6928

        virNetworkFree(network);
6929
        VIR_FREE(inactiveNames[i]);
6930
    }
6931 6932
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
6933
    return true;
6934 6935 6936 6937 6938 6939
}


/*
 * "net-name" command
 */
6940
static const vshCmdInfo info_network_name[] = {
6941
    {"help", N_("convert a network UUID to network name")},
6942
    {"desc", ""},
6943 6944 6945
    {NULL, NULL}
};

6946
static const vshCmdOptDef opts_network_name[] = {
6947
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
6948 6949 6950
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6951
static bool
6952
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
6953 6954 6955
{
    virNetworkPtr network;

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

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
6964
    return true;
6965 6966 6967 6968 6969 6970
}


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

6977
static const vshCmdOptDef opts_network_start[] = {
6978
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
6979 6980 6981
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6982
static bool
6983
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
6984 6985
{
    virNetworkPtr network;
E
Eric Blake 已提交
6986
    bool ret = true;
6987

6988
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6989
        return false;
6990

J
Jim Meyering 已提交
6991
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
6992
         return false;
6993 6994 6995

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


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

7016
static const vshCmdOptDef opts_network_undefine[] = {
7017
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
7018 7019 7020
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7021
static bool
7022
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
7023 7024
{
    virNetworkPtr network;
E
Eric Blake 已提交
7025
    bool ret = true;
7026
    const char *name;
7027

7028
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7029
        return false;
7030

J
Jim Meyering 已提交
7031
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
7032
        return false;
7033 7034 7035 7036

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

L
Laine Stump 已提交
7041
    virNetworkFree(network);
7042 7043 7044 7045 7046 7047 7048
    return ret;
}


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

7055
static const vshCmdOptDef opts_network_uuid[] = {
7056
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
7057 7058 7059
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7060
static bool
7061
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
7062 7063 7064 7065
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

7066
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7067
        return false;
7068

J
Jim Meyering 已提交
7069
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
7070
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7071
        return false;
7072 7073 7074 7075

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

L
Laine Stump 已提交
7078
    virNetworkFree(network);
E
Eric Blake 已提交
7079
    return true;
7080 7081 7082
}


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

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

7108
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7109
        return false;
7110 7111 7112 7113

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

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

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

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

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

    for (i = 0; i < maxactive; i++) {
7157 7158
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
7159 7160 7161

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
7162
            VIR_FREE(activeNames[i]);
7163 7164 7165 7166 7167 7168 7169 7170
            continue;
        }

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

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
7179
            VIR_FREE(inactiveNames[i]);
7180 7181 7182 7183 7184 7185 7186 7187
            continue;
        }

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

}

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

static const vshCmdOptDef opts_interface_name[] = {
7206
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
7207 7208 7209
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7210
static bool
7211 7212 7213 7214
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

7215
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7216
        return false;
7217
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL, NULL,
7218
                                           VSH_BYMAC)))
E
Eric Blake 已提交
7219
        return false;
7220 7221 7222

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
7223
    return true;
7224 7225 7226 7227 7228 7229
}

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

static const vshCmdOptDef opts_interface_mac[] = {
7236
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
7237 7238 7239
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7240
static bool
7241 7242 7243 7244
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

7245
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7246
        return false;
7247
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL, NULL,
7248
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7249
        return false;
7250 7251 7252

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
7253
    return true;
7254 7255 7256 7257 7258 7259
}

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

static const vshCmdOptDef opts_interface_dumpxml[] = {
7266 7267
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
7268 7269 7270
    {NULL, 0, 0, NULL}
};

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

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
7282

7283
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7284
        return false;
7285 7286

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

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

    virInterfaceFree(iface);
    return ret;
}

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

static const vshCmdOptDef opts_interface_define[] = {
7311
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
7312 7313 7314
    {NULL, 0, 0, NULL}
};

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

7323
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7324
        return false;
7325

7326
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7327
        return false;
7328 7329

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

7332
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
7333
    VIR_FREE(buffer);
7334

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

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

static const vshCmdOptDef opts_interface_undefine[] = {
7356
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
7357 7358 7359
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7360
static bool
7361 7362 7363
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
7364
    bool ret = true;
7365
    const char *name;
7366

7367
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7368
        return false;
7369 7370

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
7371
        return false;
7372 7373 7374 7375

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

    virInterfaceFree(iface);
    return ret;
}

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

static const vshCmdOptDef opts_interface_start[] = {
7394
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
7395 7396 7397
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7398
static bool
7399 7400 7401
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
7402
    bool ret = true;
7403
    const char *name;
7404

7405
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7406
        return false;
7407 7408

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
7409
        return false;
7410 7411 7412 7413

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

    virInterfaceFree(iface);
    return ret;
}

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

static const vshCmdOptDef opts_interface_destroy[] = {
7432
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
7433 7434 7435
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7436
static bool
7437 7438 7439
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
7440
    bool ret = true;
7441
    const char *name;
7442

7443
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7444
        return false;
7445 7446

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
7447
        return false;
7448 7449 7450 7451

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

    virInterfaceFree(iface);
    return ret;
}

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

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

7981
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7982
        return false;
7983

7984
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
7985
        return false;
7986 7987

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
7988
        return false;
7989 7990 7991 7992 7993 7994 7995 7996 7997 7998

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

8026
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8027
        return false;
8028 8029

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
8030
        return false;
8031 8032 8033 8034 8035

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

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

8065
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8066
        return false;
8067 8068

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
8069
        return false;
8070 8071 8072

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

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

8103
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8104
        return false;
8105 8106 8107 8108

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

    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 已提交
8118
        return false;
8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145
    }

    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 已提交
8146
    return true;
8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163
}


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

8174
    if (!vshConnectionUsability(ctl, ctl->conn))
8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200
        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 已提交
8201
        ret = true;
8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227
        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 已提交
8228
    ret = true;
8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246

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


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

8258
static const vshCmdOptDef opts_pool_autostart[] = {
8259 8260
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
8261 8262
    {NULL, 0, 0, NULL}
};
8263

E
Eric Blake 已提交
8264
static bool
8265
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
8266
{
8267
    virStoragePoolPtr pool;
8268
    const char *name;
8269
    int autostart;
8270

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

8274
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8275
        return false;
8276

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

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

8288
    if (autostart)
8289
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
8290
    else
8291
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
8292

L
Laine Stump 已提交
8293
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8294
    return true;
8295 8296
}

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

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

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

8320
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8321
        return false;
8322

8323
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8324
        return false;
8325

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

8329
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
8330
    VIR_FREE(buffer);
8331 8332 8333 8334

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

8343

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

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

8370
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8371
        return false;
8372

8373
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8374
        return false;
8375

8376
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
8377
        return false;
8378 8379

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
8380
    VIR_FREE(buffer);
8381 8382 8383 8384

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

    return ret;
}


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

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
8407
     N_("name of the device to be destroyed")},
8408 8409 8410
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8411
static bool
8412 8413 8414
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
8415
    bool ret = true;
8416
    const char *name = NULL;
8417

8418
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
8419
        return false;
8420 8421
    }

8422
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
8423
        return false;
8424 8425 8426 8427 8428 8429

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

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

    virNodeDeviceFree(dev);
    return ret;
}


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

8455
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
8456

8457 8458
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
8459
    virBuffer buf = VIR_BUFFER_INITIALIZER;
8460

8461
    if (vshCommandOptString(cmd, "name", &name) <= 0)
8462
        goto cleanup;
8463
    if (vshCommandOptString(cmd, "type", &type) <= 0)
8464 8465
        goto cleanup;

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

8476 8477
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
8478
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
8479
        virBufferAddLit(&buf, "  <source>\n");
8480

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

        virBufferAddLit(&buf, "  </source>\n");
8493 8494
    }
    if (target) {
8495
        virBufferAddLit(&buf, "  <target>\n");
8496
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
8497
        virBufferAddLit(&buf, "  </target>\n");
8498
    }
8499 8500 8501 8502
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
8503
        return false;
8504
    }
8505 8506 8507

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
8508
    return true;
8509 8510

cleanup:
8511
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
8512
    return false;
8513 8514 8515 8516 8517 8518
}

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

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

8532
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8533
        return false;
8534 8535

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

8538
    if (printXML) {
8539
        vshPrint(ctl, "%s", xml);
8540
        VIR_FREE(xml);
8541
    } else {
8542
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
8543
        VIR_FREE(xml);
8544

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

8556

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

8566
static const vshCmdOptDef opts_pool_define[] = {
8567
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
8568 8569 8570
    {NULL, 0, 0, NULL}
};

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

8579
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8580
        return false;
8581

8582
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8583
        return false;
8584

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

8588
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
8589
    VIR_FREE(buffer);
8590 8591 8592 8593

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

8602

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

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

8620
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8621
        return false;
8622

8623
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
8624
        return false;
8625

8626
    if (printXML) {
8627
        vshPrint(ctl, "%s", xml);
8628
        VIR_FREE(xml);
8629
    } else {
8630
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
8631
        VIR_FREE(xml);
8632

8633 8634 8635 8636
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
8637
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
8638
            return false;
8639 8640
        }
    }
E
Eric Blake 已提交
8641
    return true;
8642 8643 8644
}


8645
/*
8646
 * "pool-build" command
8647
 */
8648
static const vshCmdInfo info_pool_build[] = {
8649 8650
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
8651 8652 8653
    {NULL, NULL}
};

8654
static const vshCmdOptDef opts_pool_build[] = {
8655
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8656 8657
    {"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")},
8658 8659 8660
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8661
static bool
8662
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
8663
{
8664
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8665
    bool ret = true;
8666
    const char *name;
8667
    unsigned int flags = 0;
8668

8669
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8670
        return false;
8671

8672
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8673
        return false;
8674

8675 8676 8677 8678 8679 8680 8681 8682 8683
    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) {
8684
        vshPrint(ctl, _("Pool %s built\n"), name);
8685
    } else {
8686
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
8687
        ret = false;
8688 8689
    }

8690 8691
    virStoragePoolFree(pool);

8692 8693 8694
    return ret;
}

8695
/*
8696
 * "pool-destroy" command
8697
 */
8698
static const vshCmdInfo info_pool_destroy[] = {
8699 8700 8701
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
8702 8703 8704
    {NULL, NULL}
};

8705
static const vshCmdOptDef opts_pool_destroy[] = {
8706
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8707 8708 8709
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8710
static bool
8711
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
8712
{
8713
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8714
    bool ret = true;
8715
    const char *name;
8716

8717
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8718
        return false;
8719

8720
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8721
        return false;
8722

8723 8724 8725
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
8726
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
8727
        ret = false;
8728 8729
    }

8730
    virStoragePoolFree(pool);
8731 8732 8733
    return ret;
}

8734

8735
/*
8736 8737
 * "pool-delete" command
 */
8738
static const vshCmdInfo info_pool_delete[] = {
8739 8740
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
8741 8742 8743
    {NULL, NULL}
};

8744
static const vshCmdOptDef opts_pool_delete[] = {
8745
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8746 8747 8748
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8749
static bool
8750
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
8751 8752
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8753
    bool ret = true;
8754
    const char *name;
8755

8756
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8757
        return false;
8758 8759

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8760
        return false;
8761 8762

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
8763
        vshPrint(ctl, _("Pool %s deleted\n"), name);
8764
    } else {
8765
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
8766
        ret = false;
8767 8768
    }

L
Laine Stump 已提交
8769
    virStoragePoolFree(pool);
8770 8771 8772 8773 8774 8775 8776
    return ret;
}


/*
 * "pool-refresh" command
 */
8777
static const vshCmdInfo info_pool_refresh[] = {
8778 8779
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
8780 8781 8782
    {NULL, NULL}
};

8783
static const vshCmdOptDef opts_pool_refresh[] = {
8784
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8785 8786 8787
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8788
static bool
8789
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
8790 8791
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8792
    bool ret = true;
8793
    const char *name;
8794

8795
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8796
        return false;
8797 8798

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
8799
        return false;
8800 8801 8802 8803

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
8804
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
8805
        ret = false;
8806 8807 8808 8809 8810 8811 8812 8813 8814 8815
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
8816
static const vshCmdInfo info_pool_dumpxml[] = {
8817 8818
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
8819 8820 8821
    {NULL, NULL}
};

8822
static const vshCmdOptDef opts_pool_dumpxml[] = {
8823
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8824 8825 8826
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8827
static bool
8828
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
8829 8830
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
8831
    bool ret = true;
8832 8833
    char *dump;

8834
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8835
        return false;
8836 8837

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8838
        return false;
8839 8840 8841

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
8842
        vshPrint(ctl, "%s", dump);
8843
        VIR_FREE(dump);
8844
    } else {
E
Eric Blake 已提交
8845
        ret = false;
8846 8847 8848 8849 8850 8851 8852 8853 8854 8855
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
8856
static const vshCmdInfo info_pool_list[] = {
8857 8858
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
8859 8860 8861
    {NULL, NULL}
};

8862
static const vshCmdOptDef opts_pool_list[] = {
8863 8864
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
8865
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
8866 8867 8868
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8869
static bool
8870
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8871
{
8872 8873
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
8874 8875
    int i, ret;
    bool functionReturn;
8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891
    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 */
8892
    int all = vshCommandOptBool(cmd, "all");
8893 8894
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
8895 8896 8897
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

8898
    /* Check the connection to libvirtd daemon is still working */
8899
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8900
        return false;
8901

8902
    /* Retrieve the number of active storage pools */
8903
    if (active) {
8904 8905
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
8906
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
8907
            return false;
8908 8909
        }
    }
8910 8911

    /* Retrieve the number of inactive storage pools */
8912
    if (inactive) {
8913 8914
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
8915
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
8916
            return false;
8917
        }
8918
    }
8919

8920 8921
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
8922

8923 8924 8925 8926 8927 8928 8929 8930 8931 8932 8933 8934
    /* 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 已提交
8935
            return false;
8936 8937 8938
        }
    }

8939 8940 8941 8942 8943 8944 8945 8946
    /* 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 已提交
8947
            return false;
8948 8949
        }
    }
8950

8951 8952 8953 8954 8955 8956 8957 8958 8959 8960
    /* 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]);
8961
        if (!pool) {
8962
            VIR_FREE(poolNames[i]);
8963 8964 8965
            continue;
        }

8966
        /* Retrieve the autostart status of the pool */
8967
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
8968
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
8969
        else
8970 8971 8972 8973 8974 8975
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
8976 8977
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988
            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;
        }
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 9098 9099 9100 9101
        /* 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 */
9102 9103 9104
        virStoragePoolFree(pool);
    }

9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122
    /* 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);
9123 9124
        }

9125
        /* Cleanup and return */
E
Eric Blake 已提交
9126
        functionReturn = true;
9127 9128
        goto cleanup;
    }
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 9164 9165 9166 9167
    /* 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. */
9168
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
9169
             (unsigned long) nameStrLength);
9170
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
9171
             (unsigned long) stateStrLength);
9172
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
9173
             (unsigned long) autostartStrLength);
9174
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
9175
             (unsigned long) persistStrLength);
9176
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
9177
             (unsigned long) capStrLength);
9178
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
9179
             (unsigned long) allocStrLength);
9180
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
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 9220 9221 9222 9223
             (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 已提交
9224
    functionReturn = true;
9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238
    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 已提交
9239
    functionReturn = false;
9240

9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252
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]);
9253
    }
9254 9255 9256 9257 9258 9259 9260

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

    /* Return the desired value */
    return functionReturn;
9261 9262
}

9263 9264 9265 9266
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
9267 9268
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
9269 9270 9271 9272 9273
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
9274 9275 9276
     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")},
9277
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
9278 9279 9280
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9281
static bool
9282 9283
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
9284
    const char *type = NULL, *host = NULL;
9285 9286
    char *srcSpec = NULL;
    char *srcList;
9287
    const char *initiator = NULL;
9288

9289 9290
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
9291 9292
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
9293
        return false;
9294
    }
9295

9296
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9297
        return false;
9298 9299

    if (host) {
9300
        const char *port = NULL;
9301
        virBuffer buf = VIR_BUFFER_INITIALIZER;
9302 9303 9304 9305

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
9306
            return false;
9307
        }
9308
        virBufferAddLit(&buf, "<source>\n");
9309
        virBufferAsprintf(&buf, "  <host name='%s'", host);
9310
        if (port)
9311
            virBufferAsprintf(&buf, " port='%s'", port);
9312
        virBufferAddLit(&buf, "/>\n");
9313 9314
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
9315
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
9316 9317
            virBufferAddLit(&buf, "  </initiator>\n");
        }
9318 9319 9320
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
9321
            return false;
9322
        }
9323
        srcSpec = virBufferContentAndReset(&buf);
9324 9325 9326
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
9327
    VIR_FREE(srcSpec);
9328
    if (srcList == NULL) {
9329
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
9330
        return false;
9331 9332
    }
    vshPrint(ctl, "%s", srcList);
9333
    VIR_FREE(srcList);
9334

E
Eric Blake 已提交
9335
    return true;
9336 9337 9338 9339 9340 9341 9342
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
9343 9344
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
9345 9346 9347 9348 9349
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
9350
     N_("type of storage pool sources to discover")},
9351
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
9352
     N_("optional file of source xml to query for pools")},
9353 9354 9355
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9356
static bool
9357 9358
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
9359
    const char *type = NULL, *srcSpecFile = NULL;
9360
    char *srcSpec = NULL, *srcList;
9361

9362
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
9363
        return false;
9364

9365 9366
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
9367
        return false;
9368
    }
9369

9370
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9371
        return false;
9372 9373

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
9374
        return false;
9375 9376

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
9377
    VIR_FREE(srcSpec);
9378
    if (srcList == NULL) {
9379
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
9380
        return false;
9381 9382
    }
    vshPrint(ctl, "%s", srcList);
9383
    VIR_FREE(srcList);
9384

E
Eric Blake 已提交
9385
    return true;
9386 9387 9388
}


9389 9390 9391
/*
 * "pool-info" command
 */
9392
static const vshCmdInfo info_pool_info[] = {
9393 9394
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
9395 9396 9397
    {NULL, NULL}
};

9398
static const vshCmdOptDef opts_pool_info[] = {
9399
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9400 9401 9402
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9403
static bool
9404
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
9405 9406 9407
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
9408 9409
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
9410
    bool ret = true;
9411 9412
    char uuid[VIR_UUID_STRING_BUFLEN];

9413
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9414
        return false;
9415 9416

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
9417
        return false;
9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443

    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;
9444 9445 9446 9447
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
9448 9449
        }

9450 9451
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
9452 9453
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
9454 9455 9456 9457 9458 9459 9460
        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);
9461 9462
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
9463 9464 9465 9466 9467
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

9468 9469 9470 9471 9472 9473 9474 9475 9476 9477 9478 9479
        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 已提交
9480
        ret = false;
9481 9482 9483 9484 9485 9486 9487 9488 9489 9490
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
9491
static const vshCmdInfo info_pool_name[] = {
9492
    {"help", N_("convert a pool UUID to pool name")},
9493
    {"desc", ""},
9494 9495 9496
    {NULL, NULL}
};

9497
static const vshCmdOptDef opts_pool_name[] = {
9498
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
9499 9500 9501
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9502
static bool
9503
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
9504 9505 9506
{
    virStoragePoolPtr pool;

9507
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9508
        return false;
9509
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
9510
                                           VSH_BYUUID)))
E
Eric Blake 已提交
9511
        return false;
9512 9513 9514

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9515
    return true;
9516 9517 9518 9519 9520 9521
}


/*
 * "pool-start" command
 */
9522
static const vshCmdInfo info_pool_start[] = {
9523 9524
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
9525 9526 9527
    {NULL, NULL}
};

9528
static const vshCmdOptDef opts_pool_start[] = {
9529
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
9530 9531 9532
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9533
static bool
9534
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
9535 9536
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
9537
    bool ret = true;
9538

9539
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9540
        return false;
9541

9542
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
9543
         return false;
9544 9545 9546 9547 9548

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
9549
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
9550
        ret = false;
9551
    }
L
Laine Stump 已提交
9552 9553

    virStoragePoolFree(pool);
9554 9555 9556 9557
    return ret;
}


9558 9559 9560
/*
 * "vol-create-as" command
 */
9561
static const vshCmdInfo info_vol_create_as[] = {
9562 9563
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
9564 9565 9566
    {NULL, NULL}
};

9567
static const vshCmdOptDef opts_vol_create_as[] = {
9568 9569 9570 9571 9572
    {"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")},
9573 9574
    {"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")},
9575 9576 9577 9578 9579 9580 9581 9582 9583 9584
    {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 已提交
9585
        /* Deliberate fallthrough cases here :-) */
9586 9587 9588
        switch (*end) {
        case 'T':
            *val *= 1024;
9589
            /* fallthrough */
9590 9591
        case 'G':
            *val *= 1024;
9592
            /* fallthrough */
9593 9594
        case 'M':
            *val *= 1024;
9595
            /* fallthrough */
9596 9597 9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
9609
static bool
9610
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
9611 9612 9613
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9614
    char *xml;
9615 9616
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
9617
    unsigned long long capacity, allocation = 0;
9618
    virBuffer buf = VIR_BUFFER_INITIALIZER;
9619

9620
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9621
        return false;
9622 9623 9624

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

9627
    if (vshCommandOptString(cmd, "name", &name) <= 0)
9628 9629
        goto cleanup;

9630
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
9631 9632
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
9633
        vshError(ctl, _("Malformed size %s"), capacityStr);
9634

9635 9636
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
9637
        vshError(ctl, _("Malformed size %s"), allocationStr);
9638

9639 9640 9641 9642 9643 9644 9645
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

9646

9647
    virBufferAddLit(&buf, "<volume>\n");
9648 9649
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
9650
    if (allocationStr)
9651
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
9652 9653

    if (format) {
9654
        virBufferAddLit(&buf, "  <target>\n");
9655
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
9656
        virBufferAddLit(&buf, "  </target>\n");
9657
    }
9658

9659 9660 9661 9662
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
9663 9664
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
9665 9666 9667
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
9668 9669
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
9670 9671 9672 9673 9674
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
9675 9676
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
9677 9678 9679
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
9680 9681
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
9682 9683 9684 9685 9686
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
9687 9688
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
9689 9690 9691
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
9692 9693
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
9694 9695 9696 9697
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
9698
            goto cleanup;
9699 9700 9701 9702 9703
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
9704
            goto cleanup;
9705 9706 9707 9708
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
9709
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
9710
        if (snapshotStrFormat)
9711
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
9712 9713 9714 9715 9716 9717 9718 9719
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

9721 9722
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
9723
        goto cleanup;
9724 9725 9726
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
9727
    VIR_FREE(xml);
9728 9729 9730 9731 9732
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
9733
        return true;
9734
    } else {
9735
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
9736
        return false;
9737 9738 9739
    }

 cleanup:
9740
    virBufferFreeAndReset(&buf);
9741
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9742
    return false;
9743 9744 9745
}


9746 9747 9748
/*
 * "pool-undefine" command
 */
9749
static const vshCmdInfo info_pool_undefine[] = {
9750 9751
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
9752 9753 9754
    {NULL, NULL}
};

9755
static const vshCmdOptDef opts_pool_undefine[] = {
9756
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
9757 9758 9759
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9760
static bool
9761
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
9762 9763
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
9764
    bool ret = true;
9765
    const char *name;
9766

9767
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9768
        return false;
9769 9770

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
9771
        return false;
9772 9773 9774 9775

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

L
Laine Stump 已提交
9780
    virStoragePoolFree(pool);
9781 9782 9783 9784 9785 9786 9787
    return ret;
}


/*
 * "pool-uuid" command
 */
9788
static const vshCmdInfo info_pool_uuid[] = {
9789
    {"help", N_("convert a pool name to pool UUID")},
9790
    {"desc", ""},
9791 9792 9793
    {NULL, NULL}
};

9794
static const vshCmdOptDef opts_pool_uuid[] = {
9795
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
9796 9797 9798
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9799
static bool
9800
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
9801 9802 9803 9804
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

9805
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9806
        return false;
9807 9808

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
9809
                                           VSH_BYNAME)))
E
Eric Blake 已提交
9810
        return false;
9811 9812 9813 9814

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

L
Laine Stump 已提交
9817
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9818
    return true;
9819 9820 9821 9822 9823 9824
}


/*
 * "vol-create" command
 */
9825
static const vshCmdInfo info_vol_create[] = {
9826 9827
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
9828 9829 9830
    {NULL, NULL}
};

9831
static const vshCmdOptDef opts_vol_create[] = {
9832 9833
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
9834 9835 9836
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9837
static bool
9838
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
9839 9840 9841
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
9842
    const char *from = NULL;
E
Eric Blake 已提交
9843
    bool ret = true;
9844 9845
    char *buffer;

9846
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9847
        return false;
9848 9849

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

9853
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9854
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9855
        return false;
9856 9857 9858
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9859
        virshReportError(ctl);
9860
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9861
        return false;
9862 9863 9864
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
9865
    VIR_FREE(buffer);
9866 9867 9868 9869 9870 9871 9872
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
9873
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
9874
        ret = false;
9875 9876 9877 9878
    }
    return ret;
}

9879 9880 9881 9882
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
9883 9884
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
9885 9886 9887 9888
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
9889 9890 9891
    {"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 已提交
9892
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
9893 9894 9895
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9896
static bool
9897 9898 9899 9900
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
9901
    const char *from = NULL;
E
Eric Blake 已提交
9902
    bool ret = false;
9903 9904
    char *buffer = NULL;

9905
    if (!vshConnectionUsability(ctl, ctl->conn))
9906 9907 9908 9909 9910
        goto cleanup;

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

9911
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9912 9913 9914 9915 9916 9917 9918
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9919
        virshReportError(ctl);
9920 9921 9922 9923 9924 9925 9926 9927 9928
        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 {
9929
        vshError(ctl, _("Failed to create vol from %s"), from);
9930 9931 9932
        goto cleanup;
    }

E
Eric Blake 已提交
9933
    ret = true;
9934
cleanup:
9935
    VIR_FREE(buffer);
9936 9937 9938 9939
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
9940 9941
    if (newvol)
        virStorageVolFree(newvol);
9942 9943 9944 9945
    return ret;
}

static xmlChar *
9946 9947
makeCloneXML(const char *origxml, const char *newname)
{
9948

9949 9950 9951
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
9952 9953 9954
    xmlChar *newxml = NULL;
    int size;

9955
    doc = virXMLParseStringCtxt(origxml, _("(volume_definition)"), &ctxt);
9956 9957 9958 9959 9960 9961 9962 9963 9964 9965 9966 9967 9968 9969 9970 9971 9972 9973 9974 9975 9976 9977
    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[] = {
9978 9979
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
9980 9981 9982 9983
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
9984 9985
    {"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 已提交
9986
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
9987 9988 9989
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9990
static bool
9991 9992 9993 9994
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
9995
    const char *name = NULL;
9996
    char *origxml = NULL;
9997
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
9998
    bool ret = false;
9999

10000
    if (!vshConnectionUsability(ctl, ctl->conn))
10001 10002 10003 10004 10005 10006 10007
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
10008
        vshError(ctl, "%s", _("failed to get parent pool"));
10009 10010 10011
        goto cleanup;
    }

10012
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 10027 10028 10029 10030
        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 {
10031
        vshError(ctl, _("Failed to clone vol from %s"),
10032 10033 10034 10035
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
10036
    ret = true;
10037 10038

cleanup:
10039
    VIR_FREE(origxml);
10040 10041 10042
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
10043 10044
    if (newvol)
        virStorageVolFree(newvol);
10045 10046 10047 10048 10049
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

10050 10051 10052 10053 10054 10055 10056 10057 10058 10059 10060 10061 10062

/*
 * "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 已提交
10063
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10064 10065 10066 10067 10068 10069 10070 10071 10072 10073 10074 10075 10076 10077
    {"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 已提交
10078
static bool
10079 10080 10081 10082
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
10083
    bool ret = false;
10084 10085 10086 10087 10088 10089 10090 10091 10092 10093
    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 已提交
10094
        return false;
10095 10096 10097 10098
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
10099
        return false;
10100 10101 10102
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
10103
        return false;
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 10134 10135 10136 10137
    }

    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 已提交
10138
    ret = true;
10139 10140 10141 10142 10143 10144 10145 10146 10147 10148 10149 10150 10151 10152 10153 10154 10155 10156 10157 10158 10159 10160 10161 10162

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 已提交
10163
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10164 10165 10166 10167 10168
    {"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 已提交
10169
static bool
10170 10171 10172 10173
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
10174
    bool ret = false;
10175 10176 10177 10178
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
10179
    bool created = false;
10180 10181

    if (!vshConnectionUsability(ctl, ctl->conn))
10182
        return false;
10183 10184 10185

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
10186
        return false;
10187 10188 10189 10190
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
10191
        return false;
10192 10193 10194
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
10195
        return false;
10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207

    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;
        }
10208 10209
    } else {
        created = true;
10210 10211 10212 10213 10214 10215 10216 10217
    }

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

10218
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233
        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 已提交
10234
    ret = true;
10235 10236

cleanup:
10237
    VIR_FORCE_CLOSE(fd);
10238
    if (!ret && created)
10239 10240 10241 10242 10243 10244 10245 10246 10247
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


10248 10249 10250
/*
 * "vol-delete" command
 */
10251
static const vshCmdInfo info_vol_delete[] = {
10252 10253
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
10254 10255 10256
    {NULL, NULL}
};

10257
static const vshCmdOptDef opts_vol_delete[] = {
10258
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
10259
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10260 10261 10262
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10263
static bool
10264
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
10265 10266
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
10267
    bool ret = true;
10268
    const char *name;
10269

10270
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10271
        return false;
10272 10273

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
10274
        return false;
10275 10276 10277
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
10278
        vshPrint(ctl, _("Vol %s deleted\n"), name);
10279
    } else {
10280
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
10281
        ret = false;
10282 10283
    }

L
Laine Stump 已提交
10284
    virStorageVolFree(vol);
10285 10286 10287 10288
    return ret;
}


D
David Allan 已提交
10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299
/*
 * "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 已提交
10300
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
10301 10302 10303
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10304
static bool
D
David Allan 已提交
10305 10306 10307
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
10308
    bool ret = true;
10309
    const char *name;
D
David Allan 已提交
10310

10311
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10312
        return false;
D
David Allan 已提交
10313 10314

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
10315
        return false;
D
David Allan 已提交
10316 10317 10318 10319 10320 10321
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
10322
        ret = false;
D
David Allan 已提交
10323 10324 10325 10326 10327 10328 10329
    }

    virStorageVolFree(vol);
    return ret;
}


10330 10331 10332
/*
 * "vol-info" command
 */
10333
static const vshCmdInfo info_vol_info[] = {
10334 10335
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
10336 10337 10338
    {NULL, NULL}
};

10339
static const vshCmdOptDef opts_vol_info[] = {
10340
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
10341
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10342 10343 10344
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10345
static bool
10346
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
10347 10348 10349
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
10350
    bool ret = true;
10351

10352
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10353
        return false;
10354 10355

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
10356
        return false;
10357 10358 10359 10360 10361 10362

    vshPrint(ctl, "%-15s %s\n", _("Name:"), virStorageVolGetName(vol));

    if (virStorageVolGetInfo(vol, &info) == 0) {
        double val;
        const char *unit;
R
Ryota Ozaki 已提交
10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378
        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"));
        }
10379 10380 10381 10382 10383 10384 10385

        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 已提交
10386
        ret = false;
10387 10388 10389 10390 10391 10392 10393 10394 10395 10396
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
10397
static const vshCmdInfo info_vol_dumpxml[] = {
10398 10399
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
10400 10401 10402
    {NULL, NULL}
};

10403
static const vshCmdOptDef opts_vol_dumpxml[] = {
10404
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
10405
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10406 10407 10408
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10409
static bool
10410
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
10411 10412
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
10413
    bool ret = true;
10414 10415
    char *dump;

10416
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10417
        return false;
10418 10419

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
10420
        return false;
10421 10422 10423

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
10424
        vshPrint(ctl, "%s", dump);
10425
        VIR_FREE(dump);
10426
    } else {
E
Eric Blake 已提交
10427
        ret = false;
10428 10429 10430 10431 10432 10433 10434 10435 10436 10437
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
10438
static const vshCmdInfo info_vol_list[] = {
10439 10440
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
10441 10442 10443
    {NULL, NULL}
};

10444
static const vshCmdOptDef opts_vol_list[] = {
10445
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10446
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
10447 10448 10449
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10450
static bool
10451
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10452
{
10453
    virStorageVolInfo volumeInfo;
10454 10455
    virStoragePoolPtr pool;
    char **activeNames = NULL;
10456 10457 10458 10459 10460
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
10461 10462
    int ret;
    bool functionReturn;
10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473
    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;
10474

10475
    /* Check the connection to libvirtd daemon is still working */
10476
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10477
        return false;
10478

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

10483 10484
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
10485

10486 10487 10488
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
10489
        return false;
10490 10491
    }

10492 10493 10494 10495 10496
    /* 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) {
10497
            vshError(ctl, "%s", _("Failed to list active vols"));
10498
            VIR_FREE(activeNames);
10499
            virStoragePoolFree(pool);
E
Eric Blake 已提交
10500
            return false;
10501 10502
        }

10503 10504 10505 10506 10507
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

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

10510 10511 10512 10513 10514
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
10515

10516 10517 10518 10519
        /* 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"));
10520 10521
        }

10522 10523 10524 10525 10526 10527 10528 10529 10530
        /* 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 */
10531

10532
                /* Volume type */
10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545
                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"));
                }
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 10592 10593 10594 10595

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

10597
        /* Cleanup memory allocation */
10598
        virStorageVolFree(vol);
10599 10600 10601 10602 10603 10604 10605 10606 10607 10608 10609 10610 10611 10612 10613 10614 10615 10616
    }

    /* 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 已提交
10617
        functionReturn = true;
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 10645 10646 10647 10648
        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 */
10649 10650 10651 10652 10653 10654 10655 10656 10657 10658
    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);
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 10689 10690 10691 10692

    /* 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 已提交
10693
    functionReturn = true;
10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707
    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 已提交
10708
    functionReturn = false;
10709 10710 10711 10712 10713 10714 10715 10716 10717 10718

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);
10719
        VIR_FREE(activeNames[i]);
10720
    }
10721 10722 10723 10724

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
10725
    VIR_FREE(activeNames);
10726
    virStoragePoolFree(pool);
10727 10728 10729

    /* Return the desired value */
    return functionReturn;
10730 10731 10732 10733 10734 10735
}


/*
 * "vol-name" command
 */
10736
static const vshCmdInfo info_vol_name[] = {
10737
    {"help", N_("returns the volume name for a given volume key or path")},
10738
    {"desc", ""},
10739 10740 10741
    {NULL, NULL}
};

10742
static const vshCmdOptDef opts_vol_name[] = {
10743
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
10744 10745 10746
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10747
static bool
10748
cmdVolName(vshControl *ctl, const vshCmd *cmd)
10749 10750 10751
{
    virStorageVolPtr vol;

10752
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10753
        return false;
10754

10755
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
10756
                                   VSH_BYUUID)))
E
Eric Blake 已提交
10757
        return false;
10758 10759 10760

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
10761
    return true;
10762 10763 10764
}


J
Justin Clift 已提交
10765 10766 10767 10768 10769 10770 10771 10772 10773 10774
/*
 * "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[] = {
10775
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
10776 10777 10778 10779
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10780
static bool
J
Justin Clift 已提交
10781 10782 10783 10784
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
10785
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
10786 10787

    /* Check the connection to libvirtd daemon is still working */
10788
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10789
        return false;
J
Justin Clift 已提交
10790 10791

    /* Use the supplied string to locate the volume */
10792
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
10793
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
10794
        return false;
J
Justin Clift 已提交
10795 10796 10797 10798 10799 10800 10801
    }

    /* 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 已提交
10802
        return false;
J
Justin Clift 已提交
10803 10804
    }

10805 10806 10807 10808 10809 10810 10811 10812 10813
    /* 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 已提交
10814 10815 10816 10817

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
10818
    return true;
J
Justin Clift 已提交
10819 10820
}

10821 10822 10823 10824

/*
 * "vol-key" command
 */
10825
static const vshCmdInfo info_vol_key[] = {
10826
    {"help", N_("returns the volume key for a given volume name or path")},
10827
    {"desc", ""},
10828 10829 10830
    {NULL, NULL}
};

10831
static const vshCmdOptDef opts_vol_key[] = {
10832
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
10833
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10834 10835 10836
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10837
static bool
10838
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
10839 10840 10841
{
    virStorageVolPtr vol;

10842
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10843
        return false;
10844

10845
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
10846
        return false;
10847 10848 10849

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
10850
    return true;
10851 10852 10853 10854 10855 10856 10857
}



/*
 * "vol-path" command
 */
10858
static const vshCmdInfo info_vol_path[] = {
10859
    {"help", N_("returns the volume path for a given volume name or key")},
10860
    {"desc", ""},
10861 10862 10863
    {NULL, NULL}
};

10864
static const vshCmdOptDef opts_vol_path[] = {
10865
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
10866
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
10867 10868 10869
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10870
static bool
10871
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
10872 10873
{
    virStorageVolPtr vol;
10874
    char * StorageVolPath;
10875

10876
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10877
        return false;
10878

10879
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL))) {
E
Eric Blake 已提交
10880
        return false;
10881
    }
10882

10883 10884 10885 10886 10887 10888 10889
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
10890
    virStorageVolFree(vol);
E
Eric Blake 已提交
10891
    return true;
10892 10893 10894
}


10895 10896 10897 10898
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
10899 10900
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
10901 10902
    {NULL, NULL}
};
10903

10904
static const vshCmdOptDef opts_secret_define[] = {
10905
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
10906 10907
    {NULL, 0, 0, NULL}
};
10908

E
Eric Blake 已提交
10909
static bool
10910 10911
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
10912
    const char *from = NULL;
10913
    char *buffer;
10914
    virSecretPtr res;
10915
    char uuid[VIR_UUID_STRING_BUFLEN];
10916

10917
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10918
        return false;
10919

10920
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10921
        return false;
10922 10923

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
10927
    VIR_FREE(buffer);
10928 10929

    if (res == NULL) {
10930
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
10931
        return false;
10932
    }
10933
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
10934
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
10935
        virSecretFree(res);
E
Eric Blake 已提交
10936
        return false;
10937 10938 10939
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
10940
    return true;
10941 10942 10943 10944 10945 10946
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
10947 10948
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
10949 10950 10951 10952
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
10953
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
10954 10955 10956
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10957
static bool
10958 10959 10960
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
10961
    bool ret = false;
10962 10963
    char *xml;

10964
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10965
        return false;
10966 10967 10968

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
10969
        return false;
10970 10971 10972 10973

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
10974
    vshPrint(ctl, "%s", xml);
10975
    VIR_FREE(xml);
E
Eric Blake 已提交
10976
    ret = true;
10977 10978 10979 10980 10981 10982 10983 10984 10985 10986

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
10987 10988
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
10989 10990 10991 10992
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
10993 10994
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
10995 10996 10997
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10998
static bool
10999 11000 11001 11002
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
11003
    const char *base64 = NULL;
11004
    char *value;
E
Eric Blake 已提交
11005 11006
    int res;
    bool ret = false;
11007

11008
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11009
        return false;
11010 11011 11012

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

11015
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
11016 11017 11018
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
11019
        vshError(ctl, "%s", _("Invalid base64 data"));
11020 11021 11022
        goto cleanup;
    }
    if (value == NULL) {
11023
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
11024
        return false;
11025 11026 11027 11028
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
11029
    VIR_FREE(value);
11030 11031

    if (res != 0) {
11032
        vshError(ctl, "%s", _("Failed to set secret value"));
11033 11034 11035
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
11036
    ret = true;
11037 11038 11039 11040 11041 11042 11043 11044 11045 11046

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
11047 11048
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
11049 11050 11051 11052
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
11053
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
11054 11055 11056
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11057
static bool
11058 11059 11060 11061 11062 11063
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
11064
    bool ret = false;
11065

11066
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11067
        return false;
11068 11069 11070

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
11071
        return false;
11072 11073 11074 11075 11076 11077 11078

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

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
11079
    VIR_FREE(value);
11080 11081

    if (base64 == NULL) {
11082
        vshError(ctl, "%s", _("Failed to allocate memory"));
11083 11084
        goto cleanup;
    }
11085
    vshPrint(ctl, "%s", base64);
11086
    memset(base64, 0, strlen(base64));
11087
    VIR_FREE(base64);
E
Eric Blake 已提交
11088
    ret = true;
11089 11090 11091 11092 11093 11094 11095 11096 11097 11098

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
11099 11100
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
11101 11102 11103 11104
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
11105
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
11106 11107 11108
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11109
static bool
11110 11111 11112
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
11113
    bool ret = false;
11114
    const char *uuid;
11115

11116
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11117
        return false;
11118 11119 11120

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
11121
        return false;
11122 11123

    if (virSecretUndefine(secret) < 0) {
11124
        vshError(ctl, _("Failed to delete secret %s"), uuid);
11125 11126 11127
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
11128
    ret = true;
11129 11130 11131 11132 11133 11134 11135 11136 11137 11138

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
11139 11140
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
11141 11142 11143
    {NULL, NULL}
};

E
Eric Blake 已提交
11144
static bool
11145 11146 11147 11148 11149
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

11150
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11151
        return false;
11152 11153 11154

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
11155
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
11156
        return false;
11157 11158 11159 11160 11161
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
11162
        vshError(ctl, "%s", _("Failed to list secrets"));
11163
        VIR_FREE(uuids);
E
Eric Blake 已提交
11164
        return false;
11165 11166 11167 11168
    }

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

11169 11170
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
11171 11172

    for (i = 0; i < maxuuids; i++) {
11173 11174 11175 11176
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
11177
            VIR_FREE(uuids[i]);
11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195
            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);
11196
        VIR_FREE(uuids[i]);
11197
    }
11198
    VIR_FREE(uuids);
E
Eric Blake 已提交
11199
    return true;
11200
}
11201 11202 11203 11204 11205


/*
 * "version" command
 */
11206
static const vshCmdInfo info_version[] = {
11207 11208
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
11209 11210 11211
    {NULL, NULL}
};

11212 11213 11214 11215
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
11216

E
Eric Blake 已提交
11217
static bool
11218
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11219 11220 11221 11222 11223 11224
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
11225
    unsigned long daemonVersion;
11226 11227 11228 11229 11230
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

11231
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11232
        return false;
11233 11234 11235

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
11236
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
11237
        return false;
11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249
    }

    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) {
11250
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
11251
        return false;
11252 11253 11254 11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268
    }
    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) {
11269
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
11270
        return false;
11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283
    }
    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);
    }
11284 11285 11286 11287 11288 11289 11290 11291 11292 11293 11294 11295 11296 11297 11298

    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 已提交
11299
    return true;
11300 11301
}

11302 11303 11304 11305
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
11306
    {"help", N_("enumerate devices on this host")},
11307
    {"desc", ""},
11308 11309 11310 11311
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
11312 11313
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
11314 11315 11316
    {NULL, 0, 0, NULL}
};

11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338
#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] = '-';
11339 11340
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
11341 11342 11343
    }

    /* Print this device */
11344
    vshPrint(ctl, "%s", indentBuf);
11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 11360 11361 11362 11363 11364 11365 11366 11367
    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) {
11368
        vshPrint(ctl, "%s", indentBuf);
11369
        vshPrint(ctl, " |\n");
11370 11371 11372 11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391
    }

    /* 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) {
11392
        vshPrint(ctl, "%s", indentBuf);
11393 11394 11395 11396
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
11397
static bool
11398 11399
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
11400
    const char *cap = NULL;
11401
    char **devices;
11402
    int num_devices, i;
11403
    int tree = vshCommandOptBool(cmd, "tree");
11404

11405
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11406
        return false;
11407

11408
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
11409 11410 11411 11412
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
11413
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
11414
        return false;
11415
    } else if (num_devices == 0) {
E
Eric Blake 已提交
11416
        return true;
11417 11418 11419 11420 11421 11422
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
11423
        vshError(ctl, "%s", _("Failed to list node devices"));
11424
        VIR_FREE(devices);
E
Eric Blake 已提交
11425
        return false;
11426
    }
11427
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
11428 11429 11430 11431 11432 11433 11434
    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 已提交
11435
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454
            } 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++) {
11455 11456
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
11457
        }
11458
        VIR_FREE(parents);
11459 11460 11461
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
11462
            VIR_FREE(devices[i]);
11463
        }
11464
    }
11465
    VIR_FREE(devices);
E
Eric Blake 已提交
11466
    return true;
11467 11468 11469 11470 11471 11472
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
11473 11474
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
11475 11476 11477 11478 11479
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
11480
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
11481 11482 11483
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11484
static bool
11485 11486
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
11487
    const char *name = NULL;
11488
    virNodeDevicePtr device;
L
Laine Stump 已提交
11489
    char *xml;
11490

11491
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11492
        return false;
11493
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
11494
        return false;
11495
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
11496
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
11497
        return false;
11498 11499
    }

L
Laine Stump 已提交
11500 11501 11502
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
11503
        return false;
L
Laine Stump 已提交
11504 11505 11506
    }

    vshPrint(ctl, "%s\n", xml);
11507
    VIR_FREE(xml);
11508
    virNodeDeviceFree(device);
E
Eric Blake 已提交
11509
    return true;
11510 11511
}

11512 11513 11514 11515
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
11516 11517
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
11518 11519 11520 11521 11522
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
11523
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
11524 11525 11526
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11527
static bool
11528 11529
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
11530
    const char *name = NULL;
11531
    virNodeDevicePtr device;
E
Eric Blake 已提交
11532
    bool ret = true;
11533

11534
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11535
        return false;
11536
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
11537
        return false;
11538
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
11539
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
11540
        return false;
11541 11542 11543 11544 11545
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
11546
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
11547
        ret = false;
11548 11549 11550 11551 11552 11553 11554 11555 11556
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
11557 11558
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
11559 11560 11561 11562 11563
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
11564
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
11565 11566 11567
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11568
static bool
11569 11570
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
11571
    const char *name = NULL;
11572
    virNodeDevicePtr device;
E
Eric Blake 已提交
11573
    bool ret = true;
11574

11575
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11576
        return false;
11577
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
11578
        return false;
11579
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
11580
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
11581
        return false;
11582 11583 11584 11585 11586
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
11587
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
11588
        ret = false;
11589 11590 11591 11592 11593 11594 11595 11596 11597
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
11598 11599
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
11600 11601 11602 11603 11604
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
11605
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
11606 11607 11608
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11609
static bool
11610 11611
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
11612
    const char *name = NULL;
11613
    virNodeDevicePtr device;
E
Eric Blake 已提交
11614
    bool ret = true;
11615

11616
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11617
        return false;
11618
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
11619
        return false;
11620
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
11621
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
11622
        return false;
11623 11624 11625 11626 11627
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
11628
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
11629
        ret = false;
11630 11631 11632 11633 11634
    }
    virNodeDeviceFree(device);
    return ret;
}

11635
/*
E
Eric Blake 已提交
11636
 * "hostname" command
11637
 */
11638
static const vshCmdInfo info_hostname[] = {
11639
    {"help", N_("print the hypervisor hostname")},
11640
    {"desc", ""},
11641 11642 11643
    {NULL, NULL}
};

E
Eric Blake 已提交
11644
static bool
11645
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11646 11647 11648
{
    char *hostname;

11649
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11650
        return false;
11651 11652 11653

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
11654
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
11655
        return false;
11656 11657 11658
    }

    vshPrint (ctl, "%s\n", hostname);
11659
    VIR_FREE(hostname);
11660

E
Eric Blake 已提交
11661
    return true;
11662 11663 11664 11665 11666
}

/*
 * "uri" command
 */
11667
static const vshCmdInfo info_uri[] = {
11668
    {"help", N_("print the hypervisor canonical URI")},
11669
    {"desc", ""},
11670 11671 11672
    {NULL, NULL}
};

E
Eric Blake 已提交
11673
static bool
11674
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11675 11676 11677
{
    char *uri;

11678
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11679
        return false;
11680 11681 11682

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
11683
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
11684
        return false;
11685 11686 11687
    }

    vshPrint (ctl, "%s\n", uri);
11688
    VIR_FREE(uri);
11689

E
Eric Blake 已提交
11690
    return true;
11691 11692
}

E
Eric Blake 已提交
11693 11694 11695 11696 11697 11698 11699 11700 11701 11702
/*
 * "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 已提交
11703
static bool
E
Eric Blake 已提交
11704 11705 11706 11707 11708
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11709
        return false;
E
Eric Blake 已提交
11710 11711 11712 11713

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
11714
        return false;
E
Eric Blake 已提交
11715 11716 11717 11718 11719
    }

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

E
Eric Blake 已提交
11720
    return true;
E
Eric Blake 已提交
11721 11722
}

11723 11724 11725
/*
 * "vncdisplay" command
 */
11726
static const vshCmdInfo info_vncdisplay[] = {
11727 11728
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
11729 11730 11731
    {NULL, NULL}
};

11732
static const vshCmdOptDef opts_vncdisplay[] = {
11733
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11734 11735 11736
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11737
static bool
11738
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
11739 11740 11741 11742 11743
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
11744
    bool ret = false;
11745 11746 11747
    int port = 0;
    char *doc;

11748
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11749
        return false;
11750

J
Jim Meyering 已提交
11751
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
11752
        return false;
11753 11754 11755 11756 11757

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11758
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
11759
    VIR_FREE(doc);
11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774
    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) ||
11775
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
11776 11777 11778 11779 11780 11781
        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 已提交
11782
    ret = true;
11783 11784 11785 11786

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
11787
    xmlFreeDoc(xml);
11788 11789 11790 11791 11792 11793 11794
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
11795
static const vshCmdInfo info_ttyconsole[] = {
11796 11797
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
11798 11799 11800
    {NULL, NULL}
};

11801
static const vshCmdOptDef opts_ttyconsole[] = {
11802
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11803 11804 11805
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11806
static bool
11807
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
11808 11809 11810 11811 11812
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
11813
    bool ret = false;
11814 11815
    char *doc;

11816
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11817
        return false;
11818

J
Jim Meyering 已提交
11819
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
11820
        return false;
11821 11822 11823 11824 11825

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

11826
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
11827
    VIR_FREE(doc);
11828 11829 11830 11831 11832 11833 11834 11835 11836
    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 已提交
11837
    ret = true;
11838 11839 11840 11841

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
11842
    xmlFreeDoc(xml);
11843 11844 11845 11846 11847 11848
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
11849
 */
11850
static const vshCmdInfo info_attach_device[] = {
11851 11852
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
11853 11854 11855
    {NULL, NULL}
};

11856
static const vshCmdOptDef opts_attach_device[] = {
11857 11858 11859
    {"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")},
11860 11861 11862
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11863
static bool
11864
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
11865 11866
{
    virDomainPtr dom;
11867
    const char *from = NULL;
11868
    char *buffer;
W
Wen Congyang 已提交
11869
    int ret;
J
Jim Fehlig 已提交
11870
    unsigned int flags;
11871

11872
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11873
        return false;
11874

J
Jim Meyering 已提交
11875
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
11876
        return false;
11877

11878
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11879
        virDomainFree(dom);
E
Eric Blake 已提交
11880
        return false;
11881 11882
    }

11883
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11884
        virshReportError(ctl);
11885
        virDomainFree(dom);
E
Eric Blake 已提交
11886
        return false;
11887
    }
11888

J
Jim Fehlig 已提交
11889
    if (vshCommandOptBool(cmd, "persistent")) {
11890
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
11891
        if (virDomainIsActive(dom) == 1)
11892
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
11893 11894 11895 11896
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
11897
    VIR_FREE(buffer);
11898 11899

    if (ret < 0) {
11900
        vshError(ctl, _("Failed to attach device from %s"), from);
11901
        virDomainFree(dom);
E
Eric Blake 已提交
11902
        return false;
11903
    } else {
J
Jim Meyering 已提交
11904
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
11905 11906 11907
    }

    virDomainFree(dom);
E
Eric Blake 已提交
11908
    return true;
11909 11910
}

11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926
/**
 * 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 已提交
11927
    long n1_child_size, n2_child_size, n1_iter;
11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955
    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 已提交
11956 11957 11958 11959
    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)
11960 11961
        return false;

11962 11963 11964
    if (n1_child_size == 0 && n2_child_size == 0)
        return true;

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 12151 12152 12153 12154
    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;
}
12155 12156 12157 12158

/*
 * "detach-device" command
 */
12159
static const vshCmdInfo info_detach_device[] = {
12160 12161
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
12162 12163 12164
    {NULL, NULL}
};

12165
static const vshCmdOptDef opts_detach_device[] = {
12166 12167 12168
    {"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")},
12169 12170 12171
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12172
static bool
12173
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
12174
{
12175
    virDomainPtr dom = NULL;
12176
    const char *from = NULL;
12177
    char *buffer = NULL, *new_buffer = NULL;
W
Wen Congyang 已提交
12178
    int ret;
12179
    bool funcRet = false;
J
Jim Fehlig 已提交
12180
    unsigned int flags;
12181

12182
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12183
        return false;
12184

J
Jim Meyering 已提交
12185
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
12186
        return false;
12187

12188 12189
    if (vshCommandOptString(cmd, "file", &from) <= 0)
        goto cleanup;
12190

12191
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
12192
        virshReportError(ctl);
12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203 12204 12205 12206 12207
        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;
12208
    }
12209

J
Jim Fehlig 已提交
12210
    if (vshCommandOptBool(cmd, "persistent")) {
12211
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
12212
        if (virDomainIsActive(dom) == 1)
12213
           flags |= VIR_DOMAIN_AFFECT_LIVE;
12214
        ret = virDomainDetachDeviceFlags(dom, new_buffer, flags);
J
Jim Fehlig 已提交
12215
    } else {
12216
        ret = virDomainDetachDevice(dom, new_buffer);
J
Jim Fehlig 已提交
12217
    }
12218 12219

    if (ret < 0) {
12220
        vshError(ctl, _("Failed to detach device from %s"), from);
12221
        goto cleanup;
12222 12223
    }

12224 12225 12226 12227 12228 12229
    vshPrint(ctl, "%s", _("Device detached successfully\n"));
    funcRet = true;

cleanup:
    VIR_FREE(new_buffer);
    VIR_FREE(buffer);
12230
    virDomainFree(dom);
12231
    return funcRet;
12232 12233
}

12234

12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247
/*
 * "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")},
12248
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
12249 12250 12251
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12252
static bool
12253 12254 12255
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
12256
    const char *from = NULL;
12257
    char *buffer;
W
Wen Congyang 已提交
12258
    int ret;
12259 12260
    unsigned int flags;

12261
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12262
        return false;
12263 12264

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

12267
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
12268
        virDomainFree(dom);
E
Eric Blake 已提交
12269
        return false;
12270 12271 12272
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
12273
        virshReportError(ctl);
12274
        virDomainFree(dom);
E
Eric Blake 已提交
12275
        return false;
12276 12277 12278
    }

    if (vshCommandOptBool(cmd, "persistent")) {
12279
        flags = VIR_DOMAIN_AFFECT_CONFIG;
12280
        if (virDomainIsActive(dom) == 1)
12281
           flags |= VIR_DOMAIN_AFFECT_LIVE;
12282
    } else {
12283
        flags = VIR_DOMAIN_AFFECT_LIVE;
12284
    }
12285 12286 12287 12288

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

12289 12290 12291 12292 12293 12294
    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 已提交
12295
        return false;
12296 12297 12298 12299 12300
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
12301
    return true;
12302 12303 12304
}


12305 12306 12307
/*
 * "attach-interface" command
 */
12308
static const vshCmdInfo info_attach_interface[] = {
12309 12310
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
12311 12312 12313
    {NULL, NULL}
};

12314
static const vshCmdOptDef opts_attach_interface[] = {
12315 12316 12317 12318 12319 12320
    {"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")},
12321
    {"model", VSH_OT_DATA, 0, N_("model type")},
12322
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
12323 12324
    {"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")},
12325 12326 12327
    {NULL, 0, 0, NULL}
};

12328 12329 12330
/* 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. */
12331
static int parseRateStr(const char *rateStr, virNetDevBandwidthRatePtr rate)
12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 12345 12346 12347 12348 12349 12350 12351 12352 12353 12354 12355 12356 12357 12358 12359 12360 12361 12362
{
    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 已提交
12363
static bool
12364
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
12365 12366
{
    virDomainPtr dom = NULL;
12367
    const char *mac = NULL, *target = NULL, *script = NULL,
12368 12369
                *type = NULL, *source = NULL, *model = NULL,
                *inboundStr = NULL, *outboundStr = NULL;
12370
    virNetDevBandwidthRate inbound, outbound;
E
Eric Blake 已提交
12371
    int typ;
W
Wen Congyang 已提交
12372 12373
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
12374
    unsigned int flags;
12375 12376
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
12377

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

J
Jim Meyering 已提交
12381
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
12382 12383
        goto cleanup;

12384
    if (vshCommandOptString(cmd, "type", &type) <= 0)
12385 12386
        goto cleanup;

12387 12388 12389 12390
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
12391 12392 12393
        vshCommandOptString(cmd, "model", &model) < 0 ||
        vshCommandOptString(cmd, "inbound", &inboundStr) < 0 ||
        vshCommandOptString(cmd, "outbound", &outboundStr) < 0) {
12394
        vshError(ctl, "missing argument");
12395
        goto cleanup;
12396
    }
12397 12398

    /* check interface type */
12399
    if (STREQ(type, "network")) {
12400
        typ = 1;
12401
    } else if (STREQ(type, "bridge")) {
12402 12403
        typ = 2;
    } else {
E
Eric Blake 已提交
12404 12405
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
12406 12407 12408
        goto cleanup;
    }

12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431
    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;
        }
    }

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

12435
    if (typ == 1)
12436
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
12437
    else if (typ == 2)
12438
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
12439

12440
    if (target != NULL)
12441
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
12442
    if (mac != NULL)
12443
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
12444
    if (script != NULL)
12445
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
12446
    if (model != NULL)
12447
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
12448

12449 12450 12451 12452 12453 12454 12455 12456 12457 12458 12459 12460 12461 12462 12463 12464 12465 12466 12467 12468 12469
    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");
    }

12470
    virBufferAddLit(&buf, "</interface>\n");
12471

12472 12473
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
12474
        goto cleanup;
12475 12476
    }

12477
    xml = virBufferContentAndReset(&buf);
12478

J
Jim Fehlig 已提交
12479
    if (vshCommandOptBool(cmd, "persistent")) {
12480
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
12481
        if (virDomainIsActive(dom) == 1)
12482
            flags |= VIR_DOMAIN_AFFECT_LIVE;
12483
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
12484
    } else {
12485
        ret = virDomainAttachDevice(dom, xml);
12486
    }
12487

12488 12489
    VIR_FREE(xml);

J
Jim Fehlig 已提交
12490
    if (ret != 0) {
L
Laine Stump 已提交
12491
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
12492 12493
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
12494
        functionReturn = true;
J
Jim Fehlig 已提交
12495
    }
12496 12497 12498 12499

 cleanup:
    if (dom)
        virDomainFree(dom);
12500
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
12501
    return functionReturn;
12502 12503 12504 12505 12506
}

/*
 * "detach-interface" command
 */
12507
static const vshCmdInfo info_detach_interface[] = {
12508 12509
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
12510 12511 12512
    {NULL, NULL}
};

12513
static const vshCmdOptDef opts_detach_interface[] = {
12514 12515 12516 12517
    {"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")},
12518 12519 12520
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12521
static bool
12522
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
12523 12524 12525 12526 12527 12528 12529
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
12530
    const char *mac =NULL, *type = NULL;
12531
    char *doc;
12532
    char buf[64];
E
Eric Blake 已提交
12533
    int i = 0, diff_mac;
W
Wen Congyang 已提交
12534 12535
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
12536
    unsigned int flags;
12537

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

J
Jim Meyering 已提交
12541
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
12542 12543
        goto cleanup;

12544
    if (vshCommandOptString(cmd, "type", &type) <= 0)
12545 12546
        goto cleanup;

12547 12548
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
12549
        goto cleanup;
12550
    }
12551 12552 12553 12554 12555

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

12556
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
12557
    VIR_FREE(doc);
12558
    if (!xml) {
12559
        vshError(ctl, "%s", _("Failed to get interface information"));
12560 12561 12562
        goto cleanup;
    }

E
Eric Blake 已提交
12563
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
12564 12565 12566
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
12567
        vshError(ctl, _("No found interface whose type is %s"), type);
12568 12569 12570
        goto cleanup;
    }

12571 12572 12573 12574 12575 12576
    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;
    }

12577 12578 12579 12580 12581 12582 12583
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
12584 12585 12586 12587 12588
            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);
12589 12590 12591 12592 12593 12594 12595
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
12596
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
12597 12598 12599 12600 12601
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
12602
        vshError(ctl, "%s", _("Failed to allocate memory"));
12603 12604 12605
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
12611
    if (vshCommandOptBool(cmd, "persistent")) {
12612
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
12613
        if (virDomainIsActive(dom) == 1)
12614
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
12615 12616 12617 12618 12619 12620 12621 12622
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
12623
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
12624
    } else {
J
Jim Meyering 已提交
12625
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
12626
        functionReturn = true;
12627
    }
12628 12629 12630 12631

 cleanup:
    if (dom)
        virDomainFree(dom);
12632
    xmlXPathFreeObject(obj);
12633
    xmlXPathFreeContext(ctxt);
12634 12635
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
12636
    return functionReturn;
12637 12638 12639 12640 12641
}

/*
 * "attach-disk" command
 */
12642
static const vshCmdInfo info_attach_disk[] = {
12643 12644
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
12645 12646 12647
    {NULL, NULL}
};

12648
static const vshCmdOptDef opts_attach_disk[] = {
12649
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
12650 12651
    {"source",  VSH_OT_DATA, VSH_OFLAG_REQ | VSH_OFLAG_EMPTY_OK,
     N_("source of disk device")},
12652 12653 12654
    {"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")},
12655
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
12656 12657 12658
    {"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")},
12659
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
12660 12661 12662
    {"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")},
12663 12664 12665
    {NULL, 0, 0, NULL}
};

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 12809 12810 12811 12812
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 已提交
12813
static bool
12814
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
12815 12816
{
    virDomainPtr dom = NULL;
12817
    const char *source = NULL, *target = NULL, *driver = NULL,
12818 12819 12820
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
12821 12822
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
12823
    unsigned int flags;
12824
    const char *stype = NULL;
12825 12826
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
12827

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

J
Jim Meyering 已提交
12831
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
12832 12833
        goto cleanup;

12834
    if (vshCommandOptString(cmd, "source", &source) <= 0)
12835
        goto cleanup;
12836 12837 12838 12839
    /* Allow empty string as a placeholder that implies no source, for
     * use in adding a cdrom drive with no disk.  */
    if (!*source)
        source = NULL;
12840

12841
    if (vshCommandOptString(cmd, "target", &target) <= 0)
12842 12843
        goto cleanup;

12844 12845 12846 12847
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
12848 12849 12850
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
12851
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
12852
        vshError(ctl, "%s", _("missing option"));
12853 12854
        goto cleanup;
    }
12855

12856 12857
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
12858
            isFile = true;
12859
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
12860
        isFile = true;
12861 12862 12863
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
12864 12865 12866
    }

    if (mode) {
12867
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
12868 12869
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
12870 12871 12872 12873 12874
            goto cleanup;
        }
    }

    /* Make XML of disk */
12875
    virBufferAsprintf(&buf, "<disk type='%s'",
12876 12877
                      (isFile) ? "file" : "block");
    if (type)
12878
        virBufferAsprintf(&buf, " device='%s'", type);
12879 12880
    virBufferAddLit(&buf, ">\n");

12881
    if (driver || subdriver)
12882
        virBufferAsprintf(&buf, "  <driver");
12883 12884

    if (driver)
12885
        virBufferAsprintf(&buf, " name='%s'", driver);
12886
    if (subdriver)
12887
        virBufferAsprintf(&buf, " type='%s'", subdriver);
12888 12889
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
12890

12891
    if (driver || subdriver || cache)
12892
        virBufferAddLit(&buf, "/>\n");
12893

12894 12895 12896 12897
    if (source)
        virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
                          (isFile) ? "file" : "dev",
                          source);
12898
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
12899
    if (mode)
12900
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
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 12946 12947 12948 12949
    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;
            }
        }
    }

12950
    virBufferAddLit(&buf, "</disk>\n");
12951

12952 12953
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
12954
        return false;
12955 12956
    }

12957
    xml = virBufferContentAndReset(&buf);
12958

J
Jim Fehlig 已提交
12959
    if (vshCommandOptBool(cmd, "persistent")) {
12960
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
12961
        if (virDomainIsActive(dom) == 1)
12962
            flags |= VIR_DOMAIN_AFFECT_LIVE;
12963
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
12964
    } else {
12965
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
12966
    }
12967

12968 12969
    VIR_FREE(xml);

J
Jim Fehlig 已提交
12970
    if (ret != 0) {
L
Laine Stump 已提交
12971
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
12972 12973
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
12974
        functionReturn = true;
J
Jim Fehlig 已提交
12975
    }
12976 12977 12978 12979

 cleanup:
    if (dom)
        virDomainFree(dom);
12980
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
12981
    return functionReturn;
12982 12983 12984 12985 12986
}

/*
 * "detach-disk" command
 */
12987
static const vshCmdInfo info_detach_disk[] = {
12988 12989
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
12990 12991 12992
    {NULL, NULL}
};

12993
static const vshCmdOptDef opts_detach_disk[] = {
12994 12995 12996
    {"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")},
12997 12998 12999
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13000
static bool
13001
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
13002 13003 13004 13005 13006 13007 13008
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
13009
    const char *target = NULL;
13010
    char *doc;
E
Eric Blake 已提交
13011
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
13012 13013
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
13014
    unsigned int flags;
13015

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

J
Jim Meyering 已提交
13019
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
13020 13021
        goto cleanup;

13022
    if (vshCommandOptString(cmd, "target", &target) <= 0)
13023 13024 13025 13026 13027 13028
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

13029
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
13030
    VIR_FREE(doc);
13031
    if (!xml) {
13032
        vshError(ctl, "%s", _("Failed to get disk information"));
13033 13034 13035 13036 13037 13038
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
13039
        vshError(ctl, "%s", _("Failed to get disk information"));
13040 13041 13042 13043 13044 13045 13046
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
13047 13048 13049 13050 13051
            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);
13052 13053 13054 13055 13056 13057 13058
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
13059
    vshError(ctl, _("No found disk whose target is %s"), target);
13060 13061 13062 13063 13064
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
13065
        vshError(ctl, "%s", _("Failed to allocate memory"));
13066 13067 13068
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
13074
    if (vshCommandOptBool(cmd, "persistent")) {
13075
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
13076
        if (virDomainIsActive(dom) == 1)
13077
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
13078 13079 13080 13081 13082 13083 13084 13085
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
13086
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
13087
    } else {
J
Jim Meyering 已提交
13088
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
13089
        functionReturn = true;
13090
    }
13091 13092

 cleanup:
13093
    xmlXPathFreeObject(obj);
13094
    xmlXPathFreeContext(ctxt);
13095 13096
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
13097 13098
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
13099
    return functionReturn;
13100 13101
}

13102 13103 13104 13105
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
13106 13107
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
13108 13109 13110 13111
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
13112
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
13113 13114 13115
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13116
static bool
13117 13118
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
13119
    const char *from = NULL;
13120
    bool ret = false;
13121 13122
    char *buffer;
    int result;
13123 13124 13125 13126 13127 13128
    const char *snippet;

    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlBufferPtr xml_buf = NULL;
    xmlNodePtr node;
13129

13130
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13131
        return false;
13132

13133
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
13134
        return false;
13135

13136 13137 13138
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
        vshError(ctl, _("Failed to read file '%s' to compare"),
                 from);
E
Eric Blake 已提交
13139
        return false;
13140
    }
13141

13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166
    /* 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);
13167 13168 13169 13170 13171

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
13172
        goto cleanup;
13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187
        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);
13188
        goto cleanup;
13189 13190
    }

13191 13192 13193 13194 13195 13196 13197 13198
    ret = true;

cleanup:
    VIR_FREE(buffer);
    xmlBufferFree(xml_buf);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);

13199 13200 13201
    return ret;
}

13202 13203 13204 13205
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
13206 13207
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
13208 13209 13210 13211
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
13212
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
13213 13214 13215
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13216
static bool
13217 13218
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
13219
    const char *from = NULL;
13220
    bool ret = false;
13221 13222 13223
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
13224 13225 13226 13227
    int count = 0;

    xmlDocPtr xml = NULL;
    xmlNodePtr *node_list = NULL;
13228
    xmlXPathContextPtr ctxt = NULL;
13229 13230 13231
    xmlBufferPtr xml_buf = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    int i;
13232

13233
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13234
        return false;
13235

13236
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
13237
        return false;
13238 13239

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

E
Eric Blake 已提交
13242
    /* add a separate container around the xml */
13243 13244
    virBufferStrcat(&buf, "<container>", buffer, "</container>", NULL);
    if (virBufferError(&buf))
13245 13246
        goto no_memory;

13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259
    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);
13260 13261 13262
        goto cleanup;
    }

13263
    list = vshCalloc(ctl, count, sizeof(const char *));
13264

13265
    if (!(xml_buf = xmlBufferCreate()))
13266 13267
        goto no_memory;

13268 13269
    for (i = 0; i < count; i++) {
        xmlBufferEmpty(xml_buf);
13270

13271 13272 13273
        if (xmlNodeDump(xml_buf, xml,  node_list[i], 0, 0) < 0) {
            vshError(ctl, _("Failed to extract <cpu> element"));
            goto cleanup;
13274 13275
        }

13276
        list[i] = vshStrdup(ctl, (const char *)xmlBufferContent(xml_buf));
13277 13278 13279 13280
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

13281
    if (result) {
13282
        vshPrint(ctl, "%s", result);
13283 13284
        ret = true;
    }
13285 13286 13287

cleanup:
    xmlXPathFreeContext(ctxt);
13288 13289
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
13290 13291
    VIR_FREE(result);
    if ((list != NULL) && (count > 0)) {
13292
        for (i = 0; i < count; i++)
13293 13294 13295 13296 13297 13298 13299 13300 13301
            VIR_FREE(list[i]);
    }
    VIR_FREE(list);
    VIR_FREE(buffer);

    return ret;

no_memory:
    vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
13302
    ret = false;
13303
    goto cleanup;
13304 13305
}

13306 13307 13308 13309 13310 13311 13312 13313
/* 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;

13314
    ret = vshMalloc(ctl, PATH_MAX);
13315 13316 13317

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
13318 13319
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
13320
    if (fd == -1) {
13321
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
13322
                 strerror(errno));
13323
        VIR_FREE(ret);
13324 13325 13326 13327
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
13328 13329
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
13330
        VIR_FORCE_CLOSE(fd);
13331
        unlink (ret);
13332
        VIR_FREE(ret);
13333 13334
        return NULL;
    }
S
Stefan Berger 已提交
13335
    if (VIR_CLOSE(fd) < 0) {
13336 13337
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
13338
        unlink (ret);
13339
        VIR_FREE(ret);
13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354
        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 已提交
13355 13356 13357 13358
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
13359

13360
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
13361 13362 13363 13364
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
13365

13366 13367 13368 13369 13370
    /* 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 已提交
13371 13372
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
13373
     */
E
Eric Blake 已提交
13374 13375 13376 13377 13378 13379 13380 13381 13382 13383 13384 13385
    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);
13386 13387
    }

E
Eric Blake 已提交
13388 13389 13390 13391 13392 13393 13394
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
13395
    }
E
Eric Blake 已提交
13396
    ret = 0;
13397

E
Eric Blake 已提交
13398 13399 13400
cleanup:
    virCommandFree(cmd);
    return ret;
13401 13402 13403 13404 13405 13406 13407 13408
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
13409
        vshError(ctl,
13410
                 _("%s: failed to read temporary file: %s"),
13411
                 filename, strerror(errno));
13412 13413 13414 13415 13416
        return NULL;
    }
    return ret;
}

13417

P
Paolo Bonzini 已提交
13418 13419 13420 13421
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
13422 13423
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
13424 13425 13426 13427
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
13428
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
13429 13430 13431
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13432
static bool
13433
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
13434
{
13435
    const char *dir = NULL;
13436
    char *dir_malloced = NULL;
E
Eric Blake 已提交
13437
    bool ret = true;
P
Paolo Bonzini 已提交
13438 13439

    if (!ctl->imode) {
13440
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
13441
        return false;
P
Paolo Bonzini 已提交
13442 13443
    }

13444
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
13445
        uid_t uid = geteuid();
13446
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
13447 13448 13449 13450
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
13451
    if (chdir(dir) == -1) {
13452
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
13453
        ret = false;
P
Paolo Bonzini 已提交
13454 13455
    }

13456
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
13457
    return ret;
P
Paolo Bonzini 已提交
13458 13459 13460 13461 13462 13463
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
13464 13465
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
13466 13467 13468
    {NULL, NULL}
};

E
Eric Blake 已提交
13469
static bool
P
Paolo Bonzini 已提交
13470 13471 13472
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
13473
    bool ret = true;
P
Paolo Bonzini 已提交
13474

13475 13476
    cwd = getcwd(NULL, 0);
    if (!cwd) {
13477 13478
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
13479 13480
        ret = false;
    } else {
P
Paolo Bonzini 已提交
13481
        vshPrint (ctl, _("%s\n"), cwd);
13482 13483
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
13484

13485
    return ret;
P
Paolo Bonzini 已提交
13486 13487
}

E
Eric Blake 已提交
13488 13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 13499
/*
 * "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")},
13500
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
13501 13502 13503 13504 13505 13506
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
13507
static bool
13508
cmdEcho (vshControl *ctl, const vshCmd *cmd)
E
Eric Blake 已提交
13509 13510 13511 13512
{
    bool shell = false;
    bool xml = false;
    int count = 0;
13513
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
13514 13515 13516 13517 13518 13519 13520 13521
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

13522
    while ((opt = vshCommandOptArgv(cmd, opt))) {
13523 13524
        char *str;
        virBuffer xmlbuf = VIR_BUFFER_INITIALIZER;
E
Eric Blake 已提交
13525

13526
        arg = opt->data;
13527

E
Eric Blake 已提交
13528 13529
        if (count)
            virBufferAddChar(&buf, ' ');
13530

E
Eric Blake 已提交
13531
        if (xml) {
13532 13533 13534 13535
            virBufferEscapeString(&xmlbuf, "%s", arg);
            if (virBufferError(&buf)) {
                vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
                return false;
E
Eric Blake 已提交
13536
            }
13537 13538 13539
            str = virBufferContentAndReset(&xmlbuf);
        } else {
            str = vshStrdup(ctl, arg);
E
Eric Blake 已提交
13540
        }
13541 13542 13543 13544 13545

        if (shell)
            virBufferEscapeShell(&buf, str);
        else
            virBufferAdd(&buf, str, -1);
E
Eric Blake 已提交
13546
        count++;
13547
        VIR_FREE(str);
E
Eric Blake 已提交
13548 13549 13550 13551
    }

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
13552
        return false;
E
Eric Blake 已提交
13553 13554 13555 13556 13557
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
13558
    return true;
E
Eric Blake 已提交
13559 13560
}

13561 13562 13563 13564
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
13565 13566
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
13567 13568 13569 13570
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
13571
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
13572 13573 13574 13575 13576 13577
    {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 已提交
13578
static bool
13579 13580
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
13581
    bool ret = false;
13582 13583 13584 13585 13586
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
13587
    unsigned int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
13588

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

J
Jim Meyering 已提交
13592
    dom = vshCommandOptDomain (ctl, cmd, NULL);
13593 13594 13595 13596
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
13597
    doc = virDomainGetXMLDesc (dom, flags);
13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615
    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 已提交
13616
        ret = true;
13617 13618 13619 13620 13621 13622 13623
        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.
     */
13624
    doc_reread = virDomainGetXMLDesc (dom, flags);
13625 13626 13627 13628
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
13629 13630
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641 13642
        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 已提交
13643
    ret = true;
13644 13645 13646 13647 13648

 cleanup:
    if (dom)
        virDomainFree (dom);

13649 13650 13651
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
13652 13653 13654

    if (tmp) {
        unlink (tmp);
13655
        VIR_FREE(tmp);
13656 13657 13658 13659 13660
    }

    return ret;
}

13661

13662 13663 13664 13665
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
13666 13667
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
13668 13669 13670 13671
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
13672
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
13673 13674 13675 13676 13677 13678 13679 13680 13681 13682
    {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[] = {
13683 13684
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
13685 13686 13687 13688
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
13689
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
13690 13691 13692 13693 13694 13695
    {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 已提交
13696 13697 13698
/*
 * "quit" command
 */
13699
static const vshCmdInfo info_quit[] = {
13700
    {"help", N_("quit this interactive terminal")},
13701
    {"desc", ""},
13702
    {NULL, NULL}
K
Karel Zak 已提交
13703 13704
};

E
Eric Blake 已提交
13705
static bool
13706
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
13707
{
E
Eric Blake 已提交
13708 13709
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
13710 13711
}

13712 13713 13714 13715 13716 13717 13718
/* 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;
13719
    bool halt = false;
13720 13721 13722
    char *doc = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
E
Eric Blake 已提交
13723
    const char *name = NULL;
13724 13725

    snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749

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

13750 13751 13752
    if (snapshot == NULL)
        goto cleanup;

13753 13754 13755 13756 13757
    if (halt && virDomainDestroy(dom) < 0) {
        virshReportError(ctl);
        goto cleanup;
    }

E
Eric Blake 已提交
13758
    name = virDomainSnapshotGetName(snapshot);
13759
    if (!name) {
E
Eric Blake 已提交
13760
        vshError(ctl, "%s", _("Could not get snapshot name"));
13761 13762 13763 13764 13765 13766 13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777 13778 13779
        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;
}

13780 13781 13782 13783
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
13784 13785
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
13786 13787 13788 13789 13790 13791
    {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")},
13792 13793 13794
    {"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")},
13795
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
13796
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
13797 13798 13799
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13800
static bool
13801 13802 13803
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
13804
    bool ret = false;
13805
    const char *from = NULL;
13806
    char *buffer = NULL;
13807 13808 13809 13810 13811 13812 13813 13814
    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;
13815 13816
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
13817 13818
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
13819

13820
    if (!vshConnectionUsability(ctl, ctl->conn))
13821 13822 13823 13824 13825 13826
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

13827
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
13828
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843
    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;
    }

13844
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, from);
13845 13846 13847 13848 13849 13850 13851 13852 13853

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

13854 13855 13856
/*
 * "snapshot-create-as" command
 */
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 13909 13910 13911 13912
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;
}

13913 13914 13915 13916 13917 13918 13919 13920 13921 13922
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 已提交
13923
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
13924
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
13925
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
13926 13927 13928
    {"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]")},
13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940
    {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;
13941
    unsigned int flags = 0;
13942
    const vshCmdOpt *opt = NULL;
13943 13944 13945

    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
13946 13947
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
13948 13949
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962 13963 13964 13965

    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)
13966
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
13967
    if (desc)
13968
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
13969 13970 13971 13972 13973 13974 13975 13976 13977 13978
    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");
    }
13979 13980 13981 13982 13983 13984 13985 13986
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
13987 13988 13989 13990 13991 13992
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

13993
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, NULL);
13994 13995 13996 13997 13998 13999 14000 14001 14002

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

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 14038 14039 14040 14041
/* 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;
}

14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052
/*
 * "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")},
14053
    {"snapshotname", VSH_OT_DATA, 0, N_("snapshot name")},
14054
    {"current", VSH_OT_BOOL, 0, N_("also set edited snapshot as current")},
14055 14056
    {"rename", VSH_OT_BOOL, 0, N_("allow renaming an existing snapshot")},
    {"clone", VSH_OT_BOOL, 0, N_("allow cloning to new name")},
14057 14058 14059 14060 14061 14062 14063 14064
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotEdit(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    virDomainSnapshotPtr snapshot = NULL;
14065
    virDomainSnapshotPtr edited = NULL;
14066
    const char *name;
14067
    const char *edited_name;
14068 14069 14070 14071 14072 14073
    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;
14074 14075 14076 14077 14078 14079 14080 14081
    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;
    }
14082

14083 14084
    if (vshCommandOptBool(cmd, "current") &&
        vshCommandOptBool(cmd, "snapshotname"))
14085 14086 14087 14088 14089 14090 14091 14092 14093
        define_flags |= VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT;

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

14094 14095
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", false, dom,
                          &snapshot, &name) < 0)
14096 14097 14098 14099 14100 14101 14102
        goto cleanup;

    /* Get the XML configuration of the snapshot.  */
    doc = virDomainSnapshotGetXMLDesc(snapshot, getxml_flags);
    if (!doc)
        goto cleanup;

14103 14104 14105 14106
    /* 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;

14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 14128 14129 14130 14131
    /* 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.  */
14132 14133
    edited = virDomainSnapshotCreateXML(dom, doc_edited, define_flags);
    if (!edited) {
14134 14135 14136 14137
        vshError(ctl, _("Failed to update %s"), name);
        goto cleanup;
    }

14138 14139 14140 14141 14142 14143 14144 14145 14146 14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161
    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;
        }
    }

14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172
    ret = true;

cleanup:
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
    if (snapshot)
        virDomainSnapshotFree(snapshot);
14173 14174
    if (edited)
        virDomainSnapshotFree(edited);
14175 14176 14177 14178 14179
    if (dom)
        virDomainFree(dom);
    return ret;
}

14180 14181 14182 14183
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
14184 14185
    {"help", N_("Get or set the current snapshot")},
    {"desc", N_("Get or set the current snapshot")},
14186 14187 14188 14189 14190
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
14191
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
14192 14193
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
14194 14195
    {"snapshotname", VSH_OT_DATA, 0,
     N_("name of existing snapshot to make current")},
14196 14197 14198
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14199
static bool
14200 14201 14202
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14203
    bool ret = false;
14204 14205
    int current;
    virDomainSnapshotPtr snapshot = NULL;
14206
    char *xml = NULL;
14207
    const char *snapshotname = NULL;
14208
    unsigned int flags = 0;
14209
    const char *domname;
14210 14211 14212

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;
14213

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

14217
    dom = vshCommandOptDomain(ctl, cmd, &domname);
14218 14219 14220
    if (dom == NULL)
        goto cleanup;

14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240
    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;
14241 14242 14243
        /* 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;
14244 14245 14246 14247 14248 14249 14250 14251 14252
        snapshot2 = virDomainSnapshotCreateXML(dom, xml, flags);
        if (snapshot2 == NULL)
            goto cleanup;
        virDomainSnapshotFree(snapshot2);
        vshPrint(ctl, _("Snapshot %s set as current"), snapshotname);
        ret = true;
        goto cleanup;
    }

14253
    current = virDomainHasCurrentSnapshot(dom, 0);
14254 14255 14256 14257
    if (current < 0) {
        goto cleanup;
    } else if (!current) {
        vshError(ctl, _("domain '%s' has no current snapshot"), domname);
14258
        goto cleanup;
14259
    } else {
E
Eric Blake 已提交
14260
        const char *name = NULL;
14261 14262 14263 14264

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

14265
        if (vshCommandOptBool(cmd, "name")) {
E
Eric Blake 已提交
14266
            name = virDomainSnapshotGetName(snapshot);
14267 14268
            if (!name)
                goto cleanup;
E
Eric Blake 已提交
14269 14270 14271 14272
        } else {
            xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
            if (!xml)
                goto cleanup;
14273 14274 14275
        }

        vshPrint(ctl, "%s", name ? name : xml);
14276 14277
    }

E
Eric Blake 已提交
14278
    ret = true;
14279 14280

cleanup:
14281 14282
    if (!ret)
        virshReportError(ctl);
14283
    VIR_FREE(xml);
14284 14285 14286 14287 14288 14289 14290 14291
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

14292
/* Helper function to get the name of a snapshot's parent.  Caller
14293 14294 14295 14296 14297 14298
 * 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)
14299 14300 14301 14302 14303
{
    virDomainSnapshotPtr parent = NULL;
    char *xml = NULL;
    xmlDocPtr xmldoc = NULL;
    xmlXPathContextPtr ctxt = NULL;
14304 14305 14306
    int ret = -1;

    *parent_name = NULL;
14307 14308

    /* Try new API, since it is faster. */
14309
    if (!ctl->useSnapshotOld) {
14310 14311 14312
        parent = virDomainSnapshotGetParent(snapshot, 0);
        if (parent) {
            /* API works, and virDomainSnapshotGetName will succeed */
14313 14314
            *parent_name = vshStrdup(ctl, virDomainSnapshotGetName(parent));
            ret = 0;
14315 14316 14317 14318
            goto cleanup;
        }
        if (last_error->code == VIR_ERR_NO_DOMAIN_SNAPSHOT) {
            /* API works, and we found a root with no parent */
14319
            ret = 0;
14320 14321 14322
            goto cleanup;
        }
        /* API didn't work, fall back to XML scraping. */
14323
        ctl->useSnapshotOld = true;
14324 14325 14326 14327 14328 14329 14330 14331 14332 14333
    }

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

    xmldoc = virXMLParseStringCtxt(xml, _("(domain_snapshot)"), &ctxt);
    if (!xmldoc)
        goto cleanup;

14334 14335
    *parent_name = virXPathString("string(/domainsnapshot/parent/name)", ctxt);
    ret = 0;
14336 14337

cleanup:
14338 14339 14340 14341 14342 14343 14344
    if (ret < 0) {
        virshReportError(ctl);
        vshError(ctl, "%s", _("unable to determine if snapshot has parent"));
    } else {
        virFreeError(last_error);
        last_error = NULL;
    }
14345 14346 14347 14348 14349
    if (parent)
        virDomainSnapshotFree(parent);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xmldoc);
    VIR_FREE(xml);
14350
    return ret;
14351 14352
}

14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363
/*
 * "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")},
14364
    {"parent", VSH_OT_BOOL, 0, N_("add a column showing parent snapshot")},
14365
    {"roots", VSH_OT_BOOL, 0, N_("list only snapshots without parents")},
14366
    {"leaves", VSH_OT_BOOL, 0, N_("list only snapshots without children")},
14367 14368
    {"metadata", VSH_OT_BOOL, 0,
     N_("list only snapshots that have metadata that would prevent undefine")},
14369
    {"tree", VSH_OT_BOOL, 0, N_("list snapshots in a tree")},
14370
    {"from", VSH_OT_DATA, 0, N_("limit list to children of given snapshot")},
14371 14372
    {"current", VSH_OT_BOOL, 0,
     N_("limit list to children of current snapshot")},
14373
    {"descendants", VSH_OT_BOOL, 0, N_("with --from, list all descendants")},
14374 14375 14376
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14377
static bool
14378 14379 14380
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14381
    bool ret = false;
14382
    unsigned int flags = 0;
14383 14384
    int parent_filter = 0; /* -1 for roots filtering, 0 for no parent
                              information needed, 1 for parent column */
14385 14386
    int numsnaps;
    char **names = NULL;
14387
    char **parents = NULL;
14388
    int actual = 0;
14389 14390 14391 14392 14393 14394
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
14395
    char *parent = NULL;
14396 14397
    long long creation_longlong;
    time_t creation_time_t;
14398 14399
    char timestr[100];
    struct tm time_info;
14400
    bool tree = vshCommandOptBool(cmd, "tree");
14401
    bool leaves = vshCommandOptBool(cmd, "leaves");
14402 14403
    const char *from = NULL;
    virDomainSnapshotPtr start = NULL;
14404
    int start_index = -1;
14405
    bool descendants = false;
14406

14407 14408 14409 14410 14411 14412 14413 14414 14415 14416
    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)
14417
        goto cleanup;
14418

14419
    if (vshCommandOptBool(cmd, "parent")) {
14420 14421
        if (vshCommandOptBool(cmd, "roots")) {
            vshError(ctl, "%s",
14422
                     _("--parent and --roots are mutually exclusive"));
14423 14424
            return false;
        }
14425 14426
        if (tree) {
            vshError(ctl, "%s",
14427
                     _("--parent and --tree are mutually exclusive"));
14428 14429
            return false;
        }
14430
        parent_filter = 1;
14431
    } else if (vshCommandOptBool(cmd, "roots")) {
14432 14433
        if (tree) {
            vshError(ctl, "%s",
14434
                     _("--roots and --tree are mutually exclusive"));
14435 14436
            return false;
        }
14437 14438 14439 14440
        if (from) {
            vshError(ctl, "%s",
                     _("--roots and --from are mutually exclusive"));
        }
14441 14442
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
    }
14443 14444 14445 14446 14447 14448 14449 14450
    if (leaves) {
        if (tree) {
            vshError(ctl, "%s",
                     _("--leaves and --tree are mutually exclusive"));
            return false;
        }
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_LEAVES;
    }
14451 14452 14453

    if (vshCommandOptBool(cmd, "metadata")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_METADATA;
14454 14455
    }

14456
    if (from) {
14457 14458
        descendants = vshCommandOptBool(cmd, "descendants");
        if (descendants || tree) {
14459 14460
            flags |= VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS;
        }
14461 14462
        numsnaps = ctl->useSnapshotOld ? -1 :
            virDomainSnapshotNumChildren(start, flags);
14463
        if (numsnaps < 0) {
14464 14465
            if (ctl->useSnapshotOld ||
                last_error->code == VIR_ERR_NO_SUPPORT) {
14466
                /* We can emulate --from.  */
14467
                /* XXX can we also emulate --leaves? */
14468 14469 14470 14471 14472 14473
                virFreeError(last_error);
                last_error = NULL;
                ctl->useSnapshotOld = true;
                flags &= ~VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS;
                numsnaps = virDomainSnapshotNum(dom, flags);
            }
14474 14475
        } else if (tree) {
            numsnaps++;
14476
        }
14477
    } else {
14478
        numsnaps = virDomainSnapshotNum(dom, flags);
14479 14480

        /* Fall back to simulation if --roots was unsupported. */
14481
        /* XXX can we also emulate --leaves? */
14482 14483 14484 14485 14486 14487 14488 14489
        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);
        }
14490 14491
    }

14492 14493 14494
    if (numsnaps < 0) {
        if (!last_error)
            vshError(ctl, _("missing support"));
14495
        goto cleanup;
14496
    }
14497

14498 14499 14500 14501 14502 14503 14504 14505 14506
    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\
14507
------------------------------------------------------------\n");
14508
    }
14509

14510 14511 14512 14513
    if (!numsnaps) {
        ret = true;
        goto cleanup;
    }
14514

14515 14516 14517
    if (VIR_ALLOC_N(names, numsnaps) < 0)
        goto cleanup;

14518
    if (from && !ctl->useSnapshotOld) {
14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533 14534 14535 14536
        /* 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);
    }
14537 14538
    if (actual < 0)
        goto cleanup;
14539

E
Eric Blake 已提交
14540 14541
    qsort(&names[0], actual, sizeof(char*), namesorter);

14542 14543
    if (tree || ctl->useSnapshotOld) {
        parents = vshCalloc(ctl, sizeof(char *), actual);
14544
        for (i = (from && !ctl->useSnapshotOld); i < actual; i++) {
14545 14546 14547 14548 14549
            if (ctl->useSnapshotOld && STREQ(names[i], from)) {
                start_index = i;
                continue;
            }

14550 14551 14552 14553
            /* free up memory from previous iterations of the loop */
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
14554 14555
            if (!snapshot ||
                vshGetSnapshotParent(ctl, snapshot, &parents[i]) < 0) {
14556 14557 14558 14559 14560 14561
                while (--i >= 0)
                    VIR_FREE(parents[i]);
                VIR_FREE(parents);
                goto cleanup;
            }
        }
14562 14563 14564
    }
    if (tree) {
        char indentBuf[INDENT_BUFLEN];
14565 14566
        for (i = 0 ; i < actual ; i++) {
            memset(indentBuf, '\0', sizeof indentBuf);
14567
            if (ctl->useSnapshotOld ? STREQ(names[i], from) : !parents[i])
14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581
                cmdNodeListDevicesPrint(ctl,
                                        names,
                                        parents,
                                        actual,
                                        i,
                                        i,
                                        0,
                                        0,
                                        indentBuf);
        }

        ret = true;
        goto cleanup;
    } else {
14582
        if (ctl->useSnapshotOld && descendants) {
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 14629 14630 14631 14632
            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]);
14633 14634
        }

14635
        for (i = 0; i < actual; i++) {
14636 14637
            if (ctl->useSnapshotOld &&
                (descendants ? !names[i] : STRNEQ_NULLABLE(parents[i], from)))
14638 14639
                continue;

14640
            /* free up memory from previous iterations of the loop */
14641
            VIR_FREE(parent);
14642 14643 14644 14645
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
14646
            xmlFreeDoc(xml);
14647 14648 14649 14650 14651 14652 14653 14654 14655 14656
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

14657
            xml = virXMLParseStringCtxt(doc, _("(domain_snapshot)"), &ctxt);
14658 14659 14660
            if (!xml)
                continue;

14661 14662 14663
            if (parent_filter) {
                parent = virXPathString("string(/domainsnapshot/parent/name)",
                                        ctxt);
14664 14665
                if (!parent && parent_filter < 0)
                    continue;
14666 14667
            }

14668 14669 14670
            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
14671 14672
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
14673
                continue;
14674 14675 14676 14677 14678 14679
            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);
14680 14681
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z",
                     &time_info);
14682

14683 14684 14685 14686 14687
            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);
14688 14689 14690
        }
    }

E
Eric Blake 已提交
14691
    ret = true;
14692 14693 14694

cleanup:
    /* this frees up memory from the last iteration of the loop */
14695
    VIR_FREE(parent);
14696 14697 14698
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
14699 14700
    if (start)
        virDomainSnapshotFree(start);
14701
    xmlXPathFreeContext(ctxt);
14702
    xmlFreeDoc(xml);
14703
    VIR_FREE(doc);
14704
    for (i = 0; i < actual; i++) {
14705
        VIR_FREE(names[i]);
14706 14707 14708
        if (parents)
            VIR_FREE(parents[i]);
    }
14709
    VIR_FREE(names);
14710
    VIR_FREE(parents);
14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728
    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")},
14729 14730
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
14731 14732 14733
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14734
static bool
14735 14736 14737
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14738
    bool ret = false;
14739
    const char *name = NULL;
14740 14741
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
14742 14743 14744 14745
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;
14746

14747
    if (!vshConnectionUsability(ctl, ctl->conn))
14748 14749 14750 14751 14752 14753
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

14754
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
14755 14756 14757 14758 14759 14760
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

14761
    xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
14762 14763 14764
    if (!xml)
        goto cleanup;

14765
    vshPrint(ctl, "%s", xml);
14766

E
Eric Blake 已提交
14767
    ret = true;
14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

E
Eric Blake 已提交
14779 14780 14781 14782
/*
 * "snapshot-parent" command
 */
static const vshCmdInfo info_snapshot_parent[] = {
E
Eric Blake 已提交
14783
    {"help", N_("Get the name of the parent of a snapshot")},
E
Eric Blake 已提交
14784 14785 14786 14787 14788 14789
    {"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")},
14790 14791
    {"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 已提交
14792 14793 14794 14795 14796 14797 14798 14799 14800 14801 14802 14803 14804 14805 14806 14807 14808 14809 14810
    {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;

14811 14812
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", true, dom,
                          &snapshot, &name) < 0)
E
Eric Blake 已提交
14813 14814
        goto cleanup;

14815
    if (vshGetSnapshotParent(ctl, snapshot, &parent) < 0)
E
Eric Blake 已提交
14816
        goto cleanup;
14817 14818 14819 14820
    if (!parent) {
        vshError(ctl, _("snapshot '%s' has no parent"), name);
        goto cleanup;
    }
E
Eric Blake 已提交
14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835

    vshPrint(ctl, "%s", parent);

    ret = true;

cleanup:
    VIR_FREE(parent);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

14836
/*
14837
 * "snapshot-revert" command
14838
 */
14839
static const vshCmdInfo info_snapshot_revert[] = {
14840 14841 14842 14843 14844
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

14845
static const vshCmdOptDef opts_snapshot_revert[] = {
14846
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
14847 14848
    {"snapshotname", VSH_OT_DATA, 0, N_("snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("revert to current snapshot")},
14849 14850
    {"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 已提交
14851
    {"force", VSH_OT_BOOL, 0, N_("try harder on risky reverts")},
14852 14853 14854
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14855
static bool
14856
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
14857 14858
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14859
    bool ret = false;
14860
    const char *name = NULL;
14861
    virDomainSnapshotPtr snapshot = NULL;
14862
    unsigned int flags = 0;
E
Eric Blake 已提交
14863 14864
    bool force = false;
    int result;
14865 14866 14867 14868 14869

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED;
E
Eric Blake 已提交
14870 14871 14872 14873 14874 14875
    /* 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;
14876

14877
    if (!vshConnectionUsability(ctl, ctl->conn))
14878 14879 14880 14881 14882 14883
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

14884 14885
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", true, dom,
                          &snapshot, &name) < 0)
14886 14887
        goto cleanup;

E
Eric Blake 已提交
14888 14889 14890 14891 14892 14893 14894 14895 14896
    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)
14897 14898
        goto cleanup;

E
Eric Blake 已提交
14899
    ret = true;
14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920

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")},
14921 14922
    {"snapshotname", VSH_OT_DATA, 0, N_("snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("delete current snapshot")},
14923
    {"children", VSH_OT_BOOL, 0, N_("delete snapshot and all children")},
14924 14925 14926
    {"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")},
14927 14928 14929
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14930
static bool
14931 14932 14933
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
14934
    bool ret = false;
14935
    const char *name = NULL;
14936 14937 14938
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

14939
    if (!vshConnectionUsability(ctl, ctl->conn))
14940 14941 14942 14943 14944 14945
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

14946 14947
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", true, dom,
                          &snapshot, &name) < 0)
14948 14949 14950 14951
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;
14952 14953 14954 14955
    if (vshCommandOptBool(cmd, "children-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY;
    if (vshCommandOptBool(cmd, "metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY;
14956

14957 14958 14959
    /* 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.  */
14960
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
14961 14962 14963 14964
        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);
14965 14966
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
14967
        goto cleanup;
14968
    }
14969

E
Eric Blake 已提交
14970
    ret = true;
14971 14972 14973 14974 14975 14976 14977 14978 14979 14980

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

14981 14982 14983 14984
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
14985 14986
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
14987 14988 14989 14990 14991
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
14992
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
14993
    {"cmd", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("command")},
14994 14995 14996
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14997
static bool
14998 14999 15000
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
15001
    bool ret = false;
15002
    char *monitor_cmd = NULL;
15003
    char *result = NULL;
15004
    unsigned int flags = 0;
15005 15006 15007
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
15008 15009 15010 15011 15012 15013 15014 15015

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

15016 15017 15018 15019 15020 15021 15022 15023
    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"));
15024 15025
        goto cleanup;
    }
15026
    monitor_cmd = virBufferContentAndReset(&buf);
15027

15028 15029 15030 15031
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
15032 15033 15034 15035
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
15036
    ret = true;
15037 15038 15039

cleanup:
    VIR_FREE(result);
15040
    VIR_FREE(monitor_cmd);
15041 15042 15043 15044 15045 15046
    if (dom)
        virDomainFree(dom);

    return ret;
}

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 15089 15090 15091 15092
/*
 * "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;
}

15093
static const vshCmdDef domManagementCmds[] = {
15094 15095 15096 15097 15098 15099 15100
    {"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 已提交
15101
    {"blkdeviotune", cmdBlkdeviotune, opts_blkdeviotune, info_blkdeviotune, 0},
15102
    {"blkiotune", cmdBlkiotune, opts_blkiotune, info_blkiotune, 0},
15103 15104
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
15105
    {"blockresize", cmdBlockResize, opts_block_resize, info_block_resize, 0},
15106
#ifndef WIN32
15107
    {"console", cmdConsole, opts_console, info_console, 0},
15108
#endif
15109 15110 15111 15112 15113 15114 15115 15116 15117 15118 15119
    {"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},
15120
    {"domif-setlink", cmdDomIfSetLink, opts_domif_setlink, info_domif_setlink, 0},
15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132
    {"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},
15133
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
15134 15135 15136 15137 15138 15139 15140 15141
    {"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},
15142 15143
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
15144 15145
    {"migrate-getspeed", cmdMigrateGetMaxSpeed,
     opts_migrate_getspeed, info_migrate_getspeed, 0},
15146
    {"reboot", cmdReboot, opts_reboot, info_reboot, 0},
X
Xu He Jie 已提交
15147
    {"reset", cmdReset, opts_reset, info_reset, 0},
15148 15149 15150
    {"restore", cmdRestore, opts_restore, info_restore, 0},
    {"resume", cmdResume, opts_resume, info_resume, 0},
    {"save", cmdSave, opts_save, info_save, 0},
15151 15152 15153 15154 15155 15156
    {"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},
15157
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
15158
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
15159 15160 15161 15162 15163 15164 15165 15166 15167 15168 15169 15170
    {"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 已提交
15171
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
15172
    {"version", cmdVersion, opts_version, info_version, 0},
15173 15174
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
15175 15176 15177
};

static const vshCmdDef domMonitoringCmds[] = {
15178
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
15179
    {"domblklist", cmdDomblklist, opts_domblklist, info_domblklist, 0},
15180
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
15181
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
15182
    {"domif-getlink", cmdDomIfGetLink, opts_domif_getlink, info_domif_getlink, 0},
15183 15184 15185 15186 15187 15188
    {"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}
15189 15190 15191
};

static const vshCmdDef storagePoolCmds[] = {
15192
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
15193
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
15194
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 15205 15206 15207 15208 15209 15210 15211 15212 15213 15214 15215
     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}
15216 15217 15218
};

static const vshCmdDef storageVolCmds[] = {
15219 15220 15221 15222 15223 15224 15225 15226 15227 15228 15229 15230 15231 15232 15233 15234 15235 15236
    {"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}
15237
};
15238

15239
static const vshCmdDef networkCmds[] = {
15240 15241 15242 15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254 15255 15256 15257 15258
    {"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}
15259
};
15260

15261
static const vshCmdDef nodedevCmds[] = {
15262 15263 15264 15265 15266 15267 15268 15269 15270 15271 15272 15273 15274 15275 15276
    {"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}
15277 15278 15279
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
15280 15281
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
15282 15283
    {"iface-bridge", cmdInterfaceBridge, opts_interface_bridge,
     info_interface_bridge, 0},
E
Eric Blake 已提交
15284 15285
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
15286 15287 15288 15289 15290 15291 15292 15293 15294 15295 15296 15297 15298 15299
    {"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 已提交
15300 15301
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
15302 15303
    {"iface-start", cmdInterfaceStart, opts_interface_start,
     info_interface_start, 0},
15304 15305
    {"iface-unbridge", cmdInterfaceUnbridge, opts_interface_unbridge,
     info_interface_unbridge, 0},
15306 15307 15308
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine,
     info_interface_undefine, 0},
    {NULL, NULL, NULL, NULL, 0}
15309
};
15310

15311
static const vshCmdDef nwfilterCmds[] = {
15312 15313 15314 15315 15316 15317 15318 15319 15320 15321 15322
    {"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}
15323
};
15324

15325
static const vshCmdDef secretCmds[] = {
15326 15327 15328 15329 15330 15331 15332 15333 15334 15335 15336 15337
    {"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}
15338
};
15339

15340
static const vshCmdDef virshCmds[] = {
15341 15342 15343 15344 15345 15346 15347
    {"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}
15348
};
15349

15350
static const vshCmdDef snapshotCmds[] = {
15351 15352
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
15353 15354
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
15355 15356 15357 15358 15359 15360
    {"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},
15361 15362
    {"snapshot-edit", cmdSnapshotEdit, opts_snapshot_edit,
     info_snapshot_edit, 0},
15363 15364
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
E
Eric Blake 已提交
15365 15366
    {"snapshot-parent", cmdSnapshotParent, opts_snapshot_parent,
     info_snapshot_parent, 0},
15367 15368 15369
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
15370
};
15371

15372
static const vshCmdDef hostAndHypervisorCmds[] = {
15373 15374 15375 15376 15377
    {"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},
15378
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
15379
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
15380
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
15381
    {"nodesuspend", cmdNodeSuspend, opts_node_suspend, info_nodesuspend, 0},
15382
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
15383 15384 15385 15386 15387
    {"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 已提交
15388 15389
};

15390 15391 15392 15393 15394 15395 15396 15397 15398 15399 15400 15401 15402 15403 15404 15405 15406
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 已提交
15407 15408 15409 15410
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
15411
static const char *
15412
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
15413
{
15414
    const vshCmdInfo *info;
15415

K
Karel Zak 已提交
15416
    for (info = cmd->info; info && info->name; info++) {
15417
        if (STREQ(info->name, name))
K
Karel Zak 已提交
15418 15419 15420 15421 15422
            return info->data;
    }
    return NULL;
}

15423
/* Validate that the options associated with cmd can be parsed.  */
15424
static int
E
Eric Blake 已提交
15425
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
15426 15427 15428 15429 15430
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
15431 15432 15433
    *opts_need_arg = 0;
    *opts_required = 0;

15434 15435 15436 15437 15438 15439 15440 15441 15442
    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 已提交
15443
            if (opt->flags & VSH_OFLAG_REQ)
15444 15445 15446
                return -1; /* bool options can't be mandatory */
            continue;
        }
E
Eric Blake 已提交
15447 15448
        if (opt->flags & VSH_OFLAG_REQ_OPT) {
            if (opt->flags & VSH_OFLAG_REQ)
L
Lai Jiangshan 已提交
15449 15450 15451 15452
                *opts_required |= 1 << i;
            continue;
        }

15453
        *opts_need_arg |= 1 << i;
E
Eric Blake 已提交
15454
        if (opt->flags & VSH_OFLAG_REQ) {
15455 15456 15457 15458 15459 15460
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
15461 15462 15463

        if (opt->type == VSH_OT_ARGV && cmd->opts[i + 1].name)
            return -1; /* argv option must be listed last */
15464 15465 15466 15467
    }
    return 0;
}

15468
static const vshCmdOptDef *
15469
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
15470
                   uint32_t *opts_seen, int *opt_index)
15471
{
15472 15473 15474 15475
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
15476

15477
        if (STREQ(opt->name, name)) {
15478
            if ((*opts_seen & (1 << i)) && opt->type != VSH_OT_ARGV) {
15479 15480 15481
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
15482 15483
            *opts_seen |= 1 << i;
            *opt_index = i;
K
Karel Zak 已提交
15484
            return opt;
15485 15486 15487 15488 15489
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
15490 15491 15492
    return NULL;
}

15493
static const vshCmdOptDef *
15494 15495
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
15496
{
15497
    int i;
15498
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
15499

15500 15501 15502 15503
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
15504
    i = ffs(*opts_need_arg) - 1;
15505
    opt = &cmd->opts[i];
15506
    if (opt->type != VSH_OT_ARGV)
15507
        *opts_need_arg &= ~(1 << i);
15508
    *opts_seen |= 1 << i;
15509
    return opt;
K
Karel Zak 已提交
15510 15511
}

15512 15513 15514
/*
 * Checks for required options
 */
15515
static int
15516 15517
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
15518
{
15519
    const vshCmdDef *def = cmd->def;
15520 15521 15522 15523 15524 15525 15526 15527 15528
    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];
15529

15530
            vshError(ctl,
15531
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
15532 15533 15534
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
15535 15536
        }
    }
15537
    return -1;
15538 15539
}

15540
static const vshCmdDef *
15541 15542
vshCmddefSearch(const char *cmdname)
{
15543
    const vshCmdGrp *g;
15544
    const vshCmdDef *c;
15545

15546 15547
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
15548
            if (STREQ(c->name, cmdname))
15549 15550 15551 15552
                return c;
        }
    }

K
Karel Zak 已提交
15553 15554 15555
    return NULL;
}

15556 15557 15558 15559 15560 15561
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
15562
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
15563 15564 15565 15566 15567 15568
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
15569
static bool
15570 15571 15572 15573 15574 15575 15576
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 已提交
15577
        return false;
15578 15579 15580 15581 15582 15583 15584 15585 15586 15587
    } 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 已提交
15588
    return true;
15589 15590
}

E
Eric Blake 已提交
15591
static bool
15592
vshCmddefHelp(vshControl *ctl, const char *cmdname)
15593
{
15594
    const vshCmdDef *def = vshCmddefSearch(cmdname);
15595

K
Karel Zak 已提交
15596
    if (!def) {
15597
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
15598
        return false;
15599
    } else {
E
Eric Blake 已提交
15600 15601
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
15602
        const char *help = _(vshCmddefGetInfo(def, "help"));
15603
        char buf[256];
15604 15605
        uint32_t opts_need_arg;
        uint32_t opts_required;
15606
        bool shortopt = false; /* true if 'arg' works instead of '--opt arg' */
15607 15608 15609 15610

        if (vshCmddefOptParse(def, &opts_need_arg, &opts_required)) {
            vshError(ctl, _("internal error: bad options in command: '%s'"),
                     def->name);
E
Eric Blake 已提交
15611
            return false;
15612
        }
K
Karel Zak 已提交
15613

15614
        fputs(_("  NAME\n"), stdout);
15615 15616
        fprintf(stdout, "    %s - %s\n", def->name, help);

15617 15618 15619 15620 15621
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
15622
                const char *fmt = "%s";
15623 15624
                switch (opt->type) {
                case VSH_OT_BOOL:
15625
                    fmt = "[--%s]";
15626 15627
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
15628
                    /* xgettext:c-format */
E
Eric Blake 已提交
15629
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>"
15630
                           : _("[--%s <number>]"));
15631 15632
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
15633 15634
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
15635 15636
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
15637 15638
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
15639 15640
                    break;
                case VSH_OT_DATA:
E
Eric Blake 已提交
15641
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
15642 15643
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
15644 15645 15646
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
15647 15648 15649 15650 15651 15652 15653 15654
                    if (shortopt) {
                        fmt = (opt->flags & VSH_OFLAG_REQ)
                            ? _("{[--%s] <string>}...")
                            : _("[[--%s] <string>]...");
                    } else {
                        fmt = (opt->flags & VSH_OFLAG_REQ) ? _("<%s>...")
                            : _("[<%s>]...");
                    }
15655 15656
                    break;
                default:
15657
                    assert(0);
15658
                }
15659
                fputc(' ', stdout);
E
Eric Blake 已提交
15660
                fprintf(stdout, fmt, opt->name);
15661
            }
K
Karel Zak 已提交
15662
        }
15663 15664 15665
        fputc('\n', stdout);

        if (desc[0]) {
15666
            /* Print the description only if it's not empty.  */
15667
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
15668
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
15669
        }
15670

K
Karel Zak 已提交
15671
        if (def->opts) {
15672
            const vshCmdOptDef *opt;
15673
            fputs(_("\n  OPTIONS\n"), stdout);
15674
            for (opt = def->opts; opt->name; opt++) {
15675 15676
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
15677
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
15678 15679
                    break;
                case VSH_OT_INT:
15680
                    snprintf(buf, sizeof(buf),
E
Eric Blake 已提交
15681
                             (opt->flags & VSH_OFLAG_REQ) ? _("[--%s] <number>")
15682
                             : _("--%s <number>"), opt->name);
15683 15684
                    break;
                case VSH_OT_STRING:
15685
                    /* OT_STRING should never be VSH_OFLAG_REQ */
15686
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
15687 15688
                    break;
                case VSH_OT_DATA:
15689 15690
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
15691 15692
                    break;
                case VSH_OT_ARGV:
15693 15694 15695
                    snprintf(buf, sizeof(buf),
                             shortopt ? _("[--%s] <string>") : _("<%s>"),
                             opt->name);
15696
                    break;
15697 15698 15699
                default:
                    assert(0);
                }
15700

E
Eric Blake 已提交
15701
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
15702
            }
K
Karel Zak 已提交
15703 15704 15705
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
15706
    return true;
K
Karel Zak 已提交
15707 15708 15709 15710 15711 15712
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
15713 15714 15715
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
15716 15717
    vshCmdOpt *a = arg;

15718
    while (a) {
K
Karel Zak 已提交
15719
        vshCmdOpt *tmp = a;
15720

K
Karel Zak 已提交
15721 15722
        a = a->next;

15723 15724
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
15725 15726 15727 15728
    }
}

static void
15729
vshCommandFree(vshCmd *cmd)
15730
{
K
Karel Zak 已提交
15731 15732
    vshCmd *c = cmd;

15733
    while (c) {
K
Karel Zak 已提交
15734
        vshCmd *tmp = c;
15735

K
Karel Zak 已提交
15736 15737 15738 15739
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
15740
        VIR_FREE(tmp);
K
Karel Zak 已提交
15741 15742 15743
    }
}

E
Eric Blake 已提交
15744 15745 15746 15747 15748 15749 15750 15751 15752 15753 15754
/**
 * 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 已提交
15755
 */
E
Eric Blake 已提交
15756 15757
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
15758
{
E
Eric Blake 已提交
15759 15760
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
15761

E
Eric Blake 已提交
15762 15763 15764 15765 15766 15767 15768
    /* 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 已提交
15769
    }
E
Eric Blake 已提交
15770 15771 15772 15773 15774 15775 15776

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
E
Eric Blake 已提交
15777
            return (valid->flags & VSH_OFLAG_REQ) == 0 ? 0 : -1;
E
Eric Blake 已提交
15778 15779 15780 15781
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
15782 15783
}

E
Eric Blake 已提交
15784 15785
/**
 * vshCommandOptInt:
15786 15787 15788 15789 15790 15791 15792
 * @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 已提交
15793
 * 0 if option not found and not required (@value untouched)
15794
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
15795 15796
 */
static int
15797
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
15798
{
E
Eric Blake 已提交
15799 15800 15801
    vshCmdOpt *arg;
    int ret;
    int num;
15802
    char *end_p = NULL;
15803

E
Eric Blake 已提交
15804 15805 15806 15807 15808 15809 15810
    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;
15811
    }
E
Eric Blake 已提交
15812 15813 15814 15815 15816 15817 15818

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
15819 15820
}

15821

E
Eric Blake 已提交
15822 15823 15824 15825 15826 15827
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
15828 15829 15830 15831 15832 15833
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
15834 15835 15836
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
15837 15838
    char *end_p = NULL;

E
Eric Blake 已提交
15839 15840 15841 15842 15843 15844 15845
    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;
15846
    }
E
Eric Blake 已提交
15847 15848 15849 15850 15851 15852 15853

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
15854 15855 15856
}


15857
/*
E
Eric Blake 已提交
15858 15859 15860 15861 15862
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
15863 15864 15865 15866 15867
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
15868
{
E
Eric Blake 已提交
15869 15870
    vshCmdOpt *arg;
    int ret;
15871
    unsigned long num;
15872 15873
    char *end_p = NULL;

E
Eric Blake 已提交
15874 15875 15876 15877 15878 15879 15880
    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;
15881
    }
E
Eric Blake 已提交
15882 15883 15884 15885 15886 15887 15888

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
15889 15890
}

E
Eric Blake 已提交
15891 15892 15893 15894 15895 15896
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
15897
 * Returns option as STRING
E
Eric Blake 已提交
15898 15899 15900 15901
 * 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 已提交
15902
 */
15903 15904
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
15905
{
E
Eric Blake 已提交
15906 15907 15908 15909 15910 15911 15912 15913 15914 15915
    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;
15916
    }
15917

E
Eric Blake 已提交
15918
    if (!*arg->data && !(arg->def->flags & VSH_OFLAG_EMPTY_OK)) {
E
Eric Blake 已提交
15919 15920 15921 15922
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
15923 15924
}

E
Eric Blake 已提交
15925 15926 15927 15928 15929 15930
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
15931
 * Returns option as long long
15932
 * See vshCommandOptInt()
15933
 */
15934 15935 15936
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
15937
{
E
Eric Blake 已提交
15938 15939
    vshCmdOpt *arg;
    int ret;
15940
    long long num;
15941 15942
    char *end_p = NULL;

E
Eric Blake 已提交
15943 15944 15945 15946 15947 15948 15949
    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;
15950
    }
E
Eric Blake 已提交
15951 15952 15953 15954 15955 15956 15957

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
15958 15959
}

E
Eric Blake 已提交
15960 15961 15962 15963 15964 15965 15966 15967 15968
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
15969 15970 15971 15972
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
15973 15974
    vshCmdOpt *arg;
    int ret;
15975 15976 15977
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
15978 15979 15980 15981 15982 15983 15984
    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;
15985
    }
E
Eric Blake 已提交
15986 15987 15988 15989 15990 15991 15992

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
15993 15994 15995
}


E
Eric Blake 已提交
15996 15997 15998 15999 16000 16001 16002 16003 16004
/**
 * 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 已提交
16005
 */
E
Eric Blake 已提交
16006
static bool
16007
vshCommandOptBool(const vshCmd *cmd, const char *name)
16008
{
E
Eric Blake 已提交
16009 16010 16011
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
16012 16013
}

E
Eric Blake 已提交
16014 16015 16016 16017 16018
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
16019 16020
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
16021
 *
16022
 * Requires that a VSH_OT_ARGV option be last in the
16023 16024
 * list of supported options in CMD->def->opts.
 */
16025 16026
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
16027
{
16028
    opt = opt ? opt->next : cmd->opts;
16029 16030

    while (opt) {
E
Eric Blake 已提交
16031
        if (opt->def->type == VSH_OT_ARGV) {
16032
            return opt;
16033 16034 16035 16036 16037 16038
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
16039 16040 16041 16042 16043 16044 16045 16046 16047 16048 16049 16050 16051 16052 16053 16054 16055 16056
/* 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)
16057
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
16058 16059 16060
                 cmd->def->name, optname);
    return found;
}
16061

K
Karel Zak 已提交
16062
static virDomainPtr
J
Jim Meyering 已提交
16063
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
16064
                      const char **name, int flag)
16065
{
K
Karel Zak 已提交
16066
    virDomainPtr dom = NULL;
16067
    const char *n = NULL;
K
Karel Zak 已提交
16068
    int id;
J
Jim Meyering 已提交
16069 16070 16071
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
16072

16073
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16074 16075
        return NULL;

16076
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16077 16078
             cmd->def->name, optname, n);

K
Karel Zak 已提交
16079 16080
    if (name)
        *name = n;
16081

K
Karel Zak 已提交
16082
    /* try it by ID */
16083
    if (flag & VSH_BYID) {
16084
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
16085 16086
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
16087 16088 16089
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
16090
    }
K
Karel Zak 已提交
16091
    /* try it by UUID */
16092
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
16093
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
16094
                 cmd->def->name, optname);
K
Karel Zak 已提交
16095
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
16096
    }
K
Karel Zak 已提交
16097
    /* try it by NAME */
16098
    if (dom==NULL && (flag & VSH_BYNAME)) {
16099
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
16100
                 cmd->def->name, optname);
K
Karel Zak 已提交
16101
        dom = virDomainLookupByName(ctl->conn, n);
16102
    }
K
Karel Zak 已提交
16103

16104
    if (!dom)
16105
        vshError(ctl, _("failed to get domain '%s'"), n);
16106

K
Karel Zak 已提交
16107 16108 16109
    return dom;
}

16110
static virNetworkPtr
J
Jim Meyering 已提交
16111
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
16112
                       const char **name, int flag)
16113 16114
{
    virNetworkPtr network = NULL;
16115
    const char *n = NULL;
J
Jim Meyering 已提交
16116 16117 16118
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
16119

16120
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16121 16122
        return NULL;

16123
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16124 16125 16126 16127 16128 16129
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
16130
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
16131
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
16132
                 cmd->def->name, optname);
16133 16134 16135 16136
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
16137
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
16138 16139 16140 16141 16142
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
16143
        vshError(ctl, _("failed to get network '%s'"), n);
16144 16145 16146 16147

    return network;
}

16148 16149 16150

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
16151
                        const char **name, int flag)
16152 16153
{
    virNWFilterPtr nwfilter = NULL;
16154
    const char *n = NULL;
16155 16156 16157 16158
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

16159
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16160 16161
        return NULL;

16162
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16163 16164 16165 16166 16167 16168 16169
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
16170
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
16171 16172 16173 16174 16175
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
16176
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
16177 16178 16179 16180 16181 16182 16183 16184 16185 16186
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

16187 16188
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
16189
                         const char *optname,
16190
                         const char **name, int flag)
16191 16192
{
    virInterfacePtr iface = NULL;
16193
    const char *n = NULL;
16194 16195 16196

    if (!optname)
       optname = "interface";
16197 16198 16199
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

16200
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16201 16202
        return NULL;

16203
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16204 16205 16206 16207 16208 16209
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
16210
    if ((flag & VSH_BYNAME)) {
16211
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
16212 16213 16214 16215 16216
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
16217
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
16218 16219 16220 16221 16222
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
16223
        vshError(ctl, _("failed to get interface '%s'"), n);
16224 16225 16226 16227

    return iface;
}

16228
static virStoragePoolPtr
16229
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
16230
                    const char **name, int flag)
16231 16232
{
    virStoragePoolPtr pool = NULL;
16233
    const char *n = NULL;
16234

16235
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16236 16237
        return NULL;

16238
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
16239 16240 16241 16242 16243 16244
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
16245
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
16246
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
16247
                 cmd->def->name, optname);
16248 16249 16250
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
16251
    if (pool == NULL && (flag & VSH_BYNAME)) {
16252
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
16253 16254 16255 16256 16257
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
16258
        vshError(ctl, _("failed to get pool '%s'"), n);
16259 16260 16261 16262 16263

    return pool;
}

static virStorageVolPtr
16264
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
16265 16266
                   const char *optname,
                   const char *pooloptname,
16267
                   const char **name, int flag)
16268 16269 16270
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
16271
    const char *n = NULL, *p = NULL;
16272

16273
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16274 16275
        return NULL;

16276
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
16277
        vshError(ctl, "%s", _("missing option"));
16278
        return NULL;
16279
    }
16280 16281 16282 16283

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

16284
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
16285 16286 16287 16288 16289
             cmd->def->name, optname, n);

    if (name)
        *name = n;

16290
    /* try it by name */
16291
    if (pool && (flag & VSH_BYNAME)) {
16292
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
16293 16294 16295
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
16296
    /* try it by key */
16297
    if (vol == NULL && (flag & VSH_BYUUID)) {
16298
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
16299 16300 16301
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
16302
    /* try it by path */
16303
    if (vol == NULL && (flag & VSH_BYUUID)) {
16304
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
16305 16306 16307 16308
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

16309 16310 16311 16312
    if (!vol) {
        if (pool)
            vshError(ctl, _("failed to get vol '%s'"), n);
        else
16313 16314
            vshError(ctl, _("failed to get vol '%s', specifying --%s "
                            "might help"), n, pooloptname);
16315
    }
16316 16317 16318 16319 16320 16321 16322

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

16323
static virSecretPtr
16324
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
16325 16326
{
    virSecretPtr secret = NULL;
16327
    const char *n = NULL;
16328 16329 16330 16331 16332
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

16333
    if (vshCommandOptString(cmd, optname, &n) <= 0)
16334 16335
        return NULL;

16336 16337
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
16338 16339 16340 16341 16342 16343 16344

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
16345
        vshError(ctl, _("failed to get secret '%s'"), n);
16346 16347 16348 16349

    return secret;
}

K
Karel Zak 已提交
16350 16351 16352
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
16353
static bool
16354
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
16355
{
E
Eric Blake 已提交
16356
    bool ret = true;
16357 16358

    while (cmd) {
K
Karel Zak 已提交
16359
        struct timeval before, after;
16360
        bool enable_timing = ctl->timing;
16361

16362 16363
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
16364 16365
            vshReconnect(ctl);

16366
        if (enable_timing)
K
Karel Zak 已提交
16367
            GETTIMEOFDAY(&before);
16368

K
Karel Zak 已提交
16369 16370
        ret = cmd->def->handler(ctl, cmd);

16371
        if (enable_timing)
K
Karel Zak 已提交
16372
            GETTIMEOFDAY(&after);
16373

16374
        if (!ret)
J
John Levon 已提交
16375 16376
            virshReportError(ctl);

16377
        /* try to automatically catch disconnections */
16378
        if (!ret &&
16379 16380 16381 16382 16383 16384 16385 16386 16387
            ((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);

16388
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
16389 16390
            return ret;

16391
        if (enable_timing)
16392
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
16393 16394
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
16395
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
16396 16397 16398 16399 16400 16401
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
16402
 * Command parsing
K
Karel Zak 已提交
16403 16404 16405
 * ---------------
 */

16406 16407 16408 16409 16410 16411 16412 16413 16414 16415
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 已提交
16416
    /* vshCommandStringGetArg() */
16417
    char *pos;
L
Lai Jiangshan 已提交
16418 16419 16420
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
16421 16422
} vshCommandParser;

E
Eric Blake 已提交
16423
static bool
16424
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
16425
{
K
Karel Zak 已提交
16426 16427 16428
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
16429

K
Karel Zak 已提交
16430 16431 16432 16433
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
16434

16435
    while (1) {
K
Karel Zak 已提交
16436
        vshCmdOpt *last = NULL;
16437
        const vshCmdDef *cmd = NULL;
16438
        vshCommandToken tk;
L
Lai Jiangshan 已提交
16439
        bool data_only = false;
16440 16441 16442
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
16443

K
Karel Zak 已提交
16444
        first = NULL;
16445

16446
        while (1) {
16447
            const vshCmdOptDef *opt = NULL;
16448

K
Karel Zak 已提交
16449
            tkdata = NULL;
16450
            tk = parser->getNextArg(ctl, parser, &tkdata);
16451 16452

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
16453
                goto syntaxError;
H
Hu Tao 已提交
16454 16455
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
16456
                break;
H
Hu Tao 已提交
16457
            }
16458 16459

            if (cmd == NULL) {
K
Karel Zak 已提交
16460 16461
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
16462
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
16463
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
16464
                }
16465 16466 16467 16468 16469 16470 16471
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
16472
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
16473 16474 16475 16476
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
16477
                char *optstr = strchr(tkdata + 2, '=');
16478 16479
                int opt_index;

16480 16481 16482 16483
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
16484
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
16485
                                               &opts_seen, &opt_index))) {
16486
                    VIR_FREE(optstr);
K
Karel Zak 已提交
16487 16488
                    goto syntaxError;
                }
16489
                VIR_FREE(tkdata);
K
Karel Zak 已提交
16490 16491 16492

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
16493 16494 16495
                    if (optstr)
                        tkdata = optstr;
                    else
16496
                        tk = parser->getNextArg(ctl, parser, &tkdata);
16497
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
16498
                        goto syntaxError;
16499
                    if (tk != VSH_TK_ARG) {
16500
                        vshError(ctl,
16501
                                 _("expected syntax: --%s <%s>"),
16502 16503
                                 opt->name,
                                 opt->type ==
16504
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
16505 16506
                        goto syntaxError;
                    }
16507 16508
                    if (opt->type != VSH_OT_ARGV)
                        opts_need_arg &= ~(1 << opt_index);
16509 16510 16511 16512 16513 16514 16515 16516
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
16517
                }
L
Lai Jiangshan 已提交
16518 16519 16520 16521
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
16522
            } else {
L
Lai Jiangshan 已提交
16523
get_data:
16524 16525
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
16526
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
16527 16528 16529 16530 16531
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
16532
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
16533

K
Karel Zak 已提交
16534 16535 16536 16537
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
16538

K
Karel Zak 已提交
16539 16540 16541 16542 16543
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
16544

16545
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
16546 16547
                         cmd->name,
                         opt->name,
16548 16549
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
16550 16551
            }
        }
16552

D
Daniel Veillard 已提交
16553
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
16554
        if (cmd) {
16555
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
16556

K
Karel Zak 已提交
16557 16558 16559 16560
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

16561
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
16562
                VIR_FREE(c);
16563
                goto syntaxError;
16564
            }
16565

K
Karel Zak 已提交
16566 16567 16568 16569 16570 16571
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
16572 16573 16574

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
16575
    }
16576

E
Eric Blake 已提交
16577
    return true;
K
Karel Zak 已提交
16578

16579
 syntaxError:
16580
    if (ctl->cmd) {
K
Karel Zak 已提交
16581
        vshCommandFree(ctl->cmd);
16582 16583
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
16584 16585
    if (first)
        vshCommandOptFree(first);
16586
    VIR_FREE(tkdata);
E
Eric Blake 已提交
16587
    return false;
K
Karel Zak 已提交
16588 16589
}

16590 16591 16592 16593 16594 16595 16596 16597 16598 16599 16600 16601 16602 16603 16604 16605 16606 16607
/* --------------------
 * 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 已提交
16608 16609
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
16610 16611 16612 16613
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
16614
        return false;
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 16683 16684 16685 16686

    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 已提交
16687 16688
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
16689 16690 16691 16692
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
16693
        return false;
16694 16695 16696 16697 16698 16699

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
16700
/* ---------------
16701
 * Misc utils
K
Karel Zak 已提交
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 16728 16729 16730 16731
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 已提交
16732
static const char *
16733 16734
vshDomainStateToString(int state)
{
16735 16736
    /* Can't use virDomainStateTypeToString, because we want to mark
     * strings for translation.  */
16737
    switch ((virDomainState) state) {
16738
    case VIR_DOMAIN_RUNNING:
16739
        return N_("running");
16740
    case VIR_DOMAIN_BLOCKED:
16741
        return N_("idle");
16742
    case VIR_DOMAIN_PAUSED:
16743
        return N_("paused");
16744
    case VIR_DOMAIN_SHUTDOWN:
16745
        return N_("in shutdown");
16746
    case VIR_DOMAIN_SHUTOFF:
16747
        return N_("shut off");
16748
    case VIR_DOMAIN_CRASHED:
16749
        return N_("crashed");
16750
    case VIR_DOMAIN_NOSTATE:
16751
    default:
16752
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
16753
    }
16754
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
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 16808 16809 16810 16811
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");
16812 16813
        case VIR_DOMAIN_PAUSED_SHUTTING_DOWN:
            return N_("shutting down");
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 16851 16852 16853 16854
        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;
16855 16856 16857

    default:
        ;
16858 16859 16860 16861 16862
    }

    return N_("unknown");
}

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 16922 16923 16924 16925
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;
}

16926 16927 16928 16929 16930 16931 16932 16933 16934 16935 16936 16937 16938 16939 16940 16941 16942
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");
}

16943 16944 16945 16946
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
16947
    case VIR_VCPU_OFFLINE:
16948
        return N_("offline");
16949
    case VIR_VCPU_BLOCKED:
16950
        return N_("idle");
16951
    case VIR_VCPU_RUNNING:
16952
        return N_("running");
16953
    default:
16954
        ;/*FALLTHROUGH*/
16955
    }
16956
    return N_("no state");
16957 16958
}

E
Eric Blake 已提交
16959
static bool
16960
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
16961
{
16962 16963
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
16964 16965
     */
    if (!conn) {
16966
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
16967
        return false;
K
Karel Zak 已提交
16968
    }
E
Eric Blake 已提交
16969
    return true;
K
Karel Zak 已提交
16970 16971
}

K
Karel Zak 已提交
16972
static void
16973
vshDebug(vshControl *ctl, int level, const char *format, ...)
16974
{
K
Karel Zak 已提交
16975
    va_list ap;
16976
    char *str;
K
Karel Zak 已提交
16977

16978 16979 16980 16981 16982 16983 16984
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

16985
    va_start(ap, format);
16986
    vshOutputLogFile(ctl, level, format, ap);
16987 16988
    va_end(ap);

K
Karel Zak 已提交
16989
    va_start(ap, format);
16990 16991 16992 16993 16994
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
16995
    va_end(ap);
16996 16997
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
16998 16999 17000
}

static void
17001
vshPrintExtra(vshControl *ctl, const char *format, ...)
17002
{
K
Karel Zak 已提交
17003
    va_list ap;
17004
    char *str;
17005

17006
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
17007
        return;
17008

K
Karel Zak 已提交
17009
    va_start(ap, format);
17010 17011 17012 17013 17014
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
17015
    va_end(ap);
17016
    fputs(str, stdout);
17017
    VIR_FREE(str);
K
Karel Zak 已提交
17018 17019
}

K
Karel Zak 已提交
17020

K
Karel Zak 已提交
17021
static void
17022
vshError(vshControl *ctl, const char *format, ...)
17023
{
K
Karel Zak 已提交
17024
    va_list ap;
17025
    char *str;
17026

17027 17028 17029 17030 17031
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
17032

17033 17034 17035 17036
    /* 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);
17037
    fputs(_("error: "), stderr);
17038

K
Karel Zak 已提交
17039
    va_start(ap, format);
17040 17041 17042
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
17043 17044
    va_end(ap);

17045
    fprintf(stderr, "%s\n", NULLSTR(str));
17046
    fflush(stderr);
17047
    VIR_FREE(str);
K
Karel Zak 已提交
17048 17049
}

17050

J
Jiri Denemark 已提交
17051 17052 17053 17054 17055
static void
vshEventLoop(void *opaque)
{
    vshControl *ctl = opaque;

17056 17057 17058 17059 17060 17061 17062 17063 17064 17065
    while (1) {
        bool quit;
        virMutexLock(&ctl->lock);
        quit = ctl->quit;
        virMutexUnlock(&ctl->lock);

        if (quit)
            break;

        if (virEventRunDefaultImpl() < 0)
J
Jiri Denemark 已提交
17066 17067 17068 17069 17070
            virshReportError(ctl);
    }
}


K
Karel Zak 已提交
17071
/*
17072
 * Initialize connection.
K
Karel Zak 已提交
17073
 */
E
Eric Blake 已提交
17074
static bool
17075
vshInit(vshControl *ctl)
17076
{
17077 17078
    char *debugEnv;

K
Karel Zak 已提交
17079
    if (ctl->conn)
E
Eric Blake 已提交
17080
        return false;
K
Karel Zak 已提交
17081

J
Jiri Denemark 已提交
17082
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
17083 17084 17085
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
17086 17087 17088
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
17089 17090
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
17091 17092
            } else {
                ctl->debug = debug;
17093 17094 17095 17096 17097 17098 17099 17100 17101 17102 17103 17104
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

17105 17106
    vshOpenLogFile(ctl);

17107 17108
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
17109

17110 17111 17112
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

17113
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
17114
        return false;
17115

J
Jiri Denemark 已提交
17116 17117 17118 17119
    if (virThreadCreate(&ctl->eventLoop, true, vshEventLoop, ctl) < 0)
        return false;
    ctl->eventLoopStarted = true;

17120 17121 17122 17123
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
17124

17125 17126 17127 17128 17129 17130 17131 17132 17133 17134 17135
        /* 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;
        }
17136
    }
K
Karel Zak 已提交
17137

E
Eric Blake 已提交
17138
    return true;
K
Karel Zak 已提交
17139 17140
}

17141 17142
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

17143 17144 17145 17146 17147 17148 17149 17150 17151 17152 17153 17154 17155 17156 17157 17158 17159 17160 17161
/**
 * 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:
17162
                vshError(ctl, "%s",
J
Jim Meyering 已提交
17163
                         _("failed to get the log file information"));
17164
                exit(EXIT_FAILURE);
17165 17166 17167
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
17168 17169
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
17170 17171 17172 17173
        }
    }

    /* log file open */
17174
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
17175
        vshError(ctl, "%s",
J
Jim Meyering 已提交
17176
                 _("failed to open the log file. check the log file path"));
17177
        exit(EXIT_FAILURE);
17178 17179 17180 17181 17182 17183 17184 17185 17186
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
17187 17188
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
17189
{
17190 17191 17192
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
17193 17194 17195 17196 17197 17198 17199 17200 17201 17202 17203 17204 17205 17206
    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);
17207
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
17208 17209 17210 17211 17212 17213
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
17214 17215
                      SIGN_NAME,
                      (int) getpid());
17216 17217 17218 17219 17220 17221 17222 17223 17224 17225 17226 17227 17228 17229 17230 17231 17232 17233 17234 17235
    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;
    }
17236 17237 17238
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
17239

17240 17241
    if (virBufferError(&buf))
        goto error;
17242

17243 17244 17245 17246 17247
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
17248
    }
17249

17250 17251 17252 17253 17254 17255 17256 17257 17258 17259 17260
    /* 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);
17261 17262 17263 17264 17265 17266 17267 17268 17269 17270 17271
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
17272 17273 17274
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
17275 17276 17277
    }

    if (ctl->logfile) {
17278
        VIR_FREE(ctl->logfile);
17279 17280 17281 17282
        ctl->logfile = NULL;
    }
}

17283
#ifdef USE_READLINE
17284

K
Karel Zak 已提交
17285 17286 17287 17288 17289
/* -----------------
 * Readline stuff
 * -----------------
 */

17290
/*
K
Karel Zak 已提交
17291 17292
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
17293
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
17294 17295
 */
static char *
17296 17297
vshReadlineCommandGenerator(const char *text, int state)
{
17298
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
17299
    const char *name;
17300 17301
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
17302 17303

    if (!state) {
17304 17305
        grp_list_index = 0;
        cmd_list_index = 0;
17306
        len = strlen(text);
K
Karel Zak 已提交
17307 17308
    }

17309 17310
    grp = cmdGroups;

K
Karel Zak 已提交
17311
    /* Return the next name which partially matches from the
17312
     * command list.
K
Karel Zak 已提交
17313
     */
17314 17315 17316 17317 17318 17319 17320 17321 17322 17323 17324 17325 17326 17327
    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 已提交
17328 17329 17330 17331 17332 17333 17334
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
17335 17336
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
17337
    static int list_index, len;
17338
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
17339
    const char *name;
K
Karel Zak 已提交
17340 17341 17342 17343 17344 17345 17346 17347 17348

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

17349
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
17350
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
17351 17352 17353

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
17354
        len = strlen(text);
17355
        VIR_FREE(cmdname);
K
Karel Zak 已提交
17356 17357 17358 17359
    }

    if (!cmd)
        return NULL;
17360

17361 17362 17363
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
17364
    while ((name = cmd->opts[list_index].name)) {
17365
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
17366
        char *res;
17367

K
Karel Zak 已提交
17368
        list_index++;
17369

17370
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
17371 17372
            /* ignore non --option */
            continue;
17373

K
Karel Zak 已提交
17374
        if (len > 2) {
17375
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
17376 17377
                continue;
        }
17378
        res = vshMalloc(NULL, strlen(name) + 3);
17379
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
17380 17381 17382 17383 17384 17385 17386 17387
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
17388 17389 17390
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
17391 17392
    char **matches = (char **) NULL;

17393
    if (start == 0)
K
Karel Zak 已提交
17394
        /* command name generator */
17395
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
17396 17397
    else
        /* commands options */
17398
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
17399 17400 17401 17402
    return matches;
}


17403 17404
static int
vshReadlineInit(vshControl *ctl)
17405
{
17406 17407
    char *userdir = NULL;

K
Karel Zak 已提交
17408 17409 17410 17411 17412
    /* 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;
17413 17414 17415

    /* Limit the total size of the history buffer */
    stifle_history(500);
17416 17417

    /* Prepare to read/write history from/to the ~/.virsh/history file */
17418
    userdir = virGetUserDirectory(getuid());
17419

17420 17421
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
17422
        return -1;
17423
    }
17424 17425 17426

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
17427
        VIR_FREE(userdir);
17428 17429 17430 17431 17432
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
17433
        VIR_FREE(userdir);
17434 17435 17436
        return -1;
    }

17437
    VIR_FREE(userdir);
17438 17439 17440 17441 17442 17443 17444 17445 17446 17447 17448 17449 17450 17451 17452 17453 17454 17455

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

17456 17457
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
17458 17459
}

17460 17461 17462 17463 17464 17465
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

17466
#else /* !USE_READLINE */
17467

17468 17469 17470 17471 17472 17473 17474
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

17475
static void
17476
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
17477 17478 17479 17480 17481 17482 17483 17484 17485 17486 17487 17488 17489 17490 17491 17492 17493 17494 17495 17496 17497 17498 17499
{
    /* 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);
}

17500
#endif /* !USE_READLINE */
17501

17502 17503 17504 17505 17506 17507
static void
vshDeinitTimer(int timer ATTRIBUTE_UNUSED, void *opaque ATTRIBUTE_UNUSED)
{
    /* nothing to be done here */
}

K
Karel Zak 已提交
17508
/*
J
Jim Meyering 已提交
17509
 * Deinitialize virsh
K
Karel Zak 已提交
17510
 */
E
Eric Blake 已提交
17511
static bool
17512
vshDeinit(vshControl *ctl)
17513
{
17514
    vshReadlineDeinit(ctl);
17515
    vshCloseLogFile(ctl);
17516
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
17517
    if (ctl->conn) {
17518 17519 17520
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
17521 17522
        }
    }
D
Daniel P. Berrange 已提交
17523 17524
    virResetLastError();

J
Jiri Denemark 已提交
17525
    if (ctl->eventLoopStarted) {
17526 17527 17528 17529
        int timer;

        virMutexLock(&ctl->lock);
        ctl->quit = true;
J
Jiri Denemark 已提交
17530
        /* HACK: Add a dummy timeout to break event loop */
17531 17532 17533 17534 17535
        timer = virEventAddTimeout(0, vshDeinitTimer, NULL, NULL);
        virMutexUnlock(&ctl->lock);

        virThreadJoin(&ctl->eventLoop);

J
Jiri Denemark 已提交
17536 17537 17538 17539 17540 17541
        if (timer != -1)
            virEventRemoveTimeout(timer);

        ctl->eventLoopStarted = false;
    }

17542 17543
    virMutexDestroy(&ctl->lock);

E
Eric Blake 已提交
17544
    return true;
K
Karel Zak 已提交
17545
}
17546

K
Karel Zak 已提交
17547 17548 17549 17550
/*
 * Print usage
 */
static void
17551
vshUsage(void)
17552
{
17553
    const vshCmdGrp *grp;
17554
    const vshCmdDef *cmd;
17555

L
Lai Jiangshan 已提交
17556 17557
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
17558
                      "  options:\n"
17559
                      "    -c | --connect=URI      hypervisor connection URI\n"
17560
                      "    -r | --readonly         connect readonly\n"
17561
                      "    -d | --debug=NUM        debug level [0-4]\n"
17562 17563 17564
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
17565 17566 17567 17568 17569
                      "    -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"
17570
                      "  commands (non interactive mode):\n\n"), progname, progname);
17571

17572 17573
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
17574

17575 17576 17577 17578 17579 17580 17581 17582 17583
        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"));
17584 17585 17586
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
17587 17588
}

17589 17590 17591 17592 17593 17594 17595 17596 17597 17598
/*
 * 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 已提交
17599 17600
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
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 17632 17633 17634 17635
#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 已提交
17636
    vshPrint(ctl, "%s", _(" Networking:"));
17637 17638 17639 17640 17641 17642 17643 17644 17645 17646 17647 17648 17649 17650 17651 17652 17653 17654 17655 17656 17657 17658 17659 17660 17661 17662
#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 已提交
17663
    vshPrint(ctl, "%s", _(" Storage:"));
17664 17665 17666 17667 17668 17669 17670 17671 17672 17673 17674 17675 17676 17677 17678 17679 17680 17681 17682 17683 17684 17685 17686
#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 已提交
17687
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
17688
#ifdef WITH_SECDRIVER_APPARMOR
17689 17690 17691 17692 17693 17694 17695 17696 17697 17698 17699 17700 17701 17702 17703 17704 17705 17706 17707 17708 17709 17710 17711
    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 已提交
17712 17713 17714 17715
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
17716
static bool
17717
vshParseArgv(vshControl *ctl, int argc, char **argv)
17718
{
17719
    bool help = false;
17720
    int arg, len;
K
Karel Zak 已提交
17721
    struct option opt[] = {
E
Eric Blake 已提交
17722 17723 17724 17725 17726 17727 17728 17729
        {"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'},
17730
        {"escape", required_argument, NULL, 'e'},
E
Eric Blake 已提交
17731
        {NULL, 0, NULL, 0}
17732 17733
    };

17734 17735 17736
    /* 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. */
17737
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:e:", opt, NULL)) != -1) {
17738
        switch (arg) {
17739
        case 'd':
D
Daniel Veillard 已提交
17740
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
17741
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
17742 17743
                exit(EXIT_FAILURE);
            }
17744 17745
            break;
        case 'h':
17746
            help = true;
17747 17748
            break;
        case 'q':
E
Eric Blake 已提交
17749
            ctl->quiet = true;
17750 17751
            break;
        case 't':
E
Eric Blake 已提交
17752
            ctl->timing = true;
17753 17754 17755 17756
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
17757 17758 17759 17760 17761 17762
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
17763 17764 17765
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
17766
        case 'r':
E
Eric Blake 已提交
17767
            ctl->readonly = true;
17768
            break;
17769 17770 17771
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
17772 17773 17774 17775 17776 17777 17778 17779 17780 17781 17782 17783
        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;
17784
        default:
17785 17786
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
17787 17788 17789 17790
        }
    }

    if (help) {
17791 17792
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
17793 17794
            exit(EXIT_FAILURE);
        }
17795 17796 17797

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
17798
        exit(EXIT_SUCCESS);
17799 17800
    }

17801
    if (argc > optind) {
K
Karel Zak 已提交
17802
        /* parse command */
E
Eric Blake 已提交
17803
        ctl->imode = false;
17804
        if (argc - optind == 1) {
17805
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
17806
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
17807
        } else {
17808
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
17809 17810
        }
    }
E
Eric Blake 已提交
17811
    return true;
K
Karel Zak 已提交
17812 17813
}

17814 17815 17816 17817
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
17818
    char *defaultConn;
E
Eric Blake 已提交
17819
    bool ret = true;
K
Karel Zak 已提交
17820

17821 17822 17823
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
17824
    ctl->debug = VSH_DEBUG_DEFAULT;
17825 17826
    ctl->escapeChar = CTRL_CLOSE_BRACKET;

17827

17828 17829
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
17830
        /* failure to setup locale is not fatal */
17831
    }
17832
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
17833
        perror("bindtextdomain");
E
Eric Blake 已提交
17834
        return EXIT_FAILURE;
17835
    }
17836
    if (!textdomain(PACKAGE)) {
17837
        perror("textdomain");
E
Eric Blake 已提交
17838
        return EXIT_FAILURE;
17839 17840
    }

17841 17842 17843 17844 17845
    if (virMutexInit(&ctl->lock) < 0) {
        vshError(ctl, "%s", _("Failed to initialize mutex"));
        return EXIT_FAILURE;
    }

17846 17847 17848 17849 17850
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

17851
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
17852 17853 17854
        progname = argv[0];
    else
        progname++;
17855

17856
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
17857
        ctl->name = vshStrdup(ctl, defaultConn);
17858 17859
    }

D
Daniel P. Berrange 已提交
17860 17861
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
17862
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
17863
    }
17864

D
Daniel P. Berrange 已提交
17865 17866
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
17867
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
17868
    }
17869

K
Karel Zak 已提交
17870
    if (!ctl->imode) {
17871
        ret = vshCommandRun(ctl, ctl->cmd);
17872
    } else {
K
Karel Zak 已提交
17873 17874
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
17875
            vshPrint(ctl,
17876
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
17877
                     progname);
J
Jim Meyering 已提交
17878
            vshPrint(ctl, "%s",
17879
                     _("Type:  'help' for help with commands\n"
17880
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
17881
        }
17882 17883 17884 17885 17886 17887

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
17888
        do {
17889
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
17890
            ctl->cmdstr =
17891
                vshReadline(ctl, prompt);
17892 17893
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
17894
            if (*ctl->cmdstr) {
17895
#if USE_READLINE
K
Karel Zak 已提交
17896
                add_history(ctl->cmdstr);
17897
#endif
17898
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
17899 17900
                    vshCommandRun(ctl, ctl->cmd);
            }
17901
            VIR_FREE(ctl->cmdstr);
17902
        } while (ctl->imode);
K
Karel Zak 已提交
17903

17904 17905
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
17906
    }
17907

K
Karel Zak 已提交
17908 17909
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
17910
}