virsh.c 398.3 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;

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

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

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

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

/*
 * vshCmdInfo -- information about command
 */
165 166 167
typedef struct {
    const char *name;           /* name of information */
    const char *data;           /* information */
K
Karel Zak 已提交
168 169 170 171 172
} vshCmdInfo;

/*
 * vshCmdOptDef - command option definition
 */
173 174 175 176 177
typedef struct {
    const char *name;           /* the name of option */
    vshCmdOptType type;         /* option type */
    int flag;                   /* flags */
    const char *help;           /* help string */
K
Karel Zak 已提交
178 179 180 181 182 183
} vshCmdOptDef;

/*
 * vshCmdOpt - command options
 */
typedef struct vshCmdOpt {
184
    const vshCmdOptDef *def;    /* pointer to relevant option */
185 186
    char *data;                 /* allocated data */
    struct vshCmdOpt *next;
K
Karel Zak 已提交
187 188
} vshCmdOpt;

189 190 191 192 193 194 195
/*
 * Command Usage Flags
 */
enum {
    VSH_CMD_FLAG_NOCONNECT = (1 << 0),  /* no prior connection needed */
};

K
Karel Zak 已提交
196 197 198
/*
 * vshCmdDef - command definition
 */
199 200
typedef struct {
    const char *name;
E
Eric Blake 已提交
201
    bool (*handler) (vshControl *, const vshCmd *);    /* command handler */
202 203
    const vshCmdOptDef *opts;   /* definition of command options */
    const vshCmdInfo *info;     /* details about command */
204
    int flags;                  /* bitwise OR of VSH_CMD_FLAG */
K
Karel Zak 已提交
205 206 207 208 209 210
} vshCmdDef;

/*
 * vshCmd - parsed command
 */
typedef struct __vshCmd {
211
    const vshCmdDef *def;       /* command definition */
212 213
    vshCmdOpt *opts;            /* list of command arguments */
    struct __vshCmd *next;      /* next command */
K
Karel Zak 已提交
214 215 216 217 218 219
} __vshCmd;

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

239 240 241 242 243
typedef struct vshCmdGrp {
    const char *name;
    const char *keyword; /* help keyword */
    const vshCmdDef *commands;
} vshCmdGrp;
244

245
static const vshCmdGrp cmdGroups[];
K
Karel Zak 已提交
246

247 248
static void vshError(vshControl *ctl, const char *format, ...)
    ATTRIBUTE_FMT_PRINTF(2, 3);
E
Eric Blake 已提交
249 250
static bool vshInit(vshControl *ctl);
static bool vshDeinit(vshControl *ctl);
251
static void vshUsage(void);
252
static void vshOpenLogFile(vshControl *ctl);
253 254
static void vshOutputLogFile(vshControl *ctl, int log_level, const char *format, va_list ap)
    ATTRIBUTE_FMT_PRINTF(3, 0);
255
static void vshCloseLogFile(vshControl *ctl);
K
Karel Zak 已提交
256

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

259
static const char *vshCmddefGetInfo(const vshCmdDef *cmd, const char *info);
260
static const vshCmdDef *vshCmddefSearch(const char *cmdname);
E
Eric Blake 已提交
261
static bool vshCmddefHelp(vshControl *ctl, const char *name);
262
static const vshCmdGrp *vshCmdGrpSearch(const char *grpname);
E
Eric Blake 已提交
263
static bool vshCmdGrpHelp(vshControl *ctl, const char *name);
K
Karel Zak 已提交
264

265
static vshCmdOpt *vshCommandOpt(const vshCmd *cmd, const char *name);
266 267
static int vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
268 269 270
static int vshCommandOptUInt(const vshCmd *cmd, const char *name,
                             unsigned int *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
271 272 273 274 275 276 277 278 279
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;
280 281 282
static int vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                                  unsigned long long *value)
    ATTRIBUTE_NONNULL(3) ATTRIBUTE_RETURN_CHECK;
E
Eric Blake 已提交
283
static bool vshCommandOptBool(const vshCmd *cmd, const char *name);
284 285
static const vshCmdOpt *vshCommandOptArgv(const vshCmd *cmd,
                                          const vshCmdOpt *opt);
K
Karel Zak 已提交
286

287 288 289
#define VSH_BYID     (1 << 1)
#define VSH_BYUUID   (1 << 2)
#define VSH_BYNAME   (1 << 3)
290
#define VSH_BYMAC    (1 << 4)
K
Karel Zak 已提交
291

292
static virDomainPtr vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
293
                                          const char **name, int flag);
K
Karel Zak 已提交
294 295

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

299
static virNetworkPtr vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
300
                                            const char **name, int flag);
301 302

/* default is lookup by Name and UUID */
J
Jim Meyering 已提交
303 304
#define vshCommandOptNetwork(_ctl, _cmd, _name)                    \
    vshCommandOptNetworkBy(_ctl, _cmd, _name,                      \
305 306
                           VSH_BYUUID|VSH_BYNAME)

307
static virNWFilterPtr vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
308
                                                  const char **name, int flag);
309 310 311 312 313 314

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

315
static virInterfacePtr vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
316
                                                const char **name, int flag);
317 318 319 320 321 322

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

323
static virStoragePoolPtr vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd,
324
                            const char *optname, const char **name, int flag);
325 326 327 328 329 330

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

331
static virStorageVolPtr vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
332 333
                                           const char *optname,
                                           const char *pooloptname,
334
                                           const char **name, int flag);
335 336

/* default is lookup by Name and UUID */
337
#define vshCommandOptVol(_ctl, _cmd, _optname, _pooloptname, _name)   \
338 339 340
    vshCommandOptVolBy(_ctl, _cmd, _optname, _pooloptname, _name,     \
                           VSH_BYUUID|VSH_BYNAME)

341
static virSecretPtr vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd,
342
                                        const char **name);
343

344
static void vshPrintExtra(vshControl *ctl, const char *format, ...)
345
    ATTRIBUTE_FMT_PRINTF(2, 3);
346
static void vshDebug(vshControl *ctl, int level, const char *format, ...)
347
    ATTRIBUTE_FMT_PRINTF(3, 4);
K
Karel Zak 已提交
348 349

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

352
static int vshDomainState(vshControl *ctl, virDomainPtr dom, int *reason);
K
Karel Zak 已提交
353
static const char *vshDomainStateToString(int state);
354
static const char *vshDomainStateReasonToString(int state, int reason);
355
static const char *vshDomainControlStateToString(int state);
356
static const char *vshDomainVcpuStateToString(int state);
E
Eric Blake 已提交
357
static bool vshConnectionUsability(vshControl *ctl, virConnectPtr conn);
K
Karel Zak 已提交
358

359 360 361 362
static char *editWriteToTempFile (vshControl *ctl, const char *doc);
static int   editFile (vshControl *ctl, const char *filename);
static char *editReadBackFile (vshControl *ctl, const char *filename);

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

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

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

372
static char *_vshStrdup(vshControl *ctl, const char *s, const char *filename, int line);
373 374
#define vshStrdup(_ctl, _s)    _vshStrdup(_ctl, _s, __FILE__, __LINE__)

E
Eric Blake 已提交
375 376 377 378 379 380 381 382 383 384 385 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
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
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449

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;

450
  /* User visible sort, so we want locale-specific case comparison.  */
451 452 453
  return strcasecmp(*sa, *sb);
}

454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
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 已提交
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
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)
{
501 502 503 504 505 506 507 508
    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)
509
            goto out;
510
    }
J
John Levon 已提交
511 512

    if (last_error->code == VIR_ERR_OK) {
513
        vshError(ctl, "%s", _("unknown error"));
J
John Levon 已提交
514 515 516
        goto out;
    }

517
    vshError(ctl, "%s", last_error->message);
J
John Levon 已提交
518 519 520 521 522 523

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

524 525 526 527 528 529 530 531 532
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;
}

533 534 535 536 537
/*
 * Detection of disconnections and automatic reconnection support
 */
static int disconnected = 0; /* we may have been disconnected */

538 539 540 541 542
/* Gnulib doesn't guarantee SA_SIGINFO support.  */
#ifndef SA_SIGINFO
# define SA_SIGINFO 0
#endif

543 544 545 546 547 548
/*
 * 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
 */
549 550 551 552
static void vshCatchDisconnect(int sig, siginfo_t *siginfo,
                               void *context ATTRIBUTE_UNUSED) {
    if ((sig == SIGPIPE) ||
        (SA_SIGINFO && siginfo->si_signo == SIGPIPE))
553 554 555 556 557 558 559 560 561
        disconnected++;
}

/*
 * vshSetupSignals:
 *
 * Catch SIGPIPE signals which may arise when disconnection
 * from libvirtd occurs
 */
L
Laine Stump 已提交
562
static void
563 564 565 566 567 568 569 570 571 572 573 574 575
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 已提交
576
 * Reconnect after a disconnect from libvirtd
577 578
 *
 */
L
Laine Stump 已提交
579
static void
580 581 582 583 584 585
vshReconnect(vshControl *ctl)
{
    bool connected = false;

    if (ctl->conn != NULL) {
        connected = true;
586
        virConnectClose(ctl->conn);
587
    }
588 589 590 591 592 593

    ctl->conn = virConnectOpenAuth(ctl->name,
                                   virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);
    if (!ctl->conn)
        vshError(ctl, "%s", _("Failed to reconnect to the hypervisor"));
594
    else if (connected)
595 596
        vshError(ctl, "%s", _("Reconnected to the hypervisor"));
    disconnected = 0;
597
    ctl->useGetInfo = false;
598
}
599

K
Karel Zak 已提交
600 601 602 603 604 605
/* ---------------
 * Commands
 * ---------------
 */

/*
606
 * "help" command
K
Karel Zak 已提交
607
 */
608
static const vshCmdInfo info_help[] = {
609
    {"help", N_("print help")},
610 611
    {"desc", N_("Prints global help, command specific help, or help for a\n"
                "    group of related commands")},
612

613
    {NULL, NULL}
K
Karel Zak 已提交
614 615
};

616
static const vshCmdOptDef opts_help[] = {
617
    {"command", VSH_OT_DATA, 0, N_("Prints global help, command specific help, or help for a group of related commands")},
618
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
619 620
};

E
Eric Blake 已提交
621
static bool
622
cmdHelp(vshControl *ctl, const vshCmd *cmd)
623
 {
624
    const char *name = NULL;
625

626
    if (vshCommandOptString(cmd, "command", &name) <= 0) {
627
        const vshCmdGrp *grp;
628
        const vshCmdDef *def;
629

630 631 632 633 634 635 636 637 638 639 640 641 642
        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 已提交
643
        return true;
644
    }
645

E
Eric Blake 已提交
646
    if (vshCmddefSearch(name)) {
647
        return vshCmddefHelp(ctl, name);
E
Eric Blake 已提交
648
    } else if (vshCmdGrpSearch(name)) {
649 650 651
        return vshCmdGrpHelp(ctl, name);
    } else {
        vshError(ctl, _("command or command group '%s' doesn't exist"), name);
E
Eric Blake 已提交
652
        return false;
K
Karel Zak 已提交
653 654 655
    }
}

656 657 658
/*
 * "autostart" command
 */
659
static const vshCmdInfo info_autostart[] = {
660
    {"help", N_("autostart a domain")},
661
    {"desc",
662
     N_("Configure a domain to be automatically started at boot.")},
663 664 665
    {NULL, NULL}
};

666
static const vshCmdOptDef opts_autostart[] = {
667 668
    {"domain",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
669 670 671
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
672
static bool
673
cmdAutostart(vshControl *ctl, const vshCmd *cmd)
674 675
{
    virDomainPtr dom;
676
    const char *name;
677 678
    int autostart;

679
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
680
        return false;
681

J
Jim Meyering 已提交
682
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
683
        return false;
684 685 686 687

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

    if (virDomainSetAutostart(dom, autostart) < 0) {
688
        if (autostart)
689
            vshError(ctl, _("Failed to mark domain %s as autostarted"), name);
690
        else
691
            vshError(ctl, _("Failed to unmark domain %s as autostarted"), name);
692
        virDomainFree(dom);
E
Eric Blake 已提交
693
        return false;
694 695
    }

696
    if (autostart)
697
        vshPrint(ctl, _("Domain %s marked as autostarted\n"), name);
698
    else
699
        vshPrint(ctl, _("Domain %s unmarked as autostarted\n"), name);
700

701
    virDomainFree(dom);
E
Eric Blake 已提交
702
    return true;
703 704
}

K
Karel Zak 已提交
705
/*
706
 * "connect" command
K
Karel Zak 已提交
707
 */
708
static const vshCmdInfo info_connect[] = {
709
    {"help", N_("(re)connect to hypervisor")},
710
    {"desc",
711
     N_("Connect to local hypervisor. This is built-in command after shell start up.")},
712
    {NULL, NULL}
K
Karel Zak 已提交
713 714
};

715
static const vshCmdOptDef opts_connect[] = {
E
Eric Blake 已提交
716 717
    {"name",     VSH_OT_DATA, VSH_OFLAG_EMPTY_OK,
     N_("hypervisor connection URI")},
718
    {"readonly", VSH_OT_BOOL, 0, N_("read-only connection")},
719
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
720 721
};

E
Eric Blake 已提交
722
static bool
723
cmdConnect(vshControl *ctl, const vshCmd *cmd)
724
{
E
Eric Blake 已提交
725
    bool ro = vshCommandOptBool(cmd, "readonly");
726
    const char *name = NULL;
727

K
Karel Zak 已提交
728
    if (ctl->conn) {
729 730 731
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
E
Eric Blake 已提交
732
            return false;
K
Karel Zak 已提交
733 734 735
        }
        ctl->conn = NULL;
    }
736

737
    VIR_FREE(ctl->name);
738 739
    if (vshCommandOptString(cmd, "name", &name) < 0) {
        vshError(ctl, "%s", _("Please specify valid connection URI"));
E
Eric Blake 已提交
740
        return false;
741
    }
742
    ctl->name = vshStrdup(ctl, name);
K
Karel Zak 已提交
743

744
    ctl->useGetInfo = false;
E
Eric Blake 已提交
745
    ctl->readonly = ro;
K
Karel Zak 已提交
746

747 748 749
    ctl->conn = virConnectOpenAuth(ctl->name, virConnectAuthPtrDefault,
                                   ctl->readonly ? VIR_CONNECT_RO : 0);

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

E
Eric Blake 已提交
753
    return !!ctl->conn;
K
Karel Zak 已提交
754 755
}

756 757
#ifndef WIN32

758
/*
759
 * "console" command
760
 */
761
static const vshCmdInfo info_console[] = {
762
    {"help", N_("connect to the guest console")},
763
    {"desc",
764
     N_("Connect the virtual serial console for the guest")},
765 766 767
    {NULL, NULL}
};

768
static const vshCmdOptDef opts_console[] = {
769
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
770
    {"devname", VSH_OT_STRING, 0, N_("character device name")},
771 772 773
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
774
static bool
775
cmdRunConsole(vshControl *ctl, virDomainPtr dom, const char *name)
776
{
E
Eric Blake 已提交
777
    bool ret = false;
778
    int state;
779

780
    if ((state = vshDomainState(ctl, dom, NULL)) < 0) {
781 782 783 784
        vshError(ctl, "%s", _("Unable to get domain status"));
        goto cleanup;
    }

785
    if (state == VIR_DOMAIN_SHUTOFF) {
786 787 788 789
        vshError(ctl, "%s", _("The domain is not running"));
        goto cleanup;
    }

790 791
    vshPrintExtra(ctl, _("Connected to domain %s\n"), virDomainGetName(dom));
    vshPrintExtra(ctl, "%s", _("Escape character is ^]\n"));
792
    if (vshRunConsole(dom, name) == 0)
E
Eric Blake 已提交
793
        ret = true;
794 795

 cleanup:
796

797 798 799
    return ret;
}

E
Eric Blake 已提交
800
static bool
801 802 803
cmdConsole(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
804
    bool ret = false;
805
    const char *name = NULL;
806

807
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
808
        return false;
809 810

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

813 814 815 816
    if (vshCommandOptString(cmd, "devname", &name) < 0) {
        vshError(ctl, "%s", _("Invalid devname"));
        goto cleanup;
    }
817

818
    ret = cmdRunConsole(ctl, dom, name);
819

820
cleanup:
821 822 823 824
    virDomainFree(dom);
    return ret;
}

825 826 827
#endif /* WIN32 */


K
Karel Zak 已提交
828 829 830
/*
 * "list" command
 */
831
static const vshCmdInfo info_list[] = {
832 833
    {"help", N_("list domains")},
    {"desc", N_("Returns list of domains.")},
834
    {NULL, NULL}
K
Karel Zak 已提交
835 836
};

837
static const vshCmdOptDef opts_list[] = {
838 839
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive domains")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active domains")},
840 841 842
    {NULL, 0, 0, NULL}
};

K
Karel Zak 已提交
843

E
Eric Blake 已提交
844
static bool
845
cmdList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
846
{
847 848 849 850
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int *ids = NULL, maxid = 0, i;
851
    char **names = NULL;
852 853
    int maxname = 0;
    inactive |= all;
K
Karel Zak 已提交
854

855
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
856
        return false;
857

858
    if (active) {
859 860
        maxid = virConnectNumOfDomains(ctl->conn);
        if (maxid < 0) {
861
            vshError(ctl, "%s", _("Failed to list active domains"));
E
Eric Blake 已提交
862
            return false;
863 864 865 866 867
        }
        if (maxid) {
            ids = vshMalloc(ctl, sizeof(int) * maxid);

            if ((maxid = virConnectListDomains(ctl->conn, &ids[0], maxid)) < 0) {
868
                vshError(ctl, "%s", _("Failed to list active domains"));
869
                VIR_FREE(ids);
E
Eric Blake 已提交
870
                return false;
871 872
            }

873
            qsort(&ids[0], maxid, sizeof(int), idsorter);
874
        }
875 876
    }
    if (inactive) {
877 878
        maxname = virConnectNumOfDefinedDomains(ctl->conn);
        if (maxname < 0) {
879
            vshError(ctl, "%s", _("Failed to list inactive domains"));
880
            VIR_FREE(ids);
E
Eric Blake 已提交
881
            return false;
882
        }
883 884 885 886
        if (maxname) {
            names = vshMalloc(ctl, sizeof(char *) * maxname);

            if ((maxname = virConnectListDefinedDomains(ctl->conn, names, maxname)) < 0) {
887
                vshError(ctl, "%s", _("Failed to list inactive domains"));
888 889
                VIR_FREE(ids);
                VIR_FREE(names);
E
Eric Blake 已提交
890
                return false;
891
            }
892

893
            qsort(&names[0], maxname, sizeof(char*), namesorter);
894
        }
895
    }
896
    vshPrintExtra(ctl, "%3s %-20s %s\n", _("Id"), _("Name"), _("State"));
K
Karel Zak 已提交
897
    vshPrintExtra(ctl, "----------------------------------\n");
898 899

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

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

K
Karel Zak 已提交
906
        vshPrint(ctl, "%3d %-20s %s\n",
907 908
                 virDomainGetID(dom),
                 virDomainGetName(dom),
909
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
910
        virDomainFree(dom);
K
Karel Zak 已提交
911
    }
912 913 914 915
    for (i = 0; i < maxname; i++) {
        virDomainPtr dom = virDomainLookupByName(ctl->conn, names[i]);

        /* this kind of work with domains is not atomic operation */
916
        if (!dom) {
917
            VIR_FREE(names[i]);
918
            continue;
919
        }
920

921 922 923 924
        vshPrint(ctl, "%3s %-20s %s\n",
                 "-",
                 names[i],
                 vshDomainStateToString(vshDomainState(ctl, dom, NULL)));
925

926
        virDomainFree(dom);
927
        VIR_FREE(names[i]);
928
    }
929 930
    VIR_FREE(ids);
    VIR_FREE(names);
E
Eric Blake 已提交
931
    return true;
K
Karel Zak 已提交
932 933 934
}

/*
K
Karel Zak 已提交
935
 * "domstate" command
K
Karel Zak 已提交
936
 */
937
static const vshCmdInfo info_domstate[] = {
938 939
    {"help", N_("domain state")},
    {"desc", N_("Returns state about a domain.")},
940
    {NULL, NULL}
K
Karel Zak 已提交
941 942
};

943
static const vshCmdOptDef opts_domstate[] = {
944
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
945
    {"reason", VSH_OT_BOOL, 0, N_("also print reason for the state")},
946
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
947 948
};

E
Eric Blake 已提交
949
static bool
950
cmdDomstate(vshControl *ctl, const vshCmd *cmd)
951
{
K
Karel Zak 已提交
952
    virDomainPtr dom;
E
Eric Blake 已提交
953
    bool ret = true;
954 955
    int showReason = vshCommandOptBool(cmd, "reason");
    int state, reason;
956

957
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
958
        return false;
959

J
Jim Meyering 已提交
960
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
961
        return false;
962

963
    if ((state = vshDomainState(ctl, dom, &reason)) < 0) {
E
Eric Blake 已提交
964
        ret = false;
965 966 967 968 969 970 971 972 973 974 975
        goto cleanup;
    }

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

977
cleanup:
978 979 980 981
    virDomainFree(dom);
    return ret;
}

982 983 984 985 986 987 988 989 990 991 992 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
/*
 * "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;
}

1029 1030
/* "domblkstat" command
 */
1031
static const vshCmdInfo info_domblkstat[] = {
1032 1033
    {"help", N_("get device block stats for a domain")},
    {"desc", N_("Get device block stats for a running domain.")},
1034 1035 1036
    {NULL,NULL}
};

1037
static const vshCmdOptDef opts_domblkstat[] = {
1038 1039
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("block device")},
1040 1041 1042
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1043
static bool
1044
cmdDomblkstat (vshControl *ctl, const vshCmd *cmd)
1045 1046
{
    virDomainPtr dom;
1047
    const char *name = NULL, *device = NULL;
1048 1049
    struct _virDomainBlockStats stats;

1050
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1051
        return false;
1052

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

1056
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
L
Laine Stump 已提交
1057
        virDomainFree(dom);
E
Eric Blake 已提交
1058
        return false;
L
Laine Stump 已提交
1059
    }
1060 1061

    if (virDomainBlockStats (dom, device, &stats, sizeof stats) == -1) {
1062
        vshError(ctl, _("Failed to get block stats %s %s"), name, device);
1063
        virDomainFree(dom);
E
Eric Blake 已提交
1064
        return false;
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
    }

    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 已提交
1083
    return true;
1084 1085 1086 1087
}

/* "domifstat" command
 */
1088
static const vshCmdInfo info_domifstat[] = {
1089 1090
    {"help", N_("get network interface stats for a domain")},
    {"desc", N_("Get network interface stats for a running domain.")},
1091 1092 1093
    {NULL,NULL}
};

1094
static const vshCmdOptDef opts_domifstat[] = {
1095 1096
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface device")},
1097 1098 1099
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1100
static bool
1101
cmdDomIfstat (vshControl *ctl, const vshCmd *cmd)
1102 1103
{
    virDomainPtr dom;
1104
    const char *name = NULL, *device = NULL;
1105 1106
    struct _virDomainInterfaceStats stats;

1107
    if (!vshConnectionUsability (ctl, ctl->conn))
E
Eric Blake 已提交
1108
        return false;
1109

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

1113
    if (vshCommandOptString (cmd, "interface", &device) <= 0) {
L
Laine Stump 已提交
1114
        virDomainFree(dom);
E
Eric Blake 已提交
1115
        return false;
L
Laine Stump 已提交
1116
    }
1117 1118

    if (virDomainInterfaceStats (dom, device, &stats, sizeof stats) == -1) {
1119
        vshError(ctl, _("Failed to get interface stats %s %s"), name, device);
1120
        virDomainFree(dom);
E
Eric Blake 已提交
1121
        return false;
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
    }

    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 已提交
1149
    return true;
1150 1151
}

1152 1153 1154
/*
 * "dommemstats" command
 */
1155
static const vshCmdInfo info_dommemstat[] = {
1156 1157
    {"help", N_("get memory statistics for a domain")},
    {"desc", N_("Get memory statistics for a runnng domain.")},
1158 1159 1160
    {NULL,NULL}
};

1161
static const vshCmdOptDef opts_dommemstat[] = {
1162
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1163 1164 1165
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1166
static bool
1167
cmdDomMemStat(vshControl *ctl, const vshCmd *cmd)
1168 1169
{
    virDomainPtr dom;
1170
    const char *name;
1171 1172 1173
    struct _virDomainMemoryStat stats[VIR_DOMAIN_MEMORY_STAT_NR];
    unsigned int nr_stats, i;

1174
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1175
        return false;
1176 1177

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1178
        return false;
1179 1180 1181 1182 1183

    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 已提交
1184
        return false;
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199
    }

    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);
1200 1201
        if (stats[i].tag == VIR_DOMAIN_MEMORY_STAT_ACTUAL_BALLOON)
            vshPrint (ctl, "actual %llu\n", stats[i].val);
1202 1203 1204
    }

    virDomainFree(dom);
E
Eric Blake 已提交
1205
    return true;
1206 1207
}

1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
/*
 * "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 已提交
1223
static bool
1224 1225 1226 1227
cmdDomblkinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainBlockInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
1228
    bool ret = true;
1229
    const char *device = NULL;
1230

1231
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1232
        return false;
1233 1234

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

1237
    if (vshCommandOptString (cmd, "device", &device) <= 0) {
1238
        virDomainFree(dom);
E
Eric Blake 已提交
1239
        return false;
1240 1241 1242 1243
    }

    if (virDomainGetBlockInfo(dom, device, &info, 0) < 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
1244
        return false;
1245 1246 1247 1248 1249 1250 1251 1252 1253 1254
    }

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

1255 1256 1257
/*
 * "suspend" command
 */
1258
static const vshCmdInfo info_suspend[] = {
1259 1260
    {"help", N_("suspend a domain")},
    {"desc", N_("Suspend a running domain.")},
1261
    {NULL, NULL}
1262 1263
};

1264
static const vshCmdOptDef opts_suspend[] = {
1265
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
1266
    {NULL, 0, 0, NULL}
1267 1268
};

E
Eric Blake 已提交
1269
static bool
1270
cmdSuspend(vshControl *ctl, const vshCmd *cmd)
1271
{
1272
    virDomainPtr dom;
1273
    const char *name;
E
Eric Blake 已提交
1274
    bool ret = true;
1275

1276
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1277
        return false;
1278

J
Jim Meyering 已提交
1279
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1280
        return false;
1281 1282

    if (virDomainSuspend(dom) == 0) {
1283
        vshPrint(ctl, _("Domain %s suspended\n"), name);
1284
    } else {
1285
        vshError(ctl, _("Failed to suspend domain %s"), name);
E
Eric Blake 已提交
1286
        ret = false;
1287
    }
1288

1289 1290 1291 1292
    virDomainFree(dom);
    return ret;
}

1293 1294 1295
/*
 * "create" command
 */
1296
static const vshCmdInfo info_create[] = {
1297 1298
    {"help", N_("create a domain from an XML file")},
    {"desc", N_("Create a domain.")},
1299 1300 1301
    {NULL, NULL}
};

