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

13
#include <config.h>
14

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

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

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

46
#include "internal.h"
47
#include "virterror_internal.h"
48
#include "base64.h"
49
#include "buf.h"
50
#include "console.h"
51
#include "util.h"
52
#include "memory.h"
53
#include "xml.h"
54
#include "libvirt/libvirt-qemu.h"
55
#include "files.h"
56
#include "event_poll.h"
57
#include "configmake.h"
58
#include "threads.h"
E
Eric Blake 已提交
59
#include "command.h"
60
#include "count-one-bits.h"
K
Karel Zak 已提交
61 62 63

static char *progname;

64 65
#define VIRSH_MAX_XML_FILE 10*1024*1024

K
Karel Zak 已提交
66 67 68 69 70 71 72 73
#define VSH_PROMPT_RW    "virsh # "
#define VSH_PROMPT_RO    "virsh > "

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

74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
/**
 * 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 已提交
91
 * Indicates the level of a log message
92 93 94 95 96 97 98 99 100
 */
typedef enum {
    VSH_ERR_DEBUG = 0,
    VSH_ERR_INFO,
    VSH_ERR_NOTICE,
    VSH_ERR_WARNING,
    VSH_ERR_ERROR
} vshErrorLevel;

J
Jiri Denemark 已提交
101 102
#define VSH_DEBUG_DEFAULT VSH_ERR_ERROR

K
Karel Zak 已提交
103 104 105 106 107
/*
 * virsh command line grammar:
 *
 *    command_line    =     <command>\n | <command>; <command>; ...
 *
E
Eric Blake 已提交
108
 *    command         =    <keyword> <option> [--] <data>
K
Karel Zak 已提交
109 110 111 112 113
 *
 *    option          =     <bool_option> | <int_option> | <string_option>
 *    data            =     <string>
 *
 *    bool_option     =     --optionname
E
Eric Blake 已提交
114 115
 *    int_option      =     --optionname <number> | --optionname=<number>
 *    string_option   =     --optionname <string> | --optionname=<string>
116
 *
E
Eric Blake 已提交
117
 *    keyword         =     [a-zA-Z][a-zA-Z-]*
118
 *    number          =     [0-9]+
E
Eric Blake 已提交
119
 *    string          =     ('[^']*'|"([^\\"]|\\.)*"|([^ \t\n\\'"]|\\.))+
K
Karel Zak 已提交
120 121 122 123
 *
 */

/*
124
 * vshCmdOptType - command option type
125
 */
K
Karel Zak 已提交
126
typedef enum {
127 128 129
    VSH_OT_BOOL,     /* optional boolean option */
    VSH_OT_STRING,   /* optional string option */
    VSH_OT_INT,      /* optional or mandatory int option */
130
    VSH_OT_DATA,     /* string data (as non-option) */
131
    VSH_OT_ARGV      /* remaining arguments */
K
Karel Zak 已提交
132 133
} vshCmdOptType;

134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
/*
 * 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 已提交
150 151 152
/*
 * Command Option Flags
 */
E
Eric Blake 已提交
153 154 155 156
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 已提交
157
    VSH_OFLAG_REQ_OPT  = (1 << 2), /* --optionname required */
E
Eric Blake 已提交
158
};
K
Karel Zak 已提交
159 160 161 162 163 164

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

/*
E
Eric Blake 已提交
165 166 167 168 169
 * 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 已提交
170
 */
171
typedef struct {
E
Eric Blake 已提交
172 173
    const char *name;           /* name of information, or NULL for list end */
    const char *data;           /* non-NULL information */
K
Karel Zak 已提交
174 175 176 177 178
} vshCmdInfo;

/*
 * vshCmdOptDef - command option definition
 */
179
typedef struct {
E
Eric Blake 已提交
180
    const char *name;           /* the name of option, or NULL for list end */
181 182
    vshCmdOptType type;         /* option type */
    int flag;                   /* flags */
E
Eric Blake 已提交
183
    const char *help;           /* non-NULL help string */
K
Karel Zak 已提交
184 185 186 187
} vshCmdOptDef;

/*
 * vshCmdOpt - command options
E
Eric Blake 已提交
188 189 190
 *
 * After parsing a command, all arguments to the command have been
 * collected into a list of these objects.
K
Karel Zak 已提交
191 192
 */
typedef struct vshCmdOpt {
E
Eric Blake 已提交
193 194
    const vshCmdOptDef *def;    /* non-NULL pointer to option definition */
    char *data;                 /* allocated data, or NULL for bool option */
195
    struct vshCmdOpt *next;
K
Karel Zak 已提交
196 197
} vshCmdOpt;

198 199 200 201 202 203 204
/*
 * Command Usage Flags
 */
enum {
    VSH_CMD_FLAG_NOCONNECT = (1 << 0),  /* no prior connection needed */
};

K
Karel Zak 已提交
205 206 207
/*
 * vshCmdDef - command definition
 */
208
typedef struct {
E
Eric Blake 已提交
209
    const char *name;           /* name of command, or NULL for list end */
E
Eric Blake 已提交
210
    bool (*handler) (vshControl *, const vshCmd *);    /* command handler */
211 212
    const vshCmdOptDef *opts;   /* definition of command options */
    const vshCmdInfo *info;     /* details about command */
213
    unsigned int flags;         /* bitwise OR of VSH_CMD_FLAG */
K
Karel Zak 已提交
214 215 216 217 218 219
} vshCmdDef;

/*
 * vshCmd - parsed command
 */
typedef struct __vshCmd {
220
    const vshCmdDef *def;       /* command definition */
221 222
    vshCmdOpt *opts;            /* list of command arguments */
    struct __vshCmd *next;      /* next command */
K
Karel Zak 已提交
223 224 225 226 227 228
} __vshCmd;

/*
 * vshControl
 */
typedef struct __vshControl {
K
Karel Zak 已提交
229
    char *name;                 /* connection name */
230
    virConnectPtr conn;         /* connection to hypervisor (MAY BE NULL) */
231 232
    vshCmd *cmd;                /* the current command */
    char *cmdstr;               /* string with command */
E
Eric Blake 已提交
233 234
    bool imode;                 /* interactive mode? */
    bool quiet;                 /* quiet mode */
235
    int debug;                  /* print debug messages? */
E
Eric Blake 已提交
236 237
    bool timing;                /* print timing info? */
    bool readonly;              /* connect readonly (first time only, not
238 239
                                 * during explicit connect command)
                                 */
240 241
    char *logfile;              /* log file name */
    int log_fd;                 /* log file descriptor */
242 243
    char *historydir;           /* readline history directory name */
    char *historyfile;          /* readline history file name */
244 245
    bool useGetInfo;            /* must use virDomainGetInfo, since
                                   virDomainGetState is not supported */
K
Karel Zak 已提交
246
} __vshControl;
247

248
typedef struct vshCmdGrp {
E
Eric Blake 已提交
249
    const char *name;    /* name of group, or NULL for list end */
250 251 252
    const char *keyword; /* help keyword */
    const vshCmdDef *commands;
} vshCmdGrp;
253

254
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
255

256 257
static void vshError(vshControl *ctl, const char *format, ...)
    ATTRIBUTE_FMT_PRINTF(2, 3);
E
Eric Blake 已提交
258 259
static bool vshInit(vshControl *ctl);
static bool vshDeinit(vshControl *ctl);
260
static void vshUsage(void);
261
static void vshOpenLogFile(vshControl *ctl);
262 263
static void vshOutputLogFile(vshControl *ctl, int log_level, const char *format, va_list ap)
    ATTRIBUTE_FMT_PRINTF(3, 0);
264
static void vshCloseLogFile(vshControl *ctl);
K
Karel Zak 已提交
265

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

268
static const char *vshCmddefGetInfo(const vshCmdDef *cmd, const char *info);
269
static const vshCmdDef *vshCmddefSearch(const char *cmdname);
E
Eric Blake 已提交
270
static bool vshCmddefHelp(vshControl *ctl, const char *name);
271
static const vshCmdGrp *vshCmdGrpSearch(const char *grpname);
E
Eric Blake 已提交
272
static bool vshCmdGrpHelp(vshControl *ctl, const char *name);
K
Karel Zak 已提交
273

E
Eric Blake 已提交
274 275 276
static int vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
    ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
    ATTRIBUTE_RETURN_CHECK;
277 278
static int vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
279 280 281
static int vshCommandOptUInt(const vshCmd *cmd, const char *name,
                             unsigned int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
282 283 284 285 286 287 288 289 290
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;
291 292 293
static int vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                                  unsigned long long *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
E
Eric Blake 已提交
294
static bool vshCommandOptBool(const vshCmd *cmd, const char *name);
295 296
static const vshCmdOpt *vshCommandOptArgv(const vshCmd *cmd,
                                          const vshCmdOpt *opt);
K
Karel Zak 已提交
297

298 299 300
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
301
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
302

303
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
304
                                          const char **name, int flag);
K
Karel Zak 已提交
305 306

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

310
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
311
                                            const char **name, int flag);
312 313

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
314 315
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
316 317
                           VSH_BYUUID|VSH_BYNAME)

318
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
319
                                                  const char **name, int flag);
320 321 322 323 324 325

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

326
static virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
327
                                                const char **name, int flag);
328 329 330 331 332 333

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

334
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
335
                            const char *optname, const char **name, int flag);
336 337 338 339 340 341

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

342
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
343 344
                                           const char *optname,
                                           const char *pooloptname,
345
                                           const char **name, int flag);
346 347

/* default is lookup by Name and UUID */
348
#define vshCommandOptVol(_ctl, _cmd, _optname, _pooloptname, _name)   \
349 350 351
    vshCommandOptVolBy(_ctl, _cmd, _optname, _pooloptname, _name,     \
                           VSH_BYUUID|VSH_BYNAME)

352
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
353
                                        const char **name);
354

355
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
356
    ATTRIBUTE_FMT_PRINTF(2, 3);
357
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
358
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
359 360

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

363
static int vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason);
K
Karel Zak 已提交
364
static const char *vshDomainStateToString(int state);
365
static const char *vshDomainStateReasonToString(int state, int reason);
366
static const char *vshDomainControlStateToString(int state);
367
static const char *vshDomainVcpuStateToString(int state);
E
Eric Blake 已提交
368
static bool vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
K
Karel Zak 已提交
369

370 371 372 373
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

380
static void *_vshRealloc(vshControl *ctl, void *ptr, size_t sz, const char *filename, int line);
381 382
#define vshRealloc(_ctl, _ptr, _sz)    _vshRealloc(_ctl, _ptr, _sz, __FILE__, __LINE__)

383
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
384 385
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
static void *
_vshMalloc(vshControl *ctl, size_t size, const char *filename, int line)
{
    void *x;

    if ((x = malloc(size)))
        return x;
    vshError(ctl, _("%s: %d: failed to allocate %d bytes"),
             filename, line, (int) size);
    exit(EXIT_FAILURE);
}

static void *
_vshCalloc(vshControl *ctl, size_t nmemb, size_t size, const char *filename, int line)
{
    void *x;

    if ((x = calloc(nmemb, size)))
        return x;
    vshError(ctl, _("%s: %d: failed to allocate %d bytes"),
             filename, line, (int) (size*nmemb));
    exit(EXIT_FAILURE);
}

static void *
_vshRealloc(vshControl *ctl, void *ptr, size_t size, const char *filename, int line)
{
    void *x;

    if ((x = realloc(ptr, size)))
        return x;
    VIR_FREE(ptr);
    vshError(ctl, _("%s: %d: failed to allocate %d bytes"),
             filename, line, (int) size);
    exit(EXIT_FAILURE);
}

static char *
_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line)
{
    char *x;

    if (s == NULL)
        return(NULL);
    if ((x = strdup(s)))
        return x;
    vshError(ctl, _("%s: %d: failed to allocate %lu bytes"),
             filename, line, (unsigned long)strlen(s));
    exit(EXIT_FAILURE);
}

/* Poison the raw allocating identifiers in favor of our vsh variants.  */
#undef malloc
#undef calloc
#undef realloc
#undef strdup
#define malloc use_vshMalloc_instead_of_malloc
#define calloc use_vshCalloc_instead_of_calloc
#define realloc use_vshRealloc_instead_of_realloc
#define strdup use_vshStrdup_instead_of_strdup
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460

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;

461
  /* User visible sort, so we want locale-specific case comparison.  */
462 463 464
  return strcasecmp(*sa, *sb);
}

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

    if (last_error->code == VIR_ERR_OK) {
524
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
525 526 527
        goto out;
    }

528
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
529 530 531 532 533 534

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

535 536 537 538 539 540 541 542 543
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;
}

544 545 546 547 548
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

549 550 551 552 553
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

554 555 556 557 558 559
/*
 * 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
 */
560 561 562 563
static void vshCatchDisconnect(int sig, siginfo_t *siginfo,
                               void *context ATTRIBUTE_UNUSED) {
    if ((sig == SIGPIPE) ||
        (SA_SIGINFO && siginfo->si_signo == SIGPIPE))
564 565 566 567 568 569 570 571 572
        disconnected++;
}

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

    if (ctl->conn != NULL) {
        connected = true;
597
        virConnectClose(ctl->conn);
598
    }
599 600 601 602 603 604

    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);
    if (!ctl->conn)
        vshError(ctl, "%s", _("Failed to reconnect to the hypervisor"));
605
    else if (connected)
606 607
        vshError(ctl, "%s", _("Reconnected to the hypervisor"));
    disconnected = 0;
608
    ctl->useGetInfo = false;
609
}
610

K
Karel Zak 已提交
611 612 613 614 615 616
/* ---------------
 * Commands
 * ---------------
 */

/*
617
 * "help" command
K
Karel Zak 已提交
618
 */
619
static const vshCmdInfo info_help[] = {
620
    {"help", N_("print help")},
621 622
    {"desc", N_("Prints global help, command specific help, or help for a\n"
                "    group of related commands")},
623

624
    {NULL, NULL}
K
Karel Zak 已提交
625 626
};

627
static const vshCmdOptDef opts_help[] = {
628
    {"command", VSH_OT_DATA, 0, N_("Prints global help, command specific help, or help for a group of related commands")},
629
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
630 631
};

E
Eric Blake 已提交
632
static bool
633
cmdHelp(vshControl *ctl, const vshCmd *cmd)
634
 {
635
    const char *name = NULL;
636

637
    if (vshCommandOptString(cmd, "command", &name) <= 0) {
638
        const vshCmdGrp *grp;
639
        const vshCmdDef *def;
640

641 642 643 644 645 646 647 648 649 650 651 652 653
        vshPrint(ctl, "%s", _("Grouped commands:\n\n"));

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

            for (def = grp->commands; def->name; def++)
                vshPrint(ctl, "    %-30s %s\n", def->name,
                         _(vshCmddefGetInfo(def, "help")));

            vshPrint(ctl, "\n");
        }

E
Eric Blake 已提交
654
        return true;
655
    }
656

E
Eric Blake 已提交
657
    if (vshCmddefSearch(name)) {
658
        return vshCmddefHelp(ctl, name);
E
Eric Blake 已提交
659
    } else if (vshCmdGrpSearch(name)) {
660 661 662
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
E
Eric Blake 已提交
663
        return false;
K
Karel Zak 已提交
664 665 666
    }
}

667 668 669
/*
 * "autostart" command
 */
670
static const vshCmdInfo info_autostart[] = {
671
    {"help", N_("autostart a domain")},
672
    {"desc",
673
     N_("Configure a domain to be automatically started at boot.")},
674 675 676
    {NULL, NULL}
};

677
static const vshCmdOptDef opts_autostart[] = {
678 679
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
680 681 682
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
683
static bool
684
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
685 686
{
    virDomainPtr dom;
687
    const char *name;
688 689
    int autostart;

690
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
691
        return false;
692

J
Jim Meyering 已提交
693
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
694
        return false;
695 696 697 698

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
699
        if (autostart)
700
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
701
        else
702
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
703
        virDomainFree(dom);
E
Eric Blake 已提交
704
        return false;
705 706
    }

707
    if (autostart)
708
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
709
    else
710
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
711

712
    virDomainFree(dom);
E
Eric Blake 已提交
713
    return true;
714 715
}

K
Karel Zak 已提交
716
/*
717
 * "connect" command
K
Karel Zak 已提交
718
 */
719
static const vshCmdInfo info_connect[] = {
720
    {"help", N_("(re)connect to hypervisor")},
721
    {"desc",
722
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
723
    {NULL, NULL}
K
Karel Zak 已提交
724 725
};

726
static const vshCmdOptDef opts_connect[] = {
E
Eric Blake 已提交
727 728
    {"name",     VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("hypervisor connection URI")},
729
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
730
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
731 732
};

E
Eric Blake 已提交
733
static bool
734
cmdConnect(vshControl *ctl, const vshCmd *cmd)
735
{
E
Eric Blake 已提交
736
    bool ro = vshCommandOptBool(cmd, "readonly");
737
    const char *name = NULL;
738

K
Karel Zak 已提交
739
    if (ctl->conn) {
740 741 742
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
E
Eric Blake 已提交
743
            return false;
K
Karel Zak 已提交
744 745 746
        }
        ctl->conn = NULL;
    }
747

748
    VIR_FREE(ctl->name);
749 750
    if (vshCommandOptString(cmd, "name", &name) < 0) {
        vshError(ctl, "%s", _("Please specify valid connection URI"));
E
Eric Blake 已提交
751
        return false;
752
    }
753
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
754

755
    ctl->useGetInfo = false;
E
Eric Blake 已提交
756
    ctl->readonly = ro;
K
Karel Zak 已提交
757

758 759 760
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

E
Eric Blake 已提交
764
    return !!ctl->conn;
K
Karel Zak 已提交
765 766
}

767 768
#ifndef WIN32

769
/*
770
 * "console" command
771
 */
772
static const vshCmdInfo info_console[] = {
773
    {"help", N_("connect to the guest console")},
774
    {"desc",
775
     N_("Connect the virtual serial console for the guest")},
776 777 778
    {NULL, NULL}
};

779
static const vshCmdOptDef opts_console[] = {
780
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
781
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
782 783 784
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
785
static bool
786
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
787
{
E
Eric Blake 已提交
788
    bool ret = false;
789
    int state;
790

791
    if ((state = vshDomainState(ctl, dom, NULL)) < 0) {
792 793 794 795
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

796
    if (state == VIR_DOMAIN_SHUTOFF) {
797 798 799 800
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

801 802
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
    vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
803
    if (vshRunConsole(dom, name) == 0)
E
Eric Blake 已提交
804
        ret = true;
805 806

 cleanup:
807

808 809 810
    return ret;
}

E
Eric Blake 已提交
811
static bool
812 813 814
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
815
    bool ret = false;
816
    const char *name = NULL;
817

818
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
819
        return false;
820 821

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

824 825 826 827
    if (vshCommandOptString(cmd, "devname", &name) < 0) {
        vshError(ctl, "%s", _("Invalid devname"));
        goto cleanup;
    }
828

829
    ret = cmdRunConsole(ctl, dom, name);
830

831
cleanup:
832 833 834 835
    virDomainFree(dom);
    return ret;
}

836 837 838
#endif /* WIN32 */


K
Karel Zak 已提交
839 840 841
/*
 * "list" command
 */
842
static const vshCmdInfo info_list[] = {
843 844
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
845
    {NULL, NULL}
K
Karel Zak 已提交
846 847
};

848
static const vshCmdOptDef opts_list[] = {
849 850
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
851 852 853
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
854

E
Eric Blake 已提交
855
static bool
856
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
857
{
858 859 860 861
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
862
    char **names = NULL;
863 864
    int maxname = 0;
    inactive |= all;
K
Karel Zak 已提交
865

866
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
867
        return false;
868

869
    if (active) {
870 871
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
872
            vshError(ctl, "%s", _("Failed to list active domains"));
E
Eric Blake 已提交
873
            return false;
874 875 876 877 878
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
879
                vshError(ctl, "%s", _("Failed to list active domains"));
880
                VIR_FREE(ids);
E
Eric Blake 已提交
881
                return false;
882 883
            }

884
            qsort(&ids[0], maxid, sizeof(int), idsorter);
885
        }
886 887
    }
    if (inactive) {
888 889
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
890
            vshError(ctl, "%s", _("Failed to list inactive domains"));
891
            VIR_FREE(ids);
E
Eric Blake 已提交
892
            return false;
893
        }
894 895 896 897
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
898
                vshError(ctl, "%s", _("Failed to list inactive domains"));
899 900
                VIR_FREE(ids);
                VIR_FREE(names);
E
Eric Blake 已提交
901
                return false;
902
            }
903

904
            qsort(&names[0], maxname, sizeof(char*), namesorter);
905
        }
906
    }
907
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
908
    vshPrintExtra(ctl, "----------------------------------\n");
909 910

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

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

K
Karel Zak 已提交
917
        vshPrint(ctl, "%3d %-20s %s\n",
918 919
                 virDomainGetID(dom),
                 virDomainGetName(dom),
920
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
921
        virDomainFree(dom);
K
Karel Zak 已提交
922
    }
923 924 925 926
    for (i = 0; i < maxname; i++) {
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);

        /* this kind of work with domains is not atomic operation */
927
        if (!dom) {
928
            VIR_FREE(names[i]);
929
            continue;
930
        }
931

932 933 934 935
        vshPrint(ctl, "%3s %-20s %s\n",
                 "-",
                 names[i],
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
936

937
        virDomainFree(dom);
938
        VIR_FREE(names[i]);
939
    }
940 941
    VIR_FREE(ids);
    VIR_FREE(names);
E
Eric Blake 已提交
942
    return true;
K
Karel Zak 已提交
943 944 945
}

/*
K
Karel Zak 已提交
946
 * "domstate" command
K
Karel Zak 已提交
947
 */
948
static const vshCmdInfo info_domstate[] = {
949 950
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
951
    {NULL, NULL}
K
Karel Zak 已提交
952 953
};

954
static const vshCmdOptDef opts_domstate[] = {
955
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
956
    {"reason", VSH_OT_BOOL, 0, N_("also print reason for the state")},
957
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
958 959
};

E
Eric Blake 已提交
960
static bool
961
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
962
{
K
Karel Zak 已提交
963
    virDomainPtr dom;
E
Eric Blake 已提交
964
    bool ret = true;
965 966
    int showReason = vshCommandOptBool(cmd, "reason");
    int state, reason;
967

968
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
969
        return false;
970

J
Jim Meyering 已提交
971
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
972
        return false;
973

974
    if ((state = vshDomainState(ctl, dom, &reason)) < 0) {
E
Eric Blake 已提交
975
        ret = false;
976 977 978 979 980 981 982 983 984 985 986
        goto cleanup;
    }

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

988
cleanup:
989 990 991 992
    virDomainFree(dom);
    return ret;
}

993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
/*
 * "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;
}

1040 1041
/* "domblkstat" command
 */
1042
static const vshCmdInfo info_domblkstat[] = {
1043 1044
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
1045 1046 1047
    {NULL,NULL}
};

1048
static const vshCmdOptDef opts_domblkstat[] = {
1049 1050
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
1051 1052 1053
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1054
static bool
1055
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
1056 1057
{
    virDomainPtr dom;
1058
    const char *name = NULL, *device = NULL;
1059 1060
    struct _virDomainBlockStats stats;

1061
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1062
        return false;
1063

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

1067
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
L
Laine Stump 已提交
1068
        virDomainFree(dom);
E
Eric Blake 已提交
1069
        return false;
L
Laine Stump 已提交
1070
    }
1071 1072

    if (virDomainBlockStats (dom, device, &stats, sizeof stats) == -1) {
1073
        vshError(ctl, _("Failed to get block stats %s %s"), name, device);
1074
        virDomainFree(dom);
E
Eric Blake 已提交
1075
        return false;
1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
    }

    if (stats.rd_req >= 0)
        vshPrint (ctl, "%s rd_req %lld\n", device, stats.rd_req);

    if (stats.rd_bytes >= 0)
        vshPrint (ctl, "%s rd_bytes %lld\n", device, stats.rd_bytes);

    if (stats.wr_req >= 0)
        vshPrint (ctl, "%s wr_req %lld\n", device, stats.wr_req);

    if (stats.wr_bytes >= 0)
        vshPrint (ctl, "%s wr_bytes %lld\n", device, stats.wr_bytes);

    if (stats.errs >= 0)
        vshPrint (ctl, "%s errs %lld\n", device, stats.errs);

    virDomainFree(dom);
E
Eric Blake 已提交
1094
    return true;
1095 1096 1097 1098
}

/* "domifstat" command
 */
1099
static const vshCmdInfo info_domifstat[] = {
1100 1101
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1102 1103 1104
    {NULL,NULL}
};

1105
static const vshCmdOptDef opts_domifstat[] = {
1106 1107
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1108 1109 1110
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1111
static bool
1112
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1113 1114
{
    virDomainPtr dom;
1115
    const char *name = NULL, *device = NULL;
1116 1117
    struct _virDomainInterfaceStats stats;

1118
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1119
        return false;
1120

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

1124
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1125
        virDomainFree(dom);
E
Eric Blake 已提交
1126
        return false;
L
Laine Stump 已提交
1127
    }
1128 1129

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1130
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1131
        virDomainFree(dom);
E
Eric Blake 已提交
1132
        return false;
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159
    }

    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 已提交
1160
    return true;
1161 1162
}

1163 1164 1165
/*
 * "dommemstats" command
 */
1166
static const vshCmdInfo info_dommemstat[] = {
1167 1168
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1169 1170 1171
    {NULL,NULL}
};

1172
static const vshCmdOptDef opts_dommemstat[] = {
1173
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1174 1175 1176
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1177
static bool
1178
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1179 1180
{
    virDomainPtr dom;
1181
    const char *name;
1182 1183 1184
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1185
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1186
        return false;
1187 1188

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1189
        return false;
1190 1191 1192 1193 1194

    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 已提交
1195
        return false;
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
    }

    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);
1211 1212
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON)
            vshPrint (ctl, "actual %llu\n", stats[i].val);
1213 1214 1215
    }

    virDomainFree(dom);
E
Eric Blake 已提交
1216
    return true;
1217 1218
}

1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233
/*
 * "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 已提交
1234
static bool
1235 1236 1237 1238
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1239
    bool ret = true;
1240
    const char *device = NULL;
1241

1242
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1243
        return false;
1244 1245

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

1248
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1249
        virDomainFree(dom);
E
Eric Blake 已提交
1250
        return false;
1251 1252 1253 1254
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1255
        return false;
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265
    }

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

1266 1267 1268
/*
 * "suspend" command
 */
1269
static const vshCmdInfo info_suspend[] = {
1270 1271
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1272
    {NULL, NULL}
1273 1274
};

1275
static const vshCmdOptDef opts_suspend[] = {
1276
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1277
    {NULL, 0, 0, NULL}
1278 1279
};

E
Eric Blake 已提交
1280
static bool
1281
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1282
{
1283
    virDomainPtr dom;
1284
    const char *name;
E
Eric Blake 已提交
1285
    bool ret = true;
1286

1287
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1288
        return false;
1289

J
Jim Meyering 已提交
1290
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1291
        return false;
1292 1293

    if (virDomainSuspend(dom) == 0) {
1294
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1295
    } else {
1296
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1297
        ret = false;
1298
    }
1299

1300 1301 1302 1303
    virDomainFree(dom);
    return ret;
}

1304 1305 1306
/*
 * "create" command
 */
1307
static const vshCmdInfo info_create[] = {
1308 1309
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1310 1311 1312
    {NULL, NULL}
};

1313
static const vshCmdOptDef opts_create[] = {
1314
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1315
#ifndef WIN32
1316
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1317
#endif
1318
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1319
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1320 1321 1322
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1323
static bool
1324
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1325 1326
{
    virDomainPtr dom;
1327
    const char *from = NULL;
E
Eric Blake 已提交
1328
    bool ret = true;
1329
    char *buffer;
1330
#ifndef WIN32
1331
    int console = vshCommandOptBool(cmd, "console");
1332
#endif
1333
    unsigned int flags = VIR_DOMAIN_NONE;
1334

1335
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1336
        return false;
1337

1338
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1339
        return false;
1340

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

1344 1345
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1346 1347
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1348 1349

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1350
    VIR_FREE(buffer);
1351

1352
    if (dom != NULL) {
1353
        vshPrint(ctl, _("Domain %s created from %s\n"),
1354
                 virDomainGetName(dom), from);
1355
#ifndef WIN32
1356
        if (console)
1357
            cmdRunConsole(ctl, dom, NULL);
1358
#endif
1359
        virDomainFree(dom);
1360
    } else {
1361
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1362
        ret = false;
1363 1364 1365 1366
    }
    return ret;
}

1367 1368 1369
/*
 * "define" command
 */
1370
static const vshCmdInfo info_define[] = {
1371 1372
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1373 1374 1375
    {NULL, NULL}
};

1376
static const vshCmdOptDef opts_define[] = {
1377
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1378 1379 1380
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1381
static bool
1382
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1383 1384
{
    virDomainPtr dom;
1385
    const char *from = NULL;
E
Eric Blake 已提交
1386
    bool ret = true;
1387
    char *buffer;
1388

1389
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1390
        return false;
1391

1392
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1393
        return false;
1394

1395
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1396
        return false;
1397 1398

    dom = virDomainDefineXML(ctl->conn, buffer);
1399
    VIR_FREE(buffer);
1400

1401
    if (dom != NULL) {
1402
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1403
                 virDomainGetName(dom), from);
1404
        virDomainFree(dom);
1405
    } else {
1406
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1407
        ret = false;
1408 1409 1410 1411 1412 1413 1414
    }
    return ret;
}

/*
 * "undefine" command
 */
1415
static const vshCmdInfo info_undefine[] = {
1416 1417
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1418 1419 1420
    {NULL, NULL}
};

1421
static const vshCmdOptDef opts_undefine[] = {
1422
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1423 1424 1425
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1426
static bool
1427
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1428 1429
{
    virDomainPtr dom;
E
Eric Blake 已提交
1430
    bool ret = true;
1431
    const char *name = NULL;
1432
    int id;
1433

1434
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1435
        return false;
1436

1437
    if (vshCommandOptString(cmd, "domain", &name) <= 0)
E
Eric Blake 已提交
1438
        return false;
1439 1440 1441

    if (name && virStrToLong_i(name, NULL, 10, &id) == 0
        && id >= 0 && (dom = virDomainLookupByID(ctl->conn, id))) {
1442 1443 1444 1445 1446
        vshError(ctl,
                 _("a running domain like %s cannot be undefined;\n"
                   "to undefine, first shutdown then undefine"
                   " using its name or UUID"),
                 name);
1447
        virDomainFree(dom);
E
Eric Blake 已提交
1448
        return false;
1449
    }
J
Jim Meyering 已提交
1450
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
1451
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
1452
        return false;
1453 1454

    if (virDomainUndefine(dom) == 0) {
1455
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1456
    } else {
1457
        vshError(ctl, _("Failed to undefine domain %s"), name);
E
Eric Blake 已提交
1458
        ret = false;
1459 1460
    }

1461
    virDomainFree(dom);
1462 1463 1464 1465 1466 1467 1468
    return ret;
}


/*
 * "start" command
 */
1469
static const vshCmdInfo info_start[] = {
1470
    {"help", N_("start a (previously defined) inactive domain")},
1471 1472 1473
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1474 1475 1476
    {NULL, NULL}
};

1477
static const vshCmdOptDef opts_start[] = {
1478
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1479
#ifndef WIN32
1480
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1481
#endif
E
Eric Blake 已提交
1482
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1483
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1484 1485 1486
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1487
static bool
1488
cmdStart(vshControl *ctl, const vshCmd *cmd)
1489 1490
{
    virDomainPtr dom;
E
Eric Blake 已提交
1491
    bool ret = true;
1492
#ifndef WIN32
1493
    int console = vshCommandOptBool(cmd, "console");
1494
#endif
E
Eric Blake 已提交
1495
    unsigned int flags = VIR_DOMAIN_NONE;
1496

1497
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1498
        return false;
1499

1500 1501
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
1502
        return false;
1503 1504

    if (virDomainGetID(dom) != (unsigned int)-1) {
1505
        vshError(ctl, "%s", _("Domain is already active"));
1506
        virDomainFree(dom);
E
Eric Blake 已提交
1507
        return false;
1508 1509
    }

E
Eric Blake 已提交
1510 1511
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1512 1513
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
E
Eric Blake 已提交
1514 1515 1516 1517

    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
         : virDomainCreate(dom)) == 0) {
1518
        vshPrint(ctl, _("Domain %s started\n"),
1519
                 virDomainGetName(dom));
1520
#ifndef WIN32
1521
        if (console)
1522
            cmdRunConsole(ctl, dom, NULL);
1523
#endif
1524
    } else {
1525
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
E
Eric Blake 已提交
1526
        ret = false;
1527
    }
1528
    virDomainFree(dom);
1529 1530 1531
    return ret;
}

1532 1533 1534
/*
 * "save" command
 */
1535
static const vshCmdInfo info_save[] = {
1536
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
1537
    {"desc", N_("Save the RAM state of a running domain.")},
1538
    {NULL, NULL}
1539 1540
};

1541
static const vshCmdOptDef opts_save[] = {
1542 1543
    {"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")},
1544
    {NULL, 0, 0, NULL}
1545 1546
};

