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

13
#include <config.h>
14

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

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

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

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

static char *progname;

69 70
#define VIRSH_MAX_XML_FILE 10*1024*1024

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

74 75
#define VIR_FROM_THIS VIR_FROM_NONE

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

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

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

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

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

/*
134
 * vshCmdOptType - command option type
135
 */
K
Karel Zak 已提交
136
typedef enum {
137 138 139
    VSH_OT_BOOL,     /* optional boolean option */
    VSH_OT_STRING,   /* optional string option */
    VSH_OT_INT,      /* optional or mandatory int option */
140
    VSH_OT_DATA,     /* string data (as non-option) */
E
Eric Blake 已提交
141 142
    VSH_OT_ARGV,     /* remaining arguments */
    VSH_OT_ALIAS,    /* alternate spelling for a later argument */
K
Karel Zak 已提交
143 144
} vshCmdOptType;

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

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

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

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

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

210 211 212 213 214
/*
 * Command Usage Flags
 */
enum {
    VSH_CMD_FLAG_NOCONNECT = (1 << 0),  /* no prior connection needed */
215
    VSH_CMD_FLAG_ALIAS     = (1 << 1),  /* command is an alias */
216 217
};

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

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

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

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

270
typedef struct vshCmdGrp {
E
Eric Blake 已提交
271
    const char *name;    /* name of group, or NULL for list end */
272 273 274
    const char *keyword; /* help keyword */
    const vshCmdDef *commands;
} vshCmdGrp;
275

276
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
277

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

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

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

E
Eric Blake 已提交
296 297 298
static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
    ATTRIBUTE_RETURN_CHECK;
299 300
static int vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
301 302 303
static int vshCommandOptUInt(const vshCmd *cmd, const char *name,
                             unsigned int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
304 305 306 307 308 309 310 311 312
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;
313 314 315
static int vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                                  unsigned long long *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
E
Eric Blake 已提交
316
static bool vshCommandOptBool(const vshCmd *cmd, const char *name);
317 318
static const vshCmdOpt *vshCommandOptArgv(const vshCmd *cmd,
                                          const vshCmdOpt *opt);
319 320 321
static char *vshGetDomainDescription(vshControl *ctl, virDomainPtr dom,
                                     bool title, unsigned int flags)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_RETURN_CHECK;
K
Karel Zak 已提交
322

323 324 325
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
326
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
327

328
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
329
                                          const char **name, int flag);
K
Karel Zak 已提交
330 331

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

335
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
336
                                            const char **name, int flag);
337 338

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
339 340
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
341 342
                           VSH_BYUUID|VSH_BYNAME)

343
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
344
                                                  const char **name, int flag);
345 346 347 348 349 350

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

351
static virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
352
                                                const char *optname,
353
                                                const char **name, int flag);
354 355 356

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

360
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
361
                            const char *optname, const char **name, int flag);
362 363 364 365 366 367

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

368
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
369 370
                                           const char *optname,
                                           const char *pooloptname,
371
                                           const char **name, int flag);
372 373

/* default is lookup by Name and UUID */
374
#define vshCommandOptVol(_ctl, _cmd, _optname, _pooloptname, _name)   \
375 376 377
    vshCommandOptVolBy(_ctl, _cmd, _optname, _pooloptname, _name,     \
                           VSH_BYUUID|VSH_BYNAME)

378
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
379
                                        const char **name);
380

381
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
382
    ATTRIBUTE_FMT_PRINTF(2, 3);
383
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
384
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
385 386

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

389
static int vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason);
K
Karel Zak 已提交
390
static const char *vshDomainStateToString(int state);
391
static const char *vshDomainStateReasonToString(int state, int reason);
392
static const char *vshDomainControlStateToString(int state);
393
static const char *vshDomainVcpuStateToString(int state);
E
Eric Blake 已提交
394
static bool vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
395 396 397
static virTypedParameterPtr vshFindTypedParamByName(const char *name,
                                                    virTypedParameterPtr list,
                                                    int count);
398 399
static char *vshGetTypedParamValue(vshControl *ctl, virTypedParameterPtr item)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
K
Karel Zak 已提交
400

401 402 403 404
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
/* Typedefs, function prototypes for job progress reporting.
 * There are used by some long lingering commands like
 * migrate, dump, save, managedsave.
 */
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

typedef void (*jobWatchTimeoutFunc) (vshControl *ctl, virDomainPtr dom,
                                     void *opaque);

static bool
vshWatchJob(vshControl *ctl,
            virDomainPtr dom,
            bool verbose,
            int pipe_fd,
            int timeout,
            jobWatchTimeoutFunc timeout_func,
            void *opaque,
            const char *label);

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

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

434
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
435 436
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

437 438
static int parseRateStr(const char *rateStr, virNetDevBandwidthRatePtr rate);

E
Eric Blake 已提交
439 440 441
static void *
_vshMalloc(vshControl *ctl, size_t size, const char *filename, int line)
{
E
Eric Blake 已提交
442
    char *x;
E
Eric Blake 已提交
443

E
Eric Blake 已提交
444
    if (VIR_ALLOC_N(x, size) == 0)
E
Eric Blake 已提交
445 446 447 448 449 450 451 452 453
        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)
{
E
Eric Blake 已提交
454
    char *x;
E
Eric Blake 已提交
455

E
Eric Blake 已提交
456 457
    if (!xalloc_oversized(nmemb, size) &&
        VIR_ALLOC_N(x, nmemb * size) == 0)
E
Eric Blake 已提交
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
        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
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501

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;

502
  /* User visible sort, so we want locale-specific case comparison.  */
503 504 505
  return strcasecmp(*sa, *sb);
}

506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
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 已提交
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552
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)
{
553 554 555 556 557 558 559 560
    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)
561
            goto out;
562
    }
J
John Levon 已提交
563 564

    if (last_error->code == VIR_ERR_OK) {
565
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
566 567 568
        goto out;
    }

569
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
570 571 572 573 574 575

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

576 577 578 579 580 581 582 583 584
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;
}

585 586 587 588 589
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

590 591 592 593 594
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

595 596 597 598 599 600
/*
 * 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
 */
601 602 603 604
static void vshCatchDisconnect(int sig, siginfo_t *siginfo,
                               void *context ATTRIBUTE_UNUSED) {
    if ((sig == SIGPIPE) ||
        (SA_SIGINFO && siginfo->si_signo == SIGPIPE))
605 606 607 608 609 610 611 612 613
        disconnected++;
}

/*
 * vshSetupSignals:
 *
 * Catch SIGPIPE signals which may arise when disconnection
 * from libvirtd occurs
 */
L
Laine Stump 已提交
614
static void
615 616 617 618 619 620 621 622 623 624 625 626 627
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 已提交
628
 * Reconnect after a disconnect from libvirtd
629 630
 *
 */
L
Laine Stump 已提交
631
static void
632 633 634 635 636 637
vshReconnect(vshControl *ctl)
{
    bool connected = false;

    if (ctl->conn != NULL) {
        connected = true;
638
        virConnectClose(ctl->conn);
639
    }
640 641 642 643 644 645

    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);
    if (!ctl->conn)
        vshError(ctl, "%s", _("Failed to reconnect to the hypervisor"));
646
    else if (connected)
647 648
        vshError(ctl, "%s", _("Reconnected to the hypervisor"));
    disconnected = 0;
649
    ctl->useGetInfo = false;
650
    ctl->useSnapshotOld = false;
651
}
652

K
Karel Zak 已提交
653 654 655 656 657 658
/* ---------------
 * Commands
 * ---------------
 */

/*
659
 * "help" command
K
Karel Zak 已提交
660
 */
661
static const vshCmdInfo info_help[] = {
662
    {"help", N_("print help")},
663 664
    {"desc", N_("Prints global help, command specific help, or help for a\n"
                "    group of related commands")},
665

666
    {NULL, NULL}
K
Karel Zak 已提交
667 668
};

669
static const vshCmdOptDef opts_help[] = {
670
    {"command", VSH_OT_DATA, 0, N_("Prints global help, command specific help, or help for a group of related commands")},
671
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
672 673
};

E
Eric Blake 已提交
674
static bool
675
cmdHelp(vshControl *ctl, const vshCmd *cmd)
676
 {
677
    const char *name = NULL;
678

679
    if (vshCommandOptString(cmd, "command", &name) <= 0) {
680
        const vshCmdGrp *grp;
681
        const vshCmdDef *def;
682

683 684 685 686 687 688
        vshPrint(ctl, "%s", _("Grouped commands:\n\n"));

        for (grp = cmdGroups; grp->name; grp++) {
            vshPrint(ctl, _(" %s (help keyword '%s'):\n"), grp->name,
                     grp->keyword);

689 690 691
            for (def = grp->commands; def->name; def++) {
                if (def->flags & VSH_CMD_FLAG_ALIAS)
                    continue;
692 693
                vshPrint(ctl, "    %-30s %s\n", def->name,
                         _(vshCmddefGetInfo(def, "help")));
694
            }
695 696 697 698

            vshPrint(ctl, "\n");
        }

E
Eric Blake 已提交
699
        return true;
700
    }
701

E
Eric Blake 已提交
702
    if (vshCmddefSearch(name)) {
703
        return vshCmddefHelp(ctl, name);
E
Eric Blake 已提交
704
    } else if (vshCmdGrpSearch(name)) {
705 706 707
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
E
Eric Blake 已提交
708
        return false;
K
Karel Zak 已提交
709 710 711
    }
}

712 713 714
/*
 * "autostart" command
 */
715
static const vshCmdInfo info_autostart[] = {
716
    {"help", N_("autostart a domain")},
717
    {"desc",
718
     N_("Configure a domain to be automatically started at boot.")},
719 720 721
    {NULL, NULL}
};

722
static const vshCmdOptDef opts_autostart[] = {
723 724
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
725 726 727
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
728
static bool
729
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
730 731
{
    virDomainPtr dom;
732
    const char *name;
733 734
    int autostart;

735
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
736
        return false;
737

J
Jim Meyering 已提交
738
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
739
        return false;
740 741 742 743

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
744
        if (autostart)
745
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
746
        else
747
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
748
        virDomainFree(dom);
E
Eric Blake 已提交
749
        return false;
750 751
    }

752
    if (autostart)
753
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
754
    else
755
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
756

757
    virDomainFree(dom);
E
Eric Blake 已提交
758
    return true;
759 760
}

K
Karel Zak 已提交
761
/*
762
 * "connect" command
K
Karel Zak 已提交
763
 */
764
static const vshCmdInfo info_connect[] = {
765
    {"help", N_("(re)connect to hypervisor")},
766
    {"desc",
767
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
768
    {NULL, NULL}
K
Karel Zak 已提交
769 770
};

771
static const vshCmdOptDef opts_connect[] = {
E
Eric Blake 已提交
772 773
    {"name",     VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("hypervisor connection URI")},
774
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
775
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
776 777
};

E
Eric Blake 已提交
778
static bool
779
cmdConnect(vshControl *ctl, const vshCmd *cmd)
780
{
E
Eric Blake 已提交
781
    bool ro = vshCommandOptBool(cmd, "readonly");
782
    const char *name = NULL;
783

K
Karel Zak 已提交
784
    if (ctl->conn) {
785 786 787
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
E
Eric Blake 已提交
788
            return false;
K
Karel Zak 已提交
789 790 791
        }
        ctl->conn = NULL;
    }
792

793
    VIR_FREE(ctl->name);
794 795
    if (vshCommandOptString(cmd, "name", &name) < 0) {
        vshError(ctl, "%s", _("Please specify valid connection URI"));
E
Eric Blake 已提交
796
        return false;
797
    }
798
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
799

800
    ctl->useGetInfo = false;
801
    ctl->useSnapshotOld = false;
E
Eric Blake 已提交
802
    ctl->readonly = ro;
K
Karel Zak 已提交
803

804 805 806
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

E
Eric Blake 已提交
810
    return !!ctl->conn;
K
Karel Zak 已提交
811 812
}

813 814
#ifndef WIN32

815
/*
816
 * "console" command
817
 */
818
static const vshCmdInfo info_console[] = {
819
    {"help", N_("connect to the guest console")},
820
    {"desc",
821
     N_("Connect the virtual serial console for the guest")},
822 823 824
    {NULL, NULL}
};

825
static const vshCmdOptDef opts_console[] = {
826
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
827
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
828 829 830 831
    {"force", VSH_OT_BOOL, 0,
      N_("force console connection (disconnect already connected sessions)")},
    {"safe", VSH_OT_BOOL, 0,
      N_("only connect if safe console handling is supported")},
832 833 834
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
835
static bool
836 837 838
cmdRunConsole(vshControl *ctl, virDomainPtr dom,
              const char *name,
              unsigned int flags)
839
{
E
Eric Blake 已提交
840
    bool ret = false;
841
    int state;
842

843
    if ((state = vshDomainState(ctl, dom, NULL)) < 0) {
844 845 846 847
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

848
    if (state == VIR_DOMAIN_SHUTOFF) {
849 850 851 852
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

853 854 855 856 857
    if (!isatty(STDIN_FILENO)) {
        vshError(ctl, "%s", _("Cannot run interactive console without a controlling TTY"));
        goto cleanup;
    }

858
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
859
    vshPrintExtra(ctl, _("Escape character is %s\n"), ctl->escapeChar);
860
    fflush(stdout);
861
    if (vshRunConsole(dom, name, ctl->escapeChar, flags) == 0)
E
Eric Blake 已提交
862
        ret = true;
863 864

 cleanup:
865

866 867 868
    return ret;
}

E
Eric Blake 已提交
869
static bool
870 871 872
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
873
    bool ret = false;
874 875 876
    bool force = vshCommandOptBool(cmd, "force");
    bool safe = vshCommandOptBool(cmd, "safe");
    unsigned int flags = 0;
877
    const char *name = NULL;
878

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

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

885 886 887 888
    if (vshCommandOptString(cmd, "devname", &name) < 0) {
        vshError(ctl, "%s", _("Invalid devname"));
        goto cleanup;
    }
889

890 891 892 893 894 895
    if (force)
        flags |= VIR_DOMAIN_CONSOLE_FORCE;
    if (safe)
        flags |= VIR_DOMAIN_CONSOLE_SAFE;

    ret = cmdRunConsole(ctl, dom, name, flags);
896

897
cleanup:
898 899 900 901
    virDomainFree(dom);
    return ret;
}

902 903 904
#endif /* WIN32 */


K
Karel Zak 已提交
905 906 907
/*
 * "list" command
 */
908
static const vshCmdInfo info_list[] = {
909 910
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
911
    {NULL, NULL}
K
Karel Zak 已提交
912 913
};

914
static const vshCmdOptDef opts_list[] = {
915 916
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
917 918 919 920 921
    {"transient", VSH_OT_BOOL, 0, N_("list transient domains")},
    {"persistent", VSH_OT_BOOL, 0, N_("list persistent domains")},
    {"uuid", VSH_OT_BOOL, 0, N_("list uuid's only")},
    {"name", VSH_OT_BOOL, 0, N_("list domain names only")},
    {"table", VSH_OT_BOOL, 0, N_("list table (default)")},
E
Eric Blake 已提交
922 923
    {"managed-save", VSH_OT_BOOL, 0,
     N_("mark domains with managed save state")},
924
    {"title", VSH_OT_BOOL, 0, N_("show short domain description")},
925 926 927
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
928

E
Eric Blake 已提交
929
static bool
930
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
931
{
932 933 934 935
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
936
    char **names = NULL;
937
    int maxname = 0;
E
Eric Blake 已提交
938
    bool managed = vshCommandOptBool(cmd, "managed-save");
939 940 941 942 943 944 945 946
    bool optTitle = vshCommandOptBool(cmd, "title");
    bool optTable = vshCommandOptBool(cmd, "table");
    bool optUUID = vshCommandOptBool(cmd, "uuid");
    bool optName = vshCommandOptBool(cmd, "name");
    bool optPersistent = vshCommandOptBool(cmd, "persistent");
    bool optTransient = vshCommandOptBool(cmd, "transient");
    bool persistUsed = true;
    virDomainPtr dom = NULL;
947
    char *title;
948
    char uuid[VIR_UUID_STRING_BUFLEN];
E
Eric Blake 已提交
949
    int state;
950
    int persistent;
951
    bool ret = false;
E
Eric Blake 已提交
952

953
    inactive |= all;
K
Karel Zak 已提交
954

955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971
    /* process arguments */
    if (!optPersistent && !optTransient) {
        optPersistent = true;
        optTransient = true;
        persistUsed = false;
    }

    if (optTable + optName + optUUID > 1) {
        vshError(ctl, "%s",
                 _("Only one argument from --table, --name and --uuid"
                   "may be specified."));
        return false;
    }

    if (!optUUID && !optName)
        optTable = true;

972
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
973
        return false;
974

975
    if (active) {
976 977
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
978
            vshError(ctl, "%s", _("Failed to list active domains"));
E
Eric Blake 已提交
979
            return false;
980 981 982 983
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

984
            if ((maxid = virConnectListDomains(ctl->conn, ids, maxid)) < 0) {
985
                vshError(ctl, "%s", _("Failed to list active domains"));
986
                goto cleanup;
987 988
            }

989
            qsort(ids, maxid, sizeof(int), idsorter);
990
        }
991
    }
992

993
    if (inactive) {
994 995
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
996
            vshError(ctl, "%s", _("Failed to list inactive domains"));
997
            goto cleanup;
998
        }
999 1000 1001
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

1002 1003 1004
            if ((maxname = virConnectListDefinedDomains(ctl->conn,
                                                        names,
                                                        maxname)) < 0) {
1005
                vshError(ctl, "%s", _("Failed to list inactive domains"));
1006
                goto cleanup;
1007
            }
1008

1009
            qsort(&names[0], maxname, sizeof(char*), namesorter);
1010
        }
1011
    }
1012

1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
    /* print table header in legacy mode */
    if (optTable) {
        if (optTitle) {
            vshPrintExtra(ctl, " %-5s %-30s %-10s %-20s\n%s\n",
                          _("Id"), _("Name"), _("State"), _("Title"),
                          "-----------------------------------------"
                          "-----------------------------------------");
        } else {
            vshPrintExtra(ctl, " %-5s %-30s %s\n%s\n",
                          _("Id"), _("Name"), _("State"),
                          "-----------------------------------------"
                          "-----------");
        }
1026
    }
1027 1028

    for (i = 0; i < maxid; i++) {
1029
         dom = virDomainLookupByID(ctl->conn, ids[i]);
1030 1031

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

1035 1036 1037 1038 1039
        if (persistUsed) {
            persistent = virDomainIsPersistent(dom);
            if (persistent < 0) {
                vshError(ctl, "%s",
                         _("Failed to determine domain's persistent state"));
1040
                goto cleanup;
1041
            }
1042

1043 1044 1045 1046 1047 1048
            if ((persistent && !optPersistent) ||
                (!persistent && !optTransient)) {
                virDomainFree(dom);
                dom = NULL;
                continue;
            }
1049
       }
1050

1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
       if (optTable) {
           if (optTitle) {
               if (!(title = vshGetDomainDescription(ctl, dom, true, 0)))
                   goto cleanup;

               vshPrint(ctl, " %-5d %-30s %-10s %-20s\n",
                        virDomainGetID(dom),
                        virDomainGetName(dom),
                        _(vshDomainStateToString(vshDomainState(ctl, dom, NULL))),
                        title);
               VIR_FREE(title);
           } else {
               vshPrint(ctl, " %-5d %-30s %s\n",
                        virDomainGetID(dom),
                        virDomainGetName(dom),
                        _(vshDomainStateToString(vshDomainState(ctl, dom, NULL))));
           }
       } else if (optUUID) {
           if (virDomainGetUUIDString(dom, uuid) < 0) {
               vshError(ctl, "%s",
                        _("Failed to get domain's UUID"));
               goto cleanup;
           }
           vshPrint(ctl, "%s\n", uuid);
       } else if (optName) {
           vshPrint(ctl, "%s\n", virDomainGetName(dom));
       }
E
Eric Blake 已提交
1078

1079 1080 1081
       virDomainFree(dom);
       dom = NULL;
    }
1082

1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125
    if (optPersistent) {
        for (i = 0; i < maxname; i++) {
            dom = virDomainLookupByName(ctl->conn, names[i]);

            /* this kind of work with domains is not atomic operation */
            if (!dom)
                continue;

            if (optTable) {
                state = vshDomainState(ctl, dom, NULL);
                if (managed && state == VIR_DOMAIN_SHUTOFF &&
                    virDomainHasManagedSaveImage(dom, 0) > 0)
                    state = -2;

                if (optTitle) {
                    if (!(title = vshGetDomainDescription(ctl, dom, true, 0)))
                        goto cleanup;

                    vshPrint(ctl, " %-5s %-30s %-10s %-20s\n",
                             "-",
                             names[i],
                             state == -2 ? _("saved") : _(vshDomainStateToString(state)),
                             title);
                    VIR_FREE(title);
                } else {
                    vshPrint(ctl, " %-5s %-30s %s\n",
                             "-",
                             names[i],
                             state == -2 ? _("saved") : _(vshDomainStateToString(state)));
                }
           } else if (optUUID) {
               if (virDomainGetUUIDString(dom, uuid) < 0) {
                   vshError(ctl, "%s",
                            _("Failed to get domain's UUID"));
                   goto cleanup;
               }
               vshPrint(ctl, "%s\n", uuid);
           } else if (optName) {
               vshPrint(ctl, "%s\n", names[i]);
           }

           virDomainFree(dom);
           dom = NULL;
1126
        }
1127
    }
1128 1129 1130

    ret = true;
cleanup:
1131 1132
    if (dom)
        virDomainFree(dom);
1133
    VIR_FREE(ids);
1134 1135
    for (i = 0; i < maxname; i++)
        VIR_FREE(names[i]);
1136
    VIR_FREE(names);
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165
    return ret;
}

/*
 * "desc" command for managing domain description and title
 */
static const vshCmdInfo info_desc[] = {
    {"help", N_("show or set domain's description or title")},
    {"desc", N_("Allows to show or modify description or title of a domain.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_desc[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"live", VSH_OT_BOOL, 0, N_("modify/get running state")},
    {"config", VSH_OT_BOOL, 0, N_("modify/get persistent configuration")},
    {"current", VSH_OT_BOOL, 0, N_("modify/get current state configuration")},
    {"title", VSH_OT_BOOL, 0, N_("modify the title instead of description")},
    {"edit", VSH_OT_BOOL, 0, N_("open an editor to modify the description")},
    {"new-desc", VSH_OT_ARGV, 0, N_("message")},
    {NULL, 0, 0, NULL}
};

static bool
cmdDesc(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    virDomainPtr dom;
    bool config = vshCommandOptBool(cmd, "config");
    bool live = vshCommandOptBool(cmd, "live");
1166
    bool current = vshCommandOptBool(cmd, "current");
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182

    bool title = vshCommandOptBool(cmd, "title");
    bool edit = vshCommandOptBool(cmd, "edit");

    int state;
    int type;
    char *desc = NULL;
    char *desc_edited = NULL;
    char *tmp = NULL;
    char *tmpstr;
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
    bool ret = false;
    unsigned int flags = VIR_DOMAIN_AFFECT_CURRENT;

1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195
    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;
    }

1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
    if (!vshConnectionUsability(ctl, ctl->conn))
        return false;

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

    if ((state = vshDomainState(ctl, dom, NULL)) < 0)
        goto cleanup;

    while ((opt = vshCommandOptArgv(cmd, opt))) {
        if (pad)
            virBufferAddChar(&buf, ' ');
        pad = true;
        virBufferAdd(&buf, opt->data, -1);
    }

    if (title)
        type = VIR_DOMAIN_METADATA_TITLE;
    else
        type = VIR_DOMAIN_METADATA_DESCRIPTION;

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to collect new description/title"));
        goto cleanup;
    }
    desc = virBufferContentAndReset(&buf);

    if (edit || desc) {
        if (!desc) {
                desc = vshGetDomainDescription(ctl, dom, title,
                                           config?VIR_DOMAIN_XML_INACTIVE:0);
                if (!desc)
                    goto cleanup;
        }

        if (edit) {
            /* Create and open the temporary file. */
            if (!(tmp = editWriteToTempFile(ctl, desc)))
                goto cleanup;

            /* Start the editor. */
            if (editFile(ctl, tmp) == -1)
                goto cleanup;

            /* Read back the edited file. */
            if (!(desc_edited = editReadBackFile(ctl, tmp)))
                goto cleanup;

            /* strip a possible newline at the end of file; some
             * editors enforce a newline, this makes editing the title
1246
             * more convenient */
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290
            if (title &&
                (tmpstr = strrchr(desc_edited, '\n')) &&
                *(tmpstr+1) == '\0')
                *tmpstr = '\0';

            /* Compare original XML with edited.  Has it changed at all? */
            if (STREQ(desc, desc_edited)) {
                vshPrint(ctl, _("Domain description not changed.\n"));
                ret = true;
                goto cleanup;
            }

            VIR_FREE(desc);
            desc = desc_edited;
            desc_edited = NULL;
        }

        if (virDomainSetMetadata(dom, type, desc, NULL, NULL, flags) < 0) {
            vshError(ctl, "%s",
                     _("Failed to set new domain description"));
            goto cleanup;
        }
        vshPrint(ctl, "%s", _("Domain description updated successfully"));
    } else {
        desc = vshGetDomainDescription(ctl, dom, title,
                                       config?VIR_DOMAIN_XML_INACTIVE:0);
        if (!desc)
            goto cleanup;

        if (strlen(desc) > 0)
            vshPrint(ctl, "%s", desc);
        else
            vshPrint(ctl, _("No description for domain: %s"),
                     virDomainGetName(dom));
    }

    ret = true;
cleanup:
    VIR_FREE(desc_edited);
    VIR_FREE(desc);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
A
Alex Jia 已提交
1291 1292
    if (dom)
        virDomainFree(dom);
1293
    return ret;
K
Karel Zak 已提交
1294 1295 1296
}

/*
K
Karel Zak 已提交
1297
 * "domstate" command
K
Karel Zak 已提交
1298
 */
1299
static const vshCmdInfo info_domstate[] = {
1300 1301
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
1302
    {NULL, NULL}
K
Karel Zak 已提交
1303 1304
};

1305
static const vshCmdOptDef opts_domstate[] = {
1306
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1307
    {"reason", VSH_OT_BOOL, 0, N_("also print reason for the state")},
1308
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
1309 1310
};

E
Eric Blake 已提交
1311
static bool
1312
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
1313
{
K
Karel Zak 已提交
1314
    virDomainPtr dom;
E
Eric Blake 已提交
1315
    bool ret = true;
1316 1317
    int showReason = vshCommandOptBool(cmd, "reason");
    int state, reason;
1318

1319
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1320
        return false;
1321

J
Jim Meyering 已提交
1322
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
1323
        return false;
1324

1325
    if ((state = vshDomainState(ctl, dom, &reason)) < 0) {
E
Eric Blake 已提交
1326
        ret = false;
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337
        goto cleanup;
    }

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

1339
cleanup:
1340 1341 1342 1343
    virDomainFree(dom);
    return ret;
}

1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
/*
 * "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;
}

1391 1392
/* "domblkstat" command
 */
1393
static const vshCmdInfo info_domblkstat[] = {
1394
    {"help", N_("get device block stats for a domain")},
1395 1396
    {"desc", N_("Get device block stats for a running domain. See man page or "
                "use --human for explanation of fields")},
1397 1398 1399
    {NULL,NULL}
};

1400
static const vshCmdOptDef opts_domblkstat[] = {
1401 1402
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416
    {"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",
1417
      N_("number of read operations:") }, /* 0 */
1418
    { VIR_DOMAIN_BLOCK_STATS_READ_BYTES,        "rd_bytes",
1419
      N_("number of bytes read:") }, /* 1 */
1420
    { VIR_DOMAIN_BLOCK_STATS_WRITE_REQ,         "wr_req",
1421
      N_("number of write operations:") }, /* 2 */
1422
    { VIR_DOMAIN_BLOCK_STATS_WRITE_BYTES,       "wr_bytes",
1423
      N_("number of bytes written:") }, /* 3 */
1424
    { VIR_DOMAIN_BLOCK_STATS_ERRS,              "errs",
1425
      N_("error count:") }, /* 4 */
1426
    { VIR_DOMAIN_BLOCK_STATS_FLUSH_REQ,         NULL,
1427
      N_("number of flush operations:") }, /* 5 */
1428
    { VIR_DOMAIN_BLOCK_STATS_READ_TOTAL_TIMES,  NULL,
1429
      N_("total duration of reads (ns):") }, /* 6 */
1430
    { VIR_DOMAIN_BLOCK_STATS_WRITE_TOTAL_TIMES, NULL,
1431
      N_("total duration of writes (ns):") }, /* 7 */
1432 1433 1434 1435 1436 1437 1438
    { 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)                                     \
1439 1440
        vshPrint(ctl, "%s %-*s %lld\n", device,         \
                 human ? 31 : 0,                        \
1441 1442 1443
                 human ? _(domblkstat_output[ID].human) \
                 : domblkstat_output[ID].legacy,        \
                 VALUE);
1444

E
Eric Blake 已提交
1445
static bool
1446
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
1447 1448
{
    virDomainPtr dom;
1449
    const char *name = NULL, *device = NULL;
1450
    struct _virDomainBlockStats stats;
1451
    virTypedParameterPtr params = NULL;
1452 1453 1454
    virTypedParameterPtr par = NULL;
    char *value = NULL;
    const char *field = NULL;
1455
    int rc, nparams = 0;
1456
    int i = 0;
1457
    bool ret = false;
1458
    bool human = vshCommandOptBool(cmd, "human"); /* human readable output */
1459

1460
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1461
        return false;
1462

1463
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1464
        return false;
1465

1466
    if (vshCommandOptString(cmd, "device", &device) <= 0)
1467
        goto cleanup;
1468

1469 1470 1471 1472 1473 1474 1475
    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) {
1476 1477
        /* try older API if newer is not supported */
        if (last_error->code != VIR_ERR_NO_SUPPORT)
1478 1479
            goto cleanup;

1480 1481
        virFreeError(last_error);
        last_error = NULL;
1482

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

1490 1491 1492 1493
        /* human friendly output */
        if (human) {
            vshPrint(ctl, N_("Device: %s\n"), device);
            device = "";
1494
        }
1495 1496 1497 1498 1499 1500

        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);
1501
    } else {
1502
        params = vshCalloc(ctl, nparams, sizeof(*params));
1503

1504 1505 1506 1507
        if (virDomainBlockStatsFlags (dom, device, params, &nparams, 0) < 0) {
            vshError(ctl, _("Failed to get block stats %s %s"), name, device);
            goto cleanup;
        }
1508

1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521
        /* 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;

1522
            value = vshGetTypedParamValue(ctl, par);
1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537

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

1538 1539
            vshPrint(ctl, "%s %-*s %s\n", device,
                     human ? 31 : 0, field, value);
1540 1541 1542 1543 1544

            VIR_FREE(value);
        }

        /* go through the fields again, for remaining fields */
1545
        for (i = 0; i < nparams; i++) {
1546 1547
            if (!*params[i].field)
                continue;
1548

1549
            value = vshGetTypedParamValue(ctl, params+i);
1550 1551
            vshPrint(ctl, "%s %s %s\n", device, params[i].field, value);
            VIR_FREE(value);
1552 1553 1554 1555 1556 1557 1558
        }
    }

    ret = true;

cleanup:
    VIR_FREE(params);
1559
    virDomainFree(dom);
1560
    return ret;
1561
}
1562
#undef DOMBLKSTAT_LEGACY_PRINT
1563 1564 1565

/* "domifstat" command
 */
1566
static const vshCmdInfo info_domifstat[] = {
1567 1568
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1569 1570 1571
    {NULL,NULL}
};

1572
static const vshCmdOptDef opts_domifstat[] = {
1573 1574
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1575 1576 1577
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1578
static bool
1579
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1580 1581
{
    virDomainPtr dom;
1582
    const char *name = NULL, *device = NULL;
1583 1584
    struct _virDomainInterfaceStats stats;

1585
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1586
        return false;
1587

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

1591
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1592
        virDomainFree(dom);
E
Eric Blake 已提交
1593
        return false;
L
Laine Stump 已提交
1594
    }
1595 1596

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1597
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1598
        virDomainFree(dom);
E
Eric Blake 已提交
1599
        return false;
1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626
    }

    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 已提交
1627
    return true;
1628 1629
}

1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649
/* "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;
1650
    const char *iface;
1651
    const char *state;
1652
    const char *value;
1653
    const char *desc;
1654 1655 1656
    unsigned char macaddr[VIR_MAC_BUFLEN];
    const char *element;
    const char *attr;
1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672
    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;

1673
    if (vshCommandOptString(cmd, "interface", &iface) <= 0)
1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701
        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 */
1702
    xml = virXMLParseStringCtxt(desc, _("(domain_definition)"), &ctxt);
1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715
    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;
    }

1716
    if (virMacAddrParse(iface, macaddr) == 0) {
1717 1718 1719 1720 1721 1722 1723
        element = "mac";
        attr = "address";
    } else {
        element = "target";
        attr = "dev";
    }

1724 1725 1726 1727 1728 1729
    /* 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 &&
1730 1731
                xmlStrEqual(cur->name, BAD_CAST element)) {
                value = virXMLPropString(cur, attr);
1732

1733 1734
                if (STRCASEEQ(value, iface)) {
                    VIR_FREE(value);
1735 1736
                    goto hit;
                }
1737
                VIR_FREE(value);
1738 1739 1740 1741 1742
            }
            cur = cur->next;
        }
    }

1743
    vshError(ctl, _("interface (%s: %s) not found"), element, iface);
1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
    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;
1825
    const char *iface = NULL;
1826 1827
    int flags = 0;
    char *state = NULL;
1828 1829 1830 1831
    char *value = NULL;
    unsigned char macaddr[VIR_MAC_BUFLEN];
    const char *element;
    const char *attr;
1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
    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;

1846
    if (vshCommandOptString (cmd, "interface", &iface) <= 0) {
1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859
        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;
    }

1860
    xml = virXMLParseStringCtxt(desc, _("(domain_definition)"), &ctxt);
1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873
    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;
    }

1874
    if (virMacAddrParse(iface, macaddr) == 0) {
1875 1876 1877 1878 1879 1880 1881
        element = "mac";
        attr = "address";
    } else {
        element = "target";
        attr = "dev";
    }

1882 1883 1884 1885 1886 1887
    /* 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 &&
1888
                xmlStrEqual(cur->name, BAD_CAST element)) {
1889

1890
                value = virXMLPropString(cur, attr);
1891

1892 1893
                if (STRCASEEQ(value, iface)) {
                    VIR_FREE(value);
1894 1895
                    goto hit;
                }
1896
                VIR_FREE(value);
1897 1898 1899 1900 1901
            }
            cur = cur->next;
        }
    }

1902
    vshError(ctl, _("Interface (%s: %s) not found."), element, iface);
1903 1904 1905 1906 1907 1908 1909 1910 1911
    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");
1912
            vshPrint(ctl, "%s %s", iface, state);
1913 1914 1915 1916 1917 1918 1919 1920
            VIR_FREE(state);

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

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

1923
    ret = true;
1924 1925 1926 1927 1928 1929 1930 1931 1932 1933
cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    if (dom)
        virDomainFree(dom);

    return ret;
}

1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128
/* "domiftune" command
 */
static const vshCmdInfo info_domiftune[] = {
    {"help", N_("get/set parameters of a virtual interface")},
    {"desc", N_("Get/set parameters of a domain's virtual interface.")},
    {NULL,NULL}
};

static const vshCmdOptDef opts_domiftune[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
    {"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")},
    {"config", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("affect next boot")},
    {"live", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("affect running domain")},
    {"current", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("affect current domain")},
    {NULL, 0, 0, NULL}
};

static bool
cmdDomIftune(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name = NULL, *device = NULL,
               *inboundStr = NULL, *outboundStr = NULL;
    unsigned int flags = 0;
    int nparams = 0;
    virTypedParameterPtr params = NULL;
    bool ret = false;
    int current = vshCommandOptBool(cmd, "current");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    virNetDevBandwidthRate inbound, outbound;
    int i;

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
            return false;
        }
        flags = VIR_DOMAIN_AFFECT_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_AFFECT_LIVE;
    }

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

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

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

    if (vshCommandOptString(cmd, "inbound", &inboundStr) < 0 ||
        vshCommandOptString(cmd, "outbound", &outboundStr) < 0) {
        vshError(ctl, "missing argument");
        goto cleanup;
    }

    memset(&inbound, 0, sizeof(inbound));
    memset(&outbound, 0, sizeof(outbound));

    if (inboundStr) {
        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;
        }
        nparams++; /* average */
        if (inbound.peak) nparams++;
        if (inbound.burst) nparams++;
    }
    if (outboundStr) {
        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;
        }
        nparams++; /* average */
        if (outbound.peak) nparams++;
        if (outbound.burst) nparams++;
    }

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

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

        /* get all interface parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
        if (!params) {
            virReportOOMError();
            goto cleanup;
        }
        if (virDomainGetInterfaceParameters(dom, device, params, &nparams, flags) != 0) {
            vshError(ctl, "%s", _("Unable to get interface parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            char *str = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
            VIR_FREE(str);
        }
    } else {
        /* set the interface parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
        if (!params) {
            virReportOOMError();
            goto cleanup;
        }

        for (i = 0; i < nparams; i++)
            params[i].type = VIR_TYPED_PARAM_UINT;

        i = 0;
        if (inbound.average && i < nparams) {
            if (!virStrcpy(params[i].field, VIR_DOMAIN_BANDWIDTH_IN_AVERAGE,
                           sizeof(params[i].field)))
                goto cleanup;
            params[i].value.ui = inbound.average;
            i++;
        }
        if (inbound.peak && i < nparams) {
            if (!virStrcpy(params[i].field, VIR_DOMAIN_BANDWIDTH_IN_PEAK,
                           sizeof(params[i].field)))
                goto cleanup;
            params[i].value.ui = inbound.peak;
            i++;
        }
        if (inbound.burst && i < nparams) {
            if (!virStrcpy(params[i].field, VIR_DOMAIN_BANDWIDTH_IN_BURST,
                           sizeof(params[i].field)))
                goto cleanup;
            params[i].value.ui = inbound.burst;
            i++;
        }
        if (outbound.average && i < nparams) {
            if (!virStrcpy(params[i].field, VIR_DOMAIN_BANDWIDTH_OUT_AVERAGE,
                           sizeof(params[i].field)))
                goto cleanup;
            params[i].value.ui = outbound.average;
            i++;
        }
        if (outbound.peak && i < nparams) {
            if (!virStrcpy(params[i].field, VIR_DOMAIN_BANDWIDTH_OUT_PEAK,
                           sizeof(params[i].field)))
                goto cleanup;
            params[i].value.ui = outbound.peak;
            i++;
        }
        if (outbound.burst && i < nparams) {
            if (!virStrcpy(params[i].field, VIR_DOMAIN_BANDWIDTH_OUT_BURST,
                           sizeof(params[i].field)))
                goto cleanup;
            params[i].value.ui = outbound.burst;
            i++;
        }

        if (virDomainSetInterfaceParameters(dom, device, params, nparams, flags) != 0) {
            vshError(ctl, "%s", _("Unable to set interface parameters"));
            goto cleanup;
        }
    }

    ret = true;

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

2129 2130 2131
/*
 * "dommemstats" command
 */
2132
static const vshCmdInfo info_dommemstat[] = {
2133
    {"help", N_("get memory statistics for a domain")},
Y
Yuri Chornoivan 已提交
2134
    {"desc", N_("Get memory statistics for a running domain.")},
2135 2136 2137
    {NULL,NULL}
};

2138
static const vshCmdOptDef opts_dommemstat[] = {
2139
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2140 2141 2142
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2143
static bool
2144
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
2145 2146
{
    virDomainPtr dom;
2147
    const char *name;
2148 2149 2150
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

2151
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2152
        return false;
2153 2154

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2155
        return false;
2156 2157 2158 2159 2160

    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 已提交
2161
        return false;
2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176
    }

    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);
2177 2178
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON)
            vshPrint (ctl, "actual %llu\n", stats[i].val);
M
Martin Kletzander 已提交
2179 2180
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_RSS)
            vshPrint (ctl, "rss %llu\n", stats[i].val);
2181 2182 2183
    }

    virDomainFree(dom);
E
Eric Blake 已提交
2184
    return true;
2185 2186
}

2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201
/*
 * "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 已提交
2202
static bool
2203 2204 2205 2206
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
2207
    bool ret = true;
2208
    const char *device = NULL;
2209

2210
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2211
        return false;
2212 2213

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

2216
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
2217
        virDomainFree(dom);
E
Eric Blake 已提交
2218
        return false;
2219 2220 2221 2222
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2223
        return false;
2224 2225 2226 2227 2228 2229 2230 2231 2232 2233
    }

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

2234 2235 2236 2237 2238
/*
 * "domblklist" command
 */
static const vshCmdInfo info_domblklist[] = {
    {"help", N_("list all domain blocks")},
2239
    {"desc", N_("Get the summary of block devices for a domain.")},
2240 2241 2242 2243 2244 2245 2246
    {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")},
2247 2248
    {"details", VSH_OT_BOOL, 0,
     N_("additionally display the type and device value")},
2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263
    {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;
2264
    bool details = false;
2265 2266 2267 2268

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

2269 2270
    details = vshCommandOptBool(cmd, "details");

2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
    if (!vshConnectionUsability(ctl, ctl->conn))
        return false;

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

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

2281
    xmldoc = virXMLParseStringCtxt(xml, _("(domain_definition)"), &ctxt);
2282 2283 2284 2285 2286 2287 2288
    if (!xmldoc)
        goto cleanup;

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

2289 2290 2291 2292 2293 2294
    if (details)
        vshPrint(ctl, "%-10s %-10s %-10s %s\n", _("Type"),
                 _("Device"), _("Target"), _("Source"));
    else
        vshPrint(ctl, "%-10s %s\n", _("Target"), _("Source"));

2295 2296 2297
    vshPrint(ctl, "------------------------------------------------\n");

    for (i = 0; i < ndisks; i++) {
2298 2299
        char *type;
        char *device;
2300 2301 2302 2303
        char *target;
        char *source;

        ctxt->node = disks[i];
2304 2305 2306 2307 2308 2309

        if (details) {
            type = virXPathString("string(./@type)", ctxt);
            device = virXPathString("string(./@device)", ctxt);
        }

2310 2311 2312 2313 2314 2315 2316 2317 2318
        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);
2319 2320 2321 2322 2323 2324 2325 2326 2327
        if (details) {
            vshPrint(ctl, "%-10s %-10s %-10s %s\n", type, device,
                     target, source ? source : "-");
            VIR_FREE(type);
            VIR_FREE(device);
        } else {
            vshPrint(ctl, "%-10s %s\n", target, source ? source : "-");
        }

2328 2329 2330 2331
        VIR_FREE(target);
        VIR_FREE(source);
    }

A
Alex Jia 已提交
2332
    ret = true;
2333 2334 2335 2336

cleanup:
    VIR_FREE(disks);
    virDomainFree(dom);
2337 2338 2339
    VIR_FREE(xml);
    xmlFreeDoc(xmldoc);
    xmlXPathFreeContext(ctxt);
2340 2341 2342
    return ret;
}

2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392
/*
 * "domiflist" command
 */
static const vshCmdInfo info_domiflist[] = {
    {"help", N_("list all domain virtual interfaces")},
    {"desc", N_("Get the summary of virtual interfaces for a domain.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_domiflist[] = {
    {"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
cmdDomiflist(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    bool ret = false;
    unsigned int flags = 0;
    char *xml = NULL;
    xmlDocPtr xmldoc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    int ninterfaces;
    xmlNodePtr *interfaces = NULL;
    int i;

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

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

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

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

    xmldoc = virXMLParseStringCtxt(xml, _("(domain_definition)"), &ctxt);
    if (!xmldoc)
        goto cleanup;

    ninterfaces = virXPathNodeSet("./devices/interface", ctxt, &interfaces);
    if (ninterfaces < 0)
        goto cleanup;

T
Taku Izumi 已提交
2393 2394
    vshPrint(ctl, "%-10s %-10s %-10s %-11s %s\n", _("Interface"), _("Type"),
             _("Source"), _("Model"), _("MAC"));
2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415
    vshPrint(ctl, "-------------------------------------------------------\n");

    for (i = 0; i < ninterfaces; i++) {
        char *type = NULL;
        char *source = NULL;
        char *target = NULL;
        char *model = NULL;
        char *mac = NULL;

        ctxt->node = interfaces[i];
        type = virXPathString("string(./@type)", ctxt);

        source = virXPathString("string(./source/@bridge"
                                "|./source/@dev"
                                "|./source/@network"
                                "|./source/@name)", ctxt);

        target = virXPathString("string(./target/@dev)", ctxt);
        model = virXPathString("string(./model/@type)", ctxt);
        mac = virXPathString("string(./mac/@address)", ctxt);

T
Taku Izumi 已提交
2416
        vshPrint(ctl, "%-10s %-10s %-10s %-11s %-10s\n",
2417
                 target ? target : "-",
T
Taku Izumi 已提交
2418 2419
                 type,
                 source ? source : "-",
2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440
                 model ? model : "-",
                 mac ? mac : "-");

        VIR_FREE(type);
        VIR_FREE(source);
        VIR_FREE(target);
        VIR_FREE(model);
        VIR_FREE(mac);
    }

    ret = true;

cleanup:
    VIR_FREE(interfaces);
    virDomainFree(dom);
    VIR_FREE(xml);
    xmlFreeDoc(xmldoc);
    xmlXPathFreeContext(ctxt);
    return ret;
}

2441 2442 2443
/*
 * "suspend" command
 */
2444
static const vshCmdInfo info_suspend[] = {
2445 2446
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
2447
    {NULL, NULL}
2448 2449
};

2450
static const vshCmdOptDef opts_suspend[] = {
2451
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2452
    {NULL, 0, 0, NULL}
2453 2454
};

E
Eric Blake 已提交
2455
static bool
2456
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
2457
{
2458
    virDomainPtr dom;
2459
    const char *name;
E
Eric Blake 已提交
2460
    bool ret = true;
2461

2462
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2463
        return false;
2464

J
Jim Meyering 已提交
2465
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2466
        return false;
2467 2468

    if (virDomainSuspend(dom) == 0) {
2469
        vshPrint(ctl, _("Domain %s suspended\n"), name);
2470
    } else {
2471
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
2472
        ret = false;
2473
    }
2474

2475 2476 2477 2478
    virDomainFree(dom);
    return ret;
}

2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549
/*
 * "dompmsuspend" command
 */
static const vshCmdInfo info_dom_pm_suspend[] = {
    {"help", N_("suspend a domain for a given time duration")},
    {"desc", N_("Suspend a running domain for a given time duration.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_dom_pm_suspend[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"duration", VSH_OT_INT, VSH_OFLAG_REQ_OPT, N_("duration in seconds")},
    {"target", VSH_OT_STRING, VSH_OFLAG_REQ, N_("mem(Suspend-to-RAM), "
                                                "disk(Suspend-to-Disk), "
                                                "hybrid(Hybrid-Suspend)")},
    {NULL, 0, 0, NULL}
};

static bool
cmdDomPMSuspend(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name;
    bool ret = false;
    const char *target = NULL;
    unsigned int suspendTarget;
    unsigned long long duration = 0;

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

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

    if (vshCommandOptULongLong(cmd, "duration", &duration) < 0) {
        vshError(ctl, _("Invalid duration argument"));
        goto cleanup;
    }

    if (vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(ctl, _("Invalid target argument"));
        goto cleanup;
    }

    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"));
        goto cleanup;
    }

    if (virDomainPMSuspendForDuration(dom, suspendTarget, duration, 0) < 0) {
        vshError(ctl, _("Domain %s could not be suspended"),
                 virDomainGetName(dom));
        goto cleanup;
    }

    vshPrint(ctl, _("Domain %s successfully suspended"),
             virDomainGetName(dom));

    ret = true;

cleanup:
    virDomainFree(dom);
    return ret;
}

2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595
/*
 * "dompmwakeup" command
 */

static const vshCmdInfo info_dom_pm_wakeup[] = {
    {"help", N_("wakeup a domain suspended by dompmsuspend command")},
    {"desc", N_("Wakeup a domain previously suspended "
                "by dompmsuspend command.")},
    {NULL, NULL}
};

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

static bool
cmdDomPMWakeup(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name;
    bool ret = false;
    unsigned int flags = 0;

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

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

    if (virDomainPMWakeup(dom, flags) < 0) {
        vshError(ctl, _("Domain %s could not be woken up"),
                 virDomainGetName(dom));
        goto cleanup;
    }

    vshPrint(ctl, _("Domain %s successfully woken up"),
             virDomainGetName(dom));

    ret = true;

cleanup:
    virDomainFree(dom);
    return ret;
}

2596 2597 2598
/*
 * "create" command
 */
2599
static const vshCmdInfo info_create[] = {
2600 2601
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
2602 2603 2604
    {NULL, NULL}
};

2605
static const vshCmdOptDef opts_create[] = {
2606
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
2607
#ifndef WIN32
2608
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
2609
#endif
2610
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
2611
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
2612 2613 2614
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2615
static bool
2616
cmdCreate(vshControl *ctl, const vshCmd *cmd)
2617 2618
{
    virDomainPtr dom;
2619
    const char *from = NULL;
E
Eric Blake 已提交
2620
    bool ret = true;
2621
    char *buffer;
2622
#ifndef WIN32
2623
    int console = vshCommandOptBool(cmd, "console");
2624
#endif
2625
    unsigned int flags = VIR_DOMAIN_NONE;
2626

2627
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2628
        return false;
2629

2630
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2631
        return false;
2632

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

2636 2637
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
2638 2639
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
2640 2641

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
2642
    VIR_FREE(buffer);
2643

2644
    if (dom != NULL) {
2645
        vshPrint(ctl, _("Domain %s created from %s\n"),
2646
                 virDomainGetName(dom), from);
2647
#ifndef WIN32
2648
        if (console)
2649
            cmdRunConsole(ctl, dom, NULL, 0);
2650
#endif
2651
        virDomainFree(dom);
2652
    } else {
2653
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
2654
        ret = false;
2655 2656 2657 2658
    }
    return ret;
}

2659 2660 2661
/*
 * "define" command
 */
2662
static const vshCmdInfo info_define[] = {
2663 2664
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
2665 2666 2667
    {NULL, NULL}
};

2668
static const vshCmdOptDef opts_define[] = {
2669
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
2670 2671 2672
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2673
static bool
2674
cmdDefine(vshControl *ctl, const vshCmd *cmd)
2675 2676
{
    virDomainPtr dom;
2677
    const char *from = NULL;
E
Eric Blake 已提交
2678
    bool ret = true;
2679
    char *buffer;
2680

2681
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2682
        return false;
2683

2684
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
2685
        return false;
2686

2687
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
2688
        return false;
2689 2690

    dom = virDomainDefineXML(ctl->conn, buffer);
2691
    VIR_FREE(buffer);
2692

2693
    if (dom != NULL) {
2694
        vshPrint(ctl, _("Domain %s defined from %s\n"),
2695
                 virDomainGetName(dom), from);
2696
        virDomainFree(dom);
2697
    } else {
2698
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
2699
        ret = false;
2700 2701 2702 2703 2704 2705 2706
    }
    return ret;
}

/*
 * "undefine" command
 */
2707
static const vshCmdInfo info_undefine[] = {
2708 2709 2710
    {"help", N_("undefine a domain")},
    {"desc",
     N_("Undefine an inactive domain, or convert persistent to transient.")},
2711 2712 2713
    {NULL, NULL}
};

2714
static const vshCmdOptDef opts_undefine[] = {
2715
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
2716
    {"managed-save", VSH_OT_BOOL, 0, N_("remove domain managed state file")},
2717 2718 2719 2720 2721 2722 2723
    {"storage", VSH_OT_DATA, VSH_OFLAG_NONE,
     N_("remove associated storage volumes (comma separated list of targets "
        "or source paths) (see domblklist)")},
    {"remove-all-storage", VSH_OT_BOOL, 0,
     N_("remove all associated storage volumes (use with caution)")},
    {"wipe-storage", VSH_OT_BOOL, VSH_OFLAG_NONE,
     N_("wipe data on the removed volumes")},
2724 2725
    {"snapshots-metadata", VSH_OT_BOOL, 0,
     N_("remove all domain snapshot metadata, if inactive")},
2726 2727 2728
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2729
static bool
2730
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
2731 2732
{
    virDomainPtr dom;
2733
    bool ret = false;
2734
    const char *name = NULL;
2735
    /* Flags to attempt.  */
E
Eric Blake 已提交
2736
    unsigned int flags = 0;
2737 2738 2739
    /* User-requested actions.  */
    bool managed_save = vshCommandOptBool(cmd, "managed-save");
    bool snapshots_metadata = vshCommandOptBool(cmd, "snapshots-metadata");
2740 2741 2742
    bool wipe_storage = vshCommandOptBool(cmd, "wipe-storage");
    bool remove_storage = false;
    bool remove_all_storage = vshCommandOptBool(cmd, "remove-all-storage");
2743
    /* Positive if these items exist.  */
2744
    int has_managed_save = 0;
2745 2746 2747 2748 2749
    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;
2750
    int rc = -1;
2751
    int running;
2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768
    /* list of volumes to remove along with this domain */
    const char *volumes_arg = NULL;
    char *volumes = NULL;
    char **volume_tokens = NULL;
    char *volume_tok = NULL;
    int nvolume_tokens = 0;
    char *def = NULL;
    char *source = NULL;
    char *target = NULL;
    int vol_i;
    int tok_i;
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr *vol_nodes = NULL;
    int nvolumes = 0;
    virStorageVolPtr vol = NULL;
    bool vol_del_failed = false;
2769

2770
    if (managed_save) {
2771
        flags |= VIR_DOMAIN_UNDEFINE_MANAGED_SAVE;
2772 2773 2774 2775 2776 2777
        managed_save_safe = true;
    }
    if (snapshots_metadata) {
        flags |= VIR_DOMAIN_UNDEFINE_SNAPSHOTS_METADATA;
        snapshots_safe = true;
    }
2778

2779
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2780
        return false;
2781

2782
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2783
        return false;
2784

2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795
    /* check if a string that should contain list of volumes to remove is present */
    if (vshCommandOptString(cmd, "storage", &volumes_arg) > 0) {
        volumes = vshStrdup(ctl, volumes_arg);

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

2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814
    /* 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;
            }
2815 2816
            virFreeError(last_error);
            last_error = NULL;
2817
            has_managed_save = 0;
2818 2819
        }

2820 2821
        has_snapshots = virDomainSnapshotNum(dom, 0);
        if (has_snapshots < 0) {
2822 2823
            if (last_error->code != VIR_ERR_NO_SUPPORT) {
                virshReportError(ctl);
2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835
                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.  */
2836 2837
                virFreeError(last_error);
                last_error = NULL;
2838 2839 2840 2841 2842
                has_snapshots_metadata = has_snapshots;
            } else {
                /* The server knew the new flag, all aspects of
                 * undefineFlags are safe.  */
                managed_save_safe = snapshots_safe = true;
2843
            }
2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856
        }
    }
    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;
    }
2857

2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870
    /* Stash domain description for later use */
    if (remove_storage || remove_all_storage) {
        if (running) {
            vshError(ctl, _("Storage volume deletion is supported only on stopped domains"));
            goto cleanup;
        }

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

2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884
    /* 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;
    }
2885

2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897
    /* 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;
2898 2899 2900
        }
    }

2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914
    /* 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:
2915
    if (rc == 0) {
2916
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
2917
        ret = true;
2918
    } else {
2919
        vshError(ctl, _("Failed to undefine domain %s"), name);
2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040
        goto cleanup;
    }

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

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

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

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

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

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

        if (nvolumes < 0)
            goto cleanup;

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

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

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

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

            if (!source)
                continue;

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

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

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

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

        if (!vol_del_failed)
            ret = true;
3041 3042
    }

3043
cleanup:
3044 3045 3046 3047 3048 3049
    VIR_FREE(source);
    VIR_FREE(target);
    VIR_FREE(volumes);
    VIR_FREE(volume_tokens);
    VIR_FREE(def);
    VIR_FREE(vol_nodes);
3050 3051
    if (vol)
        virStorageVolFree(vol);
3052 3053
    xmlFreeDoc(doc);
    xmlXPathFreeContext(ctxt);
3054
    virDomainFree(dom);
3055 3056 3057 3058 3059 3060 3061
    return ret;
}


/*
 * "start" command
 */
3062
static const vshCmdInfo info_start[] = {
3063
    {"help", N_("start a (previously defined) inactive domain")},
3064 3065 3066
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
3067 3068 3069
    {NULL, NULL}
};

3070
static const vshCmdOptDef opts_start[] = {
3071
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
3072
#ifndef WIN32
3073
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
3074
#endif
E
Eric Blake 已提交
3075
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
3076 3077
    {"autodestroy", VSH_OT_BOOL, 0,
     N_("automatically destroy the guest when virsh disconnects")},
3078 3079
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when loading")},
3080 3081
    {"force-boot", VSH_OT_BOOL, 0,
     N_("force fresh boot by discarding any managed save")},
3082 3083 3084
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3085
static bool
3086
cmdStart(vshControl *ctl, const vshCmd *cmd)
3087 3088
{
    virDomainPtr dom;
3089
    bool ret = false;
3090
#ifndef WIN32
3091
    int console = vshCommandOptBool(cmd, "console");
3092
#endif
E
Eric Blake 已提交
3093
    unsigned int flags = VIR_DOMAIN_NONE;
3094
    int rc;
3095

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

3099 3100
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
3101
        return false;
3102 3103

    if (virDomainGetID(dom) != (unsigned int)-1) {
3104
        vshError(ctl, "%s", _("Domain is already active"));
3105
        virDomainFree(dom);
E
Eric Blake 已提交
3106
        return false;
3107 3108
    }

E
Eric Blake 已提交
3109 3110
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
3111 3112
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
3113 3114
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_START_BYPASS_CACHE;
3115 3116
    if (vshCommandOptBool(cmd, "force-boot"))
        flags |= VIR_DOMAIN_START_FORCE_BOOT;
E
Eric Blake 已提交
3117

3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142
    /* 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 已提交
3143 3144
    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
3145
         : virDomainCreate(dom)) < 0) {
3146
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
3147
        goto cleanup;
3148
    }
3149 3150 3151 3152 3153

started:
    vshPrint(ctl, _("Domain %s started\n"),
             virDomainGetName(dom));
#ifndef WIN32
3154
    if (console && !cmdRunConsole(ctl, dom, NULL, 0))
3155 3156 3157 3158 3159 3160
        goto cleanup;
#endif

    ret = true;

cleanup:
3161
    virDomainFree(dom);
3162 3163 3164
    return ret;
}

3165 3166 3167
/*
 * "save" command
 */
3168
static const vshCmdInfo info_save[] = {
3169
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
3170
    {"desc", N_("Save the RAM state of a running domain.")},
3171
    {NULL, NULL}
3172 3173
};

3174
static const vshCmdOptDef opts_save[] = {
3175
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
3176 3177
    {"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")},
3178 3179
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
3180 3181
    {"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")},
3182
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of save")},
3183
    {NULL, 0, 0, NULL}
3184 3185
};

3186 3187
static void
doSave(void *opaque)
3188
{
3189 3190 3191 3192 3193
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
    char ret = '1';
    virDomainPtr dom = NULL;
3194 3195
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
3196
    unsigned int flags = 0;
3197 3198
    const char *xmlfile = NULL;
    char *xml = NULL;
3199 3200 3201 3202 3203 3204
    sigset_t sigmask, oldsigmask;

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

3206
    if (!vshConnectionUsability(ctl, ctl->conn))
3207
        goto out;
3208

3209
    if (vshCommandOptString(cmd, "file", &to) <= 0)
3210
        goto out;
3211

3212 3213
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
3214 3215 3216 3217
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
3218

3219 3220
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
3221
        goto out;
3222 3223
    }

J
Jim Meyering 已提交
3224
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
3225
        goto out;
3226

3227 3228
    if (xmlfile &&
        virFileReadAll(xmlfile, 8192, &xml) < 0)
3229
        goto out;
3230 3231 3232

    if (((flags || xml)
         ? virDomainSaveFlags(dom, to, xml, flags)
3233
         : virDomainSave(dom, to)) < 0) {
3234
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
3235
        goto out;
3236
    }
3237

3238
    ret = '0';
3239

3240 3241 3242 3243
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
    if (dom) virDomainFree (dom);
3244
    VIR_FREE(xml);
3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

static bool
cmdSave(vshControl *ctl, const vshCmd *cmd)
{
    bool ret = false;
    virDomainPtr dom = NULL;
    int p[2] = {-1. -1};
    virThread workerThread;
    bool verbose = false;
    vshCtrlData data;
    const char *to = NULL;
    const char *name = NULL;

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

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

    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

    if (pipe(p) < 0)
        goto cleanup;

    data.ctl = ctl;
    data.cmd = cmd;
    data.writefd = p[1];

    if (virThreadCreate(&workerThread,
                        true,
                        doSave,
                        &data) < 0)
        goto cleanup;

    ret = vshWatchJob(ctl, dom, verbose, p[0], 0, NULL, NULL, _("Save"));

    virThreadJoin(&workerThread);

    if (ret)
        vshPrint(ctl, _("\nDomain %s saved to %s\n"), name, to);

cleanup:
    if (dom)
        virDomainFree(dom);
3292 3293 3294
    return ret;
}

3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315
/*
 * "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 已提交
3316
    unsigned int flags = 0;
3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352
    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")},
3353 3354
    {"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")},
3355 3356 3357 3358 3359 3360 3361 3362 3363 3364
    {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;
3365 3366 3367 3368 3369 3370
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385

    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;

3386
    if (virDomainSaveImageDefineXML(ctl->conn, file, xml, flags) < 0) {
3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409
        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")},
3410 3411
    {"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")},
3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422
    {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;
3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438
    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;
    }
3439 3440 3441 3442 3443 3444 3445 3446

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

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

    /* Get the XML configuration of the saved image.  */
3447
    doc = virDomainSaveImageGetXMLDesc(ctl->conn, file, getxml_flags);
3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464
    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;

3465 3466 3467
    /* 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) {
3468 3469 3470 3471 3472 3473 3474
        vshPrint(ctl, _("Saved image %s XML configuration not changed.\n"),
                 file);
        ret = true;
        goto cleanup;
    }

    /* Everything checks out, so redefine the xml.  */
3475 3476
    if (virDomainSaveImageDefineXML(ctl->conn, file, doc_edited,
                                    define_flags) < 0) {
3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493
        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;
}

3494 3495 3496 3497 3498
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
3499 3500 3501 3502
    {"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.")},
3503 3504 3505 3506
    {NULL, NULL}
};

static const vshCmdOptDef opts_managedsave[] = {
3507
    {"bypass-cache", VSH_OT_BOOL, 0, N_("avoid file system cache when saving")},
3508
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3509 3510
    {"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")},
3511
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of save")},
3512 3513 3514
    {NULL, 0, 0, NULL}
};

3515 3516
static void
doManagedsave(void *opaque)
3517
{
3518 3519 3520 3521 3522
    char ret = '1';
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
    virDomainPtr dom = NULL;
3523
    const char *name;
E
Eric Blake 已提交
3524
    unsigned int flags = 0;
3525 3526 3527 3528 3529 3530
    sigset_t sigmask, oldsigmask;

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

3532
    if (!vshConnectionUsability(ctl, ctl->conn))
3533
        goto out;
3534

3535 3536
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
3537 3538 3539 3540
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
3541

3542
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
3543
        goto out;
3544

3545
    if (virDomainManagedSave(dom, flags) < 0) {
3546
        vshError(ctl, _("Failed to save domain %s state"), name);
3547
        goto out;
3548 3549
    }

3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595
    ret = '0';
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
    if (dom)
        virDomainFree (dom);
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

static bool
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int p[2] = { -1, -1};
    bool ret = false;
    bool verbose = false;
    const char *name = NULL;
    vshCtrlData data;
    virThread workerThread;

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

    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

    if (pipe(p) < 0)
        goto cleanup;

    data.ctl = ctl;
    data.cmd = cmd;
    data.writefd = p[1];

    if (virThreadCreate(&workerThread,
                        true,
                        doManagedsave,
                        &data) < 0)
        goto cleanup;

    ret = vshWatchJob(ctl, dom, verbose, p[0], 0,
                      NULL, NULL, _("Managedsave"));

    virThreadJoin(&workerThread);

    if (ret)
        vshPrint(ctl, _("\nDomain %s state saved by libvirt\n"), name);
3596 3597

cleanup:
3598
    virDomainFree(dom);
3599 3600
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
3601 3602 3603
    return ret;
}

3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617
/*
 * "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 已提交
3618
static bool
3619 3620 3621
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
3622
    const char *name;
E
Eric Blake 已提交
3623
    bool ret = false;
3624 3625
    int hassave;

3626
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3627
        return false;
3628 3629

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
3630
        return false;
3631 3632 3633

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
3634
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650
        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 已提交
3651
    ret = true;
3652 3653 3654 3655 3656 3657

cleanup:
    virDomainFree(dom);
    return ret;
}

3658 3659 3660
/*
 * "schedinfo" command
 */
3661
static const vshCmdInfo info_schedinfo[] = {
3662 3663
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
3664 3665 3666
    {NULL, NULL}
};

3667
static const vshCmdOptDef opts_schedinfo[] = {
3668 3669 3670 3671
    {"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")},
3672 3673 3674
    {"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")},
3675 3676 3677
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
3678
static int
3679
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
3680
                   virTypedParameterPtr param)
3681
{
3682
    const char *data = NULL;
3683 3684 3685

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
3686
        param->type == VIR_TYPED_PARAM_UINT &&
3687 3688
        vshCommandOptBool(cmd, "weight")) {
        int val;
3689
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
3690
            vshError(ctl, "%s", _("Invalid value of weight"));
3691
            return -1;
3692
        } else {
3693
            param->value.ui = val;
3694
        }
3695
        return 1;
3696 3697
    }

3698 3699
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
3700
        param->type == VIR_TYPED_PARAM_UINT &&
3701 3702
        vshCommandOptBool(cmd, "cap")) {
        int val;
3703
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
3704
            vshError(ctl, "%s", _("Invalid value of cap"));
3705
            return -1;
3706
        } else {
3707
            param->value.ui = val;
3708
        }
3709
        return 1;
3710
    }
3711

3712
    if (vshCommandOptString(cmd, "set", &data) > 0) {
3713 3714 3715
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
3716
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
3717
            return -1;
3718
        }
3719 3720 3721 3722 3723 3724 3725 3726 3727
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
3728
        case VIR_TYPED_PARAM_INT:
3729
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
3730
                vshError(ctl, "%s",
3731 3732 3733 3734
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
3735
        case VIR_TYPED_PARAM_UINT:
3736
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
3737
                vshError(ctl, "%s",
3738 3739 3740 3741
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
3742
        case VIR_TYPED_PARAM_LLONG:
3743
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
3744
                vshError(ctl, "%s",
J
Jim Meyering 已提交
3745
                         _("Invalid value for parameter, expecting a long long"));
3746 3747 3748
                return -1;
            }
            break;
3749
        case VIR_TYPED_PARAM_ULLONG:
3750
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
3751
                vshError(ctl, "%s",
3752 3753 3754 3755
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
3756
        case VIR_TYPED_PARAM_DOUBLE:
3757
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
3758
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
3759 3760 3761
                return -1;
            }
            break;
3762
        case VIR_TYPED_PARAM_BOOLEAN:
3763
            param->value.b = STREQ(val, "0") ? 0 : 1;
3764
        }
3765
        return 1;
3766
    }
3767

3768 3769
    return 0;
}
3770

3771

E
Eric Blake 已提交
3772
static bool
3773 3774 3775 3776
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
3777
    virTypedParameterPtr params = NULL;
3778 3779 3780
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
3781
    bool ret_val = false;
3782 3783 3784 3785 3786 3787 3788 3789 3790 3791
    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;
        }
3792
        flags = VIR_DOMAIN_AFFECT_CURRENT;
3793 3794
    } else {
        if (config)
3795
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3796
        if (live)
3797
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3798
    }
3799

3800
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3801
        return false;
3802

3803
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3804
        return false;
3805 3806 3807

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
3808
    if (schedulertype != NULL) {
3809
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
3810
             schedulertype);
3811
        VIR_FREE(schedulertype);
3812
    } else {
3813
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
3814
        goto cleanup;
3815 3816
    }

3817
    if (nparams) {
3818
        params = vshMalloc(ctl, sizeof(*params) * nparams);
3819

3820
        memset(params, 0, sizeof(*params) * nparams);
3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831
        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);
        }
3832 3833 3834 3835
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
3836
        for (i = 0; i < nparams; i++) {
3837 3838 3839 3840 3841 3842 3843 3844 3845 3846
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
3847 3848 3849 3850 3851
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
3852 3853 3854
            if (ret == -1)
                goto cleanup;

3855 3856 3857 3858 3859 3860 3861
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
3862 3863
            if (ret == -1)
                goto cleanup;
3864 3865 3866 3867
        } 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.  */
3868 3869
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
3870 3871 3872 3873
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
3874 3875 3876 3877 3878 3879
            /* 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;
            }
3880 3881
        }

E
Eric Blake 已提交
3882
        ret_val = true;
3883
        for (i = 0; i < nparams; i++) {
3884 3885 3886
            char *str = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
            VIR_FREE(str);
3887 3888
        }
    }
3889

3890
 cleanup:
3891
    VIR_FREE(params);
3892
    virDomainFree(dom);
3893
    return ret_val;
3894 3895
}

3896 3897 3898
/*
 * "restore" command
 */
3899
static const vshCmdInfo info_restore[] = {
3900 3901
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
3902
    {NULL, NULL}
3903 3904
};

3905
static const vshCmdOptDef opts_restore[] = {
3906
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
3907 3908
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when restoring")},
3909 3910
    {"xml", VSH_OT_STRING, 0,
     N_("filename containing updated XML for the target")},
3911 3912
    {"running", VSH_OT_BOOL, 0, N_("restore domain into running state")},
    {"paused", VSH_OT_BOOL, 0, N_("restore domain into paused state")},
3913
    {NULL, 0, 0, NULL}
3914 3915
};

E
Eric Blake 已提交
3916
static bool
3917
cmdRestore(vshControl *ctl, const vshCmd *cmd)
3918
{
3919
    const char *from = NULL;
3920
    bool ret = false;
E
Eric Blake 已提交
3921
    unsigned int flags = 0;
3922 3923
    const char *xmlfile = NULL;
    char *xml = NULL;
3924

3925
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3926
        return false;
3927

3928
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
3929
        return false;
3930

3931 3932
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DOMAIN_SAVE_BYPASS_CACHE;
3933 3934 3935 3936
    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SAVE_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SAVE_PAUSED;
3937

3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948
    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)
3949
         : virDomainRestore(ctl->conn, from)) < 0) {
3950
        vshError(ctl, _("Failed to restore domain from %s"), from);
3951
        goto cleanup;
3952
    }
3953 3954 3955 3956 3957

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

cleanup:
3958
    VIR_FREE(xml);
3959 3960 3961
    return ret;
}

D
Daniel Veillard 已提交
3962 3963 3964
/*
 * "dump" command
 */
3965
static const vshCmdInfo info_dump[] = {
3966 3967
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
3968 3969 3970
    {NULL, NULL}
};

3971
static const vshCmdOptDef opts_dump[] = {
3972 3973
    {"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")},
3974 3975
    {"bypass-cache", VSH_OT_BOOL, 0,
     N_("avoid file system cache when saving")},
3976
    {"reset", VSH_OT_BOOL, 0, N_("reset the domain after core dump")},
3977 3978
    {"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")},
3979
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of dump")},
D
Daniel Veillard 已提交
3980 3981 3982
    {NULL, 0, 0, NULL}
};

3983 3984
static void
doDump(void *opaque)
D
Daniel Veillard 已提交
3985
{
3986 3987 3988 3989 3990 3991
    char ret = '1';
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
    virDomainPtr dom = NULL;
    sigset_t sigmask, oldsigmask;
3992 3993
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
3994
    unsigned int flags = 0;
D
Daniel Veillard 已提交
3995

3996 3997 3998 3999 4000
    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
    if (pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask) < 0)
        goto out_sig;

4001
    if (!vshConnectionUsability(ctl, ctl->conn))
4002
        goto out;
D
Daniel Veillard 已提交
4003

4004
    if (vshCommandOptString(cmd, "file", &to) <= 0)
4005
        goto out;
D
Daniel Veillard 已提交
4006

J
Jim Meyering 已提交
4007
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
4008
        goto out;
D
Daniel Veillard 已提交
4009

P
Paolo Bonzini 已提交
4010 4011
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
4012 4013
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;
4014 4015
    if (vshCommandOptBool(cmd, "bypass-cache"))
        flags |= VIR_DUMP_BYPASS_CACHE;
4016 4017
    if (vshCommandOptBool(cmd, "reset"))
        flags |= VIR_DUMP_RESET;
4018

4019
    if (virDomainCoreDump(dom, to, flags) < 0) {
4020
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
4021
        goto out;
D
Daniel Veillard 已提交
4022 4023
    }

4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072
    ret = '0';
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
    if (dom)
        virDomainFree (dom);
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

static bool
cmdDump(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    int p[2] = { -1, -1};
    bool ret = false;
    bool verbose = false;
    const char *name = NULL;
    const char *to = NULL;
    vshCtrlData data;
    virThread workerThread;

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

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

    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

    if (pipe(p) < 0)
        goto cleanup;

    data.ctl = ctl;
    data.cmd = cmd;
    data.writefd = p[1];

    if (virThreadCreate(&workerThread,
                        true,
                        doDump,
                        &data) < 0)
        goto cleanup;

    ret = vshWatchJob(ctl, dom, verbose, p[0], 0, NULL, NULL, _("Dump"));

    virThreadJoin(&workerThread);

    if (ret)
        vshPrint(ctl, _("\nDomain %s dumped to %s\n"), name, to);
4073 4074

cleanup:
D
Daniel Veillard 已提交
4075
    virDomainFree(dom);
4076 4077
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
D
Daniel Veillard 已提交
4078 4079 4080
    return ret;
}

4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154
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;
4155
    bool created = false;
4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194
    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;
        }
4195 4196
    } else {
        created = true;
4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225
    }

    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);
4226
    VIR_FREE(mime);
4227 4228 4229
    return ret;
}

4230 4231 4232
/*
 * "resume" command
 */
4233
static const vshCmdInfo info_resume[] = {
4234 4235
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
4236
    {NULL, NULL}
4237 4238
};

4239
static const vshCmdOptDef opts_resume[] = {
4240
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4241
    {NULL, 0, 0, NULL}
4242 4243
};

E
Eric Blake 已提交
4244
static bool
4245
cmdResume(vshControl *ctl, const vshCmd *cmd)
4246
{
4247
    virDomainPtr dom;
E
Eric Blake 已提交
4248
    bool ret = true;
4249
    const char *name;
4250

4251
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4252
        return false;
4253

J
Jim Meyering 已提交
4254
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
4255
        return false;
4256 4257

    if (virDomainResume(dom) == 0) {
4258
        vshPrint(ctl, _("Domain %s resumed\n"), name);
4259
    } else {
4260
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
4261
        ret = false;
4262
    }
4263

4264 4265 4266 4267
    virDomainFree(dom);
    return ret;
}

4268 4269 4270
/*
 * "shutdown" command
 */
4271
static const vshCmdInfo info_shutdown[] = {
4272 4273
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
4274
    {NULL, NULL}
4275 4276
};

4277
static const vshCmdOptDef opts_shutdown[] = {
4278
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4279
    {"mode", VSH_OT_STRING, VSH_OFLAG_NONE, N_("shutdown mode: acpi|agent")},
4280
    {NULL, 0, 0, NULL}
4281 4282
};

E
Eric Blake 已提交
4283
static bool
4284
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
4285
{
4286
    virDomainPtr dom;
E
Eric Blake 已提交
4287
    bool ret = true;
4288
    const char *name;
4289 4290 4291
    const char *mode = NULL;
    int flags = 0;
    int rv;
4292

4293
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4294
        return false;
4295

4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311
    if (vshCommandOptString(cmd, "mode", &mode) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
        return false;
    }

    if (mode) {
        if (STREQ(mode, "acpi")) {
            flags |= VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN;
        } else if (STREQ(mode, "agent")) {
            flags |= VIR_DOMAIN_SHUTDOWN_GUEST_AGENT;
        } else {
            vshError(ctl, _("Unknown mode %s value, expecting 'acpi' or 'agent'"), mode);
            return false;
        }
    }

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

4315 4316 4317 4318 4319
    if (flags)
        rv = virDomainShutdownFlags(dom, flags);
    else
        rv = virDomainShutdown(dom);
    if (rv == 0) {
4320
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
4321
    } else {
4322
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
4323
        ret = false;
4324
    }
4325

4326 4327 4328 4329
    virDomainFree(dom);
    return ret;
}

4330 4331 4332
/*
 * "reboot" command
 */
4333
static const vshCmdInfo info_reboot[] = {
4334 4335
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
4336 4337 4338
    {NULL, NULL}
};

4339
static const vshCmdOptDef opts_reboot[] = {
4340
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4341
    {"mode", VSH_OT_STRING, VSH_OFLAG_NONE, N_("shutdown mode: acpi|agent")},
4342 4343 4344
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4345
static bool
4346
cmdReboot(vshControl *ctl, const vshCmd *cmd)
4347 4348
{
    virDomainPtr dom;
E
Eric Blake 已提交
4349
    bool ret = true;
4350
    const char *name;
4351 4352
    const char *mode = NULL;
    int flags = 0;
4353

4354
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4355
        return false;
4356

4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372
    if (vshCommandOptString(cmd, "mode", &mode) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
        return false;
    }

    if (mode) {
        if (STREQ(mode, "acpi")) {
            flags |= VIR_DOMAIN_SHUTDOWN_ACPI_POWER_BTN;
        } else if (STREQ(mode, "agent")) {
            flags |= VIR_DOMAIN_SHUTDOWN_GUEST_AGENT;
        } else {
            vshError(ctl, _("Unknown mode %s value, expecting 'acpi' or 'agent'"), mode);
            return false;
        }
    }

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

4376
    if (virDomainReboot(dom, flags) == 0) {
4377
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
4378
    } else {
4379
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
4380
        ret = false;
4381 4382 4383 4384 4385 4386
    }

    virDomainFree(dom);
    return ret;
}

X
Xu He Jie 已提交
4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424
/*
 * "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;
}

4425 4426 4427
/*
 * "destroy" command
 */
4428
static const vshCmdInfo info_destroy[] = {
4429 4430 4431
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
4432
    {NULL, NULL}
4433 4434
};

4435
static const vshCmdOptDef opts_destroy[] = {
4436
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4437
    {"graceful", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("terminate gracefully")},
4438
    {NULL, 0, 0, NULL}
4439 4440
};

E
Eric Blake 已提交
4441
static bool
4442
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
4443
{
4444
    virDomainPtr dom;
E
Eric Blake 已提交
4445
    bool ret = true;
4446
    const char *name;
4447 4448
    unsigned int flags = 0;
    int result;
4449

4450
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4451
        return false;
4452

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

4456 4457 4458 4459 4460 4461 4462 4463 4464
    if (vshCommandOptBool(cmd, "graceful"))
       flags |= VIR_DOMAIN_DESTROY_GRACEFUL;

    if (flags)
       result = virDomainDestroyFlags(dom, VIR_DOMAIN_DESTROY_GRACEFUL);
    else
       result = virDomainDestroy(dom);

    if (result == 0) {
4465
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
4466
    } else {
4467
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
4468
        ret = false;
4469
    }
4470

4471
    virDomainFree(dom);
K
Karel Zak 已提交
4472 4473 4474 4475
    return ret;
}

/*
4476
 * "dominfo" command
K
Karel Zak 已提交
4477
 */
4478
static const vshCmdInfo info_dominfo[] = {
4479 4480
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
4481
    {NULL, NULL}
K
Karel Zak 已提交
4482 4483
};

4484
static const vshCmdOptDef opts_dominfo[] = {
4485
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4486
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4487 4488
};

E
Eric Blake 已提交
4489
static bool
4490
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
4491
{
K
Karel Zak 已提交
4492 4493
    virDomainInfo info;
    virDomainPtr dom;
4494
    virSecurityModel secmodel;
4495
    virSecurityLabelPtr seclabel;
4496
    int persistent = 0;
E
Eric Blake 已提交
4497 4498
    bool ret = true;
    int autostart;
4499
    unsigned int id;
4500
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
4501
    int has_managed_save = 0;
4502

4503
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4504
        return false;
K
Karel Zak 已提交
4505

J
Jim Meyering 已提交
4506
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4507
        return false;
4508

4509 4510
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
4511
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
4512
    else
4513
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
4514 4515
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
4516
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
4517
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
4518 4519

    if ((str = virDomainGetOSType(dom))) {
4520
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
4521
        VIR_FREE(str);
4522 4523 4524
    }

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

4528
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
4529 4530

        if (info.cpuTime != 0) {
4531
            double cpuUsed = info.cpuTime;
4532

4533
            cpuUsed /= 1000000000.0;
4534

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

4538 4539
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
4540
                 info.maxMem);
4541
        else
4542
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
4543 4544
                 _("no limit"));

4545
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
4546 4547
                 info.memory);

K
Karel Zak 已提交
4548
    } else {
E
Eric Blake 已提交
4549
        ret = false;
K
Karel Zak 已提交
4550
    }
4551

4552 4553
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
4554 4555
    vshDebug(ctl, VSH_ERR_DEBUG, "Domain persistent flag value: %d\n",
             persistent);
4556 4557 4558 4559 4560 4561
    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 */
4562
    if (!virDomainGetAutostart(dom, &autostart)) {
4563
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
4564 4565 4566
                 autostart ? _("enable") : _("disable") );
    }

4567 4568 4569 4570 4571 4572 4573
    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"));

4574 4575 4576
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
4577 4578
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
4579
            return false;
4580 4581 4582
        } else {
            virFreeError(last_error);
            last_error = NULL;
4583
        }
4584 4585 4586 4587 4588 4589 4590
    } 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 */
4591
            if (VIR_ALLOC(seclabel) < 0) {
4592
                virDomainFree(dom);
E
Eric Blake 已提交
4593
                return false;
4594 4595 4596 4597 4598
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
4599
                return false;
4600
            } else {
4601
                if (seclabel->label[0] != '\0')
4602
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
4603
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
4604
            }
4605 4606

            VIR_FREE(seclabel);
4607 4608
        }
    }
4609
    virDomainFree(dom);
K
Karel Zak 已提交
4610 4611 4612
    return ret;
}

4613 4614 4615 4616
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
4617 4618
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
4619 4620 4621 4622
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
4623
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4624 4625 4626 4627
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
4628
static bool
4629 4630 4631 4632
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
4633
    bool ret = true;
4634

4635
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4636
        return false;
4637 4638

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4639
        return false;
4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665

    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 已提交
4666
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
4667
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
4668
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
4669
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
4670
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
4671 4672 4673
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
4674
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
4675
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
4676
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
4677
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
4678
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
4679 4680 4681
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
4682
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
4683
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
4684
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
4685
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
4686
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
4687 4688
        }
    } else {
E
Eric Blake 已提交
4689
        ret = false;
4690 4691 4692 4693 4694 4695
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

4696 4697 4698 4699
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
4700 4701
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
4702 4703 4704 4705
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
4706
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4707 4708 4709
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4710
static bool
4711 4712 4713
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
4714
    bool ret = true;
4715

4716
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4717
        return false;
4718 4719

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
4723
        ret = false;
4724 4725 4726 4727 4728

    virDomainFree(dom);
    return ret;
}

4729 4730 4731
/*
 * "freecell" command
 */
4732
static const vshCmdInfo info_freecell[] = {
4733 4734
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
4735 4736 4737
    {NULL, NULL}
};

4738
static const vshCmdOptDef opts_freecell[] = {
4739
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
4740
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
4741 4742 4743
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4744
static bool
4745
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
4746
{
W
Wen Congyang 已提交
4747
    bool func_ret = false;
4748
    int ret;
4749
    int cell = -1, cell_given;
4750
    unsigned long long memory;
4751 4752 4753 4754
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
4755
    int all_given;
4756 4757 4758 4759
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
4760

4761

4762
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4763
        return false;
4764

4765 4766 4767 4768
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
4769 4770 4771 4772 4773 4774 4775 4776 4777
    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) {
4778 4779 4780
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
4781 4782 4783
            goto cleanup;
        }

4784
        xml = virXMLParseStringCtxt(cap_xml, _("(capabilities)"), &ctxt);
4785 4786
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
4787 4788
            goto cleanup;
        }
4789 4790 4791 4792
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
4793
            vshError(ctl, "%s", _("could not get information about "
4794
                                  "NUMA topology"));
4795 4796 4797
            goto cleanup;
        }

4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818
        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;
            }
        }

4819
        memory = 0;
4820 4821 4822 4823
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
4824 4825 4826 4827
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
4828
    } else {
4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842
        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));
4843 4844
    }

E
Eric Blake 已提交
4845
    func_ret = true;
4846

4847
cleanup:
4848
    xmlXPathFreeContext(ctxt);
4849
    xmlFreeDoc(xml);
4850
    VIR_FREE(nodes);
4851 4852 4853
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
4854
    return func_ret;
4855 4856
}

E
Eric Blake 已提交
4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870
/*
 * "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 已提交
4871
static bool
E
Eric Blake 已提交
4872 4873
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
4874
    const char *type = NULL;
E
Eric Blake 已提交
4875 4876
    int vcpus;

4877 4878
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
4879
        return false;
4880
    }
E
Eric Blake 已提交
4881 4882

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

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

E
Eric Blake 已提交
4890
    return true;
E
Eric Blake 已提交
4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904
}

/*
 * "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")},
4905
    {"active", VSH_OT_BOOL, 0, N_("get number of currently active vcpus")},
E
Eric Blake 已提交
4906
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
4907 4908 4909
    {"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 已提交
4910 4911 4912
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4913
static bool
E
Eric Blake 已提交
4914 4915 4916
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
4917
    bool ret = true;
E
Eric Blake 已提交
4918
    int maximum = vshCommandOptBool(cmd, "maximum");
4919
    int active = vshCommandOptBool(cmd, "active");
E
Eric Blake 已提交
4920 4921
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
4922 4923
    int current = vshCommandOptBool(cmd, "current");
    bool all = maximum + active + current + config + live == 0;
E
Eric Blake 已提交
4924 4925
    int count;

4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940
    /* 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 已提交
4941
        return false;
E
Eric Blake 已提交
4942
    }
4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955

    /* 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 已提交
4956
        vshError(ctl, "%s",
4957
                 _("--maximum and --active cannot both be specified"));
E
Eric Blake 已提交
4958
        return false;
E
Eric Blake 已提交
4959
    }
4960 4961 4962
    if (current + config + live > 1) {
        vshError(ctl, "%s",
                 _("--config, --live, and --current are mutually exclusive"));
E
Eric Blake 已提交
4963
        return false;
E
Eric Blake 已提交
4964 4965 4966
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4967
        return false;
E
Eric Blake 已提交
4968 4969

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

    /* In all cases, try the new API first; if it fails because we are
4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986
     * 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 已提交
4987 4988
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
4989
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
4990 4991 4992 4993 4994 4995 4996 4997 4998
        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;
            }
4999 5000
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
5001 5002 5003 5004 5005
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
5006
            ret = false;
E
Eric Blake 已提交
5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018
        } 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 |
5019
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
5020 5021 5022 5023 5024 5025 5026
        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 已提交
5027
            ret = false;
E
Eric Blake 已提交
5028 5029 5030 5031 5032 5033 5034 5035 5036 5037
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

5038
    if (all || (active && config)) {
5039
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063
        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 已提交
5064
            ret = false;
E
Eric Blake 已提交
5065 5066 5067 5068 5069 5070 5071 5072 5073 5074
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

5075
    if (all || (active && live)) {
5076
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
5077 5078 5079 5080 5081 5082 5083 5084 5085
        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 已提交
5086
            ret = false;
E
Eric Blake 已提交
5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100
        } 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;
}

5101 5102 5103
/*
 * "vcpuinfo" command
 */
5104
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
5105
    {"help", N_("detailed domain vcpu information")},
5106
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
5107 5108 5109
    {NULL, NULL}
};

5110
static const vshCmdOptDef opts_vcpuinfo[] = {
5111
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
5112 5113 5114
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5115
static bool
5116
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
5117 5118 5119 5120 5121
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
5122 5123
    unsigned char *cpumaps;
    int ncpus, maxcpu;
5124
    size_t cpumaplen;
E
Eric Blake 已提交
5125
    bool ret = true;
5126
    int n, m;
5127

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

J
Jim Meyering 已提交
5131
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
5132
        return false;
5133 5134 5135

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
5136
        return false;
5137 5138 5139 5140
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
5141
        return false;
5142 5143
    }

5144
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
5145 5146 5147
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
5148

5149 5150
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
5151
                                   cpumaps, cpumaplen)) >= 0) {
5152 5153 5154 5155
        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 已提交
5156
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
5157 5158 5159 5160 5161 5162 5163 5164
            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:"));
5165 5166
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
5167 5168 5169 5170 5171 5172
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
5173
    } else {
5174
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
5175
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
5176 5177 5178
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
5179
            /* fallback plan to use virDomainGetVcpuPinInfo */
5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197

            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;
5198
        }
5199 5200
    }

5201
    VIR_FREE(cpumaps);
5202
    VIR_FREE(cpuinfo);
5203 5204 5205 5206 5207 5208 5209
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
5210
static const vshCmdInfo info_vcpupin[] = {
5211
    {"help", N_("control or query domain vcpu affinity")},
5212
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
5213 5214 5215
    {NULL, NULL}
};

5216
static const vshCmdOptDef opts_vcpupin[] = {
5217
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
5218 5219 5220
    {"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")},
5221 5222 5223
    {"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")},
5224 5225 5226
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5227
static bool
E
Eric Blake 已提交
5228
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
5229 5230 5231 5232
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
5233
    int vcpu = -1;
5234
    const char *cpulist = NULL;
E
Eric Blake 已提交
5235
    bool ret = true;
5236 5237
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
5238
    size_t cpumaplen;
5239 5240
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
5241
    bool unuse = false;
5242
    const char *cur;
5243 5244 5245
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
5246
    bool query = false; /* Query mode if no cpulist */
E
Eric Blake 已提交
5247
    unsigned int flags = 0;
5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263

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

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

J
Jim Meyering 已提交
5268
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
5269
        return false;
5270

5271 5272
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
5273
        virDomainFree(dom);
E
Eric Blake 已提交
5274
        return false;
5275
    }
5276
    query = !cpulist;
5277

5278 5279 5280 5281
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
5282
        virDomainFree(dom);
E
Eric Blake 已提交
5283
        return false;
5284
    }
5285

5286 5287
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
5288
        return false;
5289 5290 5291
    }

    if (virDomainGetInfo(dom, &info) != 0) {
5292
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
5293
        virDomainFree(dom);
E
Eric Blake 已提交
5294
        return false;
5295 5296 5297
    }

    if (vcpu >= info.nrVirtCpu) {
5298
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
5299
        virDomainFree(dom);
E
Eric Blake 已提交
5300
        return false;
5301 5302
    }

5303 5304
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
5305

5306 5307 5308 5309 5310 5311 5312 5313
    /* 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 已提交
5314
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358
                                             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*/

5359
    cpumap = vshCalloc(ctl, cpumaplen, sizeof(cpumap));
5360 5361
    /* Parse cpulist */
    cur = cpulist;
5362
    if (*cur == 0) {
5363
        goto parse_error;
5364 5365 5366
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
5367
        cur = "";
5368
    }
5369 5370 5371 5372 5373 5374 5375

    while (*cur != 0) {

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

5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389
        /* 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);
5390

5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417
        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);
        }
5418

5419 5420 5421 5422 5423 5424
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
5425
        } else {
5426
            goto parse_error;
5427
        }
5428
    }
5429

5430 5431 5432 5433 5434 5435 5436 5437
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
5438 5439
    }

5440
cleanup:
5441
    VIR_FREE(cpumap);
5442 5443
    virDomainFree(dom);
    return ret;
5444 5445 5446 5447 5448

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

5451 5452 5453
/*
 * "setvcpus" command
 */
5454
static const vshCmdInfo info_setvcpus[] = {
5455 5456
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
5457 5458 5459
    {NULL, NULL}
};

5460
static const vshCmdOptDef opts_setvcpus[] = {
5461
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
5462
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
5463 5464 5465
    {"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")},
5466
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
5467 5468 5469
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5470
static bool
5471
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
5472 5473
{
    virDomainPtr dom;
5474
    int count = 0;
E
Eric Blake 已提交
5475
    bool ret = true;
E
Eric Blake 已提交
5476 5477 5478
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
5479
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
5480
    unsigned int flags = 0;
5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496

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

5498
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5499
        return false;
5500

J
Jim Meyering 已提交
5501
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
5502
        return false;
5503

5504 5505 5506 5507
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
5508

5509
    if (flags == -1) {
E
Eric Blake 已提交
5510
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
5511
            ret = false;
E
Eric Blake 已提交
5512 5513
        }
    } else {
5514 5515 5516
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
5517
            vshDebug(ctl, VSH_ERR_DEBUG, "--maximum flag was given\n");
5518

5519 5520
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

5521 5522 5523 5524 5525 5526 5527 5528
            /* 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 已提交
5529
                ret = false;
5530 5531 5532 5533 5534
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
5535
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
5536
            ret = false;
E
Eric Blake 已提交
5537
        }
5538 5539
    }

5540
  cleanup:
5541 5542 5543 5544
    virDomainFree(dom);
    return ret;
}

5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698
/*
 * "cpu-stats" command
 */
static const vshCmdInfo info_cpu_stats[] = {
    {"help", N_("show domain cpu statistics")},
    {"desc",
     N_("Display per-CPU and total statistics about the domain's CPUs")},
    {NULL, NULL},
};

static const vshCmdOptDef opts_cpu_stats[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"total", VSH_OT_BOOL, 0, N_("Show total statistics only")},
    {"start", VSH_OT_INT, 0, N_("Show statistics from this CPU")},
    {"count", VSH_OT_INT, 0, N_("Number of shown CPUs at most")},
    {NULL, 0, 0, NULL},
};

static bool
cmdCPUStats(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    virTypedParameterPtr params = NULL;
    int i, j, pos, max_id, cpu = -1, show_count = -1, nparams;
    bool show_total = false, show_per_cpu = false;

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

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

    show_total = vshCommandOptBool(cmd, "total");
    if (vshCommandOptInt(cmd, "start", &cpu) > 0)
        show_per_cpu = true;
    if (vshCommandOptInt(cmd, "count", &show_count) > 0)
        show_per_cpu = true;

    /* default show per_cpu and total */
    if (!show_total && !show_per_cpu) {
        show_total = true;
        show_per_cpu = true;
    }

    if (!show_per_cpu) /* show total stats only */
        goto do_show_total;

    /* check cpu, show_count, and ignore wrong argument */
    if (cpu < 0)
        cpu = 0;

    /* get number of cpus on the node */
    if ((max_id = virDomainGetCPUStats(dom, NULL, 0, 0, 0, 0)) < 0)
        goto failed_stats;
    if (show_count < 0 || show_count > max_id)
        show_count = max_id;

    /* get percpu information */
    if ((nparams = virDomainGetCPUStats(dom, NULL, 0, 0, 1, 0)) < 0)
        goto failed_stats;

    if (!nparams) {
        vshPrint(ctl, "%s", _("No per-CPU stats available"));
        goto do_show_total;
    }

    if (VIR_ALLOC_N(params, nparams * MIN(show_count, 128)) < 0)
        goto failed_params;

    while (show_count) {
        int ncpus = MIN(show_count, 128);

        if (virDomainGetCPUStats(dom, params, nparams, cpu, ncpus, 0) < 0)
            goto failed_stats;

        for (i = 0; i < ncpus; i++) {
            if (params[i * nparams].type == 0) /* this cpu is not in the map */
                continue;
            vshPrint(ctl, "CPU%d:\n", cpu + i);

            for (j = 0; j < nparams; j++) {
                pos = i * nparams + j;
                vshPrint(ctl, "\t%-10s ", params[pos].field);
                if (STREQ(params[pos].field, VIR_DOMAIN_CPU_STATS_CPUTIME) &&
                    params[j].type == VIR_TYPED_PARAM_ULLONG) {
                    vshPrint(ctl, "%lld.%09lld seconds\n",
                             params[pos].value.ul / 1000000000,
                             params[pos].value.ul % 1000000000);
                } else {
                    const char *s = vshGetTypedParamValue(ctl, &params[pos]);
                    vshPrint(ctl, _("%s\n"), s);
                    VIR_FREE(s);
                }
            }
        }
        cpu += ncpus;
        show_count -= ncpus;
        virTypedParameterArrayClear(params, nparams * ncpus);
    }
    VIR_FREE(params);

do_show_total:
    if (!show_total)
        goto cleanup;

    /* get supported num of parameter for total statistics */
    if ((nparams = virDomainGetCPUStats(dom, NULL, 0, -1, 1, 0)) < 0)
        goto failed_stats;

    if (!nparams) {
        vshPrint(ctl, "%s", _("No total stats available"));
        goto cleanup;
    }

    if (VIR_ALLOC_N(params, nparams))
        goto failed_params;

    /* passing start_cpu == -1 gives us domain's total status */
    if ((nparams = virDomainGetCPUStats(dom, params, nparams, -1, 1, 0)) < 0)
        goto failed_stats;

    vshPrint(ctl, _("Total:\n"));
    for (i = 0; i < nparams; i++) {
        vshPrint(ctl, "\t%-10s ", params[i].field);
        if (STREQ(params[i].field, VIR_DOMAIN_CPU_STATS_CPUTIME) &&
            params[i].type == VIR_TYPED_PARAM_ULLONG) {
            vshPrint(ctl, "%llu.%09llu seconds\n",
                     params[i].value.ul / 1000000000,
                     params[i].value.ul % 1000000000);
        } else {
            char *s = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%s\n", s);
            VIR_FREE(s);
        }
    }
    virTypedParameterArrayClear(params, nparams);
    VIR_FREE(params);

cleanup:
    virDomainFree(dom);
    return true;

failed_params:
    virReportOOMError();
    virDomainFree(dom);
    return false;

failed_stats:
    vshError(ctl, _("Failed to virDomainGetCPUStats()\n"));
    VIR_FREE(params);
    virDomainFree(dom);
    return false;
}

5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732
/*
 * "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;
}

5733 5734 5735 5736 5737
/*
 * "send-key" command
 */
static const vshCmdInfo info_send_key[] = {
    {"help", N_("Send keycodes to the guest")},
5738
    {"desc", N_("Send keycodes (integers or symbolic names) to the guest")},
5739 5740 5741 5742 5743
    {NULL, NULL}
};

static const vshCmdOptDef opts_send_key[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
5744 5745
    {"codeset", VSH_OT_STRING, VSH_OFLAG_REQ_OPT,
     N_("the codeset of keycodes, default:linux")},
5746
    {"holdtime", VSH_OT_INT, VSH_OFLAG_REQ_OPT,
A
Alex Jia 已提交
5747
     N_("the time (in milliseconds) how long the keys will be held")},
5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819
    {"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;
}

5820 5821 5822
/*
 * "setmemory" command
 */
5823
static const vshCmdInfo info_setmem[] = {
5824 5825
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
5826 5827 5828
    {NULL, NULL}
};

5829
static const vshCmdOptDef opts_setmem[] = {
5830
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
5831
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
5832 5833
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
5834
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
5835 5836 5837
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5838
static bool
5839
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
5840 5841
{
    virDomainPtr dom;
5842
    virDomainInfo info;
5843
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
5844
    bool ret = true;
5845 5846
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
5847
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
5848
    unsigned int flags = 0;
5849

5850 5851 5852
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
5853
            return false;
5854
        }
5855
        flags = VIR_DOMAIN_AFFECT_CURRENT;
5856 5857
    } else {
        if (config)
5858
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
5859
        if (live)
5860
            flags |= VIR_DOMAIN_AFFECT_LIVE;
5861 5862 5863
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
5864
    }
5865

5866
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5867
        return false;
5868

J
Jim Meyering 已提交
5869
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
5870
        return false;
5871

5872 5873
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
5874
        return false;
5875 5876
    }

5877
    if (kilobytes <= 0) {
5878
        virDomainFree(dom);
5879
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
5880
        return false;
5881 5882
    }

5883 5884
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
5885
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
5886
        return false;
5887 5888 5889 5890
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
5891
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
5892
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
5893
        return false;
5894 5895
    }

5896
    if (flags == -1) {
5897
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
5898
            ret = false;
5899 5900 5901
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
5902
            ret = false;
5903
        }
5904 5905 5906 5907 5908 5909 5910 5911 5912
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
5913
static const vshCmdInfo info_setmaxmem[] = {
5914 5915
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
5916 5917 5918
    {NULL, NULL}
};

5919
static const vshCmdOptDef opts_setmaxmem[] = {
5920
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
5921
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
5922 5923 5924
    {"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")},
5925 5926 5927
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5928
static bool
5929
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
5930 5931
{
    virDomainPtr dom;
5932
    int kilobytes = 0;
E
Eric Blake 已提交
5933
    bool ret = true;
5934 5935 5936
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
E
Eric Blake 已提交
5937
    unsigned int flags = VIR_DOMAIN_MEM_MAXIMUM;
5938 5939 5940 5941

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
5942
            return false;
5943 5944 5945
        }
    } else {
        if (config)
5946
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
5947
        if (live)
5948
            flags |= VIR_DOMAIN_AFFECT_LIVE;
5949 5950 5951 5952
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
5953

5954
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5955
        return false;
5956

J
Jim Meyering 已提交
5957
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
5958
        return false;
5959

5960 5961
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
5962
        return false;
5963 5964
    }

5965
    if (kilobytes <= 0) {
5966
        virDomainFree(dom);
5967
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
5968
        return false;
5969 5970
    }

5971 5972 5973
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
5974
            ret = false;
5975 5976 5977 5978
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
5979
            ret = false;
5980
        }
5981 5982
    }

5983 5984 5985 5986
    virDomainFree(dom);
    return ret;
}

5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002
/*
 * "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]")},
6003 6004
    {"device-weights", VSH_OT_STRING, VSH_OFLAG_NONE,
     N_("per-device IO Weights, in the form of /path/to/device,weight,...")},
H
Hu Tao 已提交
6005 6006 6007
    {"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")},
6008 6009 6010
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6011
static bool
6012 6013 6014
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
6015
    const char *device_weight = NULL;
6016 6017
    int weight = 0;
    int nparams = 0;
6018
    int rv = 0;
6019
    unsigned int i = 0;
6020
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
6021
    bool ret = false;
H
Hu Tao 已提交
6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038
    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;
    }
6039 6040

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6041
        return false;
6042 6043

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

6046
    if ((rv = vshCommandOptInt(cmd, "weight", &weight)) < 0) {
6047 6048 6049 6050 6051
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

6052
    if (rv > 0) {
6053
        nparams++;
6054
        if (weight <= 0) {
6055 6056 6057 6058 6059
            vshError(ctl, _("Invalid value of %d for I/O weight"), weight);
            goto cleanup;
        }
    }

6060 6061 6062 6063 6064 6065 6066 6067 6068 6069
    rv = vshCommandOptString(cmd, "device-weights", &device_weight);
    if (rv < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse string parameter"));
        goto cleanup;
    }
    if (rv > 0) {
        nparams++;
    }

6070 6071
    if (nparams == 0) {
        /* get the number of blkio parameters */
H
Hu Tao 已提交
6072
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
6073 6074 6075 6076 6077 6078 6079
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
6080
            ret = true;
6081 6082 6083 6084 6085
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
6086
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
6087 6088 6089 6090 6091
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
6092 6093 6094
            char *str = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
            VIR_FREE(str);
6095 6096 6097 6098 6099 6100 6101
        }
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
6102
            temp->type = VIR_TYPED_PARAM_UINT;
6103 6104 6105

            if (weight) {
                temp->value.ui = weight;
6106 6107 6108
                if (!virStrcpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                               sizeof(temp->field)))
                    goto cleanup;
6109 6110
                weight = 0;
            } else if (device_weight) {
6111 6112 6113 6114 6115
                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;
6116
                device_weight = NULL;
6117 6118
            }
        }
6119 6120

        if (virDomainSetBlkioParameters(dom, params, nparams, flags) < 0) {
6121
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
6122 6123
            goto cleanup;
        }
6124 6125
    }

6126 6127
    ret = true;

6128
  cleanup:
6129
    virTypedParameterArrayClear(params, nparams);
6130 6131 6132 6133 6134
    VIR_FREE(params);
    virDomainFree(dom);
    return ret;
}

6135 6136 6137 6138
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
6139 6140 6141
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
6142 6143 6144 6145 6146 6147 6148
                "    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")},
6149
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
6150
     N_("Max memory in kilobytes")},
6151
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
6152
     N_("Memory during contention in kilobytes")},
6153
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
6154
     N_("Max memory plus swap in kilobytes")},
6155
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
6156
     N_("Min guaranteed memory in kilobytes")},
6157 6158 6159
    {"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")},
6160 6161 6162
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6163
static bool
6164 6165 6166
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
6167 6168
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
6169 6170
    int nparams = 0;
    unsigned int i = 0;
6171
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
6172
    bool ret = false;
6173 6174 6175 6176 6177 6178 6179 6180 6181 6182
    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;
        }
6183
        flags = VIR_DOMAIN_AFFECT_CURRENT;
6184 6185
    } else {
        if (config)
6186
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
6187
        if (live)
6188
            flags |= VIR_DOMAIN_AFFECT_LIVE;
6189
    }
6190 6191

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6192
        return false;
6193 6194

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

6197 6198 6199 6200 6201 6202 6203 6204 6205
    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;
    }

6206 6207 6208 6209 6210 6211 6212 6213 6214
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

6215 6216 6217
    if (min_guarantee)
        nparams++;

6218 6219
    if (nparams == 0) {
        /* get the number of memory parameters */
6220
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
6221 6222 6223 6224 6225
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

6226 6227
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
6228
            ret = true;
6229 6230 6231
            goto cleanup;
        }

6232
        /* now go get all the memory parameters */
E
Eric Blake 已提交
6233
        params = vshCalloc(ctl, nparams, sizeof(*params));
6234
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
6235 6236 6237 6238 6239
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
6240 6241 6242 6243 6244 6245 6246
            if (params[i].type == VIR_TYPED_PARAM_ULLONG &&
                params[i].value.ul == VIR_DOMAIN_MEMORY_PARAM_UNLIMITED) {
                vshPrint(ctl, "%-15s: %s\n", params[i].field, _("unlimited"));
            } else {
                char *str = vshGetTypedParamValue(ctl, &params[i]);
                vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
                VIR_FREE(str);
6247 6248 6249
            }
        }

E
Eric Blake 已提交
6250
        ret = true;
6251 6252
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
6253
        params = vshCalloc(ctl, nparams, sizeof(*params));
6254 6255 6256

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
6257
            temp->type = VIR_TYPED_PARAM_ULLONG;
6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276

            /*
             * 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;
6277
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
6278 6279
                        sizeof(temp->field));
                swap_hard_limit = 0;
6280 6281 6282 6283 6284
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
6285
            }
6286 6287 6288 6289

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
6290
        }
6291
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
6292
            vshError(ctl, "%s", _("Unable to change memory parameters"));
6293
        else
E
Eric Blake 已提交
6294
            ret = true;
6295 6296 6297
    }

  cleanup:
E
Eric Blake 已提交
6298
    VIR_FREE(params);
6299 6300 6301 6302
    virDomainFree(dom);
    return ret;
}

H
Hu Tao 已提交
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 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460
/*
 * "numatune" command
 */
static const vshCmdInfo info_numatune[] = {
    {"help", N_("Get or set numa parameters")},
    {"desc", N_("Get or set the current numa parameters for a guest" \
                " domain.\n" \
                "    To get the numa parameters use following command: \n\n" \
                "    virsh # numatune <domain>")},
    {NULL, NULL}

};

static const vshCmdOptDef opts_numatune[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"mode", VSH_OT_DATA, VSH_OFLAG_NONE,
     N_("NUMA mode, one of strict, preferred and interleave")},
    {"nodeset", VSH_OT_DATA, VSH_OFLAG_NONE,
     N_("NUMA node selections to set")},
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
    {NULL, 0, 0, NULL}
};

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

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
            return false;
        }
        flags = VIR_DOMAIN_AFFECT_CURRENT;
    } else {
        if (config)
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
        if (live)
            flags |= VIR_DOMAIN_AFFECT_LIVE;
    }

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

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

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

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

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

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

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

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

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

            /*
             * Some magic here, this is used to fill the params structure with
             * the valid arguments passed, after filling the particular
             * argument we purposely make them 0, so on the next pass it goes
             * to the next valid argument and so on.
             */
            if (mode) {
                /* Accept string or integer, in case server
                 * understands newer integer than what strings we were
                 * compiled with */
                if ((temp->value.i =
                    virDomainNumatuneMemModeTypeFromString(mode)) < 0 &&
                    virStrToLong_i(mode, NULL, 0, &temp->value.i) < 0) {
                    vshError(ctl, _("Invalid mode: %s"), mode);
                    goto cleanup;
                }
                if (!virStrcpy(temp->field, VIR_DOMAIN_NUMA_MODE,
                               sizeof(temp->field)))
                    goto cleanup;
                temp->type = VIR_TYPED_PARAM_INT;
                mode = NULL;
            } else if (nodeset) {
                temp->value.s = vshStrdup(ctl, nodeset);
                temp->type = VIR_TYPED_PARAM_STRING;
                if (!virStrcpy(temp->field, VIR_DOMAIN_NUMA_NODESET,
                               sizeof(temp->field)))
                    goto cleanup;
                nodeset = NULL;
            }
        }
        if (virDomainSetNumaParameters(dom, params, nparams, flags) != 0)
            vshError(ctl, "%s", _("Unable to change numa parameters"));
        else
            ret = true;
    }

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

6461 6462 6463
/*
 * "nodeinfo" command
 */
6464
static const vshCmdInfo info_nodeinfo[] = {
6465 6466
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
6467 6468 6469
    {NULL, NULL}
};

E
Eric Blake 已提交
6470
static bool
6471
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6472 6473
{
    virNodeInfo info;
6474

6475
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6476
        return false;
6477 6478

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
6479
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
6480
        return false;
6481 6482 6483 6484 6485 6486 6487 6488 6489 6490
    }
    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 已提交
6491
    return true;
6492 6493
}

6494 6495 6496 6497 6498
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
6499
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
6500 6501 6502 6503 6504 6505 6506 6507 6508 6509
    {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
6510
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
6511 6512 6513 6514
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
6515 6516
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559
    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;

6560
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
6561
                cpu_stats[i].sys = value;
6562
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
6563
                cpu_stats[i].user = value;
6564
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
6565
                cpu_stats[i].idle = value;
6566
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
6567
                cpu_stats[i].iowait = value;
6568
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582
                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) {
6583
            vshPrint(ctl, "%-15s %20llu\n", _("user:"), cpu_stats[0].user);
6584
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
6585
            vshPrint(ctl, "%-15s %20llu\n", _("idle:"), cpu_stats[0].idle);
6586 6587 6588 6589 6590 6591 6592
            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);
6593
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle:"), 100 - usage);
6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605
        } 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",
6606
                     _("user:"), user_time / total_time * 100);
6607
            vshPrint(ctl, "%-15s %5.1lf%%\n",
6608
                     _("system:"), sys_time  / total_time * 100);
6609
            vshPrint(ctl, "%-15s %5.1lf%%\n",
6610
                     _("idle:"), idle_time     / total_time * 100);
6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641
/*
 * "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;
6642 6643
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683
    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;
}

6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712
/*
 * "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;

6713 6714
    if (vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(ctl, _("Invalid target argument"));
6715
        return false;
6716
    }
6717

6718 6719
    if (vshCommandOptLongLong(cmd, "duration", &duration) < 0) {
        vshError(ctl, _("Invalid duration argument"));
6720
        return false;
6721
    }
6722

6723 6724
    if (vshCommandOptUInt(cmd, "flags", &flags) < 0) {
        vshError(ctl, _("Invalid flags argument"));
6725
        return false;
6726
    }
6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752

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


6753 6754 6755
/*
 * "capabilities" command
 */
6756
static const vshCmdInfo info_capabilities[] = {
6757 6758
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
6759 6760 6761
    {NULL, NULL}
};

E
Eric Blake 已提交
6762
static bool
6763
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6764 6765 6766
{
    char *caps;

6767
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6768
        return false;
6769 6770

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
6771
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
6772
        return false;
6773 6774
    }
    vshPrint (ctl, "%s\n", caps);
6775
    VIR_FREE(caps);
6776

E
Eric Blake 已提交
6777
    return true;
6778 6779
}

6780 6781 6782
/*
 * "dumpxml" command
 */
6783
static const vshCmdInfo info_dumpxml[] = {
6784 6785
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
6786
    {NULL, NULL}
6787 6788
};

6789
static const vshCmdOptDef opts_dumpxml[] = {
6790 6791 6792
    {"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")},
6793
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
6794
    {NULL, 0, 0, NULL}
6795 6796
};

E
Eric Blake 已提交
6797
static bool
6798
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
6799
{
6800
    virDomainPtr dom;
E
Eric Blake 已提交
6801
    bool ret = true;
6802
    char *dump;
E
Eric Blake 已提交
6803
    unsigned int flags = 0;
6804 6805
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
6806
    int update = vshCommandOptBool(cmd, "update-cpu");
6807 6808 6809 6810 6811

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
6812 6813
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
6814

6815
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6816
        return false;
6817

J
Jim Meyering 已提交
6818
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
6819
        return false;
6820

6821
    dump = virDomainGetXMLDesc(dom, flags);
6822
    if (dump != NULL) {
6823
        vshPrint(ctl, "%s", dump);
6824
        VIR_FREE(dump);
6825
    } else {
E
Eric Blake 已提交
6826
        ret = false;
6827
    }
6828

6829 6830 6831 6832
    virDomainFree(dom);
    return ret;
}

6833 6834 6835 6836
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
6837 6838
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
6839 6840 6841 6842
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
6843 6844
    {"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")},
6845 6846 6847
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6848
static bool
6849 6850
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6851
    bool ret = true;
6852 6853
    const char *format = NULL;
    const char *configFile = NULL;
6854 6855
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
6856
    unsigned int flags = 0;
6857

6858
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6859
        return false;
6860

6861 6862
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
6863
        return false;
6864

6865
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
6866
        return false;
6867 6868 6869

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
6870
        vshPrint(ctl, "%s", xmlData);
6871
        VIR_FREE(xmlData);
6872
    } else {
E
Eric Blake 已提交
6873
        ret = false;
6874 6875
    }

6876
    VIR_FREE(configData);
6877 6878 6879 6880 6881 6882 6883
    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
6884 6885
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
6886 6887 6888 6889
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
6890 6891
    {"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")},
6892 6893 6894
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6895
static bool
6896 6897
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6898
    bool ret = true;
6899 6900
    const char *format = NULL;
    const char *xmlFile = NULL;
6901 6902
    char *configData;
    char *xmlData;
E
Eric Blake 已提交
6903
    unsigned int flags = 0;
6904

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

6908 6909
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
6910
        return false;
6911

6912
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
6913
        return false;
6914 6915 6916

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
6917
        vshPrint(ctl, "%s", configData);
6918
        VIR_FREE(configData);
6919
    } else {
E
Eric Blake 已提交
6920
        ret = false;
6921 6922
    }

6923
    VIR_FREE(xmlData);
6924 6925 6926
    return ret;
}

K
Karel Zak 已提交
6927
/*
K
Karel Zak 已提交
6928
 * "domname" command
K
Karel Zak 已提交
6929
 */
6930
static const vshCmdInfo info_domname[] = {
6931
    {"help", N_("convert a domain id or UUID to domain name")},
6932
    {"desc", ""},
6933
    {NULL, NULL}
K
Karel Zak 已提交
6934 6935
};

6936
static const vshCmdOptDef opts_domname[] = {
6937
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
6938
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
6939 6940
};

E
Eric Blake 已提交
6941
static bool
6942
cmdDomname(vshControl *ctl, const vshCmd *cmd)
6943
{
K
Karel Zak 已提交
6944 6945
    virDomainPtr dom;

6946
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6947
        return false;
J
Jim Meyering 已提交
6948
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
6949
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
6950
        return false;
6951

K
Karel Zak 已提交
6952 6953
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
6954
    return true;
K
Karel Zak 已提交
6955 6956 6957
}

/*
K
Karel Zak 已提交
6958
 * "domid" command
K
Karel Zak 已提交
6959
 */
6960
static const vshCmdInfo info_domid[] = {
6961
    {"help", N_("convert a domain name or UUID to domain id")},
6962
    {"desc", ""},
6963
    {NULL, NULL}
K
Karel Zak 已提交
6964 6965
};

6966
static const vshCmdOptDef opts_domid[] = {
6967
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
6968
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
6969 6970
};

E
Eric Blake 已提交
6971
static bool
6972
cmdDomid(vshControl *ctl, const vshCmd *cmd)
6973
{
6974
    virDomainPtr dom;
6975
    unsigned int id;
K
Karel Zak 已提交
6976

6977
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6978
        return false;
J
Jim Meyering 已提交
6979
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
6980
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
6981
        return false;
6982

6983 6984
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
6985
        vshPrint(ctl, "%s\n", "-");
6986
    else
6987
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
6988
    virDomainFree(dom);
E
Eric Blake 已提交
6989
    return true;
K
Karel Zak 已提交
6990
}
6991

K
Karel Zak 已提交
6992 6993 6994
/*
 * "domuuid" command
 */
6995
static const vshCmdInfo info_domuuid[] = {
6996
    {"help", N_("convert a domain name or id to domain UUID")},
6997
    {"desc", ""},
K
Karel Zak 已提交
6998 6999 7000
    {NULL, NULL}
};

7001
static const vshCmdOptDef opts_domuuid[] = {
7002
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
7003 7004 7005
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7006
static bool
7007
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
7008 7009
{
    virDomainPtr dom;
7010
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
7011

7012
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7013
        return false;
J
Jim Meyering 已提交
7014
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
7015
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
7016
        return false;
7017

K
Karel Zak 已提交
7018 7019 7020
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
7021
        vshError(ctl, "%s", _("failed to get domain UUID"));
7022

7023
    virDomainFree(dom);
E
Eric Blake 已提交
7024
    return true;
K
Karel Zak 已提交
7025 7026
}

7027 7028 7029
/*
 * "migrate" command
 */
7030
static const vshCmdInfo info_migrate[] = {
7031 7032
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
7033 7034 7035
    {NULL, NULL}
};

7036
static const vshCmdOptDef opts_migrate[] = {
7037 7038 7039
    {"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")},
E
Eric Blake 已提交
7040
    {"tunneled", VSH_OT_ALIAS, 0, "tunnelled"},
7041 7042 7043 7044
    {"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")},
7045 7046
    {"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)")},
7047 7048
    {"change-protection", VSH_OT_BOOL, 0,
     N_("prevent any configuration changes to domain until migration ends)")},
7049
    {"unsafe", VSH_OT_BOOL, 0, N_("force migration even if it may be unsafe")},
W
Wen Congyang 已提交
7050
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
7051
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
7052
    {"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)")},
7053 7054
    {"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 已提交
7055
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
7056
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
7057 7058 7059
    {NULL, 0, 0, NULL}
};

7060 7061
static void
doMigrate (void *opaque)
7062
{
7063
    char ret = '1';
7064
    virDomainPtr dom = NULL;
7065 7066 7067
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
E
Eric Blake 已提交
7068
    unsigned int flags = 0;
7069 7070 7071
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
7072 7073
    const char *xmlfile = NULL;
    char *xml = NULL;
7074
    sigset_t sigmask, oldsigmask;
7075 7076 7077 7078 7079

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

7081
    if (!vshConnectionUsability (ctl, ctl->conn))
7082
        goto out;
7083

J
Jim Meyering 已提交
7084
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
7085
        goto out;
7086

7087 7088
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
7089 7090
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
7091
        goto out;
7092
    }
7093

7094 7095 7096 7097 7098
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

7099 7100
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
7101 7102
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
7103
    if (vshCommandOptBool (cmd, "tunnelled"))
7104
        flags |= VIR_MIGRATE_TUNNELLED;
C
Chris Lalancette 已提交
7105

C
Chris Lalancette 已提交
7106 7107 7108 7109 7110
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

7111 7112 7113
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

7114 7115 7116 7117 7118 7119
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

7120 7121
    if (vshCommandOptBool (cmd, "change-protection"))
        flags |= VIR_MIGRATE_CHANGE_PROTECTION;
7122

7123 7124 7125
    if (vshCommandOptBool(cmd, "unsafe"))
        flags |= VIR_MIGRATE_UNSAFE;

7126
    if (xmlfile &&
7127 7128
        virFileReadAll(xmlfile, 8192, &xml) < 0) {
        vshError(ctl, _("file '%s' doesn't exist"), xmlfile);
7129
        goto out;
7130
    }
7131

7132 7133 7134 7135
    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. */
7136

7137
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
7138
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
7139
            goto out;
7140
        }
7141

7142
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
7143
            ret = '0';
7144 7145 7146 7147 7148 7149
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
7150
        if (!dconn) goto out;
7151

7152
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
7153 7154
        if (ddom) {
            virDomainFree(ddom);
7155
            ret = '0';
7156 7157 7158
        }
        virConnectClose (dconn);
    }
7159

7160 7161 7162
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
7163
    if (dom) virDomainFree (dom);
7164
    VIR_FREE(xml);
7165 7166 7167
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
7168
static void
7169 7170
print_job_progress(const char *label, unsigned long long remaining,
                   unsigned long long total)
W
Wen Congyang 已提交
7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189
{
    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;
        }
    }

7190 7191
    /* see comments in vshError about why we must flush */
    fflush(stdout);
7192
    fprintf(stderr, "\r%s: [%3d %%]", label, progress);
7193
    fflush(stderr);
W
Wen Congyang 已提交
7194 7195
}

7196 7197 7198 7199 7200 7201 7202 7203 7204 7205
static void
vshMigrationTimeout(vshControl *ctl,
                    virDomainPtr dom,
                    void *opaque ATTRIBUTE_UNUSED)
{
    vshDebug(ctl, VSH_ERR_DEBUG, "suspending the domain, "
             "since migration timed out\n");
    virDomainSuspend(dom);
}

E
Eric Blake 已提交
7206
static bool
7207 7208 7209 7210 7211 7212 7213 7214
vshWatchJob(vshControl *ctl,
            virDomainPtr dom,
            bool verbose,
            int pipe_fd,
            int timeout,
            jobWatchTimeoutFunc timeout_func,
            void *opaque,
            const char *label)
7215 7216 7217
{
    struct sigaction sig_action;
    struct sigaction old_sig_action;
7218
    struct pollfd pollfd;
W
Wen Congyang 已提交
7219
    struct timeval start, curr;
7220 7221 7222 7223
    virDomainJobInfo jobinfo;
    int ret = -1;
    char retchar;
    bool functionReturn = false;
7224 7225 7226 7227
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
7228 7229 7230 7231 7232 7233 7234

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

7235
    pollfd.fd = pipe_fd;
7236 7237 7238
    pollfd.events = POLLIN;
    pollfd.revents = 0;

W
Wen Congyang 已提交
7239
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
7240
    while (1) {
7241
repoll:
W
Wen Congyang 已提交
7242 7243
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
7244 7245 7246
            if (pollfd.revents & POLLIN &&
                saferead(pipe_fd, &retchar, sizeof(retchar)) > 0 &&
                retchar == '0') {
W
Wen Congyang 已提交
7247 7248
                    if (verbose) {
                        /* print [100 %] */
7249
                        print_job_progress(label, 0, 1);
W
Wen Congyang 已提交
7250
                    }
7251 7252 7253
                    break;
            }
            goto cleanup;
W
Wen Congyang 已提交
7254 7255 7256 7257 7258 7259 7260 7261 7262 7263
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
7264
            goto cleanup;
W
Wen Congyang 已提交
7265 7266
        }

W
Wen Congyang 已提交
7267 7268 7269 7270
        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. */
7271 7272 7273
            vshDebug(ctl, VSH_ERR_DEBUG, "%s timeout", label);
            if (timeout_func)
                (timeout_func)(ctl, dom, opaque);
W
Wen Congyang 已提交
7274 7275 7276
            timeout = 0;
        }

W
Wen Congyang 已提交
7277 7278 7279 7280 7281
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
7282
                print_job_progress(label, jobinfo.dataRemaining,
7283
                                   jobinfo.dataTotal);
7284 7285 7286
        }
    }

7287 7288 7289
    functionReturn = true;

cleanup:
7290
    sigaction(SIGINT, &old_sig_action, NULL);
7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345
    return functionReturn;
}

static bool
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    virThread workerThread;
    bool verbose = false;
    bool functionReturn = false;
    int timeout = 0;
    bool live_flag = false;
    vshCtrlData data;

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

    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

    if (vshCommandOptBool (cmd, "live"))
        live_flag = true;
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
        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;
        }
    }

    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;
    functionReturn = vshWatchJob(ctl, dom, verbose, p[0], timeout,
                                 vshMigrationTimeout, NULL, _("Migration"));
7346 7347 7348 7349 7350 7351 7352

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
7353
    return functionReturn;
7354 7355
}

7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366
/*
 * "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")},
7367
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
7368 7369 7370
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7371
static bool
7372 7373 7374
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
7375
    long long downtime = 0;
E
Eric Blake 已提交
7376
    bool ret = false;
7377

7378
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7379
        return false;
7380 7381

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

7384 7385
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
7386 7387 7388 7389 7390 7391 7392
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
7393
    ret = true;
7394 7395 7396 7397 7398 7399

done:
    virDomainFree(dom);
    return ret;
}

7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443
/*
 * "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;
}

7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482
/*
 * "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;
}

7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499
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))
7500
        goto cleanup;
7501 7502

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

    if (vshCommandOptString(cmd, "path", &path) < 0)
7506
        goto cleanup;
7507

7508 7509
    if (vshCommandOptUL(cmd, "bandwidth", &bandwidth) < 0) {
        vshError(ctl, "%s", _("bandwidth must be a number"));
7510
        goto cleanup;
7511
    }
7512

E
Eric Blake 已提交
7513
    if (mode == VSH_CMD_BLOCK_JOB_ABORT) {
7514
        ret = virDomainBlockJobAbort(dom, path, 0);
E
Eric Blake 已提交
7515
    } else if (mode == VSH_CMD_BLOCK_JOB_INFO) {
7516
        ret = virDomainGetBlockJobInfo(dom, path, info, 0);
E
Eric Blake 已提交
7517
    } else if (mode == VSH_CMD_BLOCK_JOB_SPEED) {
7518
        ret = virDomainBlockJobSetSpeed(dom, path, bandwidth, 0);
E
Eric Blake 已提交
7519 7520 7521 7522 7523 7524 7525 7526 7527
    } else if (mode == VSH_CMD_BLOCK_JOB_PULL) {
        const char *base = NULL;
        if (vshCommandOptString(cmd, "base", &base) < 0)
            goto cleanup;
        if (base)
            ret = virDomainBlockRebase(dom, path, base, bandwidth, 0);
        else
            ret = virDomainBlockPull(dom, path, bandwidth, 0);
    }
7528

7529
cleanup:
7530 7531
    if (dom)
        virDomainFree(dom);
7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547
    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")},
E
Eric Blake 已提交
7548 7549
    {"base", VSH_OT_DATA, VSH_OFLAG_NONE,
     N_("path of backing file in chain for a partial pull")},
7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572
    {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")},
Y
Yuri Chornoivan 已提交
7573
    {"abort", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("Abort the active job on the specified disk")},
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
    {"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;
}

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
/*
 * "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;
}
7674

7675 7676 7677
/*
 * "net-autostart" command
 */
7678
static const vshCmdInfo info_network_autostart[] = {
7679
    {"help", N_("autostart a network")},
7680
    {"desc",
7681
     N_("Configure a network to be automatically started at boot.")},
7682 7683 7684
    {NULL, NULL}
};

7685
static const vshCmdOptDef opts_network_autostart[] = {
7686 7687
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
7688 7689 7690
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7691
static bool
7692
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
7693 7694
{
    virNetworkPtr network;
7695
    const char *name;
7696 7697
    int autostart;

7698
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7699
        return false;
7700

J
Jim Meyering 已提交
7701
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
7702
        return false;
7703 7704 7705 7706

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
7707
        if (autostart)
7708
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
7709
        else
7710
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
7711
        virNetworkFree(network);
E
Eric Blake 已提交
7712
        return false;
7713 7714
    }

7715
    if (autostart)
7716
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
7717
    else
7718
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
7719

L
Laine Stump 已提交
7720
    virNetworkFree(network);
E
Eric Blake 已提交
7721
    return true;
7722
}
K
Karel Zak 已提交
7723

L
Lei Li 已提交
7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735
/*
 * "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")},
E
Eric Blake 已提交
7736 7737
    {"total_bytes_sec", VSH_OT_ALIAS, 0, "total-bytes-sec"},
    {"total-bytes-sec", VSH_OT_INT, VSH_OFLAG_NONE,
L
Lei Li 已提交
7738
     N_("total throughput limit in bytes per second")},
E
Eric Blake 已提交
7739 7740
    {"read_bytes_sec", VSH_OT_ALIAS, 0, "read-bytes-sec"},
    {"read-bytes-sec", VSH_OT_INT, VSH_OFLAG_NONE,
L
Lei Li 已提交
7741
     N_("read throughput limit in bytes per second")},
E
Eric Blake 已提交
7742 7743
    {"write_bytes_sec", VSH_OT_ALIAS, 0, "write-bytes-sec"},
    {"write-bytes-sec", VSH_OT_INT, VSH_OFLAG_NONE,
L
Lei Li 已提交
7744
     N_("write throughput limit in bytes per second")},
E
Eric Blake 已提交
7745 7746
    {"total_iops_sec", VSH_OT_ALIAS, 0, "total-iops-sec"},
    {"total-iops-sec", VSH_OT_INT, VSH_OFLAG_NONE,
L
Lei Li 已提交
7747
     N_("total I/O operations limit per second")},
E
Eric Blake 已提交
7748 7749
    {"read_iops_sec", VSH_OT_ALIAS, 0, "read-iops-sec"},
    {"read-iops-sec", VSH_OT_INT, VSH_OFLAG_NONE,
L
Lei Li 已提交
7750
     N_("read I/O operations limit per second")},
E
Eric Blake 已提交
7751 7752
    {"write_iops_sec", VSH_OT_ALIAS, 0, "write-iops-sec"},
    {"write-iops-sec", VSH_OT_INT, VSH_OFLAG_NONE,
L
Lei Li 已提交
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
     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;

E
Eric Blake 已提交
7798 7799
    if ((rv = vshCommandOptULongLong(cmd, "total-bytes-sec",
                                     &total_bytes_sec)) < 0) {
L
Lei Li 已提交
7800 7801 7802 7803 7804 7805 7806
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    } else if (rv > 0) {
        nparams++;
    }

E
Eric Blake 已提交
7807 7808
    if ((rv = vshCommandOptULongLong(cmd, "read-bytes-sec",
                                     &read_bytes_sec)) < 0) {
L
Lei Li 已提交
7809 7810 7811 7812 7813 7814 7815
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    } else if (rv > 0) {
        nparams++;
    }

E
Eric Blake 已提交
7816 7817
    if ((rv = vshCommandOptULongLong(cmd, "write-bytes-sec",
                                     &write_bytes_sec)) < 0) {
L
Lei Li 已提交
7818 7819 7820 7821 7822 7823 7824
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    } else if (rv > 0) {
        nparams++;
    }

E
Eric Blake 已提交
7825 7826
    if ((rv = vshCommandOptULongLong(cmd, "total-iops-sec",
                                     &total_iops_sec)) < 0) {
L
Lei Li 已提交
7827 7828 7829 7830 7831 7832 7833
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    } else if (rv > 0) {
        nparams++;
    }

E
Eric Blake 已提交
7834 7835
    if ((rv = vshCommandOptULongLong(cmd, "read-iops-sec",
                                     &read_iops_sec)) < 0) {
L
Lei Li 已提交
7836 7837 7838 7839 7840 7841 7842
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    } else if (rv > 0) {
        nparams++;
    }

E
Eric Blake 已提交
7843 7844
    if ((rv = vshCommandOptULongLong(cmd, "write-iops-sec",
                                     &write_iops_sec)) < 0) {
L
Lei Li 已提交
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
        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++) {
7874 7875 7876
            char *str = vshGetTypedParamValue(ctl, &params[i]);
            vshPrint(ctl, "%-15s: %s\n", params[i].field, str);
            VIR_FREE(str);
L
Lei Li 已提交
7877 7878
        }

7879
        ret = true;
7880
        goto cleanup;
L
Lei Li 已提交
7881 7882 7883 7884 7885
    } else {
        /* Set the block I/O throttle, match by opt since parameters can be 0 */
        params = vshCalloc(ctl, nparams, sizeof(*params));
        i = 0;

E
Eric Blake 已提交
7886
        if ((i < nparams) && (vshCommandOptBool(cmd, "total-bytes-sec"))) {
L
Lei Li 已提交
7887 7888 7889 7890 7891 7892 7893 7894
            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++;
        }

E
Eric Blake 已提交
7895
        if ((i < nparams) && (vshCommandOptBool(cmd, "read-bytes-sec"))) {
L
Lei Li 已提交
7896 7897 7898 7899 7900 7901 7902 7903
            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++;
        }

E
Eric Blake 已提交
7904
        if ((i < nparams) && (vshCommandOptBool(cmd, "write-bytes-sec"))) {
L
Lei Li 已提交
7905 7906 7907 7908 7909 7910 7911 7912
            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++;
        }

E
Eric Blake 已提交
7913
        if ((i < nparams) && (vshCommandOptBool(cmd, "total-iops-sec"))) {
L
Lei Li 已提交
7914 7915 7916 7917 7918 7919 7920 7921
            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++;
        }

E
Eric Blake 已提交
7922
        if ((i < nparams) && (vshCommandOptBool(cmd, "read-iops-sec"))) {
L
Lei Li 已提交
7923 7924 7925 7926 7927 7928 7929 7930
            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++;
        }

E
Eric Blake 已提交
7931
        if ((i < nparams) && (vshCommandOptBool(cmd, "write-iops-sec"))) {
L
Lei Li 已提交
7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953
            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;
}

7954 7955 7956
/*
 * "net-create" command
 */
7957
static const vshCmdInfo info_network_create[] = {
7958 7959
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
7960 7961 7962
    {NULL, NULL}
};

7963
static const vshCmdOptDef opts_network_create[] = {
7964
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
7965 7966 7967
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7968
static bool
7969
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
7970 7971
{
    virNetworkPtr network;
7972
    const char *from = NULL;
E
Eric Blake 已提交
7973
    bool ret = true;
7974
    char *buffer;
7975

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

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

7982
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
7983
        return false;
7984 7985

    network = virNetworkCreateXML(ctl->conn, buffer);
7986
    VIR_FREE(buffer);
7987

7988 7989 7990
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
7991
        virNetworkFree(network);
7992
    } else {
7993
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
7994
        ret = false;
7995 7996 7997 7998 7999 8000 8001 8002
    }
    return ret;
}


/*
 * "net-define" command
 */
8003
static const vshCmdInfo info_network_define[] = {
8004 8005
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
8006 8007 8008
    {NULL, NULL}
};

8009
static const vshCmdOptDef opts_network_define[] = {
8010
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
8011 8012 8013
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8014
static bool
8015
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
8016 8017
{
    virNetworkPtr network;
8018
    const char *from = NULL;
E
Eric Blake 已提交
8019
    bool ret = true;
8020
    char *buffer;
8021

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

8025
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8026
        return false;
8027

8028
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
8029
        return false;
8030 8031

    network = virNetworkDefineXML(ctl->conn, buffer);
8032
    VIR_FREE(buffer);
8033

8034 8035 8036
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
8037
        virNetworkFree(network);
8038
    } else {
8039
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
8040
        ret = false;
8041 8042 8043 8044 8045 8046 8047 8048
    }
    return ret;
}


/*
 * "net-destroy" command
 */
8049
static const vshCmdInfo info_network_destroy[] = {
8050 8051
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
8052 8053 8054
    {NULL, NULL}
};

8055
static const vshCmdOptDef opts_network_destroy[] = {
8056
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
8057 8058 8059
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8060
static bool
8061
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
8062 8063
{
    virNetworkPtr network;
E
Eric Blake 已提交
8064
    bool ret = true;
8065
    const char *name;
8066

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

J
Jim Meyering 已提交
8070
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
8071
        return false;
8072 8073 8074 8075

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

8080
    virNetworkFree(network);
8081 8082 8083 8084 8085 8086 8087
    return ret;
}


/*
 * "net-dumpxml" command
 */
8088
static const vshCmdInfo info_network_dumpxml[] = {
8089 8090
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
8091 8092 8093
    {NULL, NULL}
};

8094
static const vshCmdOptDef opts_network_dumpxml[] = {
8095
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
8096
    {"inactive", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("network information of an inactive domain")},
8097 8098 8099
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8100
static bool
8101
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
8102 8103
{
    virNetworkPtr network;
E
Eric Blake 已提交
8104
    bool ret = true;
8105
    char *dump;
8106 8107
    unsigned int flags = 0;
    int inactive;
8108

8109
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8110
        return false;
8111

J
Jim Meyering 已提交
8112
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
8113
        return false;
8114

8115 8116 8117 8118 8119 8120
    inactive = vshCommandOptBool (cmd, "inactive");
    if (inactive)
        flags |= VIR_NETWORK_XML_INACTIVE;

    dump = virNetworkGetXMLDesc(network, flags);

8121
    if (dump != NULL) {
8122
        vshPrint(ctl, "%s", dump);
8123
        VIR_FREE(dump);
8124
    } else {
E
Eric Blake 已提交
8125
        ret = false;
8126 8127 8128 8129 8130 8131
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
8132 8133 8134 8135 8136
/*
 * "net-info" command
 */
static const vshCmdInfo info_network_info[] = {
    {"help", N_("network information")},
E
Eric Blake 已提交
8137
    {"desc", N_("Returns basic information about the network")},
O
Osier Yang 已提交
8138 8139 8140 8141 8142 8143 8144 8145
    {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 已提交
8146
static bool
O
Osier Yang 已提交
8147 8148 8149 8150 8151 8152 8153 8154 8155 8156
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 已提交
8157
        return false;
O
Osier Yang 已提交
8158 8159 8160

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8161
        return false;
O
Osier Yang 已提交
8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186

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

8187
    VIR_FREE(bridge);
O
Osier Yang 已提交
8188
    virNetworkFree(network);
E
Eric Blake 已提交
8189
    return true;
O
Osier Yang 已提交
8190
}
8191

8192 8193 8194 8195
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
8196 8197
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
8198 8199 8200 8201
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
8202
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
8203 8204 8205
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8206
static bool
8207 8208
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
8209
    bool ret = false;
8210 8211 8212 8213 8214
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
8215
    unsigned int flags = VIR_INTERFACE_XML_INACTIVE;
8216

8217
    if (!vshConnectionUsability(ctl, ctl->conn))
8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243
        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 已提交
8244
        ret = true;
8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256
        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)) {
8257 8258
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270
        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 已提交
8271
    ret = true;
8272 8273 8274 8275 8276

cleanup:
    if (iface)
        virInterfaceFree (iface);

8277 8278 8279
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
8280 8281 8282

    if (tmp) {
        unlink (tmp);
8283
        VIR_FREE(tmp);
8284 8285 8286 8287 8288
    }

    return ret;
}

8289 8290 8291
/*
 * "net-list" command
 */
8292
static const vshCmdInfo info_network_list[] = {
8293 8294
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
8295 8296 8297
    {NULL, NULL}
};

8298
static const vshCmdOptDef opts_network_list[] = {
8299 8300
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
8301 8302 8303
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8304
static bool
8305
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8306 8307 8308 8309 8310
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
8311
    char **activeNames = NULL, **inactiveNames = NULL;
8312 8313
    inactive |= all;

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

    if (active) {
8318 8319
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
8320
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
8321
            return false;
8322
        }
8323
        if (maxactive) {
8324
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
8325

8326
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
8327
                                                    maxactive)) < 0) {
8328
                vshError(ctl, "%s", _("Failed to list active networks"));
8329
                VIR_FREE(activeNames);
E
Eric Blake 已提交
8330
                return false;
8331
            }
8332

8333
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
8334
        }
8335 8336
    }
    if (inactive) {
8337 8338
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
8339
            vshError(ctl, "%s", _("Failed to list inactive networks"));
8340
            VIR_FREE(activeNames);
E
Eric Blake 已提交
8341
            return false;
8342
        }
8343 8344 8345
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

8346 8347 8348
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
8349
                vshError(ctl, "%s", _("Failed to list inactive networks"));
8350 8351
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
8352
                return false;
8353
            }
8354

8355 8356
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
8357
    }
8358 8359
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
8360
    vshPrintExtra(ctl, "-----------------------------------------\n");
8361 8362

    for (i = 0; i < maxactive; i++) {
8363 8364
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
8365 8366
        const char *autostartStr;
        int autostart = 0;
8367 8368 8369

        /* this kind of work with networks is not atomic operation */
        if (!network) {
8370
            VIR_FREE(activeNames[i]);
8371
            continue;
8372
        }
8373

8374 8375 8376
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
8377
            autostartStr = autostart ? _("yes") : _("no");
8378 8379 8380 8381 8382

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
8383
        virNetworkFree(network);
8384
        VIR_FREE(activeNames[i]);
8385 8386 8387
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
8388 8389
        const char *autostartStr;
        int autostart = 0;
8390 8391 8392

        /* this kind of work with networks is not atomic operation */
        if (!network) {
8393
            VIR_FREE(inactiveNames[i]);
8394
            continue;
8395
        }
8396

8397 8398 8399
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
8400
            autostartStr = autostart ? _("yes") : _("no");
8401

8402
        vshPrint(ctl, "%-20s %-10s %-10s\n",
8403 8404 8405
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
8406 8407

        virNetworkFree(network);
8408
        VIR_FREE(inactiveNames[i]);
8409
    }
8410 8411
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
8412
    return true;
8413 8414 8415 8416 8417 8418
}


/*
 * "net-name" command
 */
8419
static const vshCmdInfo info_network_name[] = {
8420
    {"help", N_("convert a network UUID to network name")},
8421
    {"desc", ""},
8422 8423 8424
    {NULL, NULL}
};

8425
static const vshCmdOptDef opts_network_name[] = {
8426
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
8427 8428 8429
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8430
static bool
8431
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
8432 8433 8434
{
    virNetworkPtr network;

8435
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8436
        return false;
J
Jim Meyering 已提交
8437
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
8438
                                           VSH_BYUUID)))
E
Eric Blake 已提交
8439
        return false;
8440 8441 8442

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
8443
    return true;
8444 8445 8446 8447 8448 8449
}


/*
 * "net-start" command
 */
8450
static const vshCmdInfo info_network_start[] = {
8451 8452
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
8453 8454 8455
    {NULL, NULL}
};

8456
static const vshCmdOptDef opts_network_start[] = {
8457
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
8458 8459 8460
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8461
static bool
8462
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
8463 8464
{
    virNetworkPtr network;
E
Eric Blake 已提交
8465
    bool ret = true;
8466

8467
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8468
        return false;
8469

J
Jim Meyering 已提交
8470
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
8471
         return false;
8472 8473 8474

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
8475
                 virNetworkGetName(network));
8476
    } else {
8477
        vshError(ctl, _("Failed to start network %s"),
8478
                 virNetworkGetName(network));
E
Eric Blake 已提交
8479
        ret = false;
8480
    }
L
Laine Stump 已提交
8481
    virNetworkFree(network);
8482 8483 8484 8485 8486 8487 8488
    return ret;
}


/*
 * "net-undefine" command
 */
8489
static const vshCmdInfo info_network_undefine[] = {
8490 8491
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
8492 8493 8494
    {NULL, NULL}
};

8495
static const vshCmdOptDef opts_network_undefine[] = {
8496
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
8497 8498 8499
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8500
static bool
8501
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
8502 8503
{
    virNetworkPtr network;
E
Eric Blake 已提交
8504
    bool ret = true;
8505
    const char *name;
8506

8507
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8508
        return false;
8509

J
Jim Meyering 已提交
8510
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
8511
        return false;
8512 8513 8514 8515

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

L
Laine Stump 已提交
8520
    virNetworkFree(network);
8521 8522 8523 8524 8525 8526 8527
    return ret;
}


/*
 * "net-uuid" command
 */
8528
static const vshCmdInfo info_network_uuid[] = {
8529
    {"help", N_("convert a network name to network UUID")},
8530
    {"desc", ""},
8531 8532 8533
    {NULL, NULL}
};

8534
static const vshCmdOptDef opts_network_uuid[] = {
8535
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
8536 8537 8538
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8539
static bool
8540
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
8541 8542 8543 8544
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

8545
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8546
        return false;
8547

J
Jim Meyering 已提交
8548
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
8549
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8550
        return false;
8551 8552 8553 8554

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

L
Laine Stump 已提交
8557
    virNetworkFree(network);
E
Eric Blake 已提交
8558
    return true;
8559 8560 8561
}


8562 8563 8564 8565 8566
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
8567 8568
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
8569 8570 8571 8572
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
8573 8574
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
8575 8576
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
8577
static bool
8578 8579 8580 8581 8582 8583 8584 8585 8586
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;

8587
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8588
        return false;
8589 8590 8591 8592

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
8593
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
8594
            return false;
8595 8596 8597 8598 8599 8600
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
8601
                vshError(ctl, "%s", _("Failed to list active interfaces"));
8602
                VIR_FREE(activeNames);
E
Eric Blake 已提交
8603
                return false;
8604 8605 8606 8607 8608 8609 8610 8611
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
8612
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
8613
            VIR_FREE(activeNames);
E
Eric Blake 已提交
8614
            return false;
8615 8616 8617 8618
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

8619 8620 8621
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
8622
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
8623 8624
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
8625
                return false;
8626 8627 8628 8629 8630
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
8631 8632
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
8633 8634 8635
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
8636 8637
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
8638 8639 8640

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
8641
            VIR_FREE(activeNames[i]);
8642 8643 8644 8645 8646 8647 8648 8649
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
8650
        VIR_FREE(activeNames[i]);
8651 8652
    }
    for (i = 0; i < maxinactive; i++) {
8653 8654
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
8655 8656 8657

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
8658
            VIR_FREE(inactiveNames[i]);
8659 8660 8661 8662 8663 8664 8665 8666
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
8667
        VIR_FREE(inactiveNames[i]);
8668
    }
8669 8670
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
8671
    return true;
8672 8673 8674 8675 8676 8677 8678

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
8679
    {"help", N_("convert an interface MAC address to interface name")},
8680 8681 8682 8683 8684
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
8685
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
8686 8687 8688
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8689
static bool
8690 8691 8692 8693
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

8694
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8695
        return false;
8696
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL, NULL,
8697
                                           VSH_BYMAC)))
E
Eric Blake 已提交
8698
        return false;
8699 8700 8701

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
8702
    return true;
8703 8704 8705 8706 8707 8708
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
8709
    {"help", N_("convert an interface name to interface MAC address")},
8710 8711 8712 8713 8714
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
8715
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
8716 8717 8718
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8719
static bool
8720 8721 8722 8723
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

8724
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8725
        return false;
8726
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL, NULL,
8727
                                           VSH_BYNAME)))
E
Eric Blake 已提交
8728
        return false;
8729 8730 8731

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
8732
    return true;
8733 8734 8735 8736 8737 8738
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
8739 8740
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
8741 8742 8743 8744
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
8745 8746
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
8747 8748 8749
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8750
static bool
8751 8752 8753
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
8754
    bool ret = true;
8755
    char *dump;
E
Eric Blake 已提交
8756
    unsigned int flags = 0;
8757 8758 8759 8760
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
8761

8762
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8763
        return false;
8764 8765

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

8768
    dump = virInterfaceGetXMLDesc(iface, flags);
8769
    if (dump != NULL) {
8770
        vshPrint(ctl, "%s", dump);
8771
        VIR_FREE(dump);
8772
    } else {
E
Eric Blake 已提交
8773
        ret = false;
8774 8775 8776 8777 8778 8779 8780 8781 8782 8783
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
8784 8785
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
8786 8787 8788 8789
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
8790
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
8791 8792 8793
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8794
static bool
8795 8796
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
8797
    virInterfacePtr iface;
8798
    const char *from = NULL;
E
Eric Blake 已提交
8799
    bool ret = true;
8800 8801
    char *buffer;

8802
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8803
        return false;
8804

8805
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8806
        return false;
8807 8808

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

8811
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
8812
    VIR_FREE(buffer);
8813

8814
    if (iface != NULL) {
8815
        vshPrint(ctl, _("Interface %s defined from %s\n"),
8816
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
8817
        virInterfaceFree (iface);
8818
    } else {
8819
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
8820
        ret = false;
8821 8822 8823 8824 8825 8826 8827 8828
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
8829 8830
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
8831 8832 8833 8834
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
8835
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
8836 8837 8838
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8839
static bool
8840 8841 8842
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
8843
    bool ret = true;
8844
    const char *name;
8845

8846
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8847
        return false;
8848 8849

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
8850
        return false;
8851 8852 8853 8854

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
8855
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
8856
        ret = false;
8857 8858 8859 8860 8861 8862 8863 8864 8865 8866
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
8867 8868
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
8869 8870 8871 8872
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
8873
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
8874 8875 8876
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8877
static bool
8878 8879 8880
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
8881
    bool ret = true;
8882
    const char *name;
8883

8884
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8885
        return false;
8886 8887

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
8888
        return false;
8889 8890 8891 8892

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
8893
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
8894
        ret = false;
8895 8896 8897 8898 8899 8900 8901 8902 8903 8904
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
8905
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
8906
    {"desc", N_("forcefully stop a physical host interface.")},
8907 8908 8909 8910
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
8911
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
8912 8913 8914
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8915
static bool
8916 8917 8918
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
8919
    bool ret = true;
8920
    const char *name;
8921

8922
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8923
        return false;
8924 8925

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
8926
        return false;
8927 8928 8929 8930

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
8931
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
8932
        ret = false;
8933 8934 8935 8936 8937 8938
    }

    virInterfaceFree(iface);
    return ret;
}

8939 8940 8941 8942 8943
/*
 * "iface-begin" command
 */
static const vshCmdInfo info_interface_begin[] = {
    {"help", N_("create a snapshot of current interfaces settings, "
Y
Yuri Chornoivan 已提交
8944
                "which can be later committed (iface-commit) or "
8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976 8977 8978 8979 8980 8981 8982 8983 8984 8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 9022 9023
                "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;
}
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 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218
/*
 * "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"),
9219
             br_name, if_name);
9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326

    /* 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))) {
Y
Yuri Chornoivan 已提交
9327
        vshError(ctl, "%s", _("Multiple interfaces attached to bridge"));
9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 9356 9357 9358 9359 9360 9361 9362 9363 9364 9365 9366 9367 9368 9369 9370 9371 9372 9373 9374 9375 9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 9413 9414 9415 9416 9417 9418 9419 9420 9421 9422 9423 9424 9425 9426 9427 9428 9429 9430 9431 9432 9433 9434 9435 9436 9437
        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;
}

9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451
/*
 * "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 已提交
9452
static bool
9453 9454 9455
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
9456
    const char *from = NULL;
E
Eric Blake 已提交
9457
    bool ret = true;
9458 9459
    char *buffer;

9460
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9461
        return false;
9462

9463
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9464
        return false;
9465 9466

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
9467
        return false;
9468 9469 9470 9471 9472 9473 9474 9475 9476 9477

    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 已提交
9478
        ret = false;
9479 9480 9481 9482 9483 9484 9485 9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497
    }
    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 已提交
9498
static bool
9499 9500 9501
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
9502
    bool ret = true;
9503
    const char *name;
9504

9505
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9506
        return false;
9507 9508

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
9509
        return false;
9510 9511 9512 9513 9514

    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 已提交
9515
        ret = false;
9516 9517 9518 9519 9520 9521 9522 9523 9524 9525 9526 9527 9528 9529 9530 9531 9532 9533 9534 9535 9536
    }

    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 已提交
9537
static bool
9538 9539 9540
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
9541
    bool ret = true;
9542 9543
    char *dump;

9544
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9545
        return false;
9546 9547

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
9548
        return false;
9549 9550 9551

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
9552
        vshPrint(ctl, "%s", dump);
9553 9554
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
9555
        ret = false;
9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574
    }

    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 已提交
9575
static bool
9576 9577 9578 9579 9580 9581
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

9582
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9583
        return false;
9584 9585 9586 9587

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
9588
        return false;
9589 9590 9591 9592 9593 9594 9595 9596
    }

    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 已提交
9597
        return false;
9598 9599 9600 9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624
    }

    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 已提交
9625
    return true;
9626 9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639 9640 9641 9642
}


/*
 * "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 已提交
9643
static bool
9644 9645
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
9646
    bool ret = false;
9647 9648 9649 9650 9651 9652
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

9653
    if (!vshConnectionUsability(ctl, ctl->conn))
9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679
        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 已提交
9680
        ret = true;
9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706
        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 已提交
9707
    ret = true;
9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725

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


9726
/**************************************************************************/
9727
/*
9728
 * "pool-autostart" command
9729
 */
9730
static const vshCmdInfo info_pool_autostart[] = {
9731
    {"help", N_("autostart a pool")},
9732
    {"desc",
9733
     N_("Configure a pool to be automatically started at boot.")},
9734
    {NULL, NULL}
9735 9736
};

9737
static const vshCmdOptDef opts_pool_autostart[] = {
9738 9739
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
9740 9741
    {NULL, 0, 0, NULL}
};
9742

E
Eric Blake 已提交
9743
static bool
9744
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
9745
{
9746
    virStoragePoolPtr pool;
9747
    const char *name;
9748
    int autostart;
9749

9750
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9751
        return false;
9752

9753
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
9754
        return false;
9755

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

9758 9759
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
9760
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
9761
        else
9762
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
9763
        virStoragePoolFree(pool);
E
Eric Blake 已提交
9764
        return false;
9765 9766
    }

9767
    if (autostart)
9768
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
9769
    else
9770
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
9771

L
Laine Stump 已提交
9772
    virStoragePoolFree(pool);
E
Eric Blake 已提交
9773
    return true;
9774 9775
}

9776
/*
9777
 * "pool-create" command
9778
 */
9779
static const vshCmdInfo info_pool_create[] = {
9780 9781
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
9782 9783 9784
    {NULL, NULL}
};

9785
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
9786
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
9787
     N_("file containing an XML pool description")},
9788 9789 9790
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9791
static bool
9792
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
9793
{
9794
    virStoragePoolPtr pool;
9795
    const char *from = NULL;
E
Eric Blake 已提交
9796
    bool ret = true;
9797
    char *buffer;
9798

9799
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9800
        return false;
9801

9802
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9803
        return false;
9804

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

9808
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
9809
    VIR_FREE(buffer);
9810 9811 9812 9813

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
9814
        virStoragePoolFree(pool);
9815
    } else {
9816
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
9817
        ret = false;
9818 9819
    }
    return ret;
9820 9821
}

9822

9823 9824 9825 9826
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
9827
    {"help", N_("create a device defined "
9828
                          "by an XML file on the node")},
9829
    {"desc", N_("Create a device on the node.  Note that this "
9830 9831 9832 9833 9834 9835 9836
                          "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,
9837
     N_("file containing an XML description of the device")},
9838 9839 9840
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9841
static bool
9842 9843 9844
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
9845
    const char *from = NULL;
E
Eric Blake 已提交
9846
    bool ret = true;
9847 9848
    char *buffer;

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

9852
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
9853
        return false;
9854

9855
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
9856
        return false;
9857 9858

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
9859
    VIR_FREE(buffer);
9860 9861 9862 9863

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
9864
        virNodeDeviceFree(dev);
9865
    } else {
9866
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
9867
        ret = false;
9868 9869 9870 9871 9872 9873 9874 9875 9876 9877
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
9878
    {"help", N_("destroy (stop) a device on the node")},
9879
    {"desc", N_("Destroy a device on the node.  Note that this "
9880
                "command destroys devices on the physical host")},
9881 9882 9883 9884 9885
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
9886
     N_("name of the device to be destroyed")},
9887 9888 9889
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9890
static bool
9891 9892 9893
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
9894
    bool ret = true;
9895
    const char *name = NULL;
9896

9897
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
9898
        return false;
9899 9900
    }

9901
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
9902
        return false;
9903 9904 9905 9906 9907 9908

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
9909
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
9910
        ret = false;
9911 9912 9913 9914 9915 9916 9917
    }

    virNodeDeviceFree(dev);
    return ret;
}


9918
/*
9919
 * XML Building helper for pool-define-as and pool-create-as
9920
 */
9921
static const vshCmdOptDef opts_pool_X_as[] = {
9922 9923 9924 9925 9926 9927 9928 9929
    {"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")},
9930
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
9931 9932 9933
    {NULL, 0, 0, NULL}
};

9934
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
9935

9936 9937
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
9938
    virBuffer buf = VIR_BUFFER_INITIALIZER;
9939

9940
    if (vshCommandOptString(cmd, "name", &name) <= 0)
9941
        goto cleanup;
9942
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9943 9944
        goto cleanup;

9945 9946 9947 9948 9949
    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 ||
9950 9951
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
9952
        goto cleanup;
9953
    }
9954

9955 9956
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
9957
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
9958
        virBufferAddLit(&buf, "  <source>\n");
9959

9960
        if (srcHost)
9961
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
9962
        if (srcPath)
9963
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
9964
        if (srcDev)
9965
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
9966
        if (srcFormat)
9967
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
9968
        if (srcName)
9969
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
9970 9971

        virBufferAddLit(&buf, "  </source>\n");
9972 9973
    }
    if (target) {
9974
        virBufferAddLit(&buf, "  <target>\n");
9975
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
9976
        virBufferAddLit(&buf, "  </target>\n");
9977
    }
9978 9979 9980 9981
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
9982
        return false;
9983
    }
9984 9985 9986

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
9987
    return true;
9988 9989

cleanup:
9990
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
9991
    return false;
9992 9993 9994 9995 9996 9997
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
9998 9999
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
10000 10001 10002
    {NULL, NULL}
};

E
Eric Blake 已提交
10003
static bool
10004 10005 10006
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
10007 10008
    const char *name;
    char *xml;
10009
    int printXML = vshCommandOptBool(cmd, "print-xml");
10010

10011
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10012
        return false;
10013 10014

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

10017
    if (printXML) {
10018
        vshPrint(ctl, "%s", xml);
10019
        VIR_FREE(xml);
10020
    } else {
10021
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
10022
        VIR_FREE(xml);
10023

10024 10025 10026 10027
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
10028
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
10029
            return false;
10030 10031
        }
    }
E
Eric Blake 已提交
10032
    return true;
10033 10034
}

10035

10036
/*
10037
 * "pool-define" command
10038
 */
10039
static const vshCmdInfo info_pool_define[] = {
10040 10041
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
10042 10043 10044
    {NULL, NULL}
};

10045
static const vshCmdOptDef opts_pool_define[] = {
10046
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
10047 10048 10049
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10050
static bool
10051
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
10052
{
10053
    virStoragePoolPtr pool;
10054
    const char *from = NULL;
E
Eric Blake 已提交
10055
    bool ret = true;
10056
    char *buffer;
10057

10058
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10059
        return false;
10060

10061
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10062
        return false;
10063

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

10067
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
10068
    VIR_FREE(buffer);
10069 10070 10071 10072

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
10073
        virStoragePoolFree(pool);
10074
    } else {
10075
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
10076
        ret = false;
10077 10078
    }
    return ret;
10079 10080
}

10081

10082 10083 10084
/*
 * "pool-define-as" command
 */
10085
static const vshCmdInfo info_pool_define_as[] = {
10086 10087
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
10088 10089 10090
    {NULL, NULL}
};

E
Eric Blake 已提交
10091
static bool
10092
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
10093 10094
{
    virStoragePoolPtr pool;
10095 10096
    const char *name;
    char *xml;
10097
    int printXML = vshCommandOptBool(cmd, "print-xml");
10098

10099
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10100
        return false;
10101

10102
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
10103
        return false;
10104

10105
    if (printXML) {
10106
        vshPrint(ctl, "%s", xml);
10107
        VIR_FREE(xml);
10108
    } else {
10109
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
10110
        VIR_FREE(xml);
10111

10112 10113 10114 10115
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
10116
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
10117
            return false;
10118 10119
        }
    }
E
Eric Blake 已提交
10120
    return true;
10121 10122 10123
}


10124
/*
10125
 * "pool-build" command
10126
 */
10127
static const vshCmdInfo info_pool_build[] = {
10128 10129
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
10130 10131 10132
    {NULL, NULL}
};

10133
static const vshCmdOptDef opts_pool_build[] = {
10134
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10135 10136
    {"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")},
10137 10138 10139
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10140
static bool
10141
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
10142
{
10143
    virStoragePoolPtr pool;
E
Eric Blake 已提交
10144
    bool ret = true;
10145
    const char *name;
10146
    unsigned int flags = 0;
10147

10148
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10149
        return false;
10150

10151
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
10152
        return false;
10153

10154 10155 10156 10157 10158 10159 10160 10161 10162
    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) {
10163
        vshPrint(ctl, _("Pool %s built\n"), name);
10164
    } else {
10165
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
10166
        ret = false;
10167 10168
    }

10169 10170
    virStoragePoolFree(pool);

10171 10172 10173
    return ret;
}

10174
/*
10175
 * "pool-destroy" command
10176
 */
10177
static const vshCmdInfo info_pool_destroy[] = {
10178 10179 10180
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
10181 10182 10183
    {NULL, NULL}
};

10184
static const vshCmdOptDef opts_pool_destroy[] = {
10185
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10186 10187 10188
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10189
static bool
10190
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
10191
{
10192
    virStoragePoolPtr pool;
E
Eric Blake 已提交
10193
    bool ret = true;
10194
    const char *name;
10195

10196
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10197
        return false;
10198

10199
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
10200
        return false;
10201

10202 10203 10204
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
10205
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
10206
        ret = false;
10207 10208
    }

10209
    virStoragePoolFree(pool);
10210 10211 10212
    return ret;
}

10213

10214
/*
10215 10216
 * "pool-delete" command
 */
10217
static const vshCmdInfo info_pool_delete[] = {
10218 10219
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
10220 10221 10222
    {NULL, NULL}
};

10223
static const vshCmdOptDef opts_pool_delete[] = {
10224
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10225 10226 10227
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10228
static bool
10229
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
10230 10231
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
10232
    bool ret = true;
10233
    const char *name;
10234

10235
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10236
        return false;
10237 10238

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
10239
        return false;
10240 10241

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
10242
        vshPrint(ctl, _("Pool %s deleted\n"), name);
10243
    } else {
10244
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
10245
        ret = false;
10246 10247
    }

L
Laine Stump 已提交
10248
    virStoragePoolFree(pool);
10249 10250 10251 10252 10253 10254 10255
    return ret;
}


/*
 * "pool-refresh" command
 */
10256
static const vshCmdInfo info_pool_refresh[] = {
10257 10258
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
10259 10260 10261
    {NULL, NULL}
};

10262
static const vshCmdOptDef opts_pool_refresh[] = {
10263
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10264 10265 10266
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10267
static bool
10268
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
10269 10270
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
10271
    bool ret = true;
10272
    const char *name;
10273

10274
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10275
        return false;
10276 10277

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
10278
        return false;
10279 10280 10281 10282

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
10283
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
10284
        ret = false;
10285 10286 10287 10288 10289 10290 10291 10292 10293 10294
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
10295
static const vshCmdInfo info_pool_dumpxml[] = {
10296 10297
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
10298 10299 10300
    {NULL, NULL}
};

10301
static const vshCmdOptDef opts_pool_dumpxml[] = {
10302
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10303 10304 10305
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10306
static bool
10307
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
10308 10309
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
10310
    bool ret = true;
10311 10312
    char *dump;

10313
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10314
        return false;
10315 10316

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
10317
        return false;
10318 10319 10320

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
10321
        vshPrint(ctl, "%s", dump);
10322
        VIR_FREE(dump);
10323
    } else {
E
Eric Blake 已提交
10324
        ret = false;
10325 10326 10327 10328 10329 10330 10331 10332 10333 10334
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
10335
static const vshCmdInfo info_pool_list[] = {
10336 10337
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
10338 10339 10340
    {NULL, NULL}
};

10341
static const vshCmdOptDef opts_pool_list[] = {
10342 10343
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
10344
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
10345 10346 10347
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10348
static bool
10349
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10350
{
10351 10352
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
10353 10354
    int i, ret;
    bool functionReturn;
10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370
    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 */
10371
    int all = vshCommandOptBool(cmd, "all");
10372 10373
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
10374 10375 10376
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

10377
    /* Check the connection to libvirtd daemon is still working */
10378
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10379
        return false;
10380

10381
    /* Retrieve the number of active storage pools */
10382
    if (active) {
10383 10384
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
10385
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
10386
            return false;
10387 10388
        }
    }
10389 10390

    /* Retrieve the number of inactive storage pools */
10391
    if (inactive) {
10392 10393
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
10394
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
10395
            return false;
10396
        }
10397
    }
10398

10399 10400
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
10401

10402 10403 10404 10405 10406 10407 10408 10409 10410 10411 10412 10413
    /* 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 已提交
10414
            return false;
10415 10416 10417
        }
    }

10418 10419 10420 10421 10422 10423 10424 10425
    /* 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 已提交
10426
            return false;
10427 10428
        }
    }
10429

10430 10431 10432 10433 10434 10435 10436 10437 10438 10439
    /* 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]);
10440
        if (!pool) {
10441
            VIR_FREE(poolNames[i]);
10442 10443 10444
            continue;
        }

10445
        /* Retrieve the autostart status of the pool */
10446
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
10447
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
10448
        else
10449 10450 10451 10452 10453 10454
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
10455 10456
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467
            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;
        }
10468

10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 10480 10481 10482 10483 10484 10485 10486 10487 10488 10489 10490 10491 10492 10493 10494 10495 10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580
        /* 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 */
10581 10582 10583
        virStoragePoolFree(pool);
    }

10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601
    /* 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);
10602 10603
        }

10604
        /* Cleanup and return */
E
Eric Blake 已提交
10605
        functionReturn = true;
10606 10607
        goto cleanup;
    }
10608

10609 10610 10611 10612 10613 10614 10615 10616 10617 10618 10619 10620 10621 10622 10623 10624 10625 10626 10627 10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646
    /* 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. */
10647
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
10648
             (unsigned long) nameStrLength);
10649
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
10650
             (unsigned long) stateStrLength);
10651
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
10652
             (unsigned long) autostartStrLength);
10653
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
10654
             (unsigned long) persistStrLength);
10655
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
10656
             (unsigned long) capStrLength);
10657
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
10658
             (unsigned long) allocStrLength);
10659
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
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 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702
             (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 已提交
10703
    functionReturn = true;
10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717
    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 已提交
10718
    functionReturn = false;
10719

10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731
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]);
10732
    }
10733 10734 10735 10736 10737 10738 10739

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

    /* Return the desired value */
    return functionReturn;
10740 10741
}

10742 10743 10744 10745
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
10746 10747
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
10748 10749 10750 10751 10752
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
10753 10754 10755
     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")},
10756
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
10757 10758 10759
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10760
static bool
10761 10762
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
10763
    const char *type = NULL, *host = NULL;
10764 10765
    char *srcSpec = NULL;
    char *srcList;
10766
    const char *initiator = NULL;
10767

10768 10769
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
10770 10771
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
10772
        return false;
10773
    }
10774

10775
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10776
        return false;
10777 10778

    if (host) {
10779
        const char *port = NULL;
10780
        virBuffer buf = VIR_BUFFER_INITIALIZER;
10781 10782 10783 10784

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
10785
            return false;
10786
        }
10787
        virBufferAddLit(&buf, "<source>\n");
10788
        virBufferAsprintf(&buf, "  <host name='%s'", host);
10789
        if (port)
10790
            virBufferAsprintf(&buf, " port='%s'", port);
10791
        virBufferAddLit(&buf, "/>\n");
10792 10793
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
10794
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
10795 10796
            virBufferAddLit(&buf, "  </initiator>\n");
        }
10797 10798 10799
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
10800
            return false;
10801
        }
10802
        srcSpec = virBufferContentAndReset(&buf);
10803 10804 10805
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
10806
    VIR_FREE(srcSpec);
10807
    if (srcList == NULL) {
10808
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
10809
        return false;
10810 10811
    }
    vshPrint(ctl, "%s", srcList);
10812
    VIR_FREE(srcList);
10813

E
Eric Blake 已提交
10814
    return true;
10815 10816 10817 10818 10819 10820 10821
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
10822 10823
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
10824 10825 10826 10827 10828
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
10829
     N_("type of storage pool sources to discover")},
10830
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
10831
     N_("optional file of source xml to query for pools")},
10832 10833 10834
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10835
static bool
10836 10837
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
10838
    const char *type = NULL, *srcSpecFile = NULL;
10839
    char *srcSpec = NULL, *srcList;
10840

10841
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
10842
        return false;
10843

10844 10845
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
10846
        return false;
10847
    }
10848

10849
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10850
        return false;
10851 10852

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
10853
        return false;
10854 10855

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
10856
    VIR_FREE(srcSpec);
10857
    if (srcList == NULL) {
10858
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
10859
        return false;
10860 10861
    }
    vshPrint(ctl, "%s", srcList);
10862
    VIR_FREE(srcList);
10863

E
Eric Blake 已提交
10864
    return true;
10865 10866 10867
}


10868 10869 10870
/*
 * "pool-info" command
 */
10871
static const vshCmdInfo info_pool_info[] = {
10872 10873
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
10874 10875 10876
    {NULL, NULL}
};

10877
static const vshCmdOptDef opts_pool_info[] = {
10878
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10879 10880 10881
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10882
static bool
10883
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
10884 10885 10886
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
10887 10888
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
10889
    bool ret = true;
10890 10891
    char uuid[VIR_UUID_STRING_BUFLEN];

10892
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10893
        return false;
10894 10895

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
10896
        return false;
10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914 10915 10916 10917 10918 10919 10920 10921 10922

    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;
10923 10924 10925 10926
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
10927 10928
        }

10929 10930
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
10931 10932
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
10933 10934 10935 10936 10937 10938 10939
        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);
10940 10941
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
10942 10943 10944 10945 10946
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958
        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 已提交
10959
        ret = false;
10960 10961 10962 10963 10964 10965 10966 10967 10968 10969
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
10970
static const vshCmdInfo info_pool_name[] = {
10971
    {"help", N_("convert a pool UUID to pool name")},
10972
    {"desc", ""},
10973 10974 10975
    {NULL, NULL}
};

10976
static const vshCmdOptDef opts_pool_name[] = {
10977
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
10978 10979 10980
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10981
static bool
10982
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
10983 10984 10985
{
    virStoragePoolPtr pool;

10986
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10987
        return false;
10988
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
10989
                                           VSH_BYUUID)))
E
Eric Blake 已提交
10990
        return false;
10991 10992 10993

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
10994
    return true;
10995 10996 10997 10998 10999 11000
}


/*
 * "pool-start" command
 */
11001
static const vshCmdInfo info_pool_start[] = {
11002 11003
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
11004 11005 11006
    {NULL, NULL}
};

11007
static const vshCmdOptDef opts_pool_start[] = {
11008
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
11009 11010 11011
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11012
static bool
11013
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
11014 11015
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
11016
    bool ret = true;
11017

11018
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11019
        return false;
11020

11021
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
11022
         return false;
11023 11024 11025 11026 11027

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
11028
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
11029
        ret = false;
11030
    }
L
Laine Stump 已提交
11031 11032

    virStoragePoolFree(pool);
11033 11034 11035 11036
    return ret;
}


11037 11038 11039
/*
 * "vol-create-as" command
 */
11040
static const vshCmdInfo info_vol_create_as[] = {
11041 11042
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
11043 11044 11045
    {NULL, NULL}
};

11046
static const vshCmdOptDef opts_vol_create_as[] = {
11047 11048 11049 11050 11051
    {"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")},
11052 11053
    {"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")},
11054 11055 11056 11057 11058 11059 11060 11061 11062 11063
    {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 已提交
11064
        /* Deliberate fallthrough cases here :-) */
11065 11066 11067
        switch (*end) {
        case 'T':
            *val *= 1024;
11068
            /* fallthrough */
11069 11070
        case 'G':
            *val *= 1024;
11071
            /* fallthrough */
11072 11073
        case 'M':
            *val *= 1024;
11074
            /* fallthrough */
11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
11088
static bool
11089
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
11090 11091 11092
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
11093
    char *xml;
11094 11095
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
11096
    unsigned long long capacity, allocation = 0;
11097
    virBuffer buf = VIR_BUFFER_INITIALIZER;
11098

11099
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11100
        return false;
11101 11102 11103

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

11106
    if (vshCommandOptString(cmd, "name", &name) <= 0)
11107 11108
        goto cleanup;

11109
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
11110 11111
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
11112
        vshError(ctl, _("Malformed size %s"), capacityStr);
11113

11114 11115
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
11116
        vshError(ctl, _("Malformed size %s"), allocationStr);
11117

11118 11119 11120 11121 11122 11123 11124
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

11125

11126
    virBufferAddLit(&buf, "<volume>\n");
11127 11128
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
11129
    if (allocationStr)
11130
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
11131 11132

    if (format) {
11133
        virBufferAddLit(&buf, "  <target>\n");
11134
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
11135
        virBufferAddLit(&buf, "  </target>\n");
11136
    }
11137

11138 11139 11140 11141
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
11142 11143
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
11144 11145 11146
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
11147 11148
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
11149 11150 11151 11152 11153
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
11154 11155
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
11156 11157 11158
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
11159 11160
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
11161 11162 11163 11164 11165
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
11166 11167
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
11168 11169 11170
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
11171 11172
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
11173 11174 11175 11176
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
11177
            goto cleanup;
11178 11179 11180 11181 11182
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
11183
            goto cleanup;
11184 11185 11186 11187
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
11188
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
11189
        if (snapshotStrFormat)
11190
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
11191 11192 11193 11194 11195 11196 11197 11198
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

11200 11201
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
11202
        goto cleanup;
11203 11204 11205
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
11206
    VIR_FREE(xml);
11207 11208 11209 11210 11211
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
11212
        return true;
11213
    } else {
11214
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
11215
        return false;
11216 11217 11218
    }

 cleanup:
11219
    virBufferFreeAndReset(&buf);
11220
    virStoragePoolFree(pool);
E
Eric Blake 已提交
11221
    return false;
11222 11223 11224
}


11225 11226 11227
/*
 * "pool-undefine" command
 */
11228
static const vshCmdInfo info_pool_undefine[] = {
11229 11230
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
11231 11232 11233
    {NULL, NULL}
};

11234
static const vshCmdOptDef opts_pool_undefine[] = {
11235
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
11236 11237 11238
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11239
static bool
11240
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
11241 11242
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
11243
    bool ret = true;
11244
    const char *name;
11245

11246
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11247
        return false;
11248 11249

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
11250
        return false;
11251 11252 11253 11254

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

L
Laine Stump 已提交
11259
    virStoragePoolFree(pool);
11260 11261 11262 11263 11264 11265 11266
    return ret;
}


/*
 * "pool-uuid" command
 */
11267
static const vshCmdInfo info_pool_uuid[] = {
11268
    {"help", N_("convert a pool name to pool UUID")},
11269
    {"desc", ""},
11270 11271 11272
    {NULL, NULL}
};

11273
static const vshCmdOptDef opts_pool_uuid[] = {
11274
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
11275 11276 11277
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11278
static bool
11279
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
11280 11281 11282 11283
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

11284
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11285
        return false;
11286 11287

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
11288
                                           VSH_BYNAME)))
E
Eric Blake 已提交
11289
        return false;
11290 11291 11292 11293

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

L
Laine Stump 已提交
11296
    virStoragePoolFree(pool);
E
Eric Blake 已提交
11297
    return true;
11298 11299 11300 11301 11302 11303
}


/*
 * "vol-create" command
 */
11304
static const vshCmdInfo info_vol_create[] = {
11305 11306
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
11307 11308 11309
    {NULL, NULL}
};

11310
static const vshCmdOptDef opts_vol_create[] = {
11311 11312
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
11313 11314 11315
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11316
static bool
11317
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
11318 11319 11320
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
11321
    const char *from = NULL;
E
Eric Blake 已提交
11322
    bool ret = true;
11323 11324
    char *buffer;

11325
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11326
        return false;
11327 11328

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

11332
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11333
        virStoragePoolFree(pool);
E
Eric Blake 已提交
11334
        return false;
11335 11336 11337
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11338
        virshReportError(ctl);
11339
        virStoragePoolFree(pool);
E
Eric Blake 已提交
11340
        return false;
11341 11342 11343
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
11344
    VIR_FREE(buffer);
11345 11346 11347 11348 11349 11350 11351
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
11352
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
11353
        ret = false;
11354 11355 11356 11357
    }
    return ret;
}

11358 11359 11360 11361
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
11362 11363
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
11364 11365 11366 11367
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
11368 11369 11370
    {"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 已提交
11371
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
11372 11373 11374
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11375
static bool
11376 11377 11378 11379
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
11380
    const char *from = NULL;
E
Eric Blake 已提交
11381
    bool ret = false;
11382 11383
    char *buffer = NULL;

11384
    if (!vshConnectionUsability(ctl, ctl->conn))
11385 11386 11387 11388 11389
        goto cleanup;

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

11390
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
11391 11392 11393 11394 11395 11396 11397
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
11398
        virshReportError(ctl);
11399 11400 11401 11402 11403 11404 11405 11406 11407
        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 {
11408
        vshError(ctl, _("Failed to create vol from %s"), from);
11409 11410 11411
        goto cleanup;
    }

E
Eric Blake 已提交
11412
    ret = true;
11413
cleanup:
11414
    VIR_FREE(buffer);
11415 11416 11417 11418
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
11419 11420
    if (newvol)
        virStorageVolFree(newvol);
11421 11422 11423 11424
    return ret;
}

static xmlChar *
11425 11426
makeCloneXML(const char *origxml, const char *newname)
{
11427

11428 11429 11430
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
11431 11432 11433
    xmlChar *newxml = NULL;
    int size;

11434
    doc = virXMLParseStringCtxt(origxml, _("(volume_definition)"), &ctxt);
11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456
    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[] = {
11457 11458
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
11459 11460 11461 11462
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
11463 11464
    {"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 已提交
11465
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
11466 11467 11468
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11469
static bool
11470 11471 11472 11473
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
11474
    const char *name = NULL;
11475
    char *origxml = NULL;
11476
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
11477
    bool ret = false;
11478

11479
    if (!vshConnectionUsability(ctl, ctl->conn))
11480 11481 11482 11483 11484 11485 11486
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
11487
        vshError(ctl, "%s", _("failed to get parent pool"));
11488 11489 11490
        goto cleanup;
    }

11491
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509
        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 {
11510
        vshError(ctl, _("Failed to clone vol from %s"),
11511 11512 11513 11514
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
11515
    ret = true;
11516 11517

cleanup:
11518
    VIR_FREE(origxml);
11519 11520 11521
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
11522 11523
    if (newvol)
        virStorageVolFree(newvol);
11524 11525 11526 11527 11528
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541

/*
 * "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 已提交
11542
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556
    {"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 已提交
11557
static bool
11558 11559 11560 11561
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
11562
    bool ret = false;
11563 11564 11565 11566 11567 11568 11569 11570 11571 11572
    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 已提交
11573
        return false;
11574 11575 11576 11577
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
11578
        return false;
11579 11580 11581
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
11582
        return false;
11583 11584 11585 11586 11587 11588 11589 11590 11591 11592 11593 11594 11595 11596 11597 11598 11599 11600 11601 11602 11603 11604 11605 11606 11607 11608 11609 11610 11611 11612 11613 11614 11615 11616
    }

    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 已提交
11617
    ret = true;
11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641

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 已提交
11642
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
11643 11644 11645 11646 11647
    {"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 已提交
11648
static bool
11649 11650 11651 11652
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
11653
    bool ret = false;
11654 11655 11656 11657
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
11658
    bool created = false;
11659 11660

    if (!vshConnectionUsability(ctl, ctl->conn))
11661
        return false;
11662 11663 11664

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
11665
        return false;
11666 11667 11668 11669
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
11670
        return false;
11671 11672 11673
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
11674
        return false;
11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686

    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;
        }
11687 11688
    } else {
        created = true;
11689 11690 11691 11692 11693 11694 11695 11696
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

11697
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712
        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 已提交
11713
    ret = true;
11714 11715

cleanup:
11716
    VIR_FORCE_CLOSE(fd);
11717
    if (!ret && created)
11718 11719 11720 11721 11722 11723 11724 11725 11726
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


11727 11728 11729
/*
 * "vol-delete" command
 */
11730
static const vshCmdInfo info_vol_delete[] = {
11731 11732
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
11733 11734 11735
    {NULL, NULL}
};

11736
static const vshCmdOptDef opts_vol_delete[] = {
11737
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
11738
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
11739 11740 11741
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11742
static bool
11743
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
11744 11745
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
11746
    bool ret = true;
11747
    const char *name;
11748

11749
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11750
        return false;
11751 11752

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
11753
        return false;
11754 11755 11756
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
11757
        vshPrint(ctl, _("Vol %s deleted\n"), name);
11758
    } else {
11759
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
11760
        ret = false;
11761 11762
    }

L
Laine Stump 已提交
11763
    virStorageVolFree(vol);
11764 11765 11766 11767
    return ret;
}


D
David Allan 已提交
11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778
/*
 * "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 已提交
11779
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
11780
    {"algorithm", VSH_OT_STRING, 0, N_("perform selected wiping algorithm")},
D
David Allan 已提交
11781 11782 11783
    {NULL, 0, 0, NULL}
};

11784 11785 11786 11787 11788
VIR_ENUM_DECL(virStorageVolWipeAlgorithm)
VIR_ENUM_IMPL(virStorageVolWipeAlgorithm, VIR_STORAGE_VOL_WIPE_ALG_LAST,
              "zero", "nnsa", "dod", "bsi", "gutmann", "schneier",
              "pfitzner7", "pfitzner33", "random");

E
Eric Blake 已提交
11789
static bool
D
David Allan 已提交
11790 11791 11792
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
11793
    bool ret = false;
11794
    const char *name;
11795 11796 11797
    const char *algorithm_str = NULL;
    int algorithm = VIR_STORAGE_VOL_WIPE_ALG_ZERO;
    int funcRet;
D
David Allan 已提交
11798

11799
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11800
        return false;
D
David Allan 已提交
11801 11802

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
11803
        return false;
D
David Allan 已提交
11804 11805
    }

11806 11807 11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822 11823
    if (vshCommandOptString(cmd, "algorithm", &algorithm_str) < 0) {
        vshError(ctl, "%s", _("missing argument"));
        goto out;
    }

    if (algorithm_str &&
        (algorithm = virStorageVolWipeAlgorithmTypeFromString(algorithm_str)) < 0) {
        vshError(ctl, _("Unsupported algorithm '%s'"), algorithm_str);
        goto out;
    }

    if ((funcRet = virStorageVolWipePattern(vol, algorithm, 0)) < 0) {
        if (last_error->code == VIR_ERR_NO_SUPPORT &&
            algorithm == VIR_STORAGE_VOL_WIPE_ALG_ZERO)
            funcRet = virStorageVolWipe(vol, 0);
    }

    if (funcRet < 0) {
D
David Allan 已提交
11824
        vshError(ctl, _("Failed to wipe vol %s"), name);
11825
        goto out;
D
David Allan 已提交
11826 11827
    }

11828 11829 11830
    vshPrint(ctl, _("Vol %s wiped\n"), name);
    ret = true;
out:
D
David Allan 已提交
11831 11832 11833 11834 11835
    virStorageVolFree(vol);
    return ret;
}


11836 11837 11838
/*
 * "vol-info" command
 */
11839
static const vshCmdInfo info_vol_info[] = {
11840 11841
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
11842 11843 11844
    {NULL, NULL}
};

11845
static const vshCmdOptDef opts_vol_info[] = {
11846
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
11847
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
11848 11849 11850
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11851
static bool
11852
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
11853 11854 11855
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
11856
    bool ret = true;
11857

11858
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
11859
        return false;
11860 11861

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
11862
        return false;
11863 11864 11865 11866 11867 11868

    vshPrint(ctl, "%-15s %s\n", _("Name:"), virStorageVolGetName(vol));

    if (virStorageVolGetInfo(vol, &info) == 0) {
        double val;
        const char *unit;
R
Ryota Ozaki 已提交
11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884
        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"));
        }
11885 11886 11887 11888 11889 11890 11891

        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 已提交
11892
        ret = false;
11893 11894 11895 11896 11897 11898
    }

    virStorageVolFree(vol);
    return ret;
}

11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954 11955 11956 11957 11958 11959 11960 11961 11962 11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979
/*
 * "vol-resize" command
 */
static const vshCmdInfo info_vol_resize[] = {
    {"help", N_("resize a vol")},
    {"desc", N_("Resizes a storage volume.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_resize[] = {
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
    {"capacity", VSH_OT_DATA, VSH_OFLAG_REQ,
     N_("new capacity for the vol with optional k,M,G,T suffix")},
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
    {"allocate", VSH_OT_BOOL, 0,
     N_("allocate the new capacity, rather than leaving it sparse")},
    {"delta", VSH_OT_BOOL, 0,
     N_("use capacity as a delta to current size, rather than the new size")},
    {"shrink", VSH_OT_BOOL, 0, N_("allow the resize to shrink the volume")},
    {NULL, 0, 0, NULL}
};

static bool
cmdVolResize(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
    const char *capacityStr = NULL;
    unsigned long long capacity = 0;
    unsigned int flags = 0;
    bool ret = false;
    bool delta = false;

    if (vshCommandOptBool(cmd, "allocate"))
        flags |= VIR_STORAGE_VOL_RESIZE_ALLOCATE;
    if (vshCommandOptBool(cmd, "delta")) {
        delta = true;
        flags |= VIR_STORAGE_VOL_RESIZE_DELTA;
    }
    if (vshCommandOptBool(cmd, "shrink"))
        flags |= VIR_STORAGE_VOL_RESIZE_SHRINK;

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

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        return false;

    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
        goto cleanup;
    if (delta && *capacityStr == '-') {
        if (cmdVolSize(capacityStr + 1, &capacity) < 0) {
            vshError(ctl, _("Malformed size %s"), capacityStr);
            goto cleanup;
        }
        capacity = -capacity;
    } else {
        if (cmdVolSize(capacityStr, &capacity) < 0) {
            vshError(ctl, _("Malformed size %s"), capacityStr);
            goto cleanup;
        }
    }

    if (virStorageVolResize(vol, capacity, flags) == 0) {
        vshPrint(ctl,
                 delta ? _("Size of volume '%s' successfully changed by %s\n")
                 : _("Size of volume '%s' successfully changed to %s\n"),
                 virStorageVolGetName(vol), capacityStr);
        ret = true;
    } else {
        vshError(ctl,
                 delta ? _("Failed to change size of volume '%s' by %s\n")
                 : _("Failed to change size of volume '%s' to %s\n"),
                 virStorageVolGetName(vol), capacityStr);
        ret = false;
    }

cleanup:
    virStorageVolFree(vol);
    return ret;
}

11980 11981 11982 11983

/*
 * "vol-dumpxml" command
 */
11984
static const vshCmdInfo info_vol_dumpxml[] = {
11985 11986
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
11987 11988 11989
    {NULL, NULL}
};

11990
static const vshCmdOptDef opts_vol_dumpxml[] = {
11991
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
11992
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
11993 11994 11995
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11996
static bool
11997
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
11998 11999
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
12000
    bool ret = true;
12001 12002
    char *dump;

12003
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12004
        return false;
12005 12006

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
12007
        return false;
12008 12009 12010

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
12011
        vshPrint(ctl, "%s", dump);
12012
        VIR_FREE(dump);
12013
    } else {
E
Eric Blake 已提交
12014
        ret = false;
12015 12016 12017 12018 12019 12020 12021 12022 12023 12024
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
12025
static const vshCmdInfo info_vol_list[] = {
12026 12027
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
12028 12029 12030
    {NULL, NULL}
};

12031
static const vshCmdOptDef opts_vol_list[] = {
12032
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
12033
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
12034 12035 12036
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12037
static bool
12038
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
12039
{
12040
    virStorageVolInfo volumeInfo;
12041 12042
    virStoragePoolPtr pool;
    char **activeNames = NULL;
12043 12044 12045 12046 12047
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
12048 12049
    int ret;
    bool functionReturn;
12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060
    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;
12061

12062
    /* Check the connection to libvirtd daemon is still working */
12063
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12064
        return false;
12065

12066
    /* Look up the pool information given to us by the user */
12067
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
12068
        return false;
12069

12070 12071
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
12072

12073 12074 12075
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
12076
        return false;
12077 12078
    }

12079 12080 12081 12082 12083
    /* 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) {
12084
            vshError(ctl, "%s", _("Failed to list active vols"));
12085
            VIR_FREE(activeNames);
12086
            virStoragePoolFree(pool);
E
Eric Blake 已提交
12087
            return false;
12088 12089
        }

12090 12091 12092 12093 12094
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

        /* Set aside memory for volume information pointers */
        volInfoTexts = vshCalloc(ctl, numVolumes, sizeof(*volInfoTexts));
12095 12096
    }

12097 12098 12099 12100 12101
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
12102

12103 12104 12105 12106
        /* 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"));
12107 12108
        }

12109 12110 12111 12112 12113 12114 12115 12116 12117
        /* 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 */
12118

12119
                /* Volume type */
12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132
                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"));
                }
12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 12152 12153 12154 12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165 12166 12167 12168 12169 12170 12171 12172 12173 12174 12175 12176 12177 12178 12179 12180 12181 12182

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

12184
        /* Cleanup memory allocation */
12185
        virStorageVolFree(vol);
12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201 12202 12203
    }

    /* 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 已提交
12204
        functionReturn = true;
12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235
        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 */
12236 12237 12238 12239 12240 12241 12242 12243 12244 12245
    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);
12246 12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258 12259 12260 12261 12262 12263 12264 12265 12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279

    /* 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 已提交
12280
    functionReturn = true;
12281 12282 12283 12284 12285 12286 12287 12288 12289 12290 12291 12292 12293 12294
    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 已提交
12295
    functionReturn = false;
12296 12297 12298 12299 12300 12301 12302 12303 12304 12305

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);
12306
        VIR_FREE(activeNames[i]);
12307
    }
12308 12309 12310 12311

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
12312
    VIR_FREE(activeNames);
12313
    virStoragePoolFree(pool);
12314 12315 12316

    /* Return the desired value */
    return functionReturn;
12317 12318 12319 12320 12321 12322
}


/*
 * "vol-name" command
 */
12323
static const vshCmdInfo info_vol_name[] = {
12324
    {"help", N_("returns the volume name for a given volume key or path")},
12325
    {"desc", ""},
12326 12327 12328
    {NULL, NULL}
};

12329
static const vshCmdOptDef opts_vol_name[] = {
12330
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
12331 12332 12333
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12334
static bool
12335
cmdVolName(vshControl *ctl, const vshCmd *cmd)
12336 12337 12338
{
    virStorageVolPtr vol;

12339
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12340
        return false;
12341

12342
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
12343
                                   VSH_BYUUID)))
E
Eric Blake 已提交
12344
        return false;
12345 12346 12347

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
12348
    return true;
12349 12350 12351
}


J
Justin Clift 已提交
12352 12353 12354 12355 12356 12357 12358 12359 12360 12361
/*
 * "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[] = {
12362
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
12363 12364 12365 12366
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12367
static bool
J
Justin Clift 已提交
12368 12369 12370 12371
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
12372
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
12373 12374

    /* Check the connection to libvirtd daemon is still working */
12375
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12376
        return false;
J
Justin Clift 已提交
12377 12378

    /* Use the supplied string to locate the volume */
12379
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", NULL, NULL,
J
Justin Clift 已提交
12380
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
12381
        return false;
J
Justin Clift 已提交
12382 12383 12384 12385 12386 12387 12388
    }

    /* 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 已提交
12389
        return false;
J
Justin Clift 已提交
12390 12391
    }

12392 12393 12394 12395 12396 12397 12398 12399 12400
    /* 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 已提交
12401 12402 12403 12404

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
12405
    return true;
J
Justin Clift 已提交
12406 12407
}

12408 12409 12410 12411

/*
 * "vol-key" command
 */
12412
static const vshCmdInfo info_vol_key[] = {
12413
    {"help", N_("returns the volume key for a given volume name or path")},
12414
    {"desc", ""},
12415 12416 12417
    {NULL, NULL}
};

12418
static const vshCmdOptDef opts_vol_key[] = {
12419
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
12420
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
12421 12422 12423
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12424
static bool
12425
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
12426 12427 12428
{
    virStorageVolPtr vol;

12429
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12430
        return false;
12431

12432
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
12433
        return false;
12434 12435 12436

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
12437
    return true;
12438 12439 12440 12441 12442 12443 12444
}



/*
 * "vol-path" command
 */
12445
static const vshCmdInfo info_vol_path[] = {
12446
    {"help", N_("returns the volume path for a given volume name or key")},
12447
    {"desc", ""},
12448 12449 12450
    {NULL, NULL}
};

12451
static const vshCmdOptDef opts_vol_path[] = {
12452
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
12453
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
12454 12455 12456
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12457
static bool
12458
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
12459 12460
{
    virStorageVolPtr vol;
12461
    char * StorageVolPath;
12462

12463
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12464
        return false;
12465

12466
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL))) {
E
Eric Blake 已提交
12467
        return false;
12468
    }
12469

12470 12471 12472 12473 12474 12475 12476
    if ((StorageVolPath = virStorageVolGetPath(vol)) == NULL) {
        virStorageVolFree(vol);
        return false;
    }

    vshPrint(ctl, "%s\n", StorageVolPath);
    VIR_FREE(StorageVolPath);
12477
    virStorageVolFree(vol);
E
Eric Blake 已提交
12478
    return true;
12479 12480 12481
}


12482 12483 12484 12485
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
12486 12487
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
12488 12489
    {NULL, NULL}
};
12490

12491
static const vshCmdOptDef opts_secret_define[] = {
12492
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
12493 12494
    {NULL, 0, 0, NULL}
};
12495

E
Eric Blake 已提交
12496
static bool
12497 12498
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
12499
    const char *from = NULL;
12500
    char *buffer;
12501
    virSecretPtr res;
12502
    char uuid[VIR_UUID_STRING_BUFLEN];
12503

12504
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12505
        return false;
12506

12507
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
12508
        return false;
12509 12510

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
12514
    VIR_FREE(buffer);
12515 12516

    if (res == NULL) {
12517
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
12518
        return false;
12519
    }
12520
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
12521
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
12522
        virSecretFree(res);
E
Eric Blake 已提交
12523
        return false;
12524 12525 12526
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
12527
    return true;
12528 12529 12530 12531 12532 12533
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
12534 12535
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
12536 12537 12538 12539
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
12540
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
12541 12542 12543
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12544
static bool
12545 12546 12547
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
12548
    bool ret = false;
12549 12550
    char *xml;

12551
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12552
        return false;
12553 12554 12555

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
12556
        return false;
12557 12558 12559 12560

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
12561
    vshPrint(ctl, "%s", xml);
12562
    VIR_FREE(xml);
E
Eric Blake 已提交
12563
    ret = true;
12564 12565 12566 12567 12568 12569 12570 12571 12572 12573

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
12574 12575
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
12576 12577 12578 12579
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
12580 12581
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
12582 12583 12584
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12585
static bool
12586 12587 12588 12589
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
12590
    const char *base64 = NULL;
12591
    char *value;
E
Eric Blake 已提交
12592 12593
    int res;
    bool ret = false;
12594

12595
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12596
        return false;
12597 12598 12599

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
12600
        return false;
12601

12602
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
12603 12604 12605
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
12606
        vshError(ctl, "%s", _("Invalid base64 data"));
12607 12608 12609
        goto cleanup;
    }
    if (value == NULL) {
12610
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
12611
        return false;
12612 12613 12614 12615
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
12616
    VIR_FREE(value);
12617 12618

    if (res != 0) {
12619
        vshError(ctl, "%s", _("Failed to set secret value"));
12620 12621 12622
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
12623
    ret = true;
12624 12625 12626 12627 12628 12629 12630 12631 12632 12633

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
12634 12635
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
12636 12637 12638 12639
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
12640
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
12641 12642 12643
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12644
static bool
12645 12646 12647 12648 12649 12650
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
12651
    bool ret = false;
12652

12653
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12654
        return false;
12655 12656 12657

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
12658
        return false;
12659 12660 12661 12662 12663 12664 12665

    value = virSecretGetValue(secret, &value_size, 0);
    if (value == NULL)
        goto cleanup;

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
12666
    VIR_FREE(value);
12667 12668

    if (base64 == NULL) {
12669
        vshError(ctl, "%s", _("Failed to allocate memory"));
12670 12671
        goto cleanup;
    }
12672
    vshPrint(ctl, "%s", base64);
12673
    memset(base64, 0, strlen(base64));
12674
    VIR_FREE(base64);
E
Eric Blake 已提交
12675
    ret = true;
12676 12677 12678 12679 12680 12681 12682 12683 12684 12685

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
12686 12687
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
12688 12689 12690 12691
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
12692
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
12693 12694 12695
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
12696
static bool
12697 12698 12699
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
12700
    bool ret = false;
12701
    const char *uuid;
12702

12703
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12704
        return false;
12705 12706 12707

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
12708
        return false;
12709 12710

    if (virSecretUndefine(secret) < 0) {
12711
        vshError(ctl, _("Failed to delete secret %s"), uuid);
12712 12713 12714
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
12715
    ret = true;
12716 12717 12718 12719 12720 12721 12722 12723 12724 12725

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
12726 12727
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
12728 12729 12730
    {NULL, NULL}
};

E
Eric Blake 已提交
12731
static bool
12732 12733 12734 12735 12736
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

12737
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12738
        return false;
12739 12740 12741

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
12742
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
12743
        return false;
12744 12745 12746 12747 12748
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
12749
        vshError(ctl, "%s", _("Failed to list secrets"));
12750
        VIR_FREE(uuids);
E
Eric Blake 已提交
12751
        return false;
12752 12753 12754 12755
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

12756 12757
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
12758 12759

    for (i = 0; i < maxuuids; i++) {
12760 12761 12762 12763
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
12764
            VIR_FREE(uuids[i]);
12765 12766 12767 12768 12769 12770 12771 12772 12773 12774 12775 12776 12777 12778 12779 12780 12781 12782
            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);
12783
        VIR_FREE(uuids[i]);
12784
    }
12785
    VIR_FREE(uuids);
E
Eric Blake 已提交
12786
    return true;
12787
}
12788 12789 12790 12791 12792


/*
 * "version" command
 */
12793
static const vshCmdInfo info_version[] = {
12794 12795
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
12796 12797 12798
    {NULL, NULL}
};

12799 12800 12801 12802
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
12803

E
Eric Blake 已提交
12804
static bool
12805
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
12806 12807 12808 12809 12810 12811
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
12812
    unsigned long daemonVersion;
12813 12814 12815 12816 12817
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

12818
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12819
        return false;
12820 12821 12822

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
12823
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
12824
        return false;
12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836
    }

    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) {
12837
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
12838
        return false;
12839 12840 12841 12842 12843 12844 12845 12846 12847 12848 12849 12850 12851 12852 12853 12854 12855
    }
    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) {
12856
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
12857
        return false;
12858 12859 12860 12861 12862 12863 12864 12865 12866 12867 12868 12869 12870
    }
    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);
    }
12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885

    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 已提交
12886
    return true;
12887 12888
}

12889 12890 12891 12892
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
12893
    {"help", N_("enumerate devices on this host")},
12894
    {"desc", ""},
12895 12896 12897 12898
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
12899 12900
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
12901 12902 12903
    {NULL, 0, 0, NULL}
};

12904 12905 12906 12907 12908 12909 12910 12911 12912 12913 12914 12915 12916 12917 12918 12919 12920 12921 12922 12923 12924 12925
#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] = '-';
12926 12927
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
12928 12929 12930
    }

    /* Print this device */
12931
    vshPrint(ctl, "%s", indentBuf);
12932 12933 12934 12935 12936 12937 12938 12939 12940 12941 12942 12943 12944 12945 12946 12947 12948 12949 12950 12951 12952 12953 12954
    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) {
12955
        vshPrint(ctl, "%s", indentBuf);
12956
        vshPrint(ctl, " |\n");
12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978
    }

    /* 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) {
12979
        vshPrint(ctl, "%s", indentBuf);
12980 12981 12982 12983
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
12984
static bool
12985 12986
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
12987
    const char *cap = NULL;
12988
    char **devices;
12989
    int num_devices, i;
12990
    int tree = vshCommandOptBool(cmd, "tree");
12991

12992
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
12993
        return false;
12994

12995
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
12996 12997 12998 12999
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
13000
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
13001
        return false;
13002
    } else if (num_devices == 0) {
E
Eric Blake 已提交
13003
        return true;
13004 13005 13006 13007 13008 13009
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
13010
        vshError(ctl, "%s", _("Failed to list node devices"));
13011
        VIR_FREE(devices);
E
Eric Blake 已提交
13012
        return false;
13013
    }
13014
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
13015 13016 13017 13018 13019 13020 13021
    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 已提交
13022
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
13023 13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041
            } 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++) {
13042 13043
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
13044
        }
13045
        VIR_FREE(parents);
13046 13047 13048
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
13049
            VIR_FREE(devices[i]);
13050
        }
13051
    }
13052
    VIR_FREE(devices);
E
Eric Blake 已提交
13053
    return true;
13054 13055 13056 13057 13058 13059
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
13060 13061
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
13062 13063 13064 13065 13066
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
13067
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
13068 13069 13070
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13071
static bool
13072 13073
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
13074
    const char *name = NULL;
13075
    virNodeDevicePtr device;
L
Laine Stump 已提交
13076
    char *xml;
13077

13078
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13079
        return false;
13080
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
13081
        return false;
13082
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
13083
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
13084
        return false;
13085 13086
    }

L
Laine Stump 已提交
13087 13088 13089
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
13090
        return false;
L
Laine Stump 已提交
13091 13092 13093
    }

    vshPrint(ctl, "%s\n", xml);
13094
    VIR_FREE(xml);
13095
    virNodeDeviceFree(device);
E
Eric Blake 已提交
13096
    return true;
13097 13098
}

13099
/*
13100
 * "nodedev-detach" command
13101
 */
13102 13103 13104
static const vshCmdInfo info_node_device_detach[] = {
    {"help", N_("detach node device from its device driver")},
    {"desc", N_("Detach node device from its device driver before assigning to a domain.")},
13105 13106 13107 13108
    {NULL, NULL}
};


13109
static const vshCmdOptDef opts_node_device_detach[] = {
13110
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
13111 13112 13113
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13114
static bool
13115
cmdNodeDeviceDetach (vshControl *ctl, const vshCmd *cmd)
13116
{
13117
    const char *name = NULL;
13118
    virNodeDevicePtr device;
E
Eric Blake 已提交
13119
    bool ret = true;
13120

13121
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13122
        return false;
13123
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
13124
        return false;
13125
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
13126
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
13127
        return false;
13128 13129
    }

13130 13131
    /* Yes, our public API is misspelled.  At least virsh can accept
     * either spelling.  */
13132
    if (virNodeDeviceDettach(device) == 0) {
13133
        vshPrint(ctl, _("Device %s detached\n"), name);
13134
    } else {
13135
        vshError(ctl, _("Failed to detach device %s"), name);
E
Eric Blake 已提交
13136
        ret = false;
13137 13138 13139 13140 13141 13142 13143 13144 13145
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
13146 13147
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
13148 13149 13150 13151 13152
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
13153
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
13154 13155 13156
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13157
static bool
13158 13159
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
13160
    const char *name = NULL;
13161
    virNodeDevicePtr device;
E
Eric Blake 已提交
13162
    bool ret = true;
13163

13164
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13165
        return false;
13166
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
13167
        return false;
13168
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
13169
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
13170
        return false;
13171 13172 13173 13174 13175
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
13176
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
13177
        ret = false;
13178 13179 13180 13181 13182 13183 13184 13185 13186
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
13187 13188
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
13189 13190 13191 13192 13193
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
13194
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
13195 13196 13197
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13198
static bool
13199 13200
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
13201
    const char *name = NULL;
13202
    virNodeDevicePtr device;
E
Eric Blake 已提交
13203
    bool ret = true;
13204

13205
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13206
        return false;
13207
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
13208
        return false;
13209
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
13210
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
13211
        return false;
13212 13213 13214 13215 13216
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
13217
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
13218
        ret = false;
13219 13220 13221 13222 13223
    }
    virNodeDeviceFree(device);
    return ret;
}

13224
/*
E
Eric Blake 已提交
13225
 * "hostname" command
13226
 */
13227
static const vshCmdInfo info_hostname[] = {
13228
    {"help", N_("print the hypervisor hostname")},
13229
    {"desc", ""},
13230 13231 13232
    {NULL, NULL}
};

E
Eric Blake 已提交
13233
static bool
13234
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
13235 13236 13237
{
    char *hostname;

13238
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13239
        return false;
13240 13241 13242

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
13243
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
13244
        return false;
13245 13246 13247
    }

    vshPrint (ctl, "%s\n", hostname);
13248
    VIR_FREE(hostname);
13249

E
Eric Blake 已提交
13250
    return true;
13251 13252 13253 13254 13255
}

/*
 * "uri" command
 */
13256
static const vshCmdInfo info_uri[] = {
13257
    {"help", N_("print the hypervisor canonical URI")},
13258
    {"desc", ""},
13259 13260 13261
    {NULL, NULL}
};

E
Eric Blake 已提交
13262
static bool
13263
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
13264 13265 13266
{
    char *uri;

13267
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13268
        return false;
13269 13270 13271

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
13272
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
13273
        return false;
13274 13275 13276
    }

    vshPrint (ctl, "%s\n", uri);
13277
    VIR_FREE(uri);
13278

E
Eric Blake 已提交
13279
    return true;
13280 13281
}

E
Eric Blake 已提交
13282 13283 13284 13285 13286 13287 13288 13289 13290 13291
/*
 * "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 已提交
13292
static bool
E
Eric Blake 已提交
13293 13294 13295 13296 13297
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13298
        return false;
E
Eric Blake 已提交
13299 13300 13301 13302

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
13303
        return false;
E
Eric Blake 已提交
13304 13305 13306 13307 13308
    }

    vshPrint (ctl, "%s", sysinfo);
    VIR_FREE(sysinfo);

E
Eric Blake 已提交
13309
    return true;
E
Eric Blake 已提交
13310 13311
}

13312 13313 13314
/*
 * "vncdisplay" command
 */
13315
static const vshCmdInfo info_vncdisplay[] = {
13316 13317
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
13318 13319 13320
    {NULL, NULL}
};

13321
static const vshCmdOptDef opts_vncdisplay[] = {
13322
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
13323 13324 13325
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13326
static bool
13327
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
13328 13329 13330 13331 13332
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
13333
    bool ret = false;
13334 13335 13336
    int port = 0;
    char *doc;

13337
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13338
        return false;
13339

J
Jim Meyering 已提交
13340
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
13341
        return false;
13342 13343 13344 13345 13346

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

13347
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
13348
    VIR_FREE(doc);
13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363
    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) ||
13364
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
13365 13366 13367 13368 13369 13370
        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 已提交
13371
    ret = true;
13372 13373 13374 13375

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
13376
    xmlFreeDoc(xml);
13377 13378 13379 13380 13381 13382 13383
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
13384
static const vshCmdInfo info_ttyconsole[] = {
13385 13386
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
13387 13388 13389
    {NULL, NULL}
};

13390
static const vshCmdOptDef opts_ttyconsole[] = {
13391
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
13392 13393 13394
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13395
static bool
13396
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
13397 13398 13399 13400 13401
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
13402
    bool ret = false;
13403 13404
    char *doc;

13405
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13406
        return false;
13407

J
Jim Meyering 已提交
13408
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
13409
        return false;
13410 13411 13412 13413 13414

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

13415
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
13416
    VIR_FREE(doc);
13417 13418 13419 13420 13421 13422 13423 13424 13425
    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 已提交
13426
    ret = true;
13427 13428 13429 13430

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
13431
    xmlFreeDoc(xml);
13432 13433 13434 13435 13436 13437
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
13438
 */
13439
static const vshCmdInfo info_attach_device[] = {
13440 13441
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
13442 13443 13444
    {NULL, NULL}
};

13445
static const vshCmdOptDef opts_attach_device[] = {
13446 13447 13448
    {"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")},
13449 13450 13451
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13452
static bool
13453
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
13454 13455
{
    virDomainPtr dom;
13456
    const char *from = NULL;
13457
    char *buffer;
W
Wen Congyang 已提交
13458
    int ret;
J
Jim Fehlig 已提交
13459
    unsigned int flags;
13460

13461
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13462
        return false;
13463

J
Jim Meyering 已提交
13464
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
13465
        return false;
13466

13467
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
13468
        virDomainFree(dom);
E
Eric Blake 已提交
13469
        return false;
13470 13471
    }

13472
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
13473
        virshReportError(ctl);
13474
        virDomainFree(dom);
E
Eric Blake 已提交
13475
        return false;
13476
    }
13477

J
Jim Fehlig 已提交
13478
    if (vshCommandOptBool(cmd, "persistent")) {
13479
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
13480
        if (virDomainIsActive(dom) == 1)
13481
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
13482 13483 13484 13485
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
13486
    VIR_FREE(buffer);
13487 13488

    if (ret < 0) {
13489
        vshError(ctl, _("Failed to attach device from %s"), from);
13490
        virDomainFree(dom);
E
Eric Blake 已提交
13491
        return false;
13492
    } else {
J
Jim Meyering 已提交
13493
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
13494 13495 13496
    }

    virDomainFree(dom);
E
Eric Blake 已提交
13497
    return true;
13498 13499
}

13500 13501 13502 13503 13504 13505 13506
/**
 * 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.
 */
13507
ATTRIBUTE_UNUSED
13508 13509 13510 13511 13512 13513 13514 13515 13516
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 已提交
13517
    long n1_child_size, n2_child_size, n1_iter;
13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 13540 13541 13542 13543 13544 13545
    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 已提交
13546 13547 13548 13549
    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)
13550 13551
        return false;

13552 13553 13554
    if (n1_child_size == 0 && n2_child_size == 0)
        return true;

13555 13556 13557 13558 13559 13560 13561 13562 13563 13564 13565 13566 13567 13568 13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 13605 13606 13607 13608 13609 13610 13611 13612 13613 13614 13615 13616 13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630 13631 13632
    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.
 */
13633
ATTRIBUTE_UNUSED
13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 13669 13670 13671 13672 13673 13674 13675 13676 13677 13678 13679 13680 13681 13682 13683 13684 13685 13686 13687 13688 13689 13690 13691 13692 13693 13694 13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712 13713 13714 13715 13716 13717 13718 13719 13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745
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;
}
13746 13747 13748 13749

/*
 * "detach-device" command
 */
13750
static const vshCmdInfo info_detach_device[] = {
13751 13752
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
13753 13754 13755
    {NULL, NULL}
};

13756
static const vshCmdOptDef opts_detach_device[] = {
13757 13758 13759
    {"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")},
13760 13761 13762
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13763
static bool
13764
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
13765
{
13766
    virDomainPtr dom = NULL;
13767
    const char *from = NULL;
13768
    char *buffer = NULL;
W
Wen Congyang 已提交
13769
    int ret;
13770
    bool funcRet = false;
J
Jim Fehlig 已提交
13771
    unsigned int flags;
13772

13773
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13774
        return false;
13775

J
Jim Meyering 已提交
13776
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
13777
        return false;
13778

13779 13780
    if (vshCommandOptString(cmd, "file", &from) <= 0)
        goto cleanup;
13781

13782
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
13783
        virshReportError(ctl);
13784 13785 13786
        goto cleanup;
    }

J
Jim Fehlig 已提交
13787
    if (vshCommandOptBool(cmd, "persistent")) {
13788
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
13789
        if (virDomainIsActive(dom) == 1)
13790
           flags |= VIR_DOMAIN_AFFECT_LIVE;
13791
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
J
Jim Fehlig 已提交
13792
    } else {
13793
        ret = virDomainDetachDevice(dom, buffer);
J
Jim Fehlig 已提交
13794
    }
13795 13796

    if (ret < 0) {
13797
        vshError(ctl, _("Failed to detach device from %s"), from);
13798
        goto cleanup;
13799 13800
    }

13801 13802 13803 13804 13805
    vshPrint(ctl, "%s", _("Device detached successfully\n"));
    funcRet = true;

cleanup:
    VIR_FREE(buffer);
13806
    virDomainFree(dom);
13807
    return funcRet;
13808 13809
}

13810

13811 13812 13813 13814 13815 13816 13817 13818 13819 13820 13821 13822 13823
/*
 * "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")},
13824
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
13825 13826 13827
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
13828
static bool
13829 13830 13831
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
13832
    const char *from = NULL;
13833
    char *buffer;
W
Wen Congyang 已提交
13834
    int ret;
13835 13836
    unsigned int flags;

13837
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
13838
        return false;
13839 13840

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

13843
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
13844
        virDomainFree(dom);
E
Eric Blake 已提交
13845
        return false;
13846 13847 13848
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
13849
        virshReportError(ctl);
13850
        virDomainFree(dom);
E
Eric Blake 已提交
13851
        return false;
13852 13853 13854
    }

    if (vshCommandOptBool(cmd, "persistent")) {
13855
        flags = VIR_DOMAIN_AFFECT_CONFIG;
13856
        if (virDomainIsActive(dom) == 1)
13857
           flags |= VIR_DOMAIN_AFFECT_LIVE;
13858
    } else {
13859
        flags = VIR_DOMAIN_AFFECT_LIVE;
13860
    }
13861 13862 13863 13864

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

13865 13866 13867 13868 13869 13870
    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 已提交
13871
        return false;
13872 13873 13874 13875 13876
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
13877
    return true;
13878 13879 13880
}


13881 13882 13883
/*
 * "attach-interface" command
 */
13884
static const vshCmdInfo info_attach_interface[] = {
13885 13886
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
13887 13888 13889
    {NULL, NULL}
};

13890
static const vshCmdOptDef opts_attach_interface[] = {
13891 13892 13893 13894 13895 13896
    {"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")},
13897
    {"model", VSH_OT_DATA, 0, N_("model type")},
13898
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
13899 13900
    {"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")},
13901 13902 13903
    {NULL, 0, 0, NULL}
};

13904 13905 13906
/* 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. */
13907
static int parseRateStr(const char *rateStr, virNetDevBandwidthRatePtr rate)
13908 13909 13910 13911 13912 13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938
{
    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 已提交
13939
static bool
13940
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
13941 13942
{
    virDomainPtr dom = NULL;
13943
    const char *mac = NULL, *target = NULL, *script = NULL,
13944 13945
                *type = NULL, *source = NULL, *model = NULL,
                *inboundStr = NULL, *outboundStr = NULL;
13946
    virNetDevBandwidthRate inbound, outbound;
E
Eric Blake 已提交
13947
    int typ;
W
Wen Congyang 已提交
13948 13949
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
13950
    unsigned int flags;
13951 13952
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
13953

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

J
Jim Meyering 已提交
13957
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
13958 13959
        goto cleanup;

13960
    if (vshCommandOptString(cmd, "type", &type) <= 0)
13961 13962
        goto cleanup;

13963 13964 13965 13966
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
13967 13968 13969
        vshCommandOptString(cmd, "model", &model) < 0 ||
        vshCommandOptString(cmd, "inbound", &inboundStr) < 0 ||
        vshCommandOptString(cmd, "outbound", &outboundStr) < 0) {
13970
        vshError(ctl, "missing argument");
13971
        goto cleanup;
13972
    }
13973 13974

    /* check interface type */
13975
    if (STREQ(type, "network")) {
13976
        typ = 1;
13977
    } else if (STREQ(type, "bridge")) {
13978 13979
        typ = 2;
    } else {
E
Eric Blake 已提交
13980 13981
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
13982 13983 13984
        goto cleanup;
    }

13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997 13998 13999 14000 14001 14002 14003 14004 14005 14006 14007
    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;
        }
    }

14008
    /* Make XML of interface */
14009
    virBufferAsprintf(&buf, "<interface type='%s'>\n", type);
14010

14011
    if (typ == 1)
14012
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
14013
    else if (typ == 2)
14014
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
14015

14016
    if (target != NULL)
14017
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
14018
    if (mac != NULL)
14019
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
14020
    if (script != NULL)
14021
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
14022
    if (model != NULL)
14023
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
14024

14025 14026 14027 14028 14029 14030 14031 14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045
    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");
    }

14046
    virBufferAddLit(&buf, "</interface>\n");
14047

14048 14049
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
14050
        goto cleanup;
14051 14052
    }

14053
    xml = virBufferContentAndReset(&buf);
14054

J
Jim Fehlig 已提交
14055
    if (vshCommandOptBool(cmd, "persistent")) {
14056
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
14057
        if (virDomainIsActive(dom) == 1)
14058
            flags |= VIR_DOMAIN_AFFECT_LIVE;
14059
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
14060
    } else {
14061
        ret = virDomainAttachDevice(dom, xml);
14062
    }
14063

14064 14065
    VIR_FREE(xml);

J
Jim Fehlig 已提交
14066
    if (ret != 0) {
L
Laine Stump 已提交
14067
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
14068 14069
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
14070
        functionReturn = true;
J
Jim Fehlig 已提交
14071
    }
14072 14073 14074 14075

 cleanup:
    if (dom)
        virDomainFree(dom);
14076
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
14077
    return functionReturn;
14078 14079 14080 14081 14082
}

/*
 * "detach-interface" command
 */
14083
static const vshCmdInfo info_detach_interface[] = {
14084 14085
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
14086 14087 14088
    {NULL, NULL}
};

14089
static const vshCmdOptDef opts_detach_interface[] = {
14090 14091 14092 14093
    {"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")},
14094 14095 14096
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14097
static bool
14098
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
14099 14100 14101 14102 14103 14104 14105
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
14106
    const char *mac =NULL, *type = NULL;
14107
    char *doc;
14108
    char buf[64];
E
Eric Blake 已提交
14109
    int i = 0, diff_mac;
W
Wen Congyang 已提交
14110 14111
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
14112
    unsigned int flags;
14113

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

J
Jim Meyering 已提交
14117
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
14118 14119
        goto cleanup;

14120
    if (vshCommandOptString(cmd, "type", &type) <= 0)
14121 14122
        goto cleanup;

14123 14124
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
14125
        goto cleanup;
14126
    }
14127 14128 14129 14130 14131

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

14132
    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
14133
    VIR_FREE(doc);
14134
    if (!xml) {
14135
        vshError(ctl, "%s", _("Failed to get interface information"));
14136 14137 14138
        goto cleanup;
    }

E
Eric Blake 已提交
14139
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
14140 14141 14142
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
14143
        vshError(ctl, _("No found interface whose type is %s"), type);
14144 14145 14146
        goto cleanup;
    }

14147 14148 14149 14150 14151 14152
    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;
    }

14153 14154 14155 14156 14157 14158 14159
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
14160 14161 14162
            if (cur->type == XML_ELEMENT_NODE &&
                xmlStrEqual(cur->name, BAD_CAST "mac")) {
                char *tmp_mac = virXMLPropString(cur, "address");
14163
                diff_mac = virMacAddrCompare(tmp_mac, mac);
14164
                VIR_FREE(tmp_mac);
14165 14166 14167 14168 14169 14170 14171
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
14172
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
14173 14174 14175 14176 14177
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
14178
        vshError(ctl, "%s", _("Failed to allocate memory"));
14179 14180 14181
        goto cleanup;
    }

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

J
Jim Fehlig 已提交
14187
    if (vshCommandOptBool(cmd, "persistent")) {
14188
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
14189
        if (virDomainIsActive(dom) == 1)
14190
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
14191 14192 14193 14194 14195 14196 14197 14198
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
14199
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
14200
    } else {
J
Jim Meyering 已提交
14201
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
14202
        functionReturn = true;
14203
    }
14204 14205 14206 14207

 cleanup:
    if (dom)
        virDomainFree(dom);
14208
    xmlXPathFreeObject(obj);
14209
    xmlXPathFreeContext(ctxt);
14210 14211
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
14212
    return functionReturn;
14213 14214 14215 14216 14217
}

/*
 * "attach-disk" command
 */
14218
static const vshCmdInfo info_attach_disk[] = {
14219 14220
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
14221 14222 14223
    {NULL, NULL}
};

14224
static const vshCmdOptDef opts_attach_disk[] = {
14225
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
14226 14227
    {"source",  VSH_OT_DATA, VSH_OFLAG_REQ | VSH_OFLAG_EMPTY_OK,
     N_("source of disk device")},
14228 14229 14230
    {"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")},
14231
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
14232 14233 14234
    {"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")},
14235
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
14236 14237
    {"serial", VSH_OT_STRING, 0, N_("serial of disk device")},
    {"shareable", VSH_OT_BOOL, 0, N_("shareable between domains")},
14238
    {"rawio", VSH_OT_BOOL, 0, N_("needs rawio capability")},
14239
    {"address", VSH_OT_STRING, 0, N_("address of disk device")},
14240 14241
    {"multifunction", VSH_OT_BOOL, 0,
     N_("use multifunction pci under specified address")},
14242 14243 14244
    {NULL, 0, 0, NULL}
};

14245 14246 14247 14248 14249 14250 14251 14252 14253 14254 14255 14256 14257 14258 14259 14260 14261 14262 14263 14264 14265 14266 14267 14268 14269 14270 14271 14272 14273 14274 14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329 14330 14331 14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 14382 14383 14384 14385 14386 14387 14388 14389 14390 14391
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 已提交
14392
static bool
14393
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
14394 14395
{
    virDomainPtr dom = NULL;
14396
    const char *source = NULL, *target = NULL, *driver = NULL,
14397 14398 14399
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
14400 14401
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
14402
    unsigned int flags;
14403
    const char *stype = NULL;
14404 14405
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
14406

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

J
Jim Meyering 已提交
14410
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
14411 14412
        goto cleanup;

14413
    if (vshCommandOptString(cmd, "source", &source) <= 0)
14414
        goto cleanup;
14415 14416 14417 14418
    /* Allow empty string as a placeholder that implies no source, for
     * use in adding a cdrom drive with no disk.  */
    if (!*source)
        source = NULL;
14419

14420
    if (vshCommandOptString(cmd, "target", &target) <= 0)
14421 14422
        goto cleanup;

14423 14424 14425 14426
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
14427 14428 14429
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
14430
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
14431
        vshError(ctl, "%s", _("missing option"));
14432 14433
        goto cleanup;
    }
14434

14435 14436
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
14437
            isFile = true;
14438
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
14439
        isFile = true;
14440 14441 14442
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
14443 14444 14445
    }

    if (mode) {
14446
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
14447 14448
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
14449 14450 14451 14452 14453
            goto cleanup;
        }
    }

    /* Make XML of disk */
14454
    virBufferAsprintf(&buf, "<disk type='%s'",
14455 14456
                      (isFile) ? "file" : "block");
    if (type)
14457
        virBufferAsprintf(&buf, " device='%s'", type);
14458 14459
    if (vshCommandOptBool (cmd, "rawio"))
        virBufferAddLit(&buf, " rawio='yes'");
14460 14461
    virBufferAddLit(&buf, ">\n");

14462
    if (driver || subdriver)
14463
        virBufferAsprintf(&buf, "  <driver");
14464 14465

    if (driver)
14466
        virBufferAsprintf(&buf, " name='%s'", driver);
14467
    if (subdriver)
14468
        virBufferAsprintf(&buf, " type='%s'", subdriver);
14469 14470
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
14471

14472
    if (driver || subdriver || cache)
14473
        virBufferAddLit(&buf, "/>\n");
14474

14475 14476 14477 14478
    if (source)
        virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
                          (isFile) ? "file" : "dev",
                          source);
14479
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
14480
    if (mode)
14481
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
14482

14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498
    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'"
14499
                                  " bus ='0x%02x' slot='0x%02x' function='0x%0x'",
14500 14501
                                  diskAddr.addr.pci.domain, diskAddr.addr.pci.bus,
                                  diskAddr.addr.pci.slot, diskAddr.addr.pci.function);
14502 14503 14504
                if (vshCommandOptBool(cmd, "multifunction"))
                    virBufferAddLit(&buf, " multifunction='on'");
                virBufferAddLit(&buf, "/>\n");
14505 14506 14507 14508 14509 14510 14511 14512 14513 14514 14515 14516 14517 14518 14519 14520 14521 14522 14523 14524 14525 14526 14527 14528 14529 14530 14531 14532 14533
            } 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;
            }
        }
    }

14534
    virBufferAddLit(&buf, "</disk>\n");
14535

14536 14537
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
14538
        return false;
14539 14540
    }

14541
    xml = virBufferContentAndReset(&buf);
14542

J
Jim Fehlig 已提交
14543
    if (vshCommandOptBool(cmd, "persistent")) {
14544
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
14545
        if (virDomainIsActive(dom) == 1)
14546
            flags |= VIR_DOMAIN_AFFECT_LIVE;
14547
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
14548
    } else {
14549
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
14550
    }
14551

14552 14553
    VIR_FREE(xml);

J
Jim Fehlig 已提交
14554
    if (ret != 0) {
L
Laine Stump 已提交
14555
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
14556 14557
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
14558
        functionReturn = true;
J
Jim Fehlig 已提交
14559
    }
14560 14561 14562 14563

 cleanup:
    if (dom)
        virDomainFree(dom);
14564
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
14565
    return functionReturn;
14566 14567
}

14568 14569 14570 14571 14572 14573 14574 14575 14576 14577 14578 14579 14580 14581 14582 14583 14584 14585 14586 14587 14588 14589 14590 14591 14592 14593 14594 14595 14596 14597 14598 14599 14600 14601 14602 14603 14604 14605 14606 14607 14608 14609 14610 14611 14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 14652 14653 14654 14655 14656 14657 14658 14659 14660 14661 14662 14663 14664 14665 14666 14667 14668 14669 14670 14671 14672 14673 14674 14675 14676 14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 14716 14717 14718 14719 14720 14721 14722 14723 14724 14725 14726 14727 14728 14729 14730 14731 14732 14733 14734 14735 14736 14737 14738 14739 14740 14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765 14766 14767 14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 14780
typedef enum {
    VSH_FIND_DISK_NORMAL,
    VSH_FIND_DISK_CHANGEABLE,
} vshFindDiskType;

/* Helper function to find disk device in XML doc.  Returns the disk
 * node on success, or NULL on failure. Caller must free the result
 * @path: Fully-qualified path or target of disk device.
 * @type: Either VSH_FIND_DISK_NORMAL or VSH_FIND_DISK_CHANGEABLE.
 */
static xmlNodePtr
vshFindDisk(const char *doc,
            const char *path,
            int type)
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj= NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlNodePtr ret = NULL;
    int i = 0;

    xml = virXMLParseStringCtxt(doc, _("(domain_definition)"), &ctxt);
    if (!xml) {
        vshError(NULL, "%s", _("Failed to get disk information"));
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) ||
        (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) ||
        (obj->nodesetval->nodeNr == 0)) {
        vshError(NULL, "%s", _("Failed to get disk information"));
        goto cleanup;
    }

    /* search disk using @path */
    for (; i < obj->nodesetval->nodeNr; i++) {
        bool is_supported = true;

        if (type == VSH_FIND_DISK_CHANGEABLE) {
            xmlNodePtr n = obj->nodesetval->nodeTab[i];
            is_supported = false;

            /* Check if the disk is CDROM or floppy disk */
            if (xmlStrEqual(n->name, BAD_CAST "disk")) {
                char *device_value = virXMLPropString(n, "device");

                if (STREQ(device_value, "cdrom") ||
                    STREQ(device_value, "floppy"))
                    is_supported = true;

                VIR_FREE(device_value);
            }

            if (!is_supported)
                continue;
        }

        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
            if (cur->type == XML_ELEMENT_NODE) {
                char *tmp = NULL;

                if (xmlStrEqual(cur->name, BAD_CAST "source")) {
                    if ((tmp = virXMLPropString(cur, "file")) ||
                        (tmp = virXMLPropString(cur, "dev")) ||
                        (tmp = virXMLPropString(cur, "dir")) ||
                        (tmp = virXMLPropString(cur, "name"))) {
                    }
                } else if (xmlStrEqual(cur->name, BAD_CAST "target")) {
                    tmp = virXMLPropString(cur, "dev");
                }

                if (STREQ_NULLABLE(tmp, path)) {
                    ret = xmlCopyNode(obj->nodesetval->nodeTab[i], 1);
                    VIR_FREE(tmp);
                    goto cleanup;
                }
                VIR_FREE(tmp);
            }
            cur = cur->next;
        }
    }

    vshError(NULL, _("No found disk whose source path or target is %s"), path);

cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);
    return ret;
}

typedef enum {
    VSH_PREPARE_DISK_XML_NONE = 0,
    VSH_PREPARE_DISK_XML_EJECT,
    VSH_PREPARE_DISK_XML_INSERT,
    VSH_PREPARE_DISK_XML_UPDATE,
} vshPrepareDiskXMLType;

/* Helper function to prepare disk XML. Could be used for disk
 * detaching, media changing(ejecting, inserting, updating)
 * for changeable disk. Returns the processed XML as string on
 * success, or NULL on failure. Caller must free the result.
 */
static char *
vshPrepareDiskXML(xmlNodePtr disk_node,
                  const char *source,
                  const char *path,
                  int type)
{
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    const char *disk_type = NULL;
    const char *device_type = NULL;
    xmlNodePtr new_node = NULL;
    char *ret = NULL;

    if (!disk_node)
        return NULL;

    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
        vshError(NULL, "%s", _("Failed to allocate memory"));
        return NULL;
    }

    device_type = virXMLPropString(disk_node, "device");

    if (STREQ_NULLABLE(device_type, "cdrom") ||
        STREQ_NULLABLE(device_type, "floppy")) {
        bool has_source = false;
        disk_type = virXMLPropString(disk_node, "type");

        cur = disk_node->children;
        while (cur != NULL) {
            if (cur->type == XML_ELEMENT_NODE &&
                xmlStrEqual(cur->name, BAD_CAST "source")) {
                has_source = true;
                break;
            }
            cur = cur->next;
        }

        if (!has_source) {
            if (type == VSH_PREPARE_DISK_XML_EJECT) {
                vshError(NULL, _("The disk device '%s' doesn't have media"),
                         path);
                goto error;
            }

            if (source) {
                new_node = xmlNewNode(NULL, BAD_CAST "source");
                xmlNewProp(new_node, (const xmlChar *)disk_type,
                           (const xmlChar *)source);
                xmlAddChild(disk_node, new_node);
            } else if (type == VSH_PREPARE_DISK_XML_INSERT) {
                vshError(NULL, _("No source is specified for inserting media"));
                goto error;
            } else if (type == VSH_PREPARE_DISK_XML_UPDATE) {
                vshError(NULL, _("No source is specified for updating media"));
                goto error;
            }
        }

        if (has_source) {
            if (type == VSH_PREPARE_DISK_XML_INSERT) {
                vshError(NULL, _("The disk device '%s' already has media"),
                         path);
                goto error;
            }

            /* Remove the source if it tends to eject/update media. */
            xmlUnlinkNode(cur);
            xmlFreeNode(cur);

            if (source && (type == VSH_PREPARE_DISK_XML_UPDATE)) {
                new_node = xmlNewNode(NULL, BAD_CAST "source");
                xmlNewProp(new_node, (const xmlChar *)disk_type,
                           (const xmlChar *)source);
                xmlAddChild(disk_node, new_node);
            }
        }
    }

    if (xmlNodeDump(xml_buf, NULL, disk_node, 0, 0) < 0) {
        vshError(NULL, "%s", _("Failed to create XML"));
        goto error;
    }

    goto cleanup;

cleanup:
    VIR_FREE(device_type);
    VIR_FREE(disk_type);
    if (xml_buf) {
        if (VIR_ALLOC_N(ret, xmlBufferLength(xml_buf)) < 0) {
            virReportOOMError();
            return NULL;
        }
        memcpy(ret, (char *)xmlBufferContent(xml_buf), xmlBufferLength(xml_buf));
        xmlBufferFree(xml_buf);
    }
    return ret;

error:
    xmlBufferFree(xml_buf);
    xml_buf = NULL;
    goto cleanup;
}

14781 14782 14783
/*
 * "detach-disk" command
 */
14784
static const vshCmdInfo info_detach_disk[] = {
14785 14786
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
14787 14788 14789
    {NULL, NULL}
};

14790
static const vshCmdOptDef opts_detach_disk[] = {
14791 14792 14793
    {"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")},
14794 14795 14796
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
14797
static bool
14798
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
14799
{
14800
    char *disk_xml = NULL;
14801
    virDomainPtr dom = NULL;
14802
    const char *target = NULL;
14803
    char *doc;
W
Wen Congyang 已提交
14804 14805
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
14806
    unsigned int flags;
14807
    xmlNodePtr disk_node = NULL;
14808

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

J
Jim Meyering 已提交
14812
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
14813 14814
        goto cleanup;

14815
    if (vshCommandOptString(cmd, "target", &target) <= 0)
14816 14817 14818 14819 14820 14821
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

14822
    if (!(disk_node = vshFindDisk(doc, target, VSH_FIND_DISK_NORMAL)))
14823 14824
        goto cleanup;

14825 14826
    if (!(disk_xml = vshPrepareDiskXML(disk_node, NULL, NULL,
                                       VSH_PREPARE_DISK_XML_NONE)))
14827 14828
        goto cleanup;

J
Jim Fehlig 已提交
14829
    if (vshCommandOptBool(cmd, "persistent")) {
14830
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
14831
        if (virDomainIsActive(dom) == 1)
14832
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
14833
        ret = virDomainDetachDeviceFlags(dom,
14834
                                         disk_xml,
J
Jim Fehlig 已提交
14835 14836
                                         flags);
    } else {
14837
        ret = virDomainDetachDevice(dom, disk_xml);
J
Jim Fehlig 已提交
14838 14839 14840
    }

    if (ret != 0) {
L
Laine Stump 已提交
14841
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
14842
    } else {
J
Jim Meyering 已提交
14843
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
14844
        functionReturn = true;
14845
    }
14846 14847

 cleanup:
14848 14849 14850
    xmlFreeNode(disk_node);
    VIR_FREE(disk_xml);
    VIR_FREE(doc);
14851 14852
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
14853
    return functionReturn;
14854 14855
}

O
Osier Yang 已提交
14856 14857 14858 14859 14860 14861 14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 14900 14901 14902 14903 14904 14905 14906 14907 14908 14909 14910 14911 14912 14913 14914 14915 14916 14917 14918 14919 14920 14921 14922 14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 14961 14962 14963 14964 14965 14966 14967 14968 14969 14970 14971 14972 14973 14974 14975 14976 14977 14978 14979 14980 14981 14982 14983 14984 14985 14986 14987 14988
/*
 * "change-media" command
 */
static const vshCmdInfo info_change_media[] = {
    {"help", N_("Change media of CD or floppy drive")},
    {"desc", N_("Change media of CD or floppy drive.")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_change_media[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"path", VSH_OT_DATA, VSH_OFLAG_REQ, N_("Fully-qualified path or "
                                            "target of disk device")},
    {"source", VSH_OT_DATA, 0, N_("source of the media")},
    {"eject", VSH_OT_BOOL, 0, N_("Eject the media")},
    {"insert", VSH_OT_BOOL, 0, N_("Insert the media")},
    {"update", VSH_OT_BOOL, 0, N_("Update the media")},
    {"current", VSH_OT_BOOL, 0, N_("can be either or both of --live and --config, "
                                   "depends on implementation of hypervisor driver")},
    {"live", VSH_OT_BOOL, 0, N_("alter live configuration of running domain")},
    {"config", VSH_OT_BOOL, 0, N_("alter persistent configuration, effect observed on next boot")},
    {"force",  VSH_OT_BOOL, 0, N_("force media insertion")},
    {NULL, 0, 0, NULL}
};

static bool
cmdChangeMedia(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    const char *source = NULL;
    const char *path = NULL;
    const char *doc = NULL;
    xmlNodePtr disk_node = NULL;
    const char *disk_xml = NULL;
    int flags = 0;
    bool config, live, current, force = false;
    bool eject, insert, update = false;
    bool ret = false;
    int prepare_type = 0;
    const char *action = NULL;

    config = vshCommandOptBool(cmd, "config");
    live = vshCommandOptBool(cmd, "live");
    current = vshCommandOptBool(cmd, "current");
    force = vshCommandOptBool(cmd, "force");
    eject = vshCommandOptBool(cmd, "eject");
    insert = vshCommandOptBool(cmd, "insert");
    update = vshCommandOptBool(cmd, "update");

    if (eject + insert + update > 1) {
        vshError(ctl, "%s", _("--eject, --insert, and --update must be specified "
                            "exclusively."));
        return false;
    }

    if (eject) {
        prepare_type = VSH_PREPARE_DISK_XML_EJECT;
        action = "eject";
    }

    if (insert) {
        prepare_type = VSH_PREPARE_DISK_XML_INSERT;
        action = "insert";
    }

    if (update || (!eject && !insert)) {
        prepare_type = VSH_PREPARE_DISK_XML_UPDATE;
        action = "update";
    }

    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 (force)
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

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

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

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

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

    if (insert && !source) {
        vshError(ctl, "%s", _("No disk source specified for inserting"));
        goto cleanup;
    }

    if (flags & VIR_DOMAIN_AFFECT_CONFIG)
        doc = virDomainGetXMLDesc(dom, VIR_DOMAIN_XML_INACTIVE);
    else
        doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    if (!(disk_node = vshFindDisk(doc, path, VSH_FIND_DISK_CHANGEABLE)))
        goto cleanup;

    if (!(disk_xml = vshPrepareDiskXML(disk_node, source, path, prepare_type)))
        goto cleanup;

    if (virDomainUpdateDeviceFlags(dom, disk_xml, flags) != 0) {
        vshError(ctl, _("Failed to complete action %s on media"), action);
        goto cleanup;
    }

    vshPrint(ctl, _("succeeded to complete action %s on media\n"), action);
    ret = true;

cleanup:
    VIR_FREE(doc);
    xmlFreeNode(disk_node);
    VIR_FREE(disk_xml);
    if (dom)
        virDomainFree(dom);
    return ret;
}

14989 14990 14991 14992
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
14993 14994
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
14995 14996 14997 14998
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
14999
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
15000 15001 15002
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
15003
static bool
15004 15005
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
15006
    const char *from = NULL;
15007
    bool ret = false;
15008 15009
    char *buffer;
    int result;
15010 15011 15012 15013 15014 15015
    const char *snippet;

    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlBufferPtr xml_buf = NULL;
    xmlNodePtr node;
15016

15017
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
15018
        return false;
15019

15020
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
15021
        return false;
15022

15023 15024 15025
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
        vshError(ctl, _("Failed to read file '%s' to compare"),
                 from);
E
Eric Blake 已提交
15026
        return false;
15027
    }
15028

15029 15030 15031 15032 15033 15034 15035 15036 15037 15038 15039 15040 15041 15042 15043 15044 15045 15046 15047 15048 15049 15050 15051 15052 15053
    /* 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);
15054 15055 15056 15057 15058

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
15059
        goto cleanup;
15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074
        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);
15075
        goto cleanup;
15076 15077
    }

15078 15079 15080 15081 15082 15083 15084 15085
    ret = true;

cleanup:
    VIR_FREE(buffer);
    xmlBufferFree(xml_buf);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xml);

15086 15087 15088
    return ret;
}

15089 15090 15091 15092
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
15093 15094
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
15095 15096 15097 15098
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
15099
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
15100 15101 15102
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
15103
static bool
15104 15105
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
15106
    const char *from = NULL;
15107
    bool ret = false;
15108 15109 15110
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
15111 15112 15113 15114
    int count = 0;

    xmlDocPtr xml = NULL;
    xmlNodePtr *node_list = NULL;
15115
    xmlXPathContextPtr ctxt = NULL;
15116 15117 15118
    xmlBufferPtr xml_buf = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    int i;
15119

15120
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
15121
        return false;
15122

15123
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
15124
        return false;
15125 15126

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

E
Eric Blake 已提交
15129
    /* add a separate container around the xml */
15130 15131
    virBufferStrcat(&buf, "<container>", buffer, "</container>", NULL);
    if (virBufferError(&buf))
15132 15133
        goto no_memory;

15134 15135 15136 15137 15138 15139 15140 15141 15142 15143 15144 15145 15146
    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);
15147 15148 15149
        goto cleanup;
    }

15150
    list = vshCalloc(ctl, count, sizeof(const char *));
15151

15152
    if (!(xml_buf = xmlBufferCreate()))
15153 15154
        goto no_memory;

15155 15156
    for (i = 0; i < count; i++) {
        xmlBufferEmpty(xml_buf);
15157

15158 15159 15160
        if (xmlNodeDump(xml_buf, xml,  node_list[i], 0, 0) < 0) {
            vshError(ctl, _("Failed to extract <cpu> element"));
            goto cleanup;
15161 15162
        }

15163
        list[i] = vshStrdup(ctl, (const char *)xmlBufferContent(xml_buf));
15164 15165 15166 15167
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

15168
    if (result) {
15169
        vshPrint(ctl, "%s", result);
15170 15171
        ret = true;
    }
15172 15173 15174

cleanup:
    xmlXPathFreeContext(ctxt);
15175 15176
    xmlFreeDoc(xml);
    xmlBufferFree(xml_buf);
15177 15178
    VIR_FREE(result);
    if ((list != NULL) && (count > 0)) {
15179
        for (i = 0; i < count; i++)
15180 15181 15182 15183 15184 15185 15186 15187 15188
            VIR_FREE(list[i]);
    }
    VIR_FREE(list);
    VIR_FREE(buffer);

    return ret;

no_memory:
    vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
15189
    ret = false;
15190
    goto cleanup;
15191 15192
}

15193 15194 15195 15196 15197 15198 15199 15200
/* 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;

15201
    ret = vshMalloc(ctl, PATH_MAX);
15202 15203 15204

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
15205 15206
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
15207
    if (fd == -1) {
15208
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
15209
                 strerror(errno));
15210
        VIR_FREE(ret);
15211 15212 15213 15214
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
15215 15216
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
15217
        VIR_FORCE_CLOSE(fd);
15218
        unlink (ret);
15219
        VIR_FREE(ret);
15220 15221
        return NULL;
    }
S
Stefan Berger 已提交
15222
    if (VIR_CLOSE(fd) < 0) {
15223 15224
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
15225
        unlink (ret);
15226
        VIR_FREE(ret);
15227 15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239 15240 15241
        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 已提交
15242 15243 15244 15245
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
15246

15247
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
15248 15249 15250 15251
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
15252

15253 15254 15255 15256 15257
    /* 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 已提交
15258 15259
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
15260
     */
E
Eric Blake 已提交
15261 15262 15263 15264 15265 15266 15267 15268 15269 15270 15271 15272
    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);
15273 15274
    }

E
Eric Blake 已提交
15275 15276 15277 15278 15279 15280 15281
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
15282
    }
E
Eric Blake 已提交
15283
    ret = 0;
15284

E
Eric Blake 已提交
15285 15286 15287
cleanup:
    virCommandFree(cmd);
    return ret;
15288 15289 15290 15291 15292 15293 15294 15295
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
15296
        vshError(ctl,
15297
                 _("%s: failed to read temporary file: %s"),
15298
                 filename, strerror(errno));
15299 15300 15301 15302 15303
        return NULL;
    }
    return ret;
}

15304

P
Paolo Bonzini 已提交
15305 15306 15307 15308
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
15309 15310
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
15311 15312 15313 15314
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
15315
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
15316 15317 15318
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
15319
static bool
15320
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
15321
{
15322
    const char *dir = NULL;
15323
    char *dir_malloced = NULL;
E
Eric Blake 已提交
15324
    bool ret = true;
P
Paolo Bonzini 已提交
15325 15326

    if (!ctl->imode) {
15327
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
15328
        return false;
P
Paolo Bonzini 已提交
15329 15330
    }

15331
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
15332
        uid_t uid = geteuid();
15333
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
15334 15335 15336 15337
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
15338
    if (chdir(dir) == -1) {
15339
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
15340
        ret = false;
P
Paolo Bonzini 已提交
15341 15342
    }

15343
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
15344
    return ret;
P
Paolo Bonzini 已提交
15345 15346 15347 15348 15349 15350
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
15351 15352
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
15353 15354 15355
    {NULL, NULL}
};

E
Eric Blake 已提交
15356
static bool
P
Paolo Bonzini 已提交
15357 15358 15359
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
15360
    bool ret = true;
P
Paolo Bonzini 已提交
15361

15362 15363
    cwd = getcwd(NULL, 0);
    if (!cwd) {
15364 15365
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
15366 15367
        ret = false;
    } else {
P
Paolo Bonzini 已提交
15368
        vshPrint (ctl, _("%s\n"), cwd);
15369 15370
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
15371

15372
    return ret;
P
Paolo Bonzini 已提交
15373 15374
}

E
Eric Blake 已提交
15375 15376 15377 15378 15379 15380 15381 15382 15383 15384 15385 15386
/*
 * "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")},
E
Eric Blake 已提交
15387
    {"str", VSH_OT_ALIAS, 0, "string"},
15388
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
15389 15390 15391 15392 15393 15394
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
15395
static bool
15396
cmdEcho (vshControl *ctl, const vshCmd *cmd)
E
Eric Blake 已提交
15397 15398 15399 15400
{
    bool shell = false;
    bool xml = false;
    int count = 0;
15401
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
15402 15403 15404 15405 15406 15407 15408 15409
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

15410
    while ((opt = vshCommandOptArgv(cmd, opt))) {
15411 15412
        char *str;
        virBuffer xmlbuf = VIR_BUFFER_INITIALIZER;
E
Eric Blake 已提交
15413

15414
        arg = opt->data;
15415

E
Eric Blake 已提交
15416 15417
        if (count)
            virBufferAddChar(&buf, ' ');
15418

E
Eric Blake 已提交
15419
        if (xml) {
15420 15421 15422 15423
            virBufferEscapeString(&xmlbuf, "%s", arg);
            if (virBufferError(&buf)) {
                vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
                return false;
E
Eric Blake 已提交
15424
            }
15425 15426 15427
            str = virBufferContentAndReset(&xmlbuf);
        } else {
            str = vshStrdup(ctl, arg);
E
Eric Blake 已提交
15428
        }
15429 15430 15431 15432 15433

        if (shell)
            virBufferEscapeShell(&buf, str);
        else
            virBufferAdd(&buf, str, -1);
E
Eric Blake 已提交
15434
        count++;
15435
        VIR_FREE(str);
E
Eric Blake 已提交
15436 15437 15438 15439
    }

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
15440
        return false;
E
Eric Blake 已提交
15441 15442 15443 15444 15445
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
15446
    return true;
E
Eric Blake 已提交
15447 15448
}

15449 15450 15451 15452
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
15453 15454
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
15455 15456 15457 15458
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
15459
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
15460 15461 15462 15463 15464 15465
    {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 已提交
15466
static bool
15467 15468
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
15469
    bool ret = false;
15470 15471 15472 15473 15474
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
E
Eric Blake 已提交
15475
    unsigned int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
15476

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

J
Jim Meyering 已提交
15480
    dom = vshCommandOptDomain (ctl, cmd, NULL);
15481 15482 15483 15484
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
15485
    doc = virDomainGetXMLDesc (dom, flags);
15486 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499 15500 15501 15502 15503
    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 已提交
15504
        ret = true;
15505 15506 15507 15508 15509 15510 15511
        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.
     */
15512
    doc_reread = virDomainGetXMLDesc (dom, flags);
15513 15514 15515 15516
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
15517 15518
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
15519 15520 15521 15522 15523 15524 15525 15526 15527 15528 15529 15530
        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 已提交
15531
    ret = true;
15532 15533 15534 15535 15536

 cleanup:
    if (dom)
        virDomainFree (dom);

15537 15538 15539
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
15540 15541 15542

    if (tmp) {
        unlink (tmp);
15543
        VIR_FREE(tmp);
15544 15545 15546 15547 15548
    }

    return ret;
}

15549

15550 15551 15552 15553
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
15554 15555
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
15556 15557 15558 15559
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
15560
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
15561 15562 15563 15564 15565 15566 15567 15568 15569 15570
    {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[] = {
15571 15572
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
15573 15574 15575 15576
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
15577
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
15578 15579 15580 15581 15582 15583
    {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 已提交
15584 15585 15586
/*
 * "quit" command
 */
15587
static const vshCmdInfo info_quit[] = {
15588
    {"help", N_("quit this interactive terminal")},
15589
    {"desc", ""},
15590
    {NULL, NULL}
K
Karel Zak 已提交
15591 15592
};

E
Eric Blake 已提交
15593
static bool
15594
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
15595
{
E
Eric Blake 已提交
15596 15597
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
15598 15599
}

15600 15601 15602 15603 15604 15605 15606
/* 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;
15607
    bool halt = false;
15608 15609 15610
    char *doc = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
E
Eric Blake 已提交
15611
    const char *name = NULL;
15612 15613

    snapshot = virDomainSnapshotCreateXML(dom, buffer, flags);
15614 15615 15616 15617 15618 15619 15620 15621 15622 15623 15624 15625 15626 15627 15628 15629 15630 15631 15632 15633 15634 15635 15636 15637

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

15638 15639 15640
    if (snapshot == NULL)
        goto cleanup;

15641 15642 15643 15644 15645
    if (halt && virDomainDestroy(dom) < 0) {
        virshReportError(ctl);
        goto cleanup;
    }

E
Eric Blake 已提交
15646
    name = virDomainSnapshotGetName(snapshot);
15647
    if (!name) {
E
Eric Blake 已提交
15648
        vshError(ctl, "%s", _("Could not get snapshot name"));
15649 15650 15651 15652 15653 15654 15655 15656 15657 15658 15659 15660 15661 15662 15663 15664 15665 15666 15667
        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;
}

15668 15669 15670 15671
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
15672 15673
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
15674 15675 15676 15677 15678 15679
    {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")},
15680 15681 15682
    {"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")},
15683
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
15684
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
15685
    {"reuse-external", VSH_OT_BOOL, 0, N_("reuse any existing external files")},
15686
    {"quiesce", VSH_OT_BOOL, 0, N_("quiesce guest's file systems")},
15687 15688 15689
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
15690
static bool
15691 15692 15693
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
15694
    bool ret = false;
15695
    const char *from = NULL;
15696
    char *buffer = NULL;
15697 15698 15699 15700 15701 15702 15703 15704
    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;
15705 15706
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
15707 15708
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
15709 15710
    if (vshCommandOptBool(cmd, "reuse-external"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_REUSE_EXT;
15711 15712
    if (vshCommandOptBool(cmd, "quiesce"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_QUIESCE;
15713

15714
    if (!vshConnectionUsability(ctl, ctl->conn))
15715 15716 15717 15718 15719 15720
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

15721
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
15722
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
15723 15724 15725 15726 15727 15728 15729 15730 15731 15732 15733 15734 15735 15736 15737
    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;
    }

15738
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, from);
15739 15740 15741 15742 15743 15744 15745 15746 15747

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

15748 15749 15750
/*
 * "snapshot-create-as" command
 */
15751 15752 15753 15754 15755 15756 15757 15758 15759 15760 15761 15762 15763 15764 15765 15766 15767 15768 15769 15770 15771 15772 15773 15774 15775 15776 15777 15778 15779 15780 15781 15782 15783 15784 15785 15786 15787 15788 15789 15790 15791 15792 15793 15794 15795 15796 15797 15798 15799 15800 15801 15802 15803 15804 15805 15806
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;
}

15807 15808 15809 15810 15811 15812 15813 15814 15815 15816
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 已提交
15817
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
15818
    {"no-metadata", VSH_OT_BOOL, 0, N_("take snapshot but create no metadata")},
15819
    {"halt", VSH_OT_BOOL, 0, N_("halt domain after snapshot is created")},
15820
    {"disk-only", VSH_OT_BOOL, 0, N_("capture disk state but not vm state")},
15821
    {"reuse-external", VSH_OT_BOOL, 0, N_("reuse any existing external files")},
15822
    {"quiesce", VSH_OT_BOOL, 0, N_("quiesce guest's file systems")},
15823 15824
    {"diskspec", VSH_OT_ARGV, 0,
     N_("disk attributes: disk[,snapshot=type][,driver=type][,file=name]")},
15825 15826 15827 15828 15829 15830 15831 15832 15833 15834 15835 15836
    {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;
15837
    unsigned int flags = 0;
15838
    const vshCmdOpt *opt = NULL;
15839 15840 15841

    if (vshCommandOptBool(cmd, "no-metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_NO_METADATA;
15842 15843
    if (vshCommandOptBool(cmd, "halt"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_HALT;
15844 15845
    if (vshCommandOptBool(cmd, "disk-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_DISK_ONLY;
15846 15847
    if (vshCommandOptBool(cmd, "reuse-external"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_REUSE_EXT;
15848 15849
    if (vshCommandOptBool(cmd, "quiesce"))
        flags |= VIR_DOMAIN_SNAPSHOT_CREATE_QUIESCE;
15850 15851 15852 15853 15854 15855 15856 15857 15858 15859 15860 15861 15862 15863 15864 15865

    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)
15866
        virBufferEscapeString(&buf, "  <name>%s</name>\n", name);
15867
    if (desc)
15868
        virBufferEscapeString(&buf, "  <description>%s</description>\n", desc);
15869 15870 15871 15872 15873 15874 15875 15876 15877 15878
    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");
    }
15879 15880 15881 15882 15883 15884 15885 15886
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
15887 15888 15889 15890 15891 15892
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

15893
    ret = vshSnapshotCreate(ctl, dom, buffer, flags, NULL);
15894 15895 15896 15897 15898 15899 15900 15901 15902

cleanup:
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

15903 15904 15905 15906 15907 15908 15909 15910 15911 15912 15913 15914 15915 15916 15917 15918 15919 15920 15921 15922 15923 15924 15925 15926 15927 15928 15929 15930 15931 15932 15933 15934 15935 15936 15937 15938 15939 15940 15941
/* 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;
}

15942 15943 15944 15945 15946 15947 15948 15949 15950 15951 15952
/*
 * "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")},
15953
    {"snapshotname", VSH_OT_DATA, 0, N_("snapshot name")},
15954
    {"current", VSH_OT_BOOL, 0, N_("also set edited snapshot as current")},
15955 15956
    {"rename", VSH_OT_BOOL, 0, N_("allow renaming an existing snapshot")},
    {"clone", VSH_OT_BOOL, 0, N_("allow cloning to new name")},
15957 15958 15959 15960 15961 15962 15963 15964
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotEdit(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    virDomainSnapshotPtr snapshot = NULL;
15965
    virDomainSnapshotPtr edited = NULL;
15966
    const char *name;
15967
    const char *edited_name;
15968 15969 15970 15971 15972 15973
    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;
15974 15975 15976 15977 15978 15979 15980 15981
    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;
    }
15982

15983 15984
    if (vshCommandOptBool(cmd, "current") &&
        vshCommandOptBool(cmd, "snapshotname"))
15985 15986 15987 15988 15989 15990 15991 15992 15993
        define_flags |= VIR_DOMAIN_SNAPSHOT_CREATE_CURRENT;

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

15994 15995
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", false, dom,
                          &snapshot, &name) < 0)
15996 15997 15998 15999 16000 16001 16002
        goto cleanup;

    /* Get the XML configuration of the snapshot.  */
    doc = virDomainSnapshotGetXMLDesc(snapshot, getxml_flags);
    if (!doc)
        goto cleanup;

16003 16004 16005 16006
    /* 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;

16007 16008 16009 16010 16011 16012 16013 16014 16015 16016 16017 16018 16019 16020 16021 16022 16023 16024 16025 16026 16027 16028 16029 16030 16031
    /* 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.  */
16032 16033
    edited = virDomainSnapshotCreateXML(dom, doc_edited, define_flags);
    if (!edited) {
16034 16035 16036 16037
        vshError(ctl, _("Failed to update %s"), name);
        goto cleanup;
    }

16038 16039 16040 16041 16042 16043 16044 16045 16046 16047 16048 16049 16050 16051 16052 16053 16054 16055 16056 16057 16058 16059 16060 16061
    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;
        }
    }

16062 16063 16064 16065 16066 16067 16068 16069 16070 16071 16072
    ret = true;

cleanup:
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    if (tmp) {
        unlink(tmp);
        VIR_FREE(tmp);
    }
    if (snapshot)
        virDomainSnapshotFree(snapshot);
16073 16074
    if (edited)
        virDomainSnapshotFree(edited);
16075 16076 16077 16078 16079
    if (dom)
        virDomainFree(dom);
    return ret;
}

16080 16081 16082 16083
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
16084 16085
    {"help", N_("Get or set the current snapshot")},
    {"desc", N_("Get or set the current snapshot")},
16086 16087 16088 16089 16090
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_current[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
16091
    {"name", VSH_OT_BOOL, 0, N_("list the name, rather than the full xml")},
16092 16093
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
16094 16095
    {"snapshotname", VSH_OT_DATA, 0,
     N_("name of existing snapshot to make current")},
16096 16097 16098
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
16099
static bool
16100 16101 16102
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
16103
    bool ret = false;
16104 16105
    int current;
    virDomainSnapshotPtr snapshot = NULL;
16106
    char *xml = NULL;
16107
    const char *snapshotname = NULL;
16108
    unsigned int flags = 0;
16109
    const char *domname;
16110 16111 16112

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;
16113

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

16117
    dom = vshCommandOptDomain(ctl, cmd, &domname);
16118 16119 16120
    if (dom == NULL)
        goto cleanup;

16121 16122 16123 16124 16125 16126 16127 16128 16129 16130 16131 16132 16133 16134 16135 16136 16137 16138 16139 16140
    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;
16141 16142 16143
        /* 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;
16144 16145 16146 16147 16148 16149 16150 16151 16152
        snapshot2 = virDomainSnapshotCreateXML(dom, xml, flags);
        if (snapshot2 == NULL)
            goto cleanup;
        virDomainSnapshotFree(snapshot2);
        vshPrint(ctl, _("Snapshot %s set as current"), snapshotname);
        ret = true;
        goto cleanup;
    }

16153
    current = virDomainHasCurrentSnapshot(dom, 0);
16154 16155 16156 16157
    if (current < 0) {
        goto cleanup;
    } else if (!current) {
        vshError(ctl, _("domain '%s' has no current snapshot"), domname);
16158
        goto cleanup;
16159
    } else {
E
Eric Blake 已提交
16160
        const char *name = NULL;
16161 16162 16163 16164

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

16165
        if (vshCommandOptBool(cmd, "name")) {
E
Eric Blake 已提交
16166
            name = virDomainSnapshotGetName(snapshot);
16167 16168
            if (!name)
                goto cleanup;
E
Eric Blake 已提交
16169 16170 16171 16172
        } else {
            xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
            if (!xml)
                goto cleanup;
16173 16174 16175
        }

        vshPrint(ctl, "%s", name ? name : xml);
16176 16177
    }

E
Eric Blake 已提交
16178
    ret = true;
16179 16180

cleanup:
16181 16182
    if (!ret)
        virshReportError(ctl);
16183
    VIR_FREE(xml);
16184 16185 16186 16187 16188 16189 16190 16191
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

16192
/* Helper function to get the name of a snapshot's parent.  Caller
16193 16194 16195 16196 16197 16198
 * 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)
16199 16200 16201 16202 16203
{
    virDomainSnapshotPtr parent = NULL;
    char *xml = NULL;
    xmlDocPtr xmldoc = NULL;
    xmlXPathContextPtr ctxt = NULL;
16204 16205 16206
    int ret = -1;

    *parent_name = NULL;
16207 16208

    /* Try new API, since it is faster. */
16209
    if (!ctl->useSnapshotOld) {
16210 16211 16212
        parent = virDomainSnapshotGetParent(snapshot, 0);
        if (parent) {
            /* API works, and virDomainSnapshotGetName will succeed */
16213 16214
            *parent_name = vshStrdup(ctl, virDomainSnapshotGetName(parent));
            ret = 0;
16215 16216 16217 16218
            goto cleanup;
        }
        if (last_error->code == VIR_ERR_NO_DOMAIN_SNAPSHOT) {
            /* API works, and we found a root with no parent */
16219
            ret = 0;
16220 16221 16222
            goto cleanup;
        }
        /* API didn't work, fall back to XML scraping. */
16223
        ctl->useSnapshotOld = true;
16224 16225 16226 16227 16228 16229 16230 16231 16232 16233
    }

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

    xmldoc = virXMLParseStringCtxt(xml, _("(domain_snapshot)"), &ctxt);
    if (!xmldoc)
        goto cleanup;

16234 16235
    *parent_name = virXPathString("string(/domainsnapshot/parent/name)", ctxt);
    ret = 0;
16236 16237

cleanup:
16238 16239 16240 16241 16242 16243 16244
    if (ret < 0) {
        virshReportError(ctl);
        vshError(ctl, "%s", _("unable to determine if snapshot has parent"));
    } else {
        virFreeError(last_error);
        last_error = NULL;
    }
16245 16246 16247 16248 16249
    if (parent)
        virDomainSnapshotFree(parent);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(xmldoc);
    VIR_FREE(xml);
16250
    return ret;
16251 16252
}

16253 16254 16255 16256 16257 16258 16259 16260 16261 16262 16263
/*
 * "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")},
16264
    {"parent", VSH_OT_BOOL, 0, N_("add a column showing parent snapshot")},
16265
    {"roots", VSH_OT_BOOL, 0, N_("list only snapshots without parents")},
16266
    {"leaves", VSH_OT_BOOL, 0, N_("list only snapshots without children")},
16267 16268
    {"metadata", VSH_OT_BOOL, 0,
     N_("list only snapshots that have metadata that would prevent undefine")},
16269
    {"tree", VSH_OT_BOOL, 0, N_("list snapshots in a tree")},
16270
    {"from", VSH_OT_DATA, 0, N_("limit list to children of given snapshot")},
16271 16272
    {"current", VSH_OT_BOOL, 0,
     N_("limit list to children of current snapshot")},
16273
    {"descendants", VSH_OT_BOOL, 0, N_("with --from, list all descendants")},
16274 16275 16276
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
16277
static bool
16278 16279 16280
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
16281
    bool ret = false;
16282
    unsigned int flags = 0;
16283 16284
    int parent_filter = 0; /* -1 for roots filtering, 0 for no parent
                              information needed, 1 for parent column */
16285 16286
    int numsnaps;
    char **names = NULL;
16287
    char **parents = NULL;
16288
    int actual = 0;
16289 16290 16291 16292 16293 16294
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
16295
    char *parent = NULL;
16296 16297
    long long creation_longlong;
    time_t creation_time_t;
16298 16299
    char timestr[100];
    struct tm time_info;
16300
    bool tree = vshCommandOptBool(cmd, "tree");
16301
    bool leaves = vshCommandOptBool(cmd, "leaves");
16302 16303
    const char *from = NULL;
    virDomainSnapshotPtr start = NULL;
16304
    int start_index = -1;
16305
    bool descendants = false;
16306

16307 16308 16309 16310 16311 16312 16313 16314 16315 16316
    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)
16317
        goto cleanup;
16318

16319
    if (vshCommandOptBool(cmd, "parent")) {
16320 16321
        if (vshCommandOptBool(cmd, "roots")) {
            vshError(ctl, "%s",
16322
                     _("--parent and --roots are mutually exclusive"));
16323 16324
            return false;
        }
16325 16326
        if (tree) {
            vshError(ctl, "%s",
16327
                     _("--parent and --tree are mutually exclusive"));
16328 16329
            return false;
        }
16330
        parent_filter = 1;
16331
    } else if (vshCommandOptBool(cmd, "roots")) {
16332 16333
        if (tree) {
            vshError(ctl, "%s",
16334
                     _("--roots and --tree are mutually exclusive"));
16335 16336
            return false;
        }
16337 16338 16339 16340
        if (from) {
            vshError(ctl, "%s",
                     _("--roots and --from are mutually exclusive"));
        }
16341 16342
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_ROOTS;
    }
16343 16344 16345 16346 16347 16348 16349 16350
    if (leaves) {
        if (tree) {
            vshError(ctl, "%s",
                     _("--leaves and --tree are mutually exclusive"));
            return false;
        }
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_LEAVES;
    }
16351 16352 16353

    if (vshCommandOptBool(cmd, "metadata")) {
        flags |= VIR_DOMAIN_SNAPSHOT_LIST_METADATA;
16354 16355
    }

16356
    if (from) {
16357 16358
        descendants = vshCommandOptBool(cmd, "descendants");
        if (descendants || tree) {
16359 16360
            flags |= VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS;
        }
16361 16362
        numsnaps = ctl->useSnapshotOld ? -1 :
            virDomainSnapshotNumChildren(start, flags);
16363
        if (numsnaps < 0) {
16364 16365
            if (ctl->useSnapshotOld ||
                last_error->code == VIR_ERR_NO_SUPPORT) {
16366
                /* We can emulate --from.  */
16367
                /* XXX can we also emulate --leaves? */
16368 16369 16370 16371 16372 16373
                virFreeError(last_error);
                last_error = NULL;
                ctl->useSnapshotOld = true;
                flags &= ~VIR_DOMAIN_SNAPSHOT_LIST_DESCENDANTS;
                numsnaps = virDomainSnapshotNum(dom, flags);
            }
16374 16375
        } else if (tree) {
            numsnaps++;
16376
        }
16377
    } else {
16378
        numsnaps = virDomainSnapshotNum(dom, flags);
16379 16380

        /* Fall back to simulation if --roots was unsupported. */
16381
        /* XXX can we also emulate --leaves? */
16382 16383 16384 16385 16386 16387 16388 16389
        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);
        }
16390 16391
    }

16392 16393 16394
    if (numsnaps < 0) {
        if (!last_error)
            vshError(ctl, _("missing support"));
16395
        goto cleanup;
16396
    }
16397

16398 16399 16400 16401 16402 16403 16404 16405 16406
    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\
16407
------------------------------------------------------------\n");
16408
    }
16409

16410 16411 16412 16413
    if (!numsnaps) {
        ret = true;
        goto cleanup;
    }
16414

16415 16416 16417
    if (VIR_ALLOC_N(names, numsnaps) < 0)
        goto cleanup;

16418
    if (from && !ctl->useSnapshotOld) {
16419 16420 16421 16422 16423 16424 16425 16426 16427 16428 16429 16430 16431 16432 16433 16434 16435 16436
        /* 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);
    }
16437 16438
    if (actual < 0)
        goto cleanup;
16439

E
Eric Blake 已提交
16440 16441
    qsort(&names[0], actual, sizeof(char*), namesorter);

16442 16443
    if (tree || ctl->useSnapshotOld) {
        parents = vshCalloc(ctl, sizeof(char *), actual);
16444
        for (i = (from && !ctl->useSnapshotOld); i < actual; i++) {
16445 16446 16447 16448 16449
            if (ctl->useSnapshotOld && STREQ(names[i], from)) {
                start_index = i;
                continue;
            }

16450 16451 16452 16453
            /* free up memory from previous iterations of the loop */
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
16454 16455
            if (!snapshot ||
                vshGetSnapshotParent(ctl, snapshot, &parents[i]) < 0) {
16456 16457 16458 16459 16460 16461
                while (--i >= 0)
                    VIR_FREE(parents[i]);
                VIR_FREE(parents);
                goto cleanup;
            }
        }
16462 16463 16464
    }
    if (tree) {
        char indentBuf[INDENT_BUFLEN];
16465 16466
        for (i = 0 ; i < actual ; i++) {
            memset(indentBuf, '\0', sizeof indentBuf);
16467
            if (ctl->useSnapshotOld ? STREQ(names[i], from) : !parents[i])
16468 16469 16470 16471 16472 16473 16474 16475 16476 16477 16478 16479 16480 16481
                cmdNodeListDevicesPrint(ctl,
                                        names,
                                        parents,
                                        actual,
                                        i,
                                        i,
                                        0,
                                        0,
                                        indentBuf);
        }

        ret = true;
        goto cleanup;
    } else {
16482
        if (ctl->useSnapshotOld && descendants) {
16483 16484 16485 16486 16487 16488 16489 16490 16491 16492 16493 16494 16495 16496 16497 16498 16499 16500 16501 16502 16503 16504 16505 16506 16507 16508 16509 16510 16511 16512 16513 16514 16515 16516 16517 16518 16519 16520 16521 16522 16523 16524 16525 16526 16527 16528 16529 16530 16531 16532
            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]);
16533 16534
        }

16535
        for (i = 0; i < actual; i++) {
16536 16537
            if (ctl->useSnapshotOld &&
                (descendants ? !names[i] : STRNEQ_NULLABLE(parents[i], from)))
16538 16539
                continue;

16540
            /* free up memory from previous iterations of the loop */
16541
            VIR_FREE(parent);
16542 16543 16544 16545
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
16546
            xmlFreeDoc(xml);
16547 16548 16549 16550 16551 16552 16553 16554 16555 16556
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

16557
            xml = virXMLParseStringCtxt(doc, _("(domain_snapshot)"), &ctxt);
16558 16559 16560
            if (!xml)
                continue;

16561 16562 16563
            if (parent_filter) {
                parent = virXPathString("string(/domainsnapshot/parent/name)",
                                        ctxt);
16564 16565
                if (!parent && parent_filter < 0)
                    continue;
16566 16567
            }

16568 16569 16570
            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
16571 16572
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
16573
                continue;
16574 16575 16576 16577 16578 16579
            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);
16580 16581
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z",
                     &time_info);
16582

16583 16584 16585 16586 16587
            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);
16588 16589 16590
        }
    }

E
Eric Blake 已提交
16591
    ret = true;
16592 16593 16594

cleanup:
    /* this frees up memory from the last iteration of the loop */
16595
    VIR_FREE(parent);
16596 16597 16598
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
16599 16600
    if (start)
        virDomainSnapshotFree(start);
16601
    xmlXPathFreeContext(ctxt);
16602
    xmlFreeDoc(xml);
16603
    VIR_FREE(doc);
16604
    for (i = 0; i < actual; i++) {
16605
        VIR_FREE(names[i]);
16606 16607 16608
        if (parents)
            VIR_FREE(parents[i]);
    }
16609
    VIR_FREE(names);
16610
    VIR_FREE(parents);
16611 16612 16613 16614 16615 16616 16617 16618 16619 16620 16621 16622 16623 16624 16625 16626 16627 16628
    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")},
16629 16630
    {"security-info", VSH_OT_BOOL, 0,
     N_("include security sensitive information in XML dump")},
16631 16632 16633
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
16634
static bool
16635 16636 16637
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
16638
    bool ret = false;
16639
    const char *name = NULL;
16640 16641
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;
16642 16643 16644 16645
    unsigned int flags = 0;

    if (vshCommandOptBool(cmd, "security-info"))
        flags |= VIR_DOMAIN_XML_SECURE;
16646

16647
    if (!vshConnectionUsability(ctl, ctl->conn))
16648 16649 16650 16651 16652 16653
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

16654
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
16655 16656 16657 16658 16659 16660
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

16661
    xml = virDomainSnapshotGetXMLDesc(snapshot, flags);
16662 16663 16664
    if (!xml)
        goto cleanup;

16665
    vshPrint(ctl, "%s", xml);
16666

E
Eric Blake 已提交
16667
    ret = true;
16668 16669 16670 16671 16672 16673 16674 16675 16676 16677 16678

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

E
Eric Blake 已提交
16679 16680 16681 16682
/*
 * "snapshot-parent" command
 */
static const vshCmdInfo info_snapshot_parent[] = {
E
Eric Blake 已提交
16683
    {"help", N_("Get the name of the parent of a snapshot")},
E
Eric Blake 已提交
16684 16685 16686 16687 16688 16689
    {"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")},
16690 16691
    {"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 已提交
16692 16693 16694 16695 16696 16697 16698 16699 16700 16701 16702 16703 16704 16705 16706 16707 16708 16709 16710
    {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;

16711 16712
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", true, dom,
                          &snapshot, &name) < 0)
E
Eric Blake 已提交
16713 16714
        goto cleanup;

16715
    if (vshGetSnapshotParent(ctl, snapshot, &parent) < 0)
E
Eric Blake 已提交
16716
        goto cleanup;
16717 16718 16719 16720
    if (!parent) {
        vshError(ctl, _("snapshot '%s' has no parent"), name);
        goto cleanup;
    }
E
Eric Blake 已提交
16721 16722 16723 16724 16725 16726 16727 16728 16729 16730 16731 16732 16733 16734 16735

    vshPrint(ctl, "%s", parent);

    ret = true;

cleanup:
    VIR_FREE(parent);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

16736
/*
16737
 * "snapshot-revert" command
16738
 */
16739
static const vshCmdInfo info_snapshot_revert[] = {
16740 16741 16742 16743 16744
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

16745
static const vshCmdOptDef opts_snapshot_revert[] = {
16746
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
16747 16748
    {"snapshotname", VSH_OT_DATA, 0, N_("snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("revert to current snapshot")},
16749 16750
    {"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 已提交
16751
    {"force", VSH_OT_BOOL, 0, N_("try harder on risky reverts")},
16752 16753 16754
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
16755
static bool
16756
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
16757 16758
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
16759
    bool ret = false;
16760
    const char *name = NULL;
16761
    virDomainSnapshotPtr snapshot = NULL;
16762
    unsigned int flags = 0;
E
Eric Blake 已提交
16763 16764
    bool force = false;
    int result;
16765 16766 16767 16768 16769

    if (vshCommandOptBool(cmd, "running"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_RUNNING;
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_SNAPSHOT_REVERT_PAUSED;
E
Eric Blake 已提交
16770 16771 16772 16773 16774 16775
    /* 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;
16776

16777
    if (!vshConnectionUsability(ctl, ctl->conn))
16778 16779 16780 16781 16782 16783
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

16784 16785
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", true, dom,
                          &snapshot, &name) < 0)
16786 16787
        goto cleanup;

E
Eric Blake 已提交
16788 16789 16790 16791 16792 16793 16794 16795 16796
    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)
16797 16798
        goto cleanup;

E
Eric Blake 已提交
16799
    ret = true;
16800 16801 16802 16803 16804 16805 16806 16807 16808 16809 16810 16811 16812 16813 16814 16815 16816 16817 16818 16819 16820

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")},
16821 16822
    {"snapshotname", VSH_OT_DATA, 0, N_("snapshot name")},
    {"current", VSH_OT_BOOL, 0, N_("delete current snapshot")},
16823
    {"children", VSH_OT_BOOL, 0, N_("delete snapshot and all children")},
16824 16825 16826
    {"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")},
16827 16828 16829
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
16830
static bool
16831 16832 16833
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
16834
    bool ret = false;
16835
    const char *name = NULL;
16836 16837 16838
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

16839
    if (!vshConnectionUsability(ctl, ctl->conn))
16840 16841 16842 16843 16844 16845
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

16846 16847
    if (vshLookupSnapshot(ctl, cmd, "snapshotname", true, dom,
                          &snapshot, &name) < 0)
16848 16849 16850 16851
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;
16852 16853 16854 16855
    if (vshCommandOptBool(cmd, "children-only"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN_ONLY;
    if (vshCommandOptBool(cmd, "metadata"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY;
16856

16857 16858 16859
    /* 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.  */
16860
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
16861 16862 16863 16864
        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);
16865 16866
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
16867
        goto cleanup;
16868
    }
16869

E
Eric Blake 已提交
16870
    ret = true;
16871 16872 16873 16874 16875 16876 16877 16878 16879 16880

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

16881 16882 16883 16884 16885 16886 16887 16888 16889 16890 16891 16892 16893 16894 16895 16896 16897 16898 16899 16900 16901 16902 16903 16904 16905 16906 16907 16908 16909 16910 16911 16912 16913 16914 16915 16916 16917 16918 16919 16920 16921 16922 16923 16924 16925 16926 16927 16928 16929 16930 16931 16932 16933 16934 16935 16936 16937 16938 16939 16940 16941 16942 16943 16944 16945 16946 16947 16948 16949 16950 16951 16952 16953 16954 16955 16956 16957
/*
 * "domblkerror" command
 */
static const char *
vshDomainIOErrorToString(int error)
{
    switch ((virDomainDiskErrorCode) error) {
    case VIR_DOMAIN_DISK_ERROR_NONE:
        return _("no error");
    case VIR_DOMAIN_DISK_ERROR_UNSPEC:
        return _("unspecified error");
    case VIR_DOMAIN_DISK_ERROR_NO_SPACE:
        return _("no space");
    case VIR_DOMAIN_DISK_ERROR_LAST:
        ;
    }

    return _("unknown error");
}

static const vshCmdInfo info_domblkerror[] = {
    {"help", N_("Show errors on block devices")},
    {"desc", N_("Show block device errors")},
    {NULL, NULL}
};

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

static bool
cmdDomBlkError(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    virDomainDiskErrorPtr disks = NULL;
    unsigned int ndisks;
    int i;
    int count;
    bool ret = false;

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

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

    if ((count = virDomainGetDiskErrors(dom, NULL, 0, 0)) < 0)
        goto cleanup;
    ndisks = count;

    if (ndisks) {
        if (VIR_ALLOC_N(disks, ndisks) < 0)
            goto cleanup;

        if ((count = virDomainGetDiskErrors(dom, disks, ndisks, 0)) == -1)
            goto cleanup;
    }

    if (count == 0) {
        vshPrint(ctl, _("No errors found\n"));
    } else {
        for (i = 0; i < count; i++) {
            vshPrint(ctl, "%s: %s\n",
                     disks[i].disk,
                     vshDomainIOErrorToString(disks[i].error));
        }
    }

    ret = true;

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

16958 16959 16960 16961
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
16962 16963
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
16964 16965 16966 16967 16968
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
16969
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
16970
    {"cmd", VSH_OT_ARGV, VSH_OFLAG_REQ, N_("command")},
16971 16972 16973
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
16974
static bool
16975 16976 16977
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
16978
    bool ret = false;
16979
    char *monitor_cmd = NULL;
16980
    char *result = NULL;
16981
    unsigned int flags = 0;
16982 16983 16984
    const vshCmdOpt *opt = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    bool pad = false;
16985 16986 16987 16988 16989 16990 16991 16992

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

16993 16994 16995 16996 16997 16998 16999 17000
    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"));
17001 17002
        goto cleanup;
    }
17003
    monitor_cmd = virBufferContentAndReset(&buf);
17004

17005 17006 17007 17008
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
17009 17010 17011 17012
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
17013
    ret = true;
17014 17015 17016

cleanup:
    VIR_FREE(result);
17017
    VIR_FREE(monitor_cmd);
17018 17019 17020 17021 17022 17023
    if (dom)
        virDomainFree(dom);

    return ret;
}

17024 17025 17026 17027 17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043
/*
 * "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;
17044
    unsigned int pid_value; /* API uses unsigned int, not pid_t */
17045 17046 17047 17048

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

17049
    if (vshCommandOptUInt(cmd, "pid", &pid_value) <= 0) {
17050 17051 17052 17053
        vshError(ctl, "%s", _("missing pid value"));
        goto cleanup;
    }

17054
    if (!(dom = virDomainQemuAttach(ctl->conn, pid_value, flags)))
17055 17056 17057 17058
        goto cleanup;

    if (dom != NULL) {
        vshPrint(ctl, _("Domain %s attached to pid %u\n"),
17059
                 virDomainGetName(dom), pid_value);
17060 17061 17062
        virDomainFree(dom);
        ret = true;
    } else {
17063
        vshError(ctl, _("Failed to attach to pid %u"), pid_value);
17064 17065 17066 17067 17068 17069
    }

cleanup:
    return ret;
}

17070
static const vshCmdDef domManagementCmds[] = {
17071 17072 17073 17074 17075 17076 17077
    {"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 已提交
17078
    {"blkdeviotune", cmdBlkdeviotune, opts_blkdeviotune, info_blkdeviotune, 0},
17079
    {"blkiotune", cmdBlkiotune, opts_blkiotune, info_blkiotune, 0},
17080 17081
    {"blockpull", cmdBlockPull, opts_block_pull, info_block_pull, 0},
    {"blockjob", cmdBlockJob, opts_block_job, info_block_job, 0},
17082
    {"blockresize", cmdBlockResize, opts_block_resize, info_block_resize, 0},
O
Osier Yang 已提交
17083
    {"change-media", cmdChangeMedia, opts_change_media, info_change_media, 0},
17084
#ifndef WIN32
17085
    {"console", cmdConsole, opts_console, info_console, 0},
17086
#endif
17087 17088
    {"cpu-baseline", cmdCPUBaseline, opts_cpu_baseline, info_cpu_baseline, 0},
    {"cpu-compare", cmdCPUCompare, opts_cpu_compare, info_cpu_compare, 0},
17089
    {"cpu-stats", cmdCPUStats, opts_cpu_stats, info_cpu_stats, 0},
17090 17091
    {"create", cmdCreate, opts_create, info_create, 0},
    {"define", cmdDefine, opts_define, info_define, 0},
17092
    {"desc", cmdDesc, opts_desc, info_desc, 0},
17093 17094 17095 17096 17097 17098 17099
    {"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},
17100
    {"domif-setlink", cmdDomIfSetLink, opts_domif_setlink, info_domif_setlink, 0},
17101
    {"domiftune", cmdDomIftune, opts_domiftune, info_domiftune, 0},
17102 17103 17104
    {"domjobabort", cmdDomjobabort, opts_domjobabort, info_domjobabort, 0},
    {"domjobinfo", cmdDomjobinfo, opts_domjobinfo, info_domjobinfo, 0},
    {"domname", cmdDomname, opts_domname, info_domname, 0},
17105 17106
    {"dompmsuspend", cmdDomPMSuspend,
     opts_dom_pm_suspend, info_dom_pm_suspend, 0},
17107 17108
    {"dompmwakeup", cmdDomPMWakeup,
     opts_dom_pm_wakeup, info_dom_pm_wakeup, 0},
17109 17110 17111 17112 17113 17114 17115 17116 17117
    {"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},
17118
    {"send-key", cmdSendKey, opts_send_key, info_send_key},
17119 17120 17121 17122 17123 17124 17125 17126
    {"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},
17127 17128
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
17129 17130
    {"migrate-getspeed", cmdMigrateGetMaxSpeed,
     opts_migrate_getspeed, info_migrate_getspeed, 0},
H
Hu Tao 已提交
17131
    {"numatune", cmdNumatune, opts_numatune, info_numatune, 0},
17132
    {"reboot", cmdReboot, opts_reboot, info_reboot, 0},
X
Xu He Jie 已提交
17133
    {"reset", cmdReset, opts_reset, info_reset, 0},
17134 17135 17136
    {"restore", cmdRestore, opts_restore, info_restore, 0},
    {"resume", cmdResume, opts_resume, info_resume, 0},
    {"save", cmdSave, opts_save, info_save, 0},
17137 17138 17139 17140 17141 17142
    {"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},
17143
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
17144
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
17145 17146 17147 17148 17149 17150 17151 17152 17153 17154 17155 17156
    {"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 已提交
17157
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
17158 17159
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
17160 17161 17162
};

static const vshCmdDef domMonitoringCmds[] = {
17163
    {"domblkerror", cmdDomBlkError, opts_domblkerror, info_domblkerror, 0},
17164
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
17165
    {"domblklist", cmdDomblklist, opts_domblklist, info_domblklist, 0},
17166
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
17167
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
17168
    {"domif-getlink", cmdDomIfGetLink, opts_domif_getlink, info_domif_getlink, 0},
17169
    {"domiflist", cmdDomiflist, opts_domiflist, info_domiflist, 0},
17170 17171 17172 17173 17174 17175
    {"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}
17176 17177 17178
};

static const vshCmdDef storagePoolCmds[] = {
17179
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
17180
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
17181
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
17182 17183 17184 17185 17186 17187 17188 17189 17190 17191 17192 17193 17194 17195 17196 17197 17198 17199 17200 17201 17202
     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}
17203 17204 17205
};

static const vshCmdDef storageVolCmds[] = {
17206 17207 17208 17209 17210 17211 17212 17213 17214 17215 17216 17217 17218 17219 17220
    {"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},
17221
    {"vol-resize", cmdVolResize, opts_vol_resize, info_vol_resize, 0},
17222 17223 17224
    {"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}
17225
};
17226

17227
static const vshCmdDef networkCmds[] = {
17228 17229 17230 17231 17232 17233 17234 17235 17236 17237 17238 17239 17240 17241 17242 17243 17244 17245 17246
    {"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}
17247
};
17248

17249
static const vshCmdDef nodedevCmds[] = {
17250 17251 17252 17253
    {"nodedev-create", cmdNodeDeviceCreate, opts_node_device_create,
     info_node_device_create, 0},
    {"nodedev-destroy", cmdNodeDeviceDestroy, opts_node_device_destroy,
     info_node_device_destroy, 0},
17254 17255 17256 17257
    {"nodedev-detach", cmdNodeDeviceDetach, opts_node_device_detach,
     info_node_device_detach, 0},
    {"nodedev-dettach", cmdNodeDeviceDetach, opts_node_device_detach,
     info_node_device_detach, VSH_CMD_FLAG_ALIAS},
17258 17259 17260 17261 17262 17263 17264 17265 17266
    {"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}
17267 17268 17269
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
17270 17271
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
17272 17273
    {"iface-bridge", cmdInterfaceBridge, opts_interface_bridge,
     info_interface_bridge, 0},
E
Eric Blake 已提交
17274 17275
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
17276 17277 17278 17279 17280 17281 17282 17283 17284 17285 17286 17287 17288 17289
    {"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 已提交
17290 17291
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
17292 17293
    {"iface-start", cmdInterfaceStart, opts_interface_start,
     info_interface_start, 0},
17294 17295
    {"iface-unbridge", cmdInterfaceUnbridge, opts_interface_unbridge,
     info_interface_unbridge, 0},
17296 17297 17298
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine,
     info_interface_undefine, 0},
    {NULL, NULL, NULL, NULL, 0}
17299
};
17300

17301
static const vshCmdDef nwfilterCmds[] = {
17302 17303 17304 17305 17306 17307 17308 17309 17310 17311 17312
    {"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}
17313
};
17314

17315
static const vshCmdDef secretCmds[] = {
17316 17317 17318 17319 17320 17321 17322 17323 17324 17325 17326 17327
    {"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}
17328
};
17329

17330
static const vshCmdDef virshCmds[] = {
17331 17332 17333 17334 17335 17336 17337
    {"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}
17338
};
17339

17340
static const vshCmdDef snapshotCmds[] = {
17341 17342
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
17343 17344
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
17345 17346 17347 17348 17349 17350
    {"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},
17351 17352
    {"snapshot-edit", cmdSnapshotEdit, opts_snapshot_edit,
     info_snapshot_edit, 0},
17353 17354
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
E
Eric Blake 已提交
17355 17356
    {"snapshot-parent", cmdSnapshotParent, opts_snapshot_parent,
     info_snapshot_parent, 0},
17357 17358 17359
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
17360
};
17361

17362
static const vshCmdDef hostAndHypervisorCmds[] = {
17363 17364 17365 17366 17367
    {"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},
17368
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
17369
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
17370
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
17371
    {"nodesuspend", cmdNodeSuspend, opts_node_suspend, info_nodesuspend, 0},
17372
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
17373 17374 17375 17376
    {"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},
17377
    {"version", cmdVersion, opts_version, info_version, 0},
17378
    {NULL, NULL, NULL, NULL, 0}
K
Karel Zak 已提交
17379 17380
};

17381 17382 17383 17384 17385 17386 17387 17388 17389 17390 17391 17392 17393 17394 17395 17396 17397
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 已提交
17398 17399 17400 17401
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
17402
static const char *
17403
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
17404
{
17405
    const vshCmdInfo *info;
17406

K
Karel Zak 已提交
17407
    for (info = cmd->info; info && info->name; info++) {
17408
        if (STREQ(info->name, name))
K
Karel Zak 已提交
17409 17410 17411 17412 17413
            return info->data;
    }
    return NULL;
}

17414
/* Validate that the options associated with cmd can be parsed.  */
17415
static int
E
Eric Blake 已提交
17416
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
17417 17418 17419 17420 17421
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
17422 17423 17424
    *opts_need_arg = 0;
    *opts_required = 0;

17425 17426 17427 17428 17429 17430 17431 17432 17433
    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 已提交
17434
            if (opt->flags & VSH_OFLAG_REQ)
17435 17436 17437
                return -1; /* bool options can't be mandatory */
            continue;
        }
E
Eric Blake 已提交
17438 17439 17440 17441 17442 17443 17444 17445 17446 17447 17448 17449
        if (opt->type == VSH_OT_ALIAS) {
            int j;
            if (opt->flags || !opt->help)
                return -1; /* alias options are tracked by the original name */
            for (j = i + 1; cmd->opts[j].name; j++) {
                if (STREQ(opt->help, cmd->opts[j].name))
                    break;
            }
            if (!cmd->opts[j].name)
                return -1; /* alias option must map to a later option name */
            continue;
        }
E
Eric Blake 已提交
17450 17451
        if (opt->flags & VSH_OFLAG_REQ_OPT) {
            if (opt->flags & VSH_OFLAG_REQ)
L
Lai Jiangshan 已提交
17452 17453 17454 17455
                *opts_required |= 1 << i;
            continue;
        }

17456
        *opts_need_arg |= 1 << i;
E
Eric Blake 已提交
17457
        if (opt->flags & VSH_OFLAG_REQ) {
17458 17459 17460 17461 17462 17463
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
17464 17465 17466

        if (opt->type == VSH_OT_ARGV && cmd->opts[i + 1].name)
            return -1; /* argv option must be listed last */
17467 17468 17469 17470
    }
    return 0;
}

17471
static const vshCmdOptDef *
17472
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
17473
                   uint32_t *opts_seen, int *opt_index)
17474
{
17475 17476 17477 17478
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
17479

17480
        if (STREQ(opt->name, name)) {
E
Eric Blake 已提交
17481 17482 17483 17484
            if (opt->type == VSH_OT_ALIAS) {
                name = opt->help;
                continue;
            }
17485
            if ((*opts_seen & (1 << i)) && opt->type != VSH_OT_ARGV) {
17486 17487 17488
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
17489 17490
            *opts_seen |= 1 << i;
            *opt_index = i;
K
Karel Zak 已提交
17491
            return opt;
17492 17493 17494 17495 17496
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
17497 17498 17499
    return NULL;
}

17500
static const vshCmdOptDef *
17501 17502
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
17503
{
17504
    int i;
17505
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
17506

17507 17508 17509 17510
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
E
Eric Blake 已提交
17511
    i = ffs(*opts_need_arg) - 1;
17512
    opt = &cmd->opts[i];
17513
    if (opt->type != VSH_OT_ARGV)
17514
        *opts_need_arg &= ~(1 << i);
17515
    *opts_seen |= 1 << i;
17516
    return opt;
K
Karel Zak 已提交
17517 17518
}

17519 17520 17521
/*
 * Checks for required options
 */
17522
static int
17523 17524
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
17525
{
17526
    const vshCmdDef *def = cmd->def;
17527 17528 17529 17530 17531 17532 17533 17534 17535
    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];
17536

17537
            vshError(ctl,
17538
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
17539 17540 17541
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
17542 17543
        }
    }
17544
    return -1;
17545 17546
}

17547
static const vshCmdDef *
17548 17549
vshCmddefSearch(const char *cmdname)
{
17550
    const vshCmdGrp *g;
17551
    const vshCmdDef *c;
17552

17553 17554
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
17555
            if (STREQ(c->name, cmdname))
17556 17557 17558 17559
                return c;
        }
    }

K
Karel Zak 已提交
17560 17561 17562
    return NULL;
}

17563 17564 17565 17566 17567 17568
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
17569
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
17570 17571 17572 17573 17574 17575
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
17576
static bool
17577 17578 17579 17580 17581 17582 17583
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 已提交
17584
        return false;
17585 17586 17587 17588 17589 17590 17591 17592 17593 17594
    } 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 已提交
17595
    return true;
17596 17597
}

E
Eric Blake 已提交
17598
static bool
17599
vshCmddefHelp(vshControl *ctl, const char *cmdname)
17600
{
17601
    const vshCmdDef *def = vshCmddefSearch(cmdname);
17602

K
Karel Zak 已提交
17603
    if (!def) {
17604
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
17605
        return false;
17606
    } else {
E
Eric Blake 已提交
17607 17608
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
17609
        const char *help = _(vshCmddefGetInfo(def, "help"));
17610
        char buf[256];
17611 17612
        uint32_t opts_need_arg;
        uint32_t opts_required;
17613
        bool shortopt = false; /* true if 'arg' works instead of '--opt arg' */
17614 17615 17616 17617

        if (vshCmddefOptParse(def, &opts_need_arg, &opts_required)) {
            vshError(ctl, _("internal error: bad options in command: '%s'"),
                     def->name);
E
Eric Blake 已提交
17618
            return false;
17619
        }
K
Karel Zak 已提交
17620

17621
        fputs(_("  NAME\n"), stdout);
17622 17623
        fprintf(stdout, "    %s - %s\n", def->name, help);

17624 17625 17626 17627 17628
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
17629
                const char *fmt = "%s";
17630 17631
                switch (opt->type) {
                case VSH_OT_BOOL:
17632
                    fmt = "[--%s]";
17633 17634
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
17635
                    /* xgettext:c-format */
E
Eric Blake 已提交
17636
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>"
17637
                           : _("[--%s <number>]"));
17638 17639
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
17640 17641
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
17642 17643
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
17644 17645
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
17646 17647
                    break;
                case VSH_OT_DATA:
E
Eric Blake 已提交
17648
                    fmt = ((opt->flags & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
17649 17650
                    if (!(opt->flags & VSH_OFLAG_REQ_OPT))
                        shortopt = true;
17651 17652 17653
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
17654 17655 17656 17657 17658 17659 17660 17661
                    if (shortopt) {
                        fmt = (opt->flags & VSH_OFLAG_REQ)
                            ? _("{[--%s] <string>}...")
                            : _("[[--%s] <string>]...");
                    } else {
                        fmt = (opt->flags & VSH_OFLAG_REQ) ? _("<%s>...")
                            : _("[<%s>]...");
                    }
17662
                    break;
E
Eric Blake 已提交
17663 17664 17665
                case VSH_OT_ALIAS:
                    /* aliases are intentionally undocumented */
                    continue;
17666
                default:
17667
                    assert(0);
17668
                }
17669
                fputc(' ', stdout);
E
Eric Blake 已提交
17670
                fprintf(stdout, fmt, opt->name);
17671
            }
K
Karel Zak 已提交
17672
        }
17673 17674 17675
        fputc('\n', stdout);

        if (desc[0]) {
17676
            /* Print the description only if it's not empty.  */
17677
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
17678
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
17679
        }
17680

K
Karel Zak 已提交
17681
        if (def->opts) {
17682
            const vshCmdOptDef *opt;
17683
            fputs(_("\n  OPTIONS\n"), stdout);
17684
            for (opt = def->opts; opt->name; opt++) {
17685 17686
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
17687
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
17688 17689
                    break;
                case VSH_OT_INT:
17690
                    snprintf(buf, sizeof(buf),
E
Eric Blake 已提交
17691
                             (opt->flags & VSH_OFLAG_REQ) ? _("[--%s] <number>")
17692
                             : _("--%s <number>"), opt->name);
17693 17694
                    break;
                case VSH_OT_STRING:
17695
                    /* OT_STRING should never be VSH_OFLAG_REQ */
17696
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
17697 17698
                    break;
                case VSH_OT_DATA:
17699 17700
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
17701 17702
                    break;
                case VSH_OT_ARGV:
17703 17704 17705
                    snprintf(buf, sizeof(buf),
                             shortopt ? _("[--%s] <string>") : _("<%s>"),
                             opt->name);
17706
                    break;
E
Eric Blake 已提交
17707 17708
                case VSH_OT_ALIAS:
                    continue;
17709 17710 17711
                default:
                    assert(0);
                }
17712

E
Eric Blake 已提交
17713
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
17714
            }
K
Karel Zak 已提交
17715 17716 17717
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
17718
    return true;
K
Karel Zak 已提交
17719 17720 17721 17722 17723 17724
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
17725 17726 17727
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
17728 17729
    vshCmdOpt *a = arg;

17730
    while (a) {
K
Karel Zak 已提交
17731
        vshCmdOpt *tmp = a;
17732

K
Karel Zak 已提交
17733 17734
        a = a->next;

17735 17736
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
17737 17738 17739 17740
    }
}

static void
17741
vshCommandFree(vshCmd *cmd)
17742
{
K
Karel Zak 已提交
17743 17744
    vshCmd *c = cmd;

17745
    while (c) {
K
Karel Zak 已提交
17746
        vshCmd *tmp = c;
17747

K
Karel Zak 已提交
17748 17749 17750 17751
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
17752
        VIR_FREE(tmp);
K
Karel Zak 已提交
17753 17754 17755
    }
}

E
Eric Blake 已提交
17756 17757 17758 17759 17760 17761 17762 17763 17764 17765 17766
/**
 * 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 已提交
17767
 */
E
Eric Blake 已提交
17768 17769
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
17770
{
E
Eric Blake 已提交
17771 17772
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
17773

E
Eric Blake 已提交
17774 17775 17776 17777 17778 17779 17780
    /* 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 已提交
17781
    }
E
Eric Blake 已提交
17782 17783 17784 17785 17786 17787 17788

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
E
Eric Blake 已提交
17789
            return (valid->flags & VSH_OFLAG_REQ) == 0 ? 0 : -1;
E
Eric Blake 已提交
17790 17791 17792 17793
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
17794 17795
}

E
Eric Blake 已提交
17796 17797
/**
 * vshCommandOptInt:
17798 17799 17800 17801 17802 17803 17804
 * @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 已提交
17805
 * 0 if option not found and not required (@value untouched)
17806
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
17807 17808
 */
static int
17809
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
17810
{
E
Eric Blake 已提交
17811 17812 17813
    vshCmdOpt *arg;
    int ret;
    int num;
17814
    char *end_p = NULL;
17815

E
Eric Blake 已提交
17816 17817 17818 17819 17820 17821 17822
    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;
17823
    }
E
Eric Blake 已提交
17824 17825 17826 17827 17828 17829 17830

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
17831 17832
}

17833

E
Eric Blake 已提交
17834 17835 17836 17837 17838 17839
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
17840 17841 17842 17843 17844 17845
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
17846 17847 17848
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
17849 17850
    char *end_p = NULL;

E
Eric Blake 已提交
17851 17852 17853 17854 17855 17856 17857
    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;
17858
    }
E
Eric Blake 已提交
17859 17860 17861 17862 17863 17864 17865

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
17866 17867 17868
}


17869
/*
E
Eric Blake 已提交
17870 17871 17872 17873 17874
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
17875 17876 17877 17878 17879
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
17880
{
E
Eric Blake 已提交
17881 17882
    vshCmdOpt *arg;
    int ret;
17883
    unsigned long num;
17884 17885
    char *end_p = NULL;

E
Eric Blake 已提交
17886 17887 17888 17889 17890 17891 17892
    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;
17893
    }
E
Eric Blake 已提交
17894 17895 17896 17897 17898 17899 17900

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
17901 17902
}

E
Eric Blake 已提交
17903 17904 17905 17906 17907 17908
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
17909
 * Returns option as STRING
E
Eric Blake 已提交
17910 17911 17912 17913
 * 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 已提交
17914
 */
17915 17916
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
17917
{
E
Eric Blake 已提交
17918 17919 17920 17921 17922 17923 17924 17925 17926 17927
    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;
17928
    }
17929

E
Eric Blake 已提交
17930
    if (!*arg->data && !(arg->def->flags & VSH_OFLAG_EMPTY_OK)) {
E
Eric Blake 已提交
17931 17932 17933 17934
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
17935 17936
}

E
Eric Blake 已提交
17937 17938 17939 17940 17941 17942
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
17943
 * Returns option as long long
17944
 * See vshCommandOptInt()
17945
 */
17946 17947 17948
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
17949
{
E
Eric Blake 已提交
17950 17951
    vshCmdOpt *arg;
    int ret;
17952
    long long num;
17953 17954
    char *end_p = NULL;

E
Eric Blake 已提交
17955 17956 17957 17958 17959 17960 17961
    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;
17962
    }
E
Eric Blake 已提交
17963 17964 17965 17966 17967 17968 17969

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
17970 17971
}

E
Eric Blake 已提交
17972 17973 17974 17975 17976 17977 17978 17979 17980
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
17981 17982 17983 17984
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
17985 17986
    vshCmdOpt *arg;
    int ret;
17987 17988 17989
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
17990 17991 17992 17993 17994 17995 17996
    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;
17997
    }
E
Eric Blake 已提交
17998 17999 18000 18001 18002 18003 18004

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
18005 18006 18007
}


E
Eric Blake 已提交
18008 18009 18010 18011 18012 18013 18014 18015 18016
/**
 * 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 已提交
18017
 */
E
Eric Blake 已提交
18018
static bool
18019
vshCommandOptBool(const vshCmd *cmd, const char *name)
18020
{
E
Eric Blake 已提交
18021 18022 18023
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
18024 18025
}

E
Eric Blake 已提交
18026 18027 18028 18029 18030
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
18031 18032
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
18033
 *
18034
 * Requires that a VSH_OT_ARGV option be last in the
18035 18036
 * list of supported options in CMD->def->opts.
 */
18037 18038
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
18039
{
18040
    opt = opt ? opt->next : cmd->opts;
18041 18042

    while (opt) {
E
Eric Blake 已提交
18043
        if (opt->def->type == VSH_OT_ARGV) {
18044
            return opt;
18045 18046 18047 18048 18049 18050
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
18051 18052 18053 18054 18055 18056 18057 18058 18059 18060 18061 18062 18063 18064 18065 18066 18067 18068
/* 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)
18069
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
18070 18071 18072
                 cmd->def->name, optname);
    return found;
}
18073

K
Karel Zak 已提交
18074
static virDomainPtr
J
Jim Meyering 已提交
18075
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
18076
                      const char **name, int flag)
18077
{
K
Karel Zak 已提交
18078
    virDomainPtr dom = NULL;
18079
    const char *n = NULL;
K
Karel Zak 已提交
18080
    int id;
J
Jim Meyering 已提交
18081 18082 18083
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
18084

18085
    if (vshCommandOptString(cmd, optname, &n) <= 0)
18086 18087
        return NULL;

18088
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
18089 18090
             cmd->def->name, optname, n);

K
Karel Zak 已提交
18091 18092
    if (name)
        *name = n;
18093

K
Karel Zak 已提交
18094
    /* try it by ID */
18095
    if (flag & VSH_BYID) {
18096
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
18097 18098
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
18099 18100 18101
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
18102
    }
K
Karel Zak 已提交
18103
    /* try it by UUID */
18104
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
18105
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
18106
                 cmd->def->name, optname);
K
Karel Zak 已提交
18107
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
18108
    }
K
Karel Zak 已提交
18109
    /* try it by NAME */
18110
    if (dom==NULL && (flag & VSH_BYNAME)) {
18111
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
18112
                 cmd->def->name, optname);
K
Karel Zak 已提交
18113
        dom = virDomainLookupByName(ctl->conn, n);
18114
    }
K
Karel Zak 已提交
18115

18116
    if (!dom)
18117
        vshError(ctl, _("failed to get domain '%s'"), n);
18118

K
Karel Zak 已提交
18119 18120 18121
    return dom;
}

18122
static virNetworkPtr
J
Jim Meyering 已提交
18123
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
18124
                       const char **name, int flag)
18125 18126
{
    virNetworkPtr network = NULL;
18127
    const char *n = NULL;
J
Jim Meyering 已提交
18128 18129 18130
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
18131

18132
    if (vshCommandOptString(cmd, optname, &n) <= 0)
18133 18134
        return NULL;

18135
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
18136 18137 18138 18139 18140 18141
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
18142
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
18143
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
18144
                 cmd->def->name, optname);
18145 18146 18147 18148
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
18149
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
18150 18151 18152 18153 18154
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
18155
        vshError(ctl, _("failed to get network '%s'"), n);
18156 18157 18158 18159

    return network;
}

18160 18161 18162

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
18163
                        const char **name, int flag)
18164 18165
{
    virNWFilterPtr nwfilter = NULL;
18166
    const char *n = NULL;
18167 18168 18169 18170
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

18171
    if (vshCommandOptString(cmd, optname, &n) <= 0)
18172 18173
        return NULL;

18174
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
18175 18176 18177 18178 18179 18180 18181
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
18182
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
18183 18184 18185 18186 18187
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
18188
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
18189 18190 18191 18192 18193 18194 18195 18196 18197 18198
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

18199 18200
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
18201
                         const char *optname,
18202
                         const char **name, int flag)
18203 18204
{
    virInterfacePtr iface = NULL;
18205
    const char *n = NULL;
18206 18207 18208

    if (!optname)
       optname = "interface";
18209 18210 18211
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

18212
    if (vshCommandOptString(cmd, optname, &n) <= 0)
18213 18214
        return NULL;

18215
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
18216 18217 18218 18219 18220 18221
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
18222
    if ((flag & VSH_BYNAME)) {
18223
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
18224 18225 18226 18227 18228
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
18229
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
18230 18231 18232 18233 18234
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
18235
        vshError(ctl, _("failed to get interface '%s'"), n);
18236 18237 18238 18239

    return iface;
}

18240
static virStoragePoolPtr
18241
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
18242
                    const char **name, int flag)
18243 18244
{
    virStoragePoolPtr pool = NULL;
18245
    const char *n = NULL;
18246

18247
    if (vshCommandOptString(cmd, optname, &n) <= 0)
18248 18249
        return NULL;

18250
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
18251 18252 18253 18254 18255 18256
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
18257
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
18258
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
18259
                 cmd->def->name, optname);
18260 18261 18262
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
18263
    if (pool == NULL && (flag & VSH_BYNAME)) {
18264
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
18265 18266 18267 18268 18269
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
18270
        vshError(ctl, _("failed to get pool '%s'"), n);
18271 18272 18273 18274 18275

    return pool;
}

static virStorageVolPtr
18276
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
18277 18278
                   const char *optname,
                   const char *pooloptname,
18279
                   const char **name, int flag)
18280 18281 18282
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
18283
    const char *n = NULL, *p = NULL;
18284

18285
    if (vshCommandOptString(cmd, optname, &n) <= 0)
18286 18287
        return NULL;

18288
    if (pooloptname != NULL && vshCommandOptString(cmd, pooloptname, &p) < 0) {
18289
        vshError(ctl, "%s", _("missing option"));
18290
        return NULL;
18291
    }
18292 18293 18294 18295

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

18296
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
18297 18298 18299 18300 18301
             cmd->def->name, optname, n);

    if (name)
        *name = n;

18302
    /* try it by name */
18303
    if (pool && (flag & VSH_BYNAME)) {
18304
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
18305 18306 18307
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
18308
    /* try it by key */
18309
    if (vol == NULL && (flag & VSH_BYUUID)) {
18310
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
18311 18312 18313
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
18314
    /* try it by path */
18315
    if (vol == NULL && (flag & VSH_BYUUID)) {
18316
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
18317 18318 18319 18320
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

18321 18322 18323 18324
    if (!vol) {
        if (pool)
            vshError(ctl, _("failed to get vol '%s'"), n);
        else
18325 18326
            vshError(ctl, _("failed to get vol '%s', specifying --%s "
                            "might help"), n, pooloptname);
18327
    }
18328 18329 18330 18331 18332 18333 18334

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

18335
static virSecretPtr
18336
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
18337 18338
{
    virSecretPtr secret = NULL;
18339
    const char *n = NULL;
18340 18341 18342 18343 18344
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

18345
    if (vshCommandOptString(cmd, optname, &n) <= 0)
18346 18347
        return NULL;

18348 18349
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
18350 18351 18352 18353 18354 18355 18356

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
18357
        vshError(ctl, _("failed to get secret '%s'"), n);
18358 18359 18360 18361

    return secret;
}

K
Karel Zak 已提交
18362 18363 18364
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
18365
static bool
18366
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
18367
{
E
Eric Blake 已提交
18368
    bool ret = true;
18369 18370

    while (cmd) {
K
Karel Zak 已提交
18371
        struct timeval before, after;
18372
        bool enable_timing = ctl->timing;
18373

18374 18375
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
18376 18377
            vshReconnect(ctl);

18378
        if (enable_timing)
K
Karel Zak 已提交
18379
            GETTIMEOFDAY(&before);
18380

K
Karel Zak 已提交
18381 18382
        ret = cmd->def->handler(ctl, cmd);

18383
        if (enable_timing)
K
Karel Zak 已提交
18384
            GETTIMEOFDAY(&after);
18385

18386 18387 18388 18389 18390 18391 18392 18393 18394 18395
        /* try to automatically catch disconnections */
        if (!ret &&
            ((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))))
            disconnected++;

18396
        if (!ret)
J
John Levon 已提交
18397 18398
            virshReportError(ctl);

18399
        if (!ret && disconnected != 0)
18400 18401
            vshReconnect(ctl);

18402
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
18403 18404
            return ret;

18405
        if (enable_timing)
18406
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
18407 18408
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
18409
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
18410 18411 18412 18413 18414 18415
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
18416
 * Command parsing
K
Karel Zak 已提交
18417 18418 18419
 * ---------------
 */

18420 18421 18422 18423 18424 18425 18426 18427 18428 18429
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 已提交
18430
    /* vshCommandStringGetArg() */
18431
    char *pos;
L
Lai Jiangshan 已提交
18432 18433 18434
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
18435 18436
} vshCommandParser;

E
Eric Blake 已提交
18437
static bool
18438
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
18439
{
K
Karel Zak 已提交
18440 18441 18442
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
18443

K
Karel Zak 已提交
18444 18445 18446 18447
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
18448

18449
    while (1) {
K
Karel Zak 已提交
18450
        vshCmdOpt *last = NULL;
18451
        const vshCmdDef *cmd = NULL;
18452
        vshCommandToken tk;
L
Lai Jiangshan 已提交
18453
        bool data_only = false;
18454 18455 18456
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
18457

K
Karel Zak 已提交
18458
        first = NULL;
18459

18460
        while (1) {
18461
            const vshCmdOptDef *opt = NULL;
18462

K
Karel Zak 已提交
18463
            tkdata = NULL;
18464
            tk = parser->getNextArg(ctl, parser, &tkdata);
18465 18466

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
18467
                goto syntaxError;
H
Hu Tao 已提交
18468 18469
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
18470
                break;
H
Hu Tao 已提交
18471
            }
18472 18473

            if (cmd == NULL) {
K
Karel Zak 已提交
18474 18475
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
18476
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
18477
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
18478
                }
18479 18480 18481 18482 18483 18484 18485
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
18486
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
18487 18488 18489 18490
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
18491
                char *optstr = strchr(tkdata + 2, '=');
18492 18493
                int opt_index;

18494 18495 18496 18497
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
18498
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
18499
                                               &opts_seen, &opt_index))) {
18500
                    VIR_FREE(optstr);
K
Karel Zak 已提交
18501 18502
                    goto syntaxError;
                }
18503
                VIR_FREE(tkdata);
K
Karel Zak 已提交
18504 18505 18506

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
18507 18508 18509
                    if (optstr)
                        tkdata = optstr;
                    else
18510
                        tk = parser->getNextArg(ctl, parser, &tkdata);
18511
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
18512
                        goto syntaxError;
18513
                    if (tk != VSH_TK_ARG) {
18514
                        vshError(ctl,
18515
                                 _("expected syntax: --%s <%s>"),
18516 18517
                                 opt->name,
                                 opt->type ==
18518
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
18519 18520
                        goto syntaxError;
                    }
18521 18522
                    if (opt->type != VSH_OT_ARGV)
                        opts_need_arg &= ~(1 << opt_index);
18523 18524 18525 18526 18527 18528 18529 18530
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
18531
                }
L
Lai Jiangshan 已提交
18532 18533 18534 18535
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
18536
            } else {
L
Lai Jiangshan 已提交
18537
get_data:
18538 18539
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
18540
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
18541 18542 18543 18544 18545
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
18546
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
18547

K
Karel Zak 已提交
18548 18549 18550 18551
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
18552

K
Karel Zak 已提交
18553 18554 18555 18556 18557
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
18558

18559
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
18560 18561
                         cmd->name,
                         opt->name,
18562 18563
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
18564 18565
            }
        }
18566

D
Daniel Veillard 已提交
18567
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
18568
        if (cmd) {
18569
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
18570

K
Karel Zak 已提交
18571 18572 18573 18574
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

18575
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
18576
                VIR_FREE(c);
18577
                goto syntaxError;
18578
            }
18579

K
Karel Zak 已提交
18580 18581 18582 18583 18584 18585
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
18586 18587 18588

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
18589
    }
18590

E
Eric Blake 已提交
18591
    return true;
K
Karel Zak 已提交
18592

18593
 syntaxError:
18594
    if (ctl->cmd) {
K
Karel Zak 已提交
18595
        vshCommandFree(ctl->cmd);
18596 18597
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
18598 18599
    if (first)
        vshCommandOptFree(first);
18600
    VIR_FREE(tkdata);
E
Eric Blake 已提交
18601
    return false;
K
Karel Zak 已提交
18602 18603
}

18604 18605 18606 18607 18608 18609 18610 18611 18612 18613 18614 18615 18616 18617 18618 18619 18620 18621
/* --------------------
 * 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 已提交
18622 18623
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
18624 18625 18626 18627
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
18628
        return false;
18629 18630 18631 18632 18633 18634 18635 18636 18637 18638 18639 18640 18641 18642 18643 18644 18645 18646 18647 18648 18649 18650 18651 18652 18653 18654 18655 18656 18657 18658 18659 18660 18661 18662 18663 18664 18665 18666 18667 18668 18669 18670 18671 18672 18673 18674 18675 18676 18677 18678 18679 18680 18681 18682 18683 18684 18685 18686 18687 18688 18689 18690 18691 18692 18693 18694 18695 18696 18697 18698 18699 18700

    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 已提交
18701 18702
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
18703 18704 18705 18706
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
18707
        return false;
18708 18709 18710 18711 18712 18713

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
18714
/* ---------------
18715
 * Misc utils
K
Karel Zak 已提交
18716 18717
 * ---------------
 */
18718 18719 18720 18721 18722 18723 18724 18725 18726 18727 18728 18729 18730 18731 18732 18733 18734 18735 18736 18737 18738 18739 18740 18741 18742 18743 18744 18745
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 已提交
18746
static const char *
18747 18748
vshDomainStateToString(int state)
{
18749 18750
    /* Can't use virDomainStateTypeToString, because we want to mark
     * strings for translation.  */
18751
    switch ((virDomainState) state) {
18752
    case VIR_DOMAIN_RUNNING:
18753
        return N_("running");
18754
    case VIR_DOMAIN_BLOCKED:
18755
        return N_("idle");
18756
    case VIR_DOMAIN_PAUSED:
18757
        return N_("paused");
18758
    case VIR_DOMAIN_SHUTDOWN:
18759
        return N_("in shutdown");
18760
    case VIR_DOMAIN_SHUTOFF:
18761
        return N_("shut off");
18762
    case VIR_DOMAIN_CRASHED:
18763
        return N_("crashed");
18764
    case VIR_DOMAIN_NOSTATE:
18765
    default:
18766
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
18767
    }
18768
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
18769 18770
}

18771 18772 18773 18774 18775 18776 18777
static const char *
vshDomainStateReasonToString(int state, int reason)
{
    switch ((virDomainState) state) {
    case VIR_DOMAIN_NOSTATE:
        switch ((virDomainNostateReason) reason) {
        case VIR_DOMAIN_NOSTATE_UNKNOWN:
18778
        case VIR_DOMAIN_NOSTATE_LAST:
18779 18780 18781 18782 18783 18784 18785 18786 18787 18788 18789 18790 18791 18792 18793 18794 18795 18796 18797 18798 18799
            ;
        }
        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:
18800
        case VIR_DOMAIN_RUNNING_LAST:
18801 18802 18803 18804 18805 18806 18807
            ;
        }
        break;

    case VIR_DOMAIN_BLOCKED:
        switch ((virDomainBlockedReason) reason) {
        case VIR_DOMAIN_BLOCKED_UNKNOWN:
18808
        case VIR_DOMAIN_BLOCKED_LAST:
18809 18810 18811 18812 18813 18814 18815 18816 18817 18818 18819 18820 18821 18822 18823 18824 18825 18826 18827 18828
            ;
        }
        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");
18829 18830
        case VIR_DOMAIN_PAUSED_SHUTTING_DOWN:
            return N_("shutting down");
18831
        case VIR_DOMAIN_PAUSED_UNKNOWN:
18832
        case VIR_DOMAIN_PAUSED_LAST:
18833 18834 18835 18836 18837 18838 18839 18840 18841
            ;
        }
        break;

    case VIR_DOMAIN_SHUTDOWN:
        switch ((virDomainShutdownReason) reason) {
        case VIR_DOMAIN_SHUTDOWN_USER:
            return N_("user");
        case VIR_DOMAIN_SHUTDOWN_UNKNOWN:
18842
        case VIR_DOMAIN_SHUTDOWN_LAST:
18843 18844 18845 18846 18847 18848 18849 18850 18851 18852 18853 18854 18855 18856 18857 18858 18859 18860 18861 18862 18863
            ;
        }
        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:
18864
        case VIR_DOMAIN_SHUTOFF_LAST:
18865 18866 18867 18868 18869 18870 18871
            ;
        }
        break;

    case VIR_DOMAIN_CRASHED:
        switch ((virDomainCrashedReason) reason) {
        case VIR_DOMAIN_CRASHED_UNKNOWN:
18872
        case VIR_DOMAIN_CRASHED_LAST:
18873 18874 18875
            ;
        }
        break;
18876

18877
    case VIR_DOMAIN_LAST:
18878
        ;
18879 18880 18881 18882 18883
    }

    return N_("unknown");
}

18884 18885 18886 18887 18888 18889 18890 18891 18892 18893 18894 18895 18896 18897 18898 18899 18900 18901 18902 18903 18904 18905 18906 18907 18908 18909 18910 18911 18912 18913 18914 18915 18916 18917 18918 18919 18920 18921 18922 18923 18924 18925 18926 18927 18928 18929 18930 18931 18932 18933 18934 18935 18936 18937 18938 18939 18940 18941 18942
/* extract description or title from domain xml */
static char *
vshGetDomainDescription(vshControl *ctl, virDomainPtr dom, bool title,
                        unsigned int flags)
{
    char *desc = NULL;
    char *domxml = NULL;
    virErrorPtr err = NULL;
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    int type;

    if (title)
        type = VIR_DOMAIN_METADATA_TITLE;
    else
        type = VIR_DOMAIN_METADATA_DESCRIPTION;

    if ((desc = virDomainGetMetadata(dom, type, NULL, flags))) {
        return desc;
    } else {
        err = virGetLastError();

        if (err && err->code == VIR_ERR_NO_DOMAIN_METADATA) {
            desc = vshStrdup(ctl, "");
            virResetLastError();
            return desc;
        }

        if (err && err->code != VIR_ERR_NO_SUPPORT)
            return desc;
    }

    /* fall back to xml */
    /* get domain's xml description and extract the title/description */
    if (!(domxml = virDomainGetXMLDesc(dom, flags))) {
        vshError(ctl, "%s", _("Failed to retrieve domain XML"));
        goto cleanup;
    }
    doc = virXMLParseStringCtxt(domxml, _("(domain_definition)"), &ctxt);
    if (!doc) {
        vshError(ctl, "%s", _("Couldn't parse domain XML"));
        goto cleanup;
    }
    if (title)
        desc = virXPathString("string(./title[1])", ctxt);
    else
        desc = virXPathString("string(./description[1])", ctxt);

    if (!desc)
        desc = vshStrdup(ctl, "");

cleanup:
    VIR_FREE(domxml);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(doc);

    return desc;
}

18943 18944
/* Return a non-NULL string representation of a typed parameter; exit
 * if we are out of memory.  */
18945 18946 18947 18948 18949 18950 18951 18952 18953 18954 18955 18956 18957 18958 18959 18960 18961 18962 18963 18964 18965 18966 18967 18968 18969 18970 18971 18972 18973 18974 18975
static char *
vshGetTypedParamValue(vshControl *ctl, virTypedParameterPtr item)
{
    int ret = 0;
    char *str = NULL;

    switch(item->type) {
    case VIR_TYPED_PARAM_INT:
        ret = virAsprintf(&str, "%d", item->value.i);
        break;

    case VIR_TYPED_PARAM_UINT:
        ret = virAsprintf(&str, "%u", item->value.ui);
        break;

    case VIR_TYPED_PARAM_LLONG:
        ret = virAsprintf(&str, "%lld", item->value.l);
        break;

    case VIR_TYPED_PARAM_ULLONG:
        ret = virAsprintf(&str, "%llu", item->value.ul);
        break;

    case VIR_TYPED_PARAM_DOUBLE:
        ret = virAsprintf(&str, "%f", item->value.d);
        break;

    case VIR_TYPED_PARAM_BOOLEAN:
        ret = virAsprintf(&str, "%s", item->value.b ? _("yes") : _("no"));
        break;

18976 18977 18978 18979
    case VIR_TYPED_PARAM_STRING:
        str = vshStrdup(ctl, item->value.s);
        break;

18980
    default:
18981
        vshError(ctl, _("unimplemented parameter type %d"), item->type);
18982 18983
    }

18984
    if (ret < 0) {
18985
        vshError(ctl, "%s", _("Out of memory"));
18986 18987
        exit(EXIT_FAILURE);
    }
18988 18989 18990 18991 18992 18993 18994 18995 18996 18997 18998 18999 19000 19001 19002 19003 19004 19005 19006 19007 19008 19009 19010
    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;
}

19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022
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");
19023 19024
    default:
        ;
19025 19026 19027 19028 19029
    }

    return N_("unknown");
}

19030 19031 19032 19033
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
19034
    case VIR_VCPU_OFFLINE:
19035
        return N_("offline");
19036
    case VIR_VCPU_BLOCKED:
19037
        return N_("idle");
19038
    case VIR_VCPU_RUNNING:
19039
        return N_("running");
19040
    default:
19041
        ;/*FALLTHROUGH*/
19042
    }
19043
    return N_("no state");
19044 19045
}

E
Eric Blake 已提交
19046
static bool
19047
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
19048
{
19049 19050
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
19051 19052
     */
    if (!conn) {
19053
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
19054
        return false;
K
Karel Zak 已提交
19055
    }
E
Eric Blake 已提交
19056
    return true;
K
Karel Zak 已提交
19057 19058
}

K
Karel Zak 已提交
19059
static void
19060
vshDebug(vshControl *ctl, int level, const char *format, ...)
19061
{
K
Karel Zak 已提交
19062
    va_list ap;
19063
    char *str;
K
Karel Zak 已提交
19064

19065 19066 19067 19068 19069 19070 19071
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

19072
    va_start(ap, format);
19073
    vshOutputLogFile(ctl, level, format, ap);
19074 19075
    va_end(ap);

K
Karel Zak 已提交
19076
    va_start(ap, format);
19077 19078 19079 19080 19081
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
19082
    va_end(ap);
19083 19084
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
19085 19086 19087
}

static void
19088
vshPrintExtra(vshControl *ctl, const char *format, ...)
19089
{
K
Karel Zak 已提交
19090
    va_list ap;
19091
    char *str;
19092

19093
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
19094
        return;
19095

K
Karel Zak 已提交
19096
    va_start(ap, format);
19097 19098 19099 19100 19101
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
19102
    va_end(ap);
19103
    fputs(str, stdout);
19104
    VIR_FREE(str);
K
Karel Zak 已提交
19105 19106
}

K
Karel Zak 已提交
19107

K
Karel Zak 已提交
19108
static void
19109
vshError(vshControl *ctl, const char *format, ...)
19110
{
K
Karel Zak 已提交
19111
    va_list ap;
19112
    char *str;
19113

19114 19115 19116 19117 19118
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
19119

19120 19121 19122 19123
    /* 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);
19124
    fputs(_("error: "), stderr);
19125

K
Karel Zak 已提交
19126
    va_start(ap, format);
19127 19128 19129
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
19130 19131
    va_end(ap);

19132
    fprintf(stderr, "%s\n", NULLSTR(str));
19133
    fflush(stderr);
19134
    VIR_FREE(str);
K
Karel Zak 已提交
19135 19136
}

19137

J
Jiri Denemark 已提交
19138 19139 19140 19141 19142
static void
vshEventLoop(void *opaque)
{
    vshControl *ctl = opaque;

19143 19144 19145 19146 19147 19148 19149 19150 19151 19152
    while (1) {
        bool quit;
        virMutexLock(&ctl->lock);
        quit = ctl->quit;
        virMutexUnlock(&ctl->lock);

        if (quit)
            break;

        if (virEventRunDefaultImpl() < 0)
J
Jiri Denemark 已提交
19153 19154 19155 19156 19157
            virshReportError(ctl);
    }
}


K
Karel Zak 已提交
19158
/*
19159
 * Initialize connection.
K
Karel Zak 已提交
19160
 */
E
Eric Blake 已提交
19161
static bool
19162
vshInit(vshControl *ctl)
19163
{
19164 19165
    char *debugEnv;

K
Karel Zak 已提交
19166
    if (ctl->conn)
E
Eric Blake 已提交
19167
        return false;
K
Karel Zak 已提交
19168

J
Jiri Denemark 已提交
19169
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
19170 19171 19172
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
19173 19174 19175
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
19176 19177
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
19178 19179
            } else {
                ctl->debug = debug;
19180 19181 19182 19183 19184 19185 19186 19187 19188 19189 19190 19191
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

19192 19193
    vshOpenLogFile(ctl);

19194 19195
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
19196

19197 19198 19199
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

19200
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
19201
        return false;
19202

J
Jiri Denemark 已提交
19203 19204 19205 19206
    if (virThreadCreate(&ctl->eventLoop, true, vshEventLoop, ctl) < 0)
        return false;
    ctl->eventLoopStarted = true;

19207 19208 19209 19210
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
19211

19212 19213 19214 19215 19216 19217 19218 19219 19220 19221 19222
        /* 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;
        }
19223
    }
K
Karel Zak 已提交
19224

E
Eric Blake 已提交
19225
    return true;
K
Karel Zak 已提交
19226 19227
}

19228 19229
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

19230 19231 19232 19233 19234 19235 19236 19237 19238 19239 19240 19241 19242 19243 19244 19245 19246 19247 19248
/**
 * 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:
19249
                vshError(ctl, "%s",
J
Jim Meyering 已提交
19250
                         _("failed to get the log file information"));
19251
                exit(EXIT_FAILURE);
19252 19253 19254
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
19255 19256
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
19257 19258 19259 19260
        }
    }

    /* log file open */
19261
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
19262
        vshError(ctl, "%s",
J
Jim Meyering 已提交
19263
                 _("failed to open the log file. check the log file path"));
19264
        exit(EXIT_FAILURE);
19265 19266 19267 19268 19269 19270 19271 19272 19273
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
19274 19275
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
19276
{
19277 19278 19279
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
19280 19281 19282 19283 19284 19285 19286 19287 19288 19289 19290 19291 19292 19293
    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);
19294
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
19295 19296 19297 19298 19299 19300
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
19301 19302
                      SIGN_NAME,
                      (int) getpid());
19303 19304 19305 19306 19307 19308 19309 19310 19311 19312 19313 19314 19315 19316 19317 19318 19319 19320 19321 19322
    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;
    }
19323 19324 19325
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
19326

19327 19328
    if (virBufferError(&buf))
        goto error;
19329

19330 19331 19332 19333 19334
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
19335
    }
19336

19337 19338 19339 19340 19341 19342 19343 19344 19345 19346 19347
    /* 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);
19348 19349 19350 19351 19352 19353 19354 19355 19356 19357 19358
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
19359 19360 19361
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
19362 19363 19364
    }

    if (ctl->logfile) {
19365
        VIR_FREE(ctl->logfile);
19366 19367 19368 19369
        ctl->logfile = NULL;
    }
}

19370
#ifdef USE_READLINE
19371

K
Karel Zak 已提交
19372 19373 19374 19375 19376
/* -----------------
 * Readline stuff
 * -----------------
 */

19377
/*
K
Karel Zak 已提交
19378 19379
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
19380
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
19381 19382
 */
static char *
19383 19384
vshReadlineCommandGenerator(const char *text, int state)
{
19385
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
19386
    const char *name;
19387 19388
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
19389 19390

    if (!state) {
19391 19392
        grp_list_index = 0;
        cmd_list_index = 0;
19393
        len = strlen(text);
K
Karel Zak 已提交
19394 19395
    }

19396 19397
    grp = cmdGroups;

K
Karel Zak 已提交
19398
    /* Return the next name which partially matches from the
19399
     * command list.
K
Karel Zak 已提交
19400
     */
19401 19402 19403 19404 19405 19406 19407 19408 19409 19410 19411 19412 19413 19414
    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 已提交
19415 19416 19417 19418 19419 19420 19421
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
19422 19423
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
19424
    static int list_index, len;
19425
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
19426
    const char *name;
K
Karel Zak 已提交
19427 19428 19429 19430 19431 19432 19433 19434 19435

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

19436
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
19437
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
19438 19439 19440

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
19441
        len = strlen(text);
19442
        VIR_FREE(cmdname);
K
Karel Zak 已提交
19443 19444 19445 19446
    }

    if (!cmd)
        return NULL;
19447

19448 19449 19450
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
19451
    while ((name = cmd->opts[list_index].name)) {
19452
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
19453
        char *res;
19454

K
Karel Zak 已提交
19455
        list_index++;
19456

19457
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
19458 19459
            /* ignore non --option */
            continue;
19460

K
Karel Zak 已提交
19461
        if (len > 2) {
19462
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
19463 19464
                continue;
        }
19465
        res = vshMalloc(NULL, strlen(name) + 3);
19466
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
19467 19468 19469 19470 19471 19472 19473 19474
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
19475 19476 19477
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
19478 19479
    char **matches = (char **) NULL;

19480
    if (start == 0)
K
Karel Zak 已提交
19481
        /* command name generator */
19482
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
19483 19484
    else
        /* commands options */
19485
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
19486 19487 19488 19489
    return matches;
}


19490 19491
static int
vshReadlineInit(vshControl *ctl)
19492
{
19493 19494
    char *userdir = NULL;

K
Karel Zak 已提交
19495 19496 19497 19498 19499
    /* 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;
19500 19501 19502

    /* Limit the total size of the history buffer */
    stifle_history(500);
19503 19504

    /* Prepare to read/write history from/to the ~/.virsh/history file */
19505
    userdir = virGetUserDirectory(getuid());
19506

19507 19508
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
19509
        return -1;
19510
    }
19511 19512 19513

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
19514
        VIR_FREE(userdir);
19515 19516 19517 19518 19519
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
19520
        VIR_FREE(userdir);
19521 19522 19523
        return -1;
    }

19524
    VIR_FREE(userdir);
19525 19526 19527 19528 19529 19530 19531 19532 19533 19534 19535 19536 19537 19538 19539 19540 19541 19542

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

19543 19544
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
19545 19546
}

19547 19548 19549 19550 19551 19552
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

19553
#else /* !USE_READLINE */
19554

19555 19556 19557 19558 19559 19560 19561
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

19562
static void
19563
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
19564 19565 19566 19567 19568 19569 19570 19571 19572 19573 19574 19575 19576 19577 19578 19579 19580 19581 19582 19583 19584 19585 19586
{
    /* 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);
}

19587
#endif /* !USE_READLINE */
19588

19589 19590 19591 19592 19593 19594
static void
vshDeinitTimer(int timer ATTRIBUTE_UNUSED, void *opaque ATTRIBUTE_UNUSED)
{
    /* nothing to be done here */
}

K
Karel Zak 已提交
19595
/*
J
Jim Meyering 已提交
19596
 * Deinitialize virsh
K
Karel Zak 已提交
19597
 */
E
Eric Blake 已提交
19598
static bool
19599
vshDeinit(vshControl *ctl)
19600
{
19601
    vshReadlineDeinit(ctl);
19602
    vshCloseLogFile(ctl);
19603
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
19604
    if (ctl->conn) {
19605 19606 19607
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
19608 19609
        }
    }
D
Daniel P. Berrange 已提交
19610 19611
    virResetLastError();

J
Jiri Denemark 已提交
19612
    if (ctl->eventLoopStarted) {
19613 19614 19615 19616
        int timer;

        virMutexLock(&ctl->lock);
        ctl->quit = true;
J
Jiri Denemark 已提交
19617
        /* HACK: Add a dummy timeout to break event loop */
19618 19619 19620 19621 19622
        timer = virEventAddTimeout(0, vshDeinitTimer, NULL, NULL);
        virMutexUnlock(&ctl->lock);

        virThreadJoin(&ctl->eventLoop);

J
Jiri Denemark 已提交
19623 19624 19625 19626 19627 19628
        if (timer != -1)
            virEventRemoveTimeout(timer);

        ctl->eventLoopStarted = false;
    }

19629 19630
    virMutexDestroy(&ctl->lock);

E
Eric Blake 已提交
19631
    return true;
K
Karel Zak 已提交
19632
}
19633

K
Karel Zak 已提交
19634 19635 19636 19637
/*
 * Print usage
 */
static void
19638
vshUsage(void)
19639
{
19640
    const vshCmdGrp *grp;
19641
    const vshCmdDef *cmd;
19642

L
Lai Jiangshan 已提交
19643 19644
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
19645
                      "  options:\n"
19646
                      "    -c | --connect=URI      hypervisor connection URI\n"
19647
                      "    -r | --readonly         connect readonly\n"
19648
                      "    -d | --debug=NUM        debug level [0-4]\n"
19649 19650 19651
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
19652 19653 19654 19655 19656
                      "    -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"
19657
                      "  commands (non interactive mode):\n\n"), progname, progname);
19658

19659 19660
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
19661

19662 19663 19664 19665 19666 19667 19668 19669 19670
        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"));
19671 19672 19673
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
19674 19675
}

19676 19677 19678 19679 19680 19681 19682 19683 19684 19685
/*
 * 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 已提交
19686 19687
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
19688 19689 19690 19691 19692 19693 19694 19695 19696 19697 19698 19699 19700 19701 19702 19703 19704 19705 19706 19707 19708 19709 19710 19711 19712 19713 19714 19715 19716 19717 19718 19719 19720 19721 19722
#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 已提交
19723
    vshPrint(ctl, "%s", _(" Networking:"));
19724 19725 19726 19727 19728 19729 19730 19731 19732 19733 19734 19735 19736 19737 19738 19739 19740 19741 19742 19743 19744 19745 19746 19747 19748 19749
#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 已提交
19750
    vshPrint(ctl, "%s", _(" Storage:"));
19751 19752 19753 19754 19755 19756 19757 19758 19759 19760 19761 19762 19763 19764 19765 19766 19767 19768 19769 19770 19771 19772 19773
#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 已提交
19774
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
19775
#ifdef WITH_SECDRIVER_APPARMOR
19776 19777 19778 19779 19780 19781 19782 19783 19784 19785 19786 19787 19788 19789 19790 19791 19792 19793 19794 19795 19796 19797 19798
    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 已提交
19799 19800 19801 19802
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
19803
static bool
19804
vshParseArgv(vshControl *ctl, int argc, char **argv)
19805
{
19806
    bool help = false;
19807
    int arg, len;
K
Karel Zak 已提交
19808
    struct option opt[] = {
E
Eric Blake 已提交
19809 19810 19811 19812 19813 19814 19815 19816
        {"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'},
19817
        {"escape", required_argument, NULL, 'e'},
E
Eric Blake 已提交
19818
        {NULL, 0, NULL, 0}
19819 19820
    };

19821 19822 19823
    /* 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. */
19824
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:e:", opt, NULL)) != -1) {
19825
        switch (arg) {
19826
        case 'd':
D
Daniel Veillard 已提交
19827
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
19828
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
19829 19830
                exit(EXIT_FAILURE);
            }
19831 19832
            break;
        case 'h':
19833
            help = true;
19834 19835
            break;
        case 'q':
E
Eric Blake 已提交
19836
            ctl->quiet = true;
19837 19838
            break;
        case 't':
E
Eric Blake 已提交
19839
            ctl->timing = true;
19840 19841 19842 19843
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
19844 19845 19846 19847 19848 19849
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
19850 19851 19852
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
19853
        case 'r':
E
Eric Blake 已提交
19854
            ctl->readonly = true;
19855
            break;
19856 19857 19858
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
19859 19860 19861 19862 19863 19864 19865 19866 19867 19868 19869 19870
        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;
19871
        default:
19872 19873
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
19874 19875 19876 19877
        }
    }

    if (help) {
19878 19879
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
19880 19881
            exit(EXIT_FAILURE);
        }
19882 19883 19884

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
19885
        exit(EXIT_SUCCESS);
19886 19887
    }

19888
    if (argc > optind) {
K
Karel Zak 已提交
19889
        /* parse command */
E
Eric Blake 已提交
19890
        ctl->imode = false;
19891
        if (argc - optind == 1) {
19892
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
19893
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
19894
        } else {
19895
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
19896 19897
        }
    }
E
Eric Blake 已提交
19898
    return true;
K
Karel Zak 已提交
19899 19900
}

19901 19902 19903 19904
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
19905
    char *defaultConn;
E
Eric Blake 已提交
19906
    bool ret = true;
K
Karel Zak 已提交
19907

19908 19909 19910
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
19911
    ctl->debug = VSH_DEBUG_DEFAULT;
19912 19913
    ctl->escapeChar = CTRL_CLOSE_BRACKET;

19914

19915 19916
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
19917
        /* failure to setup locale is not fatal */
19918
    }
19919
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
19920
        perror("bindtextdomain");
E
Eric Blake 已提交
19921
        return EXIT_FAILURE;
19922
    }
19923
    if (!textdomain(PACKAGE)) {
19924
        perror("textdomain");
E
Eric Blake 已提交
19925
        return EXIT_FAILURE;
19926 19927
    }

19928 19929 19930 19931 19932
    if (virMutexInit(&ctl->lock) < 0) {
        vshError(ctl, "%s", _("Failed to initialize mutex"));
        return EXIT_FAILURE;
    }

19933 19934 19935 19936 19937
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

19938
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
19939 19940 19941
        progname = argv[0];
    else
        progname++;
19942

19943
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
19944
        ctl->name = vshStrdup(ctl, defaultConn);
19945 19946
    }

D
Daniel P. Berrange 已提交
19947 19948
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
19949
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
19950
    }
19951

D
Daniel P. Berrange 已提交
19952 19953
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
19954
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
19955
    }
19956

K
Karel Zak 已提交
19957
    if (!ctl->imode) {
19958
        ret = vshCommandRun(ctl, ctl->cmd);
19959
    } else {
K
Karel Zak 已提交
19960 19961
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
19962
            vshPrint(ctl,
19963
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
19964
                     progname);
J
Jim Meyering 已提交
19965
            vshPrint(ctl, "%s",
19966
                     _("Type:  'help' for help with commands\n"
19967
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
19968
        }
19969 19970 19971 19972 19973 19974

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
19975
        do {
19976
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
19977
            ctl->cmdstr =
19978
                vshReadline(ctl, prompt);
19979 19980
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
19981
            if (*ctl->cmdstr) {
19982
#if USE_READLINE
K
Karel Zak 已提交
19983
                add_history(ctl->cmdstr);
19984
#endif
19985
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
19986 19987
                    vshCommandRun(ctl, ctl->cmd);
            }
19988
            VIR_FREE(ctl->cmdstr);
19989
        } while (ctl->imode);
K
Karel Zak 已提交
19990

19991 19992
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
19993
    }
19994

K
Karel Zak 已提交
19995 19996
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
19997
}