1302
static const vshCmdOptDef opts_create[] = {
1303
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1304
#ifndef WIN32
1305
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1306
#endif
1307
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1308
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1309 1310 1311
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1312
static bool
1313
cmdCreate(vshControl *ctl, const vshCmd *cmd)
1314 1315
{
    virDomainPtr dom;
1316
    const char *from = NULL;
E
Eric Blake 已提交
1317
    bool ret = true;
1318
    char *buffer;
1319
#ifndef WIN32
1320
    int console = vshCommandOptBool(cmd, "console");
1321
#endif
1322
    unsigned int flags = VIR_DOMAIN_NONE;
1323

1324
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1325
        return false;
1326

1327
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1328
        return false;
1329

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

1333 1334
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1335 1336
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
1337 1338

    dom = virDomainCreateXML(ctl->conn, buffer, flags);
1339
    VIR_FREE(buffer);
1340

1341
    if (dom != NULL) {
1342
        vshPrint(ctl, _("Domain %s created from %s\n"),
1343
                 virDomainGetName(dom), from);
1344
#ifndef WIN32
1345
        if (console)
1346
            cmdRunConsole(ctl, dom, NULL);
1347
#endif
1348
        virDomainFree(dom);
1349
    } else {
1350
        vshError(ctl, _("Failed to create domain from %s"), from);
E
Eric Blake 已提交
1351
        ret = false;
1352 1353 1354 1355
    }
    return ret;
}

1356 1357 1358
/*
 * "define" command
 */
1359
static const vshCmdInfo info_define[] = {
1360 1361
    {"help", N_("define (but don't start) a domain from an XML file")},
    {"desc", N_("Define a domain.")},
1362 1363 1364
    {NULL, NULL}
};

1365
static const vshCmdOptDef opts_define[] = {
1366
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML domain description")},
1367 1368 1369
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1370
static bool
1371
cmdDefine(vshControl *ctl, const vshCmd *cmd)
1372 1373
{
    virDomainPtr dom;
1374
    const char *from = NULL;
E
Eric Blake 已提交
1375
    bool ret = true;
1376
    char *buffer;
1377

1378
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1379
        return false;
1380

1381
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1382
        return false;
1383

1384
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
1385
        return false;
1386 1387

    dom = virDomainDefineXML(ctl->conn, buffer);
1388
    VIR_FREE(buffer);
1389

1390
    if (dom != NULL) {
1391
        vshPrint(ctl, _("Domain %s defined from %s\n"),
1392
                 virDomainGetName(dom), from);
1393
        virDomainFree(dom);
1394
    } else {
1395
        vshError(ctl, _("Failed to define domain from %s"), from);
E
Eric Blake 已提交
1396
        ret = false;
1397 1398 1399 1400 1401 1402 1403
    }
    return ret;
}

/*
 * "undefine" command
 */
1404
static const vshCmdInfo info_undefine[] = {
1405 1406
    {"help", N_("undefine an inactive domain")},
    {"desc", N_("Undefine the configuration for an inactive domain.")},
1407 1408 1409
    {NULL, NULL}
};

1410
static const vshCmdOptDef opts_undefine[] = {
1411
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
1412 1413 1414
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1415
static bool
1416
cmdUndefine(vshControl *ctl, const vshCmd *cmd)
1417 1418
{
    virDomainPtr dom;
E
Eric Blake 已提交
1419
    bool ret = true;
1420
    const char *name = NULL;
1421
    int id;
1422

1423
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1424
        return false;
1425

1426
    if (vshCommandOptString(cmd, "domain", &name) <= 0)
E
Eric Blake 已提交
1427
        return false;
1428 1429 1430

    if (name && virStrToLong_i(name, NULL, 10, &id) == 0
        && id >= 0 && (dom = virDomainLookupByID(ctl->conn, id))) {
1431 1432 1433 1434 1435
        vshError(ctl,
                 _("a running domain like %s cannot be undefined;\n"
                   "to undefine, first shutdown then undefine"
                   " using its name or UUID"),
                 name);
1436
        virDomainFree(dom);
E
Eric Blake 已提交
1437
        return false;
1438
    }
J
Jim Meyering 已提交
1439
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, &name,
1440
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
1441
        return false;
1442 1443

    if (virDomainUndefine(dom) == 0) {
1444
        vshPrint(ctl, _("Domain %s has been undefined\n"), name);
1445
    } else {
1446
        vshError(ctl, _("Failed to undefine domain %s"), name);
E
Eric Blake 已提交
1447
        ret = false;
1448 1449
    }

1450
    virDomainFree(dom);
1451 1452 1453 1454 1455 1456 1457
    return ret;
}


/*
 * "start" command
 */
1458
static const vshCmdInfo info_start[] = {
1459
    {"help", N_("start a (previously defined) inactive domain")},
1460 1461 1462
    {"desc", N_("Start a domain, either from the last managedsave\n"
                "    state, or via a fresh boot if no managedsave state\n"
                "    is present.")},
1463 1464 1465
    {NULL, NULL}
};

1466
static const vshCmdOptDef opts_start[] = {
1467
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive domain")},
1468
#ifndef WIN32
1469
    {"console", VSH_OT_BOOL, 0, N_("attach to console after creation")},
1470
#endif
E
Eric Blake 已提交
1471
    {"paused", VSH_OT_BOOL, 0, N_("leave the guest paused after creation")},
1472
    {"autodestroy", VSH_OT_BOOL, 0, N_("automatically destroy the guest when virsh disconnects")},
1473 1474 1475
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1476
static bool
1477
cmdStart(vshControl *ctl, const vshCmd *cmd)
1478 1479
{
    virDomainPtr dom;
E
Eric Blake 已提交
1480
    bool ret = true;
1481
#ifndef WIN32
1482
    int console = vshCommandOptBool(cmd, "console");
1483
#endif
E
Eric Blake 已提交
1484
    unsigned int flags = VIR_DOMAIN_NONE;
1485

1486
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1487
        return false;
1488

1489 1490
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
                                      VSH_BYNAME | VSH_BYUUID)))
E
Eric Blake 已提交
1491
        return false;
1492 1493

    if (virDomainGetID(dom) != (unsigned int)-1) {
1494
        vshError(ctl, "%s", _("Domain is already active"));
1495
        virDomainFree(dom);
E
Eric Blake 已提交
1496
        return false;
1497 1498
    }

E
Eric Blake 已提交
1499 1500
    if (vshCommandOptBool(cmd, "paused"))
        flags |= VIR_DOMAIN_START_PAUSED;
1501 1502
    if (vshCommandOptBool(cmd, "autodestroy"))
        flags |= VIR_DOMAIN_START_AUTODESTROY;
E
Eric Blake 已提交
1503 1504 1505 1506

    /* Prefer older API unless we have to pass a flag.  */
    if ((flags ? virDomainCreateWithFlags(dom, flags)
         : virDomainCreate(dom)) == 0) {
1507
        vshPrint(ctl, _("Domain %s started\n"),
1508
                 virDomainGetName(dom));
1509
#ifndef WIN32
1510
        if (console)
1511
            cmdRunConsole(ctl, dom, NULL);
1512
#endif
1513
    } else {
1514
        vshError(ctl, _("Failed to start domain %s"), virDomainGetName(dom));
E
Eric Blake 已提交
1515
        ret = false;
1516
    }
1517
    virDomainFree(dom);
1518 1519 1520
    return ret;
}

1521 1522 1523
/*
 * "save" command
 */
1524
static const vshCmdInfo info_save[] = {
1525
    {"help", N_("save a domain state to a file")},
E
Eric Blake 已提交
1526
    {"desc", N_("Save the RAM state of a running domain.")},
1527
    {NULL, NULL}
1528 1529
};

1530
static const vshCmdOptDef opts_save[] = {
1531 1532
    {"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")},
1533
    {NULL, 0, 0, NULL}
1534 1535
};

E
Eric Blake 已提交
1536
static bool
1537
cmdSave(vshControl *ctl, const vshCmd *cmd)
1538
{
1539
    virDomainPtr dom;
1540 1541
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1542
    bool ret = true;
1543

1544
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1545
        return false;
1546

1547
    if (vshCommandOptString(cmd, "file", &to) <= 0)
E
Eric Blake 已提交
1548
        return false;
1549

J
Jim Meyering 已提交
1550
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1551
        return false;
1552 1553

    if (virDomainSave(dom, to) == 0) {
1554
        vshPrint(ctl, _("Domain %s saved to %s\n"), name, to);
1555
    } else {
1556
        vshError(ctl, _("Failed to save domain %s to %s"), name, to);
E
Eric Blake 已提交
1557
        ret = false;
1558
    }
1559

1560 1561 1562 1563
    virDomainFree(dom);
    return ret;
}

1564 1565 1566 1567 1568
/*
 * "managedsave" command
 */
static const vshCmdInfo info_managedsave[] = {
    {"help", N_("managed save of a domain state")},
1569 1570 1571 1572
    {"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.")},
1573 1574 1575 1576 1577 1578 1579 1580
    {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 已提交
1581
static bool
1582 1583 1584
cmdManagedSave(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1585
    const char *name;
E
Eric Blake 已提交
1586
    bool ret = true;
1587

1588
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1589
        return false;
1590 1591

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1592
        return false;
1593 1594 1595 1596 1597

    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 已提交
1598
        ret = false;
1599 1600 1601 1602 1603 1604
    }

    virDomainFree(dom);
    return ret;
}

1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618
/*
 * "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 已提交
1619
static bool
1620 1621 1622
cmdManagedSaveRemove(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
1623
    const char *name;
E
Eric Blake 已提交
1624
    bool ret = false;
1625 1626
    int hassave;

1627
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1628
        return false;
1629 1630

    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
1631
        return false;
1632 1633 1634

    hassave = virDomainHasManagedSaveImage(dom, 0);
    if (hassave < 0) {
1635
        vshError(ctl, "%s", _("Failed to check for domain managed save image"));
1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651
        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 已提交
1652
    ret = true;
1653 1654 1655 1656 1657 1658

cleanup:
    virDomainFree(dom);
    return ret;
}

1659 1660 1661
/*
 * "schedinfo" command
 */
1662
static const vshCmdInfo info_schedinfo[] = {
1663 1664
    {"help", N_("show/set scheduler parameters")},
    {"desc", N_("Show/Set scheduler parameters.")},
1665 1666 1667
    {NULL, NULL}
};

1668
static const vshCmdOptDef opts_schedinfo[] = {
1669 1670 1671 1672
    {"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")},
1673 1674 1675
    {"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")},
1676 1677 1678
    {NULL, 0, 0, NULL}
};

W
Wen Congyang 已提交
1679
static int
1680
cmdSchedInfoUpdate(vshControl *ctl, const vshCmd *cmd,
1681
                   virTypedParameterPtr param)
1682
{
1683
    const char *data = NULL;
1684 1685 1686

    /* Legacy 'weight' parameter */
    if (STREQ(param->field, "weight") &&
1687
        param->type == VIR_TYPED_PARAM_UINT &&
1688 1689
        vshCommandOptBool(cmd, "weight")) {
        int val;
1690
        if (vshCommandOptInt(cmd, "weight", &val) <= 0) {
1691
            vshError(ctl, "%s", _("Invalid value of weight"));
1692
            return -1;
1693
        } else {
1694
            param->value.ui = val;
1695
        }
1696
        return 1;
1697 1698
    }

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

1713
    if (vshCommandOptString(cmd, "set", &data) > 0) {
1714 1715 1716
        char *val = strchr(data, '=');
        int match = 0;
        if (!val) {
1717
            vshError(ctl, "%s", _("Invalid syntax for --set, expecting name=value"));
1718
            return -1;
1719
        }
1720 1721 1722 1723 1724 1725 1726 1727 1728
        *val = '\0';
        match = STREQ(data, param->field);
        *val = '=';
        val++;

        if (!match)
            return 0;

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

1769 1770
    return 0;
}
1771

1772

E
Eric Blake 已提交
1773
static bool
1774 1775 1776 1777
cmdSchedinfo(vshControl *ctl, const vshCmd *cmd)
{
    char *schedulertype;
    virDomainPtr dom;
1778
    virTypedParameterPtr params = NULL;
1779 1780 1781
    int nparams = 0;
    int update = 0;
    int i, ret;
W
Wen Congyang 已提交
1782
    bool ret_val = false;
1783 1784 1785 1786 1787 1788 1789 1790 1791 1792
    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;
        }
1793
        flags = VIR_DOMAIN_AFFECT_CURRENT;
1794 1795
    } else {
        if (config)
1796
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
1797
        if (live)
1798
            flags |= VIR_DOMAIN_AFFECT_LIVE;
1799
    }
1800

1801
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1802
        return false;
1803

1804
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
1805
        return false;
1806 1807 1808

    /* Print SchedulerType */
    schedulertype = virDomainGetSchedulerType(dom, &nparams);
1809
    if (schedulertype != NULL) {
1810
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"),
1811
             schedulertype);
1812
        VIR_FREE(schedulertype);
1813
    } else {
1814
        vshPrint(ctl, "%-15s: %s\n", _("Scheduler"), _("Unknown"));
1815
        goto cleanup;
1816 1817
    }

1818
    if (nparams) {
1819
        params = vshMalloc(ctl, sizeof(*params) * nparams);
1820

1821
        memset(params, 0, sizeof(*params) * nparams);
1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832
        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);
        }
1833 1834 1835 1836
        if (ret == -1)
            goto cleanup;

        /* See if any params are being set */
1837
        for (i = 0; i < nparams; i++) {
1838 1839 1840 1841 1842 1843 1844 1845 1846 1847
            ret = cmdSchedInfoUpdate(ctl, cmd, &(params[i]));
            if (ret == -1)
                goto cleanup;

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

        /* Update parameters & refresh data */
        if (update) {
1848 1849 1850 1851 1852
            if (flags || current)
                ret = virDomainSetSchedulerParametersFlags(dom, params,
                                                           nparams, flags);
            else
                ret = virDomainSetSchedulerParameters(dom, params, nparams);
1853 1854 1855
            if (ret == -1)
                goto cleanup;

1856 1857 1858 1859 1860 1861 1862
            if (flags || current)
                ret = virDomainGetSchedulerParametersFlags(dom, params,
                                                           &nparams,
                                                           ((live && config) ? 0
                                                            : flags));
            else
                ret = virDomainGetSchedulerParameters(dom, params, &nparams);
1863 1864
            if (ret == -1)
                goto cleanup;
1865 1866 1867 1868
        } 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.  */
1869 1870
            const char *var_value_pair = NULL;
            if (vshCommandOptString(cmd, "set", &var_value_pair) > 0) {
1871 1872 1873 1874
                vshError(ctl, _("invalid scheduler option: %s"),
                         var_value_pair);
                goto cleanup;
            }
1875 1876 1877 1878 1879 1880
            /* 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;
            }
1881 1882
        }

E
Eric Blake 已提交
1883
        ret_val = true;
1884
        for (i = 0; i < nparams; i++) {
1885
            switch (params[i].type) {
1886
            case VIR_TYPED_PARAM_INT:
1887
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.i);
1888
                 break;
1889
            case VIR_TYPED_PARAM_UINT:
1890
                 vshPrint(ctl, "%-15s: %u\n",  params[i].field, params[i].value.ui);
1891
                 break;
1892
            case VIR_TYPED_PARAM_LLONG:
1893
                 vshPrint(ctl, "%-15s: %lld\n",  params[i].field, params[i].value.l);
1894
                 break;
1895
            case VIR_TYPED_PARAM_ULLONG:
1896
                 vshPrint(ctl, "%-15s: %llu\n",  params[i].field, params[i].value.ul);
1897
                 break;
1898
            case VIR_TYPED_PARAM_DOUBLE:
1899
                 vshPrint(ctl, "%-15s: %f\n",  params[i].field, params[i].value.d);
1900
                 break;
1901
            case VIR_TYPED_PARAM_BOOLEAN:
1902
                 vshPrint(ctl, "%-15s: %d\n",  params[i].field, params[i].value.b);
1903 1904
                 break;
            default:
1905
                 vshPrint(ctl, "not implemented scheduler parameter type\n");
1906 1907 1908
            }
        }
    }
1909

1910
 cleanup:
1911
    VIR_FREE(params);
1912
    virDomainFree(dom);
1913
    return ret_val;
1914 1915
}

1916 1917 1918
/*
 * "restore" command
 */
1919
static const vshCmdInfo info_restore[] = {
1920 1921
    {"help", N_("restore a domain from a saved state in a file")},
    {"desc", N_("Restore a domain.")},
1922
    {NULL, NULL}
1923 1924
};

1925
static const vshCmdOptDef opts_restore[] = {
1926
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("the state to restore")},
1927
    {NULL, 0, 0, NULL}
1928 1929
};

E
Eric Blake 已提交
1930
static bool
1931
cmdRestore(vshControl *ctl, const vshCmd *cmd)
1932
{
1933
    const char *from = NULL;
E
Eric Blake 已提交
1934
    bool ret = true;
1935

1936
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1937
        return false;
1938

1939
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
1940
        return false;
1941 1942

    if (virDomainRestore(ctl->conn, from) == 0) {
1943
        vshPrint(ctl, _("Domain restored from %s\n"), from);
1944
    } else {
1945
        vshError(ctl, _("Failed to restore domain from %s"), from);
E
Eric Blake 已提交
1946
        ret = false;
1947 1948 1949 1950
    }
    return ret;
}

D
Daniel Veillard 已提交
1951 1952 1953
/*
 * "dump" command
 */
1954
static const vshCmdInfo info_dump[] = {
1955 1956
    {"help", N_("dump the core of a domain to a file for analysis")},
    {"desc", N_("Core dump a domain.")},
D
Daniel Veillard 已提交
1957 1958 1959
    {NULL, NULL}
};

1960
static const vshCmdOptDef opts_dump[] = {
1961 1962 1963 1964
    {"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 已提交
1965 1966 1967
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
1968
static bool
1969
cmdDump(vshControl *ctl, const vshCmd *cmd)
D
Daniel Veillard 已提交
1970 1971
{
    virDomainPtr dom;
1972 1973
    const char *name = NULL;
    const char *to = NULL;
E
Eric Blake 已提交
1974
    bool ret = true;
1975
    int flags = 0;
D
Daniel Veillard 已提交
1976

1977
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
1978
        return false;
D
Daniel Veillard 已提交
1979

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

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

P
Paolo Bonzini 已提交
1986 1987
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_DUMP_LIVE;
1988 1989 1990 1991
    if (vshCommandOptBool (cmd, "crash"))
        flags |= VIR_DUMP_CRASH;

    if (virDomainCoreDump(dom, to, flags) == 0) {
1992
        vshPrint(ctl, _("Domain %s dumped to %s\n"), name, to);
D
Daniel Veillard 已提交
1993
    } else {
1994
        vshError(ctl, _("Failed to core dump domain %s to %s"), name, to);
E
Eric Blake 已提交
1995
        ret = false;
D
Daniel Veillard 已提交
1996 1997 1998 1999 2000 2001
    }

    virDomainFree(dom);
    return ret;
}

2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148
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;
}

2149 2150 2151
/*
 * "resume" command
 */
2152
static const vshCmdInfo info_resume[] = {
2153 2154
    {"help", N_("resume a domain")},
    {"desc", N_("Resume a previously suspended domain.")},
2155
    {NULL, NULL}
2156 2157
};

2158
static const vshCmdOptDef opts_resume[] = {
2159
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2160
    {NULL, 0, 0, NULL}
2161 2162
};

E
Eric Blake 已提交
2163
static bool
2164
cmdResume(vshControl *ctl, const vshCmd *cmd)
2165
{
2166
    virDomainPtr dom;
E
Eric Blake 已提交
2167
    bool ret = true;
2168
    const char *name;
2169

2170
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2171
        return false;
2172

J
Jim Meyering 已提交
2173
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2174
        return false;
2175 2176

    if (virDomainResume(dom) == 0) {
2177
        vshPrint(ctl, _("Domain %s resumed\n"), name);
2178
    } else {
2179
        vshError(ctl, _("Failed to resume domain %s"), name);
E
Eric Blake 已提交
2180
        ret = false;
2181
    }
2182

2183 2184 2185 2186
    virDomainFree(dom);
    return ret;
}

2187 2188 2189
/*
 * "shutdown" command
 */
2190
static const vshCmdInfo info_shutdown[] = {
2191 2192
    {"help", N_("gracefully shutdown a domain")},
    {"desc", N_("Run shutdown in the target domain.")},
2193
    {NULL, NULL}
2194 2195
};

2196
static const vshCmdOptDef opts_shutdown[] = {
2197
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2198
    {NULL, 0, 0, NULL}
2199 2200
};

E
Eric Blake 已提交
2201
static bool
2202
cmdShutdown(vshControl *ctl, const vshCmd *cmd)
2203
{
2204
    virDomainPtr dom;
E
Eric Blake 已提交
2205
    bool ret = true;
2206
    const char *name;
2207

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

J
Jim Meyering 已提交
2211
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2212
        return false;
2213 2214

    if (virDomainShutdown(dom) == 0) {
2215
        vshPrint(ctl, _("Domain %s is being shutdown\n"), name);
2216
    } else {
2217
        vshError(ctl, _("Failed to shutdown domain %s"), name);
E
Eric Blake 已提交
2218
        ret = false;
2219
    }
2220

2221 2222 2223 2224
    virDomainFree(dom);
    return ret;
}

2225 2226 2227
/*
 * "reboot" command
 */
2228
static const vshCmdInfo info_reboot[] = {
2229 2230
    {"help", N_("reboot a domain")},
    {"desc", N_("Run a reboot command in the target domain.")},
2231 2232 2233
    {NULL, NULL}
};

2234
static const vshCmdOptDef opts_reboot[] = {
2235
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2236 2237 2238
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2239
static bool
2240
cmdReboot(vshControl *ctl, const vshCmd *cmd)
2241 2242
{
    virDomainPtr dom;
E
Eric Blake 已提交
2243
    bool ret = true;
2244
    const char *name;
2245

2246
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2247
        return false;
2248

J
Jim Meyering 已提交
2249
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2250
        return false;
2251 2252

    if (virDomainReboot(dom, 0) == 0) {
2253
        vshPrint(ctl, _("Domain %s is being rebooted\n"), name);
2254
    } else {
2255
        vshError(ctl, _("Failed to reboot domain %s"), name);
E
Eric Blake 已提交
2256
        ret = false;
2257 2258 2259 2260 2261 2262
    }

    virDomainFree(dom);
    return ret;
}

2263 2264 2265
/*
 * "destroy" command
 */
2266
static const vshCmdInfo info_destroy[] = {
2267 2268 2269
    {"help", N_("destroy (stop) a domain")},
    {"desc",
     N_("Forcefully stop a given domain, but leave its resources intact.")},
2270
    {NULL, NULL}
2271 2272
};

2273
static const vshCmdOptDef opts_destroy[] = {
2274
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2275
    {NULL, 0, 0, NULL}
2276 2277
};

E
Eric Blake 已提交
2278
static bool
2279
cmdDestroy(vshControl *ctl, const vshCmd *cmd)
2280
{
2281
    virDomainPtr dom;
E
Eric Blake 已提交
2282
    bool ret = true;
2283
    const char *name;
2284

2285
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2286
        return false;
2287

J
Jim Meyering 已提交
2288
    if (!(dom = vshCommandOptDomain(ctl, cmd, &name)))
E
Eric Blake 已提交
2289
        return false;
2290 2291

    if (virDomainDestroy(dom) == 0) {
2292
        vshPrint(ctl, _("Domain %s destroyed\n"), name);
2293
    } else {
2294
        vshError(ctl, _("Failed to destroy domain %s"), name);
E
Eric Blake 已提交
2295
        ret = false;
2296
    }
2297

2298
    virDomainFree(dom);
K
Karel Zak 已提交
2299 2300 2301 2302
    return ret;
}

/*
2303
 * "dominfo" command
K
Karel Zak 已提交
2304
 */
2305
static const vshCmdInfo info_dominfo[] = {
2306 2307
    {"help", N_("domain information")},
    {"desc", N_("Returns basic information about the domain.")},
2308
    {NULL, NULL}
K
Karel Zak 已提交
2309 2310
};

2311
static const vshCmdOptDef opts_dominfo[] = {
2312
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2313
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
2314 2315
};

E
Eric Blake 已提交
2316
static bool
2317
cmdDominfo(vshControl *ctl, const vshCmd *cmd)
2318
{
K
Karel Zak 已提交
2319 2320
    virDomainInfo info;
    virDomainPtr dom;
2321
    virSecurityModel secmodel;
2322
    virSecurityLabelPtr seclabel;
2323
    int persistent = 0;
E
Eric Blake 已提交
2324 2325
    bool ret = true;
    int autostart;
2326
    unsigned int id;
2327
    char *str, uuid[VIR_UUID_STRING_BUFLEN];
2328

2329
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2330
        return false;
K
Karel Zak 已提交
2331

J
Jim Meyering 已提交
2332
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2333
        return false;
2334

2335 2336
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
2337
        vshPrint(ctl, "%-15s %s\n", _("Id:"), "-");
2338
    else
2339
        vshPrint(ctl, "%-15s %d\n", _("Id:"), id);
2340 2341
    vshPrint(ctl, "%-15s %s\n", _("Name:"), virDomainGetName(dom));

K
Karel Zak 已提交
2342
    if (virDomainGetUUIDString(dom, &uuid[0])==0)
2343
        vshPrint(ctl, "%-15s %s\n", _("UUID:"), uuid);
2344 2345

    if ((str = virDomainGetOSType(dom))) {
2346
        vshPrint(ctl, "%-15s %s\n", _("OS Type:"), str);
2347
        VIR_FREE(str);
2348 2349 2350
    }

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

2354
        vshPrint(ctl, "%-15s %d\n", _("CPU(s):"), info.nrVirtCpu);
2355 2356

        if (info.cpuTime != 0) {
2357
            double cpuUsed = info.cpuTime;
2358

2359
            cpuUsed /= 1000000000.0;
2360

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

2364 2365
        if (info.maxMem != UINT_MAX)
            vshPrint(ctl, "%-15s %lu kB\n", _("Max memory:"),
2366
                 info.maxMem);
2367
        else
2368
            vshPrint(ctl, "%-15s %s\n", _("Max memory:"),
2369 2370
                 _("no limit"));

2371
        vshPrint(ctl, "%-15s %lu kB\n", _("Used memory:"),
2372 2373
                 info.memory);

K
Karel Zak 已提交
2374
    } else {
E
Eric Blake 已提交
2375
        ret = false;
K
Karel Zak 已提交
2376
    }
2377

2378 2379 2380 2381 2382 2383 2384 2385 2386
    /* Check and display whether the domain is persistent or not */
    persistent = virDomainIsPersistent(dom);
    vshDebug(ctl, 5, "Domain persistent flag value: %d\n", persistent);
    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 */
2387
    if (!virDomainGetAutostart(dom, &autostart)) {
2388
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2389 2390 2391
                 autostart ? _("enable") : _("disable") );
    }

2392 2393 2394
    /* Security model and label information */
    memset(&secmodel, 0, sizeof secmodel);
    if (virNodeGetSecurityModel(ctl->conn, &secmodel) == -1) {
2395 2396
        if (last_error->code != VIR_ERR_NO_SUPPORT) {
            virDomainFree(dom);
E
Eric Blake 已提交
2397
            return false;
2398 2399 2400
        } else {
            virFreeError(last_error);
            last_error = NULL;
2401
        }
2402 2403 2404 2405 2406 2407 2408
    } 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 */
2409
            if (VIR_ALLOC(seclabel) < 0) {
2410
                virDomainFree(dom);
E
Eric Blake 已提交
2411
                return false;
2412 2413 2414 2415 2416
            }

            if (virDomainGetSecurityLabel(dom, seclabel) == -1) {
                virDomainFree(dom);
                VIR_FREE(seclabel);
E
Eric Blake 已提交
2417
                return false;
2418
            } else {
2419
                if (seclabel->label[0] != '\0')
2420
                    vshPrint(ctl, "%-15s %s (%s)\n", _("Security label:"),
2421
                             seclabel->label, seclabel->enforcing ? "enforcing" : "permissive");
2422
            }
2423 2424

            VIR_FREE(seclabel);
2425 2426
        }
    }
2427
    virDomainFree(dom);
K
Karel Zak 已提交
2428 2429 2430
    return ret;
}

2431 2432 2433 2434
/*
 * "domjobinfo" command
 */
static const vshCmdInfo info_domjobinfo[] = {
2435 2436
    {"help", N_("domain job information")},
    {"desc", N_("Returns information about jobs running on a domain.")},
2437 2438 2439 2440
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobinfo[] = {
2441
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2442 2443 2444 2445
    {NULL, 0, 0, NULL}
};


E
Eric Blake 已提交
2446
static bool
2447 2448 2449 2450
cmdDomjobinfo(vshControl *ctl, const vshCmd *cmd)
{
    virDomainJobInfo info;
    virDomainPtr dom;
E
Eric Blake 已提交
2451
    bool ret = true;
2452

2453
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2454
        return false;
2455 2456

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2457
        return false;
2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483

    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 已提交
2484
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data processed:"), val, unit);
2485
            val = prettyCapacity(info.dataRemaining, &unit);
E
Eric Blake 已提交
2486
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data remaining:"), val, unit);
2487
            val = prettyCapacity(info.dataTotal, &unit);
E
Eric Blake 已提交
2488
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Data total:"), val, unit);
2489 2490 2491
        }
        if (info.memTotal || info.memRemaining || info.memProcessed) {
            val = prettyCapacity(info.memProcessed, &unit);
E
Eric Blake 已提交
2492
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory processed:"), val, unit);
2493
            val = prettyCapacity(info.memRemaining, &unit);
E
Eric Blake 已提交
2494
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory remaining:"), val, unit);
2495
            val = prettyCapacity(info.memTotal, &unit);
E
Eric Blake 已提交
2496
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("Memory total:"), val, unit);
2497 2498 2499
        }
        if (info.fileTotal || info.fileRemaining || info.fileProcessed) {
            val = prettyCapacity(info.fileProcessed, &unit);
E
Eric Blake 已提交
2500
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File processed:"), val, unit);
2501
            val = prettyCapacity(info.fileRemaining, &unit);
E
Eric Blake 已提交
2502
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File remaining:"), val, unit);
2503
            val = prettyCapacity(info.fileTotal, &unit);
E
Eric Blake 已提交
2504
            vshPrint(ctl, "%-17s %-.3lf %s\n", _("File total:"), val, unit);
2505 2506
        }
    } else {
E
Eric Blake 已提交
2507
        ret = false;
2508 2509 2510 2511 2512 2513
    }
cleanup:
    virDomainFree(dom);
    return ret;
}

2514 2515 2516 2517
/*
 * "domjobabort" command
 */
static const vshCmdInfo info_domjobabort[] = {
2518 2519
    {"help", N_("abort active domain job")},
    {"desc", N_("Aborts the currently running domain job")},
2520 2521 2522 2523
    {NULL, NULL}
};

static const vshCmdOptDef opts_domjobabort[] = {
2524
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2525 2526 2527
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2528
static bool
2529 2530 2531
cmdDomjobabort(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2532
    bool ret = true;
2533

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

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

    if (virDomainAbortJob(dom) < 0)
E
Eric Blake 已提交
2541
        ret = false;
2542 2543 2544 2545 2546

    virDomainFree(dom);
    return ret;
}

2547 2548 2549
/*
 * "freecell" command
 */
2550
static const vshCmdInfo info_freecell[] = {
2551 2552
    {"help", N_("NUMA free memory")},
    {"desc", N_("display available free memory for the NUMA cell.")},
2553 2554 2555
    {NULL, NULL}
};

2556
static const vshCmdOptDef opts_freecell[] = {
2557
    {"cellno", VSH_OT_INT, 0, N_("NUMA cell number")},
2558
    {"all", VSH_OT_BOOL, 0, N_("show free memory for all NUMA cells")},
2559 2560 2561
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2562
static bool
2563
cmdFreecell(vshControl *ctl, const vshCmd *cmd)
2564
{
W
Wen Congyang 已提交
2565
    bool func_ret = false;
2566
    int ret;
2567
    int cell = -1, cell_given;
2568
    unsigned long long memory;
2569 2570 2571 2572
    xmlNodePtr *nodes = NULL;
    unsigned long nodes_cnt;
    unsigned long *nodes_id = NULL;
    unsigned long long *nodes_free = NULL;
2573
    int all_given;
2574 2575 2576 2577
    int i;
    char *cap_xml = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
2578

2579

2580
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2581
        return false;
2582

2583 2584 2585 2586
    if ( (cell_given = vshCommandOptInt(cmd, "cellno", &cell)) < 0) {
        vshError(ctl, "%s", _("cell number has to be a number"));
        goto cleanup;
    }
2587 2588 2589 2590 2591 2592 2593 2594 2595
    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) {
2596 2597 2598
        cap_xml = virConnectGetCapabilities(ctl->conn);
        if (!cap_xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2599 2600 2601
            goto cleanup;
        }

2602 2603 2604
        xml = xmlReadDoc((const xmlChar *) cap_xml, "node.xml", NULL,
                          XML_PARSE_NOENT | XML_PARSE_NONET |
                          XML_PARSE_NOWARNING);
2605

2606 2607
        if (!xml) {
            vshError(ctl, "%s", _("unable to get node capabilities"));
2608 2609 2610
            goto cleanup;
        }

2611 2612 2613 2614 2615
        ctxt = xmlXPathNewContext(xml);
        nodes_cnt = virXPathNodeSet("/capabilities/host/topology/cells/cell",
                                    ctxt, &nodes);

        if (nodes_cnt == -1) {
2616
            vshError(ctl, "%s", _("could not get information about "
2617
                                  "NUMA topology"));
2618 2619 2620
            goto cleanup;
        }

2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641
        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;
            }
        }

2642
        memory = 0;
2643 2644 2645 2646
        for (cell = 0; cell < nodes_cnt; cell++) {
            vshPrint(ctl, "%5lu: %10llu kB\n", nodes_id[cell],
                    (nodes_free[cell]/1024));
            memory += nodes_free[cell];
2647 2648 2649 2650
        }

        vshPrintExtra(ctl, "--------------------\n");
        vshPrintExtra(ctl, "%5s: %10llu kB\n", _("Total"), memory/1024);
2651
    } else {
2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665
        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));