E
Eric Blake 已提交
1547
static bool
1548
cmdSave(vshControl *ctl, const vshCmd *cmd)
1549
{
1550
    virDomainPtr dom;
1551 1552
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1553
    bool ret = true;
1554

1555
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1556
        return false;
1557

1558
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1559
        return false;
1560

J
Jim Meyering 已提交
1561
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1562
        return false;
1563 1564

    if (virDomainSave(dom, to) == 0) {
1565
        vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
1566
    } else {
1567
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
E
Eric Blake 已提交
1568
        ret = false;
1569
    }
1570

1571 1572 1573 1574
    virDomainFree(dom);
    return ret;
}

1575 1576 1577 1578 1579
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1580 1581 1582 1583
    {"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.")},
1584 1585 1586 1587 1588 1589 1590 1591
    {NULL, NULL}
};

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

E
Eric Blake 已提交
1592
static bool
1593 1594 1595
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1596
    const char *name;
E
Eric Blake 已提交
1597
    bool ret = true;
1598

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1603
        return false;
1604 1605 1606 1607 1608

    if (virDomainManagedSave(dom, 0) == 0) {
        vshPrint(ctl, _("Domain %s state saved by libvirt\n"), name);
    } else {
        vshError(ctl, _("Failed to save domain %s state"), name);
E
Eric Blake 已提交
1609
        ret = false;
1610 1611 1612 1613 1614 1615
    }

    virDomainFree(dom);
    return ret;
}

1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629
/*
 * "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 已提交
1630
static bool
1631 1632 1633
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1634
    const char *name;
E
Eric Blake 已提交
1635
    bool ret = false;
1636 1637
    int hassave;

1638
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1639
        return false;
1640 1641

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1642
        return false;
1643 1644 1645

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1646
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662
        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 已提交
1663
    ret = true;
1664 1665 1666 1667 1668 1669

cleanup:
    virDomainFree(dom);
    return ret;
}

1670 1671 1672
/*
 * "schedinfo" command
 */
1673
static const vshCmdInfo info_schedinfo[] = {
1674 1675
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1676 1677 1678
    {NULL, NULL}
};

1679
static const vshCmdOptDef opts_schedinfo[] = {
1680 1681 1682 1683
    {"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")},
1684 1685 1686
    {"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")},
1687 1688 1689
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
1690
static int
1691
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
1692
                   virTypedParameterPtr param)
1693
{
1694
    const char *data = NULL;
1695 1696 1697

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
1698
        param->type == VIR_TYPED_PARAM_UINT &&
1699 1700
        vshCommandOptBool(cmd, "weight")) {
        int val;
1701
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
1702
            vshError(ctl, "%s", _("Invalid value of weight"));
1703
            return -1;
1704
        } else {
1705
            param->value.ui = val;
1706
        }
1707
        return 1;
1708 1709
    }

1710 1711
    /* Legacy 'cap' parameter */
    if (STREQ(param->field, "cap") &&
1712
        param->type == VIR_TYPED_PARAM_UINT &&
1713 1714
        vshCommandOptBool(cmd, "cap")) {
        int val;
1715
        if (vshCommandOptInt(cmd, "cap", &val) <= 0) {
1716
            vshError(ctl, "%s", _("Invalid value of cap"));
1717
            return -1;
1718
        } else {
1719
            param->value.ui = val;
1720
        }
1721
        return 1;
1722
    }
1723

1724
    if (vshCommandOptString(cmd, "set", &data) > 0) {
1725 1726 1727
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
1728
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
1729
            return -1;
1730
        }
1731 1732 1733 1734 1735 1736 1737 1738 1739
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

        switch (param->type) {
1740
        case VIR_TYPED_PARAM_INT:
1741
            if (virStrToLong_i(val, NULL, 10, &param->value.i) < 0) {
1742
                vshError(ctl, "%s",
1743 1744 1745 1746
                         _("Invalid value for parameter, expecting an int"));
                return -1;
            }
            break;
1747
        case VIR_TYPED_PARAM_UINT:
1748
            if (virStrToLong_ui(val, NULL, 10, &param->value.ui) < 0) {
1749
                vshError(ctl, "%s",
1750 1751 1752 1753
                         _("Invalid value for parameter, expecting an unsigned int"));
                return -1;
            }
            break;
1754
        case VIR_TYPED_PARAM_LLONG:
1755
            if (virStrToLong_ll(val, NULL, 10, &param->value.l) < 0) {
1756
                vshError(ctl, "%s",
J
Jim Meyering 已提交
1757
                         _("Invalid value for parameter, expecting a long long"));
1758 1759 1760
                return -1;
            }
            break;
1761
        case VIR_TYPED_PARAM_ULLONG:
1762
            if (virStrToLong_ull(val, NULL, 10, &param->value.ul) < 0) {
1763
                vshError(ctl, "%s",
1764 1765 1766 1767
                         _("Invalid value for parameter, expecting an unsigned long long"));
                return -1;
            }
            break;
1768
        case VIR_TYPED_PARAM_DOUBLE:
1769
            if (virStrToDouble(val, NULL, &param->value.d) < 0) {
1770
                vshError(ctl, "%s", _("Invalid value for parameter, expecting a double"));
1771 1772 1773
                return -1;
            }
            break;
1774
        case VIR_TYPED_PARAM_BOOLEAN:
1775
            param->value.b = STREQ(val, "0") ? 0 : 1;
1776
        }
1777
        return 1;
1778
    }
1779

1780 1781
    return 0;
}
1782

1783

E
Eric Blake 已提交
1784
static bool
1785 1786 1787 1788
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
1789
    virTypedParameterPtr params = NULL;
1790 1791 1792
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
1793
    bool ret_val = false;
1794 1795 1796 1797 1798 1799 1800 1801 1802 1803
    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;
        }
1804
        flags = VIR_DOMAIN_AFFECT_CURRENT;
1805 1806
    } else {
        if (config)
1807
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
1808
        if (live)
1809
            flags |= VIR_DOMAIN_AFFECT_LIVE;
1810
    }
1811

1812
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1813
        return false;
1814

1815
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
1816
        return false;
1817 1818 1819

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
1820
    if (schedulertype != NULL) {
1821
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
1822
             schedulertype);
1823
        VIR_FREE(schedulertype);
1824
    } else {
1825
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
1826
        goto cleanup;
1827 1828
    }

1829
    if (nparams) {
1830
        params = vshMalloc(ctl, sizeof(*params) * nparams);
1831

1832
        memset(params, 0, sizeof(*params) * nparams);
1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843
        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);
        }
1844 1845 1846 1847
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
1848
        for (i = 0; i < nparams; i++) {
1849 1850 1851 1852 1853 1854 1855 1856 1857 1858
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
1859 1860 1861 1862 1863
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
1864 1865 1866
            if (ret == -1)
                goto cleanup;

1867 1868 1869 1870 1871 1872 1873
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
1874 1875
            if (ret == -1)
                goto cleanup;
1876 1877 1878 1879
        } 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.  */
1880 1881
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
1882 1883 1884 1885
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
1886 1887 1888 1889 1890 1891
            /* 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;
            }
1892 1893
        }

E
Eric Blake 已提交
1894
        ret_val = true;
1895
        for (i = 0; i < nparams; i++) {
1896
            switch (params[i].type) {
1897
            case VIR_TYPED_PARAM_INT:
1898
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1899
                 break;
1900
            case VIR_TYPED_PARAM_UINT:
1901
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1902
                 break;
1903
            case VIR_TYPED_PARAM_LLONG:
1904
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1905
                 break;
1906
            case VIR_TYPED_PARAM_ULLONG:
1907
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1908
                 break;
1909
            case VIR_TYPED_PARAM_DOUBLE:
1910
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1911
                 break;
1912
            case VIR_TYPED_PARAM_BOOLEAN:
1913
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
1914 1915
                 break;
            default:
1916
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
1917 1918 1919
            }
        }
    }
1920

1921
 cleanup:
1922
    VIR_FREE(params);
1923
    virDomainFree(dom);
1924
    return ret_val;
1925 1926
}

1927 1928 1929
/*
 * "restore" command
 */
1930
static const vshCmdInfo info_restore[] = {
1931 1932
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
1933
    {NULL, NULL}
1934 1935
};

1936
static const vshCmdOptDef opts_restore[] = {
1937
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
1938
    {NULL, 0, 0, NULL}
1939 1940
};

E
Eric Blake 已提交
1941
static bool
1942
cmdRestore(vshControl *ctl, const vshCmd *cmd)
1943
{
1944
    const char *from = NULL;
E
Eric Blake 已提交
1945
    bool ret = true;
1946

1947
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1948
        return false;
1949

1950
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1951
        return false;
1952 1953

    if (virDomainRestore(ctl->conn, from) == 0) {
1954
        vshPrint(ctl, _("Domain restored from %s\n"), from);
1955
    } else {
1956
        vshError(ctl, _("Failed to restore domain from %s"), from);
E
Eric Blake 已提交
1957
        ret = false;
1958 1959 1960 1961
    }
    return ret;
}

D
Daniel Veillard 已提交
1962 1963 1964
/*
 * "dump" command
 */
1965
static const vshCmdInfo info_dump[] = {
1966 1967
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
1968 1969 1970
    {NULL, NULL}
};

1971
static const vshCmdOptDef opts_dump[] = {
1972 1973 1974 1975
    {"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")},
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("where to dump the core")},
D
Daniel Veillard 已提交
1976 1977 1978
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1979
static bool
1980
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
1981 1982
{
    virDomainPtr dom;
1983 1984
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1985
    bool ret = true;
1986
    int flags = 0;
D
Daniel Veillard 已提交
1987

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

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

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

P
Paolo Bonzini 已提交
1997 1998
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
1999 2000 2001 2002
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;

    if (virDomainCoreDump(dom, to, flags) == 0) {
2003
        vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
D
Daniel Veillard 已提交
2004
    } else {
2005
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
E
Eric Blake 已提交
2006
        ret = false;
D
Daniel Veillard 已提交
2007 2008 2009 2010 2011 2012
    }

    virDomainFree(dom);
    return ret;
}

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 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159
static const vshCmdInfo info_screenshot[] = {
    {"help", N_("take a screenshot of a current domain console and store it "
                "into a file")},
    {"desc", N_("screenshot of a current domain console")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_screenshot[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"file", VSH_OT_DATA, VSH_OFLAG_NONE, N_("where to store the screenshot")},
    {"screen", VSH_OT_INT, VSH_OFLAG_NONE, N_("ID of a screen to take screenshot of")},
    {NULL, 0, 0, NULL}
};

static int vshStreamSink(virStreamPtr st ATTRIBUTE_UNUSED,
                         const char *bytes, size_t nbytes, void *opaque)
{
    int *fd = opaque;

    return safewrite(*fd, bytes, nbytes);
}

/**
 * Generate string: '<domain name>-<timestamp>[<extension>]'
 */
static char *
vshGenFileName(vshControl *ctl, virDomainPtr dom, const char *mime)
{
    char timestr[100];
    struct timeval cur_time;
    struct tm time_info;
    const char *ext = NULL;
    char *ret = NULL;

    /* We should be already connected, but doesn't
     * hurt to check */
    if (!vshConnectionUsability(ctl, ctl->conn))
        return NULL;

    if (!dom) {
        vshError(ctl, "%s", _("Invalid domain supplied"));
        return NULL;
    }

    if (STREQ(mime, "image/x-portable-pixmap"))
        ext = ".ppm";
    else if (STREQ(mime, "image/png"))
        ext = ".png";
    /* add mime type here */

    gettimeofday(&cur_time, NULL);
    localtime_r(&cur_time.tv_sec, &time_info);
    strftime(timestr, sizeof(timestr), "%Y-%m-%d-%H:%M:%S", &time_info);

    if (virAsprintf(&ret, "%s-%s%s", virDomainGetName(dom),
                    timestr, ext ? ext : "") < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        return NULL;
    }

    return ret;
}

static bool
cmdScreenshot(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
    const char *name = NULL;
    char *file = NULL;
    int fd = -1;
    virStreamPtr st = NULL;
    unsigned int screen = 0;
    unsigned int flags = 0; /* currently unused */
    int ret = false;
    bool created = true;
    bool generated = false;
    char *mime = NULL;

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

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

    if (vshCommandOptUInt(cmd, "screen", &screen) < 0) {
        vshError(ctl, "%s", _("invalid screen ID"));
        return false;
    }

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

    st = virStreamNew(ctl->conn, 0);

    mime = virDomainScreenshot(dom, st, screen, flags);
    if (!mime) {
        vshError(ctl, _("could not take a screenshot of %s"), name);
        goto cleanup;
    }

    if (!file) {
        if (!(file=vshGenFileName(ctl, dom, mime)))
            return false;
        generated = true;
    }

    if ((fd = open(file, O_WRONLY|O_CREAT|O_EXCL, 0666)) < 0) {
        created = false;
        if (errno != EEXIST ||
            (fd = open(file, O_WRONLY|O_TRUNC, 0666)) < 0) {
            vshError(ctl, _("cannot create file %s"), file);
            goto cleanup;
        }
    }

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

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

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

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

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

2160 2161 2162
/*
 * "resume" command
 */
2163
static const vshCmdInfo info_resume[] = {
2164 2165
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
2166
    {NULL, NULL}
2167 2168
};

2169
static const vshCmdOptDef opts_resume[] = {
2170
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2171
    {NULL, 0, 0, NULL}
2172 2173
};

E
Eric Blake 已提交
2174
static bool
2175
cmdResume(vshControl *ctl, const vshCmd *cmd)
2176
{
2177
    virDomainPtr dom;
E
Eric Blake 已提交
2178
    bool ret = true;
2179
    const char *name;
2180

2181
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2182
        return false;
2183

J
Jim Meyering 已提交
2184
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2185
        return false;
2186 2187

    if (virDomainResume(dom) == 0) {
2188
        vshPrint(ctl, _("Domain %s resumed\n"), name);
2189
    } else {
2190
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
2191
        ret = false;
2192
    }
2193

2194 2195 2196 2197
    virDomainFree(dom);
    return ret;
}

2198 2199 2200
/*
 * "shutdown" command
 */
2201
static const vshCmdInfo info_shutdown[] = {
2202 2203
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
2204
    {NULL, NULL}
2205 2206
};

2207
static const vshCmdOptDef opts_shutdown[] = {
2208
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2209
    {NULL, 0, 0, NULL}
2210 2211
};

E
Eric Blake 已提交
2212
static bool
2213
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
2214
{
2215
    virDomainPtr dom;
E
Eric Blake 已提交
2216
    bool ret = true;
2217
    const char *name;
2218

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

J
Jim Meyering 已提交
2222
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2223
        return false;
2224 2225

    if (virDomainShutdown(dom) == 0) {
2226
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
2227
    } else {
2228
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
2229
        ret = false;
2230
    }
2231

2232 2233 2234 2235
    virDomainFree(dom);
    return ret;
}

2236 2237 2238
/*
 * "reboot" command
 */
2239
static const vshCmdInfo info_reboot[] = {
2240 2241
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
2242 2243 2244
    {NULL, NULL}
};

2245
static const vshCmdOptDef opts_reboot[] = {
2246
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2247 2248 2249
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2250
static bool
2251
cmdReboot(vshControl *ctl, const vshCmd *cmd)
2252 2253
{
    virDomainPtr dom;
E
Eric Blake 已提交
2254
    bool ret = true;
2255
    const char *name;
2256

2257
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2258
        return false;
2259

J
Jim Meyering 已提交
2260
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2261
        return false;
2262 2263

    if (virDomainReboot(dom, 0) == 0) {
2264
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
2265
    } else {
2266
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
2267
        ret = false;
2268 2269 2270 2271 2272 2273
    }

    virDomainFree(dom);
    return ret;
}

2274 2275 2276
/*
 * "destroy" command
 */
2277
static const vshCmdInfo info_destroy[] = {
2278 2279 2280
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
2281
    {NULL, NULL}
2282 2283
};

2284
static const vshCmdOptDef opts_destroy[] = {
2285
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2286
    {NULL, 0, 0, NULL}
2287 2288
};

E
Eric Blake 已提交
2289
static bool
2290
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2291
{
2292
    virDomainPtr dom;
E
Eric Blake 已提交
2293
    bool ret = true;
2294
    const char *name;
2295

2296
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2297
        return false;
2298

J
Jim Meyering 已提交
2299
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2300
        return false;
2301 2302

    if (virDomainDestroy(dom) == 0) {
2303
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2304
    } else {
2305
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
2306
        ret = false;
2307
    }
2308

2309
    virDomainFree(dom);
K
Karel Zak 已提交
2310 2311 2312 2313
    return ret;
}

/*
2314
 * "dominfo" command
K
Karel Zak 已提交
2315
 */
2316
static const vshCmdInfo info_dominfo[] = {
2317 2318
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2319
    {NULL, NULL}
K
Karel Zak 已提交
2320 2321
};

2322
static const vshCmdOptDef opts_dominfo[] = {
2323
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2324
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2325 2326
};

E
Eric Blake 已提交
2327
static bool
2328
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2329
{
K
Karel Zak 已提交
2330 2331
    virDomainInfo info;
    virDomainPtr dom;
2332
    virSecurityModel secmodel;
2333
    virSecurityLabelPtr seclabel;
2334
    int persistent = 0;
E
Eric Blake 已提交
2335 2336
    bool ret = true;
    int autostart;
2337
    unsigned int id;
2338
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2339
    int has_managed_save = 0;
2340

2341
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2342
        return false;
K
Karel Zak 已提交
2343

J
Jim Meyering 已提交
2344
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2345
        return false;
2346

2347 2348
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2349
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2350
    else
2351
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2352 2353
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2354
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2355
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2356 2357

    if ((str = virDomainGetOSType(dom))) {
2358
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2359
        VIR_FREE(str);
2360 2361 2362
    }

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

2366
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2367 2368

        if (info.cpuTime != 0) {
2369
            double cpuUsed = info.cpuTime;
2370

2371
            cpuUsed /= 1000000000.0;
2372

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

2376 2377
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2378
                 info.maxMem);
2379
        else
2380
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2381 2382
                 _("no limit"));

2383
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2384 2385
                 info.memory);

K
Karel Zak 已提交
2386
    } else {
E
Eric Blake 已提交
2387
        ret = false;
K
Karel Zak 已提交
2388
    }
2389

2390 2391
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
2392 2393
    vshDebug(ctl, VSH_ERR_DEBUG, "Domain persistent flag value: %d\n",
             persistent);
2394 2395 2396 2397 2398 2399
    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 */
2400
    if (!virDomainGetAutostart(dom, &autostart)) {
2401
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2402 2403 2404
                 autostart ? _("enable") : _("disable") );
    }

2405 2406 2407 2408 2409 2410 2411
    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"));

2412 2413 2414
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2415 2416
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
2417
            return false;
2418 2419 2420
        } else {
            virFreeError(last_error);
            last_error = NULL;
2421
        }
2422 2423 2424 2425 2426 2427 2428
    } 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 */
2429
            if (VIR_ALLOC(seclabel) < 0) {
2430
                virDomainFree(dom);
E
Eric Blake 已提交
2431
                return false;
2432 2433 2434 2435 2436
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
2437
                return false;
2438
            } else {
2439
                if (seclabel->label[0] != '\0')
2440
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
2441
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
2442
            }
2443 2444

            VIR_FREE(seclabel);
2445 2446
        }
    }
2447
    virDomainFree(dom);
K
Karel Zak 已提交
2448 2449 2450
    return ret;
}

2451 2452 2453 2454
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2455 2456
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2457 2458 2459 2460
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2461
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2462 2463 2464 2465
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
2466
static bool
2467 2468 2469 2470
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
2471
    bool ret = true;
2472

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2477
        return false;
2478 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

    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 已提交
2504
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2505
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2506
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2507
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2508
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2509 2510 2511
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2512
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2513
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2514
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2515
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2516
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2517 2518 2519
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2520
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2521
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2522
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2523
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2524
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2525 2526
        }
    } else {
E
Eric Blake 已提交
2527
        ret = false;
2528 2529 2530 2531 2532 2533
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2534 2535 2536 2537
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2538 2539
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2540 2541 2542 2543
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2544
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2545 2546 2547
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2548
static bool
2549 2550 2551
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2552
    bool ret = true;
2553

2554
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2555
        return false;
2556 2557

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
2561
        ret = false;
2562 2563 2564 2565 2566

    virDomainFree(dom);
    return ret;
}

2567 2568 2569
/*
 * "freecell" command
 */
2570
static const vshCmdInfo info_freecell[] = {
2571 2572
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2573 2574 2575
    {NULL, NULL}
};

2576
static const vshCmdOptDef opts_freecell[] = {
2577
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2578
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
2579 2580 2581
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2582
static bool
2583
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2584
{
W
Wen Congyang 已提交
2585
    bool func_ret = false;
2586
    int ret;
2587
    int cell = -1, cell_given;
2588
    unsigned long long memory;
2589 2590 2591 2592
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
2593
    int all_given;
2594 2595 2596 2597
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
2598

2599

2600
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2601
        return false;
2602

2603 2604 2605 2606
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
2607 2608 2609 2610 2611 2612 2613 2614 2615
    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) {
2616 2617 2618
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2619 2620 2621
            goto cleanup;
        }

2622 2623 2624
        xml = xmlReadDoc((const xmlChar *) cap_xml, "node.xml", NULL,
                          XML_PARSE_NOENT | XML_PARSE_NONET |
                          XML_PARSE_NOWARNING);
2625

2626 2627
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2628 2629 2630
            goto cleanup;
        }

2631 2632 2633 2634 2635
        ctxt = xmlXPathNewContext(xml);
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
2636
            vshError(ctl, "%s", _("could not get information about "
2637
                                  "NUMA topology"));
2638 2639 2640
            goto cleanup;
        }

2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661
        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;
            }
        }

2662
        memory = 0;
2663 2664 2665 2666
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
2667 2668 2669 2670
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
2671
    } else {
2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685
        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));
2686 2687
    }

E
Eric Blake 已提交
2688
    func_ret = true;
2689

2690
cleanup:
2691 2692 2693
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
2694
    VIR_FREE(nodes);
2695 2696 2697
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
2698
    return func_ret;
2699 2700
}

E
Eric Blake 已提交
2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714
/*
 * "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 已提交
2715
static bool
E
Eric Blake 已提交
2716 2717
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
2718
    const char *type = NULL;
E
Eric Blake 已提交
2719 2720
    int vcpus;

2721 2722
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
2723
        return false;
2724
    }
E
Eric Blake 已提交
2725 2726

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2727
        return false;
E
Eric Blake 已提交
2728 2729 2730

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

E
Eric Blake 已提交
2734
    return true;
E
Eric Blake 已提交
2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754
}

/*
 * "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")},
    {"current", VSH_OT_BOOL, 0, N_("get current vcpu usage")},
    {"config", VSH_OT_BOOL, 0, N_("get value to be used on next boot")},
    {"live", VSH_OT_BOOL, 0, N_("get value from running domain")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2755
static bool
E
Eric Blake 已提交
2756 2757 2758
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2759
    bool ret = true;
E
Eric Blake 已提交
2760 2761 2762 2763 2764 2765 2766 2767 2768 2769
    int maximum = vshCommandOptBool(cmd, "maximum");
    int current = vshCommandOptBool(cmd, "current");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    bool all = maximum + current + config + live == 0;
    int count;

    if (maximum && current) {
        vshError(ctl, "%s",
                 _("--maximum and --current cannot both be specified"));
E
Eric Blake 已提交
2770
        return false;
E
Eric Blake 已提交
2771 2772 2773 2774
    }
    if (config && live) {
        vshError(ctl, "%s",
                 _("--config and --live cannot both be specified"));
E
Eric Blake 已提交
2775
        return false;
E
Eric Blake 已提交
2776 2777 2778 2779 2780 2781 2782 2783 2784 2785
    }
    /* We want one of each pair of mutually exclusive options; that
     * is, use of flags requires exactly two options.  */
    if (maximum + current + config + live == 1) {
        vshError(ctl,
                 _("when using --%s, either --%s or --%s must be specified"),
                 (maximum ? "maximum" : current ? "current"
                  : config ? "config" : "live"),
                 maximum + current ? "config" : "maximum",
                 maximum + current ? "live" : "current");
E
Eric Blake 已提交
2786
        return false;
E
Eric Blake 已提交
2787 2788 2789
    }

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

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2793
        return false;
E
Eric Blake 已提交
2794 2795 2796 2797 2798 2799

    /* In all cases, try the new API first; if it fails because we are
     * talking to an older client, try a fallback API before giving
     * up.  */
    if (all || (maximum && config)) {
        count = virDomainGetVcpusFlags(dom, (VIR_DOMAIN_VCPU_MAXIMUM |
2800
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
2801 2802 2803 2804 2805 2806 2807 2808 2809
        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;
            }
2810 2811
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
2812 2813 2814 2815 2816
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2817
            ret = false;
E
Eric Blake 已提交
2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829
        } 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 |
2830
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
2831 2832 2833 2834 2835 2836 2837
        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 已提交
2838
            ret = false;
E
Eric Blake 已提交
2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("maximum"), _("live"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    if (all || (current && config)) {
2850
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874
        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 已提交
2875
            ret = false;
E
Eric Blake 已提交
2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886
        } else if (all) {
            vshPrint(ctl, "%-12s %-12s %3d\n", _("current"), _("config"),
                     count);
        } else {
            vshPrint(ctl, "%d\n", count);
        }
        virFreeError(last_error);
        last_error = NULL;
    }

    if (all || (current && live)) {
2887
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
2888 2889 2890 2891 2892 2893 2894 2895 2896
        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 已提交
2897
            ret = false;
E
Eric Blake 已提交
2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911
        } 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;
}

2912 2913 2914
/*
 * "vcpuinfo" command
 */
2915
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
2916
    {"help", N_("detailed domain vcpu information")},
2917
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
2918 2919 2920
    {NULL, NULL}
};

2921
static const vshCmdOptDef opts_vcpuinfo[] = {
2922
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2923 2924 2925
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2926
static bool
2927
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
2928 2929 2930 2931 2932
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
2933 2934
    unsigned char *cpumaps;
    int ncpus, maxcpu;
2935
    size_t cpumaplen;
E
Eric Blake 已提交
2936
    bool ret = true;
2937
    int n, m;
2938

2939
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2940
        return false;
2941

J
Jim Meyering 已提交
2942
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2943
        return false;
2944 2945 2946

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2947
        return false;
2948 2949 2950 2951
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2952
        return false;
2953 2954
    }

2955
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
2956 2957 2958
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
2959

2960 2961
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
2962
                                   cpumaps, cpumaplen)) >= 0) {
2963 2964 2965 2966
        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 已提交
2967
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
2968 2969 2970 2971 2972 2973 2974 2975
            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:"));
2976 2977
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
2978 2979 2980 2981 2982 2983
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
2984
    } else {
2985
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
2986
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
2987 2988 2989
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
2990
            /* fallback plan to use virDomainGetVcpuPinInfo */
2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008

            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;
3009
        }
3010 3011
    }

3012
    VIR_FREE(cpumaps);
3013
    VIR_FREE(cpuinfo);
3014 3015 3016 3017 3018 3019 3020
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
3021
static const vshCmdInfo info_vcpupin[] = {
3022
    {"help", N_("control or query domain vcpu affinity")},
3023
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
3024 3025 3026
    {NULL, NULL}
};

3027
static const vshCmdOptDef opts_vcpupin[] = {
3028
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3029 3030 3031
    {"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")},
3032 3033 3034
    {"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")},
3035 3036 3037
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3038
static bool
E
Eric Blake 已提交
3039
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
3040 3041 3042 3043
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
3044
    int vcpu = -1;
3045
    const char *cpulist = NULL;
E
Eric Blake 已提交
3046
    bool ret = true;
3047 3048
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
3049
    size_t cpumaplen;
3050 3051
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
3052
    bool unuse = false;
3053
    const char *cur;
3054 3055 3056
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
3057
    bool query = false; /* Query mode if no cpulist */
3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074
    int flags = 0;

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

3076
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3077
        return false;
3078

J
Jim Meyering 已提交
3079
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3080
        return false;
3081

3082 3083
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
3084
        virDomainFree(dom);
E
Eric Blake 已提交
3085
        return false;
3086
    }
3087
    query = !cpulist;
3088

3089 3090 3091 3092
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
3093
        virDomainFree(dom);
E
Eric Blake 已提交
3094
        return false;
3095
    }
3096

3097 3098
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3099
        return false;
3100 3101 3102
    }

    if (virDomainGetInfo(dom, &info) != 0) {
3103
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
3104
        virDomainFree(dom);
E
Eric Blake 已提交
3105
        return false;
3106 3107 3108
    }

    if (vcpu >= info.nrVirtCpu) {
3109
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
3110
        virDomainFree(dom);
E
Eric Blake 已提交
3111
        return false;
3112 3113
    }

3114 3115
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
3116

