virsh.c 397.0 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
    {"help", N_("destroy a domain")},
    {"desc", N_("Destroy a given domain.")},
2269
    {NULL, NULL}
2270 2271
};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

2358
            cpuUsed /= 1000000000.0;
2359

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

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

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

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

2377 2378 2379 2380 2381 2382 2383 2384 2385
    /* 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 */
2386
    if (!virDomainGetAutostart(dom, &autostart)) {
2387
        vshPrint(ctl, "%-15s %s\n", _("Autostart:"),
2388 2389 2390
                 autostart ? _("enable") : _("disable") );
    }

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

2578

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3096 3097 3098 3099 3100 3101 3102 3103
    /* 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 已提交
3104
        if ((ncpus = virDomainGetVcpuPinInfo(dom, info.nrVirtCpu,
3105 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
                                             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);
3150 3151
    /* Parse cpulist */
    cur = cpulist;
3152
    if (*cur == 0) {
3153
        goto parse_error;
3154 3155 3156
    } else if (*cur == 'r') {
        for (cpu = 0; cpu < maxcpu; cpu++)
            VIR_USE_CPU(cpumap, cpu);
3157
        cur = "";
3158
    }
3159 3160 3161 3162 3163 3164 3165

    while (*cur != 0) {

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

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

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

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

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

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

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

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

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

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

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

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

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

E
Eric Blake 已提交
3283 3284
    if (!flags) {
        if (virDomainSetVcpus(dom, count) != 0) {
E
Eric Blake 已提交
3285
            ret = false;
E
Eric Blake 已提交
3286 3287
        }
    } else {
3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300
        /* 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 已提交
3301
                ret = false;
3302 3303 3304 3305 3306
                goto cleanup;
            }
        }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    virDomainFree(dom);
    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    if (soft_limit)
        nparams++;

    if (swap_hard_limit)
        nparams++;

3748 3749 3750
    if (min_guarantee)
        nparams++;

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

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

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

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

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

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

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

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

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

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

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

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

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

3892 3893 3894 3895 3896
/*
 * "nodecpustats" command
 */
static const vshCmdInfo info_nodecpustats[] = {
    {"help", N_("Prints cpu stats of the node.")},
3897
    {"desc", N_("Returns cpu stats of the node, in nanoseconds.")},
3898 3899 3900 3901 3902 3903 3904 3905 3906 3907
    {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
3908
cmdNodeCpuStats(vshControl *ctl, const vshCmd *cmd)
3909 3910 3911 3912 3913 3914 3915 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 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 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
{
    int i, j;
    bool flag_utilization = false;
    bool flag_percent = vshCommandOptBool(cmd, "percent");
    int cpuNum = VIR_CPU_STATS_ALL_CPUS;
    virCPUStatsPtr params;
    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;

            if (STREQ(params[j].field, VIR_CPU_STATS_KERNEL)) {
                cpu_stats[i].sys = value;
            } else if (STREQ(params[j].field, VIR_CPU_STATS_USER)) {
                cpu_stats[i].user = value;
            } else if (STREQ(params[j].field, VIR_CPU_STATS_IDLE)) {
                cpu_stats[i].idle = value;
            } else if (STREQ(params[j].field, VIR_CPU_STATS_IOWAIT)) {
                cpu_stats[i].iowait = value;
            } else if (STREQ(params[j].field, VIR_CPU_STATS_UTILIZATION)) {
                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;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    return ret;
}

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

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

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

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

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

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

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

    return ret;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static void
doMigrate (void *opaque)
4391
{
4392
    char ret = '1';
4393
    virDomainPtr dom = NULL;
4394 4395 4396 4397
    const char *desturi = NULL;
    const char *migrateuri = NULL;
    const char *dname = NULL;
    int flags = 0;
4398 4399 4400
    vshCtrlData *data = opaque;
    vshControl *ctl = data->ctl;
    const vshCmd *cmd = data->cmd;
4401 4402
    const char *xmlfile = NULL;
    char *xml = NULL;
4403 4404
#if HAVE_PTHREAD_SIGMASK
    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
#endif
4411

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

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

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

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

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

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

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

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

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

4451 4452 4453 4454 4455 4456

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


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

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

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

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

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

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

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

4516
    fprintf(stderr, "\rMigration: [%3d %%]", progress);
W
Wen Congyang 已提交
4517 4518
}

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

    sigemptyset(&sigmask);
    sigaddset(&sigmask, SIGINT);
#endif
4543 4544

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

W
Wen Congyang 已提交
4547 4548 4549
    if (vshCommandOptBool (cmd, "verbose"))
        verbose = true;

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

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

        if (ret < 0) {
            if (errno == EINTR) {
                if (intCaught) {
                    virDomainAbortJob(dom);
                    intCaught = 0;
                } else
                    goto repoll;
            }
W
Wen Congyang 已提交
4620
            functionReturn = false;
W
Wen Congyang 已提交
4621 4622 4623
            break;
        }

W
Wen Congyang 已提交
4624 4625 4626 4627 4628 4629 4630 4631 4632
        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 已提交
4633
        if (verbose) {
4634
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
4635
            pthread_sigmask(SIG_BLOCK, &sigmask, &oldsigmask);
4636
#endif
W
Wen Congyang 已提交
4637
            ret = virDomainGetJobInfo(dom, &jobinfo);
4638
#if HAVE_PTHREAD_SIGMASK
W
Wen Congyang 已提交
4639
            pthread_sigmask(SIG_SETMASK, &oldsigmask, NULL);
4640
#endif
W
Wen Congyang 已提交
4641
            if (ret == 0)
4642
                print_job_progress(jobinfo.dataRemaining, jobinfo.dataTotal);
4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653
        }
    }

    sigaction(SIGINT, &old_sig_action, NULL);

    virThreadJoin(&workerThread);

cleanup:
    virDomainFree(dom);
    VIR_FORCE_CLOSE(p[0]);
    VIR_FORCE_CLOSE(p[1]);
W
Wen Congyang 已提交
4654
    return functionReturn;
4655 4656
}

4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667
/*
 * "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")},
4668
    {"downtime", VSH_OT_INT, VSH_OFLAG_REQ, N_("maximum tolerable downtime (in milliseconds) for migration")},
4669 4670 4671
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4672
static bool
4673 4674 4675
cmdMigrateSetMaxDowntime(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
4676
    long long downtime = 0;
E
Eric Blake 已提交
4677
    bool ret = false;
4678

4679
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4680
        return false;
4681 4682

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

4685 4686
    if (vshCommandOptLongLong(cmd, "downtime", &downtime) < 0 ||
        downtime < 1) {
4687 4688 4689 4690 4691 4692 4693
        vshError(ctl, "%s", _("migrate: Invalid downtime"));
        goto done;
    }

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

E
Eric Blake 已提交
4694
    ret = true;
4695 4696 4697 4698 4699 4700

done:
    virDomainFree(dom);
    return ret;
}

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 4736 4737 4738 4739 4740 4741 4742 4743 4744
/*
 * "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;
}

4745 4746 4747
/*
 * "net-autostart" command
 */
4748
static const vshCmdInfo info_network_autostart[] = {
4749
    {"help", N_("autostart a network")},
4750
    {"desc",
4751
     N_("Configure a network to be automatically started at boot.")},
4752 4753 4754
    {NULL, NULL}
};

4755
static const vshCmdOptDef opts_network_autostart[] = {
4756 4757
    {"network",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
4758 4759 4760
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4761
static bool
4762
cmdNetworkAutostart(vshControl *ctl, const vshCmd *cmd)
4763 4764
{
    virNetworkPtr network;
4765
    const char *name;
4766 4767
    int autostart;

4768
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4769
        return false;
4770

J
Jim Meyering 已提交
4771
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4772
        return false;
4773 4774 4775 4776

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

    if (virNetworkSetAutostart(network, autostart) < 0) {
4777
        if (autostart)
4778
            vshError(ctl, _("failed to mark network %s as autostarted"), name);
4779
        else
4780
            vshError(ctl, _("failed to unmark network %s as autostarted"), name);
4781
        virNetworkFree(network);
E
Eric Blake 已提交
4782
        return false;
4783 4784
    }

4785
    if (autostart)
4786
        vshPrint(ctl, _("Network %s marked as autostarted\n"), name);
4787
    else
4788
        vshPrint(ctl, _("Network %s unmarked as autostarted\n"), name);
4789

L
Laine Stump 已提交
4790
    virNetworkFree(network);
E
Eric Blake 已提交
4791
    return true;
4792
}
K
Karel Zak 已提交
4793

4794 4795 4796
/*
 * "net-create" command
 */
4797
static const vshCmdInfo info_network_create[] = {
4798 4799
    {"help", N_("create a network from an XML file")},
    {"desc", N_("Create a network.")},
4800 4801 4802
    {NULL, NULL}
};

4803
static const vshCmdOptDef opts_network_create[] = {
4804
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4805 4806 4807
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4808
static bool
4809
cmdNetworkCreate(vshControl *ctl, const vshCmd *cmd)
4810 4811
{
    virNetworkPtr network;
4812
    const char *from = NULL;
E
Eric Blake 已提交
4813
    bool ret = true;
4814
    char *buffer;
4815

4816
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4817
        return false;
4818

4819
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4820
        return false;
4821

4822
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4823
        return false;
4824 4825

    network = virNetworkCreateXML(ctl->conn, buffer);
4826
    VIR_FREE(buffer);
4827

4828 4829 4830
    if (network != NULL) {
        vshPrint(ctl, _("Network %s created from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4831
        virNetworkFree(network);
4832
    } else {
4833
        vshError(ctl, _("Failed to create network from %s"), from);
E
Eric Blake 已提交
4834
        ret = false;
4835 4836 4837 4838 4839 4840 4841 4842
    }
    return ret;
}


/*
 * "net-define" command
 */
4843
static const vshCmdInfo info_network_define[] = {
4844 4845
    {"help", N_("define (but don't start) a network from an XML file")},
    {"desc", N_("Define a network.")},
4846 4847 4848
    {NULL, NULL}
};

4849
static const vshCmdOptDef opts_network_define[] = {
4850
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML network description")},
4851 4852 4853
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4854
static bool
4855
cmdNetworkDefine(vshControl *ctl, const vshCmd *cmd)
4856 4857
{
    virNetworkPtr network;
4858
    const char *from = NULL;
E
Eric Blake 已提交
4859
    bool ret = true;
4860
    char *buffer;
4861

4862
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4863
        return false;
4864

4865
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
4866
        return false;
4867

4868
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
4869
        return false;
4870 4871

    network = virNetworkDefineXML(ctl->conn, buffer);
4872
    VIR_FREE(buffer);
4873

4874 4875 4876
    if (network != NULL) {
        vshPrint(ctl, _("Network %s defined from %s\n"),
                 virNetworkGetName(network), from);
L
Laine Stump 已提交
4877
        virNetworkFree(network);
4878
    } else {
4879
        vshError(ctl, _("Failed to define network from %s"), from);
E
Eric Blake 已提交
4880
        ret = false;
4881 4882 4883 4884 4885 4886 4887 4888
    }
    return ret;
}


/*
 * "net-destroy" command
 */
4889
static const vshCmdInfo info_network_destroy[] = {
4890 4891
    {"help", N_("destroy a network")},
    {"desc", N_("Destroy a given network.")},
4892 4893 4894
    {NULL, NULL}
};

4895
static const vshCmdOptDef opts_network_destroy[] = {
4896
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4897 4898 4899
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4900
static bool
4901
cmdNetworkDestroy(vshControl *ctl, const vshCmd *cmd)
4902 4903
{
    virNetworkPtr network;
E
Eric Blake 已提交
4904
    bool ret = true;
4905
    const char *name;
4906

4907
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4908
        return false;
4909

J
Jim Meyering 已提交
4910
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
4911
        return false;
4912 4913 4914 4915

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

4920
    virNetworkFree(network);
4921 4922 4923 4924 4925 4926 4927
    return ret;
}


/*
 * "net-dumpxml" command
 */
4928
static const vshCmdInfo info_network_dumpxml[] = {
4929 4930
    {"help", N_("network information in XML")},
    {"desc", N_("Output the network information as an XML dump to stdout.")},
4931 4932 4933
    {NULL, NULL}
};

4934
static const vshCmdOptDef opts_network_dumpxml[] = {
4935
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
4936 4937 4938
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
4939
static bool
4940
cmdNetworkDumpXML(vshControl *ctl, const vshCmd *cmd)
4941 4942
{
    virNetworkPtr network;
E
Eric Blake 已提交
4943
    bool ret = true;
4944 4945
    char *dump;

4946
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
4947
        return false;
4948

J
Jim Meyering 已提交
4949
    if (!(network = vshCommandOptNetwork(ctl, cmd, NULL)))
E
Eric Blake 已提交
4950
        return false;
4951 4952 4953

    dump = virNetworkGetXMLDesc(network, 0);
    if (dump != NULL) {
4954
        vshPrint(ctl, "%s", dump);
4955
        VIR_FREE(dump);
4956
    } else {
E
Eric Blake 已提交
4957
        ret = false;
4958 4959 4960 4961 4962 4963
    }

    virNetworkFree(network);
    return ret;
}

O
Osier Yang 已提交
4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977
/*
 * "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 已提交
4978
static bool
O
Osier Yang 已提交
4979 4980 4981 4982 4983 4984 4985 4986 4987 4988
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 已提交
4989
        return false;
O
Osier Yang 已提交
4990 4991 4992

    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
                                           VSH_BYNAME)))
E
Eric Blake 已提交
4993
        return false;
O
Osier Yang 已提交
4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019

    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 已提交
5020
    return true;
O
Osier Yang 已提交
5021
}
5022

5023 5024 5025 5026
/*
 * "iface-edit" command
 */
static const vshCmdInfo info_interface_edit[] = {
5027 5028
    {"help", N_("edit XML configuration for a physical host interface")},
    {"desc", N_("Edit the XML configuration for a physical host interface.")},
5029 5030 5031 5032
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_edit[] = {
5033
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5034 5035 5036
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5037
static bool
5038 5039
cmdInterfaceEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
5040
    bool ret = false;
5041 5042 5043 5044 5045
    virInterfacePtr iface = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
5046
    int flags = VIR_INTERFACE_XML_INACTIVE;
5047

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

cleanup:
    if (iface)
        virInterfaceFree (iface);

5108 5109 5110
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
5111 5112 5113

    if (tmp) {
        unlink (tmp);
5114
        VIR_FREE(tmp);
5115 5116 5117 5118 5119
    }

    return ret;
}

5120 5121 5122
/*
 * "net-list" command
 */
5123
static const vshCmdInfo info_network_list[] = {
5124 5125
    {"help", N_("list networks")},
    {"desc", N_("Returns list of networks.")},
5126 5127 5128
    {NULL, NULL}
};

5129
static const vshCmdOptDef opts_network_list[] = {
5130 5131
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive networks")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active networks")},
5132 5133 5134
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5135
static bool
5136
cmdNetworkList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
5137 5138 5139 5140 5141
{
    int inactive = vshCommandOptBool(cmd, "inactive");
    int all = vshCommandOptBool(cmd, "all");
    int active = !inactive || all ? 1 : 0;
    int maxactive = 0, maxinactive = 0, i;
5142
    char **activeNames = NULL, **inactiveNames = NULL;
5143 5144
    inactive |= all;

5145
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5146
        return false;
5147 5148

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

5157
            if ((maxactive = virConnectListNetworks(ctl->conn, activeNames,
5158
                                                    maxactive)) < 0) {
5159
                vshError(ctl, "%s", _("Failed to list active networks"));
5160
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5161
                return false;
5162
            }
5163

5164
            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
5165
        }
5166 5167
    }
    if (inactive) {
5168 5169
        maxinactive = virConnectNumOfDefinedNetworks(ctl->conn);
        if (maxinactive < 0) {
5170
            vshError(ctl, "%s", _("Failed to list inactive networks"));
5171
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5172
            return false;
5173
        }
5174 5175 5176
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5177 5178 5179
            if ((maxinactive =
                     virConnectListDefinedNetworks(ctl->conn, inactiveNames,
                                                   maxinactive)) < 0) {
5180
                vshError(ctl, "%s", _("Failed to list inactive networks"));
5181 5182
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5183
                return false;
5184
            }
5185

5186 5187
            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
5188
    }
5189 5190
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("Autostart"));
5191
    vshPrintExtra(ctl, "-----------------------------------------\n");
5192 5193

    for (i = 0; i < maxactive; i++) {
5194 5195
        virNetworkPtr network =
            virNetworkLookupByName(ctl->conn, activeNames[i]);
5196 5197
        const char *autostartStr;
        int autostart = 0;
5198 5199 5200

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5201
            VIR_FREE(activeNames[i]);
5202
            continue;
5203
        }
5204

5205 5206 5207
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5208
            autostartStr = autostart ? _("yes") : _("no");
5209 5210 5211 5212 5213

        vshPrint(ctl, "%-20s %-10s %-10s\n",
                 virNetworkGetName(network),
                 _("active"),
                 autostartStr);
5214
        virNetworkFree(network);
5215
        VIR_FREE(activeNames[i]);
5216 5217 5218
    }
    for (i = 0; i < maxinactive; i++) {
        virNetworkPtr network = virNetworkLookupByName(ctl->conn, inactiveNames[i]);
5219 5220
        const char *autostartStr;
        int autostart = 0;
5221 5222 5223

        /* this kind of work with networks is not atomic operation */
        if (!network) {
5224
            VIR_FREE(inactiveNames[i]);
5225
            continue;
5226
        }
5227

5228 5229 5230
        if (virNetworkGetAutostart(network, &autostart) < 0)
            autostartStr = _("no autostart");
        else
5231
            autostartStr = autostart ? _("yes") : _("no");
5232

5233
        vshPrint(ctl, "%-20s %-10s %-10s\n",
5234 5235 5236
                 inactiveNames[i],
                 _("inactive"),
                 autostartStr);
5237 5238

        virNetworkFree(network);
5239
        VIR_FREE(inactiveNames[i]);
5240
    }
5241 5242
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5243
    return true;
5244 5245 5246 5247 5248 5249
}


/*
 * "net-name" command
 */
5250
static const vshCmdInfo info_network_name[] = {
5251
    {"help", N_("convert a network UUID to network name")},
5252
    {"desc", ""},
5253 5254 5255
    {NULL, NULL}
};

5256
static const vshCmdOptDef opts_network_name[] = {
5257
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network uuid")},
5258 5259 5260
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5261
static bool
5262
cmdNetworkName(vshControl *ctl, const vshCmd *cmd)
5263 5264 5265
{
    virNetworkPtr network;

5266
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5267
        return false;
J
Jim Meyering 已提交
5268
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5269
                                           VSH_BYUUID)))
E
Eric Blake 已提交
5270
        return false;
5271 5272 5273

    vshPrint(ctl, "%s\n", virNetworkGetName(network));
    virNetworkFree(network);
E
Eric Blake 已提交
5274
    return true;
5275 5276 5277 5278 5279 5280
}


/*
 * "net-start" command
 */
5281
static const vshCmdInfo info_network_start[] = {
5282 5283
    {"help", N_("start a (previously defined) inactive network")},
    {"desc", N_("Start a network.")},
5284 5285 5286
    {NULL, NULL}
};

5287
static const vshCmdOptDef opts_network_start[] = {
5288
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive network")},
5289 5290 5291
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5292
static bool
5293
cmdNetworkStart(vshControl *ctl, const vshCmd *cmd)
5294 5295
{
    virNetworkPtr network;
E
Eric Blake 已提交
5296
    bool ret = true;
5297

5298
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5299
        return false;
5300

J
Jim Meyering 已提交
5301
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL, VSH_BYNAME)))
E
Eric Blake 已提交
5302
         return false;
5303 5304 5305

    if (virNetworkCreate(network) == 0) {
        vshPrint(ctl, _("Network %s started\n"),
5306
                 virNetworkGetName(network));
5307
    } else {
5308
        vshError(ctl, _("Failed to start network %s"),
5309
                 virNetworkGetName(network));
E
Eric Blake 已提交
5310
        ret = false;
5311
    }
L
Laine Stump 已提交
5312
    virNetworkFree(network);
5313 5314 5315 5316 5317 5318 5319
    return ret;
}


/*
 * "net-undefine" command
 */
5320
static const vshCmdInfo info_network_undefine[] = {
5321 5322
    {"help", N_("undefine an inactive network")},
    {"desc", N_("Undefine the configuration for an inactive network.")},
5323 5324 5325
    {NULL, NULL}
};

5326
static const vshCmdOptDef opts_network_undefine[] = {
5327
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
5328 5329 5330
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5331
static bool
5332
cmdNetworkUndefine(vshControl *ctl, const vshCmd *cmd)
5333 5334
{
    virNetworkPtr network;
E
Eric Blake 已提交
5335
    bool ret = true;
5336
    const char *name;
5337

5338
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5339
        return false;
5340

J
Jim Meyering 已提交
5341
    if (!(network = vshCommandOptNetwork(ctl, cmd, &name)))
E
Eric Blake 已提交
5342
        return false;
5343 5344 5345 5346

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

L
Laine Stump 已提交
5351
    virNetworkFree(network);
5352 5353 5354 5355 5356 5357 5358
    return ret;
}


/*
 * "net-uuid" command
 */
5359
static const vshCmdInfo info_network_uuid[] = {
5360
    {"help", N_("convert a network name to network UUID")},
5361
    {"desc", ""},
5362 5363 5364
    {NULL, NULL}
};

5365
static const vshCmdOptDef opts_network_uuid[] = {
5366
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name")},
5367 5368 5369
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5370
static bool
5371
cmdNetworkUuid(vshControl *ctl, const vshCmd *cmd)
5372 5373 5374 5375
{
    virNetworkPtr network;
    char uuid[VIR_UUID_STRING_BUFLEN];

5376
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5377
        return false;
5378

J
Jim Meyering 已提交
5379
    if (!(network = vshCommandOptNetworkBy(ctl, cmd, NULL,
5380
                                           VSH_BYNAME)))
E
Eric Blake 已提交
5381
        return false;
5382 5383 5384 5385

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

L
Laine Stump 已提交
5388
    virNetworkFree(network);
E
Eric Blake 已提交
5389
    return true;
5390 5391 5392
}


5393 5394 5395 5396 5397
/**************************************************************************/
/*
 * "iface-list" command
 */
static const vshCmdInfo info_interface_list[] = {
5398 5399
    {"help", N_("list physical host interfaces")},
    {"desc", N_("Returns list of physical host interfaces.")},
5400 5401 5402 5403
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_list[] = {
5404 5405
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive interfaces")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active interfaces")},
5406 5407
    {NULL, 0, 0, NULL}
};
E
Eric Blake 已提交
5408
static bool
5409 5410 5411 5412 5413 5414 5415 5416 5417
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;

5418
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5419
        return false;
5420 5421 5422 5423

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

            if ((maxactive = virConnectListInterfaces(ctl->conn, activeNames,
                                                    maxactive)) < 0) {
5432
                vshError(ctl, "%s", _("Failed to list active interfaces"));
5433
                VIR_FREE(activeNames);
E
Eric Blake 已提交
5434
                return false;
5435 5436 5437 5438 5439 5440 5441 5442
            }

            qsort(&activeNames[0], maxactive, sizeof(char *), namesorter);
        }
    }
    if (inactive) {
        maxinactive = virConnectNumOfDefinedInterfaces(ctl->conn);
        if (maxinactive < 0) {
5443
            vshError(ctl, "%s", _("Failed to list inactive interfaces"));
5444
            VIR_FREE(activeNames);
E
Eric Blake 已提交
5445
            return false;
5446 5447 5448 5449
        }
        if (maxinactive) {
            inactiveNames = vshMalloc(ctl, sizeof(char *) * maxinactive);

5450 5451 5452
            if ((maxinactive =
                     virConnectListDefinedInterfaces(ctl->conn, inactiveNames,
                                                     maxinactive)) < 0) {
5453
                vshError(ctl, "%s", _("Failed to list inactive interfaces"));
5454 5455
                VIR_FREE(activeNames);
                VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5456
                return false;
5457 5458 5459 5460 5461
            }

            qsort(&inactiveNames[0], maxinactive, sizeof(char*), namesorter);
        }
    }
5462 5463
    vshPrintExtra(ctl, "%-20s %-10s %s\n", _("Name"), _("State"),
                  _("MAC Address"));
5464 5465 5466
    vshPrintExtra(ctl, "--------------------------------------------\n");

    for (i = 0; i < maxactive; i++) {
5467 5468
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, activeNames[i]);
5469 5470 5471

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
5472
            VIR_FREE(activeNames[i]);
5473 5474 5475 5476 5477 5478 5479 5480
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("active"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
5481
        VIR_FREE(activeNames[i]);
5482 5483
    }
    for (i = 0; i < maxinactive; i++) {
5484 5485
        virInterfacePtr iface =
            virInterfaceLookupByName(ctl->conn, inactiveNames[i]);
5486 5487 5488

        /* this kind of work with interfaces is not atomic */
        if (!iface) {
5489
            VIR_FREE(inactiveNames[i]);
5490 5491 5492 5493 5494 5495 5496 5497
            continue;
        }

        vshPrint(ctl, "%-20s %-10s %s\n",
                 virInterfaceGetName(iface),
                 _("inactive"),
                 virInterfaceGetMACString(iface));
        virInterfaceFree(iface);
5498
        VIR_FREE(inactiveNames[i]);
5499
    }
5500 5501
    VIR_FREE(activeNames);
    VIR_FREE(inactiveNames);
E
Eric Blake 已提交
5502
    return true;
5503 5504 5505 5506 5507 5508 5509

}

/*
 * "iface-name" command
 */
static const vshCmdInfo info_interface_name[] = {
5510
    {"help", N_("convert an interface MAC address to interface name")},
5511 5512 5513 5514 5515
    {"desc", ""},
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_name[] = {
5516
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface mac")},
5517 5518 5519
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5520
static bool
5521 5522 5523 5524
cmdInterfaceName(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;

5525
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5526
        return false;
5527 5528
    if (!(iface = vshCommandOptInterfaceBy(ctl, cmd, NULL,
                                           VSH_BYMAC)))
E
Eric Blake 已提交
5529
        return false;
5530 5531 5532

    vshPrint(ctl, "%s\n", virInterfaceGetName(iface));
    virInterfaceFree(iface);
E
Eric Blake 已提交
5533
    return true;
5534 5535 5536 5537 5538 5539
}

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

static const vshCmdOptDef opts_interface_mac[] = {
5546
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name")},
5547 5548 5549
    {NULL, 0, 0, NULL}
};

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

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

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

/*
 * "iface-dumpxml" command
 */
static const vshCmdInfo info_interface_dumpxml[] = {
5570 5571
    {"help", N_("interface information in XML")},
    {"desc", N_("Output the physical host interface information as an XML dump to stdout.")},
5572 5573 5574 5575
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_dumpxml[] = {
5576 5577
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
    {"inactive", VSH_OT_BOOL, 0, N_("show inactive defined XML")},
5578 5579 5580
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5581
static bool
5582 5583 5584
cmdInterfaceDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5585
    bool ret = true;
5586
    char *dump;
5587 5588 5589 5590 5591
    int flags = 0;
    int inactive = vshCommandOptBool(cmd, "inactive");

    if (inactive)
        flags |= VIR_INTERFACE_XML_INACTIVE;
5592

5593
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5594
        return false;
5595 5596

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

5599
    dump = virInterfaceGetXMLDesc(iface, flags);
5600
    if (dump != NULL) {
5601
        vshPrint(ctl, "%s", dump);
5602
        VIR_FREE(dump);
5603
    } else {
E
Eric Blake 已提交
5604
        ret = false;
5605 5606 5607 5608 5609 5610 5611 5612 5613 5614
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-define" command
 */
static const vshCmdInfo info_interface_define[] = {
5615 5616
    {"help", N_("define (but don't start) a physical host interface from an XML file")},
    {"desc", N_("Define a physical host interface.")},
5617 5618 5619 5620
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_define[] = {
5621
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML interface description")},
5622 5623 5624
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5625
static bool
5626 5627
cmdInterfaceDefine(vshControl *ctl, const vshCmd *cmd)
{
5628
    virInterfacePtr iface;
5629
    const char *from = NULL;
E
Eric Blake 已提交
5630
    bool ret = true;
5631 5632
    char *buffer;

5633
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5634
        return false;
5635

5636
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5637
        return false;
5638 5639

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

5642
    iface = virInterfaceDefineXML(ctl->conn, buffer, 0);
5643
    VIR_FREE(buffer);
5644

5645
    if (iface != NULL) {
5646
        vshPrint(ctl, _("Interface %s defined from %s\n"),
5647
                 virInterfaceGetName(iface), from);
L
Laine Stump 已提交
5648
        virInterfaceFree (iface);
5649
    } else {
5650
        vshError(ctl, _("Failed to define interface from %s"), from);
E
Eric Blake 已提交
5651
        ret = false;
5652 5653 5654 5655 5656 5657 5658 5659
    }
    return ret;
}

/*
 * "iface-undefine" command
 */
static const vshCmdInfo info_interface_undefine[] = {
5660 5661
    {"help", N_("undefine a physical host interface (remove it from configuration)")},
    {"desc", N_("undefine an interface.")},
5662 5663 5664 5665
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_undefine[] = {
5666
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5667 5668 5669
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5670
static bool
5671 5672 5673
cmdInterfaceUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5674
    bool ret = true;
5675
    const char *name;
5676

5677
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5678
        return false;
5679 5680

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5681
        return false;
5682 5683 5684 5685

    if (virInterfaceUndefine(iface) == 0) {
        vshPrint(ctl, _("Interface %s undefined\n"), name);
    } else {
5686
        vshError(ctl, _("Failed to undefine interface %s"), name);
E
Eric Blake 已提交
5687
        ret = false;
5688 5689 5690 5691 5692 5693 5694 5695 5696 5697
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-start" command
 */
static const vshCmdInfo info_interface_start[] = {
5698 5699
    {"help", N_("start a physical host interface (enable it / \"if-up\")")},
    {"desc", N_("start a physical host interface.")},
5700 5701 5702 5703
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_start[] = {
5704
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5705 5706 5707
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5708
static bool
5709 5710 5711
cmdInterfaceStart(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5712
    bool ret = true;
5713
    const char *name;
5714

5715
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5716
        return false;
5717 5718

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5719
        return false;
5720 5721 5722 5723

    if (virInterfaceCreate(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s started\n"), name);
    } else {
5724
        vshError(ctl, _("Failed to start interface %s"), name);
E
Eric Blake 已提交
5725
        ret = false;
5726 5727 5728 5729 5730 5731 5732 5733 5734 5735
    }

    virInterfaceFree(iface);
    return ret;
}

/*
 * "iface-destroy" command
 */
static const vshCmdInfo info_interface_destroy[] = {
5736 5737
    {"help", N_("destroy a physical host interface (disable it / \"if-down\")")},
    {"desc", N_("destroy a physical host interface.")},
5738 5739 5740 5741
    {NULL, NULL}
};

static const vshCmdOptDef opts_interface_destroy[] = {
5742
    {"interface", VSH_OT_DATA, VSH_OFLAG_REQ, N_("interface name or MAC address")},
5743 5744 5745
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
5746
static bool
5747 5748 5749
cmdInterfaceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virInterfacePtr iface;
E
Eric Blake 已提交
5750
    bool ret = true;
5751
    const char *name;
5752

5753
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5754
        return false;
5755 5756

    if (!(iface = vshCommandOptInterface(ctl, cmd, &name)))
E
Eric Blake 已提交
5757
        return false;
5758 5759 5760 5761

    if (virInterfaceDestroy(iface, 0) == 0) {
        vshPrint(ctl, _("Interface %s destroyed\n"), name);
    } else {
5762
        vshError(ctl, _("Failed to destroy interface %s"), name);
E
Eric Blake 已提交
5763
        ret = false;
5764 5765 5766 5767 5768 5769
    }

    virInterfaceFree(iface);
    return ret;
}

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 5846 5847 5848 5849 5850 5851 5852 5853 5854
/*
 * "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;
}
5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869

/*
 * "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 已提交
5870
static bool
5871 5872 5873
cmdNWFilterDefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
5874
    const char *from = NULL;
E
Eric Blake 已提交
5875
    bool ret = true;
5876 5877
    char *buffer;

5878
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5879
        return false;
5880

5881
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
5882
        return false;
5883 5884

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
5885
        return false;
5886 5887 5888 5889 5890 5891 5892 5893 5894 5895

    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 已提交
5896
        ret = false;
5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915
    }
    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 已提交
5916
static bool
5917 5918 5919
cmdNWFilterUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5920
    bool ret = true;
5921
    const char *name;
5922

5923
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5924
        return false;
5925 5926

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, &name)))
E
Eric Blake 已提交
5927
        return false;
5928 5929 5930 5931 5932

    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 已提交
5933
        ret = false;
5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954
    }

    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 已提交
5955
static bool
5956 5957 5958
cmdNWFilterDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virNWFilterPtr nwfilter;
E
Eric Blake 已提交
5959
    bool ret = true;
5960 5961
    char *dump;

5962
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
5963
        return false;
5964 5965

    if (!(nwfilter = vshCommandOptNWFilter(ctl, cmd, NULL)))
E
Eric Blake 已提交
5966
        return false;
5967 5968 5969

    dump = virNWFilterGetXMLDesc(nwfilter, 0);
    if (dump != NULL) {
5970
        vshPrint(ctl, "%s", dump);
5971 5972
        VIR_FREE(dump);
    } else {
E
Eric Blake 已提交
5973
        ret = false;
5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992
    }

    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 已提交
5993
static bool
5994 5995 5996 5997 5998 5999
cmdNWFilterList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int numfilters, i;
    char **names;
    char uuid[VIR_UUID_STRING_BUFLEN];

6000
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6001
        return false;
6002 6003 6004 6005

    numfilters = virConnectNumOfNWFilters(ctl->conn);
    if (numfilters < 0) {
        vshError(ctl, "%s", _("Failed to list network filters"));
E
Eric Blake 已提交
6006
        return false;
6007 6008 6009 6010 6011 6012 6013 6014
    }

    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 已提交
6015
        return false;
6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042
    }

    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 已提交
6043
    return true;
6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060
}


/*
 * "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 已提交
6061
static bool
6062 6063
cmdNWFilterEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
6064
    bool ret = false;
6065 6066 6067 6068 6069 6070
    virNWFilterPtr nwfilter = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;

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

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


6144
/**************************************************************************/
6145
/*
6146
 * "pool-autostart" command
6147
 */
6148
static const vshCmdInfo info_pool_autostart[] = {
6149
    {"help", N_("autostart a pool")},
6150
    {"desc",
6151
     N_("Configure a pool to be automatically started at boot.")},
6152
    {NULL, NULL}
6153 6154
};

6155
static const vshCmdOptDef opts_pool_autostart[] = {
6156 6157
    {"pool",  VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
    {"disable", VSH_OT_BOOL, 0, N_("disable autostarting")},
6158 6159
    {NULL, 0, 0, NULL}
};
6160

E
Eric Blake 已提交
6161
static bool
6162
cmdPoolAutostart(vshControl *ctl, const vshCmd *cmd)
6163
{
6164
    virStoragePoolPtr pool;
6165
    const char *name;
6166
    int autostart;
6167

6168
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6169
        return false;
6170

6171
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6172
        return false;
6173

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

6176 6177
    if (virStoragePoolSetAutostart(pool, autostart) < 0) {
        if (autostart)
6178
            vshError(ctl, _("failed to mark pool %s as autostarted"), name);
6179
        else
6180
            vshError(ctl, _("failed to unmark pool %s as autostarted"), name);
6181
        virStoragePoolFree(pool);
E
Eric Blake 已提交
6182
        return false;
6183 6184
    }

6185
    if (autostart)
6186
        vshPrint(ctl, _("Pool %s marked as autostarted\n"), name);
6187
    else
6188
        vshPrint(ctl, _("Pool %s unmarked as autostarted\n"), name);
6189

L
Laine Stump 已提交
6190
    virStoragePoolFree(pool);
E
Eric Blake 已提交
6191
    return true;
6192 6193
}

6194
/*
6195
 * "pool-create" command
6196
 */
6197
static const vshCmdInfo info_pool_create[] = {
6198 6199
    {"help", N_("create a pool from an XML file")},
    {"desc", N_("Create a pool.")},
6200 6201 6202
    {NULL, NULL}
};

6203
static const vshCmdOptDef opts_pool_create[] = {
J
Jim Meyering 已提交
6204
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ,
6205
     N_("file containing an XML pool description")},
6206 6207 6208
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6209
static bool
6210
cmdPoolCreate(vshControl *ctl, const vshCmd *cmd)
6211
{
6212
    virStoragePoolPtr pool;
6213
    const char *from = NULL;
E
Eric Blake 已提交
6214
    bool ret = true;
6215
    char *buffer;
6216

6217
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6218
        return false;
6219

6220
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6221
        return false;
6222

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

6226
    pool = virStoragePoolCreateXML(ctl->conn, buffer, 0);
6227
    VIR_FREE(buffer);
6228 6229 6230 6231

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s created from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6232
        virStoragePoolFree(pool);
6233
    } else {
6234
        vshError(ctl, _("Failed to create pool from %s"), from);
E
Eric Blake 已提交
6235
        ret = false;
6236 6237
    }
    return ret;
6238 6239
}

6240

6241 6242 6243 6244
/*
 * "nodedev-create" command
 */
static const vshCmdInfo info_node_device_create[] = {
6245
    {"help", N_("create a device defined "
6246
                          "by an XML file on the node")},
6247
    {"desc", N_("Create a device on the node.  Note that this "
6248 6249 6250 6251 6252 6253 6254
                          "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,
6255
     N_("file containing an XML description of the device")},
6256 6257 6258
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6259
static bool
6260 6261 6262
cmdNodeDeviceCreate(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
6263
    const char *from = NULL;
E
Eric Blake 已提交
6264
    bool ret = true;
6265 6266
    char *buffer;

6267
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6268
        return false;
6269

6270
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6271
        return false;
6272

6273
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
6274
        return false;
6275 6276

    dev = virNodeDeviceCreateXML(ctl->conn, buffer, 0);
6277
    VIR_FREE(buffer);
6278 6279 6280 6281

    if (dev != NULL) {
        vshPrint(ctl, _("Node device %s created from %s\n"),
                 virNodeDeviceGetName(dev), from);
L
Laine Stump 已提交
6282
        virNodeDeviceFree(dev);
6283
    } else {
6284
        vshError(ctl, _("Failed to create node device from %s"), from);
E
Eric Blake 已提交
6285
        ret = false;
6286 6287 6288 6289 6290 6291 6292 6293 6294 6295
    }

    return ret;
}


/*
 * "nodedev-destroy" command
 */
static const vshCmdInfo info_node_device_destroy[] = {
6296 6297
    {"help", N_("destroy a device on the node")},
    {"desc", N_("Destroy a device on the node.  Note that this "
6298 6299 6300 6301 6302 6303
                          "command destroys devices on the physical host ")},
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_device_destroy[] = {
    {"name", VSH_OT_DATA, VSH_OFLAG_REQ,
6304
     N_("name of the device to be destroyed")},
6305 6306 6307
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6308
static bool
6309 6310 6311
cmdNodeDeviceDestroy(vshControl *ctl, const vshCmd *cmd)
{
    virNodeDevicePtr dev = NULL;
E
Eric Blake 已提交
6312
    bool ret = true;
6313
    const char *name = NULL;
6314

6315
    if (!vshConnectionUsability(ctl, ctl->conn)) {
E
Eric Blake 已提交
6316
        return false;
6317 6318
    }

6319
    if (vshCommandOptString(cmd, "name", &name) <= 0)
E
Eric Blake 已提交
6320
        return false;
6321 6322 6323 6324 6325 6326

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

    if (virNodeDeviceDestroy(dev) == 0) {
        vshPrint(ctl, _("Destroyed node device '%s'\n"), name);
    } else {
6327
        vshError(ctl, _("Failed to destroy node device '%s'"), name);
E
Eric Blake 已提交
6328
        ret = false;
6329 6330 6331 6332 6333 6334 6335
    }

    virNodeDeviceFree(dev);
    return ret;
}


6336
/*
6337
 * XML Building helper for pool-define-as and pool-create-as
6338
 */
6339
static const vshCmdOptDef opts_pool_X_as[] = {
6340 6341 6342 6343 6344 6345 6346 6347
    {"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")},
6348
    {"source-format", VSH_OT_STRING, 0, N_("format for underlying storage")},
6349 6350 6351
    {NULL, 0, 0, NULL}
};

6352
static int buildPoolXML(const vshCmd *cmd, const char **retname, char **xml) {
6353

6354 6355
    const char *name = NULL, *type = NULL, *srcHost = NULL, *srcPath = NULL,
               *srcDev = NULL, *srcName = NULL, *srcFormat = NULL, *target = NULL;
6356
    virBuffer buf = VIR_BUFFER_INITIALIZER;
6357

6358
    if (vshCommandOptString(cmd, "name", &name) <= 0)
6359
        goto cleanup;
6360
    if (vshCommandOptString(cmd, "type", &type) <= 0)
6361 6362
        goto cleanup;

6363 6364 6365 6366 6367
    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 ||
6368 6369
        vshCommandOptString(cmd, "target", &target) < 0) {
        vshError(NULL, "%s", _("missing argument"));
6370
        goto cleanup;
6371
    }
6372

6373 6374
    virBufferAsprintf(&buf, "<pool type='%s'>\n", type);
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
6375
    if (srcHost || srcPath || srcDev) {
6376
        virBufferAddLit(&buf, "  <source>\n");
6377

6378
        if (srcHost)
6379
            virBufferAsprintf(&buf, "    <host name='%s'/>\n", srcHost);
6380
        if (srcPath)
6381
            virBufferAsprintf(&buf, "    <dir path='%s'/>\n", srcPath);
6382
        if (srcDev)
6383
            virBufferAsprintf(&buf, "    <device path='%s'/>\n", srcDev);
6384
        if (srcFormat)
6385
            virBufferAsprintf(&buf, "    <format type='%s'/>\n", srcFormat);
6386
        if (srcName)
6387
            virBufferAsprintf(&buf, "    <name>%s</name>\n", srcName);
6388 6389

        virBufferAddLit(&buf, "  </source>\n");
6390 6391
    }
    if (target) {
6392
        virBufferAddLit(&buf, "  <target>\n");
6393
        virBufferAsprintf(&buf, "    <path>%s</path>\n", target);
6394
        virBufferAddLit(&buf, "  </target>\n");
6395
    }
6396 6397 6398 6399
    virBufferAddLit(&buf, "</pool>\n");

    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
6400
        return false;
6401
    }
6402 6403 6404

    *xml = virBufferContentAndReset(&buf);
    *retname = name;
E
Eric Blake 已提交
6405
    return true;
6406 6407

cleanup:
6408
    virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
6409
    return false;
6410 6411 6412 6413 6414 6415
}

/*
 * "pool-create-as" command
 */
static const vshCmdInfo info_pool_create_as[] = {
6416 6417
    {"help", N_("create a pool from a set of args")},
    {"desc", N_("Create a pool.")},
6418 6419 6420
    {NULL, NULL}
};

E
Eric Blake 已提交
6421
static bool
6422 6423 6424
cmdPoolCreateAs(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
6425 6426
    const char *name;
    char *xml;
6427
    int printXML = vshCommandOptBool(cmd, "print-xml");
6428

6429
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6430
        return false;
6431 6432

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

6435
    if (printXML) {
6436
        vshPrint(ctl, "%s", xml);
6437
        VIR_FREE(xml);
6438
    } else {
6439
        pool = virStoragePoolCreateXML(ctl->conn, xml, 0);
6440
        VIR_FREE(xml);
6441

6442 6443 6444 6445
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s created\n"), name);
            virStoragePoolFree(pool);
        } else {
6446
            vshError(ctl, _("Failed to create pool %s"), name);
E
Eric Blake 已提交
6447
            return false;
6448 6449
        }
    }
E
Eric Blake 已提交
6450
    return true;
6451 6452
}

6453

6454
/*
6455
 * "pool-define" command
6456
 */
6457
static const vshCmdInfo info_pool_define[] = {
6458 6459
    {"help", N_("define (but don't start) a pool from an XML file")},
    {"desc", N_("Define a pool.")},
6460 6461 6462
    {NULL, NULL}
};

6463
static const vshCmdOptDef opts_pool_define[] = {
6464
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML pool description")},
6465 6466 6467
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6468
static bool
6469
cmdPoolDefine(vshControl *ctl, const vshCmd *cmd)
6470
{
6471
    virStoragePoolPtr pool;
6472
    const char *from = NULL;
E
Eric Blake 已提交
6473
    bool ret = true;
6474
    char *buffer;
6475

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

6479
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
6480
        return false;
6481

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

6485
    pool = virStoragePoolDefineXML(ctl->conn, buffer, 0);
6486
    VIR_FREE(buffer);
6487 6488 6489 6490

    if (pool != NULL) {
        vshPrint(ctl, _("Pool %s defined from %s\n"),
                 virStoragePoolGetName(pool), from);
L
Laine Stump 已提交
6491
        virStoragePoolFree(pool);
6492
    } else {
6493
        vshError(ctl, _("Failed to define pool from %s"), from);
E
Eric Blake 已提交
6494
        ret = false;
6495 6496
    }
    return ret;
6497 6498
}

6499

6500 6501 6502
/*
 * "pool-define-as" command
 */
6503
static const vshCmdInfo info_pool_define_as[] = {
6504 6505
    {"help", N_("define a pool from a set of args")},
    {"desc", N_("Define a pool.")},
6506 6507 6508
    {NULL, NULL}
};

E
Eric Blake 已提交
6509
static bool
6510
cmdPoolDefineAs(vshControl *ctl, const vshCmd *cmd)
6511 6512
{
    virStoragePoolPtr pool;
6513 6514
    const char *name;
    char *xml;
6515
    int printXML = vshCommandOptBool(cmd, "print-xml");
6516

6517
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6518
        return false;
6519

6520
    if (!buildPoolXML(cmd, &name, &xml))
E
Eric Blake 已提交
6521
        return false;
6522

6523
    if (printXML) {
6524
        vshPrint(ctl, "%s", xml);
6525
        VIR_FREE(xml);
6526
    } else {
6527
        pool = virStoragePoolDefineXML(ctl->conn, xml, 0);
6528
        VIR_FREE(xml);
6529

6530 6531 6532 6533
        if (pool != NULL) {
            vshPrint(ctl, _("Pool %s defined\n"), name);
            virStoragePoolFree(pool);
        } else {
6534
            vshError(ctl, _("Failed to define pool %s"), name);
E
Eric Blake 已提交
6535
            return false;
6536 6537
        }
    }
E
Eric Blake 已提交
6538
    return true;
6539 6540 6541
}


6542
/*
6543
 * "pool-build" command
6544
 */
6545
static const vshCmdInfo info_pool_build[] = {
6546 6547
    {"help", N_("build a pool")},
    {"desc", N_("Build a given pool.")},
6548 6549 6550
    {NULL, NULL}
};

6551
static const vshCmdOptDef opts_pool_build[] = {
6552
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6553 6554 6555
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6556
static bool
6557
cmdPoolBuild(vshControl *ctl, const vshCmd *cmd)
6558
{
6559
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6560
    bool ret = true;
6561
    const char *name;
6562

6563
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6564
        return false;
6565

6566
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6567
        return false;
6568

6569
    if (virStoragePoolBuild(pool, 0) == 0) {
6570
        vshPrint(ctl, _("Pool %s built\n"), name);
6571
    } else {
6572
        vshError(ctl, _("Failed to build pool %s"), name);
E
Eric Blake 已提交
6573
        ret = false;
6574 6575
    }

6576 6577
    virStoragePoolFree(pool);

6578 6579 6580
    return ret;
}

6581

6582
/*
6583
 * "pool-destroy" command
6584
 */
6585
static const vshCmdInfo info_pool_destroy[] = {
6586 6587
    {"help", N_("destroy a pool")},
    {"desc", N_("Destroy a given pool.")},
6588 6589 6590
    {NULL, NULL}
};

6591
static const vshCmdOptDef opts_pool_destroy[] = {
6592
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6593 6594 6595
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6596
static bool
6597
cmdPoolDestroy(vshControl *ctl, const vshCmd *cmd)
6598
{
6599
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6600
    bool ret = true;
6601
    const char *name;
6602

6603
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6604
        return false;
6605

6606
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6607
        return false;
6608

6609 6610 6611
    if (virStoragePoolDestroy(pool) == 0) {
        vshPrint(ctl, _("Pool %s destroyed\n"), name);
    } else {
6612
        vshError(ctl, _("Failed to destroy pool %s"), name);
E
Eric Blake 已提交
6613
        ret = false;
6614 6615
    }

6616
    virStoragePoolFree(pool);
6617 6618 6619
    return ret;
}

6620

6621
/*
6622 6623
 * "pool-delete" command
 */
6624
static const vshCmdInfo info_pool_delete[] = {
6625 6626
    {"help", N_("delete a pool")},
    {"desc", N_("Delete a given pool.")},
6627 6628 6629
    {NULL, NULL}
};

6630
static const vshCmdOptDef opts_pool_delete[] = {
6631
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6632 6633 6634
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6635
static bool
6636
cmdPoolDelete(vshControl *ctl, const vshCmd *cmd)
6637 6638
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6639
    bool ret = true;
6640
    const char *name;
6641

6642
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6643
        return false;
6644 6645

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6646
        return false;
6647 6648

    if (virStoragePoolDelete(pool, 0) == 0) {
D
Daniel Veillard 已提交
6649
        vshPrint(ctl, _("Pool %s deleted\n"), name);
6650
    } else {
6651
        vshError(ctl, _("Failed to delete pool %s"), name);
E
Eric Blake 已提交
6652
        ret = false;
6653 6654
    }

L
Laine Stump 已提交
6655
    virStoragePoolFree(pool);
6656 6657 6658 6659 6660 6661 6662
    return ret;
}


/*
 * "pool-refresh" command
 */
6663
static const vshCmdInfo info_pool_refresh[] = {
6664 6665
    {"help", N_("refresh a pool")},
    {"desc", N_("Refresh a given pool.")},
6666 6667 6668
    {NULL, NULL}
};

6669
static const vshCmdOptDef opts_pool_refresh[] = {
6670
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6671 6672 6673
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6674
static bool
6675
cmdPoolRefresh(vshControl *ctl, const vshCmd *cmd)
6676 6677
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6678
    bool ret = true;
6679
    const char *name;
6680

6681
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6682
        return false;
6683 6684

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
6685
        return false;
6686 6687 6688 6689

    if (virStoragePoolRefresh(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s refreshed\n"), name);
    } else {
6690
        vshError(ctl, _("Failed to refresh pool %s"), name);
E
Eric Blake 已提交
6691
        ret = false;
6692 6693 6694 6695 6696 6697 6698 6699 6700 6701
    }
    virStoragePoolFree(pool);

    return ret;
}


/*
 * "pool-dumpxml" command
 */
6702
static const vshCmdInfo info_pool_dumpxml[] = {
6703 6704
    {"help", N_("pool information in XML")},
    {"desc", N_("Output the pool information as an XML dump to stdout.")},
6705 6706 6707
    {NULL, NULL}
};

6708
static const vshCmdOptDef opts_pool_dumpxml[] = {
6709
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
6710 6711 6712
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
6713
static bool
6714
cmdPoolDumpXML(vshControl *ctl, const vshCmd *cmd)
6715 6716
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
6717
    bool ret = true;
6718 6719
    char *dump;

6720
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6721
        return false;
6722 6723

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
6724
        return false;
6725 6726 6727

    dump = virStoragePoolGetXMLDesc(pool, 0);
    if (dump != NULL) {
6728
        vshPrint(ctl, "%s", dump);
6729
        VIR_FREE(dump);
6730
    } else {
E
Eric Blake 已提交
6731
        ret = false;
6732 6733 6734 6735 6736 6737 6738 6739 6740 6741
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-list" command
 */
6742
static const vshCmdInfo info_pool_list[] = {
6743 6744
    {"help", N_("list pools")},
    {"desc", N_("Returns list of pools.")},
6745 6746 6747
    {NULL, NULL}
};

6748
static const vshCmdOptDef opts_pool_list[] = {
6749 6750
    {"inactive", VSH_OT_BOOL, 0, N_("list inactive pools")},
    {"all", VSH_OT_BOOL, 0, N_("list inactive & active pools")},
6751
    {"details", VSH_OT_BOOL, 0, N_("display extended details for pools")},
6752 6753 6754
    {NULL, 0, 0, NULL}
};

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

6784
    /* Check the connection to libvirtd daemon is still working */
6785
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
6786
        return false;
6787

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

    /* Retrieve the number of inactive storage pools */
6798
    if (inactive) {
6799 6800
        numInactivePools = virConnectNumOfDefinedStoragePools(ctl->conn);
        if (numInactivePools < 0) {
6801
            vshError(ctl, "%s", _("Failed to list inactive pools"));
E
Eric Blake 已提交
6802
            return false;
6803
        }
6804
    }
6805

6806 6807
    /* Determine the total number of pools to list */
    numAllPools = numActivePools + numInactivePools;
6808

6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820
    /* 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 已提交
6821
            return false;
6822 6823 6824
        }
    }

6825 6826 6827 6828 6829 6830 6831 6832
    /* 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 已提交
6833
            return false;
6834 6835
        }
    }
6836

6837 6838 6839 6840 6841 6842 6843 6844 6845 6846
    /* 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]);
6847
        if (!pool) {
6848
            VIR_FREE(poolNames[i]);
6849 6850 6851
            continue;
        }

6852
        /* Retrieve the autostart status of the pool */
6853
        if (virStoragePoolGetAutostart(pool, &autostart) < 0)
6854
            poolInfoTexts[i].autostart = vshStrdup(ctl, _("no autostart"));
6855
        else
6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873
            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;
        }
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 6979 6980 6981 6982 6983 6984 6985 6986
        /* 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 */
6987 6988 6989
        virStoragePoolFree(pool);
    }

6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007
    /* 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);
7008 7009
        }

7010
        /* Cleanup and return */
E
Eric Blake 已提交
7011
        functionReturn = true;
7012 7013
        goto cleanup;
    }
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 7101 7102 7103 7104 7105 7106 7107 7108
    /* 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 已提交
7109
    functionReturn = true;
7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123
    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 已提交
7124
    functionReturn = false;
7125

7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137
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]);
7138
    }
7139 7140 7141 7142 7143 7144 7145

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

    /* Return the desired value */
    return functionReturn;
7146 7147
}

7148 7149 7150 7151
/*
 * "find-storage-pool-sources-as" command
 */
static const vshCmdInfo info_find_storage_pool_sources_as[] = {
7152 7153
    {"help", N_("find potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7154 7155 7156 7157 7158
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources_as[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7159 7160 7161
     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")},
7162
    {"initiator", VSH_OT_DATA, VSH_OFLAG_NONE, N_("optional initiator IQN to use for query")},
7163 7164 7165
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7166
static bool
7167 7168
cmdPoolDiscoverSourcesAs(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7169
    const char *type = NULL, *host = NULL;
7170 7171
    char *srcSpec = NULL;
    char *srcList;
7172
    const char *initiator = NULL;
7173

7174 7175
    if (vshCommandOptString(cmd, "type", &type) <= 0 ||
        vshCommandOptString(cmd, "host", &host) < 0 ||
7176 7177
        vshCommandOptString(cmd, "initiator", &initiator) < 0) {
        vshError(ctl,"%s", _("missing argument"));
E
Eric Blake 已提交
7178
        return false;
7179
    }
7180

7181
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7182
        return false;
7183 7184

    if (host) {
7185
        const char *port = NULL;
7186
        virBuffer buf = VIR_BUFFER_INITIALIZER;
7187 7188 7189 7190

        if (vshCommandOptString(cmd, "port", &port) < 0) {
            vshError(ctl, "%s", _("missing argument"));
            virBufferFreeAndReset(&buf);
E
Eric Blake 已提交
7191
            return false;
7192
        }
7193
        virBufferAddLit(&buf, "<source>\n");
7194
        virBufferAsprintf(&buf, "  <host name='%s'", host);
7195
        if (port)
7196
            virBufferAsprintf(&buf, " port='%s'", port);
7197
        virBufferAddLit(&buf, "/>\n");
7198 7199
        if (initiator) {
            virBufferAddLit(&buf, "  <initiator>\n");
7200
            virBufferAsprintf(&buf, "    <iqn name='%s'/>\n", initiator);
7201 7202
            virBufferAddLit(&buf, "  </initiator>\n");
        }
7203 7204 7205
        virBufferAddLit(&buf, "</source>\n");
        if (virBufferError(&buf)) {
            vshError(ctl, "%s", _("Out of memory"));
E
Eric Blake 已提交
7206
            return false;
7207
        }
7208
        srcSpec = virBufferContentAndReset(&buf);
7209 7210 7211
    }

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7212
    VIR_FREE(srcSpec);
7213
    if (srcList == NULL) {
7214
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7215
        return false;
7216 7217
    }
    vshPrint(ctl, "%s", srcList);
7218
    VIR_FREE(srcList);
7219

E
Eric Blake 已提交
7220
    return true;
7221 7222 7223 7224 7225 7226 7227
}


/*
 * "find-storage-pool-sources" command
 */
static const vshCmdInfo info_find_storage_pool_sources[] = {
7228 7229
    {"help", N_("discover potential storage pool sources")},
    {"desc", N_("Returns XML <sources> document.")},
7230 7231 7232 7233 7234
    {NULL, NULL}
};

static const vshCmdOptDef opts_find_storage_pool_sources[] = {
    {"type", VSH_OT_DATA, VSH_OFLAG_REQ,
7235
     N_("type of storage pool sources to discover")},
7236
    {"srcSpec", VSH_OT_DATA, VSH_OFLAG_NONE,
7237
     N_("optional file of source xml to query for pools")},
7238 7239 7240
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7241
static bool
7242 7243
cmdPoolDiscoverSources(vshControl * ctl, const vshCmd * cmd ATTRIBUTE_UNUSED)
{
7244
    const char *type = NULL, *srcSpecFile = NULL;
7245
    char *srcSpec = NULL, *srcList;
7246

7247
    if (vshCommandOptString(cmd, "type", &type) <= 0)
E
Eric Blake 已提交
7248
        return false;
7249

7250 7251
    if (vshCommandOptString(cmd, "srcSpec", &srcSpecFile) < 0) {
        vshError(ctl, "%s", _("missing option"));
E
Eric Blake 已提交
7252
        return false;
7253
    }
7254

7255
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7256
        return false;
7257 7258

    if (srcSpecFile && virFileReadAll(srcSpecFile, VIRSH_MAX_XML_FILE, &srcSpec) < 0)
E
Eric Blake 已提交
7259
        return false;
7260 7261

    srcList = virConnectFindStoragePoolSources(ctl->conn, type, srcSpec, 0);
7262
    VIR_FREE(srcSpec);
7263
    if (srcList == NULL) {
7264
        vshError(ctl, _("Failed to find any %s pool sources"), type);
E
Eric Blake 已提交
7265
        return false;
7266 7267
    }
    vshPrint(ctl, "%s", srcList);
7268
    VIR_FREE(srcList);
7269

E
Eric Blake 已提交
7270
    return true;
7271 7272 7273
}


7274 7275 7276
/*
 * "pool-info" command
 */
7277
static const vshCmdInfo info_pool_info[] = {
7278 7279
    {"help", N_("storage pool information")},
    {"desc", N_("Returns basic information about the storage pool.")},
7280 7281 7282
    {NULL, NULL}
};

7283
static const vshCmdOptDef opts_pool_info[] = {
7284
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7285 7286 7287
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7288
static bool
7289
cmdPoolInfo(vshControl *ctl, const vshCmd *cmd)
7290 7291 7292
{
    virStoragePoolInfo info;
    virStoragePoolPtr pool;
7293 7294
    int autostart = 0;
    int persistent = 0;
E
Eric Blake 已提交
7295
    bool ret = true;
7296 7297
    char uuid[VIR_UUID_STRING_BUFLEN];

7298
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7299
        return false;
7300 7301

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
7302
        return false;
7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328

    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;
7329 7330 7331 7332
        case VIR_STORAGE_POOL_INACCESSIBLE:
            vshPrint(ctl, "%-15s %s\n", _("State:"),
                     _("inaccessible"));
            break;
7333 7334
        }

7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350
        /* 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"));

7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362
        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 已提交
7363
        ret = false;
7364 7365 7366 7367 7368 7369 7370 7371 7372 7373
    }

    virStoragePoolFree(pool);
    return ret;
}


/*
 * "pool-name" command
 */
7374
static const vshCmdInfo info_pool_name[] = {
7375
    {"help", N_("convert a pool UUID to pool name")},
7376
    {"desc", ""},
7377 7378 7379
    {NULL, NULL}
};

7380
static const vshCmdOptDef opts_pool_name[] = {
7381
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool uuid")},
7382 7383 7384
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7385
static bool
7386
cmdPoolName(vshControl *ctl, const vshCmd *cmd)
7387 7388 7389
{
    virStoragePoolPtr pool;

7390
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7391
        return false;
7392
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7393
                                           VSH_BYUUID)))
E
Eric Blake 已提交
7394
        return false;
7395 7396 7397

    vshPrint(ctl, "%s\n", virStoragePoolGetName(pool));
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7398
    return true;
7399 7400 7401 7402 7403 7404
}


/*
 * "pool-start" command
 */
7405
static const vshCmdInfo info_pool_start[] = {
7406 7407
    {"help", N_("start a (previously defined) inactive pool")},
    {"desc", N_("Start a pool.")},
7408 7409 7410
    {NULL, NULL}
};

7411
static const vshCmdOptDef opts_pool_start[] = {
7412
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("name of the inactive pool")},
7413 7414 7415
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7416
static bool
7417
cmdPoolStart(vshControl *ctl, const vshCmd *cmd)
7418 7419
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7420
    bool ret = true;
7421

7422
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7423
        return false;
7424

7425
    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL, VSH_BYNAME)))
E
Eric Blake 已提交
7426
         return false;
7427 7428 7429 7430 7431

    if (virStoragePoolCreate(pool, 0) == 0) {
        vshPrint(ctl, _("Pool %s started\n"),
                 virStoragePoolGetName(pool));
    } else {
7432
        vshError(ctl, _("Failed to start pool %s"), virStoragePoolGetName(pool));
E
Eric Blake 已提交
7433
        ret = false;
7434
    }
L
Laine Stump 已提交
7435 7436

    virStoragePoolFree(pool);
7437 7438 7439 7440
    return ret;
}


7441 7442 7443
/*
 * "vol-create-as" command
 */
7444
static const vshCmdInfo info_vol_create_as[] = {
7445 7446
    {"help", N_("create a volume from a set of args")},
    {"desc", N_("Create a vol.")},
7447 7448 7449
    {NULL, NULL}
};

7450
static const vshCmdOptDef opts_vol_create_as[] = {
7451 7452 7453 7454 7455
    {"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")},
7456 7457
    {"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")},
7458 7459 7460 7461 7462 7463 7464 7465 7466 7467
    {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 已提交
7468
        /* Deliberate fallthrough cases here :-) */
7469 7470 7471
        switch (*end) {
        case 'T':
            *val *= 1024;
7472
            /* fallthrough */
7473 7474
        case 'G':
            *val *= 1024;
7475
            /* fallthrough */
7476 7477
        case 'M':
            *val *= 1024;
7478
            /* fallthrough */
7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491
        case 'k':
            *val *= 1024;
            break;
        default:
            return -1;
        }
        end++;
        if (*end)
            return -1;
    }
    return 0;
}

E
Eric Blake 已提交
7492
static bool
7493
cmdVolCreateAs(vshControl *ctl, const vshCmd *cmd)
7494 7495 7496
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7497
    char *xml;
7498 7499
    const char *name, *capacityStr = NULL, *allocationStr = NULL, *format = NULL;
    const char *snapshotStrVol = NULL, *snapshotStrFormat = NULL;
7500
    unsigned long long capacity, allocation = 0;
7501
    virBuffer buf = VIR_BUFFER_INITIALIZER;
7502

7503
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7504
        return false;
7505 7506 7507

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

7510
    if (vshCommandOptString(cmd, "name", &name) <= 0)
7511 7512
        goto cleanup;

7513
    if (vshCommandOptString(cmd, "capacity", &capacityStr) <= 0)
7514 7515
        goto cleanup;
    if (cmdVolSize(capacityStr, &capacity) < 0)
7516
        vshError(ctl, _("Malformed size %s"), capacityStr);
7517

7518 7519
    if ((vshCommandOptString(cmd, "allocation", &allocationStr) > 0) &&
        (cmdVolSize(allocationStr, &allocation) < 0))
7520
        vshError(ctl, _("Malformed size %s"), allocationStr);
7521

7522 7523 7524 7525 7526 7527 7528
    if (vshCommandOptString(cmd, "format", &format) < 0 ||
        vshCommandOptString(cmd, "backing-vol", &snapshotStrVol) < 0 ||
        vshCommandOptString(cmd, "backing-vol-format",
                            &snapshotStrFormat) < 0) {
        vshError(ctl, "%s", _("missing argument"));
    }

7529

7530
    virBufferAddLit(&buf, "<volume>\n");
7531 7532
    virBufferAsprintf(&buf, "  <name>%s</name>\n", name);
    virBufferAsprintf(&buf, "  <capacity>%llu</capacity>\n", capacity);
7533
    if (allocationStr)
7534
        virBufferAsprintf(&buf, "  <allocation>%llu</allocation>\n", allocation);
7535 7536

    if (format) {
7537
        virBufferAddLit(&buf, "  <target>\n");
7538
        virBufferAsprintf(&buf, "    <format type='%s'/>\n",format);
7539
        virBufferAddLit(&buf, "  </target>\n");
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 7567 7568 7569 7570 7571 7572 7573 7574
    /* 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 已提交
7575
            return false;
7576 7577 7578 7579 7580
        }

        char *snapshotStrVolPath;
        if ((snapshotStrVolPath = virStorageVolGetPath(snapVol)) == NULL) {
            virStorageVolFree(snapVol);
E
Eric Blake 已提交
7581
            return false;
7582 7583 7584 7585
        }

        /* Create XML for the backing store */
        virBufferAddLit(&buf, "  <backingStore>\n");
7586
        virBufferAsprintf(&buf, "    <path>%s</path>\n",snapshotStrVolPath);
7587
        if (snapshotStrFormat)
7588
            virBufferAsprintf(&buf, "    <format type='%s'/>\n",snapshotStrFormat);
7589 7590 7591 7592 7593 7594 7595 7596
        virBufferAddLit(&buf, "  </backingStore>\n");

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

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

7598 7599
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
7600
        return false;
7601 7602 7603
    }
    xml = virBufferContentAndReset(&buf);
    vol = virStorageVolCreateXML(pool, xml, 0);
7604
    VIR_FREE(xml);
7605 7606 7607 7608 7609
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created\n"), name);
        virStorageVolFree(vol);
E
Eric Blake 已提交
7610
        return true;
7611
    } else {
7612
        vshError(ctl, _("Failed to create vol %s"), name);
E
Eric Blake 已提交
7613
        return false;
7614 7615 7616
    }

 cleanup:
7617
    virBufferFreeAndReset(&buf);
7618
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7619
    return false;
7620 7621 7622
}


7623 7624 7625
/*
 * "pool-undefine" command
 */
7626
static const vshCmdInfo info_pool_undefine[] = {
7627 7628
    {"help", N_("undefine an inactive pool")},
    {"desc", N_("Undefine the configuration for an inactive pool.")},
7629 7630 7631
    {NULL, NULL}
};

7632
static const vshCmdOptDef opts_pool_undefine[] = {
7633
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
7634 7635 7636
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7637
static bool
7638
cmdPoolUndefine(vshControl *ctl, const vshCmd *cmd)
7639 7640
{
    virStoragePoolPtr pool;
E
Eric Blake 已提交
7641
    bool ret = true;
7642
    const char *name;
7643

7644
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7645
        return false;
7646 7647

    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", &name)))
E
Eric Blake 已提交
7648
        return false;
7649 7650 7651 7652

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

L
Laine Stump 已提交
7657
    virStoragePoolFree(pool);
7658 7659 7660 7661 7662 7663 7664
    return ret;
}


/*
 * "pool-uuid" command
 */
7665
static const vshCmdInfo info_pool_uuid[] = {
7666
    {"help", N_("convert a pool name to pool UUID")},
7667
    {"desc", ""},
7668 7669 7670
    {NULL, NULL}
};

7671
static const vshCmdOptDef opts_pool_uuid[] = {
7672
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
7673 7674 7675
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7676
static bool
7677
cmdPoolUuid(vshControl *ctl, const vshCmd *cmd)
7678 7679 7680 7681
{
    virStoragePoolPtr pool;
    char uuid[VIR_UUID_STRING_BUFLEN];

7682
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7683
        return false;
7684 7685

    if (!(pool = vshCommandOptPoolBy(ctl, cmd, "pool", NULL,
7686
                                           VSH_BYNAME)))
E
Eric Blake 已提交
7687
        return false;
7688 7689 7690 7691

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

L
Laine Stump 已提交
7694
    virStoragePoolFree(pool);
E
Eric Blake 已提交
7695
    return true;
7696 7697 7698 7699 7700 7701
}


/*
 * "vol-create" command
 */
7702
static const vshCmdInfo info_vol_create[] = {
7703 7704
    {"help", N_("create a vol from an XML file")},
    {"desc", N_("Create a vol.")},
7705 7706 7707
    {NULL, NULL}
};

7708
static const vshCmdOptDef opts_vol_create[] = {
7709 7710
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name")},
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML vol description")},
7711 7712 7713
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7714
static bool
7715
cmdVolCreate(vshControl *ctl, const vshCmd *cmd)
7716 7717 7718
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
7719
    const char *from = NULL;
E
Eric Blake 已提交
7720
    bool ret = true;
7721 7722
    char *buffer;

7723
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
7724
        return false;
7725 7726

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

7730
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7731
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7732
        return false;
7733 7734 7735
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7736
        virshReportError(ctl);
7737
        virStoragePoolFree(pool);
E
Eric Blake 已提交
7738
        return false;
7739 7740 7741
    }

    vol = virStorageVolCreateXML(pool, buffer, 0);
7742
    VIR_FREE(buffer);
7743 7744 7745 7746 7747 7748 7749
    virStoragePoolFree(pool);

    if (vol != NULL) {
        vshPrint(ctl, _("Vol %s created from %s\n"),
                 virStorageVolGetName(vol), from);
        virStorageVolFree(vol);
    } else {
7750
        vshError(ctl, _("Failed to create vol from %s"), from);
E
Eric Blake 已提交
7751
        ret = false;
7752 7753 7754 7755
    }
    return ret;
}

7756 7757 7758 7759
/*
 * "vol-create-from" command
 */
static const vshCmdInfo info_vol_create_from[] = {
7760 7761
    {"help", N_("create a vol, using another volume as input")},
    {"desc", N_("Create a vol from an existing volume.")},
7762 7763 7764 7765
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_create_from[] = {
7766 7767 7768
    {"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 已提交
7769
    {"inputpool", VSH_OT_STRING, 0, N_("pool name or uuid of the input volume's pool")},
7770 7771 7772
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7773
static bool
7774 7775 7776 7777
cmdVolCreateFrom(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool = NULL;
    virStorageVolPtr newvol = NULL, inputvol = NULL;
7778
    const char *from = NULL;
E
Eric Blake 已提交
7779
    bool ret = false;
7780 7781
    char *buffer = NULL;

7782
    if (!vshConnectionUsability(ctl, ctl->conn))
7783 7784 7785 7786 7787
        goto cleanup;

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

7788
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
7789 7790 7791 7792 7793 7794 7795
        goto cleanup;
    }

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

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
7796
        virshReportError(ctl);
7797 7798 7799 7800 7801 7802 7803 7804 7805
        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 {
7806
        vshError(ctl, _("Failed to create vol from %s"), from);
7807 7808 7809
        goto cleanup;
    }

E
Eric Blake 已提交
7810
    ret = true;
7811
cleanup:
7812
    VIR_FREE(buffer);
7813 7814 7815 7816
    if (pool)
        virStoragePoolFree(pool);
    if (inputvol)
        virStorageVolFree(inputvol);
L
Laine Stump 已提交
7817 7818
    if (newvol)
        virStorageVolFree(newvol);
7819 7820 7821 7822
    return ret;
}

static xmlChar *
7823
makeCloneXML(const char *origxml, const char *newname) {
7824

7825 7826 7827
    xmlDocPtr doc = NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlXPathObjectPtr obj = NULL;
7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857
    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[] = {
7858 7859
    {"help", N_("clone a volume.")},
    {"desc", N_("Clone an existing volume.")},
7860 7861 7862 7863
    {NULL, NULL}
};

static const vshCmdOptDef opts_vol_clone[] = {
7864 7865
    {"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 已提交
7866
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7867 7868 7869
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
7870
static bool
7871 7872 7873 7874
cmdVolClone(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr origpool = NULL;
    virStorageVolPtr origvol = NULL, newvol = NULL;
7875
    const char *name = NULL;
7876
    char *origxml = NULL;
7877
    xmlChar *newxml = NULL;
E
Eric Blake 已提交
7878
    bool ret = false;
7879

7880
    if (!vshConnectionUsability(ctl, ctl->conn))
7881 7882 7883 7884 7885 7886 7887
        goto cleanup;

    if (!(origvol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
        goto cleanup;

    origpool = virStoragePoolLookupByVolume(origvol);
    if (!origpool) {
7888
        vshError(ctl, "%s", _("failed to get parent pool"));
7889 7890 7891
        goto cleanup;
    }

7892
    if (vshCommandOptString(cmd, "newname", &name) <= 0)
7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910
        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 {
7911
        vshError(ctl, _("Failed to clone vol from %s"),
7912 7913 7914 7915
                 virStorageVolGetName(origvol));
        goto cleanup;
    }

E
Eric Blake 已提交
7916
    ret = true;
7917 7918

cleanup:
7919
    VIR_FREE(origxml);
7920 7921 7922
    xmlFree(newxml);
    if (origvol)
        virStorageVolFree(origvol);
L
Laine Stump 已提交
7923 7924
    if (newvol)
        virStorageVolFree(newvol);
7925 7926 7927 7928 7929
    if (origpool)
        virStoragePoolFree(origpool);
    return ret;
}

7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942

/*
 * "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 已提交
7943
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957
    {"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 已提交
7958
static bool
7959 7960 7961 7962
cmdVolUpload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
7963
    bool ret = false;
7964 7965 7966 7967 7968 7969 7970 7971 7972 7973
    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 已提交
7974
        return false;
7975 7976 7977 7978
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
7979
        return false;
7980 7981 7982
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
7983
        return false;
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 8010 8011 8012 8013 8014 8015 8016 8017
    }

    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 已提交
8018
    ret = true;
8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042

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 已提交
8043
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8044 8045 8046 8047 8048
    {"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 已提交
8049
static bool
8050 8051 8052 8053
cmdVolDownload (vshControl *ctl, const vshCmd *cmd)
{
    const char *file = NULL;
    virStorageVolPtr vol = NULL;
E
Eric Blake 已提交
8054
    bool ret = false;
8055 8056 8057 8058
    int fd = -1;
    virStreamPtr st = NULL;
    const char *name = NULL;
    unsigned long long offset = 0, length = 0;
8059
    bool created = false;
8060 8061

    if (!vshConnectionUsability(ctl, ctl->conn))
8062
        return false;
8063 8064 8065

    if (vshCommandOptULongLong(cmd, "offset", &offset) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8066
        return false;
8067 8068 8069 8070
    }

    if (vshCommandOptULongLong(cmd, "length", &length) < 0) {
        vshError(ctl, _("Unable to parse integer"));
E
Eric Blake 已提交
8071
        return false;
8072 8073 8074
    }

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name)))
E
Eric Blake 已提交
8075
        return false;
8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087

    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;
        }
8088 8089
    } else {
        created = true;
8090 8091 8092 8093 8094 8095 8096 8097
    }

    st = virStreamNew(ctl->conn, 0);
    if (virStorageVolDownload(vol, st, offset, length, 0) < 0) {
        vshError(ctl, _("cannot download from volume %s"), name);
        goto cleanup;
    }

8098
    if (virStreamRecvAll(st, vshStreamSink, &fd) < 0) {
8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113
        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 已提交
8114
    ret = true;
8115 8116

cleanup:
8117
    VIR_FORCE_CLOSE(fd);
8118
    if (!ret && created)
8119 8120 8121 8122 8123 8124 8125 8126 8127
        unlink(file);
    if (vol)
        virStorageVolFree(vol);
    if (st)
        virStreamFree(st);
    return ret;
}


8128 8129 8130
/*
 * "vol-delete" command
 */
8131
static const vshCmdInfo info_vol_delete[] = {
8132 8133
    {"help", N_("delete a vol")},
    {"desc", N_("Delete a given vol.")},
8134 8135 8136
    {NULL, NULL}
};

8137
static const vshCmdOptDef opts_vol_delete[] = {
8138
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8139
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8140 8141 8142
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8143
static bool
8144
cmdVolDelete(vshControl *ctl, const vshCmd *cmd)
8145 8146
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8147
    bool ret = true;
8148
    const char *name;
8149

8150
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8151
        return false;
8152 8153

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8154
        return false;
8155 8156 8157
    }

    if (virStorageVolDelete(vol, 0) == 0) {
D
Daniel Veillard 已提交
8158
        vshPrint(ctl, _("Vol %s deleted\n"), name);
8159
    } else {
8160
        vshError(ctl, _("Failed to delete vol %s"), name);
E
Eric Blake 已提交
8161
        ret = false;
8162 8163
    }

L
Laine Stump 已提交
8164
    virStorageVolFree(vol);
8165 8166 8167 8168
    return ret;
}


D
David Allan 已提交
8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179
/*
 * "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 已提交
8180
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
D
David Allan 已提交
8181 8182 8183
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8184
static bool
D
David Allan 已提交
8185 8186 8187
cmdVolWipe(vshControl *ctl, const vshCmd *cmd)
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8188
    bool ret = true;
8189
    const char *name;
D
David Allan 已提交
8190

8191
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8192
        return false;
D
David Allan 已提交
8193 8194

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8195
        return false;
D
David Allan 已提交
8196 8197 8198 8199 8200 8201
    }

    if (virStorageVolWipe(vol, 0) == 0) {
        vshPrint(ctl, _("Vol %s wiped\n"), name);
    } else {
        vshError(ctl, _("Failed to wipe vol %s"), name);
E
Eric Blake 已提交
8202
        ret = false;
D
David Allan 已提交
8203 8204 8205 8206 8207 8208 8209
    }

    virStorageVolFree(vol);
    return ret;
}


8210 8211 8212
/*
 * "vol-info" command
 */
8213
static const vshCmdInfo info_vol_info[] = {
8214 8215
    {"help", N_("storage vol information")},
    {"desc", N_("Returns basic information about the storage vol.")},
8216 8217 8218
    {NULL, NULL}
};

8219
static const vshCmdOptDef opts_vol_info[] = {
8220
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8221
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8222 8223 8224
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8225
static bool
8226
cmdVolInfo(vshControl *ctl, const vshCmd *cmd)
8227 8228 8229
{
    virStorageVolInfo info;
    virStorageVolPtr vol;
E
Eric Blake 已提交
8230
    bool ret = true;
8231

8232
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8233
        return false;
8234 8235

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8236
        return false;
8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252

    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 已提交
8253
        ret = false;
8254 8255 8256 8257 8258 8259 8260 8261 8262 8263
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-dumpxml" command
 */
8264
static const vshCmdInfo info_vol_dumpxml[] = {
8265 8266
    {"help", N_("vol information in XML")},
    {"desc", N_("Output the vol information as an XML dump to stdout.")},
8267 8268 8269
    {NULL, NULL}
};

8270
static const vshCmdOptDef opts_vol_dumpxml[] = {
8271
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("vol name, key or path")},
E
Eric Blake 已提交
8272
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8273 8274 8275
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8276
static bool
8277
cmdVolDumpXML(vshControl *ctl, const vshCmd *cmd)
8278 8279
{
    virStorageVolPtr vol;
E
Eric Blake 已提交
8280
    bool ret = true;
8281 8282
    char *dump;

8283
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8284
        return false;
8285 8286

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8287
        return false;
8288 8289 8290

    dump = virStorageVolGetXMLDesc(vol, 0);
    if (dump != NULL) {
8291
        vshPrint(ctl, "%s", dump);
8292
        VIR_FREE(dump);
8293
    } else {
E
Eric Blake 已提交
8294
        ret = false;
8295 8296 8297 8298 8299 8300 8301 8302 8303 8304
    }

    virStorageVolFree(vol);
    return ret;
}


/*
 * "vol-list" command
 */
8305
static const vshCmdInfo info_vol_list[] = {
8306 8307
    {"help", N_("list vols")},
    {"desc", N_("Returns list of vols by pool.")},
8308 8309 8310
    {NULL, NULL}
};

8311
static const vshCmdOptDef opts_vol_list[] = {
8312
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
8313
    {"details", VSH_OT_BOOL, 0, N_("display extended details for volumes")},
8314 8315 8316
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8317
static bool
8318
cmdVolList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
8319
{
8320
    virStorageVolInfo volumeInfo;
8321 8322
    virStoragePoolPtr pool;
    char **activeNames = NULL;
8323 8324 8325 8326 8327
    char *outputStr = NULL;
    const char *unit;
    double val;
    int details = vshCommandOptBool(cmd, "details");
    int numVolumes = 0, i;
W
Wen Congyang 已提交
8328 8329
    int ret;
    bool functionReturn;
8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340
    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;
8341

8342
    /* Check the connection to libvirtd daemon is still working */
8343
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8344
        return false;
8345

8346
    /* Look up the pool information given to us by the user */
8347
    if (!(pool = vshCommandOptPool(ctl, cmd, "pool", NULL)))
E
Eric Blake 已提交
8348
        return false;
8349

8350 8351
    /* Determine the number of volumes in the pool */
    numVolumes = virStoragePoolNumOfVolumes(pool);
8352

8353 8354 8355
    if (numVolumes < 0) {
        vshError(ctl, "%s", _("Failed to list storage volumes"));
        virStoragePoolFree(pool);
E
Eric Blake 已提交
8356
        return false;
8357 8358
    }

8359 8360 8361 8362 8363
    /* 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) {
8364
            vshError(ctl, "%s", _("Failed to list active vols"));
8365
            VIR_FREE(activeNames);
8366
            virStoragePoolFree(pool);
E
Eric Blake 已提交
8367
            return false;
8368 8369
        }

8370 8371 8372 8373 8374
        /* Sort the volume names */
        qsort(&activeNames[0], numVolumes, sizeof(*activeNames), namesorter);

        /* Set aside memory for volume information pointers */
        volInfoTexts = vshCalloc(ctl, numVolumes, sizeof(*volInfoTexts));
8375 8376
    }

8377 8378 8379 8380 8381
    /* Collect the rest of the volume information for display */
    for (i = 0; i < numVolumes; i++) {
        /* Retrieve volume info */
        virStorageVolPtr vol = virStorageVolLookupByName(pool,
                                                         activeNames[i]);
8382

8383 8384 8385 8386
        /* 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"));
8387 8388
        }

8389 8390 8391 8392 8393 8394 8395 8396 8397
        /* 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 */
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 8446 8447 8448 8449 8450 8451 8452 8453
                /* 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;
        }
8454

8455
        /* Cleanup memory allocation */
8456
        virStorageVolFree(vol);
8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474
    }

    /* 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 已提交
8475
        functionReturn = true;
8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506
        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 已提交
8507 8508 8509 8510 8511
    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);
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 8538 8539 8540 8541 8542 8543 8544 8545

    /* 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 已提交
8546
    functionReturn = true;
8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560
    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 已提交
8561
    functionReturn = false;
8562 8563 8564 8565 8566 8567 8568 8569 8570 8571

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);
8572
        VIR_FREE(activeNames[i]);
8573
    }
8574 8575 8576 8577

    /* Cleanup remaining memory */
    VIR_FREE(outputStr);
    VIR_FREE(volInfoTexts);
8578
    VIR_FREE(activeNames);
8579
    virStoragePoolFree(pool);
8580 8581 8582

    /* Return the desired value */
    return functionReturn;
8583 8584 8585 8586 8587 8588
}


/*
 * "vol-name" command
 */
8589
static const vshCmdInfo info_vol_name[] = {
8590
    {"help", N_("returns the volume name for a given volume key or path")},
8591
    {"desc", ""},
8592 8593 8594
    {NULL, NULL}
};

8595
static const vshCmdOptDef opts_vol_name[] = {
8596
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
8597 8598 8599
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8600
static bool
8601
cmdVolName(vshControl *ctl, const vshCmd *cmd)
8602 8603 8604
{
    virStorageVolPtr vol;

8605
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8606
        return false;
8607 8608 8609

    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID)))
E
Eric Blake 已提交
8610
        return false;
8611 8612 8613

    vshPrint(ctl, "%s\n", virStorageVolGetName(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8614
    return true;
8615 8616 8617
}


J
Justin Clift 已提交
8618 8619 8620 8621 8622 8623 8624 8625 8626 8627
/*
 * "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[] = {
8628
    {"uuid", VSH_OT_BOOL, 0, N_("return the pool uuid rather than pool name")},
J
Justin Clift 已提交
8629 8630 8631 8632
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume key or path")},
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8633
static bool
J
Justin Clift 已提交
8634 8635 8636 8637
cmdVolPool(vshControl *ctl, const vshCmd *cmd)
{
    virStoragePoolPtr pool;
    virStorageVolPtr vol;
8638
    char uuid[VIR_UUID_STRING_BUFLEN];
J
Justin Clift 已提交
8639 8640

    /* Check the connection to libvirtd daemon is still working */
8641
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8642
        return false;
J
Justin Clift 已提交
8643 8644 8645 8646

    /* Use the supplied string to locate the volume */
    if (!(vol = vshCommandOptVolBy(ctl, cmd, "vol", "pool", NULL,
                                   VSH_BYUUID))) {
E
Eric Blake 已提交
8647
        return false;
J
Justin Clift 已提交
8648 8649 8650 8651 8652 8653 8654
    }

    /* 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 已提交
8655
        return false;
J
Justin Clift 已提交
8656 8657
    }

8658 8659 8660 8661 8662 8663 8664 8665 8666
    /* 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 已提交
8667 8668 8669 8670

    /* Cleanup */
    virStorageVolFree(vol);
    virStoragePoolFree(pool);
E
Eric Blake 已提交
8671
    return true;
J
Justin Clift 已提交
8672 8673
}

8674 8675 8676 8677

/*
 * "vol-key" command
 */
8678
static const vshCmdInfo info_vol_key[] = {
8679
    {"help", N_("returns the volume key for a given volume name or path")},
8680
    {"desc", ""},
8681 8682 8683
    {NULL, NULL}
};

8684
static const vshCmdOptDef opts_vol_key[] = {
8685
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or path")},
E
Eric Blake 已提交
8686
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8687 8688 8689
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8690
static bool
8691
cmdVolKey(vshControl *ctl, const vshCmd *cmd)
8692 8693 8694
{
    virStorageVolPtr vol;

8695
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8696
        return false;
8697

8698
    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", NULL)))
E
Eric Blake 已提交
8699
        return false;
8700 8701 8702

    vshPrint(ctl, "%s\n", virStorageVolGetKey(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8703
    return true;
8704 8705 8706 8707 8708 8709 8710
}



/*
 * "vol-path" command
 */
8711
static const vshCmdInfo info_vol_path[] = {
8712
    {"help", N_("returns the volume path for a given volume name or key")},
8713
    {"desc", ""},
8714 8715 8716
    {NULL, NULL}
};

8717
static const vshCmdOptDef opts_vol_path[] = {
8718
    {"vol", VSH_OT_DATA, VSH_OFLAG_REQ, N_("volume name or key")},
E
Eric Blake 已提交
8719
    {"pool", VSH_OT_STRING, 0, N_("pool name or uuid")},
8720 8721 8722
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8723
static bool
8724
cmdVolPath(vshControl *ctl, const vshCmd *cmd)
8725 8726
{
    virStorageVolPtr vol;
8727
    const char *name = NULL;
8728

8729
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8730
        return false;
8731 8732

    if (!(vol = vshCommandOptVol(ctl, cmd, "vol", "pool", &name))) {
E
Eric Blake 已提交
8733
        return false;
8734
    }
8735 8736 8737

    vshPrint(ctl, "%s\n", virStorageVolGetPath(vol));
    virStorageVolFree(vol);
E
Eric Blake 已提交
8738
    return true;
8739 8740 8741
}


8742 8743 8744 8745
/*
 * "secret-define" command
 */
static const vshCmdInfo info_secret_define[] = {
8746 8747
    {"help", N_("define or modify a secret from an XML file")},
    {"desc", N_("Define or modify a secret.")},
8748 8749
    {NULL, NULL}
};
8750

8751
static const vshCmdOptDef opts_secret_define[] = {
8752
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing secret attributes in XML")},
8753 8754
    {NULL, 0, 0, NULL}
};
8755

E
Eric Blake 已提交
8756
static bool
8757 8758
cmdSecretDefine(vshControl *ctl, const vshCmd *cmd)
{
8759
    const char *from = NULL;
8760
    char *buffer;
8761
    virSecretPtr res;
8762
    char uuid[VIR_UUID_STRING_BUFLEN];
8763

8764
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8765
        return false;
8766

8767
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
8768
        return false;
8769 8770

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

    res = virSecretDefineXML(ctl->conn, buffer, 0);
8774
    VIR_FREE(buffer);
8775 8776

    if (res == NULL) {
8777
        vshError(ctl, _("Failed to set attributes from %s"), from);
E
Eric Blake 已提交
8778
        return false;
8779
    }
8780
    if (virSecretGetUUIDString(res, &(uuid[0])) < 0) {
8781
        vshError(ctl, "%s", _("Failed to get UUID of created secret"));
8782
        virSecretFree(res);
E
Eric Blake 已提交
8783
        return false;
8784 8785 8786
    }
    vshPrint(ctl, _("Secret %s created\n"), uuid);
    virSecretFree(res);
E
Eric Blake 已提交
8787
    return true;
8788 8789 8790 8791 8792 8793
}

/*
 * "secret-dumpxml" command
 */
static const vshCmdInfo info_secret_dumpxml[] = {
8794 8795
    {"help", N_("secret attributes in XML")},
    {"desc", N_("Output attributes of a secret as an XML dump to stdout.")},
8796 8797 8798 8799
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_dumpxml[] = {
8800
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8801 8802 8803
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8804
static bool
8805 8806 8807
cmdSecretDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8808
    bool ret = false;
8809 8810
    char *xml;

8811
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8812
        return false;
8813 8814 8815

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8816
        return false;
8817 8818 8819 8820

    xml = virSecretGetXMLDesc(secret, 0);
    if (xml == NULL)
        goto cleanup;
8821
    vshPrint(ctl, "%s", xml);
8822
    VIR_FREE(xml);
E
Eric Blake 已提交
8823
    ret = true;
8824 8825 8826 8827 8828 8829 8830 8831 8832 8833

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-set-value" command
 */
static const vshCmdInfo info_secret_set_value[] = {
8834 8835
    {"help", N_("set a secret value")},
    {"desc", N_("Set a secret value.")},
8836 8837 8838 8839
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_set_value[] = {
8840 8841
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
    {"base64", VSH_OT_DATA, VSH_OFLAG_REQ, N_("base64-encoded secret value")},
8842 8843 8844
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8845
static bool
8846 8847 8848 8849
cmdSecretSetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    size_t value_size;
8850
    const char *base64 = NULL;
8851
    char *value;
E
Eric Blake 已提交
8852 8853
    int res;
    bool ret = false;
8854

8855
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8856
        return false;
8857 8858 8859

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8860
        return false;
8861

8862
    if (vshCommandOptString(cmd, "base64", &base64) <= 0)
8863 8864 8865
        goto cleanup;

    if (!base64_decode_alloc(base64, strlen(base64), &value, &value_size)) {
J
Jim Meyering 已提交
8866
        vshError(ctl, "%s", _("Invalid base64 data"));
8867 8868 8869
        goto cleanup;
    }
    if (value == NULL) {
8870
        vshError(ctl, "%s", _("Failed to allocate memory"));
E
Eric Blake 已提交
8871
        return false;
8872 8873 8874 8875
    }

    res = virSecretSetValue(secret, (unsigned char *)value, value_size, 0);
    memset(value, 0, value_size);
8876
    VIR_FREE(value);
8877 8878

    if (res != 0) {
8879
        vshError(ctl, "%s", _("Failed to set secret value"));
8880 8881 8882
        goto cleanup;
    }
    vshPrint(ctl, "%s", _("Secret value set\n"));
E
Eric Blake 已提交
8883
    ret = true;
8884 8885 8886 8887 8888 8889 8890 8891 8892 8893

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-get-value" command
 */
static const vshCmdInfo info_secret_get_value[] = {
8894 8895
    {"help", N_("Output a secret value")},
    {"desc", N_("Output a secret value to stdout.")},
8896 8897 8898 8899
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_get_value[] = {
8900
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8901 8902 8903
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8904
static bool
8905 8906 8907 8908 8909 8910
cmdSecretGetValue(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
    char *base64;
    unsigned char *value;
    size_t value_size;
E
Eric Blake 已提交
8911
    bool ret = false;
8912

8913
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8914
        return false;
8915 8916 8917

    secret = vshCommandOptSecret(ctl, cmd, NULL);
    if (secret == NULL)
E
Eric Blake 已提交
8918
        return false;
8919 8920 8921 8922 8923 8924 8925

    value = virSecretGetValue(secret, &value_size, 0);
    if (value == NULL)
        goto cleanup;

    base64_encode_alloc((char *)value, value_size, &base64);
    memset(value, 0, value_size);
8926
    VIR_FREE(value);
8927 8928

    if (base64 == NULL) {
8929
        vshError(ctl, "%s", _("Failed to allocate memory"));
8930 8931
        goto cleanup;
    }
8932
    vshPrint(ctl, "%s", base64);
8933
    memset(base64, 0, strlen(base64));
8934
    VIR_FREE(base64);
E
Eric Blake 已提交
8935
    ret = true;
8936 8937 8938 8939 8940 8941 8942 8943 8944 8945

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-undefine" command
 */
static const vshCmdInfo info_secret_undefine[] = {
8946 8947
    {"help", N_("undefine a secret")},
    {"desc", N_("Undefine a secret.")},
8948 8949 8950 8951
    {NULL, NULL}
};

static const vshCmdOptDef opts_secret_undefine[] = {
8952
    {"secret", VSH_OT_DATA, VSH_OFLAG_REQ, N_("secret UUID")},
8953 8954 8955
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
8956
static bool
8957 8958 8959
cmdSecretUndefine(vshControl *ctl, const vshCmd *cmd)
{
    virSecretPtr secret;
E
Eric Blake 已提交
8960
    bool ret = false;
8961
    const char *uuid;
8962

8963
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8964
        return false;
8965 8966 8967

    secret = vshCommandOptSecret(ctl, cmd, &uuid);
    if (secret == NULL)
E
Eric Blake 已提交
8968
        return false;
8969 8970

    if (virSecretUndefine(secret) < 0) {
8971
        vshError(ctl, _("Failed to delete secret %s"), uuid);
8972 8973 8974
        goto cleanup;
    }
    vshPrint(ctl, _("Secret %s deleted\n"), uuid);
E
Eric Blake 已提交
8975
    ret = true;
8976 8977 8978 8979 8980 8981 8982 8983 8984 8985

cleanup:
    virSecretFree(secret);
    return ret;
}

/*
 * "secret-list" command
 */
static const vshCmdInfo info_secret_list[] = {
8986 8987
    {"help", N_("list secrets")},
    {"desc", N_("Returns a list of secrets")},
8988 8989 8990
    {NULL, NULL}
};

E
Eric Blake 已提交
8991
static bool
8992 8993 8994 8995 8996
cmdSecretList(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    int maxuuids = 0, i;
    char **uuids = NULL;

8997
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
8998
        return false;
8999 9000 9001

    maxuuids = virConnectNumOfSecrets(ctl->conn);
    if (maxuuids < 0) {
9002
        vshError(ctl, "%s", _("Failed to list secrets"));
E
Eric Blake 已提交
9003
        return false;
9004 9005 9006 9007 9008
    }
    uuids = vshMalloc(ctl, sizeof(*uuids) * maxuuids);

    maxuuids = virConnectListSecrets(ctl->conn, uuids, maxuuids);
    if (maxuuids < 0) {
9009
        vshError(ctl, "%s", _("Failed to list secrets"));
9010
        VIR_FREE(uuids);
E
Eric Blake 已提交
9011
        return false;
9012 9013 9014 9015
    }

    qsort(uuids, maxuuids, sizeof(char *), namesorter);

9016 9017
    vshPrintExtra(ctl, "%-36s %s\n", _("UUID"), _("Usage"));
    vshPrintExtra(ctl, "-----------------------------------------------------------\n");
9018 9019

    for (i = 0; i < maxuuids; i++) {
9020 9021 9022 9023
        virSecretPtr sec = virSecretLookupByUUIDString(ctl->conn, uuids[i]);
        const char *usageType = NULL;

        if (!sec) {
9024
            VIR_FREE(uuids[i]);
9025 9026 9027 9028 9029 9030 9031 9032 9033 9034 9035 9036 9037 9038 9039 9040 9041 9042
            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);
9043
        VIR_FREE(uuids[i]);
9044
    }
9045
    VIR_FREE(uuids);
E
Eric Blake 已提交
9046
    return true;
9047
}
9048 9049 9050 9051 9052


/*
 * "version" command
 */
9053
static const vshCmdInfo info_version[] = {
9054 9055
    {"help", N_("show version")},
    {"desc", N_("Display the system version information.")},
9056 9057 9058
    {NULL, NULL}
};

9059 9060 9061 9062
static const vshCmdOptDef opts_version[] = {
    {"daemon", VSH_OT_BOOL, VSH_OFLAG_NONE, N_("report daemon version too")},
    {NULL, 0, 0, NULL}
};
9063

E
Eric Blake 已提交
9064
static bool
9065
cmdVersion(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9066 9067 9068 9069 9070 9071
{
    unsigned long hvVersion;
    const char *hvType;
    unsigned long libVersion;
    unsigned long includeVersion;
    unsigned long apiVersion;
9072
    unsigned long daemonVersion;
9073 9074 9075 9076 9077
    int ret;
    unsigned int major;
    unsigned int minor;
    unsigned int rel;

9078
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9079
        return false;
9080 9081 9082

    hvType = virConnectGetType(ctl->conn);
    if (hvType == NULL) {
9083
        vshError(ctl, "%s", _("failed to get hypervisor type"));
E
Eric Blake 已提交
9084
        return false;
9085 9086 9087 9088 9089 9090 9091 9092 9093 9094 9095 9096
    }

    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) {
9097
        vshError(ctl, "%s", _("failed to get the library version"));
E
Eric Blake 已提交
9098
        return false;
9099 9100 9101 9102 9103 9104 9105 9106 9107 9108 9109 9110 9111 9112 9113 9114 9115
    }
    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) {
9116
        vshError(ctl, "%s", _("failed to get the hypervisor version"));
E
Eric Blake 已提交
9117
        return false;
9118 9119 9120 9121 9122 9123 9124 9125 9126 9127 9128 9129 9130
    }
    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);
    }
9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145

    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 已提交
9146
    return true;
9147 9148
}

9149 9150 9151 9152
/*
 * "nodedev-list" command
 */
static const vshCmdInfo info_node_list_devices[] = {
9153
    {"help", N_("enumerate devices on this host")},
9154
    {"desc", ""},
9155 9156 9157 9158
    {NULL, NULL}
};

static const vshCmdOptDef opts_node_list_devices[] = {
9159 9160
    {"tree", VSH_OT_BOOL, 0, N_("list devices in a tree")},
    {"cap", VSH_OT_STRING, VSH_OFLAG_NONE, N_("capability name")},
9161 9162 9163
    {NULL, 0, 0, NULL}
};

9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174 9175 9176 9177 9178 9179 9180 9181 9182 9183 9184 9185
#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] = '-';
9186 9187
        indentBuf[indentIdx+2] = ' ';
        indentBuf[indentIdx+3] = '\0';
9188 9189 9190
    }

    /* Print this device */
9191
    vshPrint(ctl, "%s", indentBuf);
9192 9193 9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214
    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) {
9215
        vshPrint(ctl, "%s", indentBuf);
9216
        vshPrint(ctl, " |\n");
9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238
    }

    /* 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) {
9239
        vshPrint(ctl, "%s", indentBuf);
9240 9241 9242 9243
        vshPrint(ctl, "\n");
    }
}

E
Eric Blake 已提交
9244
static bool
9245 9246
cmdNodeListDevices (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
9247
    const char *cap = NULL;
9248
    char **devices;
9249
    int num_devices, i;
9250
    int tree = vshCommandOptBool(cmd, "tree");
9251

9252
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9253
        return false;
9254

9255
    if (vshCommandOptString(cmd, "cap", &cap) <= 0)
9256 9257 9258 9259
        cap = NULL;

    num_devices = virNodeNumOfDevices(ctl->conn, cap, 0);
    if (num_devices < 0) {
9260
        vshError(ctl, "%s", _("Failed to count node devices"));
E
Eric Blake 已提交
9261
        return false;
9262
    } else if (num_devices == 0) {
E
Eric Blake 已提交
9263
        return true;
9264 9265 9266 9267 9268 9269
    }

    devices = vshMalloc(ctl, sizeof(char *) * num_devices);
    num_devices =
        virNodeListDevices(ctl->conn, cap, devices, num_devices, 0);
    if (num_devices < 0) {
9270
        vshError(ctl, "%s", _("Failed to list node devices"));
9271
        VIR_FREE(devices);
E
Eric Blake 已提交
9272
        return false;
9273
    }
9274
    qsort(&devices[0], num_devices, sizeof(char*), namesorter);
9275 9276 9277 9278 9279 9280 9281
    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 已提交
9282
                parents[i] = parent ? vshStrdup(ctl, parent) : NULL;
9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301
            } 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++) {
9302 9303
            VIR_FREE(devices[i]);
            VIR_FREE(parents[i]);
9304
        }
9305
        VIR_FREE(parents);
9306 9307 9308
    } else {
        for (i = 0; i < num_devices; i++) {
            vshPrint(ctl, "%s\n", devices[i]);
9309
            VIR_FREE(devices[i]);
9310
        }
9311
    }
9312
    VIR_FREE(devices);
E
Eric Blake 已提交
9313
    return true;
9314 9315 9316 9317 9318 9319
}

/*
 * "nodedev-dumpxml" command
 */
static const vshCmdInfo info_node_device_dumpxml[] = {
9320 9321
    {"help", N_("node device details in XML")},
    {"desc", N_("Output the node device details as an XML dump to stdout.")},
9322 9323 9324 9325 9326
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dumpxml[] = {
9327
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9328 9329 9330
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9331
static bool
9332 9333
cmdNodeDeviceDumpXML (vshControl *ctl, const vshCmd *cmd)
{
9334
    const char *name = NULL;
9335
    virNodeDevicePtr device;
L
Laine Stump 已提交
9336
    char *xml;
9337

9338
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9339
        return false;
9340
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9341
        return false;
9342
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9343
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9344
        return false;
9345 9346
    }

L
Laine Stump 已提交
9347 9348 9349
    xml = virNodeDeviceGetXMLDesc(device, 0);
    if (!xml) {
        virNodeDeviceFree(device);
E
Eric Blake 已提交
9350
        return false;
L
Laine Stump 已提交
9351 9352 9353
    }

    vshPrint(ctl, "%s\n", xml);
9354
    VIR_FREE(xml);
9355
    virNodeDeviceFree(device);
E
Eric Blake 已提交
9356
    return true;
9357 9358
}

9359 9360 9361 9362
/*
 * "nodedev-dettach" command
 */
static const vshCmdInfo info_node_device_dettach[] = {
9363 9364
    {"help", N_("dettach node device from its device driver")},
    {"desc", N_("Dettach node device from its device driver before assigning to a domain.")},
9365 9366 9367 9368 9369
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_dettach[] = {
9370
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9371 9372 9373
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9374
static bool
9375 9376
cmdNodeDeviceDettach (vshControl *ctl, const vshCmd *cmd)
{
9377
    const char *name = NULL;
9378
    virNodeDevicePtr device;
E
Eric Blake 已提交
9379
    bool ret = true;
9380

9381
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9382
        return false;
9383
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9384
        return false;
9385
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9386
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9387
        return false;
9388 9389 9390 9391 9392
    }

    if (virNodeDeviceDettach(device) == 0) {
        vshPrint(ctl, _("Device %s dettached\n"), name);
    } else {
9393
        vshError(ctl, _("Failed to dettach device %s"), name);
E
Eric Blake 已提交
9394
        ret = false;
9395 9396 9397 9398 9399 9400 9401 9402 9403
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reattach" command
 */
static const vshCmdInfo info_node_device_reattach[] = {
9404 9405
    {"help", N_("reattach node device to its device driver")},
    {"desc", N_("Reattach node device to its device driver once released by the domain.")},
9406 9407 9408 9409 9410
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reattach[] = {
9411
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9412 9413 9414
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9415
static bool
9416 9417
cmdNodeDeviceReAttach (vshControl *ctl, const vshCmd *cmd)
{
9418
    const char *name = NULL;
9419
    virNodeDevicePtr device;
E
Eric Blake 已提交
9420
    bool ret = true;
9421

9422
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9423
        return false;
9424
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9425
        return false;
9426
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9427
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9428
        return false;
9429 9430 9431 9432 9433
    }

    if (virNodeDeviceReAttach(device) == 0) {
        vshPrint(ctl, _("Device %s re-attached\n"), name);
    } else {
9434
        vshError(ctl, _("Failed to re-attach device %s"), name);
E
Eric Blake 已提交
9435
        ret = false;
9436 9437 9438 9439 9440 9441 9442 9443 9444
    }
    virNodeDeviceFree(device);
    return ret;
}

/*
 * "nodedev-reset" command
 */
static const vshCmdInfo info_node_device_reset[] = {
9445 9446
    {"help", N_("reset node device")},
    {"desc", N_("Reset node device before or after assigning to a domain.")},
9447 9448 9449 9450 9451
    {NULL, NULL}
};


static const vshCmdOptDef opts_node_device_reset[] = {
9452
    {"device", VSH_OT_DATA, VSH_OFLAG_REQ, N_("device key")},
9453 9454 9455
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9456
static bool
9457 9458
cmdNodeDeviceReset (vshControl *ctl, const vshCmd *cmd)
{
9459
    const char *name = NULL;
9460
    virNodeDevicePtr device;
E
Eric Blake 已提交
9461
    bool ret = true;
9462

9463
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9464
        return false;
9465
    if (vshCommandOptString(cmd, "device", &name) <= 0)
E
Eric Blake 已提交
9466
        return false;
9467
    if (!(device = virNodeDeviceLookupByName(ctl->conn, name))) {
9468
        vshError(ctl, "%s '%s'", _("Could not find matching device"), name);
E
Eric Blake 已提交
9469
        return false;
9470 9471 9472 9473 9474
    }

    if (virNodeDeviceReset(device) == 0) {
        vshPrint(ctl, _("Device %s reset\n"), name);
    } else {
9475
        vshError(ctl, _("Failed to reset device %s"), name);
E
Eric Blake 已提交
9476
        ret = false;
9477 9478 9479 9480 9481
    }
    virNodeDeviceFree(device);
    return ret;
}

9482
/*
E
Eric Blake 已提交
9483
 * "hostname" command
9484
 */
9485
static const vshCmdInfo info_hostname[] = {
9486
    {"help", N_("print the hypervisor hostname")},
9487
    {"desc", ""},
9488 9489 9490
    {NULL, NULL}
};

E
Eric Blake 已提交
9491
static bool
9492
cmdHostname (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9493 9494 9495
{
    char *hostname;

9496
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9497
        return false;
9498 9499 9500

    hostname = virConnectGetHostname (ctl->conn);
    if (hostname == NULL) {
9501
        vshError(ctl, "%s", _("failed to get hostname"));
E
Eric Blake 已提交
9502
        return false;
9503 9504 9505
    }

    vshPrint (ctl, "%s\n", hostname);
9506
    VIR_FREE(hostname);
9507

E
Eric Blake 已提交
9508
    return true;
9509 9510 9511 9512 9513
}

/*
 * "uri" command
 */
9514
static const vshCmdInfo info_uri[] = {
9515
    {"help", N_("print the hypervisor canonical URI")},
9516
    {"desc", ""},
9517 9518 9519
    {NULL, NULL}
};

E
Eric Blake 已提交
9520
static bool
9521
cmdURI (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
9522 9523 9524
{
    char *uri;

9525
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9526
        return false;
9527 9528 9529

    uri = virConnectGetURI (ctl->conn);
    if (uri == NULL) {
9530
        vshError(ctl, "%s", _("failed to get URI"));
E
Eric Blake 已提交
9531
        return false;
9532 9533 9534
    }

    vshPrint (ctl, "%s\n", uri);
9535
    VIR_FREE(uri);
9536

E
Eric Blake 已提交
9537
    return true;
9538 9539
}

E
Eric Blake 已提交
9540 9541 9542 9543 9544 9545 9546 9547 9548 9549
/*
 * "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 已提交
9550
static bool
E
Eric Blake 已提交
9551 9552 9553 9554 9555
cmdSysinfo (vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *sysinfo;

    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9556
        return false;
E
Eric Blake 已提交
9557 9558 9559 9560

    sysinfo = virConnectGetSysinfo (ctl->conn, 0);
    if (sysinfo == NULL) {
        vshError(ctl, "%s", _("failed to get sysinfo"));
E
Eric Blake 已提交
9561
        return false;
E
Eric Blake 已提交
9562 9563 9564 9565 9566
    }

    vshPrint (ctl, "%s", sysinfo);
    VIR_FREE(sysinfo);

E
Eric Blake 已提交
9567
    return true;
E
Eric Blake 已提交
9568 9569
}

9570 9571 9572
/*
 * "vncdisplay" command
 */
9573
static const vshCmdInfo info_vncdisplay[] = {
9574 9575
    {"help", N_("vnc display")},
    {"desc", N_("Output the IP address and port number for the VNC display.")},
9576 9577 9578
    {NULL, NULL}
};

9579
static const vshCmdOptDef opts_vncdisplay[] = {
9580
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9581 9582 9583
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9584
static bool
9585
cmdVNCDisplay(vshControl *ctl, const vshCmd *cmd)
9586 9587 9588 9589 9590
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9591
    bool ret = false;
9592 9593 9594
    int port = 0;
    char *doc;

9595
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9596
        return false;
9597

J
Jim Meyering 已提交
9598
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9599
        return false;
9600 9601 9602 9603 9604 9605 9606 9607

    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);
9608
    VIR_FREE(doc);
9609 9610 9611 9612 9613 9614 9615 9616 9617 9618 9619 9620 9621 9622 9623 9624 9625 9626
    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) ||
9627
        STREQ((const char*)obj->stringval, "0.0.0.0")) {
9628 9629 9630 9631 9632 9633
        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 已提交
9634
    ret = true;
9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "ttyconsole" command
 */
9648
static const vshCmdInfo info_ttyconsole[] = {
9649 9650
    {"help", N_("tty console")},
    {"desc", N_("Output the device for the TTY console.")},
9651 9652 9653
    {NULL, NULL}
};

9654
static const vshCmdOptDef opts_ttyconsole[] = {
9655
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
9656 9657 9658
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9659
static bool
9660
cmdTTYConsole(vshControl *ctl, const vshCmd *cmd)
9661 9662 9663 9664 9665
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj = NULL;
    xmlXPathContextPtr ctxt = NULL;
    virDomainPtr dom;
E
Eric Blake 已提交
9666
    bool ret = false;
9667 9668
    char *doc;

9669
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9670
        return false;
9671

J
Jim Meyering 已提交
9672
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9673
        return false;
9674 9675 9676 9677 9678 9679 9680 9681

    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);
9682
    VIR_FREE(doc);
9683 9684 9685 9686 9687 9688 9689 9690 9691 9692 9693 9694
    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 已提交
9695
    ret = true;
9696 9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707

 cleanup:
    xmlXPathFreeObject(obj);
    xmlXPathFreeContext(ctxt);
    if (xml)
        xmlFreeDoc(xml);
    virDomainFree(dom);
    return ret;
}

/*
 * "attach-device" command
9708
 */
9709
static const vshCmdInfo info_attach_device[] = {
9710 9711
    {"help", N_("attach device from an XML file")},
    {"desc", N_("Attach device from an XML <file>.")},
9712 9713 9714
    {NULL, NULL}
};

9715
static const vshCmdOptDef opts_attach_device[] = {
9716 9717 9718
    {"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")},
9719 9720 9721
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9722
static bool
9723
cmdAttachDevice(vshControl *ctl, const vshCmd *cmd)
9724 9725
{
    virDomainPtr dom;
9726
    const char *from = NULL;
9727
    char *buffer;
W
Wen Congyang 已提交
9728
    int ret;
J
Jim Fehlig 已提交
9729
    unsigned int flags;
9730

9731
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9732
        return false;
9733

J
Jim Meyering 已提交
9734
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9735
        return false;
9736

9737
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9738
        virDomainFree(dom);
E
Eric Blake 已提交
9739
        return false;
9740 9741
    }

9742
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9743
        virshReportError(ctl);
9744
        virDomainFree(dom);
E
Eric Blake 已提交
9745
        return false;
9746
    }
9747

J
Jim Fehlig 已提交
9748
    if (vshCommandOptBool(cmd, "persistent")) {
9749
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
9750
        if (virDomainIsActive(dom) == 1)
9751
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
9752 9753 9754 9755
        ret = virDomainAttachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainAttachDevice(dom, buffer);
    }
9756
    VIR_FREE(buffer);
9757 9758

    if (ret < 0) {
9759
        vshError(ctl, _("Failed to attach device from %s"), from);
9760
        virDomainFree(dom);
E
Eric Blake 已提交
9761
        return false;
9762
    } else {
J
Jim Meyering 已提交
9763
        vshPrint(ctl, "%s", _("Device attached successfully\n"));
9764 9765 9766
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9767
    return true;
9768 9769 9770 9771 9772 9773
}


/*
 * "detach-device" command
 */
9774
static const vshCmdInfo info_detach_device[] = {
9775 9776
    {"help", N_("detach device from an XML file")},
    {"desc", N_("Detach device from an XML <file>")},
9777 9778 9779
    {NULL, NULL}
};

9780
static const vshCmdOptDef opts_detach_device[] = {
9781 9782 9783
    {"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")},
9784 9785 9786
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9787
static bool
9788
cmdDetachDevice(vshControl *ctl, const vshCmd *cmd)
9789 9790
{
    virDomainPtr dom;
9791
    const char *from = NULL;
9792
    char *buffer;
W
Wen Congyang 已提交
9793
    int ret;
J
Jim Fehlig 已提交
9794
    unsigned int flags;
9795

9796
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9797
        return false;
9798

J
Jim Meyering 已提交
9799
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
E
Eric Blake 已提交
9800
        return false;
9801

9802
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9803
        virDomainFree(dom);
E
Eric Blake 已提交
9804
        return false;
9805 9806
    }

9807
    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9808
        virshReportError(ctl);
9809
        virDomainFree(dom);
E
Eric Blake 已提交
9810
        return false;
9811
    }
9812

J
Jim Fehlig 已提交
9813
    if (vshCommandOptBool(cmd, "persistent")) {
9814
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
9815
        if (virDomainIsActive(dom) == 1)
9816
           flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
9817 9818 9819 9820
        ret = virDomainDetachDeviceFlags(dom, buffer, flags);
    } else {
        ret = virDomainDetachDevice(dom, buffer);
    }
9821
    VIR_FREE(buffer);
9822 9823

    if (ret < 0) {
9824
        vshError(ctl, _("Failed to detach device from %s"), from);
9825
        virDomainFree(dom);
E
Eric Blake 已提交
9826
        return false;
9827
    } else {
J
Jim Meyering 已提交
9828
        vshPrint(ctl, "%s", _("Device detached successfully\n"));
9829 9830 9831
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9832
    return true;
9833 9834
}

9835

9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 9847 9848
/*
 * "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")},
9849
    {"force",  VSH_OT_BOOL, 0, N_("force device update")},
9850 9851 9852
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9853
static bool
9854 9855 9856
cmdUpdateDevice(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom;
9857
    const char *from = NULL;
9858
    char *buffer;
W
Wen Congyang 已提交
9859
    int ret;
9860 9861
    unsigned int flags;

9862
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
9863
        return false;
9864 9865

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

9868
    if (vshCommandOptString(cmd, "file", &from) <= 0) {
9869
        virDomainFree(dom);
E
Eric Blake 已提交
9870
        return false;
9871 9872 9873
    }

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0) {
9874
        virshReportError(ctl);
9875
        virDomainFree(dom);
E
Eric Blake 已提交
9876
        return false;
9877 9878 9879
    }

    if (vshCommandOptBool(cmd, "persistent")) {
9880
        flags = VIR_DOMAIN_AFFECT_CONFIG;
9881
        if (virDomainIsActive(dom) == 1)
9882
           flags |= VIR_DOMAIN_AFFECT_LIVE;
9883
    } else {
9884
        flags = VIR_DOMAIN_AFFECT_LIVE;
9885
    }
9886 9887 9888 9889

    if (vshCommandOptBool(cmd, "force"))
        flags |= VIR_DOMAIN_DEVICE_MODIFY_FORCE;

9890 9891 9892 9893 9894 9895
    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 已提交
9896
        return false;
9897 9898 9899 9900 9901
    } else {
        vshPrint(ctl, "%s", _("Device updated successfully\n"));
    }

    virDomainFree(dom);
E
Eric Blake 已提交
9902
    return true;
9903 9904 9905
}


9906 9907 9908
/*
 * "attach-interface" command
 */
9909
static const vshCmdInfo info_attach_interface[] = {
9910 9911
    {"help", N_("attach network interface")},
    {"desc", N_("Attach new network interface.")},
9912 9913 9914
    {NULL, NULL}
};

9915
static const vshCmdOptDef opts_attach_interface[] = {
9916 9917 9918 9919 9920 9921
    {"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")},
9922
    {"model", VSH_OT_DATA, 0, N_("model type")},
9923
    {"persistent", VSH_OT_BOOL, 0, N_("persist interface attachment")},
9924 9925 9926
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
9927
static bool
9928
cmdAttachInterface(vshControl *ctl, const vshCmd *cmd)
9929 9930
{
    virDomainPtr dom = NULL;
9931 9932
    const char *mac = NULL, *target = NULL, *script = NULL,
                *type = NULL, *source = NULL, *model = NULL;
E
Eric Blake 已提交
9933
    int typ;
W
Wen Congyang 已提交
9934 9935
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
9936
    unsigned int flags;
9937 9938
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
9939

9940
    if (!vshConnectionUsability(ctl, ctl->conn))
9941 9942
        goto cleanup;

J
Jim Meyering 已提交
9943
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
9944 9945
        goto cleanup;

9946
    if (vshCommandOptString(cmd, "type", &type) <= 0)
9947 9948
        goto cleanup;

9949 9950 9951 9952
    if (vshCommandOptString(cmd, "source", &source) < 0 ||
        vshCommandOptString(cmd, "target", &target) < 0 ||
        vshCommandOptString(cmd, "mac", &mac) < 0 ||
        vshCommandOptString(cmd, "script", &script) < 0 ||
9953 9954
        vshCommandOptString(cmd, "model", &model) < 0) {
        vshError(ctl, "missing argument");
9955
        goto cleanup;
9956
    }
9957 9958

    /* check interface type */
9959
    if (STREQ(type, "network")) {
9960
        typ = 1;
9961
    } else if (STREQ(type, "bridge")) {
9962 9963
        typ = 2;
    } else {
E
Eric Blake 已提交
9964 9965
        vshError(ctl, _("No support for %s in command 'attach-interface'"),
                 type);
9966 9967 9968 9969
        goto cleanup;
    }

    /* Make XML of interface */
9970
    virBufferAsprintf(&buf, "<interface type='%s'>\n", type);
9971

9972
    if (typ == 1)
9973
        virBufferAsprintf(&buf, "  <source network='%s'/>\n", source);
9974
    else if (typ == 2)
9975
        virBufferAsprintf(&buf, "  <source bridge='%s'/>\n", source);
9976

9977
    if (target != NULL)
9978
        virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
9979
    if (mac != NULL)
9980
        virBufferAsprintf(&buf, "  <mac address='%s'/>\n", mac);
9981
    if (script != NULL)
9982
        virBufferAsprintf(&buf, "  <script path='%s'/>\n", script);
9983
    if (model != NULL)
9984
        virBufferAsprintf(&buf, "  <model type='%s'/>\n", model);
9985

9986
    virBufferAddLit(&buf, "</interface>\n");
9987

9988 9989
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
W
Wen Congyang 已提交
9990
        goto cleanup;
9991 9992
    }

9993
    xml = virBufferContentAndReset(&buf);
9994

J
Jim Fehlig 已提交
9995
    if (vshCommandOptBool(cmd, "persistent")) {
9996
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
9997
        if (virDomainIsActive(dom) == 1)
9998
            flags |= VIR_DOMAIN_AFFECT_LIVE;
9999
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
10000
    } else {
10001
        ret = virDomainAttachDevice(dom, xml);
10002
    }
10003

10004 10005
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10006
    if (ret != 0) {
L
Laine Stump 已提交
10007
        vshError(ctl, "%s", _("Failed to attach interface"));
J
Jim Fehlig 已提交
10008 10009
    } else {
        vshPrint(ctl, "%s", _("Interface attached successfully\n"));
W
Wen Congyang 已提交
10010
        functionReturn = true;
J
Jim Fehlig 已提交
10011
    }
10012 10013 10014 10015

 cleanup:
    if (dom)
        virDomainFree(dom);
10016
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10017
    return functionReturn;
10018 10019 10020 10021 10022
}

/*
 * "detach-interface" command
 */
10023
static const vshCmdInfo info_detach_interface[] = {
10024 10025
    {"help", N_("detach network interface")},
    {"desc", N_("Detach network interface.")},
10026 10027 10028
    {NULL, NULL}
};

10029
static const vshCmdOptDef opts_detach_interface[] = {
10030 10031 10032 10033
    {"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")},
10034 10035 10036
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10037
static bool
10038
cmdDetachInterface(vshControl *ctl, const vshCmd *cmd)
10039 10040 10041 10042 10043 10044 10045
{
    virDomainPtr dom = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
10046
    const char *mac =NULL, *type = NULL;
10047
    char *doc;
10048
    char buf[64];
E
Eric Blake 已提交
10049
    int i = 0, diff_mac;
W
Wen Congyang 已提交
10050 10051
    int ret;
    int functionReturn = false;
J
Jim Fehlig 已提交
10052
    unsigned int flags;
10053

10054
    if (!vshConnectionUsability(ctl, ctl->conn))
10055 10056
        goto cleanup;

J
Jim Meyering 已提交
10057
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10058 10059
        goto cleanup;

10060
    if (vshCommandOptString(cmd, "type", &type) <= 0)
10061 10062
        goto cleanup;

10063 10064
    if (vshCommandOptString(cmd, "mac", &mac) < 0) {
        vshError(ctl, "%s", _("missing option"));
10065
        goto cleanup;
10066
    }
10067 10068 10069 10070 10071 10072 10073 10074

    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);
10075
    VIR_FREE(doc);
10076
    if (!xml) {
10077
        vshError(ctl, "%s", _("Failed to get interface information"));
10078 10079 10080 10081
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
10082
        vshError(ctl, "%s", _("Failed to get interface information"));
10083 10084 10085
        goto cleanup;
    }

E
Eric Blake 已提交
10086
    snprintf(buf, sizeof(buf), "/domain/devices/interface[@type='%s']", type);
10087 10088 10089
    obj = xmlXPathEval(BAD_CAST buf, ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10090
        vshError(ctl, _("No found interface whose type is %s"), type);
10091 10092 10093
        goto cleanup;
    }

10094 10095 10096 10097 10098 10099
    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;
    }

10100 10101 10102 10103 10104 10105 10106
    if (!mac)
        goto hit;

    /* search mac */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10107 10108 10109 10110 10111
            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);
10112 10113 10114 10115 10116 10117 10118
                if (!diff_mac) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10119
    vshError(ctl, _("No found interface whose MAC address is %s"), mac);
10120 10121 10122 10123 10124
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10125
        vshError(ctl, "%s", _("Failed to allocate memory"));
10126 10127 10128
        goto cleanup;
    }

10129
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
10130
        vshError(ctl, "%s", _("Failed to create XML"));
10131 10132 10133
        goto cleanup;
    }

J
Jim Fehlig 已提交
10134
    if (vshCommandOptBool(cmd, "persistent")) {
10135
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10136
        if (virDomainIsActive(dom) == 1)
10137
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10138 10139 10140 10141 10142 10143 10144 10145
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10146
        vshError(ctl, "%s", _("Failed to detach interface"));
J
Jim Fehlig 已提交
10147
    } else {
J
Jim Meyering 已提交
10148
        vshPrint(ctl, "%s", _("Interface detached successfully\n"));
W
Wen Congyang 已提交
10149
        functionReturn = true;
10150
    }
10151 10152 10153 10154

 cleanup:
    if (dom)
        virDomainFree(dom);
10155
    xmlXPathFreeObject(obj);
10156
    xmlXPathFreeContext(ctxt);
10157 10158 10159 10160
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
W
Wen Congyang 已提交
10161
    return functionReturn;
10162 10163 10164 10165 10166
}

/*
 * "attach-disk" command
 */
10167
static const vshCmdInfo info_attach_disk[] = {
10168 10169
    {"help", N_("attach disk device")},
    {"desc", N_("Attach new disk device.")},
10170 10171 10172
    {NULL, NULL}
};

10173
static const vshCmdOptDef opts_attach_disk[] = {
10174 10175 10176 10177 10178 10179 10180 10181
    {"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")},
10182
    {"sourcetype", VSH_OT_STRING, 0, N_("type of source (block|file)")},
10183 10184 10185
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10186
static bool
10187
cmdAttachDisk(vshControl *ctl, const vshCmd *cmd)
10188 10189
{
    virDomainPtr dom = NULL;
10190 10191
    const char *source = NULL, *target = NULL, *driver = NULL,
                *subdriver = NULL, *type = NULL, *mode = NULL;
W
Wen Congyang 已提交
10192 10193
    bool isFile = false, functionReturn = false;
    int ret;
J
Jim Fehlig 已提交
10194
    unsigned int flags;
10195
    const char *stype = NULL;
10196 10197
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *xml;
10198

10199
    if (!vshConnectionUsability(ctl, ctl->conn))
10200 10201
        goto cleanup;

J
Jim Meyering 已提交
10202
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10203 10204
        goto cleanup;

10205
    if (vshCommandOptString(cmd, "source", &source) <= 0)
10206 10207
        goto cleanup;

10208
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10209 10210
        goto cleanup;

10211 10212 10213 10214 10215
    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) {
10216
        vshError(ctl, "%s", _("missing option"));
10217 10218
        goto cleanup;
    }
10219

10220 10221
    if (!stype) {
        if (driver && (STREQ(driver, "file") || STREQ(driver, "tap")))
E
Eric Blake 已提交
10222
            isFile = true;
10223
    } else if (STREQ(stype, "file")) {
E
Eric Blake 已提交
10224
        isFile = true;
10225 10226 10227
    } else if (STRNEQ(stype, "block")) {
        vshError(ctl, _("Unknown source type: '%s'"), stype);
        goto cleanup;
10228 10229 10230
    }

    if (mode) {
10231
        if (STRNEQ(mode, "readonly") && STRNEQ(mode, "shareable")) {
E
Eric Blake 已提交
10232 10233
            vshError(ctl, _("No support for %s in command 'attach-disk'"),
                     mode);
10234 10235 10236 10237 10238
            goto cleanup;
        }
    }

    /* Make XML of disk */
10239
    virBufferAsprintf(&buf, "<disk type='%s'",
10240 10241
                      (isFile) ? "file" : "block");
    if (type)
10242
        virBufferAsprintf(&buf, " device='%s'", type);
10243 10244
    virBufferAddLit(&buf, ">\n");

10245
    if (driver || subdriver)
10246
        virBufferAsprintf(&buf, "  <driver");
10247 10248

    if (driver)
10249
        virBufferAsprintf(&buf, " name='%s'", driver);
10250
    if (subdriver)
10251
        virBufferAsprintf(&buf, " type='%s'", subdriver);
10252 10253 10254

    if (driver || subdriver)
        virBufferAddLit(&buf, "/>\n");
10255

10256
    virBufferAsprintf(&buf, "  <source %s='%s'/>\n",
10257 10258
                      (isFile) ? "file" : "dev",
                      source);
10259
    virBufferAsprintf(&buf, "  <target dev='%s'/>\n", target);
10260
    if (mode)
10261
        virBufferAsprintf(&buf, "  <%s/>\n", mode);
10262 10263

    virBufferAddLit(&buf, "</disk>\n");
10264

10265 10266
    if (virBufferError(&buf)) {
        vshPrint(ctl, "%s", _("Failed to allocate XML buffer"));
E
Eric Blake 已提交
10267
        return false;
10268 10269
    }

10270
    xml = virBufferContentAndReset(&buf);
10271

J
Jim Fehlig 已提交
10272
    if (vshCommandOptBool(cmd, "persistent")) {
10273
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10274
        if (virDomainIsActive(dom) == 1)
10275
            flags |= VIR_DOMAIN_AFFECT_LIVE;
10276
        ret = virDomainAttachDeviceFlags(dom, xml, flags);
J
Jim Fehlig 已提交
10277
    } else {
10278
        ret = virDomainAttachDevice(dom, xml);
J
Jim Fehlig 已提交
10279
    }
10280

10281 10282
    VIR_FREE(xml);

J
Jim Fehlig 已提交
10283
    if (ret != 0) {
L
Laine Stump 已提交
10284
        vshError(ctl, "%s", _("Failed to attach disk"));
J
Jim Fehlig 已提交
10285 10286
    } else {
        vshPrint(ctl, "%s", _("Disk attached successfully\n"));
W
Wen Congyang 已提交
10287
        functionReturn = true;
J
Jim Fehlig 已提交
10288
    }
10289 10290 10291 10292

 cleanup:
    if (dom)
        virDomainFree(dom);
10293
    virBufferFreeAndReset(&buf);
W
Wen Congyang 已提交
10294
    return functionReturn;
10295 10296 10297 10298 10299
}

/*
 * "detach-disk" command
 */
10300
static const vshCmdInfo info_detach_disk[] = {
10301 10302
    {"help", N_("detach disk device")},
    {"desc", N_("Detach disk device.")},
10303 10304 10305
    {NULL, NULL}
};

10306
static const vshCmdOptDef opts_detach_disk[] = {
10307 10308 10309
    {"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")},
10310 10311 10312
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10313
static bool
10314
cmdDetachDisk(vshControl *ctl, const vshCmd *cmd)
10315 10316 10317 10318 10319 10320 10321
{
    xmlDocPtr xml = NULL;
    xmlXPathObjectPtr obj=NULL;
    xmlXPathContextPtr ctxt = NULL;
    xmlNodePtr cur = NULL;
    xmlBufferPtr xml_buf = NULL;
    virDomainPtr dom = NULL;
10322
    const char *target = NULL;
10323
    char *doc;
E
Eric Blake 已提交
10324
    int i = 0, diff_tgt;
W
Wen Congyang 已提交
10325 10326
    int ret;
    bool functionReturn = false;
J
Jim Fehlig 已提交
10327
    unsigned int flags;
10328

10329
    if (!vshConnectionUsability(ctl, ctl->conn))
10330 10331
        goto cleanup;

J
Jim Meyering 已提交
10332
    if (!(dom = vshCommandOptDomain(ctl, cmd, NULL)))
10333 10334
        goto cleanup;

10335
    if (vshCommandOptString(cmd, "target", &target) <= 0)
10336 10337 10338 10339 10340 10341 10342 10343 10344
        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);
10345
    VIR_FREE(doc);
10346
    if (!xml) {
10347
        vshError(ctl, "%s", _("Failed to get disk information"));
10348 10349 10350 10351
        goto cleanup;
    }
    ctxt = xmlXPathNewContext(xml);
    if (!ctxt) {
10352
        vshError(ctl, "%s", _("Failed to get disk information"));
10353 10354 10355 10356 10357 10358
        goto cleanup;
    }

    obj = xmlXPathEval(BAD_CAST "/domain/devices/disk", ctxt);
    if ((obj == NULL) || (obj->type != XPATH_NODESET) ||
        (obj->nodesetval == NULL) || (obj->nodesetval->nodeNr == 0)) {
10359
        vshError(ctl, "%s", _("Failed to get disk information"));
10360 10361 10362 10363 10364 10365 10366
        goto cleanup;
    }

    /* search target */
    for (; i < obj->nodesetval->nodeNr; i++) {
        cur = obj->nodesetval->nodeTab[i]->children;
        while (cur != NULL) {
10367 10368 10369 10370 10371
            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);
10372 10373 10374 10375 10376 10377 10378
                if (diff_tgt) {
                    goto hit;
                }
            }
            cur = cur->next;
        }
    }
10379
    vshError(ctl, _("No found disk whose target is %s"), target);
10380 10381 10382 10383 10384
    goto cleanup;

 hit:
    xml_buf = xmlBufferCreate();
    if (!xml_buf) {
10385
        vshError(ctl, "%s", _("Failed to allocate memory"));
10386 10387 10388
        goto cleanup;
    }

10389
    if (xmlNodeDump(xml_buf, xml, obj->nodesetval->nodeTab[i], 0, 0) < 0) {
10390
        vshError(ctl, "%s", _("Failed to create XML"));
10391 10392 10393
        goto cleanup;
    }

J
Jim Fehlig 已提交
10394
    if (vshCommandOptBool(cmd, "persistent")) {
10395
        flags = VIR_DOMAIN_AFFECT_CONFIG;
J
Jim Fehlig 已提交
10396
        if (virDomainIsActive(dom) == 1)
10397
            flags |= VIR_DOMAIN_AFFECT_LIVE;
J
Jim Fehlig 已提交
10398 10399 10400 10401 10402 10403 10404 10405
        ret = virDomainDetachDeviceFlags(dom,
                                         (char *)xmlBufferContent(xml_buf),
                                         flags);
    } else {
        ret = virDomainDetachDevice(dom, (char *)xmlBufferContent(xml_buf));
    }

    if (ret != 0) {
L
Laine Stump 已提交
10406
        vshError(ctl, "%s", _("Failed to detach disk"));
J
Jim Fehlig 已提交
10407
    } else {
J
Jim Meyering 已提交
10408
        vshPrint(ctl, "%s", _("Disk detached successfully\n"));
W
Wen Congyang 已提交
10409
        functionReturn = true;
10410
    }
10411 10412

 cleanup:
10413
    xmlXPathFreeObject(obj);
10414
    xmlXPathFreeContext(ctxt);
10415 10416 10417 10418 10419 10420
    if (xml)
        xmlFreeDoc(xml);
    if (xml_buf)
        xmlBufferFree(xml_buf);
    if (dom)
        virDomainFree(dom);
W
Wen Congyang 已提交
10421
    return functionReturn;
10422 10423
}

10424 10425 10426 10427
/*
 * "cpu-compare" command
 */
static const vshCmdInfo info_cpu_compare[] = {
10428 10429
    {"help", N_("compare host CPU with a CPU described by an XML file")},
    {"desc", N_("compare CPU with host CPU")},
10430 10431 10432 10433
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_compare[] = {
10434
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing an XML CPU description")},
10435 10436 10437
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10438
static bool
10439 10440
cmdCPUCompare(vshControl *ctl, const vshCmd *cmd)
{
10441
    const char *from = NULL;
E
Eric Blake 已提交
10442
    bool ret = true;
10443 10444 10445
    char *buffer;
    int result;

10446
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10447
        return false;
10448

10449
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10450
        return false;
10451 10452

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

    result = virConnectCompareCPU(ctl->conn, buffer, 0);
10456
    VIR_FREE(buffer);
10457 10458 10459 10460 10461

    switch (result) {
    case VIR_CPU_COMPARE_INCOMPATIBLE:
        vshPrint(ctl, _("CPU described in %s is incompatible with host CPU\n"),
                 from);
E
Eric Blake 已提交
10462
        ret = false;
10463 10464 10465 10466 10467
        break;

    case VIR_CPU_COMPARE_IDENTICAL:
        vshPrint(ctl, _("CPU described in %s is identical to host CPU\n"),
                 from);
E
Eric Blake 已提交
10468
        ret = true;
10469 10470 10471 10472 10473
        break;

    case VIR_CPU_COMPARE_SUPERSET:
        vshPrint(ctl, _("Host CPU is a superset of CPU described in %s\n"),
                 from);
E
Eric Blake 已提交
10474
        ret = true;
10475 10476 10477 10478 10479
        break;

    case VIR_CPU_COMPARE_ERROR:
    default:
        vshError(ctl, _("Failed to compare host CPU with %s"), from);
E
Eric Blake 已提交
10480
        ret = false;
10481 10482 10483 10484 10485
    }

    return ret;
}

10486 10487 10488 10489
/*
 * "cpu-baseline" command
 */
static const vshCmdInfo info_cpu_baseline[] = {
10490 10491
    {"help", N_("compute baseline CPU")},
    {"desc", N_("Compute baseline CPU for a set of given CPUs.")},
10492 10493 10494 10495
    {NULL, NULL}
};

static const vshCmdOptDef opts_cpu_baseline[] = {
10496
    {"file", VSH_OT_DATA, VSH_OFLAG_REQ, N_("file containing XML CPU descriptions")},
10497 10498 10499
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10500
static bool
10501 10502
cmdCPUBaseline(vshControl *ctl, const vshCmd *cmd)
{
10503
    const char *from = NULL;
E
Eric Blake 已提交
10504
    bool ret = true;
10505 10506 10507 10508 10509
    char *buffer;
    char *result = NULL;
    const char **list = NULL;
    unsigned int count = 0;
    xmlDocPtr doc = NULL;
10510
    xmlNodePtr node_list;
10511 10512 10513 10514 10515 10516
    xmlXPathContextPtr ctxt = NULL;
    xmlSaveCtxtPtr sctxt = NULL;
    xmlBufferPtr buf = NULL;
    xmlXPathObjectPtr obj = NULL;
    int res, i;

10517
    if (!vshConnectionUsability(ctl, ctl->conn))
E
Eric Blake 已提交
10518
        return false;
10519

10520
    if (vshCommandOptString(cmd, "file", &from) <= 0)
E
Eric Blake 已提交
10521
        return false;
10522 10523

    if (virFileReadAll(from, VIRSH_MAX_XML_FILE, &buffer) < 0)
E
Eric Blake 已提交
10524
        return false;
10525 10526 10527 10528 10529

    doc = xmlNewDoc(NULL);
    if (doc == NULL)
        goto no_memory;

L
Laine Stump 已提交
10530 10531
    res = xmlParseBalancedChunkMemory(doc, NULL, NULL, 0,
                                      (const xmlChar *)buffer, &node_list);
10532 10533
    if (res != 0) {
        vshError(ctl, _("Failed to parse XML fragment %s"), from);
E
Eric Blake 已提交
10534
        ret = false;
10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 10546 10547 10548 10549 10550 10551 10552 10553 10554 10555 10556 10557 10558 10559 10560 10561 10562 10563 10564 10565 10566 10567 10568 10569 10570
        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 已提交
10571
        ret = false;
10572 10573 10574 10575 10576 10577 10578 10579
        goto cleanup;
    }

    result = virConnectBaselineCPU(ctl->conn, list, count, 0);

    if (result)
        vshPrint(ctl, "%s", result);
    else
E
Eric Blake 已提交
10580
        ret = false;
10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597

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 已提交
10598
    ret = false;
10599
    goto cleanup;
10600 10601
}

10602 10603 10604 10605 10606 10607 10608 10609
/* 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;

10610
    ret = vshMalloc(ctl, PATH_MAX);
10611 10612 10613

    tmpdir = getenv ("TMPDIR");
    if (!tmpdir) tmpdir = "/tmp";
10614 10615
    snprintf (ret, PATH_MAX, "%s/virshXXXXXX.xml", tmpdir);
    fd = mkstemps(ret, 4);
10616
    if (fd == -1) {
10617
        vshError(ctl, _("mkstemps: failed to create temporary file: %s"),
10618
                 strerror(errno));
10619
        VIR_FREE(ret);
10620 10621 10622 10623
        return NULL;
    }

    if (safewrite (fd, doc, strlen (doc)) == -1) {
10624 10625
        vshError(ctl, _("write: %s: failed to write to temporary file: %s"),
                 ret, strerror(errno));
S
Stefan Berger 已提交
10626
        VIR_FORCE_CLOSE(fd);
10627
        unlink (ret);
10628
        VIR_FREE(ret);
10629 10630
        return NULL;
    }
S
Stefan Berger 已提交
10631
    if (VIR_CLOSE(fd) < 0) {
10632 10633
        vshError(ctl, _("close: %s: failed to write or close temporary file: %s"),
                 ret, strerror(errno));
10634
        unlink (ret);
10635
        VIR_FREE(ret);
10636 10637 10638 10639 10640 10641 10642 10643 10644 10645 10646 10647 10648 10649 10650
        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 已提交
10651 10652 10653 10654
    virCommandPtr cmd;
    int ret = -1;
    int outfd = STDOUT_FILENO;
    int errfd = STDERR_FILENO;
10655

10656
    editor = getenv ("VISUAL");
E
Eric Blake 已提交
10657 10658 10659 10660
    if (!editor)
        editor = getenv ("EDITOR");
    if (!editor)
        editor = "vi"; /* could be cruel & default to ed(1) here */
10661

10662 10663 10664 10665 10666
    /* 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 已提交
10667 10668
     * is why sudo scrubs it by default).  Conversely, if the editor
     * is safe, we can run it directly rather than wasting a shell.
10669
     */
E
Eric Blake 已提交
10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681
    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);
10682 10683
    }

E
Eric Blake 已提交
10684 10685 10686 10687 10688 10689 10690
    virCommandSetInputFD(cmd, STDIN_FILENO);
    virCommandSetOutputFD(cmd, &outfd);
    virCommandSetErrorFD(cmd, &errfd);
    if (virCommandRunAsync(cmd, NULL) < 0 ||
        virCommandWait(cmd, NULL) < 0) {
        virshReportError(ctl);
        goto cleanup;
10691
    }
E
Eric Blake 已提交
10692
    ret = 0;
10693

E
Eric Blake 已提交
10694 10695 10696
cleanup:
    virCommandFree(cmd);
    return ret;
10697 10698 10699 10700 10701 10702 10703 10704
}

static char *
editReadBackFile (vshControl *ctl, const char *filename)
{
    char *ret;

    if (virFileReadAll (filename, VIRSH_MAX_XML_FILE, &ret) == -1) {
10705
        vshError(ctl,
10706
                 _("%s: failed to read temporary file: %s"),
10707
                 filename, strerror(errno));
10708 10709 10710 10711 10712
        return NULL;
    }
    return ret;
}

10713

P
Paolo Bonzini 已提交
10714 10715 10716 10717
/*
 * "cd" command
 */
static const vshCmdInfo info_cd[] = {
10718 10719
    {"help", N_("change the current directory")},
    {"desc", N_("Change the current directory.")},
P
Paolo Bonzini 已提交
10720 10721 10722 10723
    {NULL, NULL}
};

static const vshCmdOptDef opts_cd[] = {
10724
    {"dir", VSH_OT_DATA, 0, N_("directory to switch to (default: home or else root)")},
P
Paolo Bonzini 已提交
10725 10726 10727
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
10728
static bool
10729
cmdCd(vshControl *ctl, const vshCmd *cmd)
P
Paolo Bonzini 已提交
10730
{
10731
    const char *dir = NULL;
10732
    char *dir_malloced = NULL;
E
Eric Blake 已提交
10733
    bool ret = true;
P
Paolo Bonzini 已提交
10734 10735

    if (!ctl->imode) {
10736
        vshError(ctl, "%s", _("cd: command valid only in interactive mode"));
E
Eric Blake 已提交
10737
        return false;
P
Paolo Bonzini 已提交
10738 10739
    }

10740
    if (vshCommandOptString(cmd, "dir", &dir) <= 0) {
P
Paolo Bonzini 已提交
10741
        uid_t uid = geteuid();
10742
        dir = dir_malloced = virGetUserDirectory(uid);
P
Paolo Bonzini 已提交
10743 10744 10745 10746
    }
    if (!dir)
        dir = "/";

P
Phil Petty 已提交
10747
    if (chdir(dir) == -1) {
10748
        vshError(ctl, _("cd: %s: %s"), strerror(errno), dir);
E
Eric Blake 已提交
10749
        ret = false;
P
Paolo Bonzini 已提交
10750 10751
    }

10752
    VIR_FREE(dir_malloced);
P
Phil Petty 已提交
10753
    return ret;
P
Paolo Bonzini 已提交
10754 10755 10756 10757 10758 10759
}

/*
 * "pwd" command
 */
static const vshCmdInfo info_pwd[] = {
10760 10761
    {"help", N_("print the current directory")},
    {"desc", N_("Print the current directory.")},
P
Paolo Bonzini 已提交
10762 10763 10764
    {NULL, NULL}
};

E
Eric Blake 已提交
10765
static bool
P
Paolo Bonzini 已提交
10766 10767 10768
cmdPwd(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
{
    char *cwd;
10769
    bool ret = true;
P
Paolo Bonzini 已提交
10770

10771 10772
    cwd = getcwd(NULL, 0);
    if (!cwd) {
10773 10774
        vshError(ctl, _("pwd: cannot get current directory: %s"),
                 strerror(errno));
10775 10776
        ret = false;
    } else {
P
Paolo Bonzini 已提交
10777
        vshPrint (ctl, _("%s\n"), cwd);
10778 10779
        VIR_FREE(cwd);
    }
P
Paolo Bonzini 已提交
10780

10781
    return ret;
P
Paolo Bonzini 已提交
10782 10783
}

E
Eric Blake 已提交
10784 10785 10786 10787 10788 10789 10790 10791 10792 10793 10794 10795
/*
 * "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")},
10796
    {"string", VSH_OT_ARGV, 0, N_("arguments to echo")},
E
Eric Blake 已提交
10797 10798 10799 10800 10801 10802
    {NULL, 0, 0, NULL}
};

/* Exists mainly for debugging virsh, but also handy for adding back
 * quotes for later evaluation.
 */
E
Eric Blake 已提交
10803
static bool
E
Eric Blake 已提交
10804 10805 10806 10807 10808
cmdEcho (vshControl *ctl ATTRIBUTE_UNUSED, const vshCmd *cmd)
{
    bool shell = false;
    bool xml = false;
    int count = 0;
10809
    const vshCmdOpt *opt = NULL;
E
Eric Blake 已提交
10810 10811 10812 10813 10814 10815 10816 10817
    char *arg;
    virBuffer buf = VIR_BUFFER_INITIALIZER;

    if (vshCommandOptBool(cmd, "shell"))
        shell = true;
    if (vshCommandOptBool(cmd, "xml"))
        xml = true;

10818
    while ((opt = vshCommandOptArgv(cmd, opt))) {
E
Eric Blake 已提交
10819 10820 10821
        bool close_quote = false;
        char *q;

10822
        arg = opt->data;
E
Eric Blake 已提交
10823 10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850
        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 已提交
10851
        return false;
E
Eric Blake 已提交
10852 10853 10854 10855 10856
    }
    arg = virBufferContentAndReset(&buf);
    if (arg)
        vshPrint(ctl, "%s", arg);
    VIR_FREE(arg);
E
Eric Blake 已提交
10857
    return true;
E
Eric Blake 已提交
10858 10859
}

10860 10861 10862 10863
/*
 * "edit" command
 */
static const vshCmdInfo info_edit[] = {
10864 10865
    {"help", N_("edit XML configuration for a domain")},
    {"desc", N_("Edit the XML configuration for a domain.")},
10866 10867 10868 10869
    {NULL, NULL}
};

static const vshCmdOptDef opts_edit[] = {
10870
    {"domain", VSH_OT_DATA, VSH_OFLAG_REQ, N_("domain name, id or uuid")},
10871 10872 10873 10874 10875 10876
    {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 已提交
10877
static bool
10878 10879
cmdEdit (vshControl *ctl, const vshCmd *cmd)
{
E
Eric Blake 已提交
10880
    bool ret = false;
10881 10882 10883 10884 10885
    virDomainPtr dom = NULL;
    char *tmp = NULL;
    char *doc = NULL;
    char *doc_edited = NULL;
    char *doc_reread = NULL;
10886
    int flags = VIR_DOMAIN_XML_SECURE | VIR_DOMAIN_XML_INACTIVE;
10887

10888
    if (!vshConnectionUsability(ctl, ctl->conn))
10889 10890
        goto cleanup;

J
Jim Meyering 已提交
10891
    dom = vshCommandOptDomain (ctl, cmd, NULL);
10892 10893 10894 10895
    if (dom == NULL)
        goto cleanup;

    /* Get the XML configuration of the domain. */
10896
    doc = virDomainGetXMLDesc (dom, flags);
10897 10898 10899 10900 10901 10902 10903 10904 10905 10906 10907 10908 10909 10910 10911 10912 10913 10914
    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 已提交
10915
        ret = true;
10916 10917 10918 10919 10920 10921 10922
        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.
     */
10923
    doc_reread = virDomainGetXMLDesc (dom, flags);
10924 10925 10926 10927
    if (!doc_reread)
        goto cleanup;

    if (STRNEQ (doc, doc_reread)) {
10928 10929
        vshError(ctl,
                 "%s", _("ERROR: the XML configuration was changed by another user"));
10930 10931 10932 10933 10934 10935 10936 10937 10938 10939 10940 10941
        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 已提交
10942
    ret = true;
10943 10944 10945 10946 10947

 cleanup:
    if (dom)
        virDomainFree (dom);

10948 10949 10950
    VIR_FREE(doc);
    VIR_FREE(doc_edited);
    VIR_FREE(doc_reread);
10951 10952 10953

    if (tmp) {
        unlink (tmp);
10954
        VIR_FREE(tmp);
10955 10956 10957 10958 10959
    }

    return ret;
}

10960

10961 10962 10963 10964
/*
 * "net-edit" command
 */
static const vshCmdInfo info_network_edit[] = {
10965 10966
    {"help", N_("edit XML configuration for a network")},
    {"desc", N_("Edit the XML configuration for a network.")},
10967 10968 10969 10970
    {NULL, NULL}
};

static const vshCmdOptDef opts_network_edit[] = {
10971
    {"network", VSH_OT_DATA, VSH_OFLAG_REQ, N_("network name or uuid")},
10972 10973 10974 10975 10976 10977 10978 10979 10980 10981
    {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[] = {
10982 10983
    {"help", N_("edit XML configuration for a storage pool")},
    {"desc", N_("Edit the XML configuration for a storage pool.")},
10984 10985 10986 10987
    {NULL, NULL}
};

static const vshCmdOptDef opts_pool_edit[] = {
10988
    {"pool", VSH_OT_DATA, VSH_OFLAG_REQ, N_("pool name or uuid")},
10989 10990 10991 10992 10993 10994
    {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 已提交
10995 10996 10997
/*
 * "quit" command
 */
10998
static const vshCmdInfo info_quit[] = {
10999
    {"help", N_("quit this interactive terminal")},
11000
    {"desc", ""},
11001
    {NULL, NULL}
K
Karel Zak 已提交
11002 11003
};

E
Eric Blake 已提交
11004
static bool
11005
cmdQuit(vshControl *ctl, const vshCmd *cmd ATTRIBUTE_UNUSED)
11006
{
E
Eric Blake 已提交
11007 11008
    ctl->imode = false;
    return true;
K
Karel Zak 已提交
11009 11010
}

11011 11012 11013 11014
/*
 * "snapshot-create" command
 */
static const vshCmdInfo info_snapshot_create[] = {
E
Eric Blake 已提交
11015 11016
    {"help", N_("Create a snapshot from XML")},
    {"desc", N_("Create a snapshot (disk and RAM) from XML")},
11017 11018 11019 11020 11021 11022 11023 11024 11025
    {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 已提交
11026
static bool
11027 11028 11029
cmdSnapshotCreate(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11030
    bool ret = false;
11031
    const char *from = NULL;
11032 11033 11034 11035 11036 11037 11038
    char *buffer = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    char *name = NULL;

11039
    if (!vshConnectionUsability(ctl, ctl->conn))
11040 11041 11042 11043 11044 11045
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11046
    if (vshCommandOptString(cmd, "xmlfile", &from) <= 0)
E
Eric Blake 已提交
11047
        buffer = vshStrdup(ctl, "<domainsnapshot/>");
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 11084 11085 11086 11087 11088 11089 11090 11091
    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 已提交
11092
    ret = true;
11093 11094 11095 11096 11097 11098 11099 11100 11101 11102 11103 11104 11105 11106 11107 11108

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

11109 11110 11111 11112 11113 11114 11115 11116 11117 11118 11119 11120 11121
/*
 * "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 已提交
11122
    {"print-xml", VSH_OT_BOOL, 0, N_("print XML document rather than create")},
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 11159 11160 11161 11162 11163 11164 11165 11166
    {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 已提交
11167 11168 11169 11170 11171 11172
    if (vshCommandOptBool(cmd, "print-xml")) {
        vshPrint(ctl, "%s\n",  buffer);
        ret = true;
        goto cleanup;
    }

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 11208 11209 11210 11211 11212 11213 11214 11215
    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;
}

11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229
/*
 * "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 已提交
11230
static bool
11231 11232 11233
cmdSnapshotCurrent(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11234
    bool ret = false;
11235 11236 11237
    int current;
    virDomainSnapshotPtr snapshot = NULL;

11238
    if (!vshConnectionUsability(ctl, ctl->conn))
11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 11255 11256 11257 11258 11259 11260 11261
        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 已提交
11262
    ret = true;
11263 11264 11265 11266 11267 11268 11269 11270 11271 11272 11273 11274 11275 11276 11277 11278 11279 11280 11281 11282 11283 11284 11285 11286

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 已提交
11287
static bool
11288 11289 11290
cmdSnapshotList(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11291
    bool ret = false;
11292 11293
    int numsnaps;
    char **names = NULL;
11294
    int actual = 0;
11295 11296 11297 11298 11299 11300
    int i;
    xmlDocPtr xml = NULL;
    xmlXPathContextPtr ctxt = NULL;
    char *doc = NULL;
    virDomainSnapshotPtr snapshot = NULL;
    char *state = NULL;
11301 11302
    long long creation_longlong;
    time_t creation_time_t;
11303 11304 11305
    char timestr[100];
    struct tm time_info;

11306
    if (!vshConnectionUsability(ctl, ctl->conn))
11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

    numsnaps = virDomainSnapshotNum(dom, 0);

    if (numsnaps < 0)
        goto cleanup;

11318 11319
    vshPrintExtra(ctl, " %-20s %-25s %s\n", _("Name"), _("Creation Time"), _("State"));
    vshPrintExtra(ctl, "---------------------------------------------------\n");
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 11353 11354 11355 11356 11357 11358 11359 11360

    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;
11361 11362
            if (virXPathLongLong("string(/domainsnapshot/creationTime)", ctxt,
                                 &creation_longlong) < 0)
11363
                continue;
11364 11365 11366 11367 11368 11369
            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);
11370
            strftime(timestr, sizeof(timestr), "%Y-%m-%d %H:%M:%S %z", &time_info);
11371 11372 11373 11374 11375

            vshPrint(ctl, " %-20s %-25s %s\n", names[i], timestr, state);
        }
    }

E
Eric Blake 已提交
11376
    ret = true;
11377 11378 11379 11380 11381 11382 11383 11384 11385 11386

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);
11387 11388
    for (i = 0; i < actual; i++)
        VIR_FREE(names[i]);
11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410
    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 已提交
11411
static bool
11412 11413 11414
cmdSnapshotDumpXML(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11415
    bool ret = false;
11416
    const char *name = NULL;
11417 11418 11419
    virDomainSnapshotPtr snapshot = NULL;
    char *xml = NULL;

11420
    if (!vshConnectionUsability(ctl, ctl->conn))
11421 11422 11423 11424 11425 11426
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11427
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11428 11429 11430 11431 11432 11433 11434 11435 11436 11437
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    xml = virDomainSnapshotGetXMLDesc(snapshot, 0);
    if (!xml)
        goto cleanup;

11438
    vshPrint(ctl, "%s", xml);
11439

E
Eric Blake 已提交
11440
    ret = true;
11441 11442 11443 11444 11445 11446 11447 11448 11449 11450 11451 11452

cleanup:
    VIR_FREE(xml);
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

/*
11453
 * "snapshot-revert" command
11454
 */
11455
static const vshCmdInfo info_snapshot_revert[] = {
11456 11457 11458 11459 11460
    {"help", N_("Revert a domain to a snapshot")},
    {"desc", N_("Revert domain to snapshot")},
    {NULL, NULL}
};

11461
static const vshCmdOptDef opts_snapshot_revert[] = {
11462 11463 11464 11465 11466
    {"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 已提交
11467
static bool
11468
cmdDomainSnapshotRevert(vshControl *ctl, const vshCmd *cmd)
11469 11470
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11471
    bool ret = false;
11472
    const char *name = NULL;
11473 11474
    virDomainSnapshotPtr snapshot = NULL;

11475
    if (!vshConnectionUsability(ctl, ctl->conn))
11476 11477 11478 11479 11480 11481
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11482
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11483 11484 11485 11486 11487 11488 11489 11490 11491
        goto cleanup;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    if (virDomainRevertToSnapshot(snapshot, 0) < 0)
        goto cleanup;

E
Eric Blake 已提交
11492
    ret = true;
11493 11494 11495 11496 11497 11498 11499 11500 11501 11502 11503 11504 11505 11506 11507 11508 11509 11510 11511 11512 11513 11514 11515 11516 11517 11518

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 已提交
11519
static bool
11520 11521 11522
cmdSnapshotDelete(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11523
    bool ret = false;
11524
    const char *name = NULL;
11525 11526 11527
    virDomainSnapshotPtr snapshot = NULL;
    unsigned int flags = 0;

11528
    if (!vshConnectionUsability(ctl, ctl->conn))
11529 11530 11531 11532 11533 11534
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11535
    if (vshCommandOptString(cmd, "snapshotname", &name) <= 0)
11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547
        goto cleanup;

    if (vshCommandOptBool(cmd, "children"))
        flags |= VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN;

    snapshot = virDomainSnapshotLookupByName(dom, name, 0);
    if (snapshot == NULL)
        goto cleanup;

    if (virDomainSnapshotDelete(snapshot, flags) < 0)
        goto cleanup;

E
Eric Blake 已提交
11548
    ret = true;
11549 11550 11551 11552 11553 11554 11555 11556 11557 11558

cleanup:
    if (snapshot)
        virDomainSnapshotFree(snapshot);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11559 11560 11561 11562 11563 11564 11565 11566 11567 11568 11569 11570
/*
 * "qemu-monitor-command" command
 */
static const vshCmdInfo info_qemu_monitor_command[] = {
    {"help", N_("Qemu Monitor Command")},
    {"desc", N_("Qemu Monitor Command")},
    {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")},
11571
    {"hmp", VSH_OT_BOOL, 0, N_("command is in human monitor protocol")},
11572 11573 11574
    {NULL, 0, 0, NULL}
};

E
Eric Blake 已提交
11575
static bool
11576 11577 11578
cmdQemuMonitorCommand(vshControl *ctl, const vshCmd *cmd)
{
    virDomainPtr dom = NULL;
E
Eric Blake 已提交
11579
    bool ret = false;
11580
    const char *monitor_cmd = NULL;
11581
    char *result = NULL;
11582
    unsigned int flags = 0;
11583 11584 11585 11586 11587 11588 11589 11590

    if (!vshConnectionUsability(ctl, ctl->conn))
        goto cleanup;

    dom = vshCommandOptDomain(ctl, cmd, NULL);
    if (dom == NULL)
        goto cleanup;

11591
    if (vshCommandOptString(cmd, "cmd", &monitor_cmd) <= 0) {
11592 11593 11594 11595
        vshError(ctl, "%s", _("missing monitor command"));
        goto cleanup;
    }

11596 11597 11598 11599
    if (vshCommandOptBool(cmd, "hmp"))
        flags |= VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP;

    if (virDomainQemuMonitorCommand(dom, monitor_cmd, &result, flags) < 0)
11600 11601 11602 11603
        goto cleanup;

    printf("%s\n", result);

E
Eric Blake 已提交
11604
    ret = true;
11605 11606 11607 11608 11609 11610 11611 11612 11613

cleanup:
    VIR_FREE(result);
    if (dom)
        virDomainFree(dom);

    return ret;
}

11614
static const vshCmdDef domManagementCmds[] = {
11615 11616 11617 11618 11619 11620 11621 11622
    {"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},
11623
#ifndef WIN32
11624
    {"console", cmdConsole, opts_console, info_console, 0},
11625
#endif
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 11656
    {"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},
11657 11658
    {"migrate-setspeed", cmdMigrateSetMaxSpeed,
     opts_migrate_setspeed, info_migrate_setspeed, 0},
11659 11660 11661 11662 11663
    {"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},
11664
    {"screenshot", cmdScreenshot, opts_screenshot, info_screenshot, 0},
11665 11666 11667 11668 11669 11670 11671 11672 11673 11674 11675 11676
    {"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 已提交
11677
    {"vcpupin", cmdVcpuPin, opts_vcpupin, info_vcpupin, 0},
11678
    {"version", cmdVersion, opts_version, info_version, 0},
11679 11680
    {"vncdisplay", cmdVNCDisplay, opts_vncdisplay, info_vncdisplay, 0},
    {NULL, NULL, NULL, NULL, 0}
11681 11682 11683
};

static const vshCmdDef domMonitoringCmds[] = {
11684 11685
    {"domblkinfo", cmdDomblkinfo, opts_domblkinfo, info_domblkinfo, 0},
    {"domblkstat", cmdDomblkstat, opts_domblkstat, info_domblkstat, 0},
11686
    {"domcontrol", cmdDomControl, opts_domcontrol, info_domcontrol, 0},
11687 11688 11689 11690 11691 11692
    {"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}
11693 11694 11695
};

static const vshCmdDef storagePoolCmds[] = {
11696
    {"find-storage-pool-sources-as", cmdPoolDiscoverSourcesAs,
11697
     opts_find_storage_pool_sources_as, info_find_storage_pool_sources_as, 0},
11698
    {"find-storage-pool-sources", cmdPoolDiscoverSources,
11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719
     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}
11720 11721 11722
};

static const vshCmdDef storageVolCmds[] = {
11723 11724 11725 11726 11727 11728 11729 11730 11731 11732 11733 11734 11735 11736 11737 11738 11739 11740
    {"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}
11741
};
11742

11743
static const vshCmdDef networkCmds[] = {
11744 11745 11746 11747 11748 11749 11750 11751 11752 11753 11754 11755 11756 11757 11758 11759 11760 11761 11762
    {"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}
11763
};
11764

11765
static const vshCmdDef nodedevCmds[] = {
11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780
    {"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}
11781 11782 11783
};

static const vshCmdDef ifaceCmds[] = {
E
Eric Blake 已提交
11784 11785 11786 11787
    {"iface-begin", cmdInterfaceBegin, opts_interface_begin,
     info_interface_begin, 0},
    {"iface-commit", cmdInterfaceCommit, opts_interface_commit,
     info_interface_commit, 0},
11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 11800 11801
    {"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 已提交
11802 11803
    {"iface-rollback", cmdInterfaceRollback, opts_interface_rollback,
     info_interface_rollback, 0},
11804 11805 11806 11807 11808
    {"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}
11809
};
11810

11811
static const vshCmdDef nwfilterCmds[] = {
11812 11813 11814 11815 11816 11817 11818 11819 11820 11821 11822
    {"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}
11823
};
11824

11825
static const vshCmdDef secretCmds[] = {
11826 11827 11828 11829 11830 11831 11832 11833 11834 11835 11836 11837
    {"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}
11838
};
11839

11840
static const vshCmdDef virshCmds[] = {
11841 11842 11843 11844 11845 11846 11847
    {"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}
11848
};
11849

11850
static const vshCmdDef snapshotCmds[] = {
11851 11852
    {"snapshot-create", cmdSnapshotCreate, opts_snapshot_create,
     info_snapshot_create, 0},
11853 11854
    {"snapshot-create-as", cmdSnapshotCreateAs, opts_snapshot_create_as,
     info_snapshot_create_as, 0},
11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865
    {"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}
11866
};
11867

11868
static const vshCmdDef hostAndHypervisorCmds[] = {
11869 11870 11871 11872 11873
    {"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},
11874
    {"nodecpustats", cmdNodeCpuStats, opts_node_cpustats, info_nodecpustats, 0},
11875
    {"nodeinfo", cmdNodeinfo, NULL, info_nodeinfo, 0},
11876
    {"nodememstats", cmdNodeMemStats, opts_node_memstats, info_nodememstats, 0},
11877 11878 11879 11880 11881
    {"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 已提交
11882 11883
};

11884 11885 11886 11887 11888 11889 11890 11891 11892 11893 11894 11895 11896 11897 11898 11899 11900
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 已提交
11901 11902 11903 11904
/* ---------------
 * Utils for work with command definition
 * ---------------
 */
K
Karel Zak 已提交
11905
static const char *
11906
vshCmddefGetInfo(const vshCmdDef * cmd, const char *name)
11907
{
11908
    const vshCmdInfo *info;
11909

K
Karel Zak 已提交
11910
    for (info = cmd->info; info && info->name; info++) {
11911
        if (STREQ(info->name, name))
K
Karel Zak 已提交
11912 11913 11914 11915 11916
            return info->data;
    }
    return NULL;
}

11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 11933 11934 11935 11936
static int
vshCmddefOptParse(const vshCmdDef *cmd, uint32_t* opts_need_arg,
                  uint32_t *opts_required)
{
    int i;
    bool optional = false;

    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 已提交
11937 11938 11939 11940 11941 11942
        if (opt->flag & VSH_OFLAG_REQ_OPT) {
            if (opt->flag & VSH_OFLAG_REQ)
                *opts_required |= 1 << i;
            continue;
        }

11943 11944 11945 11946 11947 11948 11949 11950 11951 11952 11953 11954
        *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;
}

11955
static const vshCmdOptDef *
11956 11957
vshCmddefGetOption(vshControl *ctl, const vshCmdDef *cmd, const char *name,
                   uint32_t *opts_seen)
11958
{
11959 11960 11961 11962
    int i;

    for (i = 0; cmd->opts && cmd->opts[i].name; i++) {
        const vshCmdOptDef *opt = &cmd->opts[i];
11963

11964 11965 11966 11967 11968
        if (STREQ(opt->name, name)) {
            if (*opts_seen & (1 << i)) {
                vshError(ctl, _("option --%s already seen"), name);
                return NULL;
            }
11969 11970 11971 11972 11973
            if (opt->type == VSH_OT_ARGV) {
                vshError(ctl, _("variable argument <%s> "
                         "should not be used with --<%s>"), name, name);
                return NULL;
            }
11974
            *opts_seen |= 1 << i;
K
Karel Zak 已提交
11975
            return opt;
11976 11977 11978 11979 11980
        }
    }

    vshError(ctl, _("command '%s' doesn't support option --%s"),
             cmd->name, name);
K
Karel Zak 已提交
11981 11982 11983
    return NULL;
}

11984
static const vshCmdOptDef *
11985 11986
vshCmddefGetData(const vshCmdDef *cmd, uint32_t *opts_need_arg,
                 uint32_t *opts_seen)
11987
{
11988
    int i;
11989
    const vshCmdOptDef *opt;
K
Karel Zak 已提交
11990

11991 11992 11993 11994 11995 11996 11997 11998 11999 12000
    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 已提交
12001 12002
}

12003 12004 12005
/*
 * Checks for required options
 */
12006
static int
12007 12008
vshCommandCheckOpts(vshControl *ctl, const vshCmd *cmd, uint32_t opts_required,
                    uint32_t opts_seen)
12009
{
12010
    const vshCmdDef *def = cmd->def;
12011 12012 12013 12014 12015 12016 12017 12018 12019
    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];
12020

12021
            vshError(ctl,
12022
                     opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV ?
12023 12024 12025
                     _("command '%s' requires <%s> option") :
                     _("command '%s' requires --%s option"),
                     def->name, opt->name);
12026 12027
        }
    }
12028
    return -1;
12029 12030
}

12031
static const vshCmdDef *
12032 12033
vshCmddefSearch(const char *cmdname)
{
12034
    const vshCmdGrp *g;
12035
    const vshCmdDef *c;
12036

12037 12038
    for (g = cmdGroups; g->name; g++) {
        for (c = g->commands; c->name; c++) {
12039
            if (STREQ(c->name, cmdname))
12040 12041 12042 12043
                return c;
        }
    }

K
Karel Zak 已提交
12044 12045 12046
    return NULL;
}

12047 12048 12049 12050 12051 12052
static const vshCmdGrp *
vshCmdGrpSearch(const char *grpname)
{
    const vshCmdGrp *g;

    for (g = cmdGroups; g->name; g++) {
12053
        if (STREQ(g->name, grpname) || STREQ(g->keyword, grpname))
12054 12055 12056 12057 12058 12059
            return g;
    }

    return NULL;
}

E
Eric Blake 已提交
12060
static bool
12061 12062 12063 12064 12065 12066 12067
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 已提交
12068
        return false;
12069 12070 12071 12072 12073 12074 12075 12076 12077 12078
    } 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 已提交
12079
    return true;
12080 12081
}

E
Eric Blake 已提交
12082
static bool
12083
vshCmddefHelp(vshControl *ctl, const char *cmdname)
12084
{
12085
    const vshCmdDef *def = vshCmddefSearch(cmdname);
12086

K
Karel Zak 已提交
12087
    if (!def) {
12088
        vshError(ctl, _("command '%s' doesn't exist"), cmdname);
E
Eric Blake 已提交
12089
        return false;
12090
    } else {
E
Eric Blake 已提交
12091 12092
        /* Don't translate desc if it is "".  */
        const char *desc = vshCmddefGetInfo(def, "desc");
E
Eric Blake 已提交
12093
        const char *help = _(vshCmddefGetInfo(def, "help"));
12094
        char buf[256];
12095 12096 12097 12098 12099 12100
        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 已提交
12101
            return false;
12102
        }
K
Karel Zak 已提交
12103

12104
        fputs(_("  NAME\n"), stdout);
12105 12106
        fprintf(stdout, "    %s - %s\n", def->name, help);

12107 12108 12109 12110 12111
        fputs(_("\n  SYNOPSIS\n"), stdout);
        fprintf(stdout, "    %s", def->name);
        if (def->opts) {
            const vshCmdOptDef *opt;
            for (opt = def->opts; opt->name; opt++) {
12112
                const char *fmt = "%s";
12113 12114
                switch (opt->type) {
                case VSH_OT_BOOL:
12115
                    fmt = "[--%s]";
12116 12117
                    break;
                case VSH_OT_INT:
E
Eric Blake 已提交
12118
                    /* xgettext:c-format */
12119 12120
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>"
                           : _("[--%s <number>]"));
12121 12122
                    break;
                case VSH_OT_STRING:
E
Eric Blake 已提交
12123 12124
                    /* xgettext:c-format */
                    fmt = _("[--%s <string>]");
12125 12126
                    break;
                case VSH_OT_DATA:
12127
                    fmt = ((opt->flag & VSH_OFLAG_REQ) ? "<%s>" : "[<%s>]");
12128 12129 12130
                    break;
                case VSH_OT_ARGV:
                    /* xgettext:c-format */
12131 12132
                    fmt = (opt->flag & VSH_OFLAG_REQ) ? _("<%s>...")
                           : _("[<%s>]...");
12133 12134
                    break;
                default:
12135
                    assert(0);
12136
                }
12137
                fputc(' ', stdout);
E
Eric Blake 已提交
12138
                fprintf(stdout, fmt, opt->name);
12139
            }
K
Karel Zak 已提交
12140
        }
12141 12142 12143
        fputc('\n', stdout);

        if (desc[0]) {
12144
            /* Print the description only if it's not empty.  */
12145
            fputs(_("\n  DESCRIPTION\n"), stdout);
E
Eric Blake 已提交
12146
            fprintf(stdout, "    %s\n", _(desc));
K
Karel Zak 已提交
12147
        }
12148

K
Karel Zak 已提交
12149
        if (def->opts) {
12150
            const vshCmdOptDef *opt;
12151
            fputs(_("\n  OPTIONS\n"), stdout);
12152
            for (opt = def->opts; opt->name; opt++) {
12153 12154
                switch (opt->type) {
                case VSH_OT_BOOL:
K
Karel Zak 已提交
12155
                    snprintf(buf, sizeof(buf), "--%s", opt->name);
12156 12157
                    break;
                case VSH_OT_INT:
12158 12159 12160
                    snprintf(buf, sizeof(buf),
                             (opt->flag & VSH_OFLAG_REQ) ? _("[--%s] <number>")
                             : _("--%s <number>"), opt->name);
12161 12162
                    break;
                case VSH_OT_STRING:
12163
                    /* OT_STRING should never be VSH_OFLAG_REQ */
12164
                    snprintf(buf, sizeof(buf), _("--%s <string>"), opt->name);
12165 12166
                    break;
                case VSH_OT_DATA:
12167 12168
                    snprintf(buf, sizeof(buf), _("[--%s] <string>"),
                             opt->name);
12169 12170 12171
                    break;
                case VSH_OT_ARGV:
                    /* Not really an option. */
12172 12173
                    snprintf(buf, sizeof(buf), _("<%s>"), opt->name);
                    break;
12174 12175 12176
                default:
                    assert(0);
                }
12177

E
Eric Blake 已提交
12178
                fprintf(stdout, "    %-15s  %s\n", buf, _(opt->help));
12179
            }
K
Karel Zak 已提交
12180 12181 12182
        }
        fputc('\n', stdout);
    }
E
Eric Blake 已提交
12183
    return true;
K
Karel Zak 已提交
12184 12185 12186 12187 12188 12189
}

/* ---------------
 * Utils for work with runtime commands data
 * ---------------
 */
12190 12191 12192
static void
vshCommandOptFree(vshCmdOpt * arg)
{
K
Karel Zak 已提交
12193 12194
    vshCmdOpt *a = arg;

12195
    while (a) {
K
Karel Zak 已提交
12196
        vshCmdOpt *tmp = a;
12197

K
Karel Zak 已提交
12198 12199
        a = a->next;

12200 12201
        VIR_FREE(tmp->data);
        VIR_FREE(tmp);
K
Karel Zak 已提交
12202 12203 12204 12205
    }
}

static void
12206
vshCommandFree(vshCmd *cmd)
12207
{
K
Karel Zak 已提交
12208 12209
    vshCmd *c = cmd;

12210
    while (c) {
K
Karel Zak 已提交
12211
        vshCmd *tmp = c;
12212

K
Karel Zak 已提交
12213 12214 12215 12216
        c = c->next;

        if (tmp->opts)
            vshCommandOptFree(tmp->opts);
12217
        VIR_FREE(tmp);
K
Karel Zak 已提交
12218 12219 12220 12221 12222 12223 12224
    }
}

/*
 * Returns option by name
 */
static vshCmdOpt *
12225
vshCommandOpt(const vshCmd *cmd, const char *name)
12226
{
K
Karel Zak 已提交
12227
    vshCmdOpt *opt = cmd->opts;
12228 12229

    while (opt) {
12230
        if (opt->def && STREQ(opt->def->name, name))
K
Karel Zak 已提交
12231 12232 12233 12234 12235 12236 12237
            return opt;
        opt = opt->next;
    }
    return NULL;
}

/*
12238 12239 12240 12241 12242 12243 12244 12245 12246
 * @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 已提交
12247 12248
 */
static int
12249
vshCommandOptInt(const vshCmd *cmd, const char *name, int *value)
12250
{
K
Karel Zak 已提交
12251
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
12252
    int ret = 0, num;
12253
    char *end_p = NULL;
12254

12255
    if ((arg != NULL) && (arg->data != NULL)) {
12256 12257 12258 12259 12260 12261
        num = strtol(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
12262
    }
12263
    return ret;
K
Karel Zak 已提交
12264 12265
}

12266 12267 12268 12269 12270 12271 12272 12273 12274 12275 12276 12277 12278 12279 12280 12281 12282 12283 12284 12285 12286 12287 12288 12289

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


12290 12291 12292 12293 12294 12295
/*
 * Convert option to unsigned long
 * See vshCommandOptInt()
 */
static int
vshCommandOptUL(const vshCmd *cmd, const char *name, unsigned long *value)
12296 12297
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
12298 12299
    int ret = 0;
    unsigned long num;
12300 12301 12302
    char *end_p = NULL;

    if ((arg != NULL) && (arg->data != NULL)) {
12303 12304 12305 12306 12307 12308
        num = strtoul(arg->data, &end_p, 10);
        ret = -1;
        if ((arg->data != end_p) && (*end_p == 0)) {
            *value = num;
            ret = 1;
        }
12309
    }
12310
    return ret;
12311 12312
}

K
Karel Zak 已提交
12313 12314
/*
 * Returns option as STRING
12315
 * See vshCommandOptInt()
K
Karel Zak 已提交
12316
 */
12317 12318
static int
vshCommandOptString(const vshCmd *cmd, const char *name, const char **value)
12319
{
K
Karel Zak 已提交
12320
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
12321 12322 12323
    int ret = 0;

    if (arg && arg->data) {
E
Eric Blake 已提交
12324 12325 12326 12327
        if (*arg->data
            || (arg->def && (arg->def->flag & VSH_OFLAG_EMPTY_OK))) {
            *value = arg->data;
            ret = 1;
12328 12329
        } else if (arg->def && ((arg->def->flag) & VSH_OFLAG_REQ)) {
            vshError(NULL, _("Missing required option '%s'"), name);
E
Eric Blake 已提交
12330 12331 12332 12333
            ret = -1;
        } else {
            /* Treat "--option ''" as if option had not been specified. */
            ret = 0;
12334 12335
        }
    }
12336

12337
    return ret;
K
Karel Zak 已提交
12338 12339
}

12340 12341
/*
 * Returns option as long long
12342
 * See vshCommandOptInt()
12343
 */
12344 12345 12346
static int
vshCommandOptLongLong(const vshCmd *cmd, const char *name,
                      long long *value)
12347 12348
{
    vshCmdOpt *arg = vshCommandOpt(cmd, name);
12349 12350
    int ret = 0;
    long long num;
12351 12352
    char *end_p = NULL;

12353 12354 12355 12356 12357 12358 12359 12360 12361
    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;
12362 12363
}

12364 12365 12366 12367 12368 12369 12370 12371 12372 12373 12374 12375 12376 12377 12378 12379 12380 12381 12382 12383 12384
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 已提交
12385
/*
E
Eric Blake 已提交
12386
 * Returns true/false if the option exists
K
Karel Zak 已提交
12387
 */
E
Eric Blake 已提交
12388
static bool
12389
vshCommandOptBool(const vshCmd *cmd, const char *name)
12390
{
E
Eric Blake 已提交
12391
    return vshCommandOpt(cmd, name) != NULL;
K
Karel Zak 已提交
12392 12393
}

12394
/*
12395 12396
 * Returns the next argv argument after OPT (or the first one if OPT
 * is NULL), or NULL if no more are present.
12397
 *
12398
 * Requires that a VSH_OT_ARGV option be last in the
12399 12400
 * list of supported options in CMD->def->opts.
 */
12401 12402
static const vshCmdOpt *
vshCommandOptArgv(const vshCmd *cmd, const vshCmdOpt *opt)
12403
{
12404
    opt = opt ? opt->next : cmd->opts;
12405 12406 12407

    while (opt) {
        if (opt->def && opt->def->type == VSH_OT_ARGV) {
12408
            return opt;
12409 12410 12411 12412 12413 12414
        }
        opt = opt->next;
    }
    return NULL;
}

J
Jim Meyering 已提交
12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 12426 12427 12428 12429 12430 12431 12432
/* 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)
12433
        vshError(ctl, _("internal error: virsh %s: no %s VSH_OT_DATA option"),
J
Jim Meyering 已提交
12434 12435 12436
                 cmd->def->name, optname);
    return found;
}
12437

K
Karel Zak 已提交
12438
static virDomainPtr
J
Jim Meyering 已提交
12439
vshCommandOptDomainBy(vshControl *ctl, const vshCmd *cmd,
12440
                      const char **name, int flag)
12441
{
K
Karel Zak 已提交
12442
    virDomainPtr dom = NULL;
12443
    const char *n = NULL;
K
Karel Zak 已提交
12444
    int id;
J
Jim Meyering 已提交
12445 12446 12447
    const char *optname = "domain";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
12448

12449
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12450 12451
        return NULL;

K
Karel Zak 已提交
12452
    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
12453 12454
             cmd->def->name, optname, n);

K
Karel Zak 已提交
12455 12456
    if (name)
        *name = n;
12457

K
Karel Zak 已提交
12458
    /* try it by ID */
12459
    if (flag & VSH_BYID) {
12460
        if (virStrToLong_i(n, NULL, 10, &id) == 0 && id >= 0) {
K
Karel Zak 已提交
12461 12462 12463 12464
            vshDebug(ctl, 5, "%s: <%s> seems like domain ID\n",
                     cmd->def->name, optname);
            dom = virDomainLookupByID(ctl->conn, id);
        }
12465
    }
K
Karel Zak 已提交
12466
    /* try it by UUID */
12467
    if (dom==NULL && (flag & VSH_BYUUID) && strlen(n)==VIR_UUID_STRING_BUFLEN-1) {
D
Daniel Veillard 已提交
12468
        vshDebug(ctl, 5, "%s: <%s> trying as domain UUID\n",
12469
                 cmd->def->name, optname);
K
Karel Zak 已提交
12470
        dom = virDomainLookupByUUIDString(ctl->conn, n);
K
Karel Zak 已提交
12471
    }
K
Karel Zak 已提交
12472
    /* try it by NAME */
12473
    if (dom==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
12474
        vshDebug(ctl, 5, "%s: <%s> trying as domain NAME\n",
12475
                 cmd->def->name, optname);
K
Karel Zak 已提交
12476
        dom = virDomainLookupByName(ctl->conn, n);
12477
    }
K
Karel Zak 已提交
12478

12479
    if (!dom)
12480
        vshError(ctl, _("failed to get domain '%s'"), n);
12481

K
Karel Zak 已提交
12482 12483 12484
    return dom;
}

12485
static virNetworkPtr
J
Jim Meyering 已提交
12486
vshCommandOptNetworkBy(vshControl *ctl, const vshCmd *cmd,
12487
                       const char **name, int flag)
12488 12489
{
    virNetworkPtr network = NULL;
12490
    const char *n = NULL;
J
Jim Meyering 已提交
12491 12492 12493
    const char *optname = "network";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;
12494

12495
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12496 12497 12498 12499 12500 12501 12502 12503 12504
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
12505
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
D
Daniel Veillard 已提交
12506
        vshDebug(ctl, 5, "%s: <%s> trying as network UUID\n",
12507
                 cmd->def->name, optname);
12508 12509 12510 12511
        network = virNetworkLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
    if (network==NULL && (flag & VSH_BYNAME)) {
D
Daniel Veillard 已提交
12512
        vshDebug(ctl, 5, "%s: <%s> trying as network NAME\n",
12513 12514 12515 12516 12517
                 cmd->def->name, optname);
        network = virNetworkLookupByName(ctl->conn, n);
    }

    if (!network)
12518
        vshError(ctl, _("failed to get network '%s'"), n);
12519 12520 12521 12522

    return network;
}

12523 12524 12525

static virNWFilterPtr
vshCommandOptNWFilterBy(vshControl *ctl, const vshCmd *cmd,
12526
                        const char **name, int flag)
12527 12528
{
    virNWFilterPtr nwfilter = NULL;
12529
    const char *n = NULL;
12530 12531 12532 12533
    const char *optname = "nwfilter";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

12534
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12535 12536 12537 12538 12539 12540 12541 12542 12543 12544 12545 12546 12547 12548 12549 12550 12551 12552 12553 12554 12555 12556 12557 12558 12559 12560 12561
        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;
}

12562 12563
static virInterfacePtr
vshCommandOptInterfaceBy(vshControl *ctl, const vshCmd *cmd,
12564
                         const char **name, int flag)
12565 12566
{
    virInterfacePtr iface = NULL;
12567
    const char *n = NULL;
12568 12569 12570 12571
    const char *optname = "interface";
    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

12572
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12573 12574 12575 12576 12577 12578 12579 12580 12581
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by NAME */
12582
    if ((flag & VSH_BYNAME)) {
12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594
        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)
12595
        vshError(ctl, _("failed to get interface '%s'"), n);
12596 12597 12598 12599

    return iface;
}

12600
static virStoragePoolPtr
12601
vshCommandOptPoolBy(vshControl *ctl, const vshCmd *cmd, const char *optname,
12602
                    const char **name, int flag)
12603 12604
{
    virStoragePoolPtr pool = NULL;
12605
    const char *n = NULL;
12606

12607
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12608 12609 12610 12611 12612 12613 12614 12615 12616
        return NULL;

    vshDebug(ctl, 5, "%s: found option <%s>: %s\n",
             cmd->def->name, optname, n);

    if (name)
        *name = n;

    /* try it by UUID */
12617
    if ((flag & VSH_BYUUID) && (strlen(n) == VIR_UUID_STRING_BUFLEN-1)) {
12618
        vshDebug(ctl, 5, "%s: <%s> trying as pool UUID\n",
12619
                 cmd->def->name, optname);
12620 12621 12622
        pool = virStoragePoolLookupByUUIDString(ctl->conn, n);
    }
    /* try it by NAME */
12623
    if (pool == NULL && (flag & VSH_BYNAME)) {
12624 12625 12626 12627 12628 12629
        vshDebug(ctl, 5, "%s: <%s> trying as pool NAME\n",
                 cmd->def->name, optname);
        pool = virStoragePoolLookupByName(ctl->conn, n);
    }

    if (!pool)
12630
        vshError(ctl, _("failed to get pool '%s'"), n);
12631 12632 12633 12634 12635

    return pool;
}

static virStorageVolPtr
12636
vshCommandOptVolBy(vshControl *ctl, const vshCmd *cmd,
12637 12638
                   const char *optname,
                   const char *pooloptname,
12639
                   const char **name, int flag)
12640 12641 12642
{
    virStorageVolPtr vol = NULL;
    virStoragePoolPtr pool = NULL;
12643
    const char *n = NULL, *p = NULL;
12644

12645
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12646 12647
        return NULL;

12648 12649
    if (vshCommandOptString(cmd, pooloptname, &p) < 0) {
        vshError(ctl, "%s", _("missing option"));
12650
        return NULL;
12651
    }
12652 12653 12654 12655 12656 12657 12658 12659 12660 12661

    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;

12662
    /* try it by name */
12663
    if (pool && (flag & VSH_BYNAME)) {
12664
        vshDebug(ctl, 5, "%s: <%s> trying as vol name\n",
12665 12666 12667
                 cmd->def->name, optname);
        vol = virStorageVolLookupByName(pool, n);
    }
12668
    /* try it by key */
12669 12670 12671 12672 12673
    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);
    }
12674
    /* try it by path */
12675 12676 12677 12678 12679 12680 12681
    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)
12682
        vshError(ctl, _("failed to get vol '%s'"), n);
12683 12684 12685 12686 12687 12688 12689

    if (pool)
        virStoragePoolFree(pool);

    return vol;
}

12690
static virSecretPtr
12691
vshCommandOptSecret(vshControl *ctl, const vshCmd *cmd, const char **name)
12692 12693
{
    virSecretPtr secret = NULL;
12694
    const char *n = NULL;
12695 12696 12697 12698 12699
    const char *optname = "secret";

    if (!cmd_has_option (ctl, cmd, optname))
        return NULL;

12700
    if (vshCommandOptString(cmd, optname, &n) <= 0)
12701 12702 12703 12704 12705 12706 12707 12708 12709 12710
        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)
12711
        vshError(ctl, _("failed to get secret '%s'"), n);
12712 12713 12714 12715

    return secret;
}

K
Karel Zak 已提交
12716 12717 12718
/*
 * Executes command(s) and returns return code from last command
 */
E
Eric Blake 已提交
12719
static bool
12720
vshCommandRun(vshControl *ctl, const vshCmd *cmd)
12721
{
E
Eric Blake 已提交
12722
    bool ret = true;
12723 12724

    while (cmd) {
K
Karel Zak 已提交
12725
        struct timeval before, after;
12726
        bool enable_timing = ctl->timing;
12727

12728 12729
        if ((ctl->conn == NULL || disconnected) &&
            !(cmd->def->flags & VSH_CMD_FLAG_NOCONNECT))
12730 12731
            vshReconnect(ctl);

12732
        if (enable_timing)
K
Karel Zak 已提交
12733
            GETTIMEOFDAY(&before);
12734

K
Karel Zak 已提交
12735 12736
        ret = cmd->def->handler(ctl, cmd);

12737
        if (enable_timing)
K
Karel Zak 已提交
12738
            GETTIMEOFDAY(&after);
12739

12740
        if (!ret)
J
John Levon 已提交
12741 12742
            virshReportError(ctl);

12743
        /* try to automatically catch disconnections */
12744
        if (!ret &&
12745 12746 12747 12748 12749 12750 12751 12752 12753
            ((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);

12754
        if (STREQ(cmd->def->name, "quit"))        /* hack ... */
K
Karel Zak 已提交
12755 12756
            return ret;

12757
        if (enable_timing)
12758
            vshPrint(ctl, _("\n(Time: %.3f ms)\n\n"),
12759 12760
                     DIFF_MSEC(&after, &before));
        else
K
Karel Zak 已提交
12761
            vshPrintExtra(ctl, "\n");
K
Karel Zak 已提交
12762 12763 12764 12765 12766 12767
        cmd = cmd->next;
    }
    return ret;
}

/* ---------------
12768
 * Command parsing
K
Karel Zak 已提交
12769 12770 12771
 * ---------------
 */

12772 12773 12774 12775 12776 12777 12778 12779 12780 12781
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 已提交
12782
    /* vshCommandStringGetArg() */
12783
    char *pos;
L
Lai Jiangshan 已提交
12784 12785 12786
    /* vshCommandArgvGetArg() */
    char **arg_pos;
    char **arg_end;
12787 12788
} vshCommandParser;

E
Eric Blake 已提交
12789
static bool
12790
vshCommandParse(vshControl *ctl, vshCommandParser *parser)
12791
{
K
Karel Zak 已提交
12792 12793 12794
    char *tkdata = NULL;
    vshCmd *clast = NULL;
    vshCmdOpt *first = NULL;
12795

K
Karel Zak 已提交
12796 12797 12798 12799
    if (ctl->cmd) {
        vshCommandFree(ctl->cmd);
        ctl->cmd = NULL;
    }
12800

12801
    while (1) {
K
Karel Zak 已提交
12802
        vshCmdOpt *last = NULL;
12803
        const vshCmdDef *cmd = NULL;
12804
        vshCommandToken tk;
L
Lai Jiangshan 已提交
12805
        bool data_only = false;
12806 12807 12808
        uint32_t opts_need_arg = 0;
        uint32_t opts_required = 0;
        uint32_t opts_seen = 0;
12809

K
Karel Zak 已提交
12810
        first = NULL;
12811

12812
        while (1) {
12813
            const vshCmdOptDef *opt = NULL;
12814

K
Karel Zak 已提交
12815
            tkdata = NULL;
12816
            tk = parser->getNextArg(ctl, parser, &tkdata);
12817 12818

            if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
12819
                goto syntaxError;
H
Hu Tao 已提交
12820 12821
            if (tk != VSH_TK_ARG) {
                VIR_FREE(tkdata);
12822
                break;
H
Hu Tao 已提交
12823
            }
12824 12825

            if (cmd == NULL) {
K
Karel Zak 已提交
12826 12827
                /* first token must be command name */
                if (!(cmd = vshCmddefSearch(tkdata))) {
12828
                    vshError(ctl, _("unknown command: '%s'"), tkdata);
12829
                    goto syntaxError;   /* ... or ignore this command only? */
K
Karel Zak 已提交
12830
                }
12831 12832 12833 12834 12835 12836 12837
                if (vshCmddefOptParse(cmd, &opts_need_arg,
                                      &opts_required) < 0) {
                    vshError(ctl,
                             _("internal error: bad options in command: '%s'"),
                             tkdata);
                    goto syntaxError;
                }
12838
                VIR_FREE(tkdata);
L
Lai Jiangshan 已提交
12839 12840 12841 12842
            } else if (data_only) {
                goto get_data;
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       c_isalnum(tkdata[2])) {
12843 12844 12845 12846 12847
                char *optstr = strchr(tkdata + 2, '=');
                if (optstr) {
                    *optstr = '\0'; /* convert the '=' to '\0' */
                    optstr = vshStrdup(ctl, optstr + 1);
                }
12848 12849
                if (!(opt = vshCmddefGetOption(ctl, cmd, tkdata + 2,
                                               &opts_seen))) {
12850
                    VIR_FREE(optstr);
K
Karel Zak 已提交
12851 12852
                    goto syntaxError;
                }
12853
                VIR_FREE(tkdata);
K
Karel Zak 已提交
12854 12855 12856

                if (opt->type != VSH_OT_BOOL) {
                    /* option data */
12857 12858 12859
                    if (optstr)
                        tkdata = optstr;
                    else
12860
                        tk = parser->getNextArg(ctl, parser, &tkdata);
12861
                    if (tk == VSH_TK_ERROR)
K
Karel Zak 已提交
12862
                        goto syntaxError;
12863
                    if (tk != VSH_TK_ARG) {
12864
                        vshError(ctl,
12865
                                 _("expected syntax: --%s <%s>"),
12866 12867
                                 opt->name,
                                 opt->type ==
12868
                                 VSH_OT_INT ? _("number") : _("string"));
K
Karel Zak 已提交
12869 12870
                        goto syntaxError;
                    }
12871
                    opts_need_arg &= ~opts_seen;
12872 12873 12874 12875 12876 12877 12878 12879
                } else {
                    tkdata = NULL;
                    if (optstr) {
                        vshError(ctl, _("invalid '=' after option --%s"),
                                opt->name);
                        VIR_FREE(optstr);
                        goto syntaxError;
                    }
K
Karel Zak 已提交
12880
                }
L
Lai Jiangshan 已提交
12881 12882 12883 12884
            } else if (tkdata[0] == '-' && tkdata[1] == '-' &&
                       tkdata[2] == '\0') {
                data_only = true;
                continue;
12885
            } else {
L
Lai Jiangshan 已提交
12886
get_data:
12887 12888
                if (!(opt = vshCmddefGetData(cmd, &opts_need_arg,
                                             &opts_seen))) {
12889
                    vshError(ctl, _("unexpected data '%s'"), tkdata);
K
Karel Zak 已提交
12890 12891 12892 12893 12894
                    goto syntaxError;
                }
            }
            if (opt) {
                /* save option */
12895
                vshCmdOpt *arg = vshMalloc(ctl, sizeof(vshCmdOpt));
12896

K
Karel Zak 已提交
12897 12898 12899 12900
                arg->def = opt;
                arg->data = tkdata;
                arg->next = NULL;
                tkdata = NULL;
12901

K
Karel Zak 已提交
12902 12903 12904 12905 12906
                if (!first)
                    first = arg;
                if (last)
                    last->next = arg;
                last = arg;
12907

K
Karel Zak 已提交
12908
                vshDebug(ctl, 4, "%s: %s(%s): %s\n",
12909 12910
                         cmd->name,
                         opt->name,
12911 12912
                         opt->type != VSH_OT_BOOL ? _("optdata") : _("bool"),
                         opt->type != VSH_OT_BOOL ? arg->data : _("(none)"));
K
Karel Zak 已提交
12913 12914
            }
        }
12915

D
Daniel Veillard 已提交
12916
        /* command parsed -- allocate new struct for the command */
K
Karel Zak 已提交
12917
        if (cmd) {
12918
            vshCmd *c = vshMalloc(ctl, sizeof(vshCmd));
12919

K
Karel Zak 已提交
12920 12921 12922 12923
            c->opts = first;
            c->def = cmd;
            c->next = NULL;

12924
            if (vshCommandCheckOpts(ctl, c, opts_required, opts_seen) < 0) {
12925
                VIR_FREE(c);
12926
                goto syntaxError;
12927
            }
12928

K
Karel Zak 已提交
12929 12930 12931 12932 12933 12934
            if (!ctl->cmd)
                ctl->cmd = c;
            if (clast)
                clast->next = c;
            clast = c;
        }
12935 12936 12937

        if (tk == VSH_TK_END)
            break;
K
Karel Zak 已提交
12938
    }
12939

E
Eric Blake 已提交
12940
    return true;
K
Karel Zak 已提交
12941

12942
 syntaxError:
12943
    if (ctl->cmd) {
K
Karel Zak 已提交
12944
        vshCommandFree(ctl->cmd);
12945 12946
        ctl->cmd = NULL;
    }
K
Karel Zak 已提交
12947 12948
    if (first)
        vshCommandOptFree(first);
12949
    VIR_FREE(tkdata);
E
Eric Blake 已提交
12950
    return false;
K
Karel Zak 已提交
12951 12952
}

12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970
/* --------------------
 * 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 已提交
12971 12972
static bool
vshCommandArgvParse(vshControl *ctl, int nargs, char **argv)
12973 12974 12975 12976
{
    vshCommandParser parser;

    if (nargs <= 0)
E
Eric Blake 已提交
12977
        return false;
12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 13007 13008 13009 13010 13011 13012 13013 13014 13015 13016 13017 13018 13019 13020 13021 13022 13023 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

    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 已提交
13050 13051
static bool
vshCommandStringParse(vshControl *ctl, char *cmdstr)
13052 13053 13054 13055
{
    vshCommandParser parser;

    if (cmdstr == NULL || *cmdstr == '\0')
E
Eric Blake 已提交
13056
        return false;
13057 13058 13059 13060 13061 13062

    parser.pos = cmdstr;
    parser.getNextArg = vshCommandStringGetArg;
    return vshCommandParse(ctl, &parser);
}

K
Karel Zak 已提交
13063
/* ---------------
13064
 * Misc utils
K
Karel Zak 已提交
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
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 已提交
13095
static const char *
13096 13097
vshDomainStateToString(int state)
{
13098
    switch ((virDomainState) state) {
13099
    case VIR_DOMAIN_RUNNING:
13100
        return N_("running");
13101
    case VIR_DOMAIN_BLOCKED:
13102
        return N_("idle");
13103
    case VIR_DOMAIN_PAUSED:
13104
        return N_("paused");
13105
    case VIR_DOMAIN_SHUTDOWN:
13106
        return N_("in shutdown");
13107
    case VIR_DOMAIN_SHUTOFF:
13108
        return N_("shut off");
13109
    case VIR_DOMAIN_CRASHED:
13110
        return N_("crashed");
13111
    case VIR_DOMAIN_NOSTATE:
13112
        ;/*FALLTHROUGH*/
K
Karel Zak 已提交
13113
    }
13114
    return N_("no state");  /* = dom0 state */
K
Karel Zak 已提交
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 13141 13142 13143 13144 13145 13146 13147 13148 13149 13150 13151 13152 13153 13154 13155 13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 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
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");
}

13218 13219 13220 13221 13222 13223 13224 13225 13226 13227 13228 13229 13230 13231 13232 13233 13234
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");
}

13235 13236 13237 13238
static const char *
vshDomainVcpuStateToString(int state)
{
    switch (state) {
13239
    case VIR_VCPU_OFFLINE:
13240
        return N_("offline");
13241
    case VIR_VCPU_BLOCKED:
13242
        return N_("idle");
13243
    case VIR_VCPU_RUNNING:
13244
        return N_("running");
13245
    default:
13246
        ;/*FALLTHROUGH*/
13247
    }
13248
    return N_("no state");
13249 13250
}

E
Eric Blake 已提交
13251
static bool
13252
vshConnectionUsability(vshControl *ctl, virConnectPtr conn)
13253
{
13254 13255
    /* TODO: use something like virConnectionState() to
     *       check usability of the connection
K
Karel Zak 已提交
13256 13257
     */
    if (!conn) {
13258
        vshError(ctl, "%s", _("no valid connection"));
E
Eric Blake 已提交
13259
        return false;
K
Karel Zak 已提交
13260
    }
E
Eric Blake 已提交
13261
    return true;
K
Karel Zak 已提交
13262 13263
}

K
Karel Zak 已提交
13264
static void
13265
vshDebug(vshControl *ctl, int level, const char *format, ...)
13266
{
K
Karel Zak 已提交
13267
    va_list ap;
13268
    char *str;
K
Karel Zak 已提交
13269

13270 13271 13272 13273
    va_start(ap, format);
    vshOutputLogFile(ctl, VSH_ERR_DEBUG, format, ap);
    va_end(ap);

K
Karel Zak 已提交
13274 13275 13276 13277
    if (level > ctl->debug)
        return;

    va_start(ap, format);
13278 13279 13280 13281 13282
    if (virVasprintf(&str, format, ap) < 0) {
        /* Skip debug messages on low memory */
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
13283
    va_end(ap);
13284 13285
    fputs(str, stdout);
    VIR_FREE(str);
K
Karel Zak 已提交
13286 13287 13288
}

static void
13289
vshPrintExtra(vshControl *ctl, const char *format, ...)
13290
{
K
Karel Zak 已提交
13291
    va_list ap;
13292
    char *str;
13293

13294
    if (ctl && ctl->quiet)
K
Karel Zak 已提交
13295
        return;
13296

K
Karel Zak 已提交
13297
    va_start(ap, format);
13298 13299 13300 13301 13302
    if (virVasprintf(&str, format, ap) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
        va_end(ap);
        return;
    }
K
Karel Zak 已提交
13303
    va_end(ap);
13304
    fputs(str, stdout);
13305
    VIR_FREE(str);
K
Karel Zak 已提交
13306 13307
}

K
Karel Zak 已提交
13308

K
Karel Zak 已提交
13309
static void
13310
vshError(vshControl *ctl, const char *format, ...)
13311
{
K
Karel Zak 已提交
13312
    va_list ap;
13313
    char *str;
13314

13315 13316 13317 13318 13319
    if (ctl != NULL) {
        va_start(ap, format);
        vshOutputLogFile(ctl, VSH_ERR_ERROR, format, ap);
        va_end(ap);
    }
13320

13321
    fputs(_("error: "), stderr);
13322

K
Karel Zak 已提交
13323
    va_start(ap, format);
13324 13325 13326
    /* We can't recursively call vshError on an OOM situation, so ignore
       failure here. */
    ignore_value(virVasprintf(&str, format, ap));
K
Karel Zak 已提交
13327 13328
    va_end(ap);

13329 13330
    fprintf(stderr, "%s\n", NULLSTR(str));
    VIR_FREE(str);
K
Karel Zak 已提交
13331 13332
}

13333

K
Karel Zak 已提交
13334
/*
13335
 * Initialize connection.
K
Karel Zak 已提交
13336
 */
E
Eric Blake 已提交
13337
static bool
13338
vshInit(vshControl *ctl)
13339
{
13340 13341
    char *debugEnv;

K
Karel Zak 已提交
13342
    if (ctl->conn)
E
Eric Blake 已提交
13343
        return false;
K
Karel Zak 已提交
13344

13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363 13364 13365
    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);
        }
    }

13366 13367
    vshOpenLogFile(ctl);

13368 13369
    /* set up the library error handler */
    virSetErrorFunc(NULL, virshErrorHandler);
13370

13371 13372 13373
    /* set up the signals handlers to catch disconnections */
    vshSetupSignals();

13374
    if (virEventRegisterDefaultImpl() < 0)
E
Eric Blake 已提交
13375
        return false;
13376

13377 13378 13379 13380
    if (ctl->name) {
        ctl->conn = virConnectOpenAuth(ctl->name,
                                       virConnectAuthPtrDefault,
                                       ctl->readonly ? VIR_CONNECT_RO : 0);
13381

13382 13383 13384 13385 13386 13387 13388 13389 13390 13391 13392
        /* 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;
        }
13393
    }
K
Karel Zak 已提交
13394

E
Eric Blake 已提交
13395
    return true;
K
Karel Zak 已提交
13396 13397
}

13398 13399
#define LOGFILE_FLAGS (O_WRONLY | O_APPEND | O_CREAT | O_SYNC)

13400 13401 13402 13403 13404 13405 13406 13407 13408 13409 13410 13411 13412 13413 13414 13415 13416 13417 13418
/**
 * 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:
13419
                vshError(ctl, "%s",
J
Jim Meyering 已提交
13420
                         _("failed to get the log file information"));
13421
                exit(EXIT_FAILURE);
13422 13423 13424
        }
    } else {
        if (!S_ISREG(st.st_mode)) {
13425 13426
            vshError(ctl, "%s", _("the log path is not a file"));
            exit(EXIT_FAILURE);
13427 13428 13429 13430
        }
    }

    /* log file open */
13431
    if ((ctl->log_fd = open(ctl->logfile, LOGFILE_FLAGS, FILE_MODE)) < 0) {
13432
        vshError(ctl, "%s",
J
Jim Meyering 已提交
13433
                 _("failed to open the log file. check the log file path"));
13434
        exit(EXIT_FAILURE);
13435 13436 13437 13438 13439 13440 13441 13442 13443
    }
}

/**
 * vshOutputLogFile:
 *
 * Outputting an error to log file.
 */
static void
13444 13445
vshOutputLogFile(vshControl *ctl, int log_level, const char *msg_format,
                 va_list ap)
13446
{
13447 13448 13449
    virBuffer buf = VIR_BUFFER_INITIALIZER;
    char *str;
    size_t len;
13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463
    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);
13464
    virBufferAsprintf(&buf, "[%d.%02d.%02d %02d:%02d:%02d %s %d] ",
13465 13466 13467 13468 13469 13470
                      (1900 + stTm->tm_year),
                      (1 + stTm->tm_mon),
                      stTm->tm_mday,
                      stTm->tm_hour,
                      stTm->tm_min,
                      stTm->tm_sec,
13471 13472
                      SIGN_NAME,
                      (int) getpid());
13473 13474 13475 13476 13477 13478 13479 13480 13481 13482 13483 13484 13485 13486 13487 13488 13489 13490 13491 13492
    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;
    }
13493 13494 13495
    virBufferAsprintf(&buf, "%s ", lvl);
    virBufferVasprintf(&buf, msg_format, ap);
    virBufferAddChar(&buf, '\n');
13496

13497 13498
    if (virBufferError(&buf))
        goto error;
13499

13500 13501 13502 13503 13504
    str = virBufferContentAndReset(&buf);
    len = strlen(str);
    if (len > 1 && str[len - 2] == '\n') {
        str[len - 1] = '\0';
        len--;
13505
    }
13506

13507 13508 13509 13510 13511 13512 13513 13514 13515 13516 13517
    /* 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);
13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528
}

/**
 * vshCloseLogFile:
 *
 * Close log file.
 */
static void
vshCloseLogFile(vshControl *ctl)
{
    /* log file close */
13529 13530 13531
    if (VIR_CLOSE(ctl->log_fd) < 0) {
        vshError(ctl, _("%s: failed to write log file: %s"),
                 ctl->logfile ? ctl->logfile : "?", strerror (errno));
13532 13533 13534
    }

    if (ctl->logfile) {
13535
        VIR_FREE(ctl->logfile);
13536 13537 13538 13539
        ctl->logfile = NULL;
    }
}

13540
#ifdef USE_READLINE
13541

K
Karel Zak 已提交
13542 13543 13544 13545 13546
/* -----------------
 * Readline stuff
 * -----------------
 */

13547
/*
K
Karel Zak 已提交
13548 13549
 * Generator function for command completion.  STATE lets us
 * know whether to start from scratch; without any state
13550
 * (i.e. STATE == 0), then we start at the top of the list.
K
Karel Zak 已提交
13551 13552
 */
static char *
13553 13554
vshReadlineCommandGenerator(const char *text, int state)
{
13555
    static int grp_list_index, cmd_list_index, len;
K
Karel Zak 已提交
13556
    const char *name;
13557 13558
    const vshCmdGrp *grp;
    const vshCmdDef *cmds;
K
Karel Zak 已提交
13559 13560

    if (!state) {
13561 13562
        grp_list_index = 0;
        cmd_list_index = 0;
13563
        len = strlen(text);
K
Karel Zak 已提交
13564 13565
    }

13566 13567
    grp = cmdGroups;

K
Karel Zak 已提交
13568
    /* Return the next name which partially matches from the
13569
     * command list.
K
Karel Zak 已提交
13570
     */
13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584
    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 已提交
13585 13586 13587 13588 13589 13590 13591
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char *
13592 13593
vshReadlineOptionsGenerator(const char *text, int state)
{
K
Karel Zak 已提交
13594
    static int list_index, len;
13595
    static const vshCmdDef *cmd = NULL;
K
Karel Zak 已提交
13596
    const char *name;
K
Karel Zak 已提交
13597 13598 13599 13600 13601 13602 13603 13604 13605

    if (!state) {
        /* determine command name */
        char *p;
        char *cmdname;

        if (!(p = strchr(rl_line_buffer, ' ')))
            return NULL;

13606
        cmdname = vshCalloc(NULL, (p - rl_line_buffer) + 1, 1);
13607
        memcpy(cmdname, rl_line_buffer, p - rl_line_buffer);
K
Karel Zak 已提交
13608 13609 13610

        cmd = vshCmddefSearch(cmdname);
        list_index = 0;
13611
        len = strlen(text);
13612
        VIR_FREE(cmdname);
K
Karel Zak 已提交
13613 13614 13615 13616
    }

    if (!cmd)
        return NULL;
13617

13618 13619 13620
    if (!cmd->opts)
        return NULL;

K
Karel Zak 已提交
13621
    while ((name = cmd->opts[list_index].name)) {
13622
        const vshCmdOptDef *opt = &cmd->opts[list_index];
K
Karel Zak 已提交
13623
        char *res;
13624

K
Karel Zak 已提交
13625
        list_index++;
13626

13627
        if (opt->type == VSH_OT_DATA || opt->type == VSH_OT_ARGV)
K
Karel Zak 已提交
13628 13629
            /* ignore non --option */
            continue;
13630

K
Karel Zak 已提交
13631
        if (len > 2) {
13632
            if (STRNEQLEN(name, text + 2, len - 2))
K
Karel Zak 已提交
13633 13634
                continue;
        }
13635
        res = vshMalloc(NULL, strlen(name) + 3);
13636
        snprintf(res, strlen(name) + 3,  "--%s", name);
K
Karel Zak 已提交
13637 13638 13639 13640 13641 13642 13643 13644
        return res;
    }

    /* If no names matched, then return NULL. */
    return NULL;
}

static char **
13645 13646 13647
vshReadlineCompletion(const char *text, int start,
                      int end ATTRIBUTE_UNUSED)
{
K
Karel Zak 已提交
13648 13649
    char **matches = (char **) NULL;

13650
    if (start == 0)
K
Karel Zak 已提交
13651
        /* command name generator */
13652
        matches = rl_completion_matches(text, vshReadlineCommandGenerator);
K
Karel Zak 已提交
13653 13654
    else
        /* commands options */
13655
        matches = rl_completion_matches(text, vshReadlineOptionsGenerator);
K
Karel Zak 已提交
13656 13657 13658 13659
    return matches;
}


13660 13661
static int
vshReadlineInit(vshControl *ctl)
13662
{
13663 13664
    char *userdir = NULL;

K
Karel Zak 已提交
13665 13666 13667 13668 13669
    /* 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;
13670 13671 13672

    /* Limit the total size of the history buffer */
    stifle_history(500);
13673 13674

    /* Prepare to read/write history from/to the ~/.virsh/history file */
13675
    userdir = virGetUserDirectory(getuid());
13676

13677 13678
    if (userdir == NULL) {
        vshError(ctl, "%s", _("Could not determine home directory"));
13679
        return -1;
13680
    }
13681 13682 13683

    if (virAsprintf(&ctl->historydir, "%s/.virsh", userdir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
13684
        VIR_FREE(userdir);
13685 13686 13687 13688 13689
        return -1;
    }

    if (virAsprintf(&ctl->historyfile, "%s/history", ctl->historydir) < 0) {
        vshError(ctl, "%s", _("Out of memory"));
13690
        VIR_FREE(userdir);
13691 13692 13693
        return -1;
    }

13694
    VIR_FREE(userdir);
13695 13696 13697 13698 13699 13700 13701 13702 13703 13704 13705 13706 13707 13708 13709 13710 13711 13712

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

13713 13714
    VIR_FREE(ctl->historydir);
    VIR_FREE(ctl->historyfile);
K
Karel Zak 已提交
13715 13716
}

13717 13718 13719 13720 13721 13722
static char *
vshReadline (vshControl *ctl ATTRIBUTE_UNUSED, const char *prompt)
{
    return readline (prompt);
}

13723
#else /* !USE_READLINE */
13724

13725 13726 13727 13728 13729 13730 13731
static int
vshReadlineInit (vshControl *ctl ATTRIBUTE_UNUSED)
{
    /* empty */
    return 0;
}

13732
static void
13733
vshReadlineDeinit (vshControl *ctl ATTRIBUTE_UNUSED)
13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756
{
    /* 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);
}

13757
#endif /* !USE_READLINE */
13758

K
Karel Zak 已提交
13759
/*
J
Jim Meyering 已提交
13760
 * Deinitialize virsh
K
Karel Zak 已提交
13761
 */
E
Eric Blake 已提交
13762
static bool
13763
vshDeinit(vshControl *ctl)
13764
{
13765
    vshReadlineDeinit(ctl);
13766
    vshCloseLogFile(ctl);
13767
    VIR_FREE(ctl->name);
K
Karel Zak 已提交
13768
    if (ctl->conn) {
13769 13770 13771
        int ret;
        if ((ret = virConnectClose(ctl->conn)) != 0) {
            vshError(ctl, _("Failed to disconnect from the hypervisor, %d leaked reference(s)"), ret);
K
Karel Zak 已提交
13772 13773
        }
    }
D
Daniel P. Berrange 已提交
13774 13775
    virResetLastError();

E
Eric Blake 已提交
13776
    return true;
K
Karel Zak 已提交
13777
}
13778

K
Karel Zak 已提交
13779 13780 13781 13782
/*
 * Print usage
 */
static void
13783
vshUsage(void)
13784
{
13785
    const vshCmdGrp *grp;
13786
    const vshCmdDef *cmd;
13787

L
Lai Jiangshan 已提交
13788 13789
    fprintf(stdout, _("\n%s [options]... [<command_string>]"
                      "\n%s [options]... <command> [args...]\n\n"
13790 13791 13792
                      "  options:\n"
                      "    -c | --connect <uri>    hypervisor connection URI\n"
                      "    -r | --readonly         connect readonly\n"
13793
                      "    -d | --debug <num>      debug level [0-4]\n"
13794 13795 13796 13797
                      "    -h | --help             this help\n"
                      "    -q | --quiet            quiet mode\n"
                      "    -t | --timing           print timing information\n"
                      "    -l | --log <file>       output logging to file\n"
13798
                      "    -v | --version[=short]  program version\n"
E
Eric Blake 已提交
13799
                      "    -V | --version=long     version and full options\n\n"
13800
                      "  commands (non interactive mode):\n\n"), progname, progname);
13801

13802 13803
    for (grp = cmdGroups; grp->name; grp++) {
        fprintf(stdout, _(" %s (help keyword '%s')\n"), grp->name, grp->keyword);
13804

13805 13806 13807 13808 13809 13810 13811 13812 13813
        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"));
13814 13815 13816
    fprintf(stdout, "%s",
            _("\n  (specify help <command> for details about the command)\n\n"));
    return;
K
Karel Zak 已提交
13817 13818
}

13819 13820 13821 13822 13823 13824 13825 13826 13827 13828
/*
 * 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 已提交
13829 13830
    vshPrint(ctl, "%s", _("Compiled with support for:\n"));
    vshPrint(ctl, "%s", _(" Hypervisors:"));
13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850 13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865
#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 已提交
13866
    vshPrint(ctl, "%s", _(" Networking:"));
13867 13868 13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 13890 13891 13892
#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 已提交
13893
    vshPrint(ctl, "%s", _(" Storage:"));
13894 13895 13896 13897 13898 13899 13900 13901 13902 13903 13904 13905 13906 13907 13908 13909 13910 13911 13912 13913 13914 13915 13916
#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 已提交
13917
    vshPrint(ctl, "%s", _(" Miscellaneous:"));
13918
#ifdef WITH_SECDRIVER_APPARMOR
13919 13920 13921 13922 13923 13924 13925 13926 13927 13928 13929 13930 13931 13932 13933 13934 13935 13936 13937 13938 13939 13940 13941
    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 已提交
13942 13943 13944 13945
/*
 * argv[]:  virsh [options] [command]
 *
 */
E
Eric Blake 已提交
13946
static bool
13947
vshParseArgv(vshControl *ctl, int argc, char **argv)
13948
{
13949 13950
    bool help = false;
    int arg;
K
Karel Zak 已提交
13951
    struct option opt[] = {
E
Eric Blake 已提交
13952 13953 13954 13955 13956 13957 13958 13959 13960
        {"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}
13961 13962
    };

13963 13964 13965
    /* 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. */
13966
    while ((arg = getopt_long(argc, argv, "+d:hqtc:vVrl:", opt, NULL)) != -1) {
13967
        switch (arg) {
13968
        case 'd':
D
Daniel Veillard 已提交
13969
            if (virStrToLong_i(optarg, NULL, 10, &ctl->debug) < 0) {
L
Laine Stump 已提交
13970
                vshError(ctl, "%s", _("option -d takes a numeric argument"));
D
Daniel Veillard 已提交
13971 13972
                exit(EXIT_FAILURE);
            }
13973 13974
            break;
        case 'h':
13975
            help = true;
13976 13977
            break;
        case 'q':
E
Eric Blake 已提交
13978
            ctl->quiet = true;
13979 13980
            break;
        case 't':
E
Eric Blake 已提交
13981
            ctl->timing = true;
13982 13983 13984 13985
            break;
        case 'c':
            ctl->name = vshStrdup(ctl, optarg);
            break;
E
Eric Blake 已提交
13986 13987 13988 13989 13990 13991
        case 'v':
            if (STRNEQ_NULLABLE(optarg, "long")) {
                puts(VERSION);
                exit(EXIT_SUCCESS);
            }
            /* fall through */
13992 13993 13994
        case 'V':
            vshShowVersion(ctl);
            exit(EXIT_SUCCESS);
13995
        case 'r':
E
Eric Blake 已提交
13996
            ctl->readonly = true;
13997
            break;
13998 13999 14000
        case 'l':
            ctl->logfile = vshStrdup(ctl, optarg);
            break;
14001
        default:
14002 14003
            vshError(ctl, _("unsupported option '-%c'. See --help."), arg);
            exit(EXIT_FAILURE);
K
Karel Zak 已提交
14004 14005 14006 14007
        }
    }

    if (help) {
14008 14009
        if (optind < argc) {
            vshError(ctl, _("extra argument '%s'. See --help."), argv[optind]);
14010 14011
            exit(EXIT_FAILURE);
        }
14012 14013 14014

        /* list all command */
        vshUsage();
K
Karel Zak 已提交
14015
        exit(EXIT_SUCCESS);
14016 14017
    }

14018
    if (argc > optind) {
K
Karel Zak 已提交
14019
        /* parse command */
E
Eric Blake 已提交
14020
        ctl->imode = false;
14021 14022 14023
        if (argc - optind == 1) {
            vshDebug(ctl, 2, "commands: \"%s\"\n", argv[optind]);
            return vshCommandStringParse(ctl, argv[optind]);
L
Lai Jiangshan 已提交
14024
        } else {
14025
            return vshCommandArgvParse(ctl, argc - optind, argv + optind);
K
Karel Zak 已提交
14026 14027
        }
    }
E
Eric Blake 已提交
14028
    return true;
K
Karel Zak 已提交
14029 14030
}

14031 14032 14033 14034
int
main(int argc, char **argv)
{
    vshControl _ctl, *ctl = &_ctl;
14035
    char *defaultConn;
E
Eric Blake 已提交
14036
    bool ret = true;
K
Karel Zak 已提交
14037

14038 14039 14040
    memset(ctl, 0, sizeof(vshControl));
    ctl->imode = true;          /* default is interactive mode */
    ctl->log_fd = -1;           /* Initialize log file descriptor */
14041
    ctl->debug = -1;            /* Initialize log level */
14042

14043 14044
    if (!setlocale(LC_ALL, "")) {
        perror("setlocale");
14045
        /* failure to setup locale is not fatal */
14046
    }
14047
    if (!bindtextdomain(PACKAGE, LOCALEDIR)) {
14048
        perror("bindtextdomain");
E
Eric Blake 已提交
14049
        return EXIT_FAILURE;
14050
    }
14051
    if (!textdomain(PACKAGE)) {
14052
        perror("textdomain");
E
Eric Blake 已提交
14053
        return EXIT_FAILURE;
14054 14055
    }

14056 14057 14058 14059 14060
    if (virInitialize() < 0) {
        vshError(ctl, "%s", _("Failed to initialize libvirt"));
        return EXIT_FAILURE;
    }

14061
    if (!(progname = strrchr(argv[0], '/')))
K
Karel Zak 已提交
14062 14063 14064
        progname = argv[0];
    else
        progname++;
14065

14066
    if ((defaultConn = getenv("VIRSH_DEFAULT_CONNECT_URI"))) {
E
Eric Blake 已提交
14067
        ctl->name = vshStrdup(ctl, defaultConn);
14068 14069
    }

D
Daniel P. Berrange 已提交
14070 14071
    if (!vshParseArgv(ctl, argc, argv)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
14072
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
14073
    }
14074

D
Daniel P. Berrange 已提交
14075 14076
    if (!vshInit(ctl)) {
        vshDeinit(ctl);
K
Karel Zak 已提交
14077
        exit(EXIT_FAILURE);
D
Daniel P. Berrange 已提交
14078
    }
14079

K
Karel Zak 已提交
14080
    if (!ctl->imode) {
14081
        ret = vshCommandRun(ctl, ctl->cmd);
14082
    } else {
K
Karel Zak 已提交
14083 14084
        /* interactive mode */
        if (!ctl->quiet) {
K
Karel Zak 已提交
14085
            vshPrint(ctl,
14086
                     _("Welcome to %s, the virtualization interactive terminal.\n\n"),
14087
                     progname);
J
Jim Meyering 已提交
14088
            vshPrint(ctl, "%s",
14089
                     _("Type:  'help' for help with commands\n"
14090
                       "       'quit' to quit\n\n"));
K
Karel Zak 已提交
14091
        }
14092 14093 14094 14095 14096 14097

        if (vshReadlineInit(ctl) < 0) {
            vshDeinit(ctl);
            exit(EXIT_FAILURE);
        }

K
Karel Zak 已提交
14098
        do {
14099
            const char *prompt = ctl->readonly ? VSH_PROMPT_RO : VSH_PROMPT_RW;
14100
            ctl->cmdstr =
14101
                vshReadline(ctl, prompt);
14102 14103
            if (ctl->cmdstr == NULL)
                break;          /* EOF */
K
Karel Zak 已提交
14104
            if (*ctl->cmdstr) {
14105
#if USE_READLINE
K
Karel Zak 已提交
14106
                add_history(ctl->cmdstr);
14107
#endif
14108
                if (vshCommandStringParse(ctl, ctl->cmdstr))
K
Karel Zak 已提交
14109 14110
                    vshCommandRun(ctl, ctl->cmd);
            }
14111
            VIR_FREE(ctl->cmdstr);
14112
        } while (ctl->imode);
K
Karel Zak 已提交
14113

14114 14115
        if (ctl->cmdstr == NULL)
            fputc('\n', stdout);        /* line break after alone prompt */
K
Karel Zak 已提交
14116
    }
14117

K
Karel Zak 已提交
14118 14119
    vshDeinit(ctl);
    exit(ret ? EXIT_SUCCESS : EXIT_FAILURE);
14120
}