2666 2667
    }

E
Eric Blake 已提交
2668
    func_ret = true;
2669

2670
cleanup:
2671 2672 2673
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
2674
    VIR_FREE(nodes);
2675 2676 2677
    VIR_FREE(nodes_free);
    VIR_FREE(nodes_id);
    VIR_FREE(cap_xml);
2678
    return func_ret;
2679 2680
}

E
Eric Blake 已提交
2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694
/*
 * "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 已提交
2695
static bool
E
Eric Blake 已提交
2696 2697
cmdMaxvcpus(vshControl *ctl, const vshCmd *cmd)
{
2698
    const char *type = NULL;
E
Eric Blake 已提交
2699 2700
    int vcpus;

2701 2702
    if (vshCommandOptString(cmd, "type", &type) < 0) {
        vshError(ctl, "%s", _("Invalid type"));
E
Eric Blake 已提交
2703
        return false;
2704
    }
E
Eric Blake 已提交
2705 2706

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

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

E
Eric Blake 已提交
2714
    return true;
E
Eric Blake 已提交
2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734
}

/*
 * "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 已提交
2735
static bool
E
Eric Blake 已提交
2736 2737 2738
cmdVcpucount(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
E
Eric Blake 已提交
2739
    bool ret = true;
E
Eric Blake 已提交
2740 2741 2742 2743 2744 2745 2746 2747 2748 2749
    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 已提交
2750
        return false;
E
Eric Blake 已提交
2751 2752 2753 2754
    }
    if (config && live) {
        vshError(ctl, "%s",
                 _("--config and --live cannot both be specified"));
E
Eric Blake 已提交
2755
        return false;
E
Eric Blake 已提交
2756 2757 2758 2759 2760 2761 2762 2763 2764 2765
    }
    /* 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 已提交
2766
        return false;
E
Eric Blake 已提交
2767 2768 2769
    }

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
2770
        return false;
E
Eric Blake 已提交
2771 2772

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2773
        return false;
E
Eric Blake 已提交
2774 2775 2776 2777 2778 2779

    /* 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 |
2780
                                             VIR_DOMAIN_AFFECT_CONFIG));
E
Eric Blake 已提交
2781 2782 2783 2784 2785 2786 2787 2788 2789
        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;
            }
2790 2791
            virFreeError(last_error);
            last_error = NULL;
E
Eric Blake 已提交
2792 2793 2794 2795 2796
            VIR_FREE(xml);
        }

        if (count < 0) {
            virshReportError(ctl);
E
Eric Blake 已提交
2797
            ret = false;
E
Eric Blake 已提交
2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809
        } 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 |
2810
                                             VIR_DOMAIN_AFFECT_LIVE));
E
Eric Blake 已提交
2811 2812 2813 2814 2815 2816 2817
        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 已提交
2818
            ret = false;
E
Eric Blake 已提交
2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829
        } 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)) {
2830
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_CONFIG);
E
Eric Blake 已提交
2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854
        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 已提交
2855
            ret = false;
E
Eric Blake 已提交
2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866
        } 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)) {
2867
        count = virDomainGetVcpusFlags(dom, VIR_DOMAIN_AFFECT_LIVE);
E
Eric Blake 已提交
2868 2869 2870 2871 2872 2873 2874 2875 2876
        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 已提交
2877
            ret = false;
E
Eric Blake 已提交
2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891
        } 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;
}

2892 2893 2894
/*
 * "vcpuinfo" command
 */
2895
static const vshCmdInfo info_vcpuinfo[] = {
E
Eric Blake 已提交
2896
    {"help", N_("detailed domain vcpu information")},
2897
    {"desc", N_("Returns basic information about the domain virtual CPUs.")},
2898 2899 2900
    {NULL, NULL}
};

2901
static const vshCmdOptDef opts_vcpuinfo[] = {
2902
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
2903 2904 2905
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
2906
static bool
2907
cmdVcpuinfo(vshControl *ctl, const vshCmd *cmd)
2908 2909 2910 2911 2912
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
    virVcpuInfoPtr cpuinfo;
2913 2914
    unsigned char *cpumaps;
    int ncpus, maxcpu;
2915
    size_t cpumaplen;
E
Eric Blake 已提交
2916
    bool ret = true;
2917
    int n, m;
2918

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

J
Jim Meyering 已提交
2922
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
2923
        return false;
2924 2925 2926

    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2927
        return false;
2928 2929 2930 2931
    }

    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
2932
        return false;
2933 2934
    }

2935
    cpuinfo = vshMalloc(ctl, sizeof(virVcpuInfo)*info.nrVirtCpu);
2936 2937 2938
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
    cpumaps = vshMalloc(ctl, info.nrVirtCpu * cpumaplen);
2939

2940 2941
    if ((ncpus = virDomainGetVcpus(dom,
                                   cpuinfo, info.nrVirtCpu,
2942
                                   cpumaps, cpumaplen)) >= 0) {
2943 2944 2945 2946
        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 已提交
2947
                     _(vshDomainVcpuStateToString(cpuinfo[n].state)));
2948 2949 2950 2951 2952 2953 2954 2955
            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:"));
2956 2957
            for (m = 0; m < maxcpu; m++) {
                vshPrint(ctl, "%c", VIR_CPU_USABLE(cpumaps, cpumaplen, n, m) ? 'y' : '-');
2958 2959 2960 2961 2962 2963
            }
            vshPrint(ctl, "\n");
            if (n < (ncpus - 1)) {
                vshPrint(ctl, "\n");
            }
        }
2964
    } else {
2965
        if (info.state == VIR_DOMAIN_SHUTOFF &&
E
Eric Blake 已提交
2966
            (ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
2967 2968 2969
                                             cpumaps, cpumaplen,
                                             VIR_DOMAIN_AFFECT_CONFIG)) >= 0) {

E
Eric Blake 已提交
2970
            /* fallback plan to use virDomainGetVcpuPinInfo */
2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988

            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;
2989
        }
2990 2991
    }

2992
    VIR_FREE(cpumaps);
2993
    VIR_FREE(cpuinfo);
2994 2995 2996 2997 2998 2999 3000
    virDomainFree(dom);
    return ret;
}

/*
 * "vcpupin" command
 */
3001
static const vshCmdInfo info_vcpupin[] = {
3002
    {"help", N_("control or query domain vcpu affinity")},
3003
    {"desc", N_("Pin domain VCPUs to host physical CPUs.")},
3004 3005 3006
    {NULL, NULL}
};

3007
static const vshCmdOptDef opts_vcpupin[] = {
3008
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3009 3010 3011
    {"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")},
3012 3013 3014
    {"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")},
3015 3016 3017
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3018
static bool
E
Eric Blake 已提交
3019
cmdVcpuPin(vshControl *ctl, const vshCmd *cmd)
3020 3021 3022 3023
{
    virDomainInfo info;
    virDomainPtr dom;
    virNodeInfo nodeinfo;
3024
    int vcpu = -1;
3025
    const char *cpulist = NULL;
E
Eric Blake 已提交
3026
    bool ret = true;
3027 3028
    unsigned char *cpumap = NULL;
    unsigned char *cpumaps = NULL;
E
Eric Blake 已提交
3029
    size_t cpumaplen;
3030 3031
    bool bit, lastbit, isInvert;
    int i, cpu, lastcpu, maxcpu, ncpus;
3032
    bool unuse = false;
3033
    const char *cur;
3034 3035 3036
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int current = vshCommandOptBool(cmd, "current");
3037
    bool query = false; /* Query mode if no cpulist */
3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054
    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;
    }
3055

3056
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3057
        return false;
3058

J
Jim Meyering 已提交
3059
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3060
        return false;
3061

3062 3063
    if (vshCommandOptString(cmd, "cpulist", &cpulist) < 0) {
        vshError(ctl, "%s", _("vcpupin: Missing cpulist."));
3064
        virDomainFree(dom);
E
Eric Blake 已提交
3065
        return false;
3066
    }
3067
    query = !cpulist;
3068

3069 3070 3071 3072
    /* In query mode, "vcpu" is optional */
    if (vshCommandOptInt(cmd, "vcpu", &vcpu) < !query) {
        vshError(ctl, "%s",
                 _("vcpupin: Invalid or missing vCPU number."));
3073
        virDomainFree(dom);
E
Eric Blake 已提交
3074
        return false;
3075
    }
3076

3077 3078
    if (virNodeGetInfo(ctl->conn, &nodeinfo) != 0) {
        virDomainFree(dom);
E
Eric Blake 已提交
3079
        return false;
3080 3081 3082
    }

    if (virDomainGetInfo(dom, &info) != 0) {
3083
        vshError(ctl, "%s", _("vcpupin: failed to get domain information."));
3084
        virDomainFree(dom);
E
Eric Blake 已提交
3085
        return false;
3086 3087 3088
    }

    if (vcpu >= info.nrVirtCpu) {
3089
        vshError(ctl, "%s", _("vcpupin: Invalid vCPU number."));
3090
        virDomainFree(dom);
E
Eric Blake 已提交
3091
        return false;
3092 3093
    }

3094 3095
    maxcpu = VIR_NODEINFO_MAXCPUS(nodeinfo);
    cpumaplen = VIR_CPU_MAPLEN(maxcpu);
3096

3097 3098 3099 3100 3101 3102 3103 3104
    /* 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 已提交
3105
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150
                                             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);
3151 3152
    /* Parse cpulist */
    cur = cpulist;
3153
    if (*cur == 0) {
3154
        goto parse_error;
3155 3156 3157
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
3158
        cur = "";
3159
    }
3160 3161 3162 3163 3164 3165 3166

    while (*cur != 0) {

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

3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180
        /* 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);
3181

3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208
        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);
        }
3209

3210 3211 3212 3213 3214 3215
        if (*cur == ',') {
            cur++;
            virSkipSpaces(&cur);
            unuse = false;
        } else if (*cur == 0) {
            break;
3216
        } else {
3217
            goto parse_error;
3218
        }
3219
    }
3220

3221 3222 3223 3224 3225 3226 3227 3228
    if (flags == -1) {
        if (virDomainPinVcpu(dom, vcpu, cpumap, cpumaplen) != 0) {
            ret = false;
        }
    } else {
        if (virDomainPinVcpuFlags(dom, vcpu, cpumap, cpumaplen, flags) != 0) {
            ret = false;
        }
3229 3230
    }

3231
cleanup:
3232
    VIR_FREE(cpumap);
3233 3234
    virDomainFree(dom);
    return ret;
3235 3236 3237 3238 3239

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

3242 3243 3244
/*
 * "setvcpus" command
 */
3245
static const vshCmdInfo info_setvcpus[] = {
3246 3247
    {"help", N_("change number of virtual CPUs")},
    {"desc", N_("Change the number of virtual CPUs in the guest domain.")},
3248 3249 3250
    {NULL, NULL}
};

3251
static const vshCmdOptDef opts_setvcpus[] = {
3252
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3253
    {"count", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of virtual CPUs")},
E
Eric Blake 已提交
3254 3255 3256
    {"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")},
3257 3258 3259
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3260
static bool
3261
cmdSetvcpus(vshControl *ctl, const vshCmd *cmd)
3262 3263
{
    virDomainPtr dom;
3264
    int count = 0;
E
Eric Blake 已提交
3265
    bool ret = true;
E
Eric Blake 已提交
3266 3267 3268 3269
    int maximum = vshCommandOptBool(cmd, "maximum");
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
    int flags = ((maximum ? VIR_DOMAIN_VCPU_MAXIMUM : 0) |
3270 3271
                 (config ? VIR_DOMAIN_AFFECT_CONFIG : 0) |
                 (live ? VIR_DOMAIN_AFFECT_LIVE : 0));
3272

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

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

3279 3280 3281 3282
    if (vshCommandOptInt(cmd, "count", &count) < 0) {
        vshError(ctl, "%s", _("Invalid number of virtual CPUs"));
        goto cleanup;
    }
3283

E
Eric Blake 已提交
3284 3285
    if (!flags) {
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
3286
            ret = false;
E
Eric Blake 已提交
3287 3288
        }
    } else {
3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301
        /* If the --maximum flag was given, we need to ensure only the
           --config flag is in effect as well */
        if (maximum) {
            vshDebug(ctl, 5, "--maximum flag was given\n");

            /* 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 已提交
3302
                ret = false;
3303 3304 3305 3306 3307
                goto cleanup;
            }
        }

        /* Apply the virtual cpu changes */
E
Eric Blake 已提交
3308
        if (virDomainSetVcpusFlags(dom, count, flags) < 0) {
E
Eric Blake 已提交
3309
            ret = false;
E
Eric Blake 已提交
3310
        }
3311 3312
    }

3313
  cleanup:
3314 3315 3316 3317
    virDomainFree(dom);
    return ret;
}

3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351
/*
 * "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;
}

3352 3353 3354
/*
 * "setmemory" command
 */
3355
static const vshCmdInfo info_setmem[] = {
3356 3357
    {"help", N_("change memory allocation")},
    {"desc", N_("Change the current memory allocation in the guest domain.")},
3358 3359 3360
    {NULL, NULL}
};

3361
static const vshCmdOptDef opts_setmem[] = {
3362
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3363
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("number of kilobytes of memory")},
3364 3365
    {"config", VSH_OT_BOOL, 0, N_("affect next boot")},
    {"live", VSH_OT_BOOL, 0, N_("affect running domain")},
3366
    {"current", VSH_OT_BOOL, 0, N_("affect current domain")},
3367 3368 3369
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3370
static bool
3371
cmdSetmem(vshControl *ctl, const vshCmd *cmd)
3372 3373
{
    virDomainPtr dom;
3374
    virDomainInfo info;
3375
    unsigned long kilobytes = 0;
E
Eric Blake 已提交
3376
    bool ret = true;
3377 3378
    int config = vshCommandOptBool(cmd, "config");
    int live = vshCommandOptBool(cmd, "live");
3379
    int current = vshCommandOptBool(cmd, "current");
3380 3381
    int flags = 0;

3382 3383 3384
    if (current) {
        if (live || config) {
            vshError(ctl, "%s", _("--current must be specified exclusively"));
E
Eric Blake 已提交
3385
            return false;
3386
        }
3387
        flags = VIR_DOMAIN_AFFECT_CURRENT;
3388 3389
    } else {
        if (config)
3390
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3391
        if (live)
3392
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3393 3394 3395
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
3396
    }
3397

3398
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3399
        return false;
3400

J
Jim Meyering 已提交
3401
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3402
        return false;
3403

3404 3405
    if (vshCommandOptUL(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3406
        return false;
3407 3408
    }

3409
    if (kilobytes <= 0) {
3410
        virDomainFree(dom);
3411
        vshError(ctl, _("Invalid value of %lu for memory size"), kilobytes);
E
Eric Blake 已提交
3412
        return false;
3413 3414
    }

3415 3416
    if (virDomainGetInfo(dom, &info) != 0) {
        virDomainFree(dom);
3417
        vshError(ctl, "%s", _("Unable to verify MaxMemorySize"));
E
Eric Blake 已提交
3418
        return false;
3419 3420 3421 3422
    }

    if (kilobytes > info.maxMem) {
        virDomainFree(dom);
3423
        vshError(ctl, _("Requested memory size %lu kb is larger than maximum of %lu kb"),
3424
                 kilobytes, info.maxMem);
E
Eric Blake 已提交
3425
        return false;
3426 3427
    }

3428
    if (flags == -1) {
3429
        if (virDomainSetMemory(dom, kilobytes) != 0) {
E
Eric Blake 已提交
3430
            ret = false;
3431 3432 3433
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
E
Eric Blake 已提交
3434
            ret = false;
3435
        }
3436 3437 3438 3439 3440 3441 3442 3443 3444
    }

    virDomainFree(dom);
    return ret;
}

/*
 * "setmaxmem" command
 */
3445
static const vshCmdInfo info_setmaxmem[] = {
3446 3447
    {"help", N_("change maximum memory limit")},
    {"desc", N_("Change the maximum memory allocation limit in the guest domain.")},
3448 3449 3450
    {NULL, NULL}
};

3451
static const vshCmdOptDef opts_setmaxmem[] = {
3452
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
3453
    {"kilobytes", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum memory limit in kilobytes")},
3454 3455 3456
    {"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")},
3457 3458 3459
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3460
static bool
3461
cmdSetmaxmem(vshControl *ctl, const vshCmd *cmd)
3462 3463
{
    virDomainPtr dom;
3464
    int kilobytes = 0;
E
Eric Blake 已提交
3465
    bool ret = true;
3466 3467 3468 3469 3470 3471 3472 3473
    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 已提交
3474
            return false;
3475 3476 3477
        }
    } else {
        if (config)
3478
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3479
        if (live)
3480
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3481 3482 3483 3484
        /* neither option is specified */
        if (!live && !config)
            flags = -1;
    }
3485

3486
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3487
        return false;
3488

J
Jim Meyering 已提交
3489
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3490
        return false;
3491

3492 3493
    if (vshCommandOptInt(cmd, "kilobytes", &kilobytes) < 0) {
        vshError(ctl, "%s", _("memory size has to be a number"));
E
Eric Blake 已提交
3494
        return false;
3495 3496
    }

3497
    if (kilobytes <= 0) {
3498
        virDomainFree(dom);
3499
        vshError(ctl, _("Invalid value of %d for memory size"), kilobytes);
E
Eric Blake 已提交
3500
        return false;
3501 3502
    }

3503 3504 3505
    if (flags == -1) {
        if (virDomainSetMaxMemory(dom, kilobytes) != 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3506
            ret = false;
3507 3508 3509 3510
        }
    } else {
        if (virDomainSetMemoryFlags(dom, kilobytes, flags) < 0) {
            vshError(ctl, "%s", _("Unable to change MaxMemorySize"));
E
Eric Blake 已提交
3511
            ret = false;
3512
        }
3513 3514
    }

3515 3516 3517 3518
    virDomainFree(dom);
    return ret;
}

3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534
/*
 * "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 已提交
3535 3536 3537
    {"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")},
3538 3539 3540
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3541
static bool
3542 3543 3544 3545 3546 3547
cmdBlkiotune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
    int weight = 0;
    int nparams = 0;
    unsigned int i = 0;
3548
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3549
    bool ret = false;
H
Hu Tao 已提交
3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566
    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;
    }
3567 3568

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3569
        return false;
3570 3571

    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
3572
        return false;
3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590

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

    if (weight) {
        nparams++;
        if (weight < 0) {
            virDomainFree(dom);
            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 已提交
3591
        if (virDomainGetBlkioParameters(dom, NULL, &nparams, flags) != 0) {
3592 3593 3594 3595 3596 3597 3598
            vshError(ctl, "%s",
                     _("Unable to get number of blkio parameters"));
            goto cleanup;
        }

        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3599
            ret = true;
3600 3601 3602 3603 3604
            goto cleanup;
        }

        /* now go get all the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));
H
Hu Tao 已提交
3605
        if (virDomainGetBlkioParameters(dom, params, &nparams, flags) != 0) {
3606 3607 3608 3609 3610 3611
            vshError(ctl, "%s", _("Unable to get blkio parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
3612
                case VIR_TYPED_PARAM_INT:
3613 3614 3615
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
3616
                case VIR_TYPED_PARAM_UINT:
3617 3618 3619
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
3620
                case VIR_TYPED_PARAM_LLONG:
3621 3622 3623
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
3624
                case VIR_TYPED_PARAM_ULLONG:
3625 3626 3627
                    vshPrint(ctl, "%-15s: %llu\n", params[i].field,
                                 params[i].value.ul);
                    break;
3628
                case VIR_TYPED_PARAM_DOUBLE:
3629 3630 3631
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
3632
                case VIR_TYPED_PARAM_BOOLEAN:
3633 3634 3635 3636 3637 3638 3639 3640
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
                    vshPrint(ctl, "unimplemented blkio parameter type\n");
            }
        }

E
Eric Blake 已提交
3641
        ret = true;
3642 3643 3644 3645 3646 3647
    } else {
        /* set the blkio parameters */
        params = vshCalloc(ctl, nparams, sizeof(*params));

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
3648
            temp->type = VIR_TYPED_PARAM_UINT;
3649 3650 3651 3652 3653 3654 3655 3656

            if (weight) {
                temp->value.ui = weight;
                strncpy(temp->field, VIR_DOMAIN_BLKIO_WEIGHT,
                        sizeof(temp->field));
                weight = 0;
            }
        }
H
Hu Tao 已提交
3657
        if (virDomainSetBlkioParameters(dom, params, nparams, flags) != 0)
3658 3659
            vshError(ctl, "%s", _("Unable to change blkio parameters"));
        else
E
Eric Blake 已提交
3660
            ret = true;
3661 3662 3663 3664 3665 3666 3667 3668
    }

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

3669 3670 3671 3672
/*
 * "memtune" command
 */
static const vshCmdInfo info_memtune[] = {
3673 3674 3675
    {"help", N_("Get or set memory parameters")},
    {"desc", N_("Get or set the current memory parameters for a guest" \
                " domain.\n" \
3676 3677 3678 3679 3680 3681 3682
                "    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")},
3683
    {"hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3684
     N_("Max memory in kilobytes")},
3685
    {"soft-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3686
     N_("Memory during contention in kilobytes")},
3687
    {"swap-hard-limit", VSH_OT_INT, VSH_OFLAG_NONE,
3688
     N_("Max memory plus swap in kilobytes")},
3689
    {"min-guarantee", VSH_OT_INT, VSH_OFLAG_NONE,
3690
     N_("Min guaranteed memory in kilobytes")},
3691 3692 3693
    {"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")},
3694 3695 3696
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
3697
static bool
3698 3699 3700
cmdMemtune(vshControl * ctl, const vshCmd * cmd)
{
    virDomainPtr dom;
3701 3702
    long long hard_limit = 0, soft_limit = 0, swap_hard_limit = 0;
    long long min_guarantee = 0;
3703 3704
    int nparams = 0;
    unsigned int i = 0;
3705
    virTypedParameterPtr params = NULL, temp = NULL;
E
Eric Blake 已提交
3706
    bool ret = false;
3707 3708 3709 3710 3711 3712 3713 3714 3715 3716
    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;
        }
3717
        flags = VIR_DOMAIN_AFFECT_CURRENT;
3718 3719
    } else {
        if (config)
3720
            flags |= VIR_DOMAIN_AFFECT_CONFIG;
3721
        if (live)
3722
            flags |= VIR_DOMAIN_AFFECT_LIVE;
3723
    }
3724 3725

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3726
        return false;
3727 3728

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

3731 3732 3733 3734 3735 3736 3737 3738 3739
    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;
    }

3740 3741 3742 3743 3744 3745 3746 3747 3748
    if (hard_limit)
        nparams++;

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

3749 3750 3751
    if (min_guarantee)
        nparams++;

3752 3753
    if (nparams == 0) {
        /* get the number of memory parameters */
3754
        if (virDomainGetMemoryParameters(dom, NULL, &nparams, flags) != 0) {
3755 3756 3757 3758 3759
            vshError(ctl, "%s",
                     _("Unable to get number of memory parameters"));
            goto cleanup;
        }

3760 3761
        if (nparams == 0) {
            /* nothing to output */
E
Eric Blake 已提交
3762
            ret = true;
3763 3764 3765
            goto cleanup;
        }

3766
        /* now go get all the memory parameters */
E
Eric Blake 已提交
3767
        params = vshCalloc(ctl, nparams, sizeof(*params));
3768
        if (virDomainGetMemoryParameters(dom, params, &nparams, flags) != 0) {
3769 3770 3771 3772 3773 3774
            vshError(ctl, "%s", _("Unable to get memory parameters"));
            goto cleanup;
        }

        for (i = 0; i < nparams; i++) {
            switch (params[i].type) {
3775
                case VIR_TYPED_PARAM_INT:
3776 3777 3778
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.i);
                    break;
3779
                case VIR_TYPED_PARAM_UINT:
3780 3781 3782
                    vshPrint(ctl, "%-15s: %u\n", params[i].field,
                             params[i].value.ui);
                    break;
3783
                case VIR_TYPED_PARAM_LLONG:
3784 3785 3786
                    vshPrint(ctl, "%-15s: %lld\n", params[i].field,
                             params[i].value.l);
                    break;
3787
                case VIR_TYPED_PARAM_ULLONG:
3788 3789 3790 3791 3792
                    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);
3793
                    break;
3794
                case VIR_TYPED_PARAM_DOUBLE:
3795 3796 3797
                    vshPrint(ctl, "%-15s: %f\n", params[i].field,
                             params[i].value.d);
                    break;
3798
                case VIR_TYPED_PARAM_BOOLEAN:
3799 3800 3801 3802
                    vshPrint(ctl, "%-15s: %d\n", params[i].field,
                             params[i].value.b);
                    break;
                default:
3803
                    vshPrint(ctl, "unimplemented memory parameter type\n");
3804 3805 3806
            }
        }

E
Eric Blake 已提交
3807
        ret = true;
3808 3809
    } else {
        /* set the memory parameters */
E
Eric Blake 已提交
3810
        params = vshCalloc(ctl, nparams, sizeof(*params));
3811 3812 3813

        for (i = 0; i < nparams; i++) {
            temp = &params[i];
3814
            temp->type = VIR_TYPED_PARAM_ULLONG;
3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833

            /*
             * 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;
3834
                strncpy(temp->field, VIR_DOMAIN_MEMORY_SWAP_HARD_LIMIT,
3835 3836
                        sizeof(temp->field));
                swap_hard_limit = 0;
3837 3838 3839 3840 3841
            } else if (min_guarantee) {
                temp->value.ul = min_guarantee;
                strncpy(temp->field, VIR_DOMAIN_MEMORY_MIN_GUARANTEE,
                        sizeof(temp->field));
                min_guarantee = 0;
3842
            }
3843 3844 3845 3846

            /* If the user has passed -1, we interpret it as unlimited */
            if (temp->value.ul == -1)
                temp->value.ul = VIR_DOMAIN_MEMORY_PARAM_UNLIMITED;
3847
        }
3848
        if (virDomainSetMemoryParameters(dom, params, nparams, flags) != 0)
3849
            vshError(ctl, "%s", _("Unable to change memory parameters"));
3850
        else
E
Eric Blake 已提交
3851
            ret = true;
3852 3853 3854
    }

  cleanup:
E
Eric Blake 已提交
3855
    VIR_FREE(params);
3856 3857 3858 3859
    virDomainFree(dom);
    return ret;
}

3860 3861 3862
/*
 * "nodeinfo" command
 */
3863
static const vshCmdInfo info_nodeinfo[] = {
3864 3865
    {"help", N_("node information")},
    {"desc", N_("Returns basic information about the node.")},
3866 3867 3868
    {NULL, NULL}
};

E
Eric Blake 已提交
3869
static bool
3870
cmdNodeinfo(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
3871 3872
{
    virNodeInfo info;
3873

3874
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
3875
        return false;
3876 3877

    if (virNodeGetInfo(ctl->conn, &info) < 0) {
3878
        vshError(ctl, "%s", _("failed to get node information"));
E
Eric Blake 已提交
3879
        return false;
3880 3881 3882 3883 3884 3885 3886 3887 3888 3889
    }
    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 已提交
3890
    return true;
3891 3892
}

3893 3894 3895 3896 3897
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
3898
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
3899 3900 3901 3902 3903 3904 3905 3906 3907 3908
    {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
3909
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
3910 3911 3912 3913
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
3914 3915
    int cpuNum = VIR_NODE_CPU_STATS_ALL_CPUS;
    virNodeCPUStatsPtr params;
3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958
    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;

3959
            if (STREQ(params[j].field, VIR_NODE_CPU_STATS_KERNEL)) {
3960
                cpu_stats[i].sys = value;
3961
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_USER)) {
3962
                cpu_stats[i].user = value;
3963
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IDLE)) {
3964
                cpu_stats[i].idle = value;
3965
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_IOWAIT)) {
3966
                cpu_stats[i].iowait = value;
3967
            } else if (STREQ(params[j].field, VIR_NODE_CPU_STATS_UTILIZATION)) {
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 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021
                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;
}

4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040
/*
 * "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;
4041 4042
    int cellNum = VIR_NODE_MEMORY_STATS_ALL_CELLS;
    virNodeMemoryStatsPtr params = NULL;
4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082
    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;
}

4083 4084 4085
/*
 * "capabilities" command
 */
4086
static const vshCmdInfo info_capabilities[] = {
4087 4088
    {"help", N_("capabilities")},
    {"desc", N_("Returns capabilities of hypervisor/driver.")},
4089 4090 4091
    {NULL, NULL}
};

E
Eric Blake 已提交
4092
static bool
4093
cmdCapabilities (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
4094 4095 4096
{
    char *caps;

4097
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4098
        return false;
4099 4100

    if ((caps = virConnectGetCapabilities (ctl->conn)) == NULL) {
4101
        vshError(ctl, "%s", _("failed to get capabilities"));
E
Eric Blake 已提交
4102
        return false;
4103 4104
    }
    vshPrint (ctl, "%s\n", caps);
4105
    VIR_FREE(caps);
4106

E
Eric Blake 已提交
4107
    return true;
4108 4109
}

4110 4111 4112
/*
 * "dumpxml" command
 */
4113
static const vshCmdInfo info_dumpxml[] = {
4114 4115
    {"help", N_("domain information in XML")},
    {"desc", N_("Output the domain information as an XML dump to stdout.")},
4116
    {NULL, NULL}
4117 4118
};

4119
static const vshCmdOptDef opts_dumpxml[] = {
4120 4121 4122
    {"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")},
4123
    {"update-cpu", VSH_OT_BOOL, 0, N_("update guest CPU according to host CPU")},
4124
    {NULL, 0, 0, NULL}
4125 4126
};