3117 3118 3119 3120 3121 3122 3123 3124
    /* 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 已提交
3125
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170
                                             cpumaps, cpumaplen, flags)) >= 0) {

            vshPrint(ctl, "%s %s\n", _("VCPU:"), _("CPU Affinity"));
            vshPrint(ctl, "----------------------------------\n");
            for (i = 0; i < ncpus; i++) {

               if (vcpu != -1 && i != vcpu)
                   continue;

               bit = lastbit = isInvert = false;
               lastcpu = -1;

               vshPrint(ctl, "%4d: ", i);
               for (cpu = 0; cpu < maxcpu; cpu++) {

                   bit = VIR_CPU_USABLE(cpumaps, cpumaplen, i, cpu);

                   isInvert = (bit ^ lastbit);
                   if (bit && isInvert) {
                       if (lastcpu == -1)
                           vshPrint(ctl, "%d", cpu);
                       else
                           vshPrint(ctl, ",%d", cpu);
                       lastcpu = cpu;
                   }
                   if (!bit && isInvert && lastcpu != cpu - 1)
                       vshPrint(ctl, "-%d", cpu - 1);
                   lastbit = bit;
               }
               if (bit && !isInvert) {
                  vshPrint(ctl, "-%d", maxcpu - 1);
               }
               vshPrint(ctl, "\n");
            }

        } else {
            ret = false;
        }
        VIR_FREE(cpumaps);
        goto cleanup;
    }

    /* Pin mode: pinning specified vcpu to specified physical cpus*/

    cpumap = vshCalloc(ctl, 0, cpumaplen);
3171 3172
    /* Parse cpulist */
    cur = cpulist;
3173
    if (*cur == 0) {
3174
        goto parse_error;
3175 3176 3177
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
3178
        cur = "";
3179
    }
3180 3181 3182 3183 3184 3185 3186

    while (*cur != 0) {

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

3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200
        /* 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);
3201

3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228
        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);
        }
3229

3230 3231 3232 3233 3234 3235
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
3236
        } else {
3237
            goto parse_error;
3238
        }
3239
    }
3240

3241 3242 3243 3244 3245 3246 3247 3248
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
3249 3250
    }

3251
cleanup:
3252
    VIR_FREE(cpumap);
3253 3254
    virDomainFree(dom);
    return ret;
3255 3256 3257 3258 3259

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

3262 3263 3264
/*
 * "setvcpus" command
 */
3265
static const vshCmdInfo info_setvcpus[] = {
3266 3267
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
3268 3269 3270
    {NULL, NULL}
};

3271
static const vshCmdOptDef opts_setvcpus[] = {
3272
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3273
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
3274 3275 3276
    {"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")},
3277
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3278 3279 3280
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3281
static bool
3282
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
3283 3284
{
    virDomainPtr dom;
3285
    int count = 0;
E
Eric Blake 已提交
3286
    bool ret = true;
E
Eric Blake 已提交
3287 3288 3289
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307
    int current = vshCommandOptBool(cmd, "current");
    int flags = 0;

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

3309
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3310
        return false;
3311

J
Jim Meyering 已提交
3312
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3313
        return false;
3314

3315 3316 3317 3318
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
3319

3320
    if (flags == -1) {
E
Eric Blake 已提交
3321
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
3322
            ret = false;
E
Eric Blake 已提交
3323 3324
        }
    } else {
3325 3326 3327
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
3328
            vshDebug(ctl, VSH_ERR_DEBUG, "--maximum flag was given\n");
3329

3330 3331
            flags |= VIR_DOMAIN_VCPU_MAXIMUM;

3332 3333 3334 3335 3336 3337 3338 3339
            /* 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 已提交
3340
                ret = false;
3341 3342 3343 3344 3345
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
3346
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
3347
            ret = false;
E
Eric Blake 已提交
3348
        }
3349 3350
    }

3351
  cleanup:
3352 3353 3354 3355
    virDomainFree(dom);
    return ret;
}

3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389
/*
 * "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;
}

3390 3391 3392
/*
 * "setmemory" command
 */
3393
static const vshCmdInfo info_setmem[] = {
3394 3395
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
3396 3397 3398
    {NULL, NULL}
};

3399
static const vshCmdOptDef opts_setmem[] = {
3400
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3401
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
3402 3403
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
3404
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3405 3406 3407
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3408
static bool
3409
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
3410 3411
{
    virDomainPtr dom;
3412
    virDomainInfo info;
3413
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
3414
    bool ret = true;
3415 3416
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3417
    int current = vshCommandOptBool(cmd, "current");
3418 3419
    int flags = 0;

3420 3421 3422
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3423
            return false;
3424
        }
3425
        flags = VIR_DOMAIN_AFFECT_CURRENT;
3426 3427
    } else {
        if (config)
3428
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3429
        if (live)
3430
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3431 3432 3433
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
3434
    }
3435

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

J
Jim Meyering 已提交
3439
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3440
        return false;
3441

3442 3443
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3444
        return false;
3445 3446
    }

3447
    if (kilobytes <= 0) {
3448
        virDomainFree(dom);
3449
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
3450
        return false;
3451 3452
    }

3453 3454
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
3455
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
3456
        return false;
3457 3458 3459 3460
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
3461
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
3462
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
3463
        return false;
3464 3465
    }

3466
    if (flags == -1) {
3467
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
3468
            ret = false;
3469 3470 3471
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
3472
            ret = false;
3473
        }
3474 3475 3476 3477 3478 3479 3480 3481 3482
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
3483
static const vshCmdInfo info_setmaxmem[] = {
3484 3485
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
3486 3487 3488
    {NULL, NULL}
};

3489
static const vshCmdOptDef opts_setmaxmem[] = {
3490
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3491
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
3492 3493 3494
    {"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")},
3495 3496 3497
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3498
static bool
3499
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
3500 3501
{
    virDomainPtr dom;
3502
    int kilobytes = 0;
E
Eric Blake 已提交
3503
    bool ret = true;
3504 3505 3506 3507 3508 3509 3510 3511
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
    int flags = VIR_DOMAIN_MEM_MAXIMUM;

    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3512
            return false;
3513 3514 3515
        }
    } else {
        if (config)
3516
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3517
        if (live)
3518
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3519 3520 3521 3522
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
3523

3524
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3525
        return false;
3526

J
Jim Meyering 已提交
3527
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3528
        return false;
3529

3530 3531
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3532
        return false;
3533 3534
    }

3535
    if (kilobytes <= 0) {
3536
        virDomainFree(dom);
3537
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
3538
        return false;
3539 3540
    }

3541 3542 3543
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3544
            ret = false;
3545 3546 3547 3548
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3549
            ret = false;
3550
        }
3551 3552
    }

3553 3554 3555 3556
    virDomainFree(dom);
    return ret;
}

3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572
/*
 * "blkiotune" command
 */
static const vshCmdInfo info_blkiotune[] = {
    {"help", N_("Get or set blkio parameters")},
    {"desc", N_("Get or set the current blkio parameters for a guest" \
                " domain.\n" \
                "    To get the blkio parameters use following command: \n\n" \
                "    virsh # blkiotune <domain>")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_blkiotune[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"weight", VSH_OT_INT, VSH_OFLAG_NONE,
     N_("IO Weight in range [100, 1000]")},
H
Hu Tao 已提交
3573 3574 3575
    {"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")},
3576 3577 3578
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3579
static bool
3580 3581 3582 3583 3584 3585
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
    unsigned int i = 0;
3586
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3587
    bool ret = false;
H
Hu Tao 已提交
3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604
    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;
    }
3605 3606

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3607
        return false;
3608 3609

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3610
        return false;
3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627

    if (vshCommandOptInt(cmd, "weight", &weight) < 0) {
        vshError(ctl, "%s",
                 _("Unable to parse integer parameter"));
        goto cleanup;
    }

    if (weight) {
        nparams++;
        if (weight < 0) {
            vshError(ctl, _("Invalid value of %d for I/O weight"), weight);
            goto cleanup;
        }
    }

    if (nparams == 0) {
        /* get the number of blkio parameters */
H
Hu Tao 已提交
3628
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
3629 3630 3631 3632 3633 3634 3635
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3636
            ret = true;
3637 3638 3639 3640 3641
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
3642
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
3643 3644 3645 3646 3647 3648
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
3649
                case VIR_TYPED_PARAM_INT:
3650 3651 3652
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
3653
                case VIR_TYPED_PARAM_UINT:
3654 3655 3656
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
3657
                case VIR_TYPED_PARAM_LLONG:
3658 3659 3660
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
3661
                case VIR_TYPED_PARAM_ULLONG:
3662 3663 3664
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
3665
                case VIR_TYPED_PARAM_DOUBLE:
3666 3667 3668
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
3669
                case VIR_TYPED_PARAM_BOOLEAN:
3670 3671 3672 3673 3674 3675 3676 3677
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
3678
        ret = true;
3679 3680 3681 3682 3683 3684
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
3685
            temp->type = VIR_TYPED_PARAM_UINT;
3686 3687 3688 3689 3690 3691 3692 3693

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
H
Hu Tao 已提交
3694
        if (virDomainSetBlkioParameters(dom, params, nparams, flags) != 0)
3695 3696
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
3697
            ret = true;
3698 3699 3700 3701 3702 3703 3704 3705
    }

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

3706 3707 3708 3709
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
3710 3711 3712
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
3713 3714 3715 3716 3717 3718 3719
                "    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")},
3720
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3721
     N_("Max memory in kilobytes")},
3722
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3723
     N_("Memory during contention in kilobytes")},
3724
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3725
     N_("Max memory plus swap in kilobytes")},
3726
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
3727
     N_("Min guaranteed memory in kilobytes")},
3728 3729 3730
    {"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")},
3731 3732 3733
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3734
static bool
3735 3736 3737
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
3738 3739
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
3740 3741
    int nparams = 0;
    unsigned int i = 0;
3742
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3743
    bool ret = false;
3744 3745 3746 3747 3748 3749 3750 3751 3752 3753
    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;
        }
3754
        flags = VIR_DOMAIN_AFFECT_CURRENT;
3755 3756
    } else {
        if (config)
3757
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3758
        if (live)
3759
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3760
    }
3761 3762

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3763
        return false;
3764 3765

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

3768 3769 3770 3771 3772 3773 3774 3775 3776
    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;
    }

3777 3778 3779 3780 3781 3782 3783 3784 3785
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

3786 3787 3788
    if (min_guarantee)
        nparams++;

3789 3790
    if (nparams == 0) {
        /* get the number of memory parameters */
3791
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
3792 3793 3794 3795 3796
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

3797 3798
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3799
            ret = true;
3800 3801 3802
            goto cleanup;
        }

3803
        /* now go get all the memory parameters */
E
Eric Blake 已提交
3804
        params = vshCalloc(ctl, nparams, sizeof(*params));
3805
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
3806 3807 3808 3809 3810 3811
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
3812
                case VIR_TYPED_PARAM_INT:
3813 3814 3815
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
3816
                case VIR_TYPED_PARAM_UINT:
3817 3818 3819
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
3820
                case VIR_TYPED_PARAM_LLONG:
3821 3822 3823
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
3824
                case VIR_TYPED_PARAM_ULLONG:
3825 3826 3827 3828 3829
                    if (params[i].value.ul == VIR_DOMAIN_MEMORY_PARAM_UNLIMITED)
                        vshPrint(ctl, "%-15s: unlimited\n", params[i].field);
                    else
                        vshPrint(ctl, "%-15s: %llu kB\n", params[i].field,
                                 params[i].value.ul);
3830
                    break;
3831
                case VIR_TYPED_PARAM_DOUBLE:
3832 3833 3834
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
3835
                case VIR_TYPED_PARAM_BOOLEAN:
3836 3837 3838 3839
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
3840
                    vshPrint(ctl, "unimplemented memory parameter type\n");
3841 3842 3843
            }
        }

E
Eric Blake 已提交
3844
        ret = true;
3845 3846
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
3847
        params = vshCalloc(ctl, nparams, sizeof(*params));
3848 3849 3850

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
3851
            temp->type = VIR_TYPED_PARAM_ULLONG;
3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870

            /*
             * 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;
3871
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
3872 3873
                        sizeof(temp->field));
                swap_hard_limit = 0;
3874 3875 3876 3877 3878
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
3879
            }
3880 3881 3882 3883

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
3884
        }
3885
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
3886
            vshError(ctl, "%s", _("Unable to change memory parameters"));
3887
        else
E
Eric Blake 已提交
3888
            ret = true;
3889 3890 3891
    }

  cleanup:
E
Eric Blake 已提交
3892
    VIR_FREE(params);
3893 3894 3895 3896
    virDomainFree(dom);
    return ret;
}

3897 3898 3899
/*
 * "nodeinfo" command
 */
3900
static const vshCmdInfo info_nodeinfo[] = {
3901 3902
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
3903 3904 3905
    {NULL, NULL}
};

E
Eric Blake 已提交
3906
static bool
3907
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3908 3909
{
    virNodeInfo info;
3910

3911
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3912
        return false;
3913 3914

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
3915
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
3916
        return false;
3917 3918 3919 3920 3921 3922 3923 3924 3925 3926
    }
    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 已提交
3927
    return true;
3928 3929
}

3930 3931 3932 3933 3934
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
3935
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
3936 3937 3938 3939 3940 3941 3942 3943 3944 3945
    {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
3946
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
3947 3948 3949 3950
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
3951 3952
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995
    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;

3996
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
3997
                cpu_stats[i].sys = value;
3998
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
3999
                cpu_stats[i].user = value;
4000
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
4001
                cpu_stats[i].idle = value;
4002
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
4003
                cpu_stats[i].iowait = value;
4004
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 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
                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) {
            vshPrint(ctl, "%-15s %20llu\n", _("user  :"), cpu_stats[0].user);
            vshPrint(ctl, "%-15s %20llu\n", _("system:"), cpu_stats[0].sys);
            vshPrint(ctl, "%-15s %20llu\n", _("idle  :"), cpu_stats[0].idle);
            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);
            vshPrint(ctl, "%-15s %5.1lf%%\n", _("idle :"), 100 - usage);
        } 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",
                     _("    user  :"), user_time / total_time * 100);
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("    system:"), sys_time  / total_time * 100);
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("idle  :"), idle_time     / total_time * 100);
            vshPrint(ctl, "%-15s %5.1lf%%\n",
                     _("iowait:"), iowait_time   / total_time * 100);
        }
    }

    ret = true;

  cleanup:
    VIR_FREE(params);
    return ret;
}

4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077
/*
 * "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;
4078 4079
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
4080 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
    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;
}

4120 4121 4122
/*
 * "capabilities" command
 */
4123
static const vshCmdInfo info_capabilities[] = {
4124 4125
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
4126 4127 4128
    {NULL, NULL}
};

E
Eric Blake 已提交
4129
static bool
4130
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4131 4132 4133
{
    char *caps;

4134
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4135
        return false;
4136 4137

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
4138
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
4139
        return false;
4140 4141
    }
    vshPrint (ctl, "%s\n", caps);
4142
    VIR_FREE(caps);
4143

E
Eric Blake 已提交
4144
    return true;
4145 4146
}

4147 4148 4149
/*
 * "dumpxml" command
 */
4150
static const vshCmdInfo info_dumpxml[] = {
4151 4152
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
4153
    {NULL, NULL}
4154 4155
};

4156
static const vshCmdOptDef opts_dumpxml[] = {
4157 4158 4159
    {"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")},
4160
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
4161
    {NULL, 0, 0, NULL}
4162 4163
};

E
Eric Blake 已提交
4164
static bool
4165
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
4166
{
4167
    virDomainPtr dom;
E
Eric Blake 已提交
4168
    bool ret = true;
4169
    char *dump;
4170 4171 4172
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
4173
    int update = vshCommandOptBool(cmd, "update-cpu");
4174 4175 4176 4177 4178

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
4179 4180
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
4181

4182
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4183
        return false;
4184

J
Jim Meyering 已提交
4185
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4186
        return false;
4187

4188
    dump = virDomainGetXMLDesc(dom, flags);
4189
    if (dump != NULL) {
4190
        vshPrint(ctl, "%s", dump);
4191
        VIR_FREE(dump);
4192
    } else {
E
Eric Blake 已提交
4193
        ret = false;
4194
    }
4195

4196 4197 4198 4199
    virDomainFree(dom);
    return ret;
}

4200 4201 4202 4203
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
4204 4205
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
4206 4207 4208 4209
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
4210 4211
    {"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")},
4212 4213 4214
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4215
static bool
4216 4217
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4218
    bool ret = true;
4219 4220
    const char *format = NULL;
    const char *configFile = NULL;
4221 4222 4223 4224
    char *configData;
    char *xmlData;
    int flags = 0;

4225
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4226
        return false;
4227

4228 4229
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
4230
        return false;
4231

4232
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
4233
        return false;
4234 4235 4236

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
4237
        vshPrint(ctl, "%s", xmlData);
4238
        VIR_FREE(xmlData);
4239
    } else {
E
Eric Blake 已提交
4240
        ret = false;
4241 4242 4243 4244 4245 4246 4247 4248 4249
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
4250 4251
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
4252 4253 4254 4255
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
4256 4257
    {"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")},
4258 4259 4260
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4261
static bool
4262 4263
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4264
    bool ret = true;
4265 4266
    const char *format = NULL;
    const char *xmlFile = NULL;
4267 4268 4269 4270
    char *configData;
    char *xmlData;
    int flags = 0;

4271
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4272
        return false;
4273

4274 4275
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
4276
        return false;
4277

4278
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
4279
        return false;
4280 4281 4282

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
4283
        vshPrint(ctl, "%s", configData);
4284
        VIR_FREE(configData);
4285
    } else {
E
Eric Blake 已提交
4286
        ret = false;
4287 4288 4289 4290 4291
    }

    return ret;
}

K
Karel Zak 已提交
4292
/*
K
Karel Zak 已提交
4293
 * "domname" command
K
Karel Zak 已提交
4294
 */
4295
static const vshCmdInfo info_domname[] = {
4296
    {"help", N_("convert a domain id or UUID to domain name")},
4297
    {"desc", ""},
4298
    {NULL, NULL}
K
Karel Zak 已提交
4299 4300
};

4301
static const vshCmdOptDef opts_domname[] = {
4302
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
4303
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4304 4305
};

E
Eric Blake 已提交
4306
static bool
4307
cmdDomname(vshControl *ctl, const vshCmd *cmd)
4308
{
K
Karel Zak 已提交
4309 4310
    virDomainPtr dom;

4311
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4312
        return false;
J
Jim Meyering 已提交
4313
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4314
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
4315
        return false;
4316

K
Karel Zak 已提交
4317 4318
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
4319
    return true;
K
Karel Zak 已提交
4320 4321 4322
}

/*
K
Karel Zak 已提交
4323
 * "domid" command
K
Karel Zak 已提交
4324
 */
4325
static const vshCmdInfo info_domid[] = {
4326
    {"help", N_("convert a domain name or UUID to domain id")},
4327
    {"desc", ""},
4328
    {NULL, NULL}
K
Karel Zak 已提交
4329 4330
};

4331
static const vshCmdOptDef opts_domid[] = {
4332
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
4333
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4334 4335
};

E
Eric Blake 已提交
4336
static bool
4337
cmdDomid(vshControl *ctl, const vshCmd *cmd)
4338
{
4339
    virDomainPtr dom;
4340
    unsigned int id;
K
Karel Zak 已提交
4341

4342
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4343
        return false;
J
Jim Meyering 已提交
4344
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4345
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
4346
        return false;
4347

4348 4349
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
4350
        vshPrint(ctl, "%s\n", "-");
4351
    else
4352
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
4353
    virDomainFree(dom);
E
Eric Blake 已提交
4354
    return true;
K
Karel Zak 已提交
4355
}
4356

K
Karel Zak 已提交
4357 4358 4359
/*
 * "domuuid" command
 */
4360
static const vshCmdInfo info_domuuid[] = {
4361
    {"help", N_("convert a domain name or id to domain UUID")},
4362
    {"desc", ""},
K
Karel Zak 已提交
4363 4364 4365
    {NULL, NULL}
};

4366
static const vshCmdOptDef opts_domuuid[] = {
4367
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
4368 4369 4370
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4371
static bool
4372
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
4373 4374
{
    virDomainPtr dom;
4375
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
4376

4377
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4378
        return false;
J
Jim Meyering 已提交
4379
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4380
                                      VSH_BYNAME|VSH_BYID)))
E
Eric Blake 已提交
4381
        return false;
4382

K
Karel Zak 已提交
4383 4384 4385
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
4386
        vshError(ctl, "%s", _("failed to get domain UUID"));
4387

4388
    virDomainFree(dom);
E
Eric Blake 已提交
4389
    return true;
K
Karel Zak 已提交
4390 4391
}

4392 4393 4394
/*
 * "migrate" command
 */
4395
static const vshCmdInfo info_migrate[] = {
4396 4397
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
4398 4399 4400
    {NULL, NULL}
};

4401
static const vshCmdOptDef opts_migrate[] = {
4402 4403 4404 4405 4406 4407 4408
    {"live", VSH_OT_BOOL, 0, N_("live migration")},
    {"p2p", VSH_OT_BOOL, 0, N_("peer-2-peer migration")},
    {"direct", VSH_OT_BOOL, 0, N_("direct migration")},
    {"tunnelled", VSH_OT_BOOL, 0, N_("tunnelled migration")},
    {"persistent", VSH_OT_BOOL, 0, N_("persist VM on destination")},
    {"undefinesource", VSH_OT_BOOL, 0, N_("undefine VM on source")},
    {"suspend", VSH_OT_BOOL, 0, N_("do not restart the domain on the destination host")},
4409 4410
    {"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)")},
W
Wen Congyang 已提交
4411
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
4412
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4413
    {"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)")},
4414 4415
    {"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 已提交
4416
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
4417
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
4418 4419 4420
    {NULL, 0, 0, NULL}
};

4421 4422 4423 4424 4425 4426 4427 4428
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
4429
{
4430
    char ret = '1';
4431
    virDomainPtr dom = NULL;
4432 4433 4434 4435
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
    int flags = 0;
4436 4437 4438
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
4439 4440
    const char *xmlfile = NULL;
    char *xml = NULL;
4441
    sigset_t sigmask, oldsigmask;
4442 4443 4444 4445 4446

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

4448
    if (!vshConnectionUsability (ctl, ctl->conn))
4449
        goto out;
4450

J
Jim Meyering 已提交
4451
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
4452
        goto out;
4453

4454 4455
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
4456 4457
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
4458
        goto out;
4459
    }
4460

4461 4462 4463 4464 4465
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

4466 4467
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
4468 4469
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
4470
    if (vshCommandOptBool (cmd, "tunnelled"))
4471
        flags |= VIR_MIGRATE_TUNNELLED | VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
4472

C
Chris Lalancette 已提交
4473 4474 4475 4476 4477
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

4478 4479 4480
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

4481 4482 4483 4484 4485 4486
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

4487 4488 4489 4490 4491 4492

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


4493 4494 4495 4496
    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. */
4497

4498
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
4499
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
4500
            goto out;
4501
        }
4502

4503
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
4504
            ret = '0';
4505 4506 4507 4508 4509 4510
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
4511
        if (!dconn) goto out;
4512

4513
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
4514 4515
        if (ddom) {
            virDomainFree(ddom);
4516
            ret = '0';
4517 4518 4519
        }
        virConnectClose (dconn);
    }
4520

4521 4522 4523
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
4524
    if (dom) virDomainFree (dom);
4525
    VIR_FREE(xml);
4526 4527 4528
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
4529
static void
4530
print_job_progress(unsigned long long remaining, unsigned long long total)
W
Wen Congyang 已提交
4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549
{
    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;
        }
    }

4550
    fprintf(stderr, "\rMigration: [%3d %%]", progress);
W
Wen Congyang 已提交
4551 4552
}

E
Eric Blake 已提交
4553
static bool
4554 4555 4556 4557 4558
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
4559
    bool functionReturn = false;
4560 4561 4562 4563 4564
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
4565 4566
    virDomainJobInfo jobinfo;
    bool verbose = false;
4567
    int timeout = 0;
W
Wen Congyang 已提交
4568 4569
    struct timeval start, curr;
    bool live_flag = false;
4570
    vshCtrlData data;
4571 4572 4573 4574
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
4575 4576

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

W
Wen Congyang 已提交
4579 4580 4581
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
4582
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
4583
        live_flag = true;
4584
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601
        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;
        }
    }

4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624
    if (pipe(p) < 0)
        goto cleanup;

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

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

    intCaught = 0;
    sig_action.sa_sigaction = vshCatchInt;
    sig_action.sa_flags = SA_SIGINFO;
    sigemptyset(&sig_action.sa_mask);
    sigaction(SIGINT, &sig_action, &old_sig_action);

    pollfd.fd = p[0];
    pollfd.events = POLLIN;
    pollfd.revents = 0;

W
Wen Congyang 已提交
4625
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
4626
    while (1) {
4627
repoll:
W
Wen Congyang 已提交
4628 4629 4630 4631
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
4632
                    functionReturn = true;
W
Wen Congyang 已提交
4633 4634
                    if (verbose) {
                        /* print [100 %] */
4635
                        print_job_progress(0, 1);
W
Wen Congyang 已提交
4636 4637
                    }
                } else
W
Wen Congyang 已提交
4638
                    functionReturn = false;
4639
            } else
W
Wen Congyang 已提交
4640
                functionReturn = false;
W
Wen Congyang 已提交
4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
4652
            functionReturn = false;
W
Wen Congyang 已提交
4653 4654 4655
            break;
        }

W
Wen Congyang 已提交
4656 4657 4658 4659
        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. */
4660 4661
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "suspend the domain when migration timeouts\n");
W
Wen Congyang 已提交
4662 4663 4664 4665
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
4666 4667 4668 4669 4670
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
4671
                print_job_progress(jobinfo.dataRemaining, jobinfo.dataTotal);
4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
4683
    return functionReturn;
4684 4685
}

4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696
/*
 * "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")},
4697
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
4698 4699 4700
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4701
static bool
4702 4703 4704
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
4705
    long long downtime = 0;
E
Eric Blake 已提交
4706
    bool ret = false;
4707

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

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

4714 4715
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
4716 4717 4718 4719 4720 4721 4722
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
4723
    ret = true;
4724 4725 4726 4727 4728 4729

done:
    virDomainFree(dom);
    return ret;
}

4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773
/*
 * "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;
}

4774 4775 4776
/*
 * "net-autostart" command
 */
4777
static const vshCmdInfo info_network_autostart[] = {
4778
    {"help", N_("autostart a network")},
4779
    {"desc",
4780
     N_("Configure a network to be automatically started at boot.")},
4781 4782 4783
    {NULL, NULL}
};

4784
static const vshCmdOptDef opts_network_autostart[] = {
4785 4786
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4787 4788 4789
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4790
static bool
4791
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
4792 4793
{
    virNetworkPtr network;
4794
    const char *name;
4795 4796
    int autostart;

4797
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4798
        return false;
4799

J
Jim Meyering 已提交
4800
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4801
        return false;
4802 4803 4804 4805

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
4806
        if (autostart)
4807
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
4808
        else
4809
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
4810
        virNetworkFree(network);
E
Eric Blake 已提交
4811
        return false;
4812 4813
    }

4814
    if (autostart)
4815
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
4816
    else
4817
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
4818

L
Laine Stump 已提交
4819
    virNetworkFree(network);
E
Eric Blake 已提交
4820
    return true;
4821
}
K
Karel Zak 已提交
4822

4823 4824 4825
/*
 * "net-create" command
 */
4826
static const vshCmdInfo info_network_create[] = {
4827 4828
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
4829 4830 4831
    {NULL, NULL}
};

4832
static const vshCmdOptDef opts_network_create[] = {
4833
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4834 4835 4836
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4837
static bool
4838
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
4839 4840
{
    virNetworkPtr network;
4841
    const char *from = NULL;
E
Eric Blake 已提交
4842
    bool ret = true;
4843
    char *buffer;
4844

4845
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4846
        return false;
4847

4848
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4849
        return false;
4850

4851
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4852
        return false;
4853 4854

    network = virNetworkCreateXML(ctl->conn, buffer);
4855
    VIR_FREE(buffer);
4856

4857 4858 4859
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4860
        virNetworkFree(network);
4861
    } else {
4862
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
4863
        ret = false;
4864 4865 4866 4867 4868 4869 4870 4871
    }
    return ret;
}


/*
 * "net-define" command
 */
4872
static const vshCmdInfo info_network_define[] = {
4873 4874
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
4875 4876 4877
    {NULL, NULL}
};

4878
static const vshCmdOptDef opts_network_define[] = {
4879
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4880 4881 4882
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4883
static bool
4884
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
4885 4886
{
    virNetworkPtr network;
4887
    const char *from = NULL;
E
Eric Blake 已提交
4888
    bool ret = true;
4889
    char *buffer;
4890

4891
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4892
        return false;
4893

4894
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4895
        return false;
4896

4897
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4898
        return false;
4899 4900

    network = virNetworkDefineXML(ctl->conn, buffer);
4901
    VIR_FREE(buffer);
4902

4903 4904 4905
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4906
        virNetworkFree(network);
4907
    } else {
4908
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
4909
        ret = false;
4910 4911 4912 4913 4914 4915 4916 4917
    }
    return ret;
}


/*
 * "net-destroy" command
 */
4918
static const vshCmdInfo info_network_destroy[] = {
4919 4920
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
4921 4922 4923
    {NULL, NULL}
};

4924
static const vshCmdOptDef opts_network_destroy[] = {
4925
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4926 4927 4928
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4929
static bool
4930
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
4931 4932
{
    virNetworkPtr network;
E
Eric Blake 已提交
4933
    bool ret = true;
4934
    const char *name;
4935

4936
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4937
        return false;
4938

J
Jim Meyering 已提交
4939
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4940
        return false;
4941 4942 4943 4944

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

4949
    virNetworkFree(network);
4950 4951 4952 4953 4954 4955 4956
    return ret;
}


/*
 * "net-dumpxml" command
 */
4957
static const vshCmdInfo info_network_dumpxml[] = {
4958 4959
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
4960 4961 4962
    {NULL, NULL}
};

4963
static const vshCmdOptDef opts_network_dumpxml[] = {
4964
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4965 4966 4967
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4968
static bool
4969
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
4970 4971
{
    virNetworkPtr network;
E
Eric Blake 已提交
4972
    bool ret = true;
4973 4974
    char *dump;

4975
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4976
        return false;
4977

J
Jim Meyering 已提交
4978
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
4979
        return false;
4980 4981 4982

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
4983
        vshPrint(ctl, "%s", dump);
4984
        VIR_FREE(dump);
4985
    } else {
E
Eric Blake 已提交
4986
        ret = false;
4987 4988 4989 4990 4991 4992
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006
/*
 * "net-info" command
 */
static const vshCmdInfo info_network_info[] = {
    {"help", N_("network information")},
    {"desc", "Returns basic information about the network"},
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_info[] = {
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5007
static bool
O
Osier Yang 已提交
5008 5009 5010 5011 5012 5013 5014 5015 5016 5017
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 已提交
5018
        return false;
O
Osier Yang 已提交
5019 5020 5021

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5022
        return false;
O
Osier Yang 已提交
5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048

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

    virNetworkFree(network);
E
Eric Blake 已提交
5049
    return true;
O
Osier Yang 已提交
5050
}
5051

5052 5053 5054 5055
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
5056 5057
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
5058 5059 5060 5061
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
5062
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5063 5064 5065
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5066
static bool
5067 5068
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5069
    bool ret = false;
5070 5071 5072 5073 5074
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
5075
    int flags = VIR_INTERFACE_XML_INACTIVE;
5076

5077
    if (!vshConnectionUsability(ctl, ctl->conn))
5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103
        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 已提交
5104
        ret = true;
5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116
        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)) {
5117 5118
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130
        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 已提交
5131
    ret = true;
5132 5133 5134 5135 5136

cleanup:
    if (iface)
        virInterfaceFree (iface);

5137 5138 5139
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
5140 5141 5142

    if (tmp) {
        unlink (tmp);
5143
        VIR_FREE(tmp);
5144 5145 5146 5147 5148
    }

    return ret;
}

5149 5150 5151
/*
 * "net-list" command
 */
5152
static const vshCmdInfo info_network_list[] = {
5153 5154
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
5155 5156 5157
    {NULL, NULL}
};

5158
static const vshCmdOptDef opts_network_list[] = {
5159 5160
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
5161 5162 5163
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5164
static bool
5165
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5166 5167 5168 5169 5170
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
5171
    char **activeNames = NULL, **inactiveNames = NULL;
5172 5173
    inactive |= all;

5174
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5175
        return false;
5176 5177

    if (active) {
5178 5179
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
5180
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
5181
            return false;
5182
        }
5183
        if (maxactive) {
5184
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
5185

5186
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
5187
                                                    maxactive)) < 0) {
5188
                vshError(ctl, "%s", _("Failed to list active networks"));
5189
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5190
                return false;
5191
            }
5192

5193
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
5194
        }