E
Eric Blake 已提交
4127
static bool
4128
cmdDumpXML(vshControl *ctl, const vshCmd *cmd)
4129
{
4130
    virDomainPtr dom;
E
Eric Blake 已提交
4131
    bool ret = true;
4132
    char *dump;
4133 4134 4135
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");
    int secure = vshCommandOptBool(cmd, "security-info");
4136
    int update = vshCommandOptBool(cmd, "update-cpu");
4137 4138 4139 4140 4141

    if (inactive)
        flags |= VIR_DOMAIN_XML_INACTIVE;
    if (secure)
        flags |= VIR_DOMAIN_XML_SECURE;
4142 4143
    if (update)
        flags |= VIR_DOMAIN_XML_UPDATE_CPU;
4144

4145
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4146
        return false;
4147

J
Jim Meyering 已提交
4148
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
4149
        return false;
4150

4151
    dump = virDomainGetXMLDesc(dom, flags);
4152
    if (dump != NULL) {
4153
        vshPrint(ctl, "%s", dump);
4154
        VIR_FREE(dump);
4155
    } else {
E
Eric Blake 已提交
4156
        ret = false;
4157
    }
4158

4159 4160 4161 4162
    virDomainFree(dom);
    return ret;
}

4163 4164 4165 4166
/*
 * "domxml-from-native" command
 */
static const vshCmdInfo info_domxmlfromnative[] = {
4167 4168
    {"help", N_("Convert native config to domain XML")},
    {"desc", N_("Convert native guest configuration format to domain XML format.")},
4169 4170 4171 4172
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmlfromnative[] = {
4173 4174
    {"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")},
4175 4176 4177
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4178
static bool
4179 4180
cmdDomXMLFromNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4181
    bool ret = true;
4182 4183
    const char *format = NULL;
    const char *configFile = NULL;
4184 4185 4186 4187
    char *configData;
    char *xmlData;
    int flags = 0;

4188
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4189
        return false;
4190

4191 4192
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "config", &configFile) < 0)
E
Eric Blake 已提交
4193
        return false;
4194

4195
    if (virFileReadAll(configFile, 1024*1024, &configData) < 0)
E
Eric Blake 已提交
4196
        return false;
4197 4198 4199

    xmlData = virConnectDomainXMLFromNative(ctl->conn, format, configData, flags);
    if (xmlData != NULL) {
4200
        vshPrint(ctl, "%s", xmlData);
4201
        VIR_FREE(xmlData);
4202
    } else {
E
Eric Blake 已提交
4203
        ret = false;
4204 4205 4206 4207 4208 4209 4210 4211 4212
    }

    return ret;
}

/*
 * "domxml-to-native" command
 */
static const vshCmdInfo info_domxmltonative[] = {
4213 4214
    {"help", N_("Convert domain XML to native config")},
    {"desc", N_("Convert domain XML config to a native guest configuration format.")},
4215 4216 4217 4218
    {NULL, NULL}
};

static const vshCmdOptDef opts_domxmltonative[] = {
4219 4220
    {"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")},
4221 4222 4223
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4224
static bool
4225 4226
cmdDomXMLToNative(vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
4227
    bool ret = true;
4228 4229
    const char *format = NULL;
    const char *xmlFile = NULL;
4230 4231 4232 4233
    char *configData;
    char *xmlData;
    int flags = 0;

4234
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4235
        return false;
4236

4237 4238
    if (vshCommandOptString(cmd, "format", &format) < 0
        || vshCommandOptString(cmd, "xml", &xmlFile) < 0)
E
Eric Blake 已提交
4239
        return false;
4240

4241
    if (virFileReadAll(xmlFile, 1024*1024, &xmlData) < 0)
E
Eric Blake 已提交
4242
        return false;
4243 4244 4245

    configData = virConnectDomainXMLToNative(ctl->conn, format, xmlData, flags);
    if (configData != NULL) {
4246
        vshPrint(ctl, "%s", configData);
4247
        VIR_FREE(configData);
4248
    } else {
E
Eric Blake 已提交
4249
        ret = false;
4250 4251 4252 4253 4254
    }

    return ret;
}

K
Karel Zak 已提交
4255
/*
K
Karel Zak 已提交
4256
 * "domname" command
K
Karel Zak 已提交
4257
 */
4258
static const vshCmdInfo info_domname[] = {
4259
    {"help", N_("convert a domain id or UUID to domain name")},
4260
    {"desc", ""},
4261
    {NULL, NULL}
K
Karel Zak 已提交
4262 4263
};

4264
static const vshCmdOptDef opts_domname[] = {
4265
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or uuid")},
4266
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4267 4268
};

E
Eric Blake 已提交
4269
static bool
4270
cmdDomname(vshControl *ctl, const vshCmd *cmd)
4271
{
K
Karel Zak 已提交
4272 4273
    virDomainPtr dom;

4274
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4275
        return false;
J
Jim Meyering 已提交
4276
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4277
                                      VSH_BYID|VSH_BYUUID)))
E
Eric Blake 已提交
4278
        return false;
4279

K
Karel Zak 已提交
4280 4281
    vshPrint(ctl, "%s\n", virDomainGetName(dom));
    virDomainFree(dom);
E
Eric Blake 已提交
4282
    return true;
K
Karel Zak 已提交
4283 4284 4285
}

/*
K
Karel Zak 已提交
4286
 * "domid" command
K
Karel Zak 已提交
4287
 */
4288
static const vshCmdInfo info_domid[] = {
4289
    {"help", N_("convert a domain name or UUID to domain id")},
4290
    {"desc", ""},
4291
    {NULL, NULL}
K
Karel Zak 已提交
4292 4293
};

4294
static const vshCmdOptDef opts_domid[] = {
4295
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name or uuid")},
4296
    {NULL, 0, 0, NULL}
K
Karel Zak 已提交
4297 4298
};

E
Eric Blake 已提交
4299
static bool
4300
cmdDomid(vshControl *ctl, const vshCmd *cmd)
4301
{
4302
    virDomainPtr dom;
4303
    unsigned int id;
K
Karel Zak 已提交
4304

4305
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4306
        return false;
J
Jim Meyering 已提交
4307
    if (!(dom = vshCommandOptDomainBy(ctl, cmd, NULL,
4308
                                      VSH_BYNAME|VSH_BYUUID)))
E
Eric Blake 已提交
4309
        return false;
4310

4311 4312
    id = virDomainGetID(dom);
    if (id == ((unsigned int)-1))
4313
        vshPrint(ctl, "%s\n", "-");
4314
    else
4315
        vshPrint(ctl, "%d\n", id);
K
Karel Zak 已提交
4316
    virDomainFree(dom);
E
Eric Blake 已提交
4317
    return true;
K
Karel Zak 已提交
4318
}
4319

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

4329
static const vshCmdOptDef opts_domuuid[] = {
4330
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain id or name")},
K
Karel Zak 已提交
4331 4332 4333
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4334
static bool
4335
cmdDomuuid(vshControl *ctl, const vshCmd *cmd)
K
Karel Zak 已提交
4336 4337
{
    virDomainPtr dom;
4338
    char uuid[VIR_UUID_STRING_BUFLEN];
K
Karel Zak 已提交
4339

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

K
Karel Zak 已提交
4346 4347 4348
    if (virDomainGetUUIDString(dom, uuid) != -1)
        vshPrint(ctl, "%s\n", uuid);
    else
4349
        vshError(ctl, "%s", _("failed to get domain UUID"));
4350

4351
    virDomainFree(dom);
E
Eric Blake 已提交
4352
    return true;
K
Karel Zak 已提交
4353 4354
}

4355 4356 4357
/*
 * "migrate" command
 */
4358
static const vshCmdInfo info_migrate[] = {
4359 4360
    {"help", N_("migrate domain to another host")},
    {"desc", N_("Migrate domain to another host.  Add --live for live migration.")},
4361 4362 4363
    {NULL, NULL}
};

4364
static const vshCmdOptDef opts_migrate[] = {
4365 4366 4367 4368 4369 4370 4371
    {"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")},
4372 4373
    {"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 已提交
4374
    {"verbose", VSH_OT_BOOL, 0, N_("display the progress of migration")},
4375
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
4376
    {"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)")},
4377 4378
    {"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 已提交
4379
    {"timeout", VSH_OT_INT, 0, N_("force guest to suspend if live migration exceeds timeout (in seconds)")},
4380
    {"xml", VSH_OT_STRING, 0, N_("filename containing updated XML for the target")},
4381 4382 4383
    {NULL, 0, 0, NULL}
};

4384 4385 4386 4387 4388 4389 4390 4391
typedef struct __vshCtrlData {
    vshControl *ctl;
    const vshCmd *cmd;
    int writefd;
} vshCtrlData;

static void
doMigrate (void *opaque)
4392
{
4393
    char ret = '1';
4394
    virDomainPtr dom = NULL;
4395 4396 4397 4398
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
    int flags = 0;
4399 4400 4401
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
4402 4403
    const char *xmlfile = NULL;
    char *xml = NULL;
4404
    sigset_t sigmask, oldsigmask;
4405 4406 4407 4408 4409

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

4411
    if (!vshConnectionUsability (ctl, ctl->conn))
4412
        goto out;
4413

J
Jim Meyering 已提交
4414
    if (!(dom = vshCommandOptDomain (ctl, cmd, NULL)))
4415
        goto out;
4416

4417 4418
    if (vshCommandOptString(cmd, "desturi", &desturi) <= 0 ||
        vshCommandOptString(cmd, "migrateuri", &migrateuri) < 0 ||
4419 4420
        vshCommandOptString(cmd, "dname", &dname) < 0) {
        vshError(ctl, "%s", _("missing argument"));
4421
        goto out;
4422
    }
4423

4424 4425 4426 4427 4428
    if (vshCommandOptString(cmd, "xml", &xmlfile) < 0) {
        vshError(ctl, "%s", _("malformed xml argument"));
        goto out;
    }

4429 4430
    if (vshCommandOptBool (cmd, "live"))
        flags |= VIR_MIGRATE_LIVE;
4431 4432
    if (vshCommandOptBool (cmd, "p2p"))
        flags |= VIR_MIGRATE_PEER2PEER;
C
Chris Lalancette 已提交
4433 4434 4435
    if (vshCommandOptBool (cmd, "tunnelled"))
        flags |= VIR_MIGRATE_TUNNELLED;

C
Chris Lalancette 已提交
4436 4437 4438 4439 4440
    if (vshCommandOptBool (cmd, "persistent"))
        flags |= VIR_MIGRATE_PERSIST_DEST;
    if (vshCommandOptBool (cmd, "undefinesource"))
        flags |= VIR_MIGRATE_UNDEFINE_SOURCE;

4441 4442 4443
    if (vshCommandOptBool (cmd, "suspend"))
        flags |= VIR_MIGRATE_PAUSED;

4444 4445 4446 4447 4448 4449
    if (vshCommandOptBool (cmd, "copy-storage-all"))
        flags |= VIR_MIGRATE_NON_SHARED_DISK;

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

4450 4451 4452 4453 4454 4455

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


4456 4457 4458 4459
    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. */
4460

4461
        if (migrateuri != NULL) {
J
Jim Fehlig 已提交
4462
            vshError(ctl, "%s", _("migrate: Unexpected migrateuri for peer2peer/direct migration"));
4463
            goto out;
4464
        }
4465

4466
        if (virDomainMigrateToURI2(dom, desturi, NULL, xml, flags, dname, 0) == 0)
4467
            ret = '0';
4468 4469 4470 4471 4472 4473
    } else {
        /* For traditional live migration, connect to the destination host directly. */
        virConnectPtr dconn = NULL;
        virDomainPtr ddom = NULL;

        dconn = virConnectOpenAuth (desturi, virConnectAuthPtrDefault, 0);
4474
        if (!dconn) goto out;
4475

4476
        ddom = virDomainMigrate2(dom, dconn, xml, flags, dname, migrateuri, 0);
4477 4478
        if (ddom) {
            virDomainFree(ddom);
4479
            ret = '0';
4480 4481 4482
        }
        virConnectClose (dconn);
    }
4483

4484 4485 4486
out:
    pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
out_sig:
4487
    if (dom) virDomainFree (dom);
4488
    VIR_FREE(xml);
4489 4490 4491
    ignore_value(safewrite(data->writefd, &ret, sizeof(ret)));
}

W
Wen Congyang 已提交
4492
static void
4493
print_job_progress(unsigned long long remaining, unsigned long long total)
W
Wen Congyang 已提交
4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512
{
    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;
        }
    }

4513
    fprintf(stderr, "\rMigration: [%3d %%]", progress);
W
Wen Congyang 已提交
4514 4515
}

E
Eric Blake 已提交
4516
static bool
4517 4518 4519 4520 4521
cmdMigrate (vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
    int p[2] = {-1, -1};
    int ret = -1;
W
Wen Congyang 已提交
4522
    bool functionReturn = false;
4523 4524 4525 4526 4527
    virThread workerThread;
    struct pollfd pollfd;
    char retchar;
    struct sigaction sig_action;
    struct sigaction old_sig_action;
W
Wen Congyang 已提交
4528 4529
    virDomainJobInfo jobinfo;
    bool verbose = false;
4530
    int timeout = 0;
W
Wen Congyang 已提交
4531 4532
    struct timeval start, curr;
    bool live_flag = false;
4533
    vshCtrlData data;
4534 4535 4536 4537
    sigset_t sigmask, oldsigmask;

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
4538 4539

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

W
Wen Congyang 已提交
4542 4543 4544
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

W
Wen Congyang 已提交
4545
    if (vshCommandOptBool (cmd, "live"))
E
Eric Blake 已提交
4546
        live_flag = true;
4547
    if (vshCommandOptInt(cmd, "timeout", &timeout) > 0) {
W
Wen Congyang 已提交
4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564
        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;
        }
    }

4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587
    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 已提交
4588
    GETTIMEOFDAY(&start);
W
Wen Congyang 已提交
4589
    while (1) {
4590
repoll:
W
Wen Congyang 已提交
4591 4592 4593 4594
        ret = poll(&pollfd, 1, 500);
        if (ret > 0) {
            if (saferead(p[0], &retchar, sizeof(retchar)) > 0) {
                if (retchar == '0') {
W
Wen Congyang 已提交
4595
                    functionReturn = true;
W
Wen Congyang 已提交
4596 4597
                    if (verbose) {
                        /* print [100 %] */
4598
                        print_job_progress(0, 1);
W
Wen Congyang 已提交
4599 4600
                    }
                } else
W
Wen Congyang 已提交
4601
                    functionReturn = false;
4602
            } else
W
Wen Congyang 已提交
4603
                functionReturn = false;
W
Wen Congyang 已提交
4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614
            break;
        }

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
4615
            functionReturn = false;
W
Wen Congyang 已提交
4616 4617 4618
            break;
        }

W
Wen Congyang 已提交
4619 4620 4621 4622 4623 4624 4625 4626 4627
        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. */
            vshDebug(ctl, 5, "suspend the domain when migration timeouts\n");
            virDomainSuspend(dom);
            timeout = 0;
        }

W
Wen Congyang 已提交
4628 4629 4630 4631 4632
        if (verbose) {
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
            ret = virDomainGetJobInfo(dom, &jobinfo);
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
            if (ret == 0)
4633
                print_job_progress(jobinfo.dataRemaining, jobinfo.dataTotal);
4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
4645
    return functionReturn;
4646 4647
}

4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658
/*
 * "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")},
4659
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
4660 4661 4662
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4663
static bool
4664 4665 4666
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
4667
    long long downtime = 0;
E
Eric Blake 已提交
4668
    bool ret = false;
4669

4670
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4671
        return false;
4672 4673

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

4676 4677
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
4678 4679 4680 4681 4682 4683 4684
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
4685
    ret = true;
4686 4687 4688 4689 4690 4691

done:
    virDomainFree(dom);
    return ret;
}

4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735
/*
 * "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;
}

4736 4737 4738
/*
 * "net-autostart" command
 */
4739
static const vshCmdInfo info_network_autostart[] = {
4740
    {"help", N_("autostart a network")},
4741
    {"desc",
4742
     N_("Configure a network to be automatically started at boot.")},
4743 4744 4745
    {NULL, NULL}
};

4746
static const vshCmdOptDef opts_network_autostart[] = {
4747 4748
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4749 4750 4751
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4752
static bool
4753
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
4754 4755
{
    virNetworkPtr network;
4756
    const char *name;
4757 4758
    int autostart;

4759
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4760
        return false;
4761

J
Jim Meyering 已提交
4762
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4763
        return false;
4764 4765 4766 4767

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
4768
        if (autostart)
4769
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
4770
        else
4771
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
4772
        virNetworkFree(network);
E
Eric Blake 已提交
4773
        return false;
4774 4775
    }

4776
    if (autostart)
4777
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
4778
    else
4779
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
4780

L
Laine Stump 已提交
4781
    virNetworkFree(network);
E
Eric Blake 已提交
4782
    return true;
4783
}
K
Karel Zak 已提交
4784

4785 4786 4787
/*
 * "net-create" command
 */
4788
static const vshCmdInfo info_network_create[] = {
4789 4790
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
4791 4792 4793
    {NULL, NULL}
};

4794
static const vshCmdOptDef opts_network_create[] = {
4795
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4796 4797 4798
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4799
static bool
4800
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
4801 4802
{
    virNetworkPtr network;
4803
    const char *from = NULL;
E
Eric Blake 已提交
4804
    bool ret = true;
4805
    char *buffer;
4806

4807
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4808
        return false;
4809

4810
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4811
        return false;
4812

4813
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4814
        return false;
4815 4816

    network = virNetworkCreateXML(ctl->conn, buffer);
4817
    VIR_FREE(buffer);
4818

4819 4820 4821
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4822
        virNetworkFree(network);
4823
    } else {
4824
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
4825
        ret = false;
4826 4827 4828 4829 4830 4831 4832 4833
    }
    return ret;
}


/*
 * "net-define" command
 */
4834
static const vshCmdInfo info_network_define[] = {
4835 4836
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
4837 4838 4839
    {NULL, NULL}
};

4840
static const vshCmdOptDef opts_network_define[] = {
4841
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4842 4843 4844
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4845
static bool
4846
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
4847 4848
{
    virNetworkPtr network;
4849
    const char *from = NULL;
E
Eric Blake 已提交
4850
    bool ret = true;
4851
    char *buffer;
4852

4853
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4854
        return false;
4855

4856
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4857
        return false;
4858

4859
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4860
        return false;
4861 4862

    network = virNetworkDefineXML(ctl->conn, buffer);
4863
    VIR_FREE(buffer);
4864

4865 4866 4867
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4868
        virNetworkFree(network);
4869
    } else {
4870
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
4871
        ret = false;
4872 4873 4874 4875 4876 4877 4878 4879
    }
    return ret;
}


/*
 * "net-destroy" command
 */
4880
static const vshCmdInfo info_network_destroy[] = {
4881 4882
    {"help", N_("destroy (stop) a network")},
    {"desc", N_("Forcefully stop a given network.")},
4883 4884 4885
    {NULL, NULL}
};

4886
static const vshCmdOptDef opts_network_destroy[] = {
4887
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4888 4889 4890
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4891
static bool
4892
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
4893 4894
{
    virNetworkPtr network;
E
Eric Blake 已提交
4895
    bool ret = true;
4896
    const char *name;
4897

4898
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4899
        return false;
4900

J
Jim Meyering 已提交
4901
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4902
        return false;
4903 4904 4905 4906

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

4911
    virNetworkFree(network);
4912 4913 4914 4915 4916 4917 4918
    return ret;
}


/*
 * "net-dumpxml" command
 */
4919
static const vshCmdInfo info_network_dumpxml[] = {
4920 4921
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
4922 4923 4924
    {NULL, NULL}
};

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

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

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

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

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
4945
        vshPrint(ctl, "%s", dump);
4946
        VIR_FREE(dump);
4947
    } else {
E
Eric Blake 已提交
4948
        ret = false;
4949 4950 4951 4952 4953 4954
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968
/*
 * "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 已提交
4969
static bool
O
Osier Yang 已提交
4970 4971 4972 4973 4974 4975 4976 4977 4978 4979
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 已提交
4980
        return false;
O
Osier Yang 已提交
4981 4982 4983

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4984
        return false;
O
Osier Yang 已提交
4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010

    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 已提交
5011
    return true;
O
Osier Yang 已提交
5012
}
5013

5014 5015 5016 5017
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
5018 5019
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
5020 5021 5022 5023
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
5024
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5025 5026 5027
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5028
static bool
5029 5030
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5031
    bool ret = false;
5032 5033 5034 5035 5036
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
5037
    int flags = VIR_INTERFACE_XML_INACTIVE;
5038

5039
    if (!vshConnectionUsability(ctl, ctl->conn))
5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065
        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 已提交
5066
        ret = true;
5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078
        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)) {
5079 5080
        vshError(ctl, "%s",
                 _("ERROR: the XML configuration was changed by another user"));
5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092
        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 已提交
5093
    ret = true;
5094 5095 5096 5097 5098

cleanup:
    if (iface)
        virInterfaceFree (iface);

5099 5100 5101
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
5102 5103 5104

    if (tmp) {
        unlink (tmp);
5105
        VIR_FREE(tmp);
5106 5107 5108 5109 5110
    }

    return ret;
}

5111 5112 5113
/*
 * "net-list" command
 */
5114
static const vshCmdInfo info_network_list[] = {
5115 5116
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
5117 5118 5119
    {NULL, NULL}
};

5120
static const vshCmdOptDef opts_network_list[] = {
5121 5122
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
5123 5124 5125
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5126
static bool
5127
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5128 5129 5130 5131 5132
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
5133
    char **activeNames = NULL, **inactiveNames = NULL;
5134 5135
    inactive |= all;

5136
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5137
        return false;
5138 5139

    if (active) {
5140 5141
        maxactive = virConnectNumOfNetworks(ctl->conn);
        if (maxactive < 0) {
5142
            vshError(ctl, "%s", _("Failed to list active networks"));
E
Eric Blake 已提交
5143
            return false;
5144
        }
5145
        if (maxactive) {
5146
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);
5147

5148
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
5149
                                                    maxactive)) < 0) {
5150
                vshError(ctl, "%s", _("Failed to list active networks"));
5151
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5152
                return false;
5153
            }
5154

5155
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
5156
        }
5157 5158
    }
    if (inactive) {
5159 5160
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
5161
            vshError(ctl, "%s", _("Failed to list inactive networks"));
5162
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5163
            return false;
5164
        }
5165 5166 5167
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5168 5169 5170
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
5171
                vshError(ctl, "%s", _("Failed to list inactive networks"));
5172 5173
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5174
                return false;
5175
            }
5176

5177 5178
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
5179
    }
5180 5181
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
5182
    vshPrintExtra(ctl, "-----------------------------------------\n");
5183 5184

    for (i = 0; i < maxactive; i++) {
5185 5186
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
5187 5188
        const char *autostartStr;
        int autostart = 0;
5189 5190 5191

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5192
            VIR_FREE(activeNames[i]);
5193
            continue;
5194
        }
5195

5196 5197 5198
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5199
            autostartStr = autostart ? _("yes") : _("no");
5200 5201 5202 5203 5204

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
5205
        virNetworkFree(network);
5206
        VIR_FREE(activeNames[i]);
5207 5208 5209
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
5210 5211
        const char *autostartStr;
        int autostart = 0;
5212 5213 5214

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5215
            VIR_FREE(inactiveNames[i]);
5216
            continue;
5217
        }
5218

5219 5220 5221
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5222
            autostartStr = autostart ? _("yes") : _("no");
5223

5224
        vshPrint(ctl, "%-20s %-10s %-10s\n",
5225 5226 5227
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
5228 5229

        virNetworkFree(network);
5230
        VIR_FREE(inactiveNames[i]);
5231
    }
5232 5233
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5234
    return true;
5235 5236 5237 5238 5239 5240
}


/*
 * "net-name" command
 */
5241
static const vshCmdInfo info_network_name[] = {
5242
    {"help", N_("convert a network UUID to network name")},
5243
    {"desc", ""},
5244 5245 5246
    {NULL, NULL}
};

5247
static const vshCmdOptDef opts_network_name[] = {
5248
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
5249 5250 5251
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5252
static bool
5253
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
5254 5255 5256
{
    virNetworkPtr network;

5257
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5258
        return false;
J
Jim Meyering 已提交
5259
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5260
                                           VSH_BYUUID)))
E
Eric Blake 已提交
5261
        return false;
5262 5263 5264

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
5265
    return true;
5266 5267 5268 5269 5270 5271
}


/*
 * "net-start" command
 */
5272
static const vshCmdInfo info_network_start[] = {
5273 5274
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
5275 5276 5277
    {NULL, NULL}
};

5278
static const vshCmdOptDef opts_network_start[] = {
5279
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
5280 5281 5282
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5283
static bool
5284
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
5285 5286
{
    virNetworkPtr network;
E
Eric Blake 已提交
5287
    bool ret = true;
5288

5289
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5290
        return false;
5291

J
Jim Meyering 已提交
5292
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
5293
         return false;
5294 5295 5296

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
5297
                 virNetworkGetName(network));
5298
    } else {
5299
        vshError(ctl, _("Failed to start network %s"),
5300
                 virNetworkGetName(network));
E
Eric Blake 已提交
5301
        ret = false;
5302
    }
L
Laine Stump 已提交
5303
    virNetworkFree(network);
5304 5305 5306 5307 5308 5309 5310
    return ret;
}


/*
 * "net-undefine" command
 */
5311
static const vshCmdInfo info_network_undefine[] = {
5312 5313
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
5314 5315 5316
    {NULL, NULL}
};

5317
static const vshCmdOptDef opts_network_undefine[] = {
5318
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5319 5320 5321
    {NULL, 0, 0, NULL}
};

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

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

J
Jim Meyering 已提交
5332
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5333
        return false;
5334 5335 5336 5337

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

L
Laine Stump 已提交
5342
    virNetworkFree(network);
5343 5344 5345 5346 5347 5348 5349
    return ret;
}


/*
 * "net-uuid" command
 */
5350
static const vshCmdInfo info_network_uuid[] = {
5351
    {"help", N_("convert a network name to network UUID")},
5352
    {"desc", ""},
5353 5354 5355
    {NULL, NULL}
};

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

E
Eric Blake 已提交
5361
static bool
5362
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
5363 5364 5365 5366
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

J
Jim Meyering 已提交
5370
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5371
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5372
        return false;
5373 5374 5375 5376

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

L
Laine Stump 已提交
5379
    virNetworkFree(network);
E
Eric Blake 已提交
5380
    return true;
5381 5382 5383
}


5384 5385 5386 5387 5388
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
5389 5390
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
5391 5392 5393 5394
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
5395 5396
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
5397 5398
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
5399
static bool
5400 5401 5402 5403 5404 5405 5406 5407 5408
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;

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

    if (active) {
        maxactive = virConnectNumOfInterfaces(ctl->conn);
        if (maxactive < 0) {
5415
            vshError(ctl, "%s", _("Failed to list active interfaces"));
E
Eric Blake 已提交
5416
            return false;
5417 5418 5419 5420 5421 5422
        }
        if (maxactive) {
            activeNames = vshMalloc(ctl, sizeof(char *) * maxactive);

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
5423
                vshError(ctl, "%s", _("Failed to list active interfaces"));
5424
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5425
                return false;
5426 5427 5428 5429 5430 5431 5432 5433
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
5434
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
5435
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5436
            return false;
5437 5438 5439 5440
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5441 5442 5443
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
5444
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
5445 5446
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5447
                return false;
5448 5449 5450 5451 5452
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
5453 5454
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
5455 5456 5457
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
5458 5459
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
5460 5461 5462

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
5463
            VIR_FREE(activeNames[i]);
5464 5465 5466 5467 5468 5469 5470 5471
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
5472
        VIR_FREE(activeNames[i]);
5473 5474
    }
    for (i = 0; i < maxinactive; i++) {
5475 5476
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
5477 5478 5479

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
5480
            VIR_FREE(inactiveNames[i]);
5481 5482 5483 5484 5485 5486 5487 5488
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
5489
        VIR_FREE(inactiveNames[i]);
5490
    }
5491 5492
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5493
    return true;
5494 5495 5496 5497 5498 5499 5500

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
5501
    {"help", N_("convert an interface MAC address to interface name")},
5502 5503 5504 5505 5506
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
5507
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
5508 5509 5510
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5511
static bool
5512 5513 5514 5515
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

5516
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5517
        return false;
5518 5519
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
5520
        return false;
5521 5522 5523

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
5524
    return true;
5525 5526 5527 5528 5529 5530
}

/*
 * "iface-mac" command
 */
static const vshCmdInfo info_interface_mac[] = {
5531
    {"help", N_("convert an interface name to interface MAC address")},
5532 5533 5534 5535 5536
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_mac[] = {
5537
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
5538 5539 5540
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5541
static bool
5542 5543 5544 5545
cmdInterfaceMAC(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

5546
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5547
        return false;
5548 5549
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5550
        return false;
5551 5552 5553

    vshPrint(ctl, "%s\n", virInterfaceGetMACString(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
5554
    return true;
5555 5556 5557 5558 5559 5560
}

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
5561 5562
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
5563 5564 5565 5566
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
5567 5568
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
5569 5570 5571
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5572
static bool
5573 5574 5575
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5576
    bool ret = true;
5577
    char *dump;
5578 5579 5580 5581 5582
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
5583

5584
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5585
        return false;
5586 5587

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

5590
    dump = virInterfaceGetXMLDesc(iface, flags);
5591
    if (dump != NULL) {
5592
        vshPrint(ctl, "%s", dump);
5593
        VIR_FREE(dump);
5594
    } else {
E
Eric Blake 已提交
5595
        ret = false;
5596 5597 5598 5599 5600 5601 5602 5603 5604 5605
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
5606 5607
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
5608 5609 5610 5611
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
5612
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
5613 5614 5615
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5616
static bool
5617 5618
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
5619
    virInterfacePtr iface;
5620
    const char *from = NULL;
E
Eric Blake 已提交
5621
    bool ret = true;
5622 5623
    char *buffer;

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

5627
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5628
        return false;
5629 5630

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

5633
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
5634
    VIR_FREE(buffer);
5635

5636
    if (iface != NULL) {
5637
        vshPrint(ctl, _("Interface %s defined from %s\n"),
5638
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
5639
        virInterfaceFree (iface);
5640
    } else {
5641
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
5642
        ret = false;
5643 5644 5645 5646 5647 5648 5649 5650
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
5651 5652
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
5653 5654 5655 5656
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
5657
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5658 5659 5660
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5661
static bool
5662 5663 5664
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5665
    bool ret = true;
5666
    const char *name;
5667

5668
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5669
        return false;
5670 5671

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5672
        return false;
5673 5674 5675 5676

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
5677
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
5678
        ret = false;
5679 5680 5681 5682 5683 5684 5685 5686 5687 5688
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
5689 5690
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
5691 5692 5693 5694
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
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
cmdInterfaceStart(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 (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
5715
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
5716
        ret = false;
5717 5718 5719 5720 5721 5722 5723 5724 5725 5726
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
5727
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
5728
    {"desc", N_("forcefully stop a physical host interface.")},
5729 5730 5731 5732
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
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
cmdInterfaceDestroy(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 (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
5753
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
5754
        ret = false;
5755 5756 5757 5758 5759 5760
    }

    virInterfaceFree(iface);
    return ret;
}

5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 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
/*
 * "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;
}
5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860

/*
 * "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 已提交
5861
static bool
5862 5863 5864
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
5865
    const char *from = NULL;
E
Eric Blake 已提交
5866
    bool ret = true;
5867 5868
    char *buffer;

5869
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5870
        return false;
5871

5872
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5873
        return false;
5874 5875

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5876
        return false;
5877 5878 5879 5880 5881 5882 5883 5884 5885 5886

    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 已提交
5887
        ret = false;
5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906
    }
    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 已提交
5907
static bool
5908 5909 5910
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5911
    bool ret = true;
5912
    const char *name;
5913

5914
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5915
        return false;
5916 5917

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
5918
        return false;
5919 5920 5921 5922 5923

    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 已提交
5924
        ret = false;
5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945
    }

    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 已提交
5946
static bool
5947 5948 5949
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5950
    bool ret = true;
5951 5952
    char *dump;

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

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

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
5961
        vshPrint(ctl, "%s", dump);
5962 5963
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
5964
        ret = false;
5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983
    }

    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 已提交
5984
static bool
5985 5986 5987 5988 5989 5990
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

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

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
5997
        return false;
5998 5999 6000 6001 6002 6003 6004 6005
    }

    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 已提交
6006
        return false;
6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033
    }

    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 已提交
6034
    return true;
6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051
}


/*
 * "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 已提交
6052
static bool
6053 6054
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6055
    bool ret = false;
6056 6057 6058 6059 6060 6061
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

6062
    if (!vshConnectionUsability(ctl, ctl->conn))
6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088
        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 已提交
6089
        ret = true;
6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115
        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 已提交
6116
    ret = true;
6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134

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


6135
/**************************************************************************/
6136
/*
6137
 * "pool-autostart" command
6138
 */
6139
static const vshCmdInfo info_pool_autostart[] = {
6140
    {"help", N_("autostart a pool")},
6141
    {"desc",
6142
     N_("Configure a pool to be automatically started at boot.")},
6143
    {NULL, NULL}
6144 6145
};

6146
static const vshCmdOptDef opts_pool_autostart[] = {
6147 6148
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6149 6150
    {NULL, 0, 0, NULL}
};
6151

E
Eric Blake 已提交
6152
static bool
6153
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
6154
{
6155
    virStoragePoolPtr pool;
6156
    const char *name;
6157
    int autostart;
6158

6159
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6160
        return false;
6161

6162
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6163
        return false;
6164

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

6167 6168
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
6169
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
6170
        else
6171
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
6172
        virStoragePoolFree(pool);
E
Eric Blake 已提交
6173
        return false;
6174 6175
    }

6176
    if (autostart)
6177
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
6178
    else
6179
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
6180

L
Laine Stump 已提交
6181
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6182
    return true;
6183 6184
}

6185
/*
6186
 * "pool-create" command
6187
 */
6188
static const vshCmdInfo info_pool_create[] = {
6189 6190
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
6191 6192 6193
    {NULL, NULL}
};

6194
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
6195
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
6196
     N_("file containing an XML pool description")},
6197 6198 6199
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6200
static bool
6201
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
6202
{
6203
    virStoragePoolPtr pool;
6204
    const char *from = NULL;
E
Eric Blake 已提交
6205
    bool ret = true;
6206
    char *buffer;
6207

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

6211
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6212
        return false;
6213

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

6217
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
6218
    VIR_FREE(buffer);
6219 6220 6221 6222

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6223
        virStoragePoolFree(pool);
6224
    } else {
6225
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
6226
        ret = false;
6227 6228
    }
    return ret;
6229 6230
}

6231

6232 6233 6234 6235
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
6236
    {"help", N_("create a device defined "
6237
                          "by an XML file on the node")},
6238
    {"desc", N_("Create a device on the node.  Note that this "
6239 6240 6241 6242 6243 6244 6245
                          "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,
6246
     N_("file containing an XML description of the device")},
6247 6248 6249
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6250
static bool
6251 6252 6253
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
6254
    const char *from = NULL;
E
Eric Blake 已提交
6255
    bool ret = true;
6256 6257
    char *buffer;

6258
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6259
        return false;
6260

6261
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6262
        return false;
6263

6264
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6265
        return false;
6266 6267

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
6268
    VIR_FREE(buffer);
6269 6270 6271 6272

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
6273
        virNodeDeviceFree(dev);
6274
    } else {
6275
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
6276
        ret = false;
6277 6278 6279 6280 6281 6282 6283 6284 6285 6286
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
6287
    {"help", N_("destroy (stop) a device on the node")},
6288
    {"desc", N_("Destroy a device on the node.  Note that this "
6289
                "command destroys devices on the physical host")},
6290 6291 6292 6293 6294
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
6295
     N_("name of the device to be destroyed")},
6296 6297 6298
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6299
static bool
6300 6301 6302
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
6303
    bool ret = true;
6304
    const char *name = NULL;
6305

6306
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
6307
        return false;
6308 6309
    }

6310
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
6311
        return false;
6312 6313 6314 6315 6316 6317

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
6318
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
6319
        ret = false;
6320 6321 6322 6323 6324 6325 6326
    }

    virNodeDeviceFree(dev);
    return ret;
}


6327
/*
6328
 * XML Building helper for pool-define-as and pool-create-as
6329
 */
6330
static const vshCmdOptDef opts_pool_X_as[] = {
6331 6332 6333 6334 6335 6336 6337 6338
    {"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")},
6339
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
6340 6341 6342
    {NULL, 0, 0, NULL}
};

6343
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
6344

6345 6346
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
6347
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6348

6349
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6350
        goto cleanup;
6351
    if (vshCommandOptString(cmd, "type", &type) <= 0)
6352 6353
        goto cleanup;

6354 6355 6356 6357 6358
    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 ||
6359 6360
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
6361
        goto cleanup;
6362
    }
6363

6364 6365
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
6366
    if (srcHost || srcPath || srcDev || srcFormat || srcName) {
6367
        virBufferAddLit(&buf, "  <source>\n");
6368

6369
        if (srcHost)
6370
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
6371
        if (srcPath)
6372
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
6373
        if (srcDev)
6374
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
6375
        if (srcFormat)
6376
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
6377
        if (srcName)
6378
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
6379 6380

        virBufferAddLit(&buf, "  </source>\n");
6381 6382
    }
    if (target) {
6383
        virBufferAddLit(&buf, "  <target>\n");
6384
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
6385
        virBufferAddLit(&buf, "  </target>\n");
6386
    }
6387 6388 6389 6390
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
6391
        return false;
6392
    }
6393 6394 6395

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
6396
    return true;
6397 6398

cleanup:
6399
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6400
    return false;
6401 6402 6403 6404 6405 6406
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
6407 6408
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
6409 6410 6411
    {NULL, NULL}
};

E
Eric Blake 已提交
6412
static bool
6413 6414 6415
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
6416 6417
    const char *name;
    char *xml;
6418
    int printXML = vshCommandOptBool(cmd, "print-xml");
6419

6420
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6421
        return false;
6422 6423

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

6426
    if (printXML) {
6427
        vshPrint(ctl, "%s", xml);
6428
        VIR_FREE(xml);
6429
    } else {
6430
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
6431
        VIR_FREE(xml);
6432

6433 6434 6435 6436
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
6437
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
6438
            return false;
6439 6440
        }
    }
E
Eric Blake 已提交
6441
    return true;
6442 6443
}

6444

6445
/*
6446
 * "pool-define" command
6447
 */
6448
static const vshCmdInfo info_pool_define[] = {
6449 6450
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
6451 6452 6453
    {NULL, NULL}
};

6454
static const vshCmdOptDef opts_pool_define[] = {
6455
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
6456 6457 6458
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6459
static bool
6460
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
6461
{
6462
    virStoragePoolPtr pool;
6463
    const char *from = NULL;
E
Eric Blake 已提交
6464
    bool ret = true;
6465
    char *buffer;
6466

6467
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6468
        return false;
6469

6470
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6471
        return false;
6472

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

6476
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
6477
    VIR_FREE(buffer);
6478 6479 6480 6481

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6482
        virStoragePoolFree(pool);
6483
    } else {
6484
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
6485
        ret = false;
6486 6487
    }
    return ret;
6488 6489
}

6490

6491 6492 6493
/*
 * "pool-define-as" command
 */
6494
static const vshCmdInfo info_pool_define_as[] = {
6495 6496
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
6497 6498 6499
    {NULL, NULL}
};

E
Eric Blake 已提交
6500
static bool
6501
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
6502 6503
{
    virStoragePoolPtr pool;
6504 6505
    const char *name;
    char *xml;
6506
    int printXML = vshCommandOptBool(cmd, "print-xml");
6507

6508
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6509
        return false;
6510

6511
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
6512
        return false;
6513

6514
    if (printXML) {
6515
        vshPrint(ctl, "%s", xml);
6516
        VIR_FREE(xml);
6517
    } else {
6518
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
6519
        VIR_FREE(xml);
6520

6521 6522 6523 6524
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
6525
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
6526
            return false;
6527 6528
        }
    }
E
Eric Blake 已提交
6529
    return true;
6530 6531 6532
}


6533
/*
6534
 * "pool-build" command
6535
 */
6536
static const vshCmdInfo info_pool_build[] = {
6537 6538
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
6539 6540 6541
    {NULL, NULL}
};

6542
static const vshCmdOptDef opts_pool_build[] = {
6543
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6544 6545 6546
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6547
static bool
6548
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
6549
{
6550
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6551
    bool ret = true;
6552
    const char *name;
6553

6554
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6555
        return false;
6556

6557
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6558
        return false;
6559

6560
    if (virStoragePoolBuild(pool, 0) == 0) {
6561
        vshPrint(ctl, _("Pool %s built\n"), name);
6562
    } else {
6563
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
6564
        ret = false;
6565 6566
    }

6567 6568
    virStoragePoolFree(pool);

6569 6570 6571
    return ret;
}

6572

6573
/*
6574
 * "pool-destroy" command
6575
 */
6576
static const vshCmdInfo info_pool_destroy[] = {
6577 6578 6579
    {"help", N_("destroy (stop) a pool")},
    {"desc",
     N_("Forcefully stop a given pool. Raw data in the pool is untouched")},
6580 6581 6582
    {NULL, NULL}
};

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

E
Eric Blake 已提交
6588
static bool
6589
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
6590
{
6591
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6592
    bool ret = true;
6593
    const char *name;
6594

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

6598
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6599
        return false;
6600

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

6608
    virStoragePoolFree(pool);
6609 6610 6611
    return ret;
}

6612

6613
/*
6614 6615
 * "pool-delete" command
 */
6616
static const vshCmdInfo info_pool_delete[] = {
6617 6618
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
6619 6620 6621
    {NULL, NULL}
};

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

E
Eric Blake 已提交
6627
static bool
6628
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
6629 6630
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6631
    bool ret = true;
6632
    const char *name;
6633

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

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6638
        return false;
6639 6640

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
6641
        vshPrint(ctl, _("Pool %s deleted\n"), name);
6642
    } else {
6643
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
6644
        ret = false;
6645 6646
    }

L
Laine Stump 已提交
6647
    virStoragePoolFree(pool);
6648 6649 6650 6651 6652 6653 6654
    return ret;
}


/*
 * "pool-refresh" command
 */
6655
static const vshCmdInfo info_pool_refresh[] = {
6656 6657
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
6658 6659 6660
    {NULL, NULL}
};

6661
static const vshCmdOptDef opts_pool_refresh[] = {
6662
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6663 6664 6665
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6666
static bool
6667
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
6668 6669
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6670
    bool ret = true;
6671
    const char *name;
6672

6673
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6674
        return false;
6675 6676

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6677
        return false;
6678 6679 6680 6681

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
6682
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
6683
        ret = false;
6684 6685 6686 6687 6688 6689 6690 6691 6692 6693
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
6694
static const vshCmdInfo info_pool_dumpxml[] = {
6695 6696
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
6697 6698 6699
    {NULL, NULL}
};

6700
static const vshCmdOptDef opts_pool_dumpxml[] = {
6701
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6702 6703 6704
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6705
static bool
6706
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
6707 6708
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6709
    bool ret = true;
6710 6711
    char *dump;

6712
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6713
        return false;
6714 6715

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6716
        return false;
6717 6718 6719

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
6720
        vshPrint(ctl, "%s", dump);
6721
        VIR_FREE(dump);
6722
    } else {
E
Eric Blake 已提交
6723
        ret = false;
6724 6725 6726 6727 6728 6729 6730 6731 6732 6733
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
6734
static const vshCmdInfo info_pool_list[] = {
6735 6736
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
6737 6738 6739
    {NULL, NULL}
};

6740
static const vshCmdOptDef opts_pool_list[] = {
6741 6742
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
6743
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
6744 6745 6746
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6747
static bool
6748
cmdPoolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
6749
{
6750 6751
    virStoragePoolInfo info;
    char **poolNames = NULL;
W
Wen Congyang 已提交
6752 6753
    int i, ret;
    bool functionReturn;
6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769
    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 */
6770
    int all = vshCommandOptBool(cmd, "all");
6771 6772
    int details = vshCommandOptBool(cmd, "details");
    int inactive = vshCommandOptBool(cmd, "inactive");
6773 6774 6775
    int active = !inactive || all ? 1 : 0;
    inactive |= all;

6776
    /* Check the connection to libvirtd daemon is still working */
6777
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6778
        return false;
6779

6780
    /* Retrieve the number of active storage pools */
6781
    if (active) {
6782 6783
        numActivePools = virConnectNumOfStoragePools(ctl->conn);
        if (numActivePools < 0) {
6784
            vshError(ctl, "%s", _("Failed to list active pools"));
E
Eric Blake 已提交
6785
            return false;
6786 6787
        }
    }
6788 6789

    /* Retrieve the number of inactive storage pools */
6790
    if (inactive) {
6791 6792
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
6793
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
6794
            return false;
6795
        }
6796
    }
6797

6798 6799
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
6800

6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812
    /* 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 已提交
6813
            return false;
6814 6815 6816
        }
    }

6817 6818 6819 6820 6821 6822 6823 6824
    /* 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 已提交
6825
            return false;
6826 6827
        }
    }
6828

6829 6830 6831 6832 6833 6834 6835 6836 6837 6838
    /* 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]);
6839
        if (!pool) {
6840
            VIR_FREE(poolNames[i]);
6841 6842 6843
            continue;
        }

6844
        /* Retrieve the autostart status of the pool */
6845
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
6846
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
6847
        else
6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865
            poolInfoTexts[i].autostart = vshStrdup(ctl, autostart ?
                                                    _("yes") : _("no"));

        /* Retrieve the persistence status of the pool */
        if (details) {
            persistent = virStoragePoolIsPersistent(pool);
            vshDebug(ctl, 5, "Persistent flag value: %d\n", persistent);
            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;
        }
6866

6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 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
        /* 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 */
6979 6980 6981
        virStoragePoolFree(pool);
    }

6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999
    /* 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);
7000 7001
        }

7002
        /* Cleanup and return */
E
Eric Blake 已提交
7003
        functionReturn = true;
7004 7005
        goto cleanup;
    }
7006

7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 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 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100
    /* 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. */
    vshDebug(ctl, 5, "Longest name string = %lu chars\n",
             (unsigned long) nameStrLength);
    vshDebug(ctl, 5, "Longest state string = %lu chars\n",
             (unsigned long) stateStrLength);
    vshDebug(ctl, 5, "Longest autostart string = %lu chars\n",
             (unsigned long) autostartStrLength);
    vshDebug(ctl, 5, "Longest persistent string = %lu chars\n",
             (unsigned long) persistStrLength);
    vshDebug(ctl, 5, "Longest capacity string = %lu chars\n",
             (unsigned long) capStrLength);
    vshDebug(ctl, 5, "Longest allocation string = %lu chars\n",
             (unsigned long) allocStrLength);
    vshDebug(ctl, 5, "Longest available string = %lu chars\n",
             (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 已提交
7101
    functionReturn = true;
7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115
    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 已提交
7116
    functionReturn = false;
7117

7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129
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]);
7130
    }
7131 7132 7133 7134 7135 7136 7137

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

    /* Return the desired value */
    return functionReturn;
7138 7139
}

7140 7141 7142 7143
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
7144 7145
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7146 7147 7148 7149 7150
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7151 7152 7153
     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")},
7154
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
7155 7156 7157
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7158
static bool
7159 7160
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7161
    const char *type = NULL, *host = NULL;
7162 7163
    char *srcSpec = NULL;
    char *srcList;
7164
    const char *initiator = NULL;
7165

7166 7167
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
7168 7169
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
7170
        return false;
7171
    }
7172

7173
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7174
        return false;
7175 7176

    if (host) {
7177
        const char *port = NULL;
7178
        virBuffer buf = VIR_BUFFER_INITIALIZER;
7179 7180 7181 7182

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7183
            return false;
7184
        }
7185
        virBufferAddLit(&buf, "<source>\n");
7186
        virBufferAsprintf(&buf, "  <host name='%s'", host);
7187
        if (port)
7188
            virBufferAsprintf(&buf, " port='%s'", port);
7189
        virBufferAddLit(&buf, "/>\n");
7190 7191
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
7192
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
7193 7194
            virBufferAddLit(&buf, "  </initiator>\n");
        }
7195 7196 7197
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
7198
            return false;
7199
        }
7200
        srcSpec = virBufferContentAndReset(&buf);
7201 7202 7203
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7204
    VIR_FREE(srcSpec);
7205
    if (srcList == NULL) {
7206
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7207
        return false;
7208 7209
    }
    vshPrint(ctl, "%s", srcList);
7210
    VIR_FREE(srcList);
7211

E
Eric Blake 已提交
7212
    return true;
7213 7214 7215 7216 7217 7218 7219
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
7220 7221
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7222 7223 7224 7225 7226
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7227
     N_("type of storage pool sources to discover")},
7228
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
7229
     N_("optional file of source xml to query for pools")},
7230 7231 7232
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7233
static bool
7234 7235
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7236
    const char *type = NULL, *srcSpecFile = NULL;
7237
    char *srcSpec = NULL, *srcList;
7238

7239
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
7240
        return false;
7241

7242 7243
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
7244
        return false;
7245
    }
7246

7247
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7248
        return false;
7249 7250

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
7251
        return false;
7252 7253

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7254
    VIR_FREE(srcSpec);
7255
    if (srcList == NULL) {
7256
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7257
        return false;
7258 7259
    }
    vshPrint(ctl, "%s", srcList);
7260
    VIR_FREE(srcList);
7261

E
Eric Blake 已提交
7262
    return true;
7263 7264 7265
}


7266 7267 7268
/*
 * "pool-info" command
 */
7269
static const vshCmdInfo info_pool_info[] = {
7270 7271
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
7272 7273 7274
    {NULL, NULL}
};

7275
static const vshCmdOptDef opts_pool_info[] = {
7276
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7277 7278 7279
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7280
static bool
7281
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
7282 7283 7284
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
7285 7286
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
7287
    bool ret = true;
7288 7289
    char uuid[VIR_UUID_STRING_BUFLEN];

7290
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7291
        return false;
7292 7293

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7294
        return false;
7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320

    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;
7321 7322 7323 7324
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
7325 7326
        }

7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342
        /* Check and display whether the pool is persistent or not */
        persistent = virStoragePoolIsPersistent(pool);
        vshDebug(ctl, 5, "Pool persistent flag value: %d\n", persistent);
        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);
        vshDebug(ctl, 5, "Pool autostart flag value: %d\n", autostart);
        if (autostart < 0)
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), _("no autostart"));
        else
            vshPrint(ctl, "%-15s %s\n", _("Autostart:"), autostart ? _("yes") : _("no"));

7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354
        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 已提交
7355
        ret = false;
7356 7357 7358 7359 7360 7361 7362 7363 7364 7365
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
7366
static const vshCmdInfo info_pool_name[] = {
7367
    {"help", N_("convert a pool UUID to pool name")},
7368
    {"desc", ""},
7369 7370 7371
    {NULL, NULL}
};

7372
static const vshCmdOptDef opts_pool_name[] = {
7373
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
7374 7375 7376
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7377
static bool
7378
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
7379 7380 7381
{
    virStoragePoolPtr pool;

7382
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7383
        return false;
7384
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7385
                                           VSH_BYUUID)))
E
Eric Blake 已提交
7386
        return false;
7387 7388 7389

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7390
    return true;
7391 7392 7393 7394 7395 7396
}


/*
 * "pool-start" command
 */
7397
static const vshCmdInfo info_pool_start[] = {
7398 7399
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
7400 7401 7402
    {NULL, NULL}
};

7403
static const vshCmdOptDef opts_pool_start[] = {
7404
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
7405 7406 7407
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7408
static bool
7409
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
7410 7411
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7412
    bool ret = true;
7413

7414
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7415
        return false;
7416

7417
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
7418
         return false;
7419 7420 7421 7422 7423

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
7424
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
7425
        ret = false;
7426
    }
L
Laine Stump 已提交
7427 7428

    virStoragePoolFree(pool);
7429 7430 7431 7432
    return ret;
}


7433 7434 7435
/*
 * "vol-create-as" command
 */
7436
static const vshCmdInfo info_vol_create_as[] = {
7437 7438
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
7439 7440 7441
    {NULL, NULL}
};

7442
static const vshCmdOptDef opts_vol_create_as[] = {
7443 7444 7445 7446 7447
    {"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")},
7448 7449
    {"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")},