5195 5196
    }
    if (inactive) {
5197 5198
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
5199
            vshError(ctl, "%s", _("Failed to list inactive networks"));
5200
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5201
            return false;
5202
        }
5203 5204 5205
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5206 5207 5208
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
5209
                vshError(ctl, "%s", _("Failed to list inactive networks"));
5210 5211
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5212
                return false;
5213
            }
5214

5215 5216
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
5217
    }
5218 5219
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
5220
    vshPrintExtra(ctl, "-----------------------------------------\n");
5221 5222

    for (i = 0; i < maxactive; i++) {
5223 5224
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
5225 5226
        const char *autostartStr;
        int autostart = 0;
5227 5228 5229

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5230
            VIR_FREE(activeNames[i]);
5231
            continue;
5232
        }
5233

5234 5235 5236
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5237
            autostartStr = autostart ? _("yes") : _("no");
5238 5239 5240 5241 5242

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
5243
        virNetworkFree(network);
5244
        VIR_FREE(activeNames[i]);
5245 5246 5247
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
5248 5249
        const char *autostartStr;
        int autostart = 0;
5250 5251 5252

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5253
            VIR_FREE(inactiveNames[i]);
5254
            continue;
5255
        }
5256

5257 5258 5259
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5260
            autostartStr = autostart ? _("yes") : _("no");
5261

5262
        vshPrint(ctl, "%-20s %-10s %-10s\n",
5263 5264 5265
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
5266 5267

        virNetworkFree(network);
5268
        VIR_FREE(inactiveNames[i]);
5269
    }
5270 5271
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5272
    return true;
5273 5274 5275 5276 5277 5278
}


/*
 * "net-name" command
 */
5279
static const vshCmdInfo info_network_name[] = {
5280
    {"help", N_("convert a network UUID to network name")},
5281
    {"desc", ""},
5282 5283 5284
    {NULL, NULL}
};

5285
static const vshCmdOptDef opts_network_name[] = {
5286
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
5287 5288 5289
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5290
static bool
5291
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
5292 5293 5294
{
    virNetworkPtr network;

5295
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5296
        return false;
J
Jim Meyering 已提交
5297
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5298
                                           VSH_BYUUID)))
E
Eric Blake 已提交
5299
        return false;
5300 5301 5302

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
5303
    return true;
5304 5305 5306 5307 5308 5309
}


/*
 * "net-start" command
 */
5310
static const vshCmdInfo info_network_start[] = {
5311 5312
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
5313 5314 5315
    {NULL, NULL}
};

5316
static const vshCmdOptDef opts_network_start[] = {
5317
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
5318 5319 5320
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5321
static bool
5322
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
5323 5324
{
    virNetworkPtr network;
E
Eric Blake 已提交
5325
    bool ret = true;
5326

5327
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5328
        return false;
5329

J
Jim Meyering 已提交
5330
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
5331
         return false;
5332 5333 5334

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
5335
                 virNetworkGetName(network));
5336
    } else {
5337
        vshError(ctl, _("Failed to start network %s"),
5338
                 virNetworkGetName(network));
E
Eric Blake 已提交
5339
        ret = false;
5340
    }
L
Laine Stump 已提交
5341
    virNetworkFree(network);
5342 5343 5344 5345 5346 5347 5348
    return ret;
}


/*
 * "net-undefine" command
 */
5349
static const vshCmdInfo info_network_undefine[] = {
5350 5351
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
5352 5353 5354
    {NULL, NULL}
};

5355
static const vshCmdOptDef opts_network_undefine[] = {
5356
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5357 5358 5359
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5360
static bool
5361
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
5362 5363
{
    virNetworkPtr network;
E
Eric Blake 已提交
5364
    bool ret = true;
5365
    const char *name;
5366

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

J
Jim Meyering 已提交
5370
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5371
        return false;
5372 5373 5374 5375

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

L
Laine Stump 已提交
5380
    virNetworkFree(network);
5381 5382 5383 5384 5385 5386 5387
    return ret;
}


/*
 * "net-uuid" command
 */
5388
static const vshCmdInfo info_network_uuid[] = {
5389
    {"help", N_("convert a network name to network UUID")},
5390
    {"desc", ""},
5391 5392 5393
    {NULL, NULL}
};

5394
static const vshCmdOptDef opts_network_uuid[] = {
5395
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
5396 5397 5398
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5399
static bool
5400
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
5401 5402 5403 5404
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

J
Jim Meyering 已提交
5408
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5409
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5410
        return false;
5411 5412 5413 5414

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

L
Laine Stump 已提交
5417
    virNetworkFree(network);
E
Eric Blake 已提交
5418
    return true;
5419 5420 5421
}


5422 5423 5424 5425 5426
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
5427 5428
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
5429 5430 5431 5432
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
5433 5434
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
5435 5436
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
5437
static bool
5438 5439 5440 5441 5442 5443 5444 5445 5446
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;

5447
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5448
        return false;
5449 5450 5451 5452

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
5453
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
5454
            return false;
5455 5456 5457 5458 5459 5460
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
5461
                vshError(ctl, "%s", _("Failed to list active interfaces"));
5462
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5463
                return false;
5464 5465 5466 5467 5468 5469 5470 5471
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
5472
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
5473
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5474
            return false;
5475 5476 5477 5478
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5479 5480 5481
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
5482
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
5483 5484
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5485
                return false;
5486 5487 5488 5489 5490
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
5491 5492
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
5493 5494 5495
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
5496 5497
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
5498 5499 5500

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
5501
            VIR_FREE(activeNames[i]);
5502 5503 5504 5505 5506 5507 5508 5509
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
5510
        VIR_FREE(activeNames[i]);
5511 5512
    }
    for (i = 0; i < maxinactive; i++) {
5513 5514
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
5515 5516 5517

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
5518
            VIR_FREE(inactiveNames[i]);
5519 5520 5521 5522 5523 5524 5525 5526
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
5527
        VIR_FREE(inactiveNames[i]);
5528
    }
5529 5530
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5531
    return true;
5532 5533 5534 5535 5536 5537 5538

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
5539
    {"help", N_("convert an interface MAC address to interface name")},
5540 5541 5542 5543 5544
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
5545
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
5546 5547 5548
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5549
static bool
5550 5551 5552 5553
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

5554
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5555
        return false;
5556 5557
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
5558
        return false;
5559 5560 5561

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
5562
    return true;
5563 5564 5565 5566 5567 5568
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
5569
    {"help", N_("convert an interface name to interface MAC address")},
5570 5571 5572 5573 5574
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
5575
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
5576 5577 5578
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5579
static bool
5580 5581 5582 5583
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

5584
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5585
        return false;
5586 5587
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5588
        return false;
5589 5590 5591

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
5592
    return true;
5593 5594 5595 5596 5597 5598
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
5599 5600
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
5601 5602 5603 5604
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
5605 5606
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
5607 5608 5609
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5610
static bool
5611 5612 5613
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5614
    bool ret = true;
5615
    char *dump;
5616 5617 5618 5619 5620
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
5621

5622
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5623
        return false;
5624 5625

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

5628
    dump = virInterfaceGetXMLDesc(iface, flags);
5629
    if (dump != NULL) {
5630
        vshPrint(ctl, "%s", dump);
5631
        VIR_FREE(dump);
5632
    } else {
E
Eric Blake 已提交
5633
        ret = false;
5634 5635 5636 5637 5638 5639 5640 5641 5642 5643
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
5644 5645
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
5646 5647 5648 5649
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
5650
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
5651 5652 5653
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5654
static bool
5655 5656
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
5657
    virInterfacePtr iface;
5658
    const char *from = NULL;
E
Eric Blake 已提交
5659
    bool ret = true;
5660 5661
    char *buffer;

5662
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5663
        return false;
5664

5665
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5666
        return false;
5667 5668

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

5671
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
5672
    VIR_FREE(buffer);
5673

5674
    if (iface != NULL) {
5675
        vshPrint(ctl, _("Interface %s defined from %s\n"),
5676
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
5677
        virInterfaceFree (iface);
5678
    } else {
5679
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
5680
        ret = false;
5681 5682 5683 5684 5685 5686 5687 5688
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
5689 5690
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
5691 5692 5693 5694
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
5695
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5696 5697 5698
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5699
static bool
5700 5701 5702
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5703
    bool ret = true;
5704
    const char *name;
5705

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

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5710
        return false;
5711 5712 5713 5714

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
5715
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
5716
        ret = false;
5717 5718 5719 5720 5721 5722 5723 5724 5725 5726
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
5727 5728
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
5729 5730 5731 5732
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
5733
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5734 5735 5736
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5737
static bool
5738 5739 5740
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5741
    bool ret = true;
5742
    const char *name;
5743

5744
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5745
        return false;
5746 5747

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5748
        return false;
5749 5750 5751 5752

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
5753
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
5754
        ret = false;
5755 5756 5757 5758 5759 5760 5761 5762 5763 5764
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
5765
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
5766
    {"desc", N_("forcefully stop a physical host interface.")},
5767 5768 5769 5770
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
5771
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5772 5773 5774
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5775
static bool
5776 5777 5778
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5779
    bool ret = true;
5780
    const char *name;
5781

5782
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5783
        return false;
5784 5785

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5786
        return false;
5787 5788 5789 5790

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
5791
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
5792
        ret = false;
5793 5794 5795 5796 5797 5798
    }

    virInterfaceFree(iface);
    return ret;
}

5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883
/*
 * "iface-begin" command
 */
static const vshCmdInfo info_interface_begin[] = {
    {"help", N_("create a snapshot of current interfaces settings, "
                "which can be later commited (iface-commit) or "
                "restored (iface-rollback)")},
    {"desc", N_("Create a restore point for interfaces settings")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_begin[] = {
    {NULL, 0, 0, NULL}
};

static bool
cmdInterfaceBegin(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    if (!vshConnectionUsability(ctl, ctl->conn))
        return false;

    if (virInterfaceChangeBegin(ctl->conn, 0) < 0) {
        vshError(ctl, "%s", _("Failed to begin network config change transaction"));
        return false;
    }

    vshPrint(ctl, "%s", _("Network config change transaction started\n"));
    return true;
}

/*
 * "iface-commit" command
 */
static const vshCmdInfo info_interface_commit[] = {
    {"help", N_("commit changes made since iface-begin and free restore point")},
    {"desc", N_("commit changes and free restore point")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_commit[] = {
    {NULL, 0, 0, NULL}
};

static bool
cmdInterfaceCommit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    if (!vshConnectionUsability(ctl, ctl->conn))
        return false;

    if (virInterfaceChangeCommit(ctl->conn, 0) < 0) {
        vshError(ctl, "%s", _("Failed to commit network config change transaction"));
        return false;
    }

    vshPrint(ctl, "%s", _("Network config change transaction committed\n"));
    return true;
}

/*
 * "iface-rollback" command
 */
static const vshCmdInfo info_interface_rollback[] = {
    {"help", N_("rollback to previous saved configuration created via iface-begin")},
    {"desc", N_("rollback to previous restore point")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_rollback[] = {
    {NULL, 0, 0, NULL}
};

static bool
cmdInterfaceRollback(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    if (!vshConnectionUsability(ctl, ctl->conn))
        return false;

    if (virInterfaceChangeRollback(ctl->conn, 0) < 0) {
        vshError(ctl, "%s", _("Failed to rollback network config change transaction"));
        return false;
    }

    vshPrint(ctl, "%s", _("Network config change transaction rolled back\n"));
    return true;
}
5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898

/*
 * "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 已提交
5899
static bool
5900 5901 5902
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
5903
    const char *from = NULL;
E
Eric Blake 已提交
5904
    bool ret = true;
5905 5906
    char *buffer;

5907
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5908
        return false;
5909

5910
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5911
        return false;
5912 5913

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5914
        return false;
5915 5916 5917 5918 5919 5920 5921 5922 5923 5924

    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 已提交
5925
        ret = false;
5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944
    }
    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 已提交
5945
static bool
5946 5947 5948
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5949
    bool ret = true;
5950
    const char *name;
5951

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

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
5956
        return false;
5957 5958 5959 5960 5961

    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 已提交
5962
        ret = false;
5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983
    }

    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 已提交
5984
static bool
5985 5986 5987
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5988
    bool ret = true;
5989 5990
    char *dump;

5991
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5992
        return false;
5993 5994

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
5995
        return false;
5996 5997 5998

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
5999
        vshPrint(ctl, "%s", dump);
6000 6001
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
6002
        ret = false;
6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021
    }

    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 已提交
6022
static bool
6023 6024 6025 6026 6027 6028
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

6029
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6030
        return false;
6031 6032 6033 6034

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
6035
        return false;
6036 6037 6038 6039 6040 6041 6042 6043
    }

    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 已提交
6044
        return false;
6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071
    }

    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 已提交
6072
    return true;
6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089
}


/*
 * "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 已提交
6090
static bool
6091 6092
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6093
    bool ret = false;
6094 6095 6096 6097 6098 6099
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

6100
    if (!vshConnectionUsability(ctl, ctl->conn))
6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126
        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 已提交
6127
        ret = true;
6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153
        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 已提交
6154
    ret = true;
6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172

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


6173
/**************************************************************************/
6174
/*
6175
 * "pool-autostart" command
6176
 */
6177
static const vshCmdInfo info_pool_autostart[] = {
6178
    {"help", N_("autostart a pool")},
6179
    {"desc",
6180
     N_("Configure a pool to be automatically started at boot.")},
6181
    {NULL, NULL}
6182 6183
};

6184
static const vshCmdOptDef opts_pool_autostart[] = {
6185 6186
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6187 6188
    {NULL, 0, 0, NULL}
};
6189

E
Eric Blake 已提交
6190
static bool
6191
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
6192
{
6193
    virStoragePoolPtr pool;
6194
    const char *name;
6195
    int autostart;
6196

6197
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6198
        return false;
6199

6200
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6201
        return false;
6202

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

6205 6206
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
6207
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
6208
        else
6209
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
6210
        virStoragePoolFree(pool);
E
Eric Blake 已提交
6211
        return false;
6212 6213
    }

6214
    if (autostart)
6215
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
6216
    else
6217
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
6218

L
Laine Stump 已提交
6219
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6220
    return true;
6221 6222
}

6223
/*
6224
 * "pool-create" command
6225
 */
6226
static const vshCmdInfo info_pool_create[] = {
6227 6228
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
6229 6230 6231
    {NULL, NULL}
};

6232
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
6233
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
6234
     N_("file containing an XML pool description")},
6235 6236 6237
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6238
static bool
6239
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
6240
{
6241
    virStoragePoolPtr pool;
6242
    const char *from = NULL;
E
Eric Blake 已提交
6243
    bool ret = true;
6244
    char *buffer;
6245

6246
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6247
        return false;
6248

6249
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6250
        return false;
6251

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

6255
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
6256
    VIR_FREE(buffer);
6257 6258 6259 6260

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6261
        virStoragePoolFree(pool);
6262
    } else {
6263
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
6264
        ret = false;
6265 6266
    }
    return ret;
6267 6268
}

6269

6270 6271 6272 6273
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
6274
    {"help", N_("create a device defined "
6275
                          "by an XML file on the node")},
6276
    {"desc", N_("Create a device on the node.  Note that this "
6277 6278 6279 6280 6281 6282 6283
                          "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,
6284
     N_("file containing an XML description of the device")},
6285 6286 6287
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6288
static bool
6289 6290 6291
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
6292
    const char *from = NULL;
E
Eric Blake 已提交
6293
    bool ret = true;
6294 6295
    char *buffer;

6296
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6297
        return false;
6298

6299
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6300
        return false;
6301

6302
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6303
        return false;
6304 6305

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
6306
    VIR_FREE(buffer);
6307 6308 6309 6310

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
6311
        virNodeDeviceFree(dev);
6312
    } else {
6313
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
6314
        ret = false;
6315 6316 6317 6318 6319 6320 6321 6322 6323 6324
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
6325
    {"help", N_("destroy (stop) a device on the node")},
6326
    {"desc", N_("Destroy a device on the node.  Note that this "
6327
                "command destroys devices on the physical host")},
6328 6329 6330 6331 6332
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
6333
     N_("name of the device to be destroyed")},
6334 6335 6336
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6337
static bool
6338 6339 6340
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
6341
    bool ret = true;
6342
    const char *name = NULL;
6343

6344
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
6345
        return false;
6346 6347
    }

6348
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
6349
        return false;
6350 6351 6352 6353 6354 6355

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
6356
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
6357
        ret = false;
6358 6359 6360 6361 6362 6363 6364
    }

    virNodeDeviceFree(dev);
    return ret;
}


6365
/*
6366
 * XML Building helper for pool-define-as and pool-create-as
6367
 */
6368
static const vshCmdOptDef opts_pool_X_as[] = {
6369 6370 6371 6372 6373 6374 6375 6376
    {"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")},
6377
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
6378 6379 6380
    {NULL, 0, 0, NULL}
};

6381
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
6382

6383 6384
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
6385
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6386

6387
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6388
        goto cleanup;
6389
    if (vshCommandOptString(cmd, "type", &type) <= 0)
6390 6391
        goto cleanup;

6392 6393 6394 6395 6396
    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 ||
6397 6398
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
6399
        goto cleanup;
6400
    }
6401

6402 6403
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
6404
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
6405
        virBufferAddLit(&buf, "  <source>\n");
6406

6407
        if (srcHost)
6408
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
6409
        if (srcPath)
6410
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
6411
        if (srcDev)
6412
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
6413
        if (srcFormat)
6414
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
6415
        if (srcName)
6416
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
6417 6418

        virBufferAddLit(&buf, "  </source>\n");
6419 6420
    }
    if (target) {
6421
        virBufferAddLit(&buf, "  <target>\n");
6422
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
6423
        virBufferAddLit(&buf, "  </target>\n");
6424
    }
6425 6426 6427 6428
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
6429
        return false;
6430
    }
6431 6432 6433

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
6434
    return true;
6435 6436

cleanup:
6437
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6438
    return false;
6439 6440 6441 6442 6443 6444
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
6445 6446
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
6447 6448 6449
    {NULL, NULL}
};

E
Eric Blake 已提交
6450
static bool
6451 6452 6453
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
6454 6455
    const char *name;
    char *xml;
6456
    int printXML = vshCommandOptBool(cmd, "print-xml");
6457

6458
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6459
        return false;
6460 6461

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

6464
    if (printXML) {
6465
        vshPrint(ctl, "%s", xml);
6466
        VIR_FREE(xml);
6467
    } else {
6468
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
6469
        VIR_FREE(xml);
6470

6471 6472 6473 6474
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
6475
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
6476
            return false;
6477 6478
        }
    }
E
Eric Blake 已提交
6479
    return true;
6480 6481
}

6482

6483
/*
6484
 * "pool-define" command
6485
 */
6486
static const vshCmdInfo info_pool_define[] = {
6487 6488
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
6489 6490 6491
    {NULL, NULL}
};

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

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

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

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

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

6514
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
6515
    VIR_FREE(buffer);
6516 6517 6518 6519

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6520
        virStoragePoolFree(pool);
6521
    } else {
6522
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
6523
        ret = false;
6524 6525
    }
    return ret;
6526 6527
}

6528

6529 6530 6531
/*
 * "pool-define-as" command
 */
6532
static const vshCmdInfo info_pool_define_as[] = {
6533 6534
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
6535 6536 6537
    {NULL, NULL}
};

E
Eric Blake 已提交
6538
static bool
6539
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
6540 6541
{
    virStoragePoolPtr pool;
6542 6543
    const char *name;
    char *xml;
6544
    int printXML = vshCommandOptBool(cmd, "print-xml");
6545

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

6549
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
6550
        return false;
6551

6552
    if (printXML) {
6553
        vshPrint(ctl, "%s", xml);
6554
        VIR_FREE(xml);
6555
    } else {
6556
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
6557
        VIR_FREE(xml);
6558

6559 6560 6561 6562
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
6563
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
6564
            return false;
6565 6566
        }
    }
E
Eric Blake 已提交
6567
    return true;
6568 6569 6570
}


6571
/*
6572
 * "pool-build" command
6573
 */
6574
static const vshCmdInfo info_pool_build[] = {
6575 6576
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
6577 6578 6579
    {NULL, NULL}
};

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

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

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

6595
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6596
        return false;
6597

6598
    if (virStoragePoolBuild(pool, 0) == 0) {
6599
        vshPrint(ctl, _("Pool %s built\n"), name);
6600
    } else {
6601
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
6602
        ret = false;
6603 6604
    }

6605 6606
    virStoragePoolFree(pool);

6607 6608 6609
    return ret;
}

6610

6611
/*
6612
 * "pool-destroy" command
6613
 */
6614
static const vshCmdInfo info_pool_destroy[] = {
6615 6616 6617
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
6618 6619 6620
    {NULL, NULL}
};

6621
static const vshCmdOptDef opts_pool_destroy[] = {
6622
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6623 6624 6625
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6626
static bool
6627
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
6628
{
6629
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6630
    bool ret = true;
6631
    const char *name;
6632

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

6636
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6637
        return false;
6638

6639 6640 6641
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
6642
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
6643
        ret = false;
6644 6645
    }

6646
    virStoragePoolFree(pool);
6647 6648 6649
    return ret;
}

6650

6651
/*
6652 6653
 * "pool-delete" command
 */
6654
static const vshCmdInfo info_pool_delete[] = {
6655 6656
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
6657 6658 6659
    {NULL, NULL}
};

6660
static const vshCmdOptDef opts_pool_delete[] = {
6661
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6662 6663 6664
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6665
static bool
6666
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
6667 6668
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6669
    bool ret = true;
6670
    const char *name;
6671

6672
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6673
        return false;
6674 6675

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6676
        return false;
6677 6678

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
6679
        vshPrint(ctl, _("Pool %s deleted\n"), name);
6680
    } else {
6681
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
6682
        ret = false;
6683 6684
    }

L
Laine Stump 已提交
6685
    virStoragePoolFree(pool);
6686 6687 6688 6689 6690 6691 6692
    return ret;
}


/*
 * "pool-refresh" command
 */
6693
static const vshCmdInfo info_pool_refresh[] = {
6694 6695
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
6696 6697 6698
    {NULL, NULL}
};

6699
static const vshCmdOptDef opts_pool_refresh[] = {
6700
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6701 6702 6703
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6704
static bool
6705
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
6706 6707
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6708
    bool ret = true;
6709
    const char *name;
6710

6711
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6712
        return false;
6713 6714

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6715
        return false;
6716 6717 6718 6719

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
6720
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
6721
        ret = false;
6722 6723 6724 6725 6726 6727 6728 6729 6730 6731
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
6732
static const vshCmdInfo info_pool_dumpxml[] = {
6733 6734
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
6735 6736 6737
    {NULL, NULL}
};

6738
static const vshCmdOptDef opts_pool_dumpxml[] = {
6739
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6740 6741 6742
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6743
static bool
6744
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
6745 6746
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6747
    bool ret = true;
6748 6749
    char *dump;

6750
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6751
        return false;
6752 6753

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6754
        return false;
6755 6756 6757

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
6758
        vshPrint(ctl, "%s", dump);
6759
        VIR_FREE(dump);
6760
    } else {
E
Eric Blake 已提交
6761
        ret = false;
6762 6763 6764 6765 6766 6767 6768 6769 6770 6771
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
6772
static const vshCmdInfo info_pool_list[] = {
6773 6774
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
6775 6776 6777
    {NULL, NULL}
};

6778
static const vshCmdOptDef opts_pool_list[] = {
6779 6780
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
6781
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
6782 6783 6784
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6785
static bool
6786
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6787
{
6788 6789
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
6790 6791
    int i, ret;
    bool functionReturn;
6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807
    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 */
6808
    int all = vshCommandOptBool(cmd, "all");
6809 6810
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
6811 6812 6813
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

6814
    /* Check the connection to libvirtd daemon is still working */
6815
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6816
        return false;
6817

6818
    /* Retrieve the number of active storage pools */
6819
    if (active) {
6820 6821
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
6822
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
6823
            return false;
6824 6825
        }
    }
6826 6827

    /* Retrieve the number of inactive storage pools */
6828
    if (inactive) {
6829 6830
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
6831
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
6832
            return false;
6833
        }
6834
    }
6835

6836 6837
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
6838

6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850
    /* 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 已提交
6851
            return false;
6852 6853 6854
        }
    }

6855 6856 6857 6858 6859 6860 6861 6862
    /* 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 已提交
6863
            return false;
6864 6865
        }
    }
6866

6867 6868 6869 6870 6871 6872 6873 6874 6875 6876
    /* 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]);
6877
        if (!pool) {
6878
            VIR_FREE(poolNames[i]);
6879 6880 6881
            continue;
        }

6882
        /* Retrieve the autostart status of the pool */
6883
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
6884
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
6885
        else
6886 6887 6888 6889 6890 6891
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
6892 6893
            vshDebug(ctl, VSH_ERR_DEBUG, "Persistent flag value: %d\n",
                     persistent);
6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904
            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;
        }
6905

6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017
        /* 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 */
7018 7019 7020
        virStoragePoolFree(pool);
    }

7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038
    /* 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);
7039 7040
        }

7041
        /* Cleanup and return */
E
Eric Blake 已提交
7042
        functionReturn = true;
7043 7044
        goto cleanup;
    }
7045

7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083
    /* 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. */
7084
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest name string = %lu chars\n",
7085
             (unsigned long) nameStrLength);
7086
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest state string = %lu chars\n",
7087
             (unsigned long) stateStrLength);
7088
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest autostart string = %lu chars\n",
7089
             (unsigned long) autostartStrLength);
7090
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest persistent string = %lu chars\n",
7091
             (unsigned long) persistStrLength);
7092
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest capacity string = %lu chars\n",
7093
             (unsigned long) capStrLength);
7094
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest allocation string = %lu chars\n",
7095
             (unsigned long) allocStrLength);
7096
    vshDebug(ctl, VSH_ERR_DEBUG, "Longest available string = %lu chars\n",
7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139
             (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 已提交
7140
    functionReturn = true;
7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154
    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 已提交
7155
    functionReturn = false;
7156

7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168
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]);
7169
    }
7170 7171 7172 7173 7174 7175 7176

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

    /* Return the desired value */
    return functionReturn;
7177 7178
}

7179 7180 7181 7182
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
7183 7184
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7185 7186 7187 7188 7189
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7190 7191 7192
     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")},
7193
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
7194 7195 7196
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7197
static bool
7198 7199
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7200
    const char *type = NULL, *host = NULL;
7201 7202
    char *srcSpec = NULL;
    char *srcList;
7203
    const char *initiator = NULL;
7204

7205 7206
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
7207 7208
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
7209
        return false;
7210
    }
7211

7212
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7213
        return false;
7214 7215

    if (host) {
7216
        const char *port = NULL;
7217
        virBuffer buf = VIR_BUFFER_INITIALIZER;
7218 7219 7220 7221

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7222
            return false;
7223
        }
7224
        virBufferAddLit(&buf, "<source>\n");
7225
        virBufferAsprintf(&buf, "  <host name='%s'", host);
7226
        if (port)
7227
            virBufferAsprintf(&buf, " port='%s'", port);
7228
        virBufferAddLit(&buf, "/>\n");
7229 7230
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
7231
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
7232 7233
            virBufferAddLit(&buf, "  </initiator>\n");
        }
7234 7235 7236
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
7237
            return false;
7238
        }
7239
        srcSpec = virBufferContentAndReset(&buf);
7240 7241 7242
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7243
    VIR_FREE(srcSpec);
7244
    if (srcList == NULL) {
7245
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7246
        return false;
7247 7248
    }
    vshPrint(ctl, "%s", srcList);
7249
    VIR_FREE(srcList);
7250

E
Eric Blake 已提交
7251
    return true;
7252 7253 7254 7255 7256 7257 7258
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
7259 7260
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7261 7262 7263 7264 7265
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7266
     N_("type of storage pool sources to discover")},
7267
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
7268
     N_("optional file of source xml to query for pools")},
7269 7270 7271
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7272
static bool
7273 7274
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7275
    const char *type = NULL, *srcSpecFile = NULL;
7276
    char *srcSpec = NULL, *srcList;
7277

7278
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
7279
        return false;
7280

7281 7282
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
7283
        return false;
7284
    }
7285

7286
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7287
        return false;
7288 7289

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
7290
        return false;
7291 7292

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7293
    VIR_FREE(srcSpec);
7294
    if (srcList == NULL) {
7295
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7296
        return false;
7297 7298
    }
    vshPrint(ctl, "%s", srcList);
7299
    VIR_FREE(srcList);
7300

E
Eric Blake 已提交
7301
    return true;
7302 7303 7304
}


7305 7306 7307
/*
 * "pool-info" command
 */
7308
static const vshCmdInfo info_pool_info[] = {
7309 7310
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
7311 7312 7313
    {NULL, NULL}
};

7314
static const vshCmdOptDef opts_pool_info[] = {
7315
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7316 7317 7318
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7319
static bool
7320
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
7321 7322 7323
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
7324 7325
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
7326
    bool ret = true;
7327 7328
    char uuid[VIR_UUID_STRING_BUFLEN];

7329
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7330
        return false;
7331 7332

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7333
        return false;
7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359

    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;
7360 7361 7362 7363
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
7364 7365
        }

7366 7367
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
7368 7369
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool persistent flag value: %d\n",
                 persistent);
7370 7371 7372 7373 7374 7375 7376
        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);
7377 7378
        vshDebug(ctl, VSH_ERR_DEBUG, "Pool autostart flag value: %d\n",
                 autostart);
7379 7380 7381 7382 7383
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395
        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 已提交
7396
        ret = false;
7397 7398 7399 7400 7401 7402 7403 7404 7405 7406
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
7407
static const vshCmdInfo info_pool_name[] = {
7408
    {"help", N_("convert a pool UUID to pool name")},
7409
    {"desc", ""},
7410 7411 7412
    {NULL, NULL}
};

7413
static const vshCmdOptDef opts_pool_name[] = {
7414
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
7415 7416 7417
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7418
static bool
7419
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
7420 7421 7422
{
    virStoragePoolPtr pool;

7423
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7424
        return false;
7425
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7426
                                           VSH_BYUUID)))