7450 7451 7452 7453 7454 7455 7456 7457 7458 7459
    {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 已提交
7460
        /* Deliberate fallthrough cases here :-) */
7461 7462 7463
        switch (*end) {
        case 'T':
            *val *= 1024;
7464
            /* fallthrough */
7465 7466
        case 'G':
            *val *= 1024;
7467
            /* fallthrough */
7468 7469
        case 'M':
            *val *= 1024;
7470
            /* fallthrough */
7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
7484
static bool
7485
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
7486 7487 7488
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7489
    char *xml;
7490 7491
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
7492
    unsigned long long capacity, allocation = 0;
7493
    virBuffer buf = VIR_BUFFER_INITIALIZER;
7494

7495
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7496
        return false;
7497 7498 7499

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

7502
    if (vshCommandOptString(cmd, "name", &name) <= 0)
7503 7504
        goto cleanup;

7505
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
7506 7507
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
7508
        vshError(ctl, _("Malformed size %s"), capacityStr);
7509

7510 7511
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
7512
        vshError(ctl, _("Malformed size %s"), allocationStr);
7513

7514 7515 7516 7517 7518 7519 7520
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

7521

7522
    virBufferAddLit(&buf, "<volume>\n");
7523 7524
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
7525
    if (allocationStr)
7526
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
7527 7528

    if (format) {
7529
        virBufferAddLit(&buf, "  <target>\n");
7530
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
7531
        virBufferAddLit(&buf, "  </target>\n");
7532
    }
7533

7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566
    /* Convert the snapshot parameters into backingStore XML */
    if (snapshotStrVol) {
        /* Lookup snapshot backing volume.  Try the backing-vol
         *  parameter as a name */
        vshDebug(ctl, 5, "%s: Look up backing store volume '%s' as name\n",
                 cmd->def->name, snapshotStrVol);
        virStorageVolPtr snapVol = virStorageVolLookupByName(pool, snapshotStrVol);
        if (snapVol)
                vshDebug(ctl, 5, "%s: Backing store volume found using '%s' as name\n",
                         cmd->def->name, snapshotStrVol);

        if (snapVol == NULL) {
            /* Snapshot backing volume not found by name.  Try the
             *  backing-vol parameter as a key */
            vshDebug(ctl, 5, "%s: Look up backing store volume '%s' as key\n",
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByKey(ctl->conn, snapshotStrVol);
            if (snapVol)
                vshDebug(ctl, 5, "%s: Backing store volume found using '%s' as key\n",
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            /* Snapshot backing volume not found by key.  Try the
             *  backing-vol parameter as a path */
            vshDebug(ctl, 5, "%s: Look up backing store volume '%s' as path\n",
                     cmd->def->name, snapshotStrVol);
            snapVol = virStorageVolLookupByPath(ctl->conn, snapshotStrVol);
            if (snapVol)
                vshDebug(ctl, 5, "%s: Backing store volume found using '%s' as path\n",
                         cmd->def->name, snapshotStrVol);
        }
        if (snapVol == NULL) {
            vshError(ctl, _("failed to get vol '%s'"), snapshotStrVol);
E
Eric Blake 已提交
7567
            return false;
7568 7569 7570 7571 7572
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
7573
            return false;
7574 7575 7576 7577
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
7578
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
7579
        if (snapshotStrFormat)
7580
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
7581 7582 7583 7584 7585 7586 7587 7588
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

7590 7591
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7592
        return false;
7593 7594 7595
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
7596
    VIR_FREE(xml);
7597 7598 7599 7600 7601
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
7602
        return true;
7603
    } else {
7604
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
7605
        return false;
7606 7607 7608
    }

 cleanup:
7609
    virBufferFreeAndReset(&buf);
7610
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7611
    return false;
7612 7613 7614
}


7615 7616 7617
/*
 * "pool-undefine" command
 */
7618
static const vshCmdInfo info_pool_undefine[] = {
7619 7620
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
7621 7622 7623
    {NULL, NULL}
};

7624
static const vshCmdOptDef opts_pool_undefine[] = {
7625
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7626 7627 7628
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7629
static bool
7630
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
7631 7632
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7633
    bool ret = true;
7634
    const char *name;
7635

7636
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7637
        return false;
7638 7639

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7640
        return false;
7641 7642 7643 7644

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

L
Laine Stump 已提交
7649
    virStoragePoolFree(pool);
7650 7651 7652 7653 7654 7655 7656
    return ret;
}


/*
 * "pool-uuid" command
 */
7657
static const vshCmdInfo info_pool_uuid[] = {
7658
    {"help", N_("convert a pool name to pool UUID")},
7659
    {"desc", ""},
7660 7661 7662
    {NULL, NULL}
};

7663
static const vshCmdOptDef opts_pool_uuid[] = {
7664
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
7665 7666 7667
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7668
static bool
7669
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
7670 7671 7672 7673
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

7674
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7675
        return false;
7676 7677

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7678
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7679
        return false;
7680 7681 7682 7683

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

L
Laine Stump 已提交
7686
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7687
    return true;
7688 7689 7690 7691 7692 7693
}


/*
 * "vol-create" command
 */
7694
static const vshCmdInfo info_vol_create[] = {
7695 7696
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
7697 7698 7699
    {NULL, NULL}
};

7700
static const vshCmdOptDef opts_vol_create[] = {
7701 7702
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
7703 7704 7705
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7706
static bool
7707
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
7708 7709 7710
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7711
    const char *from = NULL;
E
Eric Blake 已提交
7712
    bool ret = true;
7713 7714
    char *buffer;

7715
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7716
        return false;
7717 7718

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

7722
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7723
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7724
        return false;
7725 7726 7727
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7728
        virshReportError(ctl);
7729
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7730
        return false;
7731 7732 7733
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
7734
    VIR_FREE(buffer);
7735 7736 7737 7738 7739 7740 7741
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
7742
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
7743
        ret = false;
7744 7745 7746 7747
    }
    return ret;
}

7748 7749 7750 7751
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
7752 7753
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
7754 7755 7756 7757
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
7758 7759 7760
    {"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 已提交
7761
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
7762 7763 7764
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7765
static bool
7766 7767 7768 7769
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
7770
    const char *from = NULL;
E
Eric Blake 已提交
7771
    bool ret = false;
7772 7773
    char *buffer = NULL;

7774
    if (!vshConnectionUsability(ctl, ctl->conn))
7775 7776 7777 7778 7779
        goto cleanup;

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

7780
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7781 7782 7783 7784 7785 7786 7787
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7788
        virshReportError(ctl);
7789 7790 7791 7792 7793 7794 7795 7796 7797
        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 {
7798
        vshError(ctl, _("Failed to create vol from %s"), from);
7799 7800 7801
        goto cleanup;
    }

E
Eric Blake 已提交
7802
    ret = true;
7803
cleanup:
7804
    VIR_FREE(buffer);
7805 7806 7807 7808
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
7809 7810
    if (newvol)
        virStorageVolFree(newvol);
7811 7812 7813 7814
    return ret;
}

static xmlChar *
7815
makeCloneXML(const char *origxml, const char *newname) {
7816

7817 7818 7819
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849
    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[] = {
7850 7851
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
7852 7853 7854 7855
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
7856 7857
    {"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 已提交
7858
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7859 7860 7861
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7862
static bool
7863 7864 7865 7866
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
7867
    const char *name = NULL;
7868
    char *origxml = NULL;
7869
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
7870
    bool ret = false;
7871

7872
    if (!vshConnectionUsability(ctl, ctl->conn))
7873 7874 7875 7876 7877 7878 7879
        goto cleanup;

    if (!(origvol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        goto cleanup;

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
7880
        vshError(ctl, "%s", _("failed to get parent pool"));
7881 7882 7883
        goto cleanup;
    }

7884
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902
        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 {
7903
        vshError(ctl, _("Failed to clone vol from %s"),
7904 7905 7906 7907
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
7908
    ret = true;
7909 7910

cleanup:
7911
    VIR_FREE(origxml);
7912 7913 7914
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
7915 7916
    if (newvol)
        virStorageVolFree(newvol);
7917 7918 7919 7920 7921
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934

/*
 * "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 已提交
7935
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949
    {"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 已提交
7950
static bool
7951 7952 7953 7954
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7955
    bool ret = false;
7956 7957 7958 7959 7960 7961 7962 7963 7964 7965
    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 已提交
7966
        return false;
7967 7968 7969 7970
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7971
        return false;
7972 7973 7974
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7975
        return false;
7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009
    }

    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 已提交
8010
    ret = true;
8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034

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 已提交
8035
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8036 8037 8038 8039 8040
    {"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 已提交
8041
static bool
8042 8043 8044 8045
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8046
    bool ret = false;
8047 8048 8049 8050
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
8051
    bool created = false;
8052 8053

    if (!vshConnectionUsability(ctl, ctl->conn))
8054
        return false;
8055 8056 8057

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8058
        return false;
8059 8060 8061 8062
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8063
        return false;
8064 8065 8066
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
8067
        return false;
8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079

    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;
        }
8080 8081
    } else {
        created = true;
8082 8083 8084 8085 8086 8087 8088 8089
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

8090
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105
        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 已提交
8106
    ret = true;
8107 8108

cleanup:
8109
    VIR_FORCE_CLOSE(fd);
8110
    if (!ret && created)
8111 8112 8113 8114 8115 8116 8117 8118 8119
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


8120 8121 8122
/*
 * "vol-delete" command
 */
8123
static const vshCmdInfo info_vol_delete[] = {
8124 8125
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
8126 8127 8128
    {NULL, NULL}
};

8129
static const vshCmdOptDef opts_vol_delete[] = {
8130
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8131
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8132 8133 8134
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8135
static bool
8136
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
8137 8138
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8139
    bool ret = true;
8140
    const char *name;
8141

8142
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8143
        return false;
8144 8145

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8146
        return false;
8147 8148 8149
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
8150
        vshPrint(ctl, _("Vol %s deleted\n"), name);
8151
    } else {
8152
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
8153
        ret = false;
8154 8155
    }

L
Laine Stump 已提交
8156
    virStorageVolFree(vol);
8157 8158 8159 8160
    return ret;
}


D
David Allan 已提交
8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171
/*
 * "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 已提交
8172
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
8173 8174 8175
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8176
static bool
D
David Allan 已提交
8177 8178 8179
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8180
    bool ret = true;
8181
    const char *name;
D
David Allan 已提交
8182

8183
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8184
        return false;
D
David Allan 已提交
8185 8186

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8187
        return false;
D
David Allan 已提交
8188 8189 8190 8191 8192 8193
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
8194
        ret = false;
D
David Allan 已提交
8195 8196 8197 8198 8199 8200 8201
    }

    virStorageVolFree(vol);
    return ret;
}


8202 8203 8204
/*
 * "vol-info" command
 */
8205
static const vshCmdInfo info_vol_info[] = {
8206 8207
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
8208 8209 8210
    {NULL, NULL}
};

8211
static const vshCmdOptDef opts_vol_info[] = {
8212
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8213
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8214 8215 8216
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8217
static bool
8218
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
8219 8220 8221
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
8222
    bool ret = true;
8223

8224
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8225
        return false;
8226 8227

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8228
        return false;
8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244

    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 已提交
8245
        ret = false;
8246 8247 8248 8249 8250 8251 8252 8253 8254 8255
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
8256
static const vshCmdInfo info_vol_dumpxml[] = {
8257 8258
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
8259 8260 8261
    {NULL, NULL}
};

8262
static const vshCmdOptDef opts_vol_dumpxml[] = {
8263
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8264
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8265 8266 8267
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8268
static bool
8269
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
8270 8271
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8272
    bool ret = true;
8273 8274
    char *dump;

8275
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8276
        return false;
8277 8278

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8279
        return false;
8280 8281 8282

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
8283
        vshPrint(ctl, "%s", dump);
8284
        VIR_FREE(dump);
8285
    } else {
E
Eric Blake 已提交
8286
        ret = false;
8287 8288 8289 8290 8291 8292 8293 8294 8295 8296
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
8297
static const vshCmdInfo info_vol_list[] = {
8298 8299
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
8300 8301 8302
    {NULL, NULL}
};

8303
static const vshCmdOptDef opts_vol_list[] = {
8304
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8305
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
8306 8307 8308
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8309
static bool
8310
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8311
{
8312
    virStorageVolInfo volumeInfo;
8313 8314
    virStoragePoolPtr pool;
    char **activeNames = NULL;
8315 8316 8317 8318 8319
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
8320 8321
    int ret;
    bool functionReturn;
8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332
    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;
8333

8334
    /* Check the connection to libvirtd daemon is still working */
8335
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8336
        return false;
8337

8338
    /* Look up the pool information given to us by the user */
8339
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8340
        return false;
8341

8342 8343
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
8344

8345 8346 8347
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8348
        return false;
8349 8350
    }

8351 8352 8353 8354 8355
    /* 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) {
8356
            vshError(ctl, "%s", _("Failed to list active vols"));
8357
            VIR_FREE(activeNames);
8358
            virStoragePoolFree(pool);
E
Eric Blake 已提交
8359
            return false;
8360 8361
        }

8362 8363 8364 8365 8366
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

        /* Set aside memory for volume information pointers */
        volInfoTexts = vshCalloc(ctl, numVolumes, sizeof(*volInfoTexts));
8367 8368
    }

8369 8370 8371 8372 8373
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
8374

8375 8376 8377 8378
        /* 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"));
8379 8380
        }

8381 8382 8383 8384 8385 8386 8387 8388 8389
        /* 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 */
8390

8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445
                /* 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;
        }
8446

8447
        /* Cleanup memory allocation */
8448
        virStorageVolFree(vol);
8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466
    }

    /* 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 已提交
8467
        functionReturn = true;
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 8493 8494 8495 8496 8497 8498
        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 */
C
Chris Lalancette 已提交
8499 8500 8501 8502 8503
    vshDebug(ctl, 5, "Longest name string = %zu chars\n", nameStrLength);
    vshDebug(ctl, 5, "Longest path string = %zu chars\n", pathStrLength);
    vshDebug(ctl, 5, "Longest type string = %zu chars\n", typeStrLength);
    vshDebug(ctl, 5, "Longest capacity string = %zu chars\n", capStrLength);
    vshDebug(ctl, 5, "Longest allocation string = %zu chars\n", allocStrLength);
8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537

    /* 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 已提交
8538
    functionReturn = true;
8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552
    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 已提交
8553
    functionReturn = false;
8554 8555 8556 8557 8558 8559 8560 8561 8562 8563

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);
8564
        VIR_FREE(activeNames[i]);
8565
    }
8566 8567 8568 8569

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
8570
    VIR_FREE(activeNames);
8571
    virStoragePoolFree(pool);
8572 8573 8574

    /* Return the desired value */
    return functionReturn;
8575 8576 8577 8578 8579 8580
}


/*
 * "vol-name" command
 */
8581
static const vshCmdInfo info_vol_name[] = {
8582
    {"help", N_("returns the volume name for a given volume key or path")},
8583
    {"desc", ""},
8584 8585 8586
    {NULL, NULL}
};

8587
static const vshCmdOptDef opts_vol_name[] = {
8588
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
8589 8590 8591
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8592
static bool
8593
cmdVolName(vshControl *ctl, const vshCmd *cmd)
8594 8595 8596
{
    virStorageVolPtr vol;

8597
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8598
        return false;
8599 8600 8601

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
E
Eric Blake 已提交
8602
        return false;
8603 8604 8605

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8606
    return true;
8607 8608 8609
}


J
Justin Clift 已提交
8610 8611 8612 8613 8614 8615 8616 8617 8618 8619
/*
 * "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[] = {
8620
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
8621 8622 8623 8624
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8625
static bool
J
Justin Clift 已提交
8626 8627 8628 8629
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8630
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
8631 8632

    /* Check the connection to libvirtd daemon is still working */
8633
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8634
        return false;
J
Justin Clift 已提交
8635 8636 8637 8638

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
8639
        return false;
J
Justin Clift 已提交
8640 8641 8642 8643 8644 8645 8646
    }

    /* 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 已提交
8647
        return false;
J
Justin Clift 已提交
8648 8649
    }

8650 8651 8652 8653 8654 8655 8656 8657 8658
    /* 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 已提交
8659 8660 8661 8662

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8663
    return true;
J
Justin Clift 已提交
8664 8665
}

8666 8667 8668 8669

/*
 * "vol-key" command
 */
8670
static const vshCmdInfo info_vol_key[] = {
8671
    {"help", N_("returns the volume key for a given volume name or path")},
8672
    {"desc", ""},
8673 8674 8675
    {NULL, NULL}
};

8676
static const vshCmdOptDef opts_vol_key[] = {
8677
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
8678
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8679 8680 8681
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8682
static bool
8683
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
8684 8685 8686
{
    virStorageVolPtr vol;

8687
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8688
        return false;
8689

8690
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8691
        return false;
8692 8693 8694

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8695
    return true;
8696 8697 8698 8699 8700 8701 8702
}



/*
 * "vol-path" command
 */
8703
static const vshCmdInfo info_vol_path[] = {
8704
    {"help", N_("returns the volume path for a given volume name or key")},
8705
    {"desc", ""},
8706 8707 8708
    {NULL, NULL}
};

8709
static const vshCmdOptDef opts_vol_path[] = {
8710
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
8711
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8712 8713 8714
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8715
static bool
8716
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
8717 8718
{
    virStorageVolPtr vol;
8719
    const char *name = NULL;
8720

8721
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8722
        return false;
8723 8724

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8725
        return false;
8726
    }
8727 8728 8729

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8730
    return true;
8731 8732 8733
}


8734 8735 8736 8737
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
8738 8739
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
8740 8741
    {NULL, NULL}
};
8742

8743
static const vshCmdOptDef opts_secret_define[] = {
8744
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
8745 8746
    {NULL, 0, 0, NULL}
};
8747

E
Eric Blake 已提交
8748
static bool
8749 8750
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
8751
    const char *from = NULL;
8752
    char *buffer;
8753
    virSecretPtr res;
8754
    char uuid[VIR_UUID_STRING_BUFLEN];
8755

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

8759
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8760
        return false;
8761 8762

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
8766
    VIR_FREE(buffer);
8767 8768

    if (res == NULL) {
8769
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
8770
        return false;
8771
    }
8772
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
8773
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
8774
        virSecretFree(res);
E
Eric Blake 已提交
8775
        return false;
8776 8777 8778
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
8779
    return true;
8780 8781 8782 8783 8784 8785
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
8786 8787
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
8788 8789 8790 8791
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
8792
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8793 8794 8795
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8796
static bool
8797 8798 8799
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8800
    bool ret = false;
8801 8802
    char *xml;

8803
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8804
        return false;
8805 8806 8807

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8808
        return false;
8809 8810 8811 8812

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
8813
    vshPrint(ctl, "%s", xml);
8814
    VIR_FREE(xml);
E
Eric Blake 已提交
8815
    ret = true;
8816 8817 8818 8819 8820 8821 8822 8823 8824 8825

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
8826 8827
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
8828 8829 8830 8831
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
8832 8833
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
8834 8835 8836
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8837
static bool
8838 8839 8840 8841
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
8842
    const char *base64 = NULL;
8843
    char *value;
E
Eric Blake 已提交
8844 8845
    int res;
    bool ret = false;
8846

8847
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8848
        return false;
8849 8850 8851

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8852
        return false;
8853

8854
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
8855 8856 8857
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
8858
        vshError(ctl, "%s", _("Invalid base64 data"));
8859 8860 8861
        goto cleanup;
    }
    if (value == NULL) {
8862
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
8863
        return false;
8864 8865 8866 8867
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
8868
    VIR_FREE(value);
8869 8870

    if (res != 0) {
8871
        vshError(ctl, "%s", _("Failed to set secret value"));
8872 8873 8874
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
8875
    ret = true;
8876 8877 8878 8879 8880 8881 8882 8883 8884 8885

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
8886 8887
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
8888 8889 8890 8891
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
8892
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8893 8894 8895
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8896
static bool
8897 8898 8899 8900 8901 8902
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
8903
    bool ret = false;
8904

8905
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8906
        return false;
8907 8908 8909

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8910
        return false;
8911 8912 8913 8914 8915 8916 8917

    value = virSecretGetValue(secret, &value_size, 0);
    if (value == NULL)
        goto cleanup;

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
8918
    VIR_FREE(value);
8919 8920

    if (base64 == NULL) {
8921
        vshError(ctl, "%s", _("Failed to allocate memory"));
8922 8923
        goto cleanup;
    }
8924
    vshPrint(ctl, "%s", base64);
8925
    memset(base64, 0, strlen(base64));
8926
    VIR_FREE(base64);
E
Eric Blake 已提交
8927
    ret = true;
8928 8929 8930 8931 8932 8933 8934 8935 8936 8937

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
8938 8939
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
8940 8941 8942 8943
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
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
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8952
    bool ret = false;
8953
    const char *uuid;
8954

8955
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8956
        return false;
8957 8958 8959

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
8960
        return false;
8961 8962

    if (virSecretUndefine(secret) < 0) {
8963
        vshError(ctl, _("Failed to delete secret %s"), uuid);
8964 8965 8966
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
8967
    ret = true;
8968 8969 8970 8971 8972 8973 8974 8975 8976 8977

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
8978 8979
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
8980 8981 8982
    {NULL, NULL}
};

E
Eric Blake 已提交
8983
static bool
8984 8985 8986 8987 8988
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

8989
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8990
        return false;
8991 8992 8993

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
8994
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
8995
        return false;
8996 8997 8998 8999 9000
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
9001
        vshError(ctl, "%s", _("Failed to list secrets"));
9002
        VIR_FREE(uuids);
E
Eric Blake 已提交
9003
        return false;
9004 9005 9006 9007
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

9008 9009
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
9010 9011

    for (i = 0; i < maxuuids; i++) {
9012 9013 9014 9015
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
9016
            VIR_FREE(uuids[i]);
9017 9018 9019 9020 9021 9022 9023 9024 9025 9026 9027 9028 9029 9030 9031 9032 9033 9034
            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);
9035
        VIR_FREE(uuids[i]);
9036
    }
9037
    VIR_FREE(uuids);
E
Eric Blake 已提交
9038
    return true;
9039
}
9040 9041 9042 9043 9044


/*
 * "version" command
 */
9045
static const vshCmdInfo info_version[] = {
9046 9047
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
9048 9049 9050
    {NULL, NULL}
};

9051 9052 9053 9054
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
9055

E
Eric Blake 已提交
9056
static bool
9057
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9058 9059 9060 9061 9062 9063
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
9064
    unsigned long daemonVersion;
9065 9066 9067 9068 9069
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

9070
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9071
        return false;
9072 9073 9074

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
9075
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
9076
        return false;
9077 9078 9079 9080 9081 9082 9083 9084 9085 9086 9087 9088
    }

    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) {
9089
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
9090
        return false;
9091 9092 9093 9094 9095 9096 9097 9098 9099 9100 9101 9102 9103 9104 9105 9106 9107
    }
    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) {
9108
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
9109
        return false;
9110 9111 9112 9113 9114 9115 9116 9117 9118 9119 9120 9121 9122
    }
    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);
    }
9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137

    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 已提交
9138
    return true;
9139 9140
}

9141 9142 9143 9144
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
9145
    {"help", N_("enumerate devices on this host")},
9146
    {"desc", ""},
9147 9148 9149 9150
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
9151 9152
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
9153 9154 9155
    {NULL, 0, 0, NULL}
};

9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177
#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] = '-';
9178 9179
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
9180 9181 9182
    }

    /* Print this device */
9183
    vshPrint(ctl, "%s", indentBuf);
9184 9185 9186 9187 9188 9189 9190 9191 9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206
    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) {
9207
        vshPrint(ctl, "%s", indentBuf);
9208
        vshPrint(ctl, " |\n");
9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230
    }

    /* 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) {
9231
        vshPrint(ctl, "%s", indentBuf);
9232 9233 9234 9235
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
9236
static bool
9237 9238
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
9239
    const char *cap = NULL;
9240
    char **devices;
9241
    int num_devices, i;
9242
    int tree = vshCommandOptBool(cmd, "tree");
9243

9244
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9245
        return false;
9246

9247
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
9248 9249 9250 9251
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
9252
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
9253
        return false;
9254
    } else if (num_devices == 0) {
E
Eric Blake 已提交
9255
        return true;
9256 9257 9258 9259 9260 9261
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
9262
        vshError(ctl, "%s", _("Failed to list node devices"));
9263
        VIR_FREE(devices);
E
Eric Blake 已提交
9264
        return false;
9265
    }
9266
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
9267 9268 9269 9270 9271 9272 9273
    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 已提交
9274
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293
            } 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++) {
9294 9295
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
9296
        }
9297
        VIR_FREE(parents);
9298 9299 9300
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
9301
            VIR_FREE(devices[i]);
9302
        }
9303
    }
9304
    VIR_FREE(devices);
E
Eric Blake 已提交
9305
    return true;
9306 9307 9308 9309 9310 9311
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
9312 9313
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
9314 9315 9316 9317 9318
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
9319
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9320 9321 9322
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9323
static bool
9324 9325
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
9326
    const char *name = NULL;
9327
    virNodeDevicePtr device;
L
Laine Stump 已提交
9328
    char *xml;
9329

9330
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9331
        return false;
9332
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9333
        return false;
9334
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9335
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9336
        return false;
9337 9338
    }

L
Laine Stump 已提交
9339 9340 9341
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
9342
        return false;
L
Laine Stump 已提交
9343 9344 9345
    }

    vshPrint(ctl, "%s\n", xml);
9346
    VIR_FREE(xml);
9347
    virNodeDeviceFree(device);
E
Eric Blake 已提交
9348
    return true;
9349 9350
}

9351 9352 9353 9354
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
9355 9356
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
9357 9358 9359 9360 9361
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
9362
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9363 9364 9365
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9366
static bool
9367 9368
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
9369
    const char *name = NULL;
9370
    virNodeDevicePtr device;
E
Eric Blake 已提交
9371
    bool ret = true;
9372

9373
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9374
        return false;
9375
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9376
        return false;
9377
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9378
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9379
        return false;
9380 9381 9382 9383 9384
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
9385
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
9386
        ret = false;
9387 9388 9389 9390 9391 9392 9393 9394 9395
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
9396 9397
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
9398 9399 9400 9401 9402
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
9403
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9404 9405 9406
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9407
static bool
9408 9409
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
9410
    const char *name = NULL;
9411
    virNodeDevicePtr device;
E
Eric Blake 已提交
9412
    bool ret = true;
9413

9414
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9415
        return false;
9416
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9417
        return false;
9418
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9419
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9420
        return false;
9421 9422 9423 9424 9425
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
9426
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
9427
        ret = false;
9428 9429 9430 9431 9432 9433 9434 9435 9436
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
9437 9438
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
9439 9440 9441 9442 9443
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
9444
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9445 9446 9447
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9448
static bool
9449 9450
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
9451
    const char *name = NULL;
9452
    virNodeDevicePtr device;
E
Eric Blake 已提交
9453
    bool ret = true;
9454

9455
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9456
        return false;
9457
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9458
        return false;
9459
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9460
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9461
        return false;
9462 9463 9464 9465 9466
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
9467
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
9468
        ret = false;
9469 9470 9471 9472 9473
    }
    virNodeDeviceFree(device);
    return ret;
}

9474
/*
E
Eric Blake 已提交
9475
 * "hostname" command
9476
 */
9477
static const vshCmdInfo info_hostname[] = {
9478
    {"help", N_("print the hypervisor hostname")},
9479
    {"desc", ""},
9480 9481 9482
    {NULL, NULL}
};

E
Eric Blake 已提交
9483
static bool
9484
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9485 9486 9487
{
    char *hostname;

9488
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9489
        return false;
9490 9491 9492

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
9493
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
9494
        return false;
9495 9496 9497
    }

    vshPrint (ctl, "%s\n", hostname);
9498
    VIR_FREE(hostname);
9499

E
Eric Blake 已提交
9500
    return true;
9501 9502 9503 9504 9505
}

/*
 * "uri" command
 */
9506
static const vshCmdInfo info_uri[] = {
9507
    {"help", N_("print the hypervisor canonical URI")},
9508
    {"desc", ""},
9509 9510 9511
    {NULL, NULL}
};

E
Eric Blake 已提交
9512
static bool
9513
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9514 9515 9516
{
    char *uri;

9517
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9518
        return false;
9519 9520 9521

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
9522
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
9523
        return false;
9524 9525 9526
    }

    vshPrint (ctl, "%s\n", uri);
9527
    VIR_FREE(uri);
9528

E
Eric Blake 已提交
9529
    return true;
9530 9531
}

E
Eric Blake 已提交
9532 9533 9534 9535 9536 9537 9538 9539 9540 9541
/*
 * "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 已提交
9542
static bool
E
Eric Blake 已提交
9543 9544 9545 9546 9547
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9548
        return false;
E
Eric Blake 已提交
9549 9550 9551 9552

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
9553
        return false;
E
Eric Blake 已提交
9554 9555 9556 9557 9558
    }

    vshPrint (ctl, "%s", sysinfo);
    VIR_FREE(sysinfo);

E
Eric Blake 已提交
9559
    return true;
E
Eric Blake 已提交
9560 9561
}

9562 9563 9564
/*
 * "vncdisplay" command
 */
9565
static const vshCmdInfo info_vncdisplay[] = {
9566 9567
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
9568 9569 9570
    {NULL, NULL}
};

9571
static const vshCmdOptDef opts_vncdisplay[] = {
9572
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9573 9574 9575
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9576
static bool
9577
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
9578 9579 9580 9581 9582
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9583
    bool ret = false;
9584 9585 9586
    int port = 0;
    char *doc;

9587
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9588
        return false;
9589

J
Jim Meyering 已提交
9590
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9591
        return false;
9592 9593 9594 9595 9596 9597 9598 9599

    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);
9600
    VIR_FREE(doc);
9601 9602 9603 9604 9605 9606 9607 9608 9609 9610 9611 9612 9613 9614 9615 9616 9617 9618
    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) ||
9619
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
9620 9621 9622 9623 9624 9625
        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 已提交
9626
    ret = true;
9627 9628 9629 9630 9631 9632 9633 9634 9635 9636 9637 9638 9639

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
9640
static const vshCmdInfo info_ttyconsole[] = {
9641 9642
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
9643 9644 9645
    {NULL, NULL}
};

9646
static const vshCmdOptDef opts_ttyconsole[] = {
9647
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9648 9649 9650
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9651
static bool
9652
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
9653 9654 9655 9656 9657
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9658
    bool ret = false;
9659 9660
    char *doc;

9661
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9662
        return false;
9663

J
Jim Meyering 已提交
9664
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9665
        return false;
9666 9667 9668 9669 9670 9671 9672 9673

    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);
9674
    VIR_FREE(doc);
9675 9676 9677 9678 9679 9680 9681 9682 9683 9684 9685 9686
    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 已提交
9687
    ret = true;
9688 9689 9690 9691 9692 9693 9694 9695 9696 9697 9698 9699

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
9700
 */
9701
static const vshCmdInfo info_attach_device[] = {
9702 9703
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
9704 9705 9706
    {NULL, NULL}
};

9707
static const vshCmdOptDef opts_attach_device[] = {
9708 9709 9710
    {"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")},
9711 9712 9713
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9714
static bool
9715
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
9716 9717
{
    virDomainPtr dom;
9718
    const char *from = NULL;
9719
    char *buffer;
W
Wen Congyang 已提交
9720
    int ret;
J
Jim Fehlig 已提交
9721
    unsigned int flags;
9722

9723
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9724
        return false;
9725

J
Jim Meyering 已提交
9726
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9727
        return false;
9728

9729
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9730
        virDomainFree(dom);
E
Eric Blake 已提交
9731
        return false;
9732 9733
    }

9734
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9735
        virshReportError(ctl);
9736
        virDomainFree(dom);
E
Eric Blake 已提交
9737
        return false;
9738
    }
9739

J
Jim Fehlig 已提交
9740
    if (vshCommandOptBool(cmd, "persistent")) {
9741
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
9742
        if (virDomainIsActive(dom) == 1)
9743
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
9744 9745 9746 9747
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
9748
    VIR_FREE(buffer);
9749 9750

    if (ret < 0) {
9751
        vshError(ctl, _("Failed to attach device from %s"), from);
9752
        virDomainFree(dom);
E
Eric Blake 已提交
9753
        return false;
9754
    } else {
J
Jim Meyering 已提交
9755
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
9756 9757 9758
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9759
    return true;
9760 9761 9762 9763 9764 9765
}


/*
 * "detach-device" command
 */
9766
static const vshCmdInfo info_detach_device[] = {
9767 9768
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
9769 9770 9771
    {NULL, NULL}
};

9772
static const vshCmdOptDef opts_detach_device[] = {
9773 9774 9775
    {"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")},
9776 9777 9778
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9779
static bool
9780
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
9781 9782
{
    virDomainPtr dom;
9783
    const char *from = NULL;
9784
    char *buffer;
W
Wen Congyang 已提交
9785
    int ret;
J
Jim Fehlig 已提交
9786
    unsigned int flags;
9787

9788
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9789
        return false;
9790

J
Jim Meyering 已提交
9791
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9792
        return false;
9793

9794
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9795
        virDomainFree(dom);
E
Eric Blake 已提交
9796
        return false;
9797 9798
    }

9799
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9800
        virshReportError(ctl);
9801
        virDomainFree(dom);
E
Eric Blake 已提交
9802
        return false;
9803
    }
9804

J
Jim Fehlig 已提交
9805
    if (vshCommandOptBool(cmd, "persistent")) {
9806
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
9807
        if (virDomainIsActive(dom) == 1)
9808
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
9809 9810 9811 9812
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
9813
    VIR_FREE(buffer);
9814 9815

    if (ret < 0) {
9816
        vshError(ctl, _("Failed to detach device from %s"), from);
9817
        virDomainFree(dom);
E
Eric Blake 已提交
9818
        return false;
9819
    } else {
J
Jim Meyering 已提交
9820
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
9821 9822 9823
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9824
    return true;
9825 9826
}

9827

9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840
/*
 * "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")},
9841
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
9842 9843 9844
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9845
static bool
9846 9847 9848
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
9849
    const char *from = NULL;
9850
    char *buffer;
W
Wen Congyang 已提交
9851
    int ret;
9852 9853
    unsigned int flags;

9854
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9855
        return false;
9856 9857

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

9860
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9861
        virDomainFree(dom);
E
Eric Blake 已提交
9862
        return false;
9863 9864 9865
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9866
        virshReportError(ctl);
9867
        virDomainFree(dom);
E
Eric Blake 已提交
9868
        return false;
9869 9870 9871
    }

    if (vshCommandOptBool(cmd, "persistent")) {
9872
        flags = VIR_DOMAIN_AFFECT_CONFIG;
9873
        if (virDomainIsActive(dom) == 1)
9874
           flags |= VIR_DOMAIN_AFFECT_LIVE;
9875
    } else {
9876
        flags = VIR_DOMAIN_AFFECT_LIVE;
9877
    }
9878 9879 9880 9881

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

9882 9883 9884 9885 9886 9887
    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 已提交
9888
        return false;
9889 9890 9891 9892 9893
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9894
    return true;
9895 9896 9897
}


9898 9899 9900
/*
 * "attach-interface" command
 */
9901
static const vshCmdInfo info_attach_interface[] = {
9902 9903
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
9904 9905 9906
    {NULL, NULL}
};

9907
static const vshCmdOptDef opts_attach_interface[] = {
9908 9909 9910 9911 9912 9913
    {"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")},
9914
    {"model", VSH_OT_DATA, 0, N_("model type")},
9915
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
9916 9917 9918
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9919
static bool
9920
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
9921 9922
{
    virDomainPtr dom = NULL;
9923 9924
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
9925
    int typ;
W
Wen Congyang 已提交
9926 9927
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9928
    unsigned int flags;
9929 9930
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9931

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

J
Jim Meyering 已提交
9935
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9936 9937
        goto cleanup;

9938
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9939 9940
        goto cleanup;

9941 9942 9943 9944
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
9945 9946
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
9947
        goto cleanup;
9948
    }
9949 9950

    /* check interface type */
9951
    if (STREQ(type, "network")) {
9952
        typ = 1;
9953
    } else if (STREQ(type, "bridge")) {
9954 9955
        typ = 2;
    } else {
E
Eric Blake 已提交
9956 9957
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
9958 9959 9960 9961
        goto cleanup;
    }

    /* Make XML of interface */
9962
    virBufferAsprintf(&buf, "<interface type='%s'>\n", type);
9963

9964
    if (typ == 1)
9965
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
9966
    else if (typ == 2)
9967
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
9968

9969
    if (target != NULL)
9970
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9971
    if (mac != NULL)
9972
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
9973
    if (script != NULL)
9974
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
9975
    if (model != NULL)
9976
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
9977

9978
    virBufferAddLit(&buf, "</interface>\n");
9979

9980 9981
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
9982
        goto cleanup;
9983 9984
    }

9985
    xml = virBufferContentAndReset(&buf);
9986

J
Jim Fehlig 已提交
9987
    if (vshCommandOptBool(cmd, "persistent")) {
9988
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
9989
        if (virDomainIsActive(dom) == 1)
9990
            flags |= VIR_DOMAIN_AFFECT_LIVE;
9991
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
9992
    } else {
9993
        ret = virDomainAttachDevice(dom, xml);
9994
    }
9995

9996 9997
    VIR_FREE(xml);

J
Jim Fehlig 已提交
9998
    if (ret != 0) {
L
Laine Stump 已提交
9999
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
10000 10001
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
10002
        functionReturn = true;
J
Jim Fehlig 已提交
10003
    }
10004 10005 10006 10007

 cleanup:
    if (dom)
        virDomainFree(dom);
10008
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10009
    return functionReturn;
10010 10011 10012 10013 10014
}

/*
 * "detach-interface" command
 */
10015
static const vshCmdInfo info_detach_interface[] = {
10016 10017
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
10018 10019 10020
    {NULL, NULL}
};

10021
static const vshCmdOptDef opts_detach_interface[] = {
10022 10023 10024 10025
    {"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")},
10026 10027 10028
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10029
static bool
10030
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
10031 10032 10033 10034 10035 10036 10037
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
10038
    const char *mac =NULL, *type = NULL;
10039
    char *doc;
10040
    char buf[64];
E
Eric Blake 已提交
10041
    int i = 0, diff_mac;
W
Wen Congyang 已提交
10042 10043
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
10044
    unsigned int flags;
10045

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

J
Jim Meyering 已提交
10049
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10050 10051
        goto cleanup;

10052
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10053 10054
        goto cleanup;

10055 10056
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
10057
        goto cleanup;
10058
    }
10059 10060 10061 10062 10063 10064 10065 10066

    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);
10067
    VIR_FREE(doc);
10068
    if (!xml) {
10069
        vshError(ctl, "%s", _("Failed to get interface information"));
10070 10071 10072 10073
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
10074
        vshError(ctl, "%s", _("Failed to get interface information"));
10075 10076 10077
        goto cleanup;
    }

E
Eric Blake 已提交
10078
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
10079 10080 10081
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10082
        vshError(ctl, _("No found interface whose type is %s"), type);
10083 10084 10085
        goto cleanup;
    }