E
Eric Blake 已提交
7427
        return false;
7428 7429 7430

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7431
    return true;
7432 7433 7434 7435 7436 7437
}


/*
 * "pool-start" command
 */
7438
static const vshCmdInfo info_pool_start[] = {
7439 7440
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
7441 7442 7443
    {NULL, NULL}
};

7444
static const vshCmdOptDef opts_pool_start[] = {
7445
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
7446 7447 7448
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7449
static bool
7450
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
7451 7452
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7453
    bool ret = true;
7454

7455
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7456
        return false;
7457

7458
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
7459
         return false;
7460 7461 7462 7463 7464

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
7465
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
7466
        ret = false;
7467
    }
L
Laine Stump 已提交
7468 7469

    virStoragePoolFree(pool);
7470 7471 7472 7473
    return ret;
}


7474 7475 7476
/*
 * "vol-create-as" command
 */
7477
static const vshCmdInfo info_vol_create_as[] = {
7478 7479
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
7480 7481 7482
    {NULL, NULL}
};

7483
static const vshCmdOptDef opts_vol_create_as[] = {
7484 7485 7486 7487 7488
    {"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")},
7489 7490
    {"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")},
7491 7492 7493 7494 7495 7496 7497 7498 7499 7500
    {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 已提交
7501
        /* Deliberate fallthrough cases here :-) */
7502 7503 7504
        switch (*end) {
        case 'T':
            *val *= 1024;
7505
            /* fallthrough */
7506 7507
        case 'G':
            *val *= 1024;
7508
            /* fallthrough */
7509 7510
        case 'M':
            *val *= 1024;
7511
            /* fallthrough */
7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
7525
static bool
7526
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
7527 7528 7529
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7530
    char *xml;
7531 7532
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
7533
    unsigned long long capacity, allocation = 0;
7534
    virBuffer buf = VIR_BUFFER_INITIALIZER;
7535

7536
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7537
        return false;
7538 7539 7540

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

7543
    if (vshCommandOptString(cmd, "name", &name) <= 0)
7544 7545
        goto cleanup;

7546
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
7547 7548
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
7549
        vshError(ctl, _("Malformed size %s"), capacityStr);
7550

7551 7552
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
7553
        vshError(ctl, _("Malformed size %s"), allocationStr);
7554

7555 7556 7557 7558 7559 7560 7561
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

7562

7563
    virBufferAddLit(&buf, "<volume>\n");
7564 7565
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
7566
    if (allocationStr)
7567
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
7568 7569

    if (format) {
7570
        virBufferAddLit(&buf, "  <target>\n");
7571
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
7572
        virBufferAddLit(&buf, "  </target>\n");
7573
    }
7574

7575 7576 7577 7578
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
7579 7580
        vshDebug(ctl, VSH_ERR_DEBUG,
                 "%s: Look up backing store volume '%s' as name\n",
7581 7582 7583
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
7584 7585
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as name\n",
7586 7587 7588 7589 7590
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
7591 7592
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as key\n",
7593 7594 7595
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
7596 7597
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as key\n",
7598 7599 7600 7601 7602
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
7603 7604
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: Look up backing store volume '%s' as path\n",
7605 7606 7607
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
7608 7609
                vshDebug(ctl, VSH_ERR_DEBUG,
                         "%s: Backing store volume found using '%s' as path\n",
7610 7611 7612 7613
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
E
Eric Blake 已提交
7614
            return false;
7615 7616 7617 7618 7619
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
7620
            return false;
7621 7622 7623 7624
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
7625
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
7626
        if (snapshotStrFormat)
7627
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
7628 7629 7630 7631 7632 7633 7634 7635
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

7637 7638
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7639
        return false;
7640 7641 7642
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
7643
    VIR_FREE(xml);
7644 7645 7646 7647 7648
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
7649
        return true;
7650
    } else {
7651
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
7652
        return false;
7653 7654 7655
    }

 cleanup:
7656
    virBufferFreeAndReset(&buf);
7657
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7658
    return false;
7659 7660 7661
}


7662 7663 7664
/*
 * "pool-undefine" command
 */
7665
static const vshCmdInfo info_pool_undefine[] = {
7666 7667
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
7668 7669 7670
    {NULL, NULL}
};

7671
static const vshCmdOptDef opts_pool_undefine[] = {
7672
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7673 7674 7675
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7676
static bool
7677
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
7678 7679
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7680
    bool ret = true;
7681
    const char *name;
7682

7683
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7684
        return false;
7685 7686

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7687
        return false;
7688 7689 7690 7691

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

L
Laine Stump 已提交
7696
    virStoragePoolFree(pool);
7697 7698 7699 7700 7701 7702 7703
    return ret;
}


/*
 * "pool-uuid" command
 */
7704
static const vshCmdInfo info_pool_uuid[] = {
7705
    {"help", N_("convert a pool name to pool UUID")},
7706
    {"desc", ""},
7707 7708 7709
    {NULL, NULL}
};

7710
static const vshCmdOptDef opts_pool_uuid[] = {
7711
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
7712 7713 7714
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7715
static bool
7716
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
7717 7718 7719 7720
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

7721
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7722
        return false;
7723 7724

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7725
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7726
        return false;
7727 7728 7729 7730

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

L
Laine Stump 已提交
7733
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7734
    return true;
7735 7736 7737 7738 7739 7740
}


/*
 * "vol-create" command
 */
7741
static const vshCmdInfo info_vol_create[] = {
7742 7743
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
7744 7745 7746
    {NULL, NULL}
};

7747
static const vshCmdOptDef opts_vol_create[] = {
7748 7749
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
7750 7751 7752
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7753
static bool
7754
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
7755 7756 7757
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7758
    const char *from = NULL;
E
Eric Blake 已提交
7759
    bool ret = true;
7760 7761
    char *buffer;

7762
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7763
        return false;
7764 7765

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

7769
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7770
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7771
        return false;
7772 7773 7774
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7775
        virshReportError(ctl);
7776
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7777
        return false;
7778 7779 7780
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
7781
    VIR_FREE(buffer);
7782 7783 7784 7785 7786 7787 7788
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
7789
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
7790
        ret = false;
7791 7792 7793 7794
    }
    return ret;
}

7795 7796 7797 7798
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
7799 7800
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
7801 7802 7803 7804
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
7805 7806 7807
    {"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 已提交
7808
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
7809 7810 7811
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7812
static bool
7813 7814 7815 7816
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
7817
    const char *from = NULL;
E
Eric Blake 已提交
7818
    bool ret = false;
7819 7820
    char *buffer = NULL;

7821
    if (!vshConnectionUsability(ctl, ctl->conn))
7822 7823 7824 7825 7826
        goto cleanup;

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

7827
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7828 7829 7830 7831 7832 7833 7834
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7835
        virshReportError(ctl);
7836 7837 7838 7839 7840 7841 7842 7843 7844
        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 {
7845
        vshError(ctl, _("Failed to create vol from %s"), from);
7846 7847 7848
        goto cleanup;
    }

E
Eric Blake 已提交
7849
    ret = true;
7850
cleanup:
7851
    VIR_FREE(buffer);
7852 7853 7854 7855
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
7856 7857
    if (newvol)
        virStorageVolFree(newvol);
7858 7859 7860 7861
    return ret;
}

static xmlChar *
7862
makeCloneXML(const char *origxml, const char *newname) {
7863

7864 7865 7866
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896
    xmlChar *newxml = NULL;
    int size;

    doc = xmlReadDoc((const xmlChar *) origxml, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET | XML_PARSE_NOWARNING);
    if (!doc)
        goto cleanup;
    ctxt = xmlXPathNewContext(doc);
    if (!ctxt)
        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[] = {
7897 7898
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
7899 7900 7901 7902
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
7903 7904
    {"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 已提交
7905
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7906 7907 7908
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7909
static bool
7910 7911 7912 7913
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
7914
    const char *name = NULL;
7915
    char *origxml = NULL;
7916
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
7917
    bool ret = false;
7918

7919
    if (!vshConnectionUsability(ctl, ctl->conn))
7920 7921 7922 7923 7924 7925 7926
        goto cleanup;

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

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
7927
        vshError(ctl, "%s", _("failed to get parent pool"));
7928 7929 7930
        goto cleanup;
    }

7931
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949
        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 {
7950
        vshError(ctl, _("Failed to clone vol from %s"),
7951 7952 7953 7954
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
7955
    ret = true;
7956 7957

cleanup:
7958
    VIR_FREE(origxml);
7959 7960 7961
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
7962 7963
    if (newvol)
        virStorageVolFree(newvol);
7964 7965 7966 7967 7968
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981

/*
 * "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 已提交
7982
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996
    {"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 已提交
7997
static bool
7998 7999 8000 8001
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8002
    bool ret = false;
8003 8004 8005 8006 8007 8008 8009 8010 8011 8012
    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 已提交
8013
        return false;
8014 8015 8016 8017
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8018
        return false;
8019 8020 8021
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8022
        return false;
8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056
    }

    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 已提交
8057
    ret = true;
8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081

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 已提交
8082
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8083 8084 8085 8086 8087
    {"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 已提交
8088
static bool
8089 8090 8091 8092
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8093
    bool ret = false;
8094 8095 8096 8097
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
8098
    bool created = false;
8099 8100

    if (!vshConnectionUsability(ctl, ctl->conn))
8101
        return false;
8102 8103 8104

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8105
        return false;
8106 8107 8108 8109
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8110
        return false;
8111 8112 8113
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
8114
        return false;
8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126

    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;
        }
8127 8128
    } else {
        created = true;
8129 8130 8131 8132 8133 8134 8135 8136
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

8137
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152
        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 已提交
8153
    ret = true;
8154 8155

cleanup:
8156
    VIR_FORCE_CLOSE(fd);
8157
    if (!ret && created)
8158 8159 8160 8161 8162 8163 8164 8165 8166
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


8167 8168 8169
/*
 * "vol-delete" command
 */
8170
static const vshCmdInfo info_vol_delete[] = {
8171 8172
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
8173 8174 8175
    {NULL, NULL}
};

8176
static const vshCmdOptDef opts_vol_delete[] = {
8177
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8178
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8179 8180 8181
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8182
static bool
8183
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
8184 8185
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8186
    bool ret = true;
8187
    const char *name;
8188

8189
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8190
        return false;
8191 8192

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8193
        return false;
8194 8195 8196
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
8197
        vshPrint(ctl, _("Vol %s deleted\n"), name);
8198
    } else {
8199
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
8200
        ret = false;
8201 8202
    }

L
Laine Stump 已提交
8203
    virStorageVolFree(vol);
8204 8205 8206 8207
    return ret;
}


D
David Allan 已提交
8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218
/*
 * "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 已提交
8219
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
8220 8221 8222
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8223
static bool
D
David Allan 已提交
8224 8225 8226
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8227
    bool ret = true;
8228
    const char *name;
D
David Allan 已提交
8229

8230
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8231
        return false;
D
David Allan 已提交
8232 8233

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8234
        return false;
D
David Allan 已提交
8235 8236 8237 8238 8239 8240
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
8241
        ret = false;
D
David Allan 已提交
8242 8243 8244 8245 8246 8247 8248
    }

    virStorageVolFree(vol);
    return ret;
}


8249 8250 8251
/*
 * "vol-info" command
 */
8252
static const vshCmdInfo info_vol_info[] = {
8253 8254
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
8255 8256 8257
    {NULL, NULL}
};

8258
static const vshCmdOptDef opts_vol_info[] = {
8259
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8260
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8261 8262 8263
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8264
static bool
8265
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
8266 8267 8268
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
8269
    bool ret = true;
8270

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

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8275
        return false;
8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291

    vshPrint(ctl, "%-15s %s\n", _("Name:"), virStorageVolGetName(vol));

    if (virStorageVolGetInfo(vol, &info) == 0) {
        double val;
        const char *unit;
        vshPrint(ctl, "%-15s %s\n", _("Type:"),
                 info.type == VIR_STORAGE_VOL_FILE ?
                 _("file") : _("block"));

        val = prettyCapacity(info.capacity, &unit);
        vshPrint(ctl, "%-15s %2.2lf %s\n", _("Capacity:"), val, unit);

        val = prettyCapacity(info.allocation, &unit);
        vshPrint(ctl, "%-15s %2.2lf %s\n", _("Allocation:"), val, unit);
    } else {
E
Eric Blake 已提交
8292
        ret = false;
8293 8294 8295 8296 8297 8298 8299 8300 8301 8302
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
8303
static const vshCmdInfo info_vol_dumpxml[] = {
8304 8305
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
8306 8307 8308
    {NULL, NULL}
};

8309
static const vshCmdOptDef opts_vol_dumpxml[] = {
8310
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8311
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8312 8313 8314
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8315
static bool
8316
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
8317 8318
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8319
    bool ret = true;
8320 8321
    char *dump;

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

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8326
        return false;
8327 8328 8329

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
8330
        vshPrint(ctl, "%s", dump);
8331
        VIR_FREE(dump);
8332
    } else {
E
Eric Blake 已提交
8333
        ret = false;
8334 8335 8336 8337 8338 8339 8340 8341 8342 8343
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
8344
static const vshCmdInfo info_vol_list[] = {
8345 8346
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
8347 8348 8349
    {NULL, NULL}
};

8350
static const vshCmdOptDef opts_vol_list[] = {
8351
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8352
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
8353 8354 8355
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8356
static bool
8357
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8358
{
8359
    virStorageVolInfo volumeInfo;
8360 8361
    virStoragePoolPtr pool;
    char **activeNames = NULL;
8362 8363 8364 8365 8366
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
8367 8368
    int ret;
    bool functionReturn;
8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379
    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;
8380

8381
    /* Check the connection to libvirtd daemon is still working */
8382
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8383
        return false;
8384

8385
    /* Look up the pool information given to us by the user */
8386
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8387
        return false;
8388

8389 8390
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
8391

8392 8393 8394
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8395
        return false;
8396 8397
    }

8398 8399 8400 8401 8402
    /* 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) {
8403
            vshError(ctl, "%s", _("Failed to list active vols"));
8404
            VIR_FREE(activeNames);
8405
            virStoragePoolFree(pool);
E
Eric Blake 已提交
8406
            return false;
8407 8408
        }

8409 8410 8411 8412 8413
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

        /* Set aside memory for volume information pointers */
        volInfoTexts = vshCalloc(ctl, numVolumes, sizeof(*volInfoTexts));
8414 8415
    }

8416 8417 8418 8419 8420
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
8421

8422 8423 8424 8425
        /* 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"));
8426 8427
        }

8428 8429 8430 8431 8432 8433 8434 8435 8436
        /* 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 */
8437

8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492
                /* Volume type */
                if (volumeInfo.type == VIR_STORAGE_VOL_FILE)
                    volInfoTexts[i].type = vshStrdup(ctl, _("file"));
                else
                    volInfoTexts[i].type = vshStrdup(ctl, _("block"));

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

8494
        /* Cleanup memory allocation */
8495
        virStorageVolFree(vol);
8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513
    }

    /* 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 已提交
8514
        functionReturn = true;
8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545
        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 */
8546 8547 8548 8549 8550 8551 8552 8553 8554 8555
    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);
8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589

    /* 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 已提交
8590
    functionReturn = true;
8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604
    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 已提交
8605
    functionReturn = false;
8606 8607 8608 8609 8610 8611 8612 8613 8614 8615

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);
8616
        VIR_FREE(activeNames[i]);
8617
    }
8618 8619 8620 8621

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
8622
    VIR_FREE(activeNames);
8623
    virStoragePoolFree(pool);
8624 8625 8626

    /* Return the desired value */
    return functionReturn;
8627 8628 8629 8630 8631 8632
}


/*
 * "vol-name" command
 */
8633
static const vshCmdInfo info_vol_name[] = {
8634
    {"help", N_("returns the volume name for a given volume key or path")},
8635
    {"desc", ""},
8636 8637 8638
    {NULL, NULL}
};

8639
static const vshCmdOptDef opts_vol_name[] = {
8640
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
8641 8642 8643
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8644
static bool
8645
cmdVolName(vshControl *ctl, const vshCmd *cmd)
8646 8647 8648
{
    virStorageVolPtr vol;

8649
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8650
        return false;
8651 8652 8653

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
E
Eric Blake 已提交
8654
        return false;
8655 8656 8657

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8658
    return true;
8659 8660 8661
}


J
Justin Clift 已提交
8662 8663 8664 8665 8666 8667 8668 8669 8670 8671
/*
 * "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[] = {
8672
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
8673 8674 8675 8676
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8677
static bool
J
Justin Clift 已提交
8678 8679 8680 8681
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8682
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
8683 8684

    /* Check the connection to libvirtd daemon is still working */
8685
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8686
        return false;
J
Justin Clift 已提交
8687 8688 8689 8690

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
8691
        return false;
J
Justin Clift 已提交
8692 8693 8694 8695 8696 8697 8698
    }

    /* 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 已提交
8699
        return false;
J
Justin Clift 已提交
8700 8701
    }

8702 8703 8704 8705 8706 8707 8708 8709 8710
    /* 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 已提交
8711 8712 8713 8714

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8715
    return true;
J
Justin Clift 已提交
8716 8717
}

8718 8719 8720 8721

/*
 * "vol-key" command
 */
8722
static const vshCmdInfo info_vol_key[] = {
8723
    {"help", N_("returns the volume key for a given volume name or path")},
8724
    {"desc", ""},
8725 8726 8727
    {NULL, NULL}
};

8728
static const vshCmdOptDef opts_vol_key[] = {
8729
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
8730
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8731 8732 8733
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8734
static bool
8735
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
8736 8737 8738
{
    virStorageVolPtr vol;

8739
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8740
        return false;
8741

8742
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8743
        return false;
8744 8745 8746

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8747
    return true;
8748 8749 8750 8751 8752 8753 8754
}



/*
 * "vol-path" command
 */
8755
static const vshCmdInfo info_vol_path[] = {
8756
    {"help", N_("returns the volume path for a given volume name or key")},
8757
    {"desc", ""},
8758 8759 8760
    {NULL, NULL}
};

8761
static const vshCmdOptDef opts_vol_path[] = {
8762
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
8763
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8764 8765 8766
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8767
static bool
8768
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
8769 8770
{
    virStorageVolPtr vol;
8771
    const char *name = NULL;
8772

8773
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8774
        return false;
8775 8776

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8777
        return false;
8778
    }
8779 8780 8781

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8782
    return true;
8783 8784 8785
}


8786 8787 8788 8789
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
8790 8791
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
8792 8793
    {NULL, NULL}
};
8794

8795
static const vshCmdOptDef opts_secret_define[] = {
8796
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
8797 8798
    {NULL, 0, 0, NULL}
};
8799

E
Eric Blake 已提交
8800
static bool
8801 8802
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
8803
    const char *from = NULL;
8804
    char *buffer;
8805
    virSecretPtr res;
8806
    char uuid[VIR_UUID_STRING_BUFLEN];
8807

8808
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8809
        return false;
8810

8811
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8812
        return false;
8813 8814

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
8818
    VIR_FREE(buffer);
8819 8820

    if (res == NULL) {
8821
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
8822
        return false;
8823
    }
8824
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
8825
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
8826
        virSecretFree(res);
E
Eric Blake 已提交
8827
        return false;
8828 8829 8830
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
8831
    return true;
8832 8833 8834 8835 8836 8837
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
8838 8839
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
8840 8841 8842 8843
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
8844
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8845 8846 8847
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8848
static bool
8849 8850 8851
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8852
    bool ret = false;
8853 8854
    char *xml;

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

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8860
        return false;
8861 8862 8863 8864

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
8865
    vshPrint(ctl, "%s", xml);
8866
    VIR_FREE(xml);
E
Eric Blake 已提交
8867
    ret = true;
8868 8869 8870 8871 8872 8873 8874 8875 8876 8877

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
8878 8879
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
8880 8881 8882 8883
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
8884 8885
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
8886 8887 8888
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8889
static bool
8890 8891 8892 8893
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
8894
    const char *base64 = NULL;
8895
    char *value;
E
Eric Blake 已提交
8896 8897
    int res;
    bool ret = false;
8898

8899
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8900
        return false;
8901 8902 8903

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8904
        return false;
8905

8906
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
8907 8908 8909
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
8910
        vshError(ctl, "%s", _("Invalid base64 data"));
8911 8912 8913
        goto cleanup;
    }
    if (value == NULL) {
8914
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
8915
        return false;
8916 8917 8918 8919
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
8920
    VIR_FREE(value);
8921 8922

    if (res != 0) {
8923
        vshError(ctl, "%s", _("Failed to set secret value"));
8924 8925 8926
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
8927
    ret = true;
8928 8929 8930 8931 8932 8933 8934 8935 8936 8937

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
8938 8939
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
8940 8941 8942 8943
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
8944
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8945 8946 8947
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8948
static bool
8949 8950 8951 8952 8953 8954
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
8955
    bool ret = false;
8956

8957
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8958
        return false;
8959 8960 8961

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8962
        return false;
8963 8964 8965 8966 8967 8968 8969

    value = virSecretGetValue(secret, &value_size, 0);
    if (value == NULL)
        goto cleanup;

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
8970
    VIR_FREE(value);
8971 8972

    if (base64 == NULL) {
8973
        vshError(ctl, "%s", _("Failed to allocate memory"));
8974 8975
        goto cleanup;
    }
8976
    vshPrint(ctl, "%s", base64);
8977
    memset(base64, 0, strlen(base64));
8978
    VIR_FREE(base64);
E
Eric Blake 已提交
8979
    ret = true;
8980 8981 8982 8983 8984 8985 8986 8987 8988 8989

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
8990 8991
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
8992 8993 8994 8995
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
8996
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8997 8998 8999
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9000
static bool
9001 9002 9003
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
9004
    bool ret = false;
9005
    const char *uuid;
9006

9007
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9008
        return false;
9009 9010 9011

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
9012
        return false;
9013 9014

    if (virSecretUndefine(secret) < 0) {
9015
        vshError(ctl, _("Failed to delete secret %s"), uuid);
9016 9017 9018
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
9019
    ret = true;
9020 9021 9022 9023 9024 9025 9026 9027 9028 9029

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
9030 9031
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
9032 9033 9034
    {NULL, NULL}
};

E
Eric Blake 已提交
9035
static bool
9036 9037 9038 9039 9040
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

9041
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9042
        return false;
9043 9044 9045

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
9046
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
9047
        return false;
9048 9049 9050 9051 9052
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
9053
        vshError(ctl, "%s", _("Failed to list secrets"));
9054
        VIR_FREE(uuids);
E
Eric Blake 已提交
9055
        return false;
9056 9057 9058 9059
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

9060 9061
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
9062 9063

    for (i = 0; i < maxuuids; i++) {
9064 9065 9066 9067
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
9068
            VIR_FREE(uuids[i]);
9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 9079 9080 9081 9082 9083 9084 9085 9086
            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);
9087
        VIR_FREE(uuids[i]);
9088
    }
9089
    VIR_FREE(uuids);
E
Eric Blake 已提交
9090
    return true;
9091
}
9092 9093 9094 9095 9096


/*
 * "version" command
 */
9097
static const vshCmdInfo info_version[] = {
9098 9099
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
9100 9101 9102
    {NULL, NULL}
};

9103 9104 9105 9106
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
9107

E
Eric Blake 已提交
9108
static bool
9109
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9110 9111 9112 9113 9114 9115
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
9116
    unsigned long daemonVersion;
9117 9118 9119 9120 9121
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

9122
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9123
        return false;
9124 9125 9126

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
9127
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
9128
        return false;
9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140
    }

    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) {
9141
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
9142
        return false;
9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159
    }
    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) {
9160
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
9161
        return false;
9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174
    }
    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);
    }
9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185 9186 9187 9188 9189

    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 已提交
9190
    return true;
9191 9192
}

9193 9194 9195 9196
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
9197
    {"help", N_("enumerate devices on this host")},
9198
    {"desc", ""},
9199 9200 9201 9202
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
9203 9204
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
9205 9206 9207
    {NULL, 0, 0, NULL}
};

9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229
#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] = '-';
9230 9231
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
9232 9233 9234
    }

    /* Print this device */
9235
    vshPrint(ctl, "%s", indentBuf);
9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258
    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) {
9259
        vshPrint(ctl, "%s", indentBuf);
9260
        vshPrint(ctl, " |\n");
9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282
    }

    /* 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) {
9283
        vshPrint(ctl, "%s", indentBuf);
9284 9285 9286 9287
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
9288
static bool
9289 9290
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
9291
    const char *cap = NULL;
9292
    char **devices;
9293
    int num_devices, i;
9294
    int tree = vshCommandOptBool(cmd, "tree");
9295

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

9299
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
9300 9301 9302 9303
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
9304
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
9305
        return false;
9306
    } else if (num_devices == 0) {
E
Eric Blake 已提交
9307
        return true;
9308 9309 9310 9311 9312 9313
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
9314
        vshError(ctl, "%s", _("Failed to list node devices"));
9315
        VIR_FREE(devices);
E
Eric Blake 已提交
9316
        return false;
9317
    }
9318
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
9319 9320 9321 9322 9323 9324 9325
    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 已提交
9326
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345
            } 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++) {
9346 9347
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
9348
        }
9349
        VIR_FREE(parents);
9350 9351 9352
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
9353
            VIR_FREE(devices[i]);
9354
        }
9355
    }
9356
    VIR_FREE(devices);
E
Eric Blake 已提交
9357
    return true;
9358 9359 9360 9361 9362 9363
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
9364 9365
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
9366 9367 9368 9369 9370
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
9371
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9372 9373 9374
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9375
static bool
9376 9377
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
9378
    const char *name = NULL;
9379
    virNodeDevicePtr device;
L
Laine Stump 已提交
9380
    char *xml;
9381

9382
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9383
        return false;
9384
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9385
        return false;
9386
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9387
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9388
        return false;
9389 9390
    }

L
Laine Stump 已提交
9391 9392 9393
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
9394
        return false;
L
Laine Stump 已提交
9395 9396 9397
    }

    vshPrint(ctl, "%s\n", xml);
9398
    VIR_FREE(xml);
9399
    virNodeDeviceFree(device);
E
Eric Blake 已提交
9400
    return true;
9401 9402
}

9403 9404 9405 9406
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
9407 9408
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
9409 9410 9411 9412 9413
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
9414
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9415 9416 9417
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9418
static bool
9419 9420
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
9421
    const char *name = NULL;
9422
    virNodeDevicePtr device;
E
Eric Blake 已提交
9423
    bool ret = true;
9424

9425
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9426
        return false;
9427
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9428
        return false;
9429
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9430
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9431
        return false;
9432 9433 9434 9435 9436
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
9437
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
9438
        ret = false;
9439 9440 9441 9442 9443 9444 9445 9446 9447
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
9448 9449
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
9450 9451 9452 9453 9454
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
9455
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9456 9457 9458
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9459
static bool
9460 9461
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
9462
    const char *name = NULL;
9463
    virNodeDevicePtr device;
E
Eric Blake 已提交
9464
    bool ret = true;
9465

9466
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9467
        return false;
9468
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9469
        return false;
9470
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9471
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9472
        return false;
9473 9474 9475 9476 9477
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
9478
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
9479
        ret = false;
9480 9481 9482 9483 9484 9485 9486 9487 9488
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
9489 9490
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
9491 9492 9493 9494 9495
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
9496
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9497 9498 9499
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9500
static bool
9501 9502
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
9503
    const char *name = NULL;
9504
    virNodeDevicePtr device;
E
Eric Blake 已提交
9505
    bool ret = true;
9506

9507
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9508
        return false;
9509
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9510
        return false;
9511
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9512
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9513
        return false;
9514 9515 9516 9517 9518
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
9519
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
9520
        ret = false;
9521 9522 9523 9524 9525
    }
    virNodeDeviceFree(device);
    return ret;
}

9526
/*
E
Eric Blake 已提交
9527
 * "hostname" command
9528
 */
9529
static const vshCmdInfo info_hostname[] = {
9530
    {"help", N_("print the hypervisor hostname")},
9531
    {"desc", ""},
9532 9533 9534
    {NULL, NULL}
};

E
Eric Blake 已提交
9535
static bool
9536
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9537 9538 9539
{
    char *hostname;

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

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
9545
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
9546
        return false;
9547 9548 9549
    }

    vshPrint (ctl, "%s\n", hostname);
9550
    VIR_FREE(hostname);
9551

E
Eric Blake 已提交
9552
    return true;
9553 9554 9555 9556 9557
}

/*
 * "uri" command
 */
9558
static const vshCmdInfo info_uri[] = {
9559
    {"help", N_("print the hypervisor canonical URI")},
9560
    {"desc", ""},
9561 9562 9563
    {NULL, NULL}
};

E
Eric Blake 已提交
9564
static bool
9565
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9566 9567 9568
{
    char *uri;

9569
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9570
        return false;
9571 9572 9573

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
9574
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
9575
        return false;
9576 9577 9578
    }

    vshPrint (ctl, "%s\n", uri);
9579
    VIR_FREE(uri);
9580

E
Eric Blake 已提交
9581
    return true;
9582 9583
}

E
Eric Blake 已提交
9584 9585 9586 9587 9588 9589 9590 9591 9592 9593
/*
 * "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 已提交
9594
static bool
E
Eric Blake 已提交
9595 9596 9597 9598 9599
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9600
        return false;
E
Eric Blake 已提交
9601 9602 9603 9604

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
9605
        return false;
E
Eric Blake 已提交
9606 9607 9608 9609 9610
    }

    vshPrint (ctl, "%s", sysinfo);
    VIR_FREE(sysinfo);

E
Eric Blake 已提交
9611
    return true;
E
Eric Blake 已提交
9612 9613
}

9614 9615 9616
/*
 * "vncdisplay" command
 */
9617
static const vshCmdInfo info_vncdisplay[] = {
9618 9619
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
9620 9621 9622
    {NULL, NULL}
};

9623
static const vshCmdOptDef opts_vncdisplay[] = {
9624
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9625 9626 9627
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9628
static bool
9629
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
9630 9631 9632 9633 9634
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9635
    bool ret = false;
9636 9637 9638
    int port = 0;
    char *doc;

9639
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9640
        return false;
9641

J
Jim Meyering 已提交
9642
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9643
        return false;
9644 9645 9646 9647 9648 9649 9650 9651

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
9652
    VIR_FREE(doc);
9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        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) ||
9671
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
9672 9673 9674 9675 9676 9677
        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 已提交
9678
    ret = true;
9679 9680 9681 9682 9683 9684 9685 9686 9687 9688 9689 9690 9691

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

/*
 * "ttyconsole" command
 */
9692
static const vshCmdInfo info_ttyconsole[] = {
9693 9694
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
9695 9696 9697
    {NULL, NULL}
};

9698
static const vshCmdOptDef opts_ttyconsole[] = {
9699
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9700 9701 9702
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9703
static bool
9704
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
9705 9706 9707 9708 9709
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9710
    bool ret = false;
9711 9712
    char *doc;

9713
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9714
        return false;
9715

J
Jim Meyering 已提交
9716
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9717
        return false;
9718 9719 9720 9721 9722 9723 9724 9725

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
9726
    VIR_FREE(doc);
9727 9728 9729 9730 9731 9732 9733 9734 9735 9736 9737 9738
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        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 已提交
9739
    ret = true;
9740 9741 9742 9743 9744 9745 9746 9747 9748 9749 9750 9751

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

/*
 * "attach-device" command
9752
 */
9753
static const vshCmdInfo info_attach_device[] = {
9754 9755
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
9756 9757 9758
    {NULL, NULL}
};

9759
static const vshCmdOptDef opts_attach_device[] = {
9760 9761 9762
    {"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")},
9763 9764 9765
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9766
static bool
9767
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
9768 9769
{
    virDomainPtr dom;
9770
    const char *from = NULL;
9771
    char *buffer;
W
Wen Congyang 已提交
9772
    int ret;
J
Jim Fehlig 已提交
9773
    unsigned int flags;
9774

9775
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9776
        return false;
9777

J
Jim Meyering 已提交
9778
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9779
        return false;
9780

9781
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9782
        virDomainFree(dom);
E
Eric Blake 已提交
9783
        return false;
9784 9785
    }

9786
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9787
        virshReportError(ctl);
9788
        virDomainFree(dom);
E
Eric Blake 已提交
9789
        return false;
9790
    }
9791

J
Jim Fehlig 已提交
9792
    if (vshCommandOptBool(cmd, "persistent")) {
9793
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
9794
        if (virDomainIsActive(dom) == 1)
9795
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
9796 9797 9798 9799
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
9800
    VIR_FREE(buffer);
9801 9802

    if (ret < 0) {
9803
        vshError(ctl, _("Failed to attach device from %s"), from);
9804
        virDomainFree(dom);
E
Eric Blake 已提交
9805
        return false;
9806
    } else {
J
Jim Meyering 已提交
9807
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
9808 9809 9810
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9811
    return true;
9812 9813 9814 9815 9816 9817
}


/*
 * "detach-device" command
 */
9818
static const vshCmdInfo info_detach_device[] = {
9819 9820
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
9821 9822 9823
    {NULL, NULL}
};

9824
static const vshCmdOptDef opts_detach_device[] = {
9825 9826 9827
    {"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")},
9828 9829 9830
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9831
static bool
9832
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
9833 9834
{
    virDomainPtr dom;
9835
    const char *from = NULL;
9836
    char *buffer;
W
Wen Congyang 已提交
9837
    int ret;
J
Jim Fehlig 已提交
9838
    unsigned int flags;
9839

9840
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9841
        return false;
9842

J
Jim Meyering 已提交
9843
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9844
        return false;
9845

9846
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9847
        virDomainFree(dom);
E
Eric Blake 已提交
9848
        return false;
9849 9850
    }

9851
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9852
        virshReportError(ctl);
9853
        virDomainFree(dom);
E
Eric Blake 已提交
9854
        return false;
9855
    }
9856

J
Jim Fehlig 已提交
9857
    if (vshCommandOptBool(cmd, "persistent")) {
9858
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
9859
        if (virDomainIsActive(dom) == 1)
9860
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
9861 9862 9863 9864
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
9865
    VIR_FREE(buffer);
9866 9867

    if (ret < 0) {
9868
        vshError(ctl, _("Failed to detach device from %s"), from);
9869
        virDomainFree(dom);
E
Eric Blake 已提交
9870
        return false;
9871
    } else {
J
Jim Meyering 已提交
9872
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
9873 9874 9875
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9876
    return true;
9877 9878
}

9879

9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892
/*
 * "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")},
9893
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
9894 9895 9896
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9897
static bool
9898 9899 9900
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
9901
    const char *from = NULL;
9902
    char *buffer;
W
Wen Congyang 已提交
9903
    int ret;
9904 9905
    unsigned int flags;

9906
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9907
        return false;
9908 9909

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

9912
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9913
        virDomainFree(dom);
E
Eric Blake 已提交
9914
        return false;
9915 9916 9917
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9918
        virshReportError(ctl);
9919
        virDomainFree(dom);
E
Eric Blake 已提交
9920
        return false;
9921 9922 9923
    }

    if (vshCommandOptBool(cmd, "persistent")) {
9924
        flags = VIR_DOMAIN_AFFECT_CONFIG;
9925
        if (virDomainIsActive(dom) == 1)
9926
           flags |= VIR_DOMAIN_AFFECT_LIVE;
9927
    } else {
9928
        flags = VIR_DOMAIN_AFFECT_LIVE;
9929
    }
9930 9931 9932 9933

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

9934 9935 9936 9937 9938 9939
    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 已提交
9940
        return false;
9941 9942 9943 9944 9945
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9946
    return true;
9947 9948 9949
}


9950 9951 9952
/*
 * "attach-interface" command
 */
9953
static const vshCmdInfo info_attach_interface[] = {
9954 9955
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
9956 9957 9958
    {NULL, NULL}
};

9959
static const vshCmdOptDef opts_attach_interface[] = {
9960 9961 9962 9963 9964 9965
    {"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")},
9966
    {"model", VSH_OT_DATA, 0, N_("model type")},
9967
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
9968 9969 9970
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9971
static bool
9972
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
9973 9974
{
    virDomainPtr dom = NULL;
9975 9976
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
9977
    int typ;
W
Wen Congyang 已提交
9978 9979
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9980
    unsigned int flags;
9981 9982
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9983

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

J
Jim Meyering 已提交
9987
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9988 9989
        goto cleanup;

9990
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9991 9992
        goto cleanup;

9993 9994 9995 9996
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
9997 9998
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
9999
        goto cleanup;
10000
    }
10001 10002

    /* check interface type */
10003
    if (STREQ(type, "network")) {
10004
        typ = 1;
10005
    } else if (STREQ(type, "bridge")) {
10006 10007
        typ = 2;
    } else {
E
Eric Blake 已提交
10008 10009
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
10010 10011 10012 10013
        goto cleanup;
    }

    /* Make XML of interface */
10014
    virBufferAsprintf(&buf, "<interface type='%s'>\n", type);
10015

10016
    if (typ == 1)
10017
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
10018
    else if (typ == 2)
10019
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
10020

10021
    if (target != NULL)
10022
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10023
    if (mac != NULL)
10024
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
10025
    if (script != NULL)
10026
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
10027
    if (model != NULL)
10028
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
10029

10030
    virBufferAddLit(&buf, "</interface>\n");
10031

10032 10033
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
10034
        goto cleanup;
10035 10036
    }

10037
    xml = virBufferContentAndReset(&buf);
10038

J
Jim Fehlig 已提交
10039
    if (vshCommandOptBool(cmd, "persistent")) {
10040
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10041
        if (virDomainIsActive(dom) == 1)
10042
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10043
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
10044
    } else {
10045
        ret = virDomainAttachDevice(dom, xml);
10046
    }
10047

10048 10049
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10050
    if (ret != 0) {
L
Laine Stump 已提交
10051
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
10052 10053
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
10054
        functionReturn = true;
J
Jim Fehlig 已提交
10055
    }
10056 10057 10058 10059

 cleanup:
    if (dom)
        virDomainFree(dom);
10060
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10061
    return functionReturn;
10062 10063 10064 10065 10066
}

/*
 * "detach-interface" command
 */
10067
static const vshCmdInfo info_detach_interface[] = {
10068 10069
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
10070 10071 10072
    {NULL, NULL}
};

10073
static const vshCmdOptDef opts_detach_interface[] = {
10074 10075 10076 10077
    {"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")},
10078 10079 10080
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10081
static bool
10082
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
10083 10084 10085 10086 10087 10088 10089
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
10090
    const char *mac =NULL, *type = NULL;
10091
    char *doc;
10092
    char buf[64];
E
Eric Blake 已提交
10093
    int i = 0, diff_mac;
W
Wen Congyang 已提交
10094 10095
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
10096
    unsigned int flags;
10097

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

J
Jim Meyering 已提交
10101
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10102 10103
        goto cleanup;

10104
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10105 10106
        goto cleanup;

10107 10108
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
10109
        goto cleanup;
10110
    }
10111 10112 10113 10114 10115 10116 10117 10118

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
10119
    VIR_FREE(doc);
10120
    if (!xml) {
10121
        vshError(ctl, "%s", _("Failed to get interface information"));
10122 10123 10124 10125
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
10126
        vshError(ctl, "%s", _("Failed to get interface information"));
10127 10128 10129
        goto cleanup;
    }

E
Eric Blake 已提交
10130
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
10131 10132 10133
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10134
        vshError(ctl, _("No found interface whose type is %s"), type);
10135 10136 10137
        goto cleanup;
    }

10138 10139 10140 10141 10142 10143
    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;
    }

10144 10145 10146 10147 10148 10149 10150
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10151 10152 10153 10154 10155
            if (cur->type == XML_ELEMENT_NODE &&
                xmlStrEqual(cur->name, BAD_CAST "mac")) {
                char *tmp_mac = virXMLPropString(cur, "address");
                diff_mac = virMacAddrCompare (tmp_mac, mac);
                VIR_FREE(tmp_mac);
10156 10157 10158 10159 10160 10161 10162
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10163
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
10164 10165 10166 10167 10168
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10169
        vshError(ctl, "%s", _("Failed to allocate memory"));
10170 10171 10172
        goto cleanup;
    }

10173
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
10174
        vshError(ctl, "%s", _("Failed to create XML"));
10175 10176 10177
        goto cleanup;
    }

J
Jim Fehlig 已提交
10178
    if (vshCommandOptBool(cmd, "persistent")) {
10179
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10180
        if (virDomainIsActive(dom) == 1)
10181
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10182 10183 10184 10185 10186 10187 10188 10189
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10190
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
10191
    } else {
J
Jim Meyering 已提交
10192
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
10193
        functionReturn = true;
10194
    }
10195 10196 10197 10198

 cleanup:
    if (dom)
        virDomainFree(dom);
10199
    xmlXPathFreeObject(obj);
10200
    xmlXPathFreeContext(ctxt);
10201 10202 10203 10204
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
10205
    return functionReturn;
10206 10207 10208 10209 10210
}

/*
 * "attach-disk" command
 */
10211
static const vshCmdInfo info_attach_disk[] = {
10212 10213
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
10214 10215 10216
    {NULL, NULL}
};

10217
static const vshCmdOptDef opts_attach_disk[] = {
10218 10219 10220 10221 10222
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"source",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("source of disk device")},
    {"target",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("target of disk device")},
    {"driver",    VSH_OT_STRING, 0, N_("driver of disk device")},
    {"subdriver", VSH_OT_STRING, 0, N_("subdriver of disk device")},
10223
    {"cache",     VSH_OT_STRING, 0, N_("cache mode of disk device")},
10224 10225 10226
    {"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")},
10227
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
10228 10229 10230
    {"serial", VSH_OT_STRING, 0, N_("serial of disk device")},
    {"shareable", VSH_OT_BOOL, 0, N_("shareable between domains")},
    {"address", VSH_OT_STRING, 0, N_("address of disk device")},
10231 10232 10233
    {NULL, 0, 0, NULL}
};

10234 10235 10236 10237 10238 10239 10240 10241 10242 10243 10244 10245 10246 10247 10248 10249 10250 10251 10252 10253 10254 10255 10256 10257 10258 10259 10260 10261 10262 10263 10264 10265 10266 10267 10268 10269 10270 10271 10272 10273 10274 10275 10276 10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 10316 10317 10318 10319 10320 10321 10322 10323 10324 10325 10326 10327 10328 10329 10330 10331 10332 10333 10334 10335 10336 10337 10338 10339 10340 10341 10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 10380
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 已提交
10381
static bool
10382
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
10383 10384
{
    virDomainPtr dom = NULL;
10385
    const char *source = NULL, *target = NULL, *driver = NULL,
10386 10387 10388
                *subdriver = NULL, *type = NULL, *mode = NULL,
                *cache = NULL, *serial = NULL, *straddr = NULL;
    struct DiskAddress diskAddr;
W
Wen Congyang 已提交
10389 10390
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
10391
    unsigned int flags;
10392
    const char *stype = NULL;
10393 10394
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10395

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

J
Jim Meyering 已提交
10399
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10400 10401
        goto cleanup;

10402
    if (vshCommandOptString(cmd, "source", &source) <= 0)
10403 10404
        goto cleanup;

10405
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10406 10407
        goto cleanup;

10408 10409 10410 10411
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
10412 10413 10414
        vshCommandOptString(cmd, "cache", &cache) < 0 ||
        vshCommandOptString(cmd, "serial", &serial) < 0 ||
        vshCommandOptString(cmd, "address", &straddr) < 0 ||
10415
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
10416
        vshError(ctl, "%s", _("missing option"));
10417 10418
        goto cleanup;
    }
10419

10420 10421
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
10422
            isFile = true;
10423
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
10424
        isFile = true;
10425 10426 10427
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
10428 10429 10430
    }

    if (mode) {
10431
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
10432 10433
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
10434 10435 10436 10437 10438
            goto cleanup;
        }
    }

    /* Make XML of disk */
10439
    virBufferAsprintf(&buf, "<disk type='%s'",
10440 10441
                      (isFile) ? "file" : "block");
    if (type)
10442
        virBufferAsprintf(&buf, " device='%s'", type);
10443 10444
    virBufferAddLit(&buf, ">\n");

10445
    if (driver || subdriver)
10446
        virBufferAsprintf(&buf, "  <driver");
10447 10448

    if (driver)
10449
        virBufferAsprintf(&buf, " name='%s'", driver);
10450
    if (subdriver)
10451
        virBufferAsprintf(&buf, " type='%s'", subdriver);
10452 10453
    if (cache)
        virBufferAsprintf(&buf, " cache='%s'", cache);
10454

10455
    if (driver || subdriver || cache)
10456
        virBufferAddLit(&buf, "/>\n");
10457

10458
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
10459 10460
                      (isFile) ? "file" : "dev",
                      source);
10461
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10462
    if (mode)
10463
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
10464

10465 10466 10467 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
    if (serial)
        virBufferAsprintf(&buf, "  <serial>%s</serial>\n", serial);

    if (vshCommandOptBool(cmd, "shareable"))
        virBufferAsprintf(&buf, "  <shareable/>\n");

    if (straddr) {
        if (str2DiskAddress(straddr, &diskAddr) != 0) {
            vshError(ctl, _("Invalid address."));
            goto cleanup;
        }

        if (STRPREFIX((const char *)target, "vd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_PCI) {
                virBufferAsprintf(&buf,
                                  "  <address type='pci' domain='0x%04x'"
                                  " bus ='0x%02x' slot='0x%02x' function='0x%0x' />\n",
                                  diskAddr.addr.pci.domain, diskAddr.addr.pci.bus,
                                  diskAddr.addr.pci.slot, diskAddr.addr.pci.function);
            } else {
                vshError(ctl, "%s", _("expecting a pci:0000.00.00.00 address."));
                goto cleanup;
            }
        } else if (STRPREFIX((const char *)target, "sd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_SCSI) {
                virBufferAsprintf(&buf,
                                  "  <address type='drive' controller='%d'"
                                  " bus='%d' unit='%d' />\n",
                                  diskAddr.addr.scsi.controller, diskAddr.addr.scsi.bus,
                                  diskAddr.addr.scsi.unit);
            } else {
                vshError(ctl, "%s", _("expecting a scsi:00.00.00 address."));
                goto cleanup;
            }
        } else if (STRPREFIX((const char *)target, "hd")) {
            if (diskAddr.type == DISK_ADDR_TYPE_IDE) {
                virBufferAsprintf(&buf,
                                  "  <address type='drive' controller='%d'"
                                  " bus='%d' unit='%d' />\n",
                                  diskAddr.addr.ide.controller, diskAddr.addr.ide.bus,
                                  diskAddr.addr.ide.unit);
            } else {
                vshError(ctl, "%s", _("expecting an ide:00.00.00 address."));
                goto cleanup;
            }
        }
    }

10513
    virBufferAddLit(&buf, "</disk>\n");
10514

10515 10516
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
10517
        return false;
10518 10519
    }

10520
    xml = virBufferContentAndReset(&buf);
10521

J
Jim Fehlig 已提交
10522
    if (vshCommandOptBool(cmd, "persistent")) {
10523
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10524
        if (virDomainIsActive(dom) == 1)
10525
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10526
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
10527
    } else {
10528
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
10529
    }
10530

10531 10532
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10533
    if (ret != 0) {
L
Laine Stump 已提交
10534
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
10535 10536
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
10537
        functionReturn = true;
J
Jim Fehlig 已提交
10538
    }
10539 10540 10541 10542

 cleanup:
    if (dom)
        virDomainFree(dom);
10543
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10544
    return functionReturn;
10545 10546 10547 10548 10549
}

/*
 * "detach-disk" command
 */
10550
static const vshCmdInfo info_detach_disk[] = {
10551 10552
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
10553 10554 10555
    {NULL, NULL}
};

10556
static const vshCmdOptDef opts_detach_disk[] = {
10557 10558 10559
    {"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")},
10560 10561 10562
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10563
static bool
10564
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
10565 10566 10567 10568 10569 10570 10571
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
10572
    const char *target = NULL;
10573
    char *doc;
E
Eric Blake 已提交
10574
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
10575 10576
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
10577
    unsigned int flags;
10578

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

J
Jim Meyering 已提交
10582
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10583 10584
        goto cleanup;

10585
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10586 10587 10588 10589 10590 10591 10592 10593 10594
        goto cleanup;

    doc = virDomainGetXMLDesc(dom, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domain.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
10595
    VIR_FREE(doc);
10596
    if (!xml) {
10597
        vshError(ctl, "%s", _("Failed to get disk information"));
10598 10599 10600 10601
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
10602
        vshError(ctl, "%s", _("Failed to get disk information"));
10603 10604 10605 10606 10607 10608
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10609
        vshError(ctl, "%s", _("Failed to get disk information"));
10610 10611 10612 10613 10614 10615 10616
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10617 10618 10619 10620 10621
            if (cur->type == XML_ELEMENT_NODE &&
                xmlStrEqual(cur->name, BAD_CAST "target")) {
                char *tmp_tgt = virXMLPropString(cur, "dev");
                diff_tgt = STREQ(tmp_tgt, target);
                VIR_FREE(tmp_tgt);
10622 10623 10624 10625 10626 10627 10628
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10629
    vshError(ctl, _("No found disk whose target is %s"), target);
10630 10631 10632 10633 10634
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10635
        vshError(ctl, "%s", _("Failed to allocate memory"));
10636 10637 10638
        goto cleanup;
    }

10639
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
10640
        vshError(ctl, "%s", _("Failed to create XML"));
10641 10642 10643
        goto cleanup;
    }

J
Jim Fehlig 已提交
10644
    if (vshCommandOptBool(cmd, "persistent")) {
10645
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10646
        if (virDomainIsActive(dom) == 1)
10647
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10648 10649 10650 10651 10652 10653 10654 10655
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10656
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
10657
    } else {
J
Jim Meyering 已提交
10658
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
10659
        functionReturn = true;
10660
    }
10661 10662

 cleanup:
10663
    xmlXPathFreeObject(obj);
10664
    xmlXPathFreeContext(ctxt);
10665 10666 10667 10668 10669 10670
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
10671
    return functionReturn;
10672 10673
}

10674 10675 10676 10677
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
10678 10679
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
10680 10681 10682 10683
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
10684
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
10685 10686 10687
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10688
static bool
10689 10690
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
10691
    const char *from = NULL;
E
Eric Blake 已提交
10692
    bool ret = true;
10693 10694 10695
    char *buffer;
    int result;

10696
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10697
        return false;
10698

10699
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10700
        return false;
10701 10702

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
10706
    VIR_FREE(buffer);
10707 10708 10709 10710 10711

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
10712
        ret = false;
10713 10714 10715 10716 10717
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
10718
        ret = true;
10719 10720 10721 10722 10723
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
10724
        ret = true;
10725 10726 10727 10728 10729
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
10730
        ret = false;
10731 10732 10733 10734 10735
    }

    return ret;
}

10736 10737 10738 10739
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
10740 10741
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
10742 10743 10744 10745
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
10746
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
10747 10748 10749
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10750
static bool
10751 10752
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
10753
    const char *from = NULL;
E
Eric Blake 已提交
10754
    bool ret = true;
10755 10756 10757 10758 10759
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
10760
    xmlNodePtr node_list;
10761 10762 10763 10764 10765 10766
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

10767
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10768
        return false;
10769

10770
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10771
        return false;
10772 10773

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
10774
        return false;
10775 10776 10777 10778 10779

    doc = xmlNewDoc(NULL);
    if (doc == NULL)
        goto no_memory;

L
Laine Stump 已提交
10780 10781
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
10782 10783
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
10784
        ret = false;
10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795 10796 10797 10798 10799 10800 10801 10802 10803 10804 10805 10806 10807 10808 10809 10810 10811 10812 10813 10814 10815 10816 10817 10818 10819 10820
        goto cleanup;
    }

    xmlAddChildList((xmlNodePtr) doc, node_list);

    ctxt = xmlXPathNewContext(doc);
    if (!ctxt)
        goto no_memory;

    obj = xmlXPathEval(BAD_CAST "//cpu[not(ancestor::cpu)]", ctxt);
    if ((obj == NULL) || (obj->nodesetval == NULL) ||
        (obj->nodesetval->nodeTab == NULL))
        goto cleanup;

    for (i = 0;i < obj->nodesetval->nodeNr;i++) {
        buf = xmlBufferCreate();
        if (buf == NULL)
            goto no_memory;
        sctxt = xmlSaveToBuffer(buf, NULL, 0);
        if (sctxt == NULL) {
            xmlBufferFree(buf);
            goto no_memory;
        }

        xmlSaveTree(sctxt, obj->nodesetval->nodeTab[i]);
        xmlSaveClose(sctxt);

        list = vshRealloc(ctl, list, sizeof(char *) * (count + 1));
        list[count++] = (char *) buf->content;
        buf->content = NULL;
        xmlBufferFree(buf);
        buf = NULL;
    }

    if (count == 0) {
        vshError(ctl, _("No host CPU specified in '%s'"), from);
E
Eric Blake 已提交
10821
        ret = false;
10822 10823 10824 10825 10826 10827 10828 10829
        goto cleanup;
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
10830
        ret = false;
10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847

cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    xmlFreeDoc(doc);
    VIR_FREE(result);
    if ((list != NULL) && (count > 0)) {
        for (i = 0;i < count;i++)
            VIR_FREE(list[i]);
    }
    VIR_FREE(list);
    VIR_FREE(buffer);

    return ret;

no_memory:
    vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
10848
    ret = false;
10849
    goto cleanup;
10850 10851
}

10852 10853 10854 10855 10856 10857 10858 10859
/* 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;

10860
    ret = vshMalloc(ctl, PATH_MAX);
10861 10862 10863

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
10864 10865
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
10866
    if (fd == -1) {
10867
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
10868
                 strerror(errno));
10869
        VIR_FREE(ret);
10870 10871 10872 10873
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
10874 10875
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
10876
        VIR_FORCE_CLOSE(fd);
10877
        unlink (ret);
10878
        VIR_FREE(ret);
10879 10880
        return NULL;
    }
S
Stefan Berger 已提交
10881
    if (VIR_CLOSE(fd) < 0) {
10882 10883
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
10884
        unlink (ret);
10885
        VIR_FREE(ret);
10886 10887 10888 10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900
        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 已提交
10901 10902 10903 10904
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
10905

10906
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
10907 10908 10909 10910
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
10911

10912 10913 10914 10915 10916
    /* 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 已提交
10917 10918
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
10919
     */
E
Eric Blake 已提交
10920 10921 10922 10923 10924 10925 10926 10927 10928 10929 10930 10931
    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);
10932 10933
    }

E
Eric Blake 已提交
10934 10935 10936 10937 10938 10939 10940
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
10941
    }
E
Eric Blake 已提交
10942
    ret = 0;
10943

E
Eric Blake 已提交
10944 10945 10946
cleanup:
    virCommandFree(cmd);
    return ret;
10947 10948 10949 10950 10951 10952 10953 10954
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
10955
        vshError(ctl,
10956
                 _("%s: failed to read temporary file: %s"),
10957
                 filename, strerror(errno));
10958 10959 10960 10961 10962
        return NULL;
    }
    return ret;
}

10963

P
Paolo Bonzini 已提交
10964 10965 10966 10967
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
10968 10969
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
10970 10971 10972 10973
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
10974
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
10975 10976 10977
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10978
static bool
10979
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
10980
{
10981
    const char *dir = NULL;
10982
    char *dir_malloced = NULL;
E
Eric Blake 已提交
10983
    bool ret = true;
P
Paolo Bonzini 已提交
10984 10985

    if (!ctl->imode) {
10986
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
10987
        return false;
P
Paolo Bonzini 已提交
10988 10989
    }

10990
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
10991
        uid_t uid = geteuid();
10992
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
10993 10994 10995 10996
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
10997
    if (chdir(dir) == -1) {
10998
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
10999
        ret = false;
P
Paolo Bonzini 已提交
11000 11001
    }

11002
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
11003
    return ret;
P
Paolo Bonzini 已提交
11004 11005 11006 11007 11008 11009
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
11010 11011
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
11012 11013 11014
    {NULL, NULL}
};

E
Eric Blake 已提交
11015
static bool
P
Paolo Bonzini 已提交
11016 11017 11018
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
11019
    bool ret = true;
P
Paolo Bonzini 已提交
11020

11021 11022
    cwd = getcwd(NULL, 0);
    if (!cwd) {
11023 11024
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
11025 11026
        ret = false;
    } else {
P
Paolo Bonzini 已提交
11027
        vshPrint (ctl, _("%s\n"), cwd);
11028 11029
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
11030

11031
    return ret;
P
Paolo Bonzini 已提交
11032 11033
}

E
Eric Blake 已提交
11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045
/*
 * "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")},
11046
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
11047 11048 11049 11050 11051 11052
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
11053
static bool
E
Eric Blake 已提交
11054 11055 11056 11057 11058
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
11059
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
11060 11061 11062 11063 11064 11065 11066 11067
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

11068
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
11069 11070 11071
        bool close_quote = false;
        char *q;

11072
        arg = opt->data;
E
Eric Blake 已提交
11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100
        if (count)
            virBufferAddChar(&buf, ' ');
        /* Add outer '' only if arg included shell metacharacters.  */
        if (shell &&
            (strpbrk(arg, "\r\t\n !\"#$&'()*;<>?[\\]^`{|}~") || !*arg)) {
            virBufferAddChar(&buf, '\'');
            close_quote = true;
        }
        if (xml) {
            virBufferEscapeString(&buf, "%s", arg);
        } else {
            if (shell && (q = strchr(arg, '\''))) {
                do {
                    virBufferAdd(&buf, arg, q - arg);
                    virBufferAddLit(&buf, "'\\''");
                    arg = q + 1;
                    q = strchr(arg, '\'');
                } while (q);
            }
            virBufferAdd(&buf, arg, strlen(arg));
        }
        if (close_quote)
            virBufferAddChar(&buf, '\'');
        count++;
    }

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
11101
        return false;
E
Eric Blake 已提交
11102 11103 11104 11105 11106
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
11107
    return true;
E
Eric Blake 已提交
11108 11109
}

11110 11111 11112 11113
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
11114 11115
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
11116 11117 11118 11119
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
11120
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
11121 11122 11123 11124 11125 11126
    {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 已提交
11127
static bool
11128 11129
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
11130
    bool ret = false;
11131 11132 11133 11134 11135
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
11136
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
11137

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

J
Jim Meyering 已提交
11141
    dom = vshCommandOptDomain (ctl, cmd, NULL);
11142 11143 11144 11145
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
11146
    doc = virDomainGetXMLDesc (dom, flags);
11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164
    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 已提交
11165
        ret = true;
11166 11167 11168 11169 11170 11171 11172
        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.
     */
11173
    doc_reread = virDomainGetXMLDesc (dom, flags);
11174 11175 11176 11177
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
11178 11179
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191
        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 已提交
11192
    ret = true;
11193 11194 11195 11196 11197

 cleanup:
    if (dom)
        virDomainFree (dom);

11198 11199 11200
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
11201 11202 11203

    if (tmp) {
        unlink (tmp);
11204
        VIR_FREE(tmp);
11205 11206 11207 11208 11209
    }

    return ret;
}

11210

11211 11212 11213 11214
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
11215 11216
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
11217 11218 11219 11220
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
11221
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
11222 11223 11224 11225 11226 11227 11228 11229 11230 11231
    {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[] = {
11232 11233
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
11234 11235 11236 11237
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
11238
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
11239 11240 11241 11242 11243 11244
    {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 已提交
11245 11246 11247
/*
 * "quit" command
 */
11248
static const vshCmdInfo info_quit[] = {
11249
    {"help", N_("quit this interactive terminal")},
11250
    {"desc", ""},
11251
    {NULL, NULL}
K
Karel Zak 已提交
11252 11253
};

E
Eric Blake 已提交
11254
static bool
11255
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11256
{
E
Eric Blake 已提交
11257 11258
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
11259 11260
}

11261 11262 11263 11264
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
11265 11266
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
11267 11268 11269 11270 11271 11272 11273 11274 11275
    {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")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11276
static bool
11277 11278 11279
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11280
    bool ret = false;
11281
    const char *from = NULL;
11282 11283 11284 11285 11286 11287 11288
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

11289
    if (!vshConnectionUsability(ctl, ctl->conn))
11290 11291 11292 11293 11294 11295
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11296
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
11297
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
11298 11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341
    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;
    }

    snapshot = virDomainSnapshotCreateXML(dom, buffer, 0);
    if (snapshot == NULL)
        goto cleanup;

    doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domainsnapshot.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        goto cleanup;

    name = virXPathString("string(/domainsnapshot/name)", ctxt);
    if (!name) {
        vshError(ctl, "%s",
                 _("Could not find 'name' element in domain snapshot XML"));
        goto cleanup;
    }

    vshPrint(ctl, _("Domain snapshot %s created"), name);
    if (from)
        vshPrint(ctl, _(" from '%s'"), from);
    vshPrint(ctl, "\n");

E
Eric Blake 已提交
11342
    ret = true;
11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358

cleanup:
    VIR_FREE(name);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11359 11360 11361 11362 11363 11364 11365 11366 11367 11368 11369 11370 11371
/*
 * "snapshot-create-as" command
 */
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 已提交
11372
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
11373 11374 11375 11376 11377 11378 11379 11380 11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416
    {NULL, 0, 0, NULL}
};

static bool
cmdSnapshotCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    const char *name = NULL;
    const char *desc = NULL;
    char *parsed_name = NULL;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    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)
        virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    if (desc)
        virBufferAsprintf(&buf, "  <description>%s</description>\n", desc);
    virBufferAddLit(&buf, "</domainsnapshot>\n");

    buffer = virBufferContentAndReset(&buf);
    if (buffer == NULL) {
        vshError(ctl, "%s", _("Out of memory"));
        goto cleanup;
    }

E
Eric Blake 已提交
11417 11418 11419 11420 11421 11422
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

11423 11424 11425 11426 11427 11428 11429 11430 11431 11432 11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452 11453 11454 11455 11456 11457 11458 11459 11460 11461 11462 11463 11464 11465
    snapshot = virDomainSnapshotCreateXML(dom, buffer, 0);
    if (snapshot == NULL)
        goto cleanup;

    doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!doc)
        goto cleanup;

    xml = xmlReadDoc((const xmlChar *) doc, "domainsnapshot.xml", NULL,
                     XML_PARSE_NOENT | XML_PARSE_NONET |
                     XML_PARSE_NOWARNING);
    if (!xml)
        goto cleanup;
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt)
        goto cleanup;

    parsed_name = virXPathString("string(/domainsnapshot/name)", ctxt);
    if (!parsed_name) {
        vshError(ctl, "%s",
                 _("Could not find 'name' element in domain snapshot XML"));
        goto cleanup;
    }

    vshPrint(ctl, _("Domain snapshot %s created\n"), name ? name : parsed_name);

    ret = true;