10086 10087 10088 10089 10090 10091
    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;
    }

10092 10093 10094 10095 10096 10097 10098
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10099 10100 10101 10102 10103
            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);
10104 10105 10106 10107 10108 10109 10110
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10111
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
10112 10113 10114 10115 10116
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10117
        vshError(ctl, "%s", _("Failed to allocate memory"));
10118 10119 10120
        goto cleanup;
    }

10121
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
10122
        vshError(ctl, "%s", _("Failed to create XML"));
10123 10124 10125
        goto cleanup;
    }

J
Jim Fehlig 已提交
10126
    if (vshCommandOptBool(cmd, "persistent")) {
10127
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10128
        if (virDomainIsActive(dom) == 1)
10129
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10130 10131 10132 10133 10134 10135 10136 10137
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10138
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
10139
    } else {
J
Jim Meyering 已提交
10140
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
10141
        functionReturn = true;
10142
    }
10143 10144 10145 10146

 cleanup:
    if (dom)
        virDomainFree(dom);
10147
    xmlXPathFreeObject(obj);
10148
    xmlXPathFreeContext(ctxt);
10149 10150 10151 10152
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
10153
    return functionReturn;
10154 10155 10156 10157 10158
}

/*
 * "attach-disk" command
 */
10159
static const vshCmdInfo info_attach_disk[] = {
10160 10161
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
10162 10163 10164
    {NULL, NULL}
};

10165
static const vshCmdOptDef opts_attach_disk[] = {
10166 10167 10168 10169 10170 10171 10172 10173
    {"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")},
    {"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")},
10174
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
10175 10176 10177
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10178
static bool
10179
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
10180 10181
{
    virDomainPtr dom = NULL;
10182 10183
    const char *source = NULL, *target = NULL, *driver = NULL,
                *subdriver = NULL, *type = NULL, *mode = NULL;
W
Wen Congyang 已提交
10184 10185
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
10186
    unsigned int flags;
10187
    const char *stype = NULL;
10188 10189
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10190

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

J
Jim Meyering 已提交
10194
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10195 10196
        goto cleanup;

10197
    if (vshCommandOptString(cmd, "source", &source) <= 0)
10198 10199
        goto cleanup;

10200
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10201 10202
        goto cleanup;

10203 10204 10205 10206 10207
    if (vshCommandOptString(cmd, "driver", &driver) < 0 ||
        vshCommandOptString(cmd, "subdriver", &subdriver) < 0 ||
        vshCommandOptString(cmd, "type", &type) < 0 ||
        vshCommandOptString(cmd, "mode", &mode) < 0 ||
        vshCommandOptString(cmd, "sourcetype", &stype) < 0) {
10208
        vshError(ctl, "%s", _("missing option"));
10209 10210
        goto cleanup;
    }
10211

10212 10213
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
10214
            isFile = true;
10215
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
10216
        isFile = true;
10217 10218 10219
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
10220 10221 10222
    }

    if (mode) {
10223
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
10224 10225
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
10226 10227 10228 10229 10230
            goto cleanup;
        }
    }

    /* Make XML of disk */
10231
    virBufferAsprintf(&buf, "<disk type='%s'",
10232 10233
                      (isFile) ? "file" : "block");
    if (type)
10234
        virBufferAsprintf(&buf, " device='%s'", type);
10235 10236
    virBufferAddLit(&buf, ">\n");

10237
    if (driver || subdriver)
10238
        virBufferAsprintf(&buf, "  <driver");
10239 10240

    if (driver)
10241
        virBufferAsprintf(&buf, " name='%s'", driver);
10242
    if (subdriver)
10243
        virBufferAsprintf(&buf, " type='%s'", subdriver);
10244 10245 10246

    if (driver || subdriver)
        virBufferAddLit(&buf, "/>\n");
10247

10248
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
10249 10250
                      (isFile) ? "file" : "dev",
                      source);
10251
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10252
    if (mode)
10253
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
10254 10255

    virBufferAddLit(&buf, "</disk>\n");
10256

10257 10258
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
10259
        return false;
10260 10261
    }

10262
    xml = virBufferContentAndReset(&buf);
10263

J
Jim Fehlig 已提交
10264
    if (vshCommandOptBool(cmd, "persistent")) {
10265
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10266
        if (virDomainIsActive(dom) == 1)
10267
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10268
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
10269
    } else {
10270
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
10271
    }
10272

10273 10274
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10275
    if (ret != 0) {
L
Laine Stump 已提交
10276
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
10277 10278
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
10279
        functionReturn = true;
J
Jim Fehlig 已提交
10280
    }
10281 10282 10283 10284

 cleanup:
    if (dom)
        virDomainFree(dom);
10285
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10286
    return functionReturn;
10287 10288 10289 10290 10291
}

/*
 * "detach-disk" command
 */
10292
static const vshCmdInfo info_detach_disk[] = {
10293 10294
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
10295 10296 10297
    {NULL, NULL}
};

10298
static const vshCmdOptDef opts_detach_disk[] = {
10299 10300 10301
    {"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")},
10302 10303 10304
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10305
static bool
10306
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
10307 10308 10309 10310 10311 10312 10313
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
10314
    const char *target = NULL;
10315
    char *doc;
E
Eric Blake 已提交
10316
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
10317 10318
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
10319
    unsigned int flags;
10320

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

J
Jim Meyering 已提交
10324
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10325 10326
        goto cleanup;

10327
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10328 10329 10330 10331 10332 10333 10334 10335 10336
        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);
10337
    VIR_FREE(doc);
10338
    if (!xml) {
10339
        vshError(ctl, "%s", _("Failed to get disk information"));
10340 10341 10342 10343
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
10344
        vshError(ctl, "%s", _("Failed to get disk information"));
10345 10346 10347 10348 10349 10350
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10351
        vshError(ctl, "%s", _("Failed to get disk information"));
10352 10353 10354 10355 10356 10357 10358
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10359 10360 10361 10362 10363
            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);
10364 10365 10366 10367 10368 10369 10370
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10371
    vshError(ctl, _("No found disk whose target is %s"), target);
10372 10373 10374 10375 10376
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10377
        vshError(ctl, "%s", _("Failed to allocate memory"));
10378 10379 10380
        goto cleanup;
    }

10381
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
10382
        vshError(ctl, "%s", _("Failed to create XML"));
10383 10384 10385
        goto cleanup;
    }

J
Jim Fehlig 已提交
10386
    if (vshCommandOptBool(cmd, "persistent")) {
10387
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10388
        if (virDomainIsActive(dom) == 1)
10389
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10390 10391 10392 10393 10394 10395 10396 10397
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10398
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
10399
    } else {
J
Jim Meyering 已提交
10400
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
10401
        functionReturn = true;
10402
    }
10403 10404

 cleanup:
10405
    xmlXPathFreeObject(obj);
10406
    xmlXPathFreeContext(ctxt);
10407 10408 10409 10410 10411 10412
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
10413
    return functionReturn;
10414 10415
}

10416 10417 10418 10419
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
10420 10421
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
10422 10423 10424 10425
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
10426
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
10427 10428 10429
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10430
static bool
10431 10432
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
10433
    const char *from = NULL;
E
Eric Blake 已提交
10434
    bool ret = true;
10435 10436 10437
    char *buffer;
    int result;

10438
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10439
        return false;
10440

10441
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10442
        return false;
10443 10444

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
10448
    VIR_FREE(buffer);
10449 10450 10451 10452 10453

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
10454
        ret = false;
10455 10456 10457 10458 10459
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
10460
        ret = true;
10461 10462 10463 10464 10465
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
10466
        ret = true;
10467 10468 10469 10470 10471
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
10472
        ret = false;
10473 10474 10475 10476 10477
    }

    return ret;
}

10478 10479 10480 10481
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
10482 10483
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
10484 10485 10486 10487
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
10488
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
10489 10490 10491
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10492
static bool
10493 10494
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
10495
    const char *from = NULL;
E
Eric Blake 已提交
10496
    bool ret = true;
10497 10498 10499 10500 10501
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
10502
    xmlNodePtr node_list;
10503 10504 10505 10506 10507 10508
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

10509
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10510
        return false;
10511

10512
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10513
        return false;
10514 10515

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
10516
        return false;
10517 10518 10519 10520 10521

    doc = xmlNewDoc(NULL);
    if (doc == NULL)
        goto no_memory;

L
Laine Stump 已提交
10522 10523
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
10524 10525
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
10526
        ret = false;
10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562
        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 已提交
10563
        ret = false;
10564 10565 10566 10567 10568 10569 10570 10571
        goto cleanup;
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
10572
        ret = false;
10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589

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 已提交
10590
    ret = false;
10591
    goto cleanup;
10592 10593
}

10594 10595 10596 10597 10598 10599 10600 10601
/* 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;

10602
    ret = vshMalloc(ctl, PATH_MAX);
10603 10604 10605

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
10606 10607
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
10608
    if (fd == -1) {
10609
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
10610
                 strerror(errno));
10611
        VIR_FREE(ret);
10612 10613 10614 10615
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
10616 10617
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
10618
        VIR_FORCE_CLOSE(fd);
10619
        unlink (ret);
10620
        VIR_FREE(ret);
10621 10622
        return NULL;
    }
S
Stefan Berger 已提交
10623
    if (VIR_CLOSE(fd) < 0) {
10624 10625
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
10626
        unlink (ret);
10627
        VIR_FREE(ret);
10628 10629 10630 10631 10632 10633 10634 10635 10636 10637 10638 10639 10640 10641 10642
        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 已提交
10643 10644 10645 10646
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
10647

10648
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
10649 10650 10651 10652
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
10653

10654 10655 10656 10657 10658
    /* 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 已提交
10659 10660
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
10661
     */
E
Eric Blake 已提交
10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673
    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);
10674 10675
    }

E
Eric Blake 已提交
10676 10677 10678 10679 10680 10681 10682
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
10683
    }
E
Eric Blake 已提交
10684
    ret = 0;
10685

E
Eric Blake 已提交
10686 10687 10688
cleanup:
    virCommandFree(cmd);
    return ret;
10689 10690 10691 10692 10693 10694 10695 10696
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
10697
        vshError(ctl,
10698
                 _("%s: failed to read temporary file: %s"),
10699
                 filename, strerror(errno));
10700 10701 10702 10703 10704
        return NULL;
    }
    return ret;
}

10705

P
Paolo Bonzini 已提交
10706 10707 10708 10709
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
10710 10711
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
10712 10713 10714 10715
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
10716
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
10717 10718 10719
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10720
static bool
10721
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
10722
{
10723
    const char *dir = NULL;
10724
    char *dir_malloced = NULL;
E
Eric Blake 已提交
10725
    bool ret = true;
P
Paolo Bonzini 已提交
10726 10727

    if (!ctl->imode) {
10728
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
10729
        return false;
P
Paolo Bonzini 已提交
10730 10731
    }

10732
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
10733
        uid_t uid = geteuid();
10734
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
10735 10736 10737 10738
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
10739
    if (chdir(dir) == -1) {
10740
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
10741
        ret = false;
P
Paolo Bonzini 已提交
10742 10743
    }

10744
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
10745
    return ret;
P
Paolo Bonzini 已提交
10746 10747 10748 10749 10750 10751
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
10752 10753
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
10754 10755 10756
    {NULL, NULL}
};

E
Eric Blake 已提交
10757
static bool
P
Paolo Bonzini 已提交
10758 10759 10760
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
10761
    bool ret = true;
P
Paolo Bonzini 已提交
10762

10763 10764
    cwd = getcwd(NULL, 0);
    if (!cwd) {
10765 10766
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
10767 10768
        ret = false;
    } else {
P
Paolo Bonzini 已提交
10769
        vshPrint (ctl, _("%s\n"), cwd);
10770 10771
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
10772

10773
    return ret;
P
Paolo Bonzini 已提交
10774 10775
}

E
Eric Blake 已提交
10776 10777 10778 10779 10780 10781 10782 10783 10784 10785 10786 10787
/*
 * "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")},
10788
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
10789 10790 10791 10792 10793 10794
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
10795
static bool
E
Eric Blake 已提交
10796 10797 10798 10799 10800
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
10801
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
10802 10803 10804 10805 10806 10807 10808 10809
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

10810
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
10811 10812 10813
        bool close_quote = false;
        char *q;

10814
        arg = opt->data;
E
Eric Blake 已提交
10815 10816 10817 10818 10819 10820 10821 10822 10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842
        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 已提交
10843
        return false;
E
Eric Blake 已提交
10844 10845 10846 10847 10848
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
10849
    return true;
E
Eric Blake 已提交
10850 10851
}

10852 10853 10854 10855
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
10856 10857
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
10858 10859 10860 10861
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
10862
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10863 10864 10865 10866 10867 10868
    {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 已提交
10869
static bool
10870 10871
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
10872
    bool ret = false;
10873 10874 10875 10876 10877
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
10878
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
10879

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

J
Jim Meyering 已提交
10883
    dom = vshCommandOptDomain (ctl, cmd, NULL);
10884 10885 10886 10887
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
10888
    doc = virDomainGetXMLDesc (dom, flags);
10889 10890 10891 10892 10893 10894 10895 10896 10897 10898 10899 10900 10901 10902 10903 10904 10905 10906
    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 已提交
10907
        ret = true;
10908 10909 10910 10911 10912 10913 10914
        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.
     */
10915
    doc_reread = virDomainGetXMLDesc (dom, flags);
10916 10917 10918 10919
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
10920 10921
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
10922 10923 10924 10925 10926 10927 10928 10929 10930 10931 10932 10933
        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 已提交
10934
    ret = true;
10935 10936 10937 10938 10939

 cleanup:
    if (dom)
        virDomainFree (dom);

10940 10941 10942
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
10943 10944 10945

    if (tmp) {
        unlink (tmp);
10946
        VIR_FREE(tmp);
10947 10948 10949 10950 10951
    }

    return ret;
}

10952

10953 10954 10955 10956
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
10957 10958
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
10959 10960 10961 10962
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
10963
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
10964 10965 10966 10967 10968 10969 10970 10971 10972 10973
    {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[] = {
10974 10975
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
10976 10977 10978 10979
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
10980
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10981 10982 10983 10984 10985 10986
    {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 已提交
10987 10988 10989
/*
 * "quit" command
 */
10990
static const vshCmdInfo info_quit[] = {
10991
    {"help", N_("quit this interactive terminal")},
10992
    {"desc", ""},
10993
    {NULL, NULL}
K
Karel Zak 已提交
10994 10995
};

E
Eric Blake 已提交
10996
static bool
10997
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
10998
{
E
Eric Blake 已提交
10999 11000
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
11001 11002
}

11003 11004 11005 11006
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
11007 11008
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
11009 11010 11011 11012 11013 11014 11015 11016 11017
    {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 已提交
11018
static bool
11019 11020 11021
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11022
    bool ret = false;
11023
    const char *from = NULL;
11024 11025 11026 11027 11028 11029 11030
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

11031
    if (!vshConnectionUsability(ctl, ctl->conn))
11032 11033 11034 11035 11036 11037
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11038
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
11039
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083
    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 已提交
11084
    ret = true;
11085 11086 11087 11088 11089 11090 11091 11092 11093 11094 11095 11096 11097 11098 11099 11100

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

11101 11102 11103 11104 11105 11106 11107 11108 11109 11110 11111 11112 11113
/*
 * "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 已提交
11114
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
11115 11116 11117 11118 11119 11120 11121 11122 11123 11124 11125 11126 11127 11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158
    {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 已提交
11159 11160 11161 11162 11163 11164
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 11182 11183 11184 11185 11186 11187 11188 11189 11190 11191 11192 11193 11194 11195 11196 11197 11198 11199 11200 11201 11202 11203 11204 11205 11206 11207
    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;
}

11208 11209 11210 11211 11212 11213 11214 11215 11216 11217 11218 11219 11220 11221
/*
 * "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 已提交
11222
static bool
11223 11224 11225
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11226
    bool ret = false;
11227 11228 11229
    int current;
    virDomainSnapshotPtr snapshot = NULL;

11230
    if (!vshConnectionUsability(ctl, ctl->conn))
11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253
        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 已提交
11254
    ret = true;
11255 11256 11257 11258 11259 11260 11261 11262 11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278

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 已提交
11279
static bool
11280 11281 11282
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11283
    bool ret = false;
11284 11285
    int numsnaps;
    char **names = NULL;
11286
    int actual = 0;
11287 11288 11289 11290 11291 11292
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
11293 11294
    long long creation_longlong;
    time_t creation_time_t;
11295 11296 11297
    char timestr[100];
    struct tm time_info;

11298
    if (!vshConnectionUsability(ctl, ctl->conn))
11299 11300 11301 11302 11303 11304 11305 11306 11307 11308 11309
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

11310 11311
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
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 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352

    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;
11353 11354
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
11355
                continue;
11356 11357 11358 11359 11360 11361
            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);
11362
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
11363 11364 11365 11366 11367

            vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
        }
    }

E
Eric Blake 已提交
11368
    ret = true;
11369 11370 11371 11372 11373 11374 11375 11376 11377 11378

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);
11379 11380
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
11381 11382 11383 11384 11385 11386 11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402
    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 已提交
11403
static bool
11404 11405 11406
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11407
    bool ret = false;
11408
    const char *name = NULL;
11409 11410 11411
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

11412
    if (!vshConnectionUsability(ctl, ctl->conn))
11413 11414 11415 11416 11417 11418
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11419
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11420 11421 11422 11423 11424 11425 11426 11427 11428 11429
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

11430
    vshPrint(ctl, "%s", xml);
11431

E
Eric Blake 已提交
11432
    ret = true;
11433 11434 11435 11436 11437 11438 11439 11440 11441 11442 11443 11444

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
11445
 * "snapshot-revert" command
11446
 */
11447
static const vshCmdInfo info_snapshot_revert[] = {
11448 11449 11450 11451 11452
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

11453
static const vshCmdOptDef opts_snapshot_revert[] = {
11454 11455 11456 11457 11458
    {"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 已提交
11459
static bool
11460
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
11461 11462
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11463
    bool ret = false;
11464
    const char *name = NULL;
11465 11466
    virDomainSnapshotPtr snapshot = NULL;

11467
    if (!vshConnectionUsability(ctl, ctl->conn))
11468 11469 11470 11471 11472 11473
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11474
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11475 11476 11477 11478 11479 11480 11481 11482 11483
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    if (virDomainRevertToSnapshot(snapshot, 0) < 0)
        goto cleanup;

E
Eric Blake 已提交
11484
    ret = true;
11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510

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 已提交
11511
static bool
11512 11513 11514
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11515
    bool ret = false;
11516
    const char *name = NULL;
11517 11518 11519
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

11520
    if (!vshConnectionUsability(ctl, ctl->conn))
11521 11522 11523 11524 11525 11526
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11527
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11528 11529 11530 11531 11532 11533 11534 11535 11536
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

11537 11538 11539 11540
    if (virDomainSnapshotDelete(snapshot, flags) == 0) {
        vshPrint(ctl, _("Domain snapshot %s deleted\n"), name);
    } else {
        vshError(ctl, _("Failed to delete snapshot %s"), name);
11541
        goto cleanup;
11542
    }
11543

E
Eric Blake 已提交
11544
    ret = true;
11545 11546 11547 11548 11549 11550 11551 11552 11553 11554

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11555 11556 11557 11558
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
11559 11560
    {"help", N_("QEMU Monitor Command")},
    {"desc", N_("QEMU Monitor Command")},
11561 11562 11563 11564 11565 11566
    {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")},
11567
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
11568 11569 11570
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11571
static bool
11572 11573 11574
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11575
    bool ret = false;
11576
    const char *monitor_cmd = NULL;
11577
    char *result = NULL;
11578
    unsigned int flags = 0;
11579 11580 11581 11582 11583 11584 11585 11586

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

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11587
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
11588 11589 11590 11591
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

11592 11593 11594 11595
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
11596 11597 11598 11599
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
11600
    ret = true;
11601 11602 11603 11604 11605 11606 11607 11608 11609

cleanup:
    VIR_FREE(result);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11610 11611 11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655
/*
 * "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;
}

11656
static const vshCmdDef domManagementCmds[] = {
11657 11658 11659 11660 11661 11662 11663 11664
    {"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},
11665
#ifndef WIN32
11666
    {"console", cmdConsole, opts_console, info_console, 0},
11667
#endif
11668 11669 11670 11671 11672 11673 11674 11675 11676 11677 11678 11679 11680 11681 11682 11683 11684 11685 11686 11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698
    {"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},
11699 11700
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
11701 11702 11703 11704 11705
    {"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},
11706
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718
    {"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 已提交
11719
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
11720
    {"version", cmdVersion, opts_version, info_version, 0},
11721 11722
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
11723 11724 11725
};

static const vshCmdDef domMonitoringCmds[] = {
11726 11727
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
11728
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
11729 11730 11731 11732 11733 11734
    {"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}
11735 11736 11737
};

static const vshCmdDef storagePoolCmds[] = {
11738
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
11739
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
11740
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
11741 11742 11743 11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761
     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}
11762 11763 11764
};

static const vshCmdDef storageVolCmds[] = {
11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782
    {"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}
11783
};
11784

11785
static const vshCmdDef networkCmds[] = {
11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801 11802 11803 11804
    {"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}
11805
};
11806

11807
static const vshCmdDef nodedevCmds[] = {
11808 11809 11810 11811 11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822
    {"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}
11823 11824 11825
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
11826 11827 11828 11829
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843
    {"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 已提交
11844 11845
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
11846 11847 11848 11849 11850
    {"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}
11851
};
11852

11853
static const vshCmdDef nwfilterCmds[] = {
11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864
    {"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}
11865
};
11866

11867
static const vshCmdDef secretCmds[] = {
11868 11869 11870 11871 11872 11873 11874 11875 11876 11877 11878 11879
    {"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}
11880
};
11881

11882
static const vshCmdDef virshCmds[] = {
11883 11884 11885 11886 11887 11888 11889
    {"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}
11890
};
11891

11892
static const vshCmdDef snapshotCmds[] = {
11893 11894
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
11895 11896
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907
    {"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}
11908
};
11909

11910
static const vshCmdDef hostAndHypervisorCmds[] = {
11911 11912 11913 11914 11915
    {"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},
11916
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
11917
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
11918
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
11919
    {"qemu-attach", cmdQemuAttach, opts_qemu_attach, info_qemu_attach},
11920 11921 11922 11923 11924
    {"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 已提交
11925 11926
};

11927 11928 11929 11930 11931 11932 11933 11934 11935 11936 11937 11938 11939 11940 11941 11942 11943
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 已提交
11944 11945 11946 11947
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
11948
static const char *
11949
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
11950
{
11951
    const vshCmdInfo *info;
11952

K
Karel Zak 已提交
11953
    for (info = cmd->info; info && info->name; info++) {
11954
        if (STREQ(info->name, name))
K
Karel Zak 已提交
11955 11956 11957 11958 11959
            return info->data;
    }
    return NULL;
}

11960
static int
E
Eric Blake 已提交
11961
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t *opts_need_arg,
11962 11963 11964 11965 11966
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

E
Eric Blake 已提交
11967 11968 11969
    *opts_need_arg = 0;
    *opts_required = 0;

11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982
    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 已提交
11983 11984 11985 11986 11987 11988
        if (opt->flag & VSH_OFLAG_REQ_OPT) {
            if (opt->flag & VSH_OFLAG_REQ)
                *opts_required |= 1 << i;
            continue;
        }

11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000
        *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;
}

12001
static const vshCmdOptDef *
12002 12003
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
12004
{
12005 12006 12007 12008
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
12009

12010 12011 12012 12013 12014
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
12015 12016 12017 12018 12019
            if (opt->type == VSH_OT_ARGV) {
                vshError(ctl, _("variable argument <%s> "
                         "should not be used with --<%s>"), name, name);
                return NULL;
            }
12020
            *opts_seen |= 1 << i;
K
Karel Zak 已提交
12021
            return opt;
12022 12023 12024 12025 12026
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
12027 12028 12029
    return NULL;
}

12030
static const vshCmdOptDef *
12031 12032
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
12033
{
12034
    int i;
12035
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
12036

12037 12038 12039 12040 12041 12042 12043 12044 12045 12046
    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 已提交
12047 12048
}

12049 12050 12051
/*
 * Checks for required options
 */
12052
static int
12053 12054
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
12055
{
12056
    const vshCmdDef *def = cmd->def;
12057 12058 12059 12060 12061 12062 12063 12064 12065
    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];
12066

12067
            vshError(ctl,
12068
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
12069 12070 12071
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
12072 12073
        }
    }
12074
    return -1;
12075 12076
}

12077
static const vshCmdDef *
12078 12079
vshCmddefSearch(const char *cmdname)
{
12080
    const vshCmdGrp *g;
12081
    const vshCmdDef *c;
12082

12083 12084
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
12085
            if (STREQ(c->name, cmdname))
12086 12087 12088 12089
                return c;
        }
    }

K
Karel Zak 已提交
12090 12091 12092
    return NULL;
}

12093 12094 12095 12096 12097 12098
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
12099
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
12100 12101 12102 12103 12104 12105
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
12106
static bool
12107 12108 12109 12110 12111 12112 12113
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 已提交
12114
        return false;
12115 12116 12117 12118 12119 12120 12121 12122 12123 12124
    } 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 已提交
12125
    return true;
12126 12127
}

E
Eric Blake 已提交
12128
static bool
12129
vshCmddefHelp(vshControl *ctl, const char *cmdname)
12130
{
12131
    const vshCmdDef *def = vshCmddefSearch(cmdname);
12132

K
Karel Zak 已提交
12133
    if (!def) {
12134
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
12135
        return false;
12136
    } else {
E
Eric Blake 已提交
12137 12138
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
12139
        const char *help = _(vshCmddefGetInfo(def, "help"));
12140
        char buf[256];
12141 12142 12143 12144 12145 12146
        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 已提交
12147
            return false;
12148
        }
K
Karel Zak 已提交
12149

12150
        fputs(_("  NAME\n"), stdout);
12151 12152
        fprintf(stdout, "    %s - %s\n", def->name, help);

12153 12154 12155 12156 12157
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
12158
                const char *fmt = "%s";
12159 12160
                switch (opt->type) {
                case VSH_OT_BOOL:
12161
                    fmt = "[--%s]";
12162 12163
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
12164
                    /* xgettext:c-format */
12165 12166
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
12167 12168
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
12169 12170
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
12171 12172
                    break;
                case VSH_OT_DATA:
12173
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
12174 12175 12176
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
12177 12178
                    fmt = (opt->flag & VSH_OFLAG_REQ) ? _("<%s>...")
                           : _("[<%s>]...");
12179 12180
                    break;
                default:
12181
                    assert(0);
12182
                }
12183
                fputc(' ', stdout);
E
Eric Blake 已提交
12184
                fprintf(stdout, fmt, opt->name);
12185
            }
K
Karel Zak 已提交
12186
        }
12187 12188 12189
        fputc('\n', stdout);

        if (desc[0]) {
12190
            /* Print the description only if it's not empty.  */
12191
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
12192
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
12193
        }
12194

K
Karel Zak 已提交
12195
        if (def->opts) {
12196
            const vshCmdOptDef *opt;
12197
            fputs(_("\n  OPTIONS\n"), stdout);
12198
            for (opt = def->opts; opt->name; opt++) {
12199 12200
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
12201
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
12202 12203
                    break;
                case VSH_OT_INT:
12204 12205 12206
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
12207 12208
                    break;
                case VSH_OT_STRING:
12209
                    /* OT_STRING should never be VSH_OFLAG_REQ */
12210
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
12211 12212
                    break;
                case VSH_OT_DATA:
12213 12214
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
12215 12216 12217
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
12218 12219
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
12220 12221 12222
                default:
                    assert(0);
                }
12223

E
Eric Blake 已提交
12224
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
12225
            }
K
Karel Zak 已提交
12226 12227 12228
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
12229
    return true;
K
Karel Zak 已提交
12230 12231 12232 12233 12234 12235
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
12236 12237 12238
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
12239 12240
    vshCmdOpt *a = arg;

12241
    while (a) {
K
Karel Zak 已提交
12242
        vshCmdOpt *tmp = a;
12243

K
Karel Zak 已提交
12244 12245
        a = a->next;

12246 12247
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
12248 12249 12250 12251
    }
}