cleanup:
    VIR_FREE(parsed_name);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    VIR_FREE(doc);
    VIR_FREE(buffer);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479
/*
 * "snapshot-current" command
 */
static const vshCmdInfo info_snapshot_current[] = {
    {"help", N_("Get the current snapshot")},
    {"desc", N_("Get the current snapshot")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11480
static bool
11481 11482 11483
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11484
    bool ret = false;
11485 11486 11487
    int current;
    virDomainSnapshotPtr snapshot = NULL;

11488
    if (!vshConnectionUsability(ctl, ctl->conn))
11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    current = virDomainHasCurrentSnapshot(dom, 0);
    if (current < 0)
        goto cleanup;
    else if (current) {
        char *xml;

        if (!(snapshot = virDomainSnapshotCurrent(dom, 0)))
            goto cleanup;

        xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
        if (!xml)
            goto cleanup;

        vshPrint(ctl, "%s", xml);
        VIR_FREE(xml);
    }

E
Eric Blake 已提交
11512
    ret = true;
11513 11514 11515 11516 11517 11518 11519 11520 11521 11522 11523 11524 11525 11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-list" command
 */
static const vshCmdInfo info_snapshot_list[] = {
    {"help", N_("List snapshots for a domain")},
    {"desc", N_("Snapshot List")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11537
static bool
11538 11539 11540
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11541
    bool ret = false;
11542 11543
    int numsnaps;
    char **names = NULL;
11544
    int actual = 0;
11545 11546 11547 11548 11549 11550
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
11551 11552
    long long creation_longlong;
    time_t creation_time_t;
11553 11554 11555
    char timestr[100];
    struct tm time_info;

11556
    if (!vshConnectionUsability(ctl, ctl->conn))
11557 11558 11559 11560 11561 11562 11563 11564 11565 11566 11567
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

11568 11569
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
11570 11571 11572 11573 11574 11575 11576 11577 11578 11579 11580 11581 11582 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

    if (numsnaps) {
        if (VIR_ALLOC_N(names, numsnaps) < 0)
            goto cleanup;

        actual = virDomainSnapshotListNames(dom, names, numsnaps, 0);
        if (actual < 0)
            goto cleanup;

        qsort(&names[0], actual, sizeof(char*), namesorter);

        for (i = 0; i < actual; i++) {
            /* free up memory from previous iterations of the loop */
            VIR_FREE(state);
            if (snapshot)
                virDomainSnapshotFree(snapshot);
            xmlXPathFreeContext(ctxt);
            if (xml)
                xmlFreeDoc(xml);
            VIR_FREE(doc);

            snapshot = virDomainSnapshotLookupByName(dom, names[i], 0);
            if (snapshot == NULL)
                continue;

            doc = virDomainSnapshotGetXMLDesc(snapshot, 0);
            if (!doc)
                continue;

            xml = xmlReadDoc((const xmlChar *) doc, "domainsnapshot.xml", NULL,
                             XML_PARSE_NOENT | XML_PARSE_NONET |
                             XML_PARSE_NOWARNING);
            if (!xml)
                continue;
            ctxt = xmlXPathNewContext(xml);
            if (!ctxt)
                continue;

            state = virXPathString("string(/domainsnapshot/state)", ctxt);
            if (state == NULL)
                continue;
11611 11612
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
11613
                continue;
11614 11615 11616 11617 11618 11619
            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);
11620
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
11621 11622 11623 11624 11625

            vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
        }
    }

E
Eric Blake 已提交
11626
    ret = true;
11627 11628 11629 11630 11631 11632 11633 11634 11635 11636

cleanup:
    /* this frees up memory from the last iteration of the loop */
    VIR_FREE(state);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    VIR_FREE(doc);
11637 11638
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660
    VIR_FREE(names);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-dumpxml" command
 */
static const vshCmdInfo info_snapshot_dumpxml[] = {
    {"help", N_("Dump XML for a domain snapshot")},
    {"desc", N_("Snapshot Dump XML")},
    {NULL, NULL}
};

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

E
Eric Blake 已提交
11661
static bool
11662 11663 11664
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11665
    bool ret = false;
11666
    const char *name = NULL;
11667 11668 11669
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

11670
    if (!vshConnectionUsability(ctl, ctl->conn))
11671 11672 11673 11674 11675 11676
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11677
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11678 11679 11680 11681 11682 11683 11684 11685 11686 11687
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

11688
    vshPrint(ctl, "%s", xml);
11689

E
Eric Blake 已提交
11690
    ret = true;
11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
11703
 * "snapshot-revert" command
11704
 */
11705
static const vshCmdInfo info_snapshot_revert[] = {
11706 11707 11708 11709 11710
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

11711
static const vshCmdOptDef opts_snapshot_revert[] = {
11712 11713 11714 11715 11716
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11717
static bool
11718
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
11719 11720
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11721
    bool ret = false;
11722
    const char *name = NULL;
11723 11724
    virDomainSnapshotPtr snapshot = NULL;

11725
    if (!vshConnectionUsability(ctl, ctl->conn))
11726 11727 11728 11729 11730 11731
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11732
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11733 11734 11735 11736 11737 11738 11739 11740 11741
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    if (virDomainRevertToSnapshot(snapshot, 0) < 0)
        goto cleanup;

E
Eric Blake 已提交
11742
    ret = true;
11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
 * "snapshot-delete" command
 */
static const vshCmdInfo info_snapshot_delete[] = {
    {"help", N_("Delete a domain snapshot")},
    {"desc", N_("Snapshot Delete")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_snapshot_delete[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"snapshotname", VSH_OT_DATA, VSH_OFLAG_REQ, N_("snapshot name")},
    {"children", VSH_OT_BOOL, 0, N_("delete snapshot and all children")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11769
static bool
11770 11771 11772
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11773
    bool ret = false;
11774
    const char *name = NULL;
11775 11776 11777
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

11778
    if (!vshConnectionUsability(ctl, ctl->conn))
11779 11780 11781 11782 11783 11784
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11785
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11786 11787 11788 11789 11790 11791 11792 11793 11794
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

11795 11796 11797 11798
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
        vshPrint(ctl, _("Domain snapshot %s deleted\n"), name);
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
11799
        goto cleanup;
11800
    }
11801

E
Eric Blake 已提交
11802
    ret = true;
11803 11804 11805 11806 11807 11808 11809 11810 11811 11812

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11813 11814 11815 11816
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
11817 11818
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
11819 11820 11821 11822 11823 11824
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_monitor_command[] = {
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"cmd", VSH_OT_DATA, VSH_OFLAG_REQ, N_("command")},
11825
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
11826 11827 11828
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11829
static bool
11830 11831 11832
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11833
    bool ret = false;
11834
    const char *monitor_cmd = NULL;
11835
    char *result = NULL;
11836
    unsigned int flags = 0;
11837 11838 11839 11840 11841 11842 11843 11844

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11845
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
11846 11847 11848 11849
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

11850 11851 11852 11853
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
11854 11855 11856 11857
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
11858
    ret = true;
11859 11860 11861 11862 11863 11864 11865 11866 11867

cleanup:
    VIR_FREE(result);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879 11880 11881 11882 11883 11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913
/*
 * "qemu-attach" command
 */
static const vshCmdInfo info_qemu_attach[] = {
    {"help", N_("QEMU Attach")},
    {"desc", N_("QEMU Attach")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_qemu_attach[] = {
    {"pid", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pid")},
    {NULL, 0, 0, NULL}
};

static bool
cmdQemuAttach(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    bool ret = false;
    unsigned int flags = 0;
    unsigned int pid;

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

    if (vshCommandOptUInt(cmd, "pid", &pid) <= 0) {
        vshError(ctl, "%s", _("missing pid value"));
        goto cleanup;
    }

    if (!(dom = virDomainQemuAttach(ctl->conn, pid, flags)))
        goto cleanup;

    if (dom != NULL) {
        vshPrint(ctl, _("Domain %s attached to pid %u\n"),
                 virDomainGetName(dom), pid);
        virDomainFree(dom);
        ret = true;
    } else {
        vshError(ctl, _("Failed to attach to pid %u"), pid);
    }

cleanup:
    return ret;
}

11914
static const vshCmdDef domManagementCmds[] = {
11915 11916 11917 11918 11919 11920 11921 11922
    {"attach-device", cmdAttachDevice, opts_attach_device,
     info_attach_device, 0},
    {"attach-disk", cmdAttachDisk, opts_attach_disk,
     info_attach_disk, 0},
    {"attach-interface", cmdAttachInterface, opts_attach_interface,
     info_attach_interface, 0},
    {"autostart", cmdAutostart, opts_autostart, info_autostart, 0},
    {"blkiotune", cmdBlkiotune, opts_blkiotune, info_blkiotune, 0},
11923
#ifndef WIN32
11924
    {"console", cmdConsole, opts_console, info_console, 0},
11925
#endif
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
    {"cpu-baseline", cmdCPUBaseline, opts_cpu_baseline, info_cpu_baseline, 0},
    {"cpu-compare", cmdCPUCompare, opts_cpu_compare, info_cpu_compare, 0},
    {"create", cmdCreate, opts_create, info_create, 0},
    {"define", cmdDefine, opts_define, info_define, 0},
    {"destroy", cmdDestroy, opts_destroy, info_destroy, 0},
    {"detach-device", cmdDetachDevice, opts_detach_device,
     info_detach_device, 0},
    {"detach-disk", cmdDetachDisk, opts_detach_disk, info_detach_disk, 0},
    {"detach-interface", cmdDetachInterface, opts_detach_interface,
     info_detach_interface, 0},
    {"domid", cmdDomid, opts_domid, info_domid, 0},
    {"domjobabort", cmdDomjobabort, opts_domjobabort, info_domjobabort, 0},
    {"domjobinfo", cmdDomjobinfo, opts_domjobinfo, info_domjobinfo, 0},
    {"domname", cmdDomname, opts_domname, info_domname, 0},
    {"domuuid", cmdDomuuid, opts_domuuid, info_domuuid, 0},
    {"domxml-from-native", cmdDomXMLFromNative, opts_domxmlfromnative,
     info_domxmlfromnative, 0},
    {"domxml-to-native", cmdDomXMLToNative, opts_domxmltonative,
     info_domxmltonative, 0},
    {"dump", cmdDump, opts_dump, info_dump, 0},
    {"dumpxml", cmdDumpXML, opts_dumpxml, info_dumpxml, 0},
    {"edit", cmdEdit, opts_edit, info_edit, 0},
    {"inject-nmi", cmdInjectNMI, opts_inject_nmi, info_inject_nmi, 0},
    {"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},
11957 11958
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
11959 11960 11961 11962 11963
    {"reboot", cmdReboot, opts_reboot, info_reboot, 0},
    {"restore", cmdRestore, opts_restore, info_restore, 0},
    {"resume", cmdResume, opts_resume, info_resume, 0},
    {"save", cmdSave, opts_save, info_save, 0},
    {"schedinfo", cmdSchedinfo, opts_schedinfo, info_schedinfo, 0},
11964
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976
    {"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 已提交
11977
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
11978
    {"version", cmdVersion, opts_version, info_version, 0},
11979 11980
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
11981 11982 11983
};

static const vshCmdDef domMonitoringCmds[] = {
11984 11985
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
11986
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
11987 11988 11989 11990 11991 11992
    {"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}
11993 11994 11995
};

static const vshCmdDef storagePoolCmds[] = {
11996
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
11997
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
11998
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
11999 12000 12001 12002 12003 12004 12005 12006 12007 12008 12009 12010 12011 12012 12013 12014 12015 12016 12017 12018 12019
     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}
12020 12021 12022
};

static const vshCmdDef storageVolCmds[] = {
12023 12024 12025 12026 12027 12028 12029 12030 12031 12032 12033 12034 12035 12036 12037 12038 12039 12040
    {"vol-clone", cmdVolClone, opts_vol_clone, info_vol_clone, 0},
    {"vol-create-as", cmdVolCreateAs, opts_vol_create_as,
     info_vol_create_as, 0},
    {"vol-create", cmdVolCreate, opts_vol_create, info_vol_create, 0},
    {"vol-create-from", cmdVolCreateFrom, opts_vol_create_from,
     info_vol_create_from, 0},
    {"vol-delete", cmdVolDelete, opts_vol_delete, info_vol_delete, 0},
    {"vol-download", cmdVolDownload, opts_vol_download, info_vol_download, 0},
    {"vol-dumpxml", cmdVolDumpXML, opts_vol_dumpxml, info_vol_dumpxml, 0},
    {"vol-info", cmdVolInfo, opts_vol_info, info_vol_info, 0},
    {"vol-key", cmdVolKey, opts_vol_key, info_vol_key, 0},
    {"vol-list", cmdVolList, opts_vol_list, info_vol_list, 0},
    {"vol-name", cmdVolName, opts_vol_name, info_vol_name, 0},
    {"vol-path", cmdVolPath, opts_vol_path, info_vol_path, 0},
    {"vol-pool", cmdVolPool, opts_vol_pool, info_vol_pool, 0},
    {"vol-upload", cmdVolUpload, opts_vol_upload, info_vol_upload, 0},
    {"vol-wipe", cmdVolWipe, opts_vol_wipe, info_vol_wipe, 0},
    {NULL, NULL, NULL, NULL, 0}
12041
};
12042

12043
static const vshCmdDef networkCmds[] = {
12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062
    {"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}
12063
};
12064

12065
static const vshCmdDef nodedevCmds[] = {
12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080
    {"nodedev-create", cmdNodeDeviceCreate, opts_node_device_create,
     info_node_device_create, 0},
    {"nodedev-destroy", cmdNodeDeviceDestroy, opts_node_device_destroy,
     info_node_device_destroy, 0},
    {"nodedev-dettach", cmdNodeDeviceDettach, opts_node_device_dettach,
     info_node_device_dettach, 0},
    {"nodedev-dumpxml", cmdNodeDeviceDumpXML, opts_node_device_dumpxml,
     info_node_device_dumpxml, 0},
    {"nodedev-list", cmdNodeListDevices, opts_node_list_devices,
     info_node_list_devices, 0},
    {"nodedev-reattach", cmdNodeDeviceReAttach, opts_node_device_reattach,
     info_node_device_reattach, 0},
    {"nodedev-reset", cmdNodeDeviceReset, opts_node_device_reset,
     info_node_device_reset, 0},
    {NULL, NULL, NULL, NULL, 0}
12081 12082 12083
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
12084 12085 12086 12087
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
12088 12089 12090 12091 12092 12093 12094 12095 12096 12097 12098 12099 12100 12101
    {"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 已提交
12102 12103
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
12104 12105 12106 12107 12108
    {"iface-start", cmdInterfaceStart, opts_interface_start,
     info_interface_start, 0},
    {"iface-undefine", cmdInterfaceUndefine, opts_interface_undefine,
     info_interface_undefine, 0},
    {NULL, NULL, NULL, NULL, 0}
12109
};
12110

12111
static const vshCmdDef nwfilterCmds[] = {
12112 12113 12114 12115 12116 12117 12118 12119 12120 12121 12122
    {"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}
12123
};
12124

12125
static const vshCmdDef secretCmds[] = {
12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137
    {"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}
12138
};
12139

12140
static const vshCmdDef virshCmds[] = {
12141 12142 12143 12144 12145 12146 12147
    {"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}
12148
};
12149

12150
static const vshCmdDef snapshotCmds[] = {
12151 12152
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
12153 12154
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
12155 12156 12157 12158 12159 12160 12161 12162 12163 12164 12165
    {"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},
    {"snapshot-list", cmdSnapshotList, opts_snapshot_list,
     info_snapshot_list, 0},
    {"snapshot-revert", cmdDomainSnapshotRevert, opts_snapshot_revert,
     info_snapshot_revert, 0},
    {NULL, NULL, NULL, NULL, 0}
12166
};
12167

12168
static const vshCmdDef hostAndHypervisorCmds[] = {
12169 12170 12171 12172 12173
    {"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},
12174
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
12175
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
12176
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
12177
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
12178 12179 12180 12181 12182
    {"qemu-monitor-command", cmdQemuMonitorCommand, opts_qemu_monitor_command,
     info_qemu_monitor_command, 0},
    {"sysinfo", cmdSysinfo, NULL, info_sysinfo, 0},
    {"uri", cmdURI, NULL, info_uri, 0},
    {NULL, NULL, NULL, NULL, 0}
K
Karel Zak 已提交
12183 12184
};

12185 12186 12187 12188 12189 12190 12191 12192 12193 12194 12195 12196 12197 12198 12199 12200 12201
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 已提交
12202 12203 12204 12205
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
12206
static const char *
12207
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
12208
{
12209
    const vshCmdInfo *info;
12210

K
Karel Zak 已提交
12211
    for (info = cmd->info; info && info->name; info++) {
12212
        if (STREQ(info->name, name))
K
Karel Zak 已提交
12213 12214 12215 12216 12217
            return info->data;
    }
    return NULL;
}

12218
static int
E
Eric Blake 已提交
12219
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
12220 12221 12222 12223 12224
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
12225 12226 12227
    *opts_need_arg = 0;
    *opts_required = 0;

12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240
    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) {
            if (opt->flag & VSH_OFLAG_REQ)
                return -1; /* bool options can't be mandatory */
            continue;
        }
L
Lai Jiangshan 已提交
12241 12242 12243 12244 12245 12246
        if (opt->flag & VSH_OFLAG_REQ_OPT) {
            if (opt->flag & VSH_OFLAG_REQ)
                *opts_required |= 1 << i;
            continue;
        }

12247 12248 12249 12250 12251 12252 12253 12254 12255 12256 12257 12258
        *opts_need_arg |= 1 << i;
        if (opt->flag & VSH_OFLAG_REQ) {
            if (optional)
                return -1; /* mandatory options must be listed first */
            *opts_required |= 1 << i;
        } else {
            optional = true;
        }
    }
    return 0;
}

12259
static const vshCmdOptDef *
12260 12261
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
12262
{
12263 12264 12265 12266
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
12267

12268 12269 12270 12271 12272
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
12273 12274 12275 12276 12277
            if (opt->type == VSH_OT_ARGV) {
                vshError(ctl, _("variable argument <%s> "
                         "should not be used with --<%s>"), name, name);
                return NULL;
            }
12278
            *opts_seen |= 1 << i;
K
Karel Zak 已提交
12279
            return opt;
12280 12281 12282 12283 12284
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
12285 12286 12287
    return NULL;
}

12288
static const vshCmdOptDef *
12289 12290
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
12291
{
12292
    int i;
12293
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
12294

12295 12296 12297 12298 12299 12300 12301 12302 12303 12304
    if (!*opts_need_arg)
        return NULL;

    /* Grab least-significant set bit */
    i = count_one_bits(*opts_need_arg ^ (*opts_need_arg - 1)) - 1;
    opt = &cmd->opts[i];
    if (opt->type != VSH_OT_ARGV)
        *opts_need_arg &= ~(1 << i);
    *opts_seen |= 1 << i;
    return opt;
K
Karel Zak 已提交
12305 12306
}

12307 12308 12309
/*
 * Checks for required options
 */
12310
static int
12311 12312
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
12313
{
12314
    const vshCmdDef *def = cmd->def;
12315 12316 12317 12318 12319 12320 12321 12322 12323
    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];
12324

12325
            vshError(ctl,
12326
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
12327 12328 12329
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
12330 12331
        }
    }
12332
    return -1;
12333 12334
}

12335
static const vshCmdDef *
12336 12337
vshCmddefSearch(const char *cmdname)
{
12338
    const vshCmdGrp *g;
12339
    const vshCmdDef *c;
12340

12341 12342
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
12343
            if (STREQ(c->name, cmdname))
12344 12345 12346 12347
                return c;
        }
    }

K
Karel Zak 已提交
12348 12349 12350
    return NULL;
}

12351 12352 12353 12354 12355 12356
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
12357
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
12358 12359 12360 12361 12362 12363
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
12364
static bool
12365 12366 12367 12368 12369 12370 12371
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 已提交
12372
        return false;
12373 12374 12375 12376 12377 12378 12379 12380 12381 12382
    } 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 已提交
12383
    return true;
12384 12385
}

E
Eric Blake 已提交
12386
static bool
12387
vshCmddefHelp(vshControl *ctl, const char *cmdname)
12388
{
12389
    const vshCmdDef *def = vshCmddefSearch(cmdname);
12390

K
Karel Zak 已提交
12391
    if (!def) {
12392
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
12393
        return false;
12394
    } else {
E
Eric Blake 已提交
12395 12396
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
12397
        const char *help = _(vshCmddefGetInfo(def, "help"));
12398
        char buf[256];
12399 12400 12401 12402 12403 12404
        uint32_t opts_need_arg;
        uint32_t opts_required;

        if (vshCmddefOptParse(def, &opts_need_arg, &opts_required)) {
            vshError(ctl, _("internal error: bad options in command: '%s'"),
                     def->name);
E
Eric Blake 已提交
12405
            return false;
12406
        }
K
Karel Zak 已提交
12407

12408
        fputs(_("  NAME\n"), stdout);
12409 12410
        fprintf(stdout, "    %s - %s\n", def->name, help);

12411 12412 12413 12414 12415
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
12416
                const char *fmt = "%s";
12417 12418
                switch (opt->type) {
                case VSH_OT_BOOL:
12419
                    fmt = "[--%s]";
12420 12421
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
12422
                    /* xgettext:c-format */
12423 12424
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
12425 12426
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
12427 12428
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
12429 12430
                    break;
                case VSH_OT_DATA:
12431
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
12432 12433 12434
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
12435 12436
                    fmt = (opt->flag & VSH_OFLAG_REQ) ? _("<%s>...")
                           : _("[<%s>]...");
12437 12438
                    break;
                default:
12439
                    assert(0);
12440
                }
12441
                fputc(' ', stdout);
E
Eric Blake 已提交
12442
                fprintf(stdout, fmt, opt->name);
12443
            }
K
Karel Zak 已提交
12444
        }
12445 12446 12447
        fputc('\n', stdout);

        if (desc[0]) {
12448
            /* Print the description only if it's not empty.  */
12449
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
12450
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
12451
        }
12452

K
Karel Zak 已提交
12453
        if (def->opts) {
12454
            const vshCmdOptDef *opt;
12455
            fputs(_("\n  OPTIONS\n"), stdout);
12456
            for (opt = def->opts; opt->name; opt++) {
12457 12458
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
12459
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
12460 12461
                    break;
                case VSH_OT_INT:
12462 12463 12464
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
12465 12466
                    break;
                case VSH_OT_STRING:
12467
                    /* OT_STRING should never be VSH_OFLAG_REQ */
12468
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
12469 12470
                    break;
                case VSH_OT_DATA:
12471 12472
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
12473 12474 12475
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
12476 12477
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
12478 12479 12480
                default:
                    assert(0);
                }
12481

E
Eric Blake 已提交
12482
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
12483
            }
K
Karel Zak 已提交
12484 12485 12486
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
12487
    return true;
K
Karel Zak 已提交
12488 12489 12490 12491 12492 12493
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
12494 12495 12496
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
12497 12498
    vshCmdOpt *a = arg;

12499
    while (a) {
K
Karel Zak 已提交
12500
        vshCmdOpt *tmp = a;
12501

K
Karel Zak 已提交
12502 12503
        a = a->next;

12504 12505
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
12506 12507 12508 12509
    }
}

static void
12510
vshCommandFree(vshCmd *cmd)
12511
{
K
Karel Zak 已提交
12512 12513
    vshCmd *c = cmd;

12514
    while (c) {
K
Karel Zak 已提交
12515
        vshCmd *tmp = c;
12516

K
Karel Zak 已提交
12517 12518 12519 12520
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
12521
        VIR_FREE(tmp);
K
Karel Zak 已提交
12522 12523 12524
    }
}

E
Eric Blake 已提交
12525 12526 12527 12528 12529 12530 12531 12532 12533 12534 12535
/**
 * 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 已提交
12536
 */
E
Eric Blake 已提交
12537 12538
static int
vshCommandOpt(const vshCmd *cmd, const char *name, vshCmdOpt **opt)
12539
{
E
Eric Blake 已提交
12540 12541
    vshCmdOpt *candidate = cmd->opts;
    const vshCmdOptDef *valid = cmd->def->opts;
12542

E
Eric Blake 已提交
12543 12544 12545 12546 12547 12548 12549
    /* 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 已提交
12550
    }
E
Eric Blake 已提交
12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561 12562

    /* Option not present, see if command requires it.  */
    *opt = NULL;
    while (valid) {
        if (!valid->name)
            break;
        if (STREQ(name, valid->name))
            return (valid->flag & VSH_OFLAG_REQ) == 0 ? 0 : -1;
        valid++;
    }
    /* If we got here, the name is unknown.  */
    return -2;
K
Karel Zak 已提交
12563 12564
}

E
Eric Blake 已提交
12565 12566
/**
 * vshCommandOptInt:
12567 12568 12569 12570 12571 12572 12573
 * @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 已提交
12574
 * 0 if option not found and not required (@value untouched)
12575
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
12576 12577
 */
static int
12578
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
12579
{
E
Eric Blake 已提交
12580 12581 12582
    vshCmdOpt *arg;
    int ret;
    int num;
12583
    char *end_p = NULL;
12584

E
Eric Blake 已提交
12585 12586 12587 12588 12589 12590 12591
    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;
12592
    }
E
Eric Blake 已提交
12593 12594 12595 12596 12597 12598 12599

    num = strtol(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
K
Karel Zak 已提交
12600 12601
}

12602

E
Eric Blake 已提交
12603 12604 12605 12606 12607 12608
/**
 * vshCommandOptUInt:
 * @cmd command reference
 * @name option name
 * @value result
 *
12609 12610 12611 12612 12613 12614
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
E
Eric Blake 已提交
12615 12616 12617
    vshCmdOpt *arg;
    int ret;
    unsigned int num;
12618 12619
    char *end_p = NULL;

E
Eric Blake 已提交
12620 12621 12622 12623 12624 12625 12626
    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;
12627
    }
E
Eric Blake 已提交
12628 12629 12630 12631 12632 12633 12634

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
12635 12636 12637
}


12638
/*
E
Eric Blake 已提交
12639 12640 12641 12642 12643
 * vshCommandOptUL:
 * @cmd command reference
 * @name option name
 * @value result
 *
12644 12645 12646 12647 12648
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
12649
{
E
Eric Blake 已提交
12650 12651
    vshCmdOpt *arg;
    int ret;
12652
    unsigned long num;
12653 12654
    char *end_p = NULL;

E
Eric Blake 已提交
12655 12656 12657 12658 12659 12660 12661
    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;
12662
    }
E
Eric Blake 已提交
12663 12664 12665 12666 12667 12668 12669

    num = strtoul(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
12670 12671
}

E
Eric Blake 已提交
12672 12673 12674 12675 12676 12677
/**
 * vshCommandOptString:
 * @cmd command reference
 * @name option name
 * @value result
 *
K
Karel Zak 已提交
12678
 * Returns option as STRING
E
Eric Blake 已提交
12679 12680 12681 12682
 * 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 已提交
12683
 */
12684 12685
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
12686
{
E
Eric Blake 已提交
12687 12688 12689 12690 12691 12692 12693 12694 12695 12696
    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;
12697
    }
12698

E
Eric Blake 已提交
12699 12700 12701 12702 12703
    if (!*arg->data && !(arg->def->flag & VSH_OFLAG_EMPTY_OK)) {
        return -1;
    }
    *value = arg->data;
    return 1;
K
Karel Zak 已提交
12704 12705
}

E
Eric Blake 已提交
12706 12707 12708 12709 12710 12711
/**
 * vshCommandOptLongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
12712
 * Returns option as long long
12713
 * See vshCommandOptInt()
12714
 */
12715 12716 12717
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
12718
{
E
Eric Blake 已提交
12719 12720
    vshCmdOpt *arg;
    int ret;
12721
    long long num;
12722 12723
    char *end_p = NULL;

E
Eric Blake 已提交
12724 12725 12726 12727 12728 12729 12730
    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;
12731
    }
E
Eric Blake 已提交
12732 12733 12734 12735 12736 12737 12738

    num = strtoll(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
12739 12740
}

E
Eric Blake 已提交
12741 12742 12743 12744 12745 12746 12747 12748 12749
/**
 * vshCommandOptULongLong:
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Returns option as long long
 * See vshCommandOptInt()
 */
12750 12751 12752 12753
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
E
Eric Blake 已提交
12754 12755
    vshCmdOpt *arg;
    int ret;
12756 12757 12758
    unsigned long long num;
    char *end_p = NULL;

E
Eric Blake 已提交
12759 12760 12761 12762 12763 12764 12765
    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;
12766
    }
E
Eric Blake 已提交
12767 12768 12769 12770 12771 12772 12773

    num = strtoull(arg->data, &end_p, 10);
    if ((arg->data != end_p) && (*end_p == 0)) {
        *value = num;
        return 1;
    }
    return -1;
12774 12775 12776
}


E
Eric Blake 已提交
12777 12778 12779 12780 12781 12782 12783 12784 12785
/**
 * 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 已提交
12786
 */
E
Eric Blake 已提交
12787
static bool
12788
vshCommandOptBool(const vshCmd *cmd, const char *name)
12789
{
E
Eric Blake 已提交
12790 12791 12792
    vshCmdOpt *dummy;

    return vshCommandOpt(cmd, name, &dummy) == 1;
K
Karel Zak 已提交
12793 12794
}

E
Eric Blake 已提交
12795 12796 12797 12798 12799
/**
 * vshCommandOptArgv:
 * @cmd command reference
 * @opt starting point for the search
 *
12800 12801
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
12802
 *
12803
 * Requires that a VSH_OT_ARGV option be last in the
12804 12805
 * list of supported options in CMD->def->opts.
 */
12806 12807
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
12808
{
12809
    opt = opt ? opt->next : cmd->opts;
12810 12811

    while (opt) {
E
Eric Blake 已提交
12812
        if (opt->def->type == VSH_OT_ARGV) {
12813
            return opt;
12814 12815 12816 12817 12818 12819
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 12834 12835 12836 12837
/* 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)
12838
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
12839 12840 12841
                 cmd->def->name, optname);
    return found;
}
12842

K
Karel Zak 已提交
12843
static virDomainPtr
J
Jim Meyering 已提交
12844
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
12845
                      const char **name, int flag)
12846
{
K
Karel Zak 已提交
12847
    virDomainPtr dom = NULL;
12848
    const char *n = NULL;
K
Karel Zak 已提交
12849
    int id;
J
Jim Meyering 已提交
12850 12851 12852
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
12853

12854
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12855 12856
        return NULL;

12857
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
12858 12859
             cmd->def->name, optname, n);

K
Karel Zak 已提交
12860 12861
    if (name)
        *name = n;
12862

K
Karel Zak 已提交
12863
    /* try it by ID */
12864
    if (flag & VSH_BYID) {
12865
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
12866 12867
            vshDebug(ctl, VSH_ERR_DEBUG,
                     "%s: <%s> seems like domain ID\n",
K
Karel Zak 已提交
12868 12869 12870
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
12871
    }
K
Karel Zak 已提交
12872
    /* try it by UUID */
12873
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
12874
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain UUID\n",
12875
                 cmd->def->name, optname);
K
Karel Zak 已提交
12876
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
12877
    }
K
Karel Zak 已提交
12878
    /* try it by NAME */
12879
    if (dom==NULL && (flag & VSH_BYNAME)) {
12880
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as domain NAME\n",
12881
                 cmd->def->name, optname);
K
Karel Zak 已提交
12882
        dom = virDomainLookupByName(ctl->conn, n);
12883
    }
K
Karel Zak 已提交
12884

12885
    if (!dom)
12886
        vshError(ctl, _("failed to get domain '%s'"), n);
12887

K
Karel Zak 已提交
12888 12889 12890
    return dom;
}

12891
static virNetworkPtr
J
Jim Meyering 已提交
12892
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
12893
                       const char **name, int flag)
12894 12895
{
    virNetworkPtr network = NULL;
12896
    const char *n = NULL;
J
Jim Meyering 已提交
12897 12898 12899
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
12900

12901
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12902 12903
        return NULL;

12904
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
12905 12906 12907 12908 12909 12910
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
12911
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
12912
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network UUID\n",
12913
                 cmd->def->name, optname);
12914 12915 12916 12917
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
12918
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as network NAME\n",
12919 12920 12921 12922 12923
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
12924
        vshError(ctl, _("failed to get network '%s'"), n);
12925 12926 12927 12928

    return network;
}

12929 12930 12931

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
12932
                        const char **name, int flag)
12933 12934
{
    virNWFilterPtr nwfilter = NULL;
12935
    const char *n = NULL;
12936 12937 12938 12939
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

12940
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12941 12942
        return NULL;

12943
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
12944 12945 12946 12947 12948 12949 12950
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
12951
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter UUID\n",
12952 12953 12954 12955 12956
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
12957
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as nwfilter NAME\n",
12958 12959 12960 12961 12962 12963 12964 12965 12966 12967
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

12968 12969
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
12970
                         const char **name, int flag)
12971 12972
{
    virInterfacePtr iface = NULL;
12973
    const char *n = NULL;
12974 12975 12976 12977
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

12978
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12979 12980
        return NULL;

12981
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
12982 12983 12984 12985 12986 12987
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
12988
    if ((flag & VSH_BYNAME)) {
12989
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface NAME\n",
12990 12991 12992 12993 12994
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
12995
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as interface MAC\n",
12996 12997 12998 12999 13000
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
13001
        vshError(ctl, _("failed to get interface '%s'"), n);
13002 13003 13004 13005

    return iface;
}

13006
static virStoragePoolPtr
13007
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
13008
                    const char **name, int flag)
13009 13010
{
    virStoragePoolPtr pool = NULL;
13011
    const char *n = NULL;
13012

13013
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13014 13015
        return NULL;

13016
    vshDebug(ctl, VSH_ERR_INFO, "%s: found option <%s>: %s\n",
13017 13018 13019 13020 13021 13022
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
13023
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
13024
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool UUID\n",
13025
                 cmd->def->name, optname);
13026 13027 13028
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
13029
    if (pool == NULL && (flag & VSH_BYNAME)) {
13030
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as pool NAME\n",
13031 13032 13033 13034 13035
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
13036
        vshError(ctl, _("failed to get pool '%s'"), n);
13037 13038 13039 13040 13041

    return pool;
}

static virStorageVolPtr
13042
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
13043 13044
                   const char *optname,
                   const char *pooloptname,
13045
                   const char **name, int flag)
13046 13047 13048
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
13049
    const char *n = NULL, *p = NULL;
13050

13051
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13052 13053
        return NULL;

13054 13055
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
13056
        return NULL;
13057
    }
13058 13059 13060 13061

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

13062
    vshDebug(ctl, VSH_ERR_DEBUG, "%s: found option <%s>: %s\n",
13063 13064 13065 13066 13067
             cmd->def->name, optname, n);

    if (name)
        *name = n;

13068
    /* try it by name */
13069
    if (pool && (flag & VSH_BYNAME)) {
13070
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol name\n",
13071 13072 13073
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
13074
    /* try it by key */
13075
    if (vol == NULL && (flag & VSH_BYUUID)) {
13076
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol key\n",
13077 13078 13079
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
13080
    /* try it by path */
13081
    if (vol == NULL && (flag & VSH_BYUUID)) {
13082
        vshDebug(ctl, VSH_ERR_DEBUG, "%s: <%s> trying as vol path\n",
13083 13084 13085 13086 13087
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
13088
        vshError(ctl, _("failed to get vol '%s'"), n);
13089 13090 13091 13092 13093 13094 13095

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

13096
static virSecretPtr
13097
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
13098 13099
{
    virSecretPtr secret = NULL;
13100
    const char *n = NULL;
13101 13102 13103 13104 13105
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

13106
    if (vshCommandOptString(cmd, optname, &n) <= 0)
13107 13108
        return NULL;

13109 13110
    vshDebug(ctl, VSH_ERR_DEBUG,
             "%s: found option <%s>: %s\n", cmd->def->name, optname, n);
13111 13112 13113 13114 13115 13116 13117

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
13118
        vshError(ctl, _("failed to get secret '%s'"), n);
13119 13120 13121 13122

    return secret;
}

K
Karel Zak 已提交
13123 13124 13125
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
13126
static bool
13127
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
13128
{
E
Eric Blake 已提交
13129
    bool ret = true;
13130 13131

    while (cmd) {
K
Karel Zak 已提交
13132
        struct timeval before, after;
13133
        bool enable_timing = ctl->timing;
13134

13135 13136
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
13137 13138
            vshReconnect(ctl);

13139
        if (enable_timing)
K
Karel Zak 已提交
13140
            GETTIMEOFDAY(&before);
13141

K
Karel Zak 已提交
13142 13143
        ret = cmd->def->handler(ctl, cmd);

13144
        if (enable_timing)
K
Karel Zak 已提交
13145
            GETTIMEOFDAY(&after);
13146

13147
        if (!ret)
J
John Levon 已提交
13148 13149
            virshReportError(ctl);

13150
        /* try to automatically catch disconnections */
13151
        if (!ret &&
13152 13153 13154 13155 13156 13157 13158 13159 13160
            ((disconnected != 0) ||
             ((last_error != NULL) &&
              (((last_error->code == VIR_ERR_SYSTEM_ERROR) &&
                (last_error->domain == VIR_FROM_REMOTE)) ||
               (last_error->code == VIR_ERR_RPC) ||
               (last_error->code == VIR_ERR_NO_CONNECT) ||
               (last_error->code == VIR_ERR_INVALID_CONN)))))
            vshReconnect(ctl);

13161
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
13162 13163
            return ret;

13164
        if (enable_timing)
13165
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
13166 13167
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
13168
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
13169 13170 13171 13172 13173 13174
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
13175
 * Command parsing
K
Karel Zak 已提交
13176 13177 13178
 * ---------------
 */

13179 13180 13181 13182 13183 13184 13185 13186 13187 13188
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 已提交
13189
    /* vshCommandStringGetArg() */
13190
    char *pos;
L
Lai Jiangshan 已提交
13191 13192 13193
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
13194 13195
} vshCommandParser;

E
Eric Blake 已提交
13196
static bool
13197
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
13198
{
K
Karel Zak 已提交
13199 13200 13201
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
13202

K
Karel Zak 已提交
13203 13204 13205 13206
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
13207

13208
    while (1) {
K
Karel Zak 已提交
13209
        vshCmdOpt *last = NULL;
13210
        const vshCmdDef *cmd = NULL;
13211
        vshCommandToken tk;
L
Lai Jiangshan 已提交
13212
        bool data_only = false;
13213 13214 13215
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
13216

K
Karel Zak 已提交
13217
        first = NULL;
13218

13219
        while (1) {
13220
            const vshCmdOptDef *opt = NULL;
13221

K
Karel Zak 已提交
13222
            tkdata = NULL;
13223
            tk = parser->getNextArg(ctl, parser, &tkdata);
13224 13225

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
13226
                goto syntaxError;
H
Hu Tao 已提交
13227 13228
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
13229
                break;
H
Hu Tao 已提交
13230
            }
13231 13232

            if (cmd == NULL) {
K
Karel Zak 已提交
13233 13234
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
13235
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
13236
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
13237
                }
13238 13239 13240 13241 13242 13243 13244
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
13245
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
13246 13247 13248 13249
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
13250 13251 13252 13253 13254
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
13255 13256
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
13257
                    VIR_FREE(optstr);
K
Karel Zak 已提交
13258 13259
                    goto syntaxError;
                }
13260
                VIR_FREE(tkdata);
K
Karel Zak 已提交
13261 13262 13263

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
13264 13265 13266
                    if (optstr)
                        tkdata = optstr;
                    else
13267
                        tk = parser->getNextArg(ctl, parser, &tkdata);
13268
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
13269
                        goto syntaxError;
13270
                    if (tk != VSH_TK_ARG) {
13271
                        vshError(ctl,
13272
                                 _("expected syntax: --%s <%s>"),
13273 13274
                                 opt->name,
                                 opt->type ==
13275
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
13276 13277
                        goto syntaxError;
                    }
13278
                    opts_need_arg &= ~opts_seen;
13279 13280 13281 13282 13283 13284 13285 13286
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
13287
                }
L
Lai Jiangshan 已提交
13288 13289 13290 13291
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
13292
            } else {
L
Lai Jiangshan 已提交
13293
get_data:
13294 13295
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
13296
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
13297 13298 13299 13300 13301
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
13302
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
13303

K
Karel Zak 已提交
13304 13305 13306 13307
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
13308

K
Karel Zak 已提交
13309 13310 13311 13312 13313
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
13314

13315
                vshDebug(ctl, VSH_ERR_INFO, "%s: %s(%s): %s\n",
13316 13317
                         cmd->name,
                         opt->name,
13318 13319
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
13320 13321
            }
        }
13322

D
Daniel Veillard 已提交
13323
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
13324
        if (cmd) {
13325
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
13326

K
Karel Zak 已提交
13327 13328 13329 13330
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

13331
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
13332
                VIR_FREE(c);
13333
                goto syntaxError;
13334
            }
13335

K
Karel Zak 已提交
13336 13337 13338 13339 13340 13341
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
13342 13343 13344

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
13345
    }
13346

E
Eric Blake 已提交
13347
    return true;
K
Karel Zak 已提交
13348

13349
 syntaxError:
13350
    if (ctl->cmd) {
K
Karel Zak 已提交
13351
        vshCommandFree(ctl->cmd);
13352 13353
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
13354 13355
    if (first)
        vshCommandOptFree(first);
13356
    VIR_FREE(tkdata);
E
Eric Blake 已提交
13357
    return false;
K
Karel Zak 已提交
13358 13359
}

13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 13376 13377
/* --------------------
 * 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 已提交
13378 13379
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
13380 13381 13382 13383
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
13384
        return false;
13385 13386 13387 13388 13389 13390 13391 13392 13393 13394 13395 13396 13397 13398 13399 13400 13401 13402 13403 13404 13405 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418 13419 13420 13421 13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456

    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 已提交
13457 13458
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
13459 13460 13461 13462
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
13463
        return false;
13464 13465 13466 13467 13468 13469

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
13470
/* ---------------
13471
 * Misc utils
K
Karel Zak 已提交
13472 13473
 * ---------------
 */
13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492 13493 13494 13495 13496 13497 13498 13499 13500 13501
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 已提交
13502
static const char *
13503 13504
vshDomainStateToString(int state)
{
13505
    switch ((virDomainState) state) {
13506
    case VIR_DOMAIN_RUNNING:
13507
        return N_("running");
13508
    case VIR_DOMAIN_BLOCKED:
13509
        return N_("idle");
13510
    case VIR_DOMAIN_PAUSED:
13511
        return N_("paused");
13512
    case VIR_DOMAIN_SHUTDOWN:
13513
        return N_("in shutdown");
13514
    case VIR_DOMAIN_SHUTOFF:
13515
        return N_("shut off");
13516
    case VIR_DOMAIN_CRASHED:
13517
        return N_("crashed");
13518
    case VIR_DOMAIN_NOSTATE:
13519
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
13520
    }
13521
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
13522 13523
}

13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 13540 13541 13542 13543 13544 13545 13546 13547 13548 13549 13550 13551 13552 13553 13554 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
static const char *
vshDomainStateReasonToString(int state, int reason)
{
    switch ((virDomainState) state) {
    case VIR_DOMAIN_NOSTATE:
        switch ((virDomainNostateReason) reason) {
        case VIR_DOMAIN_NOSTATE_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_RUNNING:
        switch ((virDomainRunningReason) reason) {
        case VIR_DOMAIN_RUNNING_BOOTED:
            return N_("booted");
        case VIR_DOMAIN_RUNNING_MIGRATED:
            return N_("migrated");
        case VIR_DOMAIN_RUNNING_RESTORED:
            return N_("restored");
        case VIR_DOMAIN_RUNNING_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_RUNNING_UNPAUSED:
            return N_("unpaused");
        case VIR_DOMAIN_RUNNING_MIGRATION_CANCELED:
            return N_("migration canceled");
        case VIR_DOMAIN_RUNNING_SAVE_CANCELED:
            return N_("save canceled");
        case VIR_DOMAIN_RUNNING_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_BLOCKED:
        switch ((virDomainBlockedReason) reason) {
        case VIR_DOMAIN_BLOCKED_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_PAUSED:
        switch ((virDomainPausedReason) reason) {
        case VIR_DOMAIN_PAUSED_USER:
            return N_("user");
        case VIR_DOMAIN_PAUSED_MIGRATION:
            return N_("migrating");
        case VIR_DOMAIN_PAUSED_SAVE:
            return N_("saving");
        case VIR_DOMAIN_PAUSED_DUMP:
            return N_("dumping");
        case VIR_DOMAIN_PAUSED_IOERROR:
            return N_("I/O error");
        case VIR_DOMAIN_PAUSED_WATCHDOG:
            return N_("watchdog");
        case VIR_DOMAIN_PAUSED_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_PAUSED_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_SHUTDOWN:
        switch ((virDomainShutdownReason) reason) {
        case VIR_DOMAIN_SHUTDOWN_USER:
            return N_("user");
        case VIR_DOMAIN_SHUTDOWN_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_SHUTOFF:
        switch ((virDomainShutoffReason) reason) {
        case VIR_DOMAIN_SHUTOFF_SHUTDOWN:
            return N_("shutdown");
        case VIR_DOMAIN_SHUTOFF_DESTROYED:
            return N_("destroyed");
        case VIR_DOMAIN_SHUTOFF_CRASHED:
            return N_("crashed");
        case VIR_DOMAIN_SHUTOFF_MIGRATED:
            return N_("migrated");
        case VIR_DOMAIN_SHUTOFF_SAVED:
            return N_("saved");
        case VIR_DOMAIN_SHUTOFF_FAILED:
            return N_("failed");
        case VIR_DOMAIN_SHUTOFF_FROM_SNAPSHOT:
            return N_("from snapshot");
        case VIR_DOMAIN_SHUTOFF_UNKNOWN:
            ;
        }
        break;

    case VIR_DOMAIN_CRASHED:
        switch ((virDomainCrashedReason) reason) {
        case VIR_DOMAIN_CRASHED_UNKNOWN:
            ;
        }
        break;
    }

    return N_("unknown");
}

13625 13626 13627 13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641
static const char *
vshDomainControlStateToString(int state)
{
    switch ((virDomainControlState) state) {
    case VIR_DOMAIN_CONTROL_OK:
        return N_("ok");
    case VIR_DOMAIN_CONTROL_JOB:
        return N_("background job");
    case VIR_DOMAIN_CONTROL_OCCUPIED:
        return N_("occupied");
    case VIR_DOMAIN_CONTROL_ERROR:
        return N_("error");
    }

    return N_("unknown");
}

13642 13643 13644 13645
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
13646
    case VIR_VCPU_OFFLINE:
13647
        return N_("offline");
13648
    case VIR_VCPU_BLOCKED:
13649
        return N_("idle");
13650
    case VIR_VCPU_RUNNING:
13651
        return N_("running");
13652
    default:
13653
        ;/*FALLTHROUGH*/
13654
    }
13655
    return N_("no state");
13656 13657
}

E
Eric Blake 已提交
13658
static bool
13659
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
13660
{
13661 13662
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
13663 13664
     */
    if (!conn) {
13665
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
13666
        return false;
K
Karel Zak 已提交
13667
    }
E
Eric Blake 已提交
13668
    return true;
K
Karel Zak 已提交
13669 13670
}

K
Karel Zak 已提交
13671
static void
13672
vshDebug(vshControl *ctl, int level, const char *format, ...)
13673
{
K
Karel Zak 已提交
13674
    va_list ap;
13675
    char *str;
K
Karel Zak 已提交
13676

13677 13678 13679 13680 13681 13682 13683
    /* Aligning log levels to that of libvirt.
     * Traces with levels >=  user-specified-level
     * gets logged into file
     */
    if (level < ctl->debug)
        return;

13684
    va_start(ap, format);
13685
    vshOutputLogFile(ctl, level, format, ap);
13686 13687
    va_end(ap);

K
Karel Zak 已提交
13688
    va_start(ap, format);
13689 13690 13691 13692 13693
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
13694
    va_end(ap);
13695 13696
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
13697 13698 13699
}

static void
13700
vshPrintExtra(vshControl *ctl, const char *format, ...)
13701
{
K
Karel Zak 已提交
13702
    va_list ap;
13703
    char *str;
13704

13705
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
13706
        return;
13707

K
Karel Zak 已提交
13708
    va_start(ap, format);
13709 13710 13711 13712 13713
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
13714
    va_end(ap);
13715
    fputs(str, stdout);
13716
    VIR_FREE(str);
K
Karel Zak 已提交
13717 13718
}

K
Karel Zak 已提交
13719

K
Karel Zak 已提交
13720
static void
13721
vshError(vshControl *ctl, const char *format, ...)
13722
{
K
Karel Zak 已提交
13723
    va_list ap;
13724
    char *str;
13725

13726 13727 13728 13729 13730
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
13731

13732
    fputs(_("error: "), stderr);
13733

K
Karel Zak 已提交
13734
    va_start(ap, format);
13735 13736 13737
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
13738 13739
    va_end(ap);

13740 13741
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
13742 13743
}

13744

K
Karel Zak 已提交
13745
/*
13746
 * Initialize connection.
K
Karel Zak 已提交
13747
 */
E
Eric Blake 已提交
13748
static bool
13749
vshInit(vshControl *ctl)
13750
{
13751 13752
    char *debugEnv;

K
Karel Zak 已提交
13753
    if (ctl->conn)
E
Eric Blake 已提交
13754
        return false;
K
Karel Zak 已提交
13755

J
Jiri Denemark 已提交
13756
    if (ctl->debug == VSH_DEBUG_DEFAULT) {
13757 13758 13759
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
J
Jiri Denemark 已提交
13760 13761 13762
            int debug;
            if (virStrToLong_i(debugEnv, NULL, 10, &debug) < 0 ||
                debug < VSH_ERR_DEBUG || debug > VSH_ERR_ERROR) {
13763 13764
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
J
Jiri Denemark 已提交
13765 13766
            } else {
                ctl->debug = debug;
13767 13768 13769 13770 13771 13772 13773 13774 13775 13776 13777 13778
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

13779 13780
    vshOpenLogFile(ctl);

13781 13782
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
13783

13784 13785 13786
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

13787
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
13788
        return false;
13789

13790 13791 13792 13793
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
13794

13795 13796 13797 13798 13799 13800 13801 13802 13803 13804 13805
        /* 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;
        }
13806
    }
K
Karel Zak 已提交
13807

E
Eric Blake 已提交
13808
    return true;
K
Karel Zak 已提交
13809 13810
}

13811 13812
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

13813 13814 13815 13816 13817 13818 13819 13820 13821 13822 13823 13824 13825 13826 13827 13828 13829 13830 13831
/**
 * 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:
13832
                vshError(ctl, "%s",
J
Jim Meyering 已提交
13833
                         _("failed to get the log file information"));
13834
                exit(EXIT_FAILURE);
13835 13836 13837
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
13838 13839
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
13840 13841 13842 13843
        }
    }

    /* log file open */
13844
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
13845
        vshError(ctl, "%s",
J
Jim Meyering 已提交
13846
                 _("failed to open the log file. check the log file path"));
13847
        exit(EXIT_FAILURE);
13848 13849 13850 13851 13852 13853 13854 13855 13856
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
13857 13858
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
13859
{
13860 13861 13862
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 13875 13876
    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);
13877
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
13878 13879 13880 13881 13882 13883
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
13884 13885
                      SIGN_NAME,
                      (int) getpid());
13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905
    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;
    }
13906 13907 13908
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
13909

13910 13911
    if (virBufferError(&buf))
        goto error;
13912

13913 13914 13915 13916 13917
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
13918
    }
13919

13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930
    /* 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);
13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
13942 13943 13944
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
13945 13946 13947
    }

    if (ctl->logfile) {
13948
        VIR_FREE(ctl->logfile);
13949 13950 13951 13952
        ctl->logfile = NULL;
    }
}

13953
#ifdef USE_READLINE
13954

K
Karel Zak 已提交
13955 13956 13957 13958 13959
/* -----------------
 * Readline stuff
 * -----------------
 */

13960
/*
K
Karel Zak 已提交
13961 13962
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
13963
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
13964 13965
 */
static char *
13966 13967
vshReadlineCommandGenerator(const char *text, int state)
{
13968
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
13969
    const char *name;
13970 13971
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
13972 13973

    if (!state) {
13974 13975
        grp_list_index = 0;
        cmd_list_index = 0;
13976
        len = strlen(text);
K
Karel Zak 已提交
13977 13978
    }

13979 13980
    grp = cmdGroups;

K
Karel Zak 已提交
13981
    /* Return the next name which partially matches from the
13982
     * command list.
K
Karel Zak 已提交
13983
     */
13984 13985 13986 13987 13988 13989 13990 13991 13992 13993 13994 13995 13996 13997
    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 已提交
13998 13999 14000 14001 14002 14003 14004
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
14005 14006
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
14007
    static int list_index, len;
14008
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
14009
    const char *name;
K
Karel Zak 已提交
14010 14011 14012 14013 14014 14015 14016 14017 14018

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

14019
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
14020
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
14021 14022 14023

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
14024
        len = strlen(text);
14025
        VIR_FREE(cmdname);
K
Karel Zak 已提交
14026 14027 14028 14029
    }

    if (!cmd)
        return NULL;
14030

14031 14032 14033
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
14034
    while ((name = cmd->opts[list_index].name)) {
14035
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
14036
        char *res;
14037

K
Karel Zak 已提交
14038
        list_index++;
14039

14040
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
14041 14042
            /* ignore non --option */
            continue;
14043

K
Karel Zak 已提交
14044
        if (len > 2) {
14045
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
14046 14047
                continue;
        }
14048
        res = vshMalloc(NULL, strlen(name) + 3);
14049
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
14050 14051 14052 14053 14054 14055 14056 14057
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
14058 14059 14060
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
14061 14062
    char **matches = (char **) NULL;

14063
    if (start == 0)
K
Karel Zak 已提交
14064
        /* command name generator */
14065
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
14066 14067
    else
        /* commands options */
14068
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
14069 14070 14071 14072
    return matches;
}


14073 14074
static int
vshReadlineInit(vshControl *ctl)
14075
{
14076 14077
    char *userdir = NULL;

K
Karel Zak 已提交
14078 14079 14080 14081 14082
    /* 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;
14083 14084 14085

    /* Limit the total size of the history buffer */
    stifle_history(500);
14086 14087

    /* Prepare to read/write history from/to the ~/.virsh/history file */
14088
    userdir = virGetUserDirectory(getuid());
14089

14090 14091
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
14092
        return -1;
14093
    }
14094 14095 14096

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
14097
        VIR_FREE(userdir);
14098 14099 14100 14101 14102
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
14103
        VIR_FREE(userdir);
14104 14105 14106
        return -1;
    }

14107
    VIR_FREE(userdir);
14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125

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

14126 14127
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
14128 14129
}

14130 14131 14132 14133 14134 14135
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

14136
#else /* !USE_READLINE */
14137

14138 14139 14140 14141 14142 14143 14144
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

14145
static void
14146
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
14147 14148 14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169
{
    /* 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);
}

14170
#endif /* !USE_READLINE */
14171

K
Karel Zak 已提交
14172
/*
J
Jim Meyering 已提交
14173
 * Deinitialize virsh
K
Karel Zak 已提交
14174
 */
E
Eric Blake 已提交
14175
static bool
14176
vshDeinit(vshControl *ctl)
14177
{
14178
    vshReadlineDeinit(ctl);
14179
    vshCloseLogFile(ctl);
14180
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
14181
    if (ctl->conn) {
14182 14183 14184
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
14185 14186
        }
    }
D
Daniel P. Berrange 已提交
14187 14188
    virResetLastError();

E
Eric Blake 已提交
14189
    return true;
K
Karel Zak 已提交
14190
}
14191

K
Karel Zak 已提交
14192 14193 14194 14195
/*
 * Print usage
 */
static void
14196
vshUsage(void)
14197
{
14198
    const vshCmdGrp *grp;
14199
    const vshCmdDef *cmd;
14200

L
Lai Jiangshan 已提交
14201 14202
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
14203 14204 14205
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
14206
                      "    -d | --debug <num>      debug level [0-4]\n"
14207 14208 14209 14210
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
14211
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
14212
                      "    -V | --version=long     version and full options\n\n"
14213
                      "  commands (non interactive mode):\n\n"), progname, progname);
14214

14215 14216
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
14217

14218 14219 14220 14221 14222 14223 14224 14225 14226
        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"));
14227 14228 14229
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
14230 14231
}

14232 14233 14234 14235 14236 14237 14238 14239 14240 14241
/*
 * 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 已提交
14242 14243
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
14244 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
#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 已提交
14279
    vshPrint(ctl, "%s", _(" Networking:"));
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
#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 已提交
14306
    vshPrint(ctl, "%s", _(" Storage:"));
14307 14308 14309 14310 14311 14312 14313 14314 14315 14316 14317 14318 14319 14320 14321 14322 14323 14324 14325 14326 14327 14328 14329
#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 已提交
14330
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
14331
#ifdef WITH_SECDRIVER_APPARMOR
14332 14333 14334 14335 14336 14337 14338 14339 14340 14341 14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354
    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 已提交
14355 14356 14357 14358
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
14359
static bool
14360
vshParseArgv(vshControl *ctl, int argc, char **argv)
14361
{
14362 14363
    bool help = false;
    int arg;
K
Karel Zak 已提交
14364
    struct option opt[] = {
E
Eric Blake 已提交
14365 14366 14367 14368 14369 14370 14371 14372 14373
        {"debug", required_argument, NULL, 'd'},
        {"help", no_argument, NULL, 'h'},
        {"quiet", no_argument, NULL, 'q'},
        {"timing", no_argument, NULL, 't'},
        {"version", optional_argument, NULL, 'v'},
        {"connect", required_argument, NULL, 'c'},
        {"readonly", no_argument, NULL, 'r'},
        {"log", required_argument, NULL, 'l'},
        {NULL, 0, NULL, 0}
14374 14375
    };

14376 14377 14378
    /* 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. */
14379
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
14380
        switch (arg) {
14381
        case 'd':
D
Daniel Veillard 已提交
14382
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
14383
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
14384 14385
                exit(EXIT_FAILURE);
            }
14386 14387
            break;
        case 'h':
14388
            help = true;
14389 14390
            break;
        case 'q':
E
Eric Blake 已提交
14391
            ctl->quiet = true;
14392 14393
            break;
        case 't':
E
Eric Blake 已提交
14394
            ctl->timing = true;
14395 14396 14397 14398
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
14399 14400 14401 14402 14403 14404
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
14405 14406 14407
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
14408
        case 'r':
E
Eric Blake 已提交
14409
            ctl->readonly = true;
14410
            break;
14411 14412 14413
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
14414
        default:
14415 14416
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
14417 14418 14419 14420
        }
    }

    if (help) {
14421 14422
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
14423 14424
            exit(EXIT_FAILURE);
        }
14425 14426 14427

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
14428
        exit(EXIT_SUCCESS);
14429 14430
    }

14431
    if (argc > optind) {
K
Karel Zak 已提交
14432
        /* parse command */
E
Eric Blake 已提交
14433
        ctl->imode = false;
14434
        if (argc - optind == 1) {
14435
            vshDebug(ctl, VSH_ERR_INFO, "commands: \"%s\"\n", argv[optind]);
14436
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
14437
        } else {
14438
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
14439 14440
        }
    }
E
Eric Blake 已提交
14441
    return true;
K
Karel Zak 已提交
14442 14443
}

14444 14445 14446 14447
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
14448
    char *defaultConn;
E
Eric Blake 已提交
14449
    bool ret = true;
K
Karel Zak 已提交
14450

14451 14452 14453
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
J
Jiri Denemark 已提交
14454
    ctl->debug = VSH_DEBUG_DEFAULT;
14455

14456 14457
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
14458
        /* failure to setup locale is not fatal */
14459
    }
14460
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
14461
        perror("bindtextdomain");
E
Eric Blake 已提交
14462
        return EXIT_FAILURE;
14463
    }
14464
    if (!textdomain(PACKAGE)) {
14465
        perror("textdomain");
E
Eric Blake 已提交
14466
        return EXIT_FAILURE;
14467 14468
    }

14469 14470 14471 14472 14473
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

14474
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
14475 14476 14477
        progname = argv[0];
    else
        progname++;
14478

14479
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
14480
        ctl->name = vshStrdup(ctl, defaultConn);
14481 14482
    }

D
Daniel P. Berrange 已提交
14483 14484
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
14485
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
14486
    }
14487

D
Daniel P. Berrange 已提交
14488 14489
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
14490
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
14491
    }
14492

K
Karel Zak 已提交
14493
    if (!ctl->imode) {
14494
        ret = vshCommandRun(ctl, ctl->cmd);
14495
    } else {
K
Karel Zak 已提交
14496 14497
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
14498
            vshPrint(ctl,
14499
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
14500
                     progname);
J
Jim Meyering 已提交
14501
            vshPrint(ctl, "%s",
14502
                     _("Type:  'help' for help with commands\n"
14503
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
14504
        }
14505 14506 14507 14508 14509 14510

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
14511
        do {
14512
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
14513
            ctl->cmdstr =
14514
                vshReadline(ctl, prompt);
14515 14516
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
14517
            if (*ctl->cmdstr) {
14518
#if USE_READLINE
K
Karel Zak 已提交
14519
                add_history(ctl->cmdstr);
14520
#endif
14521
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
14522 14523
                    vshCommandRun(ctl, ctl->cmd);
            }
14524
            VIR_FREE(ctl->cmdstr);
14525
        } while (ctl->imode);
K
Karel Zak 已提交
14526

14527 14528
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
14529
    }
14530

K
Karel Zak 已提交
14531 14532
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
14533
}