static void
12252
vshCommandFree(vshCmd *cmd)
12253
{
K
Karel Zak 已提交
12254 12255
    vshCmd *c = cmd;

12256
    while (c) {
K
Karel Zak 已提交
12257
        vshCmd *tmp = c;
12258

K
Karel Zak 已提交
12259 12260 12261 12262
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
12263
        VIR_FREE(tmp);
K
Karel Zak 已提交
12264 12265 12266 12267 12268 12269 12270
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
12271
vshCommandOpt(const vshCmd *cmd, const char *name)
12272
{
K
Karel Zak 已提交
12273
    vshCmdOpt *opt = cmd->opts;
12274 12275

    while (opt) {
12276
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
12277 12278 12279 12280 12281 12282 12283
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
12284 12285 12286 12287 12288 12289 12290 12291 12292
 * @cmd command reference
 * @name option name
 * @value result
 *
 * Convert option to int
 * Return value:
 * >0 if option found and valid (@value updated)
 * 0 in case option not found (@value untouched)
 * <0 in all other cases (@value untouched)
K
Karel Zak 已提交
12293 12294
 */
static int
12295
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
12296
{
K
Karel Zak 已提交
12297
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
12298
    int ret = 0, num;
12299
    char *end_p = NULL;
12300

12301
    if ((arg != NULL) && (arg->data != NULL)) {
12302 12303 12304 12305 12306 12307
        num = strtol(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
12308
    }
12309
    return ret;
K
Karel Zak 已提交
12310 12311
}

12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335

/*
 * Convert option to unsigned int
 * See vshCommandOptInt()
 */
static int
vshCommandOptUInt(const vshCmd *cmd, const char *name, unsigned int *value)
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
    unsigned int ret = 0, num;
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
        num = strtoul(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
    }
    return ret;
}


12336 12337 12338 12339 12340 12341
/*
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
12342 12343
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
12344 12345
    int ret = 0;
    unsigned long num;
12346 12347 12348
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
12349 12350 12351 12352 12353 12354
        num = strtoul(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
12355
    }
12356
    return ret;
12357 12358
}

K
Karel Zak 已提交
12359 12360
/*
 * Returns option as STRING
12361
 * See vshCommandOptInt()
K
Karel Zak 已提交
12362
 */
12363 12364
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
12365
{
K
Karel Zak 已提交
12366
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
12367 12368 12369
    int ret = 0;

    if (arg && arg->data) {
E
Eric Blake 已提交
12370 12371 12372 12373
        if (*arg->data
            || (arg->def && (arg->def->flag & VSH_OFLAG_EMPTY_OK))) {
            *value = arg->data;
            ret = 1;
12374 12375
        } else if (arg->def && ((arg->def->flag) & VSH_OFLAG_REQ)) {
            vshError(NULL, _("Missing required option '%s'"), name);
E
Eric Blake 已提交
12376 12377 12378 12379
            ret = -1;
        } else {
            /* Treat "--option ''" as if option had not been specified. */
            ret = 0;
12380 12381
        }
    }
12382

12383
    return ret;
K
Karel Zak 已提交
12384 12385
}

12386 12387
/*
 * Returns option as long long
12388
 * See vshCommandOptInt()
12389
 */
12390 12391 12392
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
12393 12394
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
12395 12396
    int ret = 0;
    long long num;
12397 12398
    char *end_p = NULL;

12399 12400 12401 12402 12403 12404 12405 12406 12407
    if ((arg != NULL) && (arg->data != NULL)) {
        num = strtoll(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
    }
    return ret;
12408 12409
}

12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430
static int
vshCommandOptULongLong(const vshCmd *cmd, const char *name,
                       unsigned long long *value)
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
    int ret = 0;
    unsigned long long num;
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
        num = strtoull(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
    }
    return ret;
}


K
Karel Zak 已提交
12431
/*
E
Eric Blake 已提交
12432
 * Returns true/false if the option exists
K
Karel Zak 已提交
12433
 */
E
Eric Blake 已提交
12434
static bool
12435
vshCommandOptBool(const vshCmd *cmd, const char *name)
12436
{
E
Eric Blake 已提交
12437
    return vshCommandOpt(cmd, name) != NULL;
K
Karel Zak 已提交
12438 12439
}

12440
/*
12441 12442
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
12443
 *
12444
 * Requires that a VSH_OT_ARGV option be last in the
12445 12446
 * list of supported options in CMD->def->opts.
 */
12447 12448
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
12449
{
12450
    opt = opt ? opt->next : cmd->opts;
12451 12452 12453

    while (opt) {
        if (opt->def && opt->def->type == VSH_OT_ARGV) {
12454
            return opt;
12455 12456 12457 12458 12459 12460
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
12461 12462 12463 12464 12465 12466 12467 12468 12469 12470 12471 12472 12473 12474 12475 12476 12477 12478
/* 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)
12479
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
12480 12481 12482
                 cmd->def->name, optname);
    return found;
}
12483

K
Karel Zak 已提交
12484
static virDomainPtr
J
Jim Meyering 已提交
12485
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
12486
                      const char **name, int flag)
12487
{
K
Karel Zak 已提交
12488
    virDomainPtr dom = NULL;
12489
    const char *n = NULL;
K
Karel Zak 已提交
12490
    int id;
J
Jim Meyering 已提交
12491 12492 12493
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
12494

12495
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12496 12497
        return NULL;

K
Karel Zak 已提交
12498
    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
12499 12500
             cmd->def->name, optname, n);

K
Karel Zak 已提交
12501 12502
    if (name)
        *name = n;
12503

K
Karel Zak 已提交
12504
    /* try it by ID */
12505
    if (flag & VSH_BYID) {
12506
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
12507 12508 12509 12510
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
12511
    }
K
Karel Zak 已提交
12512
    /* try it by UUID */
12513
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
12514
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
12515
                 cmd->def->name, optname);
K
Karel Zak 已提交
12516
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
12517
    }
K
Karel Zak 已提交
12518
    /* try it by NAME */
12519
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
12520
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
12521
                 cmd->def->name, optname);
K
Karel Zak 已提交
12522
        dom = virDomainLookupByName(ctl->conn, n);
12523
    }
K
Karel Zak 已提交
12524

12525
    if (!dom)
12526
        vshError(ctl, _("failed to get domain '%s'"), n);
12527

K
Karel Zak 已提交
12528 12529 12530
    return dom;
}

12531
static virNetworkPtr
J
Jim Meyering 已提交
12532
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
12533
                       const char **name, int flag)
12534 12535
{
    virNetworkPtr network = NULL;
12536
    const char *n = NULL;
J
Jim Meyering 已提交
12537 12538 12539
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
12540

12541
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12542 12543 12544 12545 12546 12547 12548 12549 12550
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
12551
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
12552
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
12553
                 cmd->def->name, optname);
12554 12555 12556 12557
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
12558
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
12559 12560 12561 12562 12563
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
12564
        vshError(ctl, _("failed to get network '%s'"), n);
12565 12566 12567 12568

    return network;
}

12569 12570 12571

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
12572
                        const char **name, int flag)
12573 12574
{
    virNWFilterPtr nwfilter = NULL;
12575
    const char *n = NULL;
12576 12577 12578 12579
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

12580
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
        vshDebug(ctl, 5, "%s: <%s> trying as nwfilter UUID\n",
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (nwfilter == NULL && (flag & VSH_BYNAME)) {
        vshDebug(ctl, 5, "%s: <%s> trying as nwfilter NAME\n",
                 cmd->def->name, optname);
        nwfilter = virNWFilterLookupByName(ctl->conn, n);
    }

    if (!nwfilter)
        vshError(ctl, _("failed to get nwfilter '%s'"), n);

    return nwfilter;
}

12608 12609
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
12610
                         const char **name, int flag)
12611 12612
{
    virInterfacePtr iface = NULL;
12613
    const char *n = NULL;
12614 12615 12616 12617
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

12618
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12619 12620 12621 12622 12623 12624 12625 12626 12627
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
12628
    if ((flag & VSH_BYNAME)) {
12629 12630 12631 12632 12633 12634 12635 12636 12637 12638 12639 12640
        vshDebug(ctl, 5, "%s: <%s> trying as interface NAME\n",
                 cmd->def->name, optname);
        iface = virInterfaceLookupByName(ctl->conn, n);
    }
    /* try it by MAC */
    if ((iface == NULL) && (flag & VSH_BYMAC)) {
        vshDebug(ctl, 5, "%s: <%s> trying as interface MAC\n",
                 cmd->def->name, optname);
        iface = virInterfaceLookupByMACString(ctl->conn, n);
    }

    if (!iface)
12641
        vshError(ctl, _("failed to get interface '%s'"), n);
12642 12643 12644 12645

    return iface;
}

12646
static virStoragePoolPtr
12647
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
12648
                    const char **name, int flag)
12649 12650
{
    virStoragePoolPtr pool = NULL;
12651
    const char *n = NULL;
12652

12653
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12654 12655 12656 12657 12658 12659 12660 12661 12662
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
12663
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
12664
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
12665
                 cmd->def->name, optname);
12666 12667 12668
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
12669
    if (pool == NULL && (flag & VSH_BYNAME)) {
12670 12671 12672 12673 12674 12675
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
12676
        vshError(ctl, _("failed to get pool '%s'"), n);
12677 12678 12679 12680 12681

    return pool;
}

static virStorageVolPtr
12682
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
12683 12684
                   const char *optname,
                   const char *pooloptname,
12685
                   const char **name, int flag)
12686 12687 12688
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
12689
    const char *n = NULL, *p = NULL;
12690

12691
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12692 12693
        return NULL;

12694 12695
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
12696
        return NULL;
12697
    }
12698 12699 12700 12701 12702 12703 12704 12705 12706 12707

    if (p)
        pool = vshCommandOptPoolBy(ctl, cmd, pooloptname, name, flag);

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

12708
    /* try it by name */
12709
    if (pool && (flag & VSH_BYNAME)) {
12710
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
12711 12712 12713
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
12714
    /* try it by key */
12715 12716 12717 12718 12719
    if (vol == NULL && (flag & VSH_BYUUID)) {
        vshDebug(ctl, 5, "%s: <%s> trying as vol key\n",
                 cmd->def->name, optname);
        vol = virStorageVolLookupByKey(ctl->conn, n);
    }
12720
    /* try it by path */
12721 12722 12723 12724 12725 12726 12727
    if (vol == NULL && (flag & VSH_BYUUID)) {
        vshDebug(ctl, 5, "%s: <%s> trying as vol path\n",
                 cmd->def->name, optname);
        vol = virStorageVolLookupByPath(ctl->conn, n);
    }

    if (!vol)
12728
        vshError(ctl, _("failed to get vol '%s'"), n);
12729 12730 12731 12732 12733 12734 12735

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

12736
static virSecretPtr
12737
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
12738 12739
{
    virSecretPtr secret = NULL;
12740
    const char *n = NULL;
12741 12742 12743 12744 12745
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

12746
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12747 12748 12749 12750 12751 12752 12753 12754 12755 12756
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n", cmd->def->name, optname, n);

    if (name != NULL)
        *name = n;

    secret = virSecretLookupByUUIDString(ctl->conn, n);

    if (secret == NULL)
12757
        vshError(ctl, _("failed to get secret '%s'"), n);
12758 12759 12760 12761

    return secret;
}

K
Karel Zak 已提交
12762 12763 12764
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
12765
static bool
12766
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
12767
{
E
Eric Blake 已提交
12768
    bool ret = true;
12769 12770

    while (cmd) {
K
Karel Zak 已提交
12771
        struct timeval before, after;
12772
        bool enable_timing = ctl->timing;
12773

12774 12775
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
12776 12777
            vshReconnect(ctl);

12778
        if (enable_timing)
K
Karel Zak 已提交
12779
            GETTIMEOFDAY(&before);
12780

K
Karel Zak 已提交
12781 12782
        ret = cmd->def->handler(ctl, cmd);

12783
        if (enable_timing)
K
Karel Zak 已提交
12784
            GETTIMEOFDAY(&after);
12785

12786
        if (!ret)
J
John Levon 已提交
12787 12788
            virshReportError(ctl);

12789
        /* try to automatically catch disconnections */
12790
        if (!ret &&
12791 12792 12793 12794 12795 12796 12797 12798 12799
            ((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);

12800
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
12801 12802
            return ret;

12803
        if (enable_timing)
12804
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
12805 12806
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
12807
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
12808 12809 12810 12811 12812 12813
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
12814
 * Command parsing
K
Karel Zak 已提交
12815 12816 12817
 * ---------------
 */

12818 12819 12820 12821 12822 12823 12824 12825 12826 12827
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 已提交
12828
    /* vshCommandStringGetArg() */
12829
    char *pos;
L
Lai Jiangshan 已提交
12830 12831 12832
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
12833 12834
} vshCommandParser;

E
Eric Blake 已提交
12835
static bool
12836
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
12837
{
K
Karel Zak 已提交
12838 12839 12840
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
12841

K
Karel Zak 已提交
12842 12843 12844 12845
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
12846

12847
    while (1) {
K
Karel Zak 已提交
12848
        vshCmdOpt *last = NULL;
12849
        const vshCmdDef *cmd = NULL;
12850
        vshCommandToken tk;
L
Lai Jiangshan 已提交
12851
        bool data_only = false;
12852 12853 12854
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
12855

K
Karel Zak 已提交
12856
        first = NULL;
12857

12858
        while (1) {
12859
            const vshCmdOptDef *opt = NULL;
12860

K
Karel Zak 已提交
12861
            tkdata = NULL;
12862
            tk = parser->getNextArg(ctl, parser, &tkdata);
12863 12864

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
12865
                goto syntaxError;
H
Hu Tao 已提交
12866 12867
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
12868
                break;
H
Hu Tao 已提交
12869
            }
12870 12871

            if (cmd == NULL) {
K
Karel Zak 已提交
12872 12873
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
12874
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
12875
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
12876
                }
12877 12878 12879 12880 12881 12882 12883
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
12884
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
12885 12886 12887 12888
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
12889 12890 12891 12892 12893
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
12894 12895
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
12896
                    VIR_FREE(optstr);
K
Karel Zak 已提交
12897 12898
                    goto syntaxError;
                }
12899
                VIR_FREE(tkdata);
K
Karel Zak 已提交
12900 12901 12902

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
12903 12904 12905
                    if (optstr)
                        tkdata = optstr;
                    else
12906
                        tk = parser->getNextArg(ctl, parser, &tkdata);
12907
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
12908
                        goto syntaxError;
12909
                    if (tk != VSH_TK_ARG) {
12910
                        vshError(ctl,
12911
                                 _("expected syntax: --%s <%s>"),
12912 12913
                                 opt->name,
                                 opt->type ==
12914
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
12915 12916
                        goto syntaxError;
                    }
12917
                    opts_need_arg &= ~opts_seen;
12918 12919 12920 12921 12922 12923 12924 12925
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
12926
                }
L
Lai Jiangshan 已提交
12927 12928 12929 12930
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
12931
            } else {
L
Lai Jiangshan 已提交
12932
get_data:
12933 12934
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
12935
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
12936 12937 12938 12939 12940
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
12941
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
12942

K
Karel Zak 已提交
12943 12944 12945 12946
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
12947

K
Karel Zak 已提交
12948 12949 12950 12951 12952
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
12953

K
Karel Zak 已提交
12954
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
12955 12956
                         cmd->name,
                         opt->name,
12957 12958
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
12959 12960
            }
        }
12961

D
Daniel Veillard 已提交
12962
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
12963
        if (cmd) {
12964
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
12965

K
Karel Zak 已提交
12966 12967 12968 12969
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

12970
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
12971
                VIR_FREE(c);
12972
                goto syntaxError;
12973
            }
12974

K
Karel Zak 已提交
12975 12976 12977 12978 12979 12980
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
12981 12982 12983

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
12984
    }
12985

E
Eric Blake 已提交
12986
    return true;
K
Karel Zak 已提交
12987

12988
 syntaxError:
12989
    if (ctl->cmd) {
K
Karel Zak 已提交
12990
        vshCommandFree(ctl->cmd);
12991 12992
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
12993 12994
    if (first)
        vshCommandOptFree(first);
12995
    VIR_FREE(tkdata);
E
Eric Blake 已提交
12996
    return false;
K
Karel Zak 已提交
12997 12998
}

12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016
/* --------------------
 * 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 已提交
13017 13018
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
13019 13020 13021 13022
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
13023
        return false;
13024 13025 13026 13027 13028 13029 13030 13031 13032 13033 13034 13035 13036 13037 13038 13039 13040 13041 13042 13043 13044 13045 13046 13047 13048 13049 13050 13051 13052 13053 13054 13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095

    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 已提交
13096 13097
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
13098 13099 13100 13101
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
13102
        return false;
13103 13104 13105 13106 13107 13108

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
13109
/* ---------------
13110
 * Misc utils
K
Karel Zak 已提交
13111 13112
 * ---------------
 */
13113 13114 13115 13116 13117 13118 13119 13120 13121 13122 13123 13124 13125 13126 13127 13128 13129 13130 13131 13132 13133 13134 13135 13136 13137 13138 13139 13140
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 已提交
13141
static const char *
13142 13143
vshDomainStateToString(int state)
{
13144
    switch ((virDomainState) state) {
13145
    case VIR_DOMAIN_RUNNING:
13146
        return N_("running");
13147
    case VIR_DOMAIN_BLOCKED:
13148
        return N_("idle");
13149
    case VIR_DOMAIN_PAUSED:
13150
        return N_("paused");
13151
    case VIR_DOMAIN_SHUTDOWN:
13152
        return N_("in shutdown");
13153
    case VIR_DOMAIN_SHUTOFF:
13154
        return N_("shut off");
13155
    case VIR_DOMAIN_CRASHED:
13156
        return N_("crashed");
13157
    case VIR_DOMAIN_NOSTATE:
13158
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
13159
    }
13160
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
13161 13162
}

13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 13210 13211 13212 13213 13214 13215 13216 13217 13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234 13235 13236 13237 13238 13239 13240 13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263
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");
}

13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276 13277 13278 13279 13280
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");
}

13281 13282 13283 13284
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
13285
    case VIR_VCPU_OFFLINE:
13286
        return N_("offline");
13287
    case VIR_VCPU_BLOCKED:
13288
        return N_("idle");
13289
    case VIR_VCPU_RUNNING:
13290
        return N_("running");
13291
    default:
13292
        ;/*FALLTHROUGH*/
13293
    }
13294
    return N_("no state");
13295 13296
}

E
Eric Blake 已提交
13297
static bool
13298
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
13299
{
13300 13301
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
13302 13303
     */
    if (!conn) {
13304
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
13305
        return false;
K
Karel Zak 已提交
13306
    }
E
Eric Blake 已提交
13307
    return true;
K
Karel Zak 已提交
13308 13309
}

K
Karel Zak 已提交
13310
static void
13311
vshDebug(vshControl *ctl, int level, const char *format, ...)
13312
{
K
Karel Zak 已提交
13313
    va_list ap;
13314
    char *str;
K
Karel Zak 已提交
13315

13316 13317 13318 13319
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
13320 13321 13322 13323
    if (level > ctl->debug)
        return;

    va_start(ap, format);
13324 13325 13326 13327 13328
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
13329
    va_end(ap);
13330 13331
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
13332 13333 13334
}

static void
13335
vshPrintExtra(vshControl *ctl, const char *format, ...)
13336
{
K
Karel Zak 已提交
13337
    va_list ap;
13338
    char *str;
13339

13340
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
13341
        return;
13342

K
Karel Zak 已提交
13343
    va_start(ap, format);
13344 13345 13346 13347 13348
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
13349
    va_end(ap);
13350
    fputs(str, stdout);
13351
    VIR_FREE(str);
K
Karel Zak 已提交
13352 13353
}

K
Karel Zak 已提交
13354

K
Karel Zak 已提交
13355
static void
13356
vshError(vshControl *ctl, const char *format, ...)
13357
{
K
Karel Zak 已提交
13358
    va_list ap;
13359
    char *str;
13360

13361 13362 13363 13364 13365
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
13366

13367
    fputs(_("error: "), stderr);
13368

K
Karel Zak 已提交
13369
    va_start(ap, format);
13370 13371 13372
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
13373 13374
    va_end(ap);

13375 13376
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
13377 13378
}

13379

K
Karel Zak 已提交
13380
/*
13381
 * Initialize connection.
K
Karel Zak 已提交
13382
 */
E
Eric Blake 已提交
13383
static bool
13384
vshInit(vshControl *ctl)
13385
{
13386 13387
    char *debugEnv;

K
Karel Zak 已提交
13388
    if (ctl->conn)
E
Eric Blake 已提交
13389
        return false;
K
Karel Zak 已提交
13390

13391 13392 13393 13394 13395 13396 13397 13398 13399 13400 13401 13402 13403 13404 13405 13406 13407 13408 13409 13410 13411
    if (ctl->debug == -1) {
        /* log level not set from commandline, check env variable */
        debugEnv = getenv("VIRSH_DEBUG");
        if (debugEnv) {
            if (virStrToLong_i(debugEnv, NULL, 10, &ctl->debug) < 0 ||
                ctl->debug < VSH_ERR_DEBUG || ctl->debug > VSH_ERR_ERROR) {
                vshError(ctl, "%s",
                         _("VIRSH_DEBUG not set with a valid numeric value"));
                ctl->debug = VSH_ERR_DEBUG;
            }
        }
    }

    if (ctl->logfile == NULL) {
        /* log file not set from cmdline */
        debugEnv = getenv("VIRSH_LOG_FILE");
        if (debugEnv && *debugEnv) {
            ctl->logfile = vshStrdup(ctl, debugEnv);
        }
    }

13412 13413
    vshOpenLogFile(ctl);

13414 13415
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
13416

13417 13418 13419
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

13420
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
13421
        return false;
13422

13423 13424 13425 13426
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
13427

13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438
        /* 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;
        }
13439
    }
K
Karel Zak 已提交
13440

E
Eric Blake 已提交
13441
    return true;
K
Karel Zak 已提交
13442 13443
}

13444 13445
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464
/**
 * 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:
13465
                vshError(ctl, "%s",
J
Jim Meyering 已提交
13466
                         _("failed to get the log file information"));
13467
                exit(EXIT_FAILURE);
13468 13469 13470
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
13471 13472
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
13473 13474 13475 13476
        }
    }

    /* log file open */
13477
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
13478
        vshError(ctl, "%s",
J
Jim Meyering 已提交
13479
                 _("failed to open the log file. check the log file path"));
13480
        exit(EXIT_FAILURE);
13481 13482 13483 13484 13485 13486 13487 13488 13489
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
13490 13491
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
13492
{
13493 13494 13495
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
13496 13497 13498 13499 13500 13501 13502 13503 13504 13505 13506 13507 13508 13509
    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);
13510
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
13511 13512 13513 13514 13515 13516
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
13517 13518
                      SIGN_NAME,
                      (int) getpid());
13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538
    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;
    }
13539 13540 13541
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
13542

13543 13544
    if (virBufferError(&buf))
        goto error;
13545

13546 13547 13548 13549 13550
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
13551
    }
13552

13553 13554 13555 13556 13557 13558 13559 13560 13561 13562 13563
    /* 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);
13564 13565 13566 13567 13568 13569 13570 13571 13572 13573 13574
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
13575 13576 13577
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
13578 13579 13580
    }

    if (ctl->logfile) {
13581
        VIR_FREE(ctl->logfile);
13582 13583 13584 13585
        ctl->logfile = NULL;
    }
}

13586
#ifdef USE_READLINE
13587

K
Karel Zak 已提交
13588 13589 13590 13591 13592
/* -----------------
 * Readline stuff
 * -----------------
 */

13593
/*
K
Karel Zak 已提交
13594 13595
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
13596
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
13597 13598
 */
static char *
13599 13600
vshReadlineCommandGenerator(const char *text, int state)
{
13601
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
13602
    const char *name;
13603 13604
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
13605 13606

    if (!state) {
13607 13608
        grp_list_index = 0;
        cmd_list_index = 0;
13609
        len = strlen(text);
K
Karel Zak 已提交
13610 13611
    }

13612 13613
    grp = cmdGroups;

K
Karel Zak 已提交
13614
    /* Return the next name which partially matches from the
13615
     * command list.
K
Karel Zak 已提交
13616
     */
13617 13618 13619 13620 13621 13622 13623 13624 13625 13626 13627 13628 13629 13630
    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 已提交
13631 13632 13633 13634 13635 13636 13637
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
13638 13639
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
13640
    static int list_index, len;
13641
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
13642
    const char *name;
K
Karel Zak 已提交
13643 13644 13645 13646 13647 13648 13649 13650 13651

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

13652
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
13653
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
13654 13655 13656

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
13657
        len = strlen(text);
13658
        VIR_FREE(cmdname);
K
Karel Zak 已提交
13659 13660 13661 13662
    }

    if (!cmd)
        return NULL;
13663

13664 13665 13666
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
13667
    while ((name = cmd->opts[list_index].name)) {
13668
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
13669
        char *res;
13670

K
Karel Zak 已提交
13671
        list_index++;
13672

13673
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
13674 13675
            /* ignore non --option */
            continue;
13676

K
Karel Zak 已提交
13677
        if (len > 2) {
13678
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
13679 13680
                continue;
        }
13681
        res = vshMalloc(NULL, strlen(name) + 3);
13682
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
13683 13684 13685 13686 13687 13688 13689 13690
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
13691 13692 13693
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
13694 13695
    char **matches = (char **) NULL;

13696
    if (start == 0)
K
Karel Zak 已提交
13697
        /* command name generator */
13698
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
13699 13700
    else
        /* commands options */
13701
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
13702 13703 13704 13705
    return matches;
}


13706 13707
static int
vshReadlineInit(vshControl *ctl)
13708
{
13709 13710
    char *userdir = NULL;

K
Karel Zak 已提交
13711 13712 13713 13714 13715
    /* 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;
13716 13717 13718

    /* Limit the total size of the history buffer */
    stifle_history(500);
13719 13720

    /* Prepare to read/write history from/to the ~/.virsh/history file */
13721
    userdir = virGetUserDirectory(getuid());
13722

13723 13724
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
13725
        return -1;
13726
    }
13727 13728 13729

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
13730
        VIR_FREE(userdir);
13731 13732 13733 13734 13735
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
13736
        VIR_FREE(userdir);
13737 13738 13739
        return -1;
    }

13740
    VIR_FREE(userdir);
13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756 13757 13758

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

13759 13760
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
13761 13762
}

13763 13764 13765 13766 13767 13768
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

13769
#else /* !USE_READLINE */
13770

13771 13772 13773 13774 13775 13776 13777
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

13778
static void
13779
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
13780 13781 13782 13783 13784 13785 13786 13787 13788 13789 13790 13791 13792 13793 13794 13795 13796 13797 13798 13799 13800 13801 13802
{
    /* 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);
}

13803
#endif /* !USE_READLINE */
13804

K
Karel Zak 已提交
13805
/*
J
Jim Meyering 已提交
13806
 * Deinitialize virsh
K
Karel Zak 已提交
13807
 */
E
Eric Blake 已提交
13808
static bool
13809
vshDeinit(vshControl *ctl)
13810
{
13811
    vshReadlineDeinit(ctl);
13812
    vshCloseLogFile(ctl);
13813
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
13814
    if (ctl->conn) {
13815 13816 13817
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
13818 13819
        }
    }
D
Daniel P. Berrange 已提交
13820 13821
    virResetLastError();

E
Eric Blake 已提交
13822
    return true;
K
Karel Zak 已提交
13823
}
13824

K
Karel Zak 已提交
13825 13826 13827 13828
/*
 * Print usage
 */
static void
13829
vshUsage(void)
13830
{
13831
    const vshCmdGrp *grp;
13832
    const vshCmdDef *cmd;
13833

L
Lai Jiangshan 已提交
13834 13835
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
13836 13837 13838
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
13839
                      "    -d | --debug <num>      debug level [0-4]\n"
13840 13841 13842 13843
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
13844
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
13845
                      "    -V | --version=long     version and full options\n\n"
13846
                      "  commands (non interactive mode):\n\n"), progname, progname);
13847

13848 13849
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
13850

13851 13852 13853 13854 13855 13856 13857 13858 13859
        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"));
13860 13861 13862
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
13863 13864
}

13865 13866 13867 13868 13869 13870 13871 13872 13873 13874
/*
 * 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 已提交
13875 13876
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892 13893 13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908 13909 13910 13911
#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 已提交
13912
    vshPrint(ctl, "%s", _(" Networking:"));
13913 13914 13915 13916 13917 13918 13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938
#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 已提交
13939
    vshPrint(ctl, "%s", _(" Storage:"));
13940 13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962
#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 已提交
13963
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
13964
#ifdef WITH_SECDRIVER_APPARMOR
13965 13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987
    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 已提交
13988 13989 13990 13991
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
13992
static bool
13993
vshParseArgv(vshControl *ctl, int argc, char **argv)
13994
{
13995 13996
    bool help = false;
    int arg;
K
Karel Zak 已提交
13997
    struct option opt[] = {
E
Eric Blake 已提交
13998 13999 14000 14001 14002 14003 14004 14005 14006
        {"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}
14007 14008
    };

14009 14010 14011
    /* 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. */
14012
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
14013
        switch (arg) {
14014
        case 'd':
D
Daniel Veillard 已提交
14015
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
14016
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
14017 14018
                exit(EXIT_FAILURE);
            }
14019 14020
            break;
        case 'h':
14021
            help = true;
14022 14023
            break;
        case 'q':
E
Eric Blake 已提交
14024
            ctl->quiet = true;
14025 14026
            break;
        case 't':
E
Eric Blake 已提交
14027
            ctl->timing = true;
14028 14029 14030 14031
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
14032 14033 14034 14035 14036 14037
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
14038 14039 14040
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
14041
        case 'r':
E
Eric Blake 已提交
14042
            ctl->readonly = true;
14043
            break;
14044 14045 14046
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
14047
        default:
14048 14049
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
14050 14051 14052 14053
        }
    }

    if (help) {
14054 14055
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
14056 14057
            exit(EXIT_FAILURE);
        }
14058 14059 14060

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
14061
        exit(EXIT_SUCCESS);
14062 14063
    }

14064
    if (argc > optind) {
K
Karel Zak 已提交
14065
        /* parse command */
E
Eric Blake 已提交
14066
        ctl->imode = false;
14067 14068 14069
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
14070
        } else {
14071
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
14072 14073
        }
    }
E
Eric Blake 已提交
14074
    return true;
K
Karel Zak 已提交
14075 14076
}

14077 14078 14079 14080
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
14081
    char *defaultConn;
E
Eric Blake 已提交
14082
    bool ret = true;
K
Karel Zak 已提交
14083

14084 14085 14086
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
14087
    ctl->debug = -1;            /* Initialize log level */
14088

14089 14090
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
14091
        /* failure to setup locale is not fatal */
14092
    }
14093
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
14094
        perror("bindtextdomain");
E
Eric Blake 已提交
14095
        return EXIT_FAILURE;
14096
    }
14097
    if (!textdomain(PACKAGE)) {
14098
        perror("textdomain");
E
Eric Blake 已提交
14099
        return EXIT_FAILURE;
14100 14101
    }

14102 14103 14104 14105 14106
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

14107
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
14108 14109 14110
        progname = argv[0];
    else
        progname++;
14111

14112
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
14113
        ctl->name = vshStrdup(ctl, defaultConn);
14114 14115
    }

D
Daniel P. Berrange 已提交
14116 14117
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
14118
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
14119
    }
14120

D
Daniel P. Berrange 已提交
14121 14122
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
14123
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
14124
    }
14125

K
Karel Zak 已提交
14126
    if (!ctl->imode) {
14127
        ret = vshCommandRun(ctl, ctl->cmd);
14128
    } else {
K
Karel Zak 已提交
14129 14130
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
14131
            vshPrint(ctl,
14132
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
14133
                     progname);
J
Jim Meyering 已提交
14134
            vshPrint(ctl, "%s",
14135
                     _("Type:  'help' for help with commands\n"
14136
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
14137
        }
14138 14139 14140 14141 14142 14143

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
14144
        do {
14145
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
14146
            ctl->cmdstr =
14147
                vshReadline(ctl, prompt);
14148 14149
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
14150
            if (*ctl->cmdstr) {
14151
#if USE_READLINE
K
Karel Zak 已提交
14152
                add_history(ctl->cmdstr);
14153
#endif
14154
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
14155 14156
                    vshCommandRun(ctl, ctl->cmd);
            }
14157
            VIR_FREE(ctl->cmdstr);
14158
        } while (ctl->imode);
K
Karel Zak 已提交
14159

14160 14161
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
14162
    }
14163

K
Karel Zak 已提交
14164 14165
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
14